Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
Network.AWS.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
- describeIdentityPool :: Text -> DescribeIdentityPool
- data DescribeIdentityPool
- dipIdentityPoolId :: Lens' DescribeIdentityPool Text
- identityPool :: Text -> Text -> Bool -> IdentityPool
- data IdentityPool
- ipSamlProviderARNs :: Lens' IdentityPool [Text]
- ipSupportedLoginProviders :: Lens' IdentityPool (HashMap Text Text)
- ipDeveloperProviderName :: Lens' IdentityPool (Maybe Text)
- ipOpenIdConnectProviderARNs :: Lens' IdentityPool [Text]
- ipCognitoIdentityProviders :: Lens' IdentityPool [CognitoIdentityProvider]
- ipIdentityPoolId :: Lens' IdentityPool Text
- ipIdentityPoolName :: Lens' IdentityPool Text
- ipAllowUnauthenticatedIdentities :: Lens' IdentityPool Bool
Creating a Request
Arguments
:: Text | |
-> DescribeIdentityPool |
Creates a value of DescribeIdentityPool
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dipIdentityPoolId
- An identity pool ID in the format REGION:GUID.
data DescribeIdentityPool Source #
Input to the DescribeIdentityPool action.
See: describeIdentityPool
smart constructor.
Instances
Request Lenses
dipIdentityPoolId :: Lens' DescribeIdentityPool Text Source #
An identity pool ID in the format REGION:GUID.
Destructuring the Response
Arguments
:: Text | |
-> Text | |
-> Bool | |
-> 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 Source #
An object representing an Amazon Cognito identity pool.
See: identityPool
smart constructor.
Instances
Response Lenses
ipSamlProviderARNs :: Lens' IdentityPool [Text] Source #
An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
ipSupportedLoginProviders :: Lens' IdentityPool (HashMap Text Text) Source #
Optional key:value pairs mapping provider names to provider app IDs.
ipDeveloperProviderName :: Lens' IdentityPool (Maybe Text) Source #
The "domain" by which Cognito will refer to your users.
ipOpenIdConnectProviderARNs :: Lens' IdentityPool [Text] Source #
A list of OpendID Connect provider ARNs.
ipCognitoIdentityProviders :: Lens' IdentityPool [CognitoIdentityProvider] Source #
A list representing an Amazon Cognito Identity User Pool and its client ID.
ipIdentityPoolId :: Lens' IdentityPool Text Source #
An identity pool ID in the format REGION:GUID.
ipIdentityPoolName :: Lens' IdentityPool Text Source #
A string that you provide.
ipAllowUnauthenticatedIdentities :: Lens' IdentityPool Bool Source #
TRUE if the identity pool supports unauthenticated logins.