amazonka-cognito-identity-1.6.1: Amazon Cognito Identity SDK.

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

Network.AWS.CognitoIdentity.CreateIdentityPool

Contents

Description

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.

Synopsis

Creating a Request

createIdentityPool Source #

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:

  • cipSamlProviderARNs - An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
  • cipSupportedLoginProviders - Optional key:value pairs mapping provider names to provider app IDs.
  • cipDeveloperProviderName - 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 - A list of OpendID Connect provider ARNs.
  • cipCognitoIdentityProviders - An array of Amazon Cognito Identity user pools and their client IDs.
  • cipIdentityPoolName - A string that you provide.
  • cipAllowUnauthenticatedIdentities - TRUE if the identity pool supports unauthenticated logins.

data CreateIdentityPool Source #

Input to the CreateIdentityPool action.

See: createIdentityPool smart constructor.

Instances
Eq CreateIdentityPool Source # 
Instance details

Defined in Network.AWS.CognitoIdentity.CreateIdentityPool

Data CreateIdentityPool Source # 
Instance details

Defined in Network.AWS.CognitoIdentity.CreateIdentityPool

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateIdentityPool -> c CreateIdentityPool #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateIdentityPool #

toConstr :: CreateIdentityPool -> Constr #

dataTypeOf :: CreateIdentityPool -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreateIdentityPool) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateIdentityPool) #

gmapT :: (forall b. Data b => b -> b) -> CreateIdentityPool -> CreateIdentityPool #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateIdentityPool -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateIdentityPool -> r #

gmapQ :: (forall d. Data d => d -> u) -> CreateIdentityPool -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateIdentityPool -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateIdentityPool -> m CreateIdentityPool #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateIdentityPool -> m CreateIdentityPool #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateIdentityPool -> m CreateIdentityPool #

Read CreateIdentityPool Source # 
Instance details

Defined in Network.AWS.CognitoIdentity.CreateIdentityPool

Show CreateIdentityPool Source # 
Instance details

Defined in Network.AWS.CognitoIdentity.CreateIdentityPool

Generic CreateIdentityPool Source # 
Instance details

Defined in Network.AWS.CognitoIdentity.CreateIdentityPool

Associated Types

type Rep CreateIdentityPool :: Type -> Type #

Hashable CreateIdentityPool Source # 
Instance details

Defined in Network.AWS.CognitoIdentity.CreateIdentityPool

ToJSON CreateIdentityPool Source # 
Instance details

Defined in Network.AWS.CognitoIdentity.CreateIdentityPool

AWSRequest CreateIdentityPool Source # 
Instance details

Defined in Network.AWS.CognitoIdentity.CreateIdentityPool

Associated Types

type Rs CreateIdentityPool :: Type #

ToHeaders CreateIdentityPool Source # 
Instance details

Defined in Network.AWS.CognitoIdentity.CreateIdentityPool

ToPath CreateIdentityPool Source # 
Instance details

Defined in Network.AWS.CognitoIdentity.CreateIdentityPool

ToQuery CreateIdentityPool Source # 
Instance details

Defined in Network.AWS.CognitoIdentity.CreateIdentityPool

NFData CreateIdentityPool Source # 
Instance details

Defined in Network.AWS.CognitoIdentity.CreateIdentityPool

Methods

rnf :: CreateIdentityPool -> () #

type Rep CreateIdentityPool Source # 
Instance details

Defined in Network.AWS.CognitoIdentity.CreateIdentityPool

type Rep CreateIdentityPool = D1 (MetaData "CreateIdentityPool" "Network.AWS.CognitoIdentity.CreateIdentityPool" "amazonka-cognito-identity-1.6.1-JxIOswo68EQKpplMh7b7yR" False) (C1 (MetaCons "CreateIdentityPool'" PrefixI True) ((S1 (MetaSel (Just "_cipSamlProviderARNs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 (MetaSel (Just "_cipSupportedLoginProviders") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text))) :*: S1 (MetaSel (Just "_cipDeveloperProviderName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_cipOpenIdConnectProviderARNs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_cipCognitoIdentityProviders") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [CognitoIdentityProvider]))) :*: (S1 (MetaSel (Just "_cipIdentityPoolName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_cipAllowUnauthenticatedIdentities") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)))))
type Rs CreateIdentityPool Source # 
Instance details

Defined in Network.AWS.CognitoIdentity.CreateIdentityPool

Request Lenses

cipSamlProviderARNs :: Lens' CreateIdentityPool [Text] Source #

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

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 #

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

cipAllowUnauthenticatedIdentities :: Lens' CreateIdentityPool Bool Source #

TRUE if the identity pool supports unauthenticated logins.

Destructuring the Response

identityPool Source #

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 an Amazon Cognito identity pool.

See: identityPool smart constructor.

Instances
Eq IdentityPool Source # 
Instance details

Defined in Network.AWS.CognitoIdentity.Types.Product

Data IdentityPool Source # 
Instance details

Defined in Network.AWS.CognitoIdentity.Types.Product

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> IdentityPool -> c IdentityPool #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c IdentityPool #

toConstr :: IdentityPool -> Constr #

dataTypeOf :: IdentityPool -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c IdentityPool) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c IdentityPool) #

gmapT :: (forall b. Data b => b -> b) -> IdentityPool -> IdentityPool #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> IdentityPool -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> IdentityPool -> r #

gmapQ :: (forall d. Data d => d -> u) -> IdentityPool -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> IdentityPool -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> IdentityPool -> m IdentityPool #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> IdentityPool -> m IdentityPool #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> IdentityPool -> m IdentityPool #

Read IdentityPool Source # 
Instance details

Defined in Network.AWS.CognitoIdentity.Types.Product

Show IdentityPool Source # 
Instance details

Defined in Network.AWS.CognitoIdentity.Types.Product

Generic IdentityPool Source # 
Instance details

Defined in Network.AWS.CognitoIdentity.Types.Product

Associated Types

type Rep IdentityPool :: Type -> Type #

Hashable IdentityPool Source # 
Instance details

Defined in Network.AWS.CognitoIdentity.Types.Product

ToJSON IdentityPool Source # 
Instance details

Defined in Network.AWS.CognitoIdentity.Types.Product

FromJSON IdentityPool Source # 
Instance details

Defined in Network.AWS.CognitoIdentity.Types.Product

NFData IdentityPool Source # 
Instance details

Defined in Network.AWS.CognitoIdentity.Types.Product

Methods

rnf :: IdentityPool -> () #

type Rep IdentityPool Source # 
Instance details

Defined in Network.AWS.CognitoIdentity.Types.Product

type Rep IdentityPool = D1 (MetaData "IdentityPool" "Network.AWS.CognitoIdentity.Types.Product" "amazonka-cognito-identity-1.6.1-JxIOswo68EQKpplMh7b7yR" False) (C1 (MetaCons "IdentityPool'" PrefixI True) (((S1 (MetaSel (Just "_ipSamlProviderARNs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_ipSupportedLoginProviders") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))) :*: (S1 (MetaSel (Just "_ipDeveloperProviderName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ipOpenIdConnectProviderARNs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])))) :*: ((S1 (MetaSel (Just "_ipCognitoIdentityProviders") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [CognitoIdentityProvider])) :*: S1 (MetaSel (Just "_ipIdentityPoolId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :*: (S1 (MetaSel (Just "_ipIdentityPoolName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_ipAllowUnauthenticatedIdentities") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)))))

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.