amazonka-cognito-identity-2.0: Amazon Cognito Identity SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CognitoIdentity.CreateIdentityPool

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

Creating a Request

data CreateIdentityPool Source #

Input to the CreateIdentityPool action.

See: newCreateIdentityPool smart constructor.

Constructors

CreateIdentityPool' 

Fields

Instances

Instances details
ToJSON CreateIdentityPool Source # 
Instance details

Defined in Amazonka.CognitoIdentity.CreateIdentityPool

ToHeaders CreateIdentityPool Source # 
Instance details

Defined in Amazonka.CognitoIdentity.CreateIdentityPool

ToPath CreateIdentityPool Source # 
Instance details

Defined in Amazonka.CognitoIdentity.CreateIdentityPool

ToQuery CreateIdentityPool Source # 
Instance details

Defined in Amazonka.CognitoIdentity.CreateIdentityPool

AWSRequest CreateIdentityPool Source # 
Instance details

Defined in Amazonka.CognitoIdentity.CreateIdentityPool

Associated Types

type AWSResponse CreateIdentityPool #

Generic CreateIdentityPool Source # 
Instance details

Defined in Amazonka.CognitoIdentity.CreateIdentityPool

Associated Types

type Rep CreateIdentityPool :: Type -> Type #

Read CreateIdentityPool Source # 
Instance details

Defined in Amazonka.CognitoIdentity.CreateIdentityPool

Show CreateIdentityPool Source # 
Instance details

Defined in Amazonka.CognitoIdentity.CreateIdentityPool

NFData CreateIdentityPool Source # 
Instance details

Defined in Amazonka.CognitoIdentity.CreateIdentityPool

Methods

rnf :: CreateIdentityPool -> () #

Eq CreateIdentityPool Source # 
Instance details

Defined in Amazonka.CognitoIdentity.CreateIdentityPool

Hashable CreateIdentityPool Source # 
Instance details

Defined in Amazonka.CognitoIdentity.CreateIdentityPool

type AWSResponse CreateIdentityPool Source # 
Instance details

Defined in Amazonka.CognitoIdentity.CreateIdentityPool

type Rep CreateIdentityPool Source # 
Instance details

Defined in Amazonka.CognitoIdentity.CreateIdentityPool

type Rep CreateIdentityPool = D1 ('MetaData "CreateIdentityPool" "Amazonka.CognitoIdentity.CreateIdentityPool" "amazonka-cognito-identity-2.0-9cap08KVWNhAJ5mbkAF9NH" 'False) (C1 ('MetaCons "CreateIdentityPool'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "allowClassicFlow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "cognitoIdentityProviders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CognitoIdentityProvider]))) :*: (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 "samlProviderARNs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "supportedLoginProviders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: (S1 ('MetaSel ('Just "identityPoolName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "allowUnauthenticatedIdentities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))))))

newCreateIdentityPool Source #

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:

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.

CreateIdentityPool, createIdentityPool_cognitoIdentityProviders - An array of Amazon Cognito user pools and their client IDs.

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.

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.

CreateIdentityPool, createIdentityPool_openIdConnectProviderARNs - The Amazon Resource Names (ARN) of the OpenID Connect providers.

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

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

CreateIdentityPool, createIdentityPool_identityPoolName - A string that you provide.

CreateIdentityPool, createIdentityPool_allowUnauthenticatedIdentities - TRUE if the identity pool supports unauthenticated logins.

Request Lenses

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_cognitoIdentityProviders :: Lens' CreateIdentityPool (Maybe [CognitoIdentityProvider]) Source #

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

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_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_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

Instances

Instances details
FromJSON IdentityPool Source # 
Instance details

Defined in Amazonka.CognitoIdentity.Types.IdentityPool

ToJSON IdentityPool Source # 
Instance details

Defined in Amazonka.CognitoIdentity.Types.IdentityPool

Generic IdentityPool Source # 
Instance details

Defined in Amazonka.CognitoIdentity.Types.IdentityPool

Associated Types

type Rep IdentityPool :: Type -> Type #

Read IdentityPool Source # 
Instance details

Defined in Amazonka.CognitoIdentity.Types.IdentityPool

Show IdentityPool Source # 
Instance details

Defined in Amazonka.CognitoIdentity.Types.IdentityPool

NFData IdentityPool Source # 
Instance details

Defined in Amazonka.CognitoIdentity.Types.IdentityPool

Methods

rnf :: IdentityPool -> () #

Eq IdentityPool Source # 
Instance details

Defined in Amazonka.CognitoIdentity.Types.IdentityPool

Hashable IdentityPool Source # 
Instance details

Defined in Amazonka.CognitoIdentity.Types.IdentityPool

type Rep IdentityPool Source # 
Instance details

Defined in Amazonka.CognitoIdentity.Types.IdentityPool

type Rep IdentityPool = D1 ('MetaData "IdentityPool" "Amazonka.CognitoIdentity.Types.IdentityPool" "amazonka-cognito-identity-2.0-9cap08KVWNhAJ5mbkAF9NH" 'False) (C1 ('MetaCons "IdentityPool'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "allowClassicFlow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "cognitoIdentityProviders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CognitoIdentityProvider]))) :*: (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 "samlProviderARNs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "supportedLoginProviders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :*: (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 #

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: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:cognitoIdentityProviders:IdentityPool', identityPool_cognitoIdentityProviders - A list representing an Amazon Cognito user pool and its client ID.

$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: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: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_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_cognitoIdentityProviders :: Lens' IdentityPool (Maybe [CognitoIdentityProvider]) Source #

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

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_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_identityPoolId :: Lens' IdentityPool Text Source #

An identity pool ID in the format REGION:GUID.

identityPool_allowUnauthenticatedIdentities :: Lens' IdentityPool Bool Source #

TRUE if the identity pool supports unauthenticated logins.