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.DescribeIdentityPool

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

data DescribeIdentityPool = DescribeIdentityPool' {
- identityPoolId :: Text
}
newDescribeIdentityPool :: Text -> DescribeIdentityPool
describeIdentityPool_identityPoolId :: Lens' DescribeIdentityPool Text
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 DescribeIdentityPool Source #

Input to the DescribeIdentityPool action.

See: newDescribeIdentityPool smart constructor.

Constructors

DescribeIdentityPool'
Fields identityPoolId :: Text An identity pool ID in the format REGION:GUID.

Instances

Instances details

Eq DescribeIdentityPool Source #
Instance details Defined in Amazonka.CognitoIdentity.DescribeIdentityPool Methods (==) :: DescribeIdentityPool -> DescribeIdentityPool -> Bool # (/=) :: DescribeIdentityPool -> DescribeIdentityPool -> Bool #
Read DescribeIdentityPool Source #
Instance details Defined in Amazonka.CognitoIdentity.DescribeIdentityPool Methods readsPrec :: Int -> ReadS DescribeIdentityPool # readList :: ReadS [DescribeIdentityPool] # readPrec :: ReadPrec DescribeIdentityPool # readListPrec :: ReadPrec [DescribeIdentityPool] #
Show DescribeIdentityPool Source #
Instance details Defined in Amazonka.CognitoIdentity.DescribeIdentityPool Methods showsPrec :: Int -> DescribeIdentityPool -> ShowS # show :: DescribeIdentityPool -> String # showList :: [DescribeIdentityPool] -> ShowS #
Generic DescribeIdentityPool Source #
Instance details Defined in Amazonka.CognitoIdentity.DescribeIdentityPool Associated Types type Rep DescribeIdentityPool :: Type -> Type # Methods from :: DescribeIdentityPool -> Rep DescribeIdentityPool x # to :: Rep DescribeIdentityPool x -> DescribeIdentityPool #
NFData DescribeIdentityPool Source #
Instance details Defined in Amazonka.CognitoIdentity.DescribeIdentityPool Methods rnf :: DescribeIdentityPool -> () #
Hashable DescribeIdentityPool Source #
Instance details Defined in Amazonka.CognitoIdentity.DescribeIdentityPool Methods hashWithSalt :: Int -> DescribeIdentityPool -> Int # hash :: DescribeIdentityPool -> Int #
ToJSON DescribeIdentityPool Source #
Instance details Defined in Amazonka.CognitoIdentity.DescribeIdentityPool Methods toJSON :: DescribeIdentityPool -> Value # toEncoding :: DescribeIdentityPool -> Encoding # toJSONList :: [DescribeIdentityPool] -> Value # toEncodingList :: [DescribeIdentityPool] -> Encoding #
AWSRequest DescribeIdentityPool Source #
Instance details Defined in Amazonka.CognitoIdentity.DescribeIdentityPool Associated Types type AWSResponse DescribeIdentityPool # Methods request :: DescribeIdentityPool -> Request DescribeIdentityPool # response :: MonadResource m => Logger -> Service -> Proxy DescribeIdentityPool -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeIdentityPool))) #
ToHeaders DescribeIdentityPool Source #
Instance details Defined in Amazonka.CognitoIdentity.DescribeIdentityPool Methods toHeaders :: DescribeIdentityPool -> [Header] #
ToPath DescribeIdentityPool Source #
Instance details Defined in Amazonka.CognitoIdentity.DescribeIdentityPool Methods toPath :: DescribeIdentityPool -> ByteString #
ToQuery DescribeIdentityPool Source #
Instance details Defined in Amazonka.CognitoIdentity.DescribeIdentityPool Methods toQuery :: DescribeIdentityPool -> QueryString #
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 type AWSResponse DescribeIdentityPool = IdentityPool

newDescribeIdentityPool Source #

Arguments

:: Text	`$sel:identityPoolId:DescribeIdentityPool'`
-> DescribeIdentityPool

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

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.