Network.AWS.CognitoIdentity.CreateIdentityPool

Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The limit on identity pools is 60 per account. The keys for SupportedLoginProviders are as follows: * Facebook: graph.facebook.com * Google: accounts.google.com * Amazon: www.amazon.com * Twitter: api.twitter.com * Digits: www.digits.com

You must use AWS Developer credentials to call this API.

Creating a Request

createIdentityPool

Arguments

:: Text

cipIdentityPoolName

-> Bool

cipAllowUnauthenticatedIdentities

-> CreateIdentityPool

Creates a value of CreateIdentityPool with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cipSamlProviderARNs - An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
• cipSupportedLoginProviders - Optional key:value pairs mapping provider names to provider app IDs.
• cipDeveloperProviderName - The "domain" by which Cognito will refer to your users. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName , you can use letters as well as period (. ), underscore (_ ), and dash (- ). Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter.
• cipOpenIdConnectProviderARNs - A list of OpendID Connect provider ARNs.
• cipCognitoIdentityProviders - An array of Amazon Cognito Identity user pools.
• cipIdentityPoolName - A string that you provide.
• cipAllowUnauthenticatedIdentities - TRUE if the identity pool supports unauthenticated logins.

data CreateIdentityPool

Input to the CreateIdentityPool action.

See: createIdentityPool smart constructor.

Instances

Eq CreateIdentityPool

Methods

(==) :: CreateIdentityPool -> CreateIdentityPool -> Bool

(/=) :: CreateIdentityPool -> CreateIdentityPool -> Bool

Data CreateIdentityPool

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateIdentityPool -> c CreateIdentityPool

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateIdentityPool

toConstr :: CreateIdentityPool -> Constr

dataTypeOf :: CreateIdentityPool -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateIdentityPool)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateIdentityPool)

gmapT :: (forall b. Data b => b -> b) -> CreateIdentityPool -> CreateIdentityPool

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateIdentityPool -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateIdentityPool -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateIdentityPool -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateIdentityPool -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateIdentityPool -> m CreateIdentityPool

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateIdentityPool -> m CreateIdentityPool

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateIdentityPool -> m CreateIdentityPool

Read CreateIdentityPool

Methods

readsPrec :: Int -> ReadS CreateIdentityPool

readList :: ReadS [CreateIdentityPool]

readPrec :: ReadPrec CreateIdentityPool

readListPrec :: ReadPrec [CreateIdentityPool]

Show CreateIdentityPool

Methods

showsPrec :: Int -> CreateIdentityPool -> ShowS

show :: CreateIdentityPool -> String

showList :: [CreateIdentityPool] -> ShowS

Generic CreateIdentityPool

Associated Types

type Rep CreateIdentityPool :: * -> *

Methods

from :: CreateIdentityPool -> Rep CreateIdentityPool x

to :: Rep CreateIdentityPool x -> CreateIdentityPool

Hashable CreateIdentityPool

Methods

hashWithSalt :: Int -> CreateIdentityPool -> Int

hash :: CreateIdentityPool -> Int

ToJSON CreateIdentityPool

Methods

toJSON :: CreateIdentityPool -> Value

toEncoding :: CreateIdentityPool -> Encoding

toJSONList :: [CreateIdentityPool] -> Value

toEncodingList :: [CreateIdentityPool] -> Encoding

NFData CreateIdentityPool

Methods

rnf :: CreateIdentityPool -> ()

AWSRequest CreateIdentityPool

Associated Types

type Rs CreateIdentityPool :: *

Methods

request :: CreateIdentityPool -> Request CreateIdentityPool

response :: MonadResource m => Logger -> Service -> Proxy * CreateIdentityPool -> ClientResponse -> m (Response CreateIdentityPool)

ToPath CreateIdentityPool

Methods

toPath :: CreateIdentityPool -> ByteString

ToHeaders CreateIdentityPool

Methods

toHeaders :: CreateIdentityPool -> [Header]

ToQuery CreateIdentityPool

Methods

toQuery :: CreateIdentityPool -> QueryString

type Rep CreateIdentityPool

type Rep CreateIdentityPool = D1 (MetaData "CreateIdentityPool" "Network.AWS.CognitoIdentity.CreateIdentityPool" "amazonka-cognito-identity-1.4.5-FQJQgy9jw2zGp3zOnk88Lj" False) (C1 (MetaCons "CreateIdentityPool'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cipSamlProviderARNs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) ((:*:) (S1 (MetaSel (Just Symbol "_cipSupportedLoginProviders") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))) (S1 (MetaSel (Just Symbol "_cipDeveloperProviderName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cipOpenIdConnectProviderARNs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_cipCognitoIdentityProviders") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [CognitoIdentityProvider])))) ((:*:) (S1 (MetaSel (Just Symbol "_cipIdentityPoolName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_cipAllowUnauthenticatedIdentities") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool))))))

type Rs CreateIdentityPool

type Rs CreateIdentityPool = IdentityPool

Request Lenses

cipSamlProviderARNs :: Lens' CreateIdentityPool [Text]

An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.

cipSupportedLoginProviders :: Lens' CreateIdentityPool (HashMap Text Text)

Optional key:value pairs mapping provider names to provider app IDs.

cipDeveloperProviderName :: Lens' CreateIdentityPool (Maybe Text)

The "domain" by which Cognito will refer to your users. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName , you can use letters as well as period (. ), underscore (_ ), and dash (- ). Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter.

cipOpenIdConnectProviderARNs :: Lens' CreateIdentityPool [Text]

A list of OpendID Connect provider ARNs.

cipCognitoIdentityProviders :: Lens' CreateIdentityPool [CognitoIdentityProvider]

An array of Amazon Cognito Identity user pools.

cipIdentityPoolName :: Lens' CreateIdentityPool Text

A string that you provide.

cipAllowUnauthenticatedIdentities :: Lens' CreateIdentityPool Bool

TRUE if the identity pool supports unauthenticated logins.

Destructuring the Response

identityPool

Arguments

:: Text

ipIdentityPoolId

-> Text

ipIdentityPoolName

-> Bool

ipAllowUnauthenticatedIdentities

-> IdentityPool

Creates a value of IdentityPool with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ipSamlProviderARNs - An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
• ipSupportedLoginProviders - Optional key:value pairs mapping provider names to provider app IDs.
• ipDeveloperProviderName - The "domain" by which Cognito will refer to your users.
• ipOpenIdConnectProviderARNs - A list of OpendID Connect provider ARNs.
• ipCognitoIdentityProviders - A list representing an Amazon Cognito Identity User Pool and its client ID.
• ipIdentityPoolId - An identity pool ID in the format REGION:GUID.
• ipIdentityPoolName - A string that you provide.
• ipAllowUnauthenticatedIdentities - TRUE if the identity pool supports unauthenticated logins.

data IdentityPool

An object representing a Cognito identity pool.

See: identityPool smart constructor.

Instances

Eq IdentityPool

Methods

(==) :: IdentityPool -> IdentityPool -> Bool

(/=) :: IdentityPool -> IdentityPool -> Bool

Data IdentityPool

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> IdentityPool -> c IdentityPool

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c IdentityPool

toConstr :: IdentityPool -> Constr

dataTypeOf :: IdentityPool -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c IdentityPool)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c IdentityPool)

gmapT :: (forall b. Data b => b -> b) -> IdentityPool -> IdentityPool

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> IdentityPool -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> IdentityPool -> r

gmapQ :: (forall d. Data d => d -> u) -> IdentityPool -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> IdentityPool -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> IdentityPool -> m IdentityPool

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> IdentityPool -> m IdentityPool

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> IdentityPool -> m IdentityPool

Read IdentityPool

Methods

readsPrec :: Int -> ReadS IdentityPool

readList :: ReadS [IdentityPool]

readPrec :: ReadPrec IdentityPool

readListPrec :: ReadPrec [IdentityPool]

Show IdentityPool

Methods

showsPrec :: Int -> IdentityPool -> ShowS

show :: IdentityPool -> String

showList :: [IdentityPool] -> ShowS

Generic IdentityPool

Associated Types

type Rep IdentityPool :: * -> *

Methods

from :: IdentityPool -> Rep IdentityPool x

to :: Rep IdentityPool x -> IdentityPool

Hashable IdentityPool

Methods

hashWithSalt :: Int -> IdentityPool -> Int

hash :: IdentityPool -> Int

ToJSON IdentityPool

Methods

toJSON :: IdentityPool -> Value

toEncoding :: IdentityPool -> Encoding

toJSONList :: [IdentityPool] -> Value

toEncodingList :: [IdentityPool] -> Encoding

FromJSON IdentityPool

Methods

parseJSON :: Value -> Parser IdentityPool

parseJSONList :: Value -> Parser [IdentityPool]

NFData IdentityPool

Methods

rnf :: IdentityPool -> ()

type Rep IdentityPool

type Rep IdentityPool = D1 (MetaData "IdentityPool" "Network.AWS.CognitoIdentity.Types.Product" "amazonka-cognito-identity-1.4.5-FQJQgy9jw2zGp3zOnk88Lj" False) (C1 (MetaCons "IdentityPool'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ipSamlProviderARNs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_ipSupportedLoginProviders") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_ipDeveloperProviderName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ipOpenIdConnectProviderARNs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ipCognitoIdentityProviders") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [CognitoIdentityProvider]))) (S1 (MetaSel (Just Symbol "_ipIdentityPoolId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "_ipIdentityPoolName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_ipAllowUnauthenticatedIdentities") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool))))))

Response Lenses

ipSamlProviderARNs :: Lens' IdentityPool [Text]

An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.

ipSupportedLoginProviders :: Lens' IdentityPool (HashMap Text Text)

Optional key:value pairs mapping provider names to provider app IDs.

ipDeveloperProviderName :: Lens' IdentityPool (Maybe Text)

The "domain" by which Cognito will refer to your users.

ipOpenIdConnectProviderARNs :: Lens' IdentityPool [Text]

A list of OpendID Connect provider ARNs.

ipCognitoIdentityProviders :: Lens' IdentityPool [CognitoIdentityProvider]

A list representing an Amazon Cognito Identity User Pool and its client ID.

ipIdentityPoolId :: Lens' IdentityPool Text

An identity pool ID in the format REGION:GUID.

ipIdentityPoolName :: Lens' IdentityPool Text

A string that you provide.

ipAllowUnauthenticatedIdentities :: Lens' IdentityPool Bool

TRUE if the identity pool supports unauthenticated logins.