Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CognitoIdentity.CreateIdentityPool

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS 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.

Synopsis

data CreateIdentityPool = CreateIdentityPool' {
- samlProviderARNs :: Maybe [Text]
- supportedLoginProviders :: Maybe (HashMap Text Text)
- allowClassicFlow :: Maybe Bool
- developerProviderName :: Maybe Text
- identityPoolTags :: Maybe (HashMap Text Text)
- openIdConnectProviderARNs :: Maybe [Text]
- cognitoIdentityProviders :: Maybe [CognitoIdentityProvider]
- identityPoolName :: Text
- allowUnauthenticatedIdentities :: Bool
}
newCreateIdentityPool :: Text -> Bool -> CreateIdentityPool
createIdentityPool_samlProviderARNs :: Lens' CreateIdentityPool (Maybe [Text])
createIdentityPool_supportedLoginProviders :: Lens' CreateIdentityPool (Maybe (HashMap Text Text))
createIdentityPool_allowClassicFlow :: Lens' CreateIdentityPool (Maybe Bool)
createIdentityPool_developerProviderName :: Lens' CreateIdentityPool (Maybe Text)
createIdentityPool_identityPoolTags :: Lens' CreateIdentityPool (Maybe (HashMap Text Text))
createIdentityPool_openIdConnectProviderARNs :: Lens' CreateIdentityPool (Maybe [Text])
createIdentityPool_cognitoIdentityProviders :: Lens' CreateIdentityPool (Maybe [CognitoIdentityProvider])
createIdentityPool_identityPoolName :: Lens' CreateIdentityPool Text
createIdentityPool_allowUnauthenticatedIdentities :: Lens' CreateIdentityPool Bool
data IdentityPool = IdentityPool' {
- samlProviderARNs :: Maybe [Text]
- supportedLoginProviders :: Maybe (HashMap Text Text)
- allowClassicFlow :: Maybe Bool
- developerProviderName :: Maybe Text
- identityPoolTags :: Maybe (HashMap Text Text)
- openIdConnectProviderARNs :: Maybe [Text]
- cognitoIdentityProviders :: Maybe [CognitoIdentityProvider]
- identityPoolId :: Text
- identityPoolName :: Text
- allowUnauthenticatedIdentities :: Bool
}
newIdentityPool :: Text -> Text -> Bool -> IdentityPool
identityPool_samlProviderARNs :: Lens' IdentityPool (Maybe [Text])
identityPool_supportedLoginProviders :: Lens' IdentityPool (Maybe (HashMap Text Text))
identityPool_allowClassicFlow :: Lens' IdentityPool (Maybe Bool)
identityPool_developerProviderName :: Lens' IdentityPool (Maybe Text)
identityPool_identityPoolTags :: Lens' IdentityPool (Maybe (HashMap Text Text))
identityPool_openIdConnectProviderARNs :: Lens' IdentityPool (Maybe [Text])
identityPool_cognitoIdentityProviders :: Lens' IdentityPool (Maybe [CognitoIdentityProvider])
identityPool_identityPoolId :: Lens' IdentityPool Text
identityPool_identityPoolName :: Lens' IdentityPool Text
identityPool_allowUnauthenticatedIdentities :: Lens' IdentityPool Bool

Creating a Request

data CreateIdentityPool Source #

Input to the CreateIdentityPool action.

See: newCreateIdentityPool smart constructor.

Constructors

CreateIdentityPool'

Fields

samlProviderARNs :: Maybe [Text]
An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
supportedLoginProviders :: Maybe (HashMap Text Text)
Optional key:value pairs mapping provider names to provider app IDs.
allowClassicFlow :: Maybe Bool
Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.
developerProviderName :: 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.
identityPoolTags :: Maybe (HashMap Text Text)
Tags to assign to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
openIdConnectProviderARNs :: Maybe [Text]
The Amazon Resource Names (ARN) of the OpenID Connect providers.
cognitoIdentityProviders :: Maybe [CognitoIdentityProvider]
An array of Amazon Cognito user pools and their client IDs.
identityPoolName :: Text
A string that you provide.
allowUnauthenticatedIdentities :: Bool
TRUE if the identity pool supports unauthenticated logins.

Instances

Instances details

Eq CreateIdentityPool Source #
Instance details Defined in Amazonka.CognitoIdentity.CreateIdentityPool Methods (==) :: CreateIdentityPool -> CreateIdentityPool -> Bool # (/=) :: CreateIdentityPool -> CreateIdentityPool -> Bool #
Read CreateIdentityPool Source #
Instance details Defined in Amazonka.CognitoIdentity.CreateIdentityPool Methods readsPrec :: Int -> ReadS CreateIdentityPool # readList :: ReadS [CreateIdentityPool] # readPrec :: ReadPrec CreateIdentityPool # readListPrec :: ReadPrec [CreateIdentityPool] #
Show CreateIdentityPool Source #
Instance details Defined in Amazonka.CognitoIdentity.CreateIdentityPool Methods showsPrec :: Int -> CreateIdentityPool -> ShowS # show :: CreateIdentityPool -> String # showList :: [CreateIdentityPool] -> ShowS #
Generic CreateIdentityPool Source #
Instance details Defined in Amazonka.CognitoIdentity.CreateIdentityPool Associated Types type Rep CreateIdentityPool :: Type -> Type # Methods from :: CreateIdentityPool -> Rep CreateIdentityPool x # to :: Rep CreateIdentityPool x -> CreateIdentityPool #
NFData CreateIdentityPool Source #
Instance details Defined in Amazonka.CognitoIdentity.CreateIdentityPool Methods rnf :: CreateIdentityPool -> () #
Hashable CreateIdentityPool Source #
Instance details Defined in Amazonka.CognitoIdentity.CreateIdentityPool Methods hashWithSalt :: Int -> CreateIdentityPool -> Int # hash :: CreateIdentityPool -> Int #
ToJSON CreateIdentityPool Source #
Instance details Defined in Amazonka.CognitoIdentity.CreateIdentityPool Methods toJSON :: CreateIdentityPool -> Value # toEncoding :: CreateIdentityPool -> Encoding # toJSONList :: [CreateIdentityPool] -> Value # toEncodingList :: [CreateIdentityPool] -> Encoding #
AWSRequest CreateIdentityPool Source #
Instance details Defined in Amazonka.CognitoIdentity.CreateIdentityPool Associated Types type AWSResponse CreateIdentityPool # Methods request :: CreateIdentityPool -> Request CreateIdentityPool # response :: MonadResource m => Logger -> Service -> Proxy CreateIdentityPool -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateIdentityPool))) #
ToHeaders CreateIdentityPool Source #
Instance details Defined in Amazonka.CognitoIdentity.CreateIdentityPool Methods toHeaders :: CreateIdentityPool -> [Header] #
ToPath CreateIdentityPool Source #
Instance details Defined in Amazonka.CognitoIdentity.CreateIdentityPool Methods toPath :: CreateIdentityPool -> ByteString #
ToQuery CreateIdentityPool Source #
Instance details Defined in Amazonka.CognitoIdentity.CreateIdentityPool Methods toQuery :: CreateIdentityPool -> QueryString #
type Rep CreateIdentityPool Source #
Instance details Defined in Amazonka.CognitoIdentity.CreateIdentityPool type Rep CreateIdentityPool = D1 ('MetaData "CreateIdentityPool" "Amazonka.CognitoIdentity.CreateIdentityPool" "libZSservicesZSamazonka-cognito-identityZSamazonka-cognito-identity" 'False) (C1 ('MetaCons "CreateIdentityPool'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "samlProviderARNs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "supportedLoginProviders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "allowClassicFlow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "developerProviderName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "identityPoolTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "openIdConnectProviderARNs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "cognitoIdentityProviders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CognitoIdentityProvider])) :: (S1 ('MetaSel ('Just "identityPoolName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "allowUnauthenticatedIdentities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))))))
type AWSResponse CreateIdentityPool Source #
Instance details Defined in Amazonka.CognitoIdentity.CreateIdentityPool type AWSResponse CreateIdentityPool = IdentityPool

newCreateIdentityPool Source #

Arguments

:: Text	`$sel:identityPoolName:CreateIdentityPool'`
-> Bool	`$sel:allowUnauthenticatedIdentities:CreateIdentityPool'`
-> CreateIdentityPool

Create a value of CreateIdentityPool with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:samlProviderARNs:CreateIdentityPool', createIdentityPool_samlProviderARNs - An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.

$sel:supportedLoginProviders:CreateIdentityPool', createIdentityPool_supportedLoginProviders - Optional key:value pairs mapping provider names to provider app IDs.

$sel:allowClassicFlow:CreateIdentityPool', createIdentityPool_allowClassicFlow - Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.

$sel:developerProviderName:CreateIdentityPool', createIdentityPool_developerProviderName - 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.

$sel:identityPoolTags:CreateIdentityPool', createIdentityPool_identityPoolTags - Tags to assign to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

$sel:openIdConnectProviderARNs:CreateIdentityPool', createIdentityPool_openIdConnectProviderARNs - The Amazon Resource Names (ARN) of the OpenID Connect providers.

$sel:cognitoIdentityProviders:CreateIdentityPool', createIdentityPool_cognitoIdentityProviders - An array of Amazon Cognito user pools and their client IDs.

$sel:identityPoolName:CreateIdentityPool', createIdentityPool_identityPoolName - A string that you provide.

$sel:allowUnauthenticatedIdentities:CreateIdentityPool', createIdentityPool_allowUnauthenticatedIdentities - TRUE if the identity pool supports unauthenticated logins.

Request Lenses

createIdentityPool_samlProviderARNs :: Lens' CreateIdentityPool (Maybe [Text]) Source #

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

createIdentityPool_supportedLoginProviders :: Lens' CreateIdentityPool (Maybe (HashMap Text Text)) Source #

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

createIdentityPool_allowClassicFlow :: Lens' CreateIdentityPool (Maybe Bool) Source #

Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.

createIdentityPool_developerProviderName :: Lens' CreateIdentityPool (Maybe Text) Source #

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.

createIdentityPool_identityPoolTags :: Lens' CreateIdentityPool (Maybe (HashMap Text Text)) Source #

Tags to assign to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

createIdentityPool_openIdConnectProviderARNs :: Lens' CreateIdentityPool (Maybe [Text]) Source #

The Amazon Resource Names (ARN) of the OpenID Connect providers.

createIdentityPool_cognitoIdentityProviders :: Lens' CreateIdentityPool (Maybe [CognitoIdentityProvider]) Source #

An array of Amazon Cognito user pools and their client IDs.

createIdentityPool_identityPoolName :: Lens' CreateIdentityPool Text Source #

A string that you provide.

createIdentityPool_allowUnauthenticatedIdentities :: Lens' CreateIdentityPool Bool Source #

TRUE if the identity pool supports unauthenticated logins.

Destructuring the Response

data IdentityPool Source #

An object representing an Amazon Cognito identity pool.

See: newIdentityPool smart constructor.

Constructors

IdentityPool'

Fields

samlProviderARNs :: Maybe [Text]
An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
supportedLoginProviders :: Maybe (HashMap Text Text)
Optional key:value pairs mapping provider names to provider app IDs.
allowClassicFlow :: Maybe Bool
Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.
developerProviderName :: Maybe Text
The "domain" by which Cognito will refer to your users.
identityPoolTags :: Maybe (HashMap Text Text)
The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
openIdConnectProviderARNs :: Maybe [Text]
The ARNs of the OpenID Connect providers.
cognitoIdentityProviders :: Maybe [CognitoIdentityProvider]
A list representing an Amazon Cognito user pool and its client ID.
identityPoolId :: Text
An identity pool ID in the format REGION:GUID.
identityPoolName :: Text
A string that you provide.
allowUnauthenticatedIdentities :: Bool
TRUE if the identity pool supports unauthenticated logins.

Instances

Instances details

Eq IdentityPool Source #
Instance details Defined in Amazonka.CognitoIdentity.Types.IdentityPool Methods (==) :: IdentityPool -> IdentityPool -> Bool # (/=) :: IdentityPool -> IdentityPool -> Bool #
Read IdentityPool Source #
Instance details Defined in Amazonka.CognitoIdentity.Types.IdentityPool Methods readsPrec :: Int -> ReadS IdentityPool # readList :: ReadS [IdentityPool] # readPrec :: ReadPrec IdentityPool # readListPrec :: ReadPrec [IdentityPool] #
Show IdentityPool Source #
Instance details Defined in Amazonka.CognitoIdentity.Types.IdentityPool Methods showsPrec :: Int -> IdentityPool -> ShowS # show :: IdentityPool -> String # showList :: [IdentityPool] -> ShowS #
Generic IdentityPool Source #
Instance details Defined in Amazonka.CognitoIdentity.Types.IdentityPool Associated Types type Rep IdentityPool :: Type -> Type # Methods from :: IdentityPool -> Rep IdentityPool x # to :: Rep IdentityPool x -> IdentityPool #
NFData IdentityPool Source #
Instance details Defined in Amazonka.CognitoIdentity.Types.IdentityPool Methods rnf :: IdentityPool -> () #
Hashable IdentityPool Source #
Instance details Defined in Amazonka.CognitoIdentity.Types.IdentityPool Methods hashWithSalt :: Int -> IdentityPool -> Int # hash :: IdentityPool -> Int #
ToJSON IdentityPool Source #
Instance details Defined in Amazonka.CognitoIdentity.Types.IdentityPool Methods toJSON :: IdentityPool -> Value # toEncoding :: IdentityPool -> Encoding # toJSONList :: [IdentityPool] -> Value # toEncodingList :: [IdentityPool] -> Encoding #
FromJSON IdentityPool Source #
Instance details Defined in Amazonka.CognitoIdentity.Types.IdentityPool Methods parseJSON :: Value -> Parser IdentityPool # parseJSONList :: Value -> Parser [IdentityPool] #
type Rep IdentityPool Source #
Instance details Defined in Amazonka.CognitoIdentity.Types.IdentityPool type Rep IdentityPool = D1 ('MetaData "IdentityPool" "Amazonka.CognitoIdentity.Types.IdentityPool" "libZSservicesZSamazonka-cognito-identityZSamazonka-cognito-identity" 'False) (C1 ('MetaCons "IdentityPool'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "samlProviderARNs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "supportedLoginProviders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "allowClassicFlow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "developerProviderName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "identityPoolTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))) :: ((S1 ('MetaSel ('Just "openIdConnectProviderARNs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "cognitoIdentityProviders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CognitoIdentityProvider]))) :: (S1 ('MetaSel ('Just "identityPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "identityPoolName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "allowUnauthenticatedIdentities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))))))

newIdentityPool Source #

Arguments

:: Text	`$sel:identityPoolId:IdentityPool'`
-> Text	`$sel:identityPoolName:IdentityPool'`
-> Bool	`$sel:allowUnauthenticatedIdentities:IdentityPool'`
-> IdentityPool

Create a value of IdentityPool with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:samlProviderARNs:IdentityPool', identityPool_samlProviderARNs - An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.

$sel:supportedLoginProviders:IdentityPool', identityPool_supportedLoginProviders - Optional key:value pairs mapping provider names to provider app IDs.

$sel:allowClassicFlow:IdentityPool', identityPool_allowClassicFlow - Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.

$sel:developerProviderName:IdentityPool', identityPool_developerProviderName - The "domain" by which Cognito will refer to your users.

$sel:identityPoolTags:IdentityPool', identityPool_identityPoolTags - The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

$sel:openIdConnectProviderARNs:IdentityPool', identityPool_openIdConnectProviderARNs - The ARNs of the OpenID Connect providers.

$sel:cognitoIdentityProviders:IdentityPool', identityPool_cognitoIdentityProviders - A list representing an Amazon Cognito user pool and its client ID.

$sel:identityPoolId:IdentityPool', identityPool_identityPoolId - An identity pool ID in the format REGION:GUID.

$sel:identityPoolName:IdentityPool', identityPool_identityPoolName - A string that you provide.

$sel:allowUnauthenticatedIdentities:IdentityPool', identityPool_allowUnauthenticatedIdentities - TRUE if the identity pool supports unauthenticated logins.

Response Lenses

identityPool_samlProviderARNs :: Lens' IdentityPool (Maybe [Text]) Source #

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

identityPool_supportedLoginProviders :: Lens' IdentityPool (Maybe (HashMap Text Text)) Source #

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

identityPool_allowClassicFlow :: Lens' IdentityPool (Maybe Bool) Source #

Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.

identityPool_developerProviderName :: Lens' IdentityPool (Maybe Text) Source #

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

identityPool_identityPoolTags :: Lens' IdentityPool (Maybe (HashMap Text Text)) Source #

The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

identityPool_openIdConnectProviderARNs :: Lens' IdentityPool (Maybe [Text]) Source #

The ARNs of the OpenID Connect providers.

identityPool_cognitoIdentityProviders :: Lens' IdentityPool (Maybe [CognitoIdentityProvider]) Source #

A list representing an Amazon Cognito user pool and its client ID.

identityPool_identityPoolId :: Lens' IdentityPool Text Source #

An identity pool ID in the format REGION:GUID.

identityPool_identityPoolName :: Lens' IdentityPool Text Source #

A string that you provide.

identityPool_allowUnauthenticatedIdentities :: Lens' IdentityPool Bool Source #

TRUE if the identity pool supports unauthenticated logins.