Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The limit on identity pools is 60 per 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.
- createIdentityPool :: Text -> Bool -> CreateIdentityPool
- data CreateIdentityPool
- cipSupportedLoginProviders :: Lens' CreateIdentityPool (HashMap Text Text)
- cipDeveloperProviderName :: Lens' CreateIdentityPool (Maybe Text)
- cipOpenIdConnectProviderARNs :: Lens' CreateIdentityPool [Text]
- cipCognitoIdentityProviders :: Lens' CreateIdentityPool [CognitoIdentityProvider]
- cipIdentityPoolName :: Lens' CreateIdentityPool Text
- cipAllowUnauthenticatedIdentities :: Lens' CreateIdentityPool Bool
- identityPool :: Text -> Text -> Bool -> IdentityPool
- data IdentityPool
- 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
Creates a value of CreateIdentityPool
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data CreateIdentityPool Source #
Input to the CreateIdentityPool action.
See: createIdentityPool
smart constructor.
Request Lenses
cipSupportedLoginProviders :: Lens' CreateIdentityPool (HashMap Text Text) Source #
Optional key:value pairs mapping provider names to provider app IDs.
cipDeveloperProviderName :: 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.
cipOpenIdConnectProviderARNs :: Lens' CreateIdentityPool [Text] Source #
A list of OpendID Connect provider ARNs.
cipCognitoIdentityProviders :: Lens' CreateIdentityPool [CognitoIdentityProvider] Source #
A list representing a Cognito User Identity Pool and its client ID.
cipIdentityPoolName :: Lens' CreateIdentityPool Text Source #
A string that you provide.
cipAllowUnauthenticatedIdentities :: Lens' CreateIdentityPool Bool Source #
TRUE if the identity pool supports unauthenticated logins.
Destructuring the Response
:: 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:
data IdentityPool Source #
An object representing a Cognito identity pool.
See: identityPool
smart constructor.
Response Lenses
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 a Cognito User Identity 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.