libZSservicesZSamazonka-cognito-identityZSamazonka-cognito-identity
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CognitoIdentity.DescribeIdentityPool

Description

Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.

You must use AWS Developer credentials to call this API.

Synopsis

Creating a Request

data DescribeIdentityPool Source #

Input to the DescribeIdentityPool action.

See: newDescribeIdentityPool smart constructor.

Constructors

DescribeIdentityPool' 

Fields

Instances

Instances details
Eq DescribeIdentityPool Source # 
Instance details

Defined in Amazonka.CognitoIdentity.DescribeIdentityPool

Read DescribeIdentityPool Source # 
Instance details

Defined in Amazonka.CognitoIdentity.DescribeIdentityPool

Show DescribeIdentityPool Source # 
Instance details

Defined in Amazonka.CognitoIdentity.DescribeIdentityPool

Generic DescribeIdentityPool Source # 
Instance details

Defined in Amazonka.CognitoIdentity.DescribeIdentityPool

Associated Types

type Rep DescribeIdentityPool :: Type -> Type #

NFData DescribeIdentityPool Source # 
Instance details

Defined in Amazonka.CognitoIdentity.DescribeIdentityPool

Methods

rnf :: DescribeIdentityPool -> () #

Hashable DescribeIdentityPool Source # 
Instance details

Defined in Amazonka.CognitoIdentity.DescribeIdentityPool

ToJSON DescribeIdentityPool Source # 
Instance details

Defined in Amazonka.CognitoIdentity.DescribeIdentityPool

AWSRequest DescribeIdentityPool Source # 
Instance details

Defined in Amazonka.CognitoIdentity.DescribeIdentityPool

Associated Types

type AWSResponse DescribeIdentityPool #

ToHeaders DescribeIdentityPool Source # 
Instance details

Defined in Amazonka.CognitoIdentity.DescribeIdentityPool

ToPath DescribeIdentityPool Source # 
Instance details

Defined in Amazonka.CognitoIdentity.DescribeIdentityPool

ToQuery DescribeIdentityPool Source # 
Instance details

Defined in Amazonka.CognitoIdentity.DescribeIdentityPool

type Rep DescribeIdentityPool Source # 
Instance details

Defined in Amazonka.CognitoIdentity.DescribeIdentityPool

type Rep DescribeIdentityPool = D1 ('MetaData "DescribeIdentityPool" "Amazonka.CognitoIdentity.DescribeIdentityPool" "libZSservicesZSamazonka-cognito-identityZSamazonka-cognito-identity" 'False) (C1 ('MetaCons "DescribeIdentityPool'" 'PrefixI 'True) (S1 ('MetaSel ('Just "identityPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeIdentityPool Source # 
Instance details

Defined in Amazonka.CognitoIdentity.DescribeIdentityPool

newDescribeIdentityPool Source #

Create a value of DescribeIdentityPool 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:identityPoolId:DescribeIdentityPool', describeIdentityPool_identityPoolId - An identity pool ID in the format REGION:GUID.

Request Lenses

describeIdentityPool_identityPoolId :: Lens' DescribeIdentityPool Text Source #

An identity pool ID in the format REGION:GUID.

Destructuring the Response

data IdentityPool Source #

An object representing an Amazon Cognito identity pool.

See: newIdentityPool smart constructor.

Constructors

IdentityPool' 

Fields

Instances

Instances details
Eq IdentityPool Source # 
Instance details

Defined in Amazonka.CognitoIdentity.Types.IdentityPool

Read IdentityPool Source # 
Instance details

Defined in Amazonka.CognitoIdentity.Types.IdentityPool

Show 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 #

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

ToJSON IdentityPool Source # 
Instance details

Defined in Amazonka.CognitoIdentity.Types.IdentityPool

FromJSON 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" "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 #

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_allowUnauthenticatedIdentities :: Lens' IdentityPool Bool Source #

TRUE if the identity pool supports unauthenticated logins.