Network.AWS.CognitoIdentity

Amazon Cognito

Amazon Cognito is a web service that delivers scoped temporary credentials to mobile devices and other untrusted environments. Amazon Cognito uniquely identifies a device and supplies the user with a consistent identity over the lifetime of an application.

Using Amazon Cognito, you can enable authentication with one or more third-party identity providers (Facebook, Google, or Login with Amazon), and you can also choose to support unauthenticated access from your app. Cognito delivers a unique identifier for each user and acts as an OpenID token provider trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS credentials.

To provide end-user credentials, first make an unsigned call to GetId. If the end user is authenticated with one of the supported identity providers, set the Logins map with the identity provider token. GetId returns a unique identifier for the user.

Next, make an unsigned call to GetCredentialsForIdentity. This call expects the same Logins map as the GetId call, as well as the IdentityID originally returned by GetId. Assuming your identity pool has been configured via the SetIdentityPoolRoles operation, GetCredentialsForIdentity will return AWS credentials for your use. If your pool has not been configured with SetIdentityPoolRoles, or if you want to follow legacy flow, make an unsigned call to GetOpenIdToken, which returns the OpenID token necessary to call STS and retrieve AWS credentials. This call expects the same Logins map as the GetId call, as well as the IdentityID originally returned by GetId. The token returned by GetOpenIdToken can be passed to the STS operation AssumeRoleWithWebIdentity to retrieve AWS credentials.

If you want to use Amazon Cognito in an Android, iOS, or Unity application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the AWS Mobile SDK Developer Guide.

Service Configuration

cognitoIdentity :: Service

API version '2014-06-30' of the Amazon Cognito Identity SDK configuration.

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by CognitoIdentity.

InvalidIdentityPoolConfigurationException

_InvalidIdentityPoolConfigurationException :: AsError a => Getting (First ServiceError) a ServiceError

Thrown if the identity pool has no role associated for the given auth type (auth/unauth) or if the AssumeRole fails.

InvalidParameterException

_InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError

Thrown for missing or bad input parameter(s).

NotAuthorizedException

_NotAuthorizedException :: AsError a => Getting (First ServiceError) a ServiceError

Thrown when a user is not authorized to access the requested resource.

InternalErrorException

_InternalErrorException :: AsError a => Getting (First ServiceError) a ServiceError

Thrown when the service encounters an error during processing the request.

ExternalServiceException

_ExternalServiceException :: AsError a => Getting (First ServiceError) a ServiceError

An exception thrown when a dependent service such as Facebook or Twitter is not responding

TooManyRequestsException

_TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError

Thrown when a request is throttled.

ConcurrentModificationException

_ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError

Thrown if there are parallel requests to modify a resource.

ResourceConflictException

_ResourceConflictException :: AsError a => Getting (First ServiceError) a ServiceError

Thrown when a user tries to use a login which is already linked to another account.

DeveloperUserAlreadyRegisteredException

_DeveloperUserAlreadyRegisteredException :: AsError a => Getting (First ServiceError) a ServiceError

The provided developer user identifier is already registered with Cognito under a different identity ID.

ResourceNotFoundException

_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError

Thrown when the requested resource (for example, a dataset or record) does not exist.

LimitExceededException

_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError

Thrown when the total number of user pools has exceeded a preset limit.

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

GetOpenIdToken

module Network.AWS.CognitoIdentity.GetOpenIdToken

GetOpenIdTokenForDeveloperIdentity

module Network.AWS.CognitoIdentity.GetOpenIdTokenForDeveloperIdentity

DescribeIdentityPool

module Network.AWS.CognitoIdentity.DescribeIdentityPool

GetId

module Network.AWS.CognitoIdentity.GetId

DeleteIdentityPool

module Network.AWS.CognitoIdentity.DeleteIdentityPool

UpdateIdentityPool

module Network.AWS.CognitoIdentity.UpdateIdentityPool

UnlinkDeveloperIdentity

module Network.AWS.CognitoIdentity.UnlinkDeveloperIdentity

GetIdentityPoolRoles

module Network.AWS.CognitoIdentity.GetIdentityPoolRoles

ListIdentityPools

module Network.AWS.CognitoIdentity.ListIdentityPools

GetCredentialsForIdentity

module Network.AWS.CognitoIdentity.GetCredentialsForIdentity

DeleteIdentities

module Network.AWS.CognitoIdentity.DeleteIdentities

SetIdentityPoolRoles

module Network.AWS.CognitoIdentity.SetIdentityPoolRoles

ListIdentities

module Network.AWS.CognitoIdentity.ListIdentities

LookupDeveloperIdentity

module Network.AWS.CognitoIdentity.LookupDeveloperIdentity

UnlinkIdentity

module Network.AWS.CognitoIdentity.UnlinkIdentity

DescribeIdentity

module Network.AWS.CognitoIdentity.DescribeIdentity

CreateIdentityPool

module Network.AWS.CognitoIdentity.CreateIdentityPool

MergeDeveloperIdentities

module Network.AWS.CognitoIdentity.MergeDeveloperIdentities

Types

CognitoErrorCode

data CognitoErrorCode

Constructors

AccessDenied

InternalServerError

Instances

Bounded CognitoErrorCode

Methods

minBound :: CognitoErrorCode

maxBound :: CognitoErrorCode

Enum CognitoErrorCode

Methods

succ :: CognitoErrorCode -> CognitoErrorCode

pred :: CognitoErrorCode -> CognitoErrorCode

toEnum :: Int -> CognitoErrorCode

fromEnum :: CognitoErrorCode -> Int

enumFrom :: CognitoErrorCode -> [CognitoErrorCode]

enumFromThen :: CognitoErrorCode -> CognitoErrorCode -> [CognitoErrorCode]

enumFromTo :: CognitoErrorCode -> CognitoErrorCode -> [CognitoErrorCode]

enumFromThenTo :: CognitoErrorCode -> CognitoErrorCode -> CognitoErrorCode -> [CognitoErrorCode]

Eq CognitoErrorCode

Methods

(==) :: CognitoErrorCode -> CognitoErrorCode -> Bool

(/=) :: CognitoErrorCode -> CognitoErrorCode -> Bool

Data CognitoErrorCode

Methods

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

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

toConstr :: CognitoErrorCode -> Constr

dataTypeOf :: CognitoErrorCode -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CognitoErrorCode)

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

gmapT :: (forall b. Data b => b -> b) -> CognitoErrorCode -> CognitoErrorCode

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

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

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

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

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

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

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

Ord CognitoErrorCode

Methods

compare :: CognitoErrorCode -> CognitoErrorCode -> Ordering

(<) :: CognitoErrorCode -> CognitoErrorCode -> Bool

(<=) :: CognitoErrorCode -> CognitoErrorCode -> Bool

(>) :: CognitoErrorCode -> CognitoErrorCode -> Bool

(>=) :: CognitoErrorCode -> CognitoErrorCode -> Bool

max :: CognitoErrorCode -> CognitoErrorCode -> CognitoErrorCode

min :: CognitoErrorCode -> CognitoErrorCode -> CognitoErrorCode

Read CognitoErrorCode

Methods

readsPrec :: Int -> ReadS CognitoErrorCode

readList :: ReadS [CognitoErrorCode]

readPrec :: ReadPrec CognitoErrorCode

readListPrec :: ReadPrec [CognitoErrorCode]

Show CognitoErrorCode

Methods

showsPrec :: Int -> CognitoErrorCode -> ShowS

show :: CognitoErrorCode -> String

showList :: [CognitoErrorCode] -> ShowS

Generic CognitoErrorCode

Associated Types

type Rep CognitoErrorCode :: * -> *

Methods

from :: CognitoErrorCode -> Rep CognitoErrorCode x

to :: Rep CognitoErrorCode x -> CognitoErrorCode

Hashable CognitoErrorCode

Methods

hashWithSalt :: Int -> CognitoErrorCode -> Int

hash :: CognitoErrorCode -> Int

NFData CognitoErrorCode

Methods

rnf :: CognitoErrorCode -> ()

ToHeader CognitoErrorCode

Methods

toHeader :: HeaderName -> CognitoErrorCode -> [Header]

ToQuery CognitoErrorCode

Methods

toQuery :: CognitoErrorCode -> QueryString

ToByteString CognitoErrorCode

Methods

toBS :: CognitoErrorCode -> ByteString

FromJSON CognitoErrorCode

Methods

parseJSON :: Value -> Parser CognitoErrorCode

FromText CognitoErrorCode

Methods

parser :: Parser CognitoErrorCode

ToText CognitoErrorCode

Methods

toText :: CognitoErrorCode -> Text

type Rep CognitoErrorCode

type Rep CognitoErrorCode = D1 (MetaData "CognitoErrorCode" "Network.AWS.CognitoIdentity.Types.Sum" "amazonka-cognito-identity-1.4.4-HCXYru6jCnl38KjgmeNXOZ" False) ((:+:) (C1 (MetaCons "AccessDenied" PrefixI False) U1) (C1 (MetaCons "InternalServerError" PrefixI False) U1))

CognitoIdentityProvider

data CognitoIdentityProvider

A provider representing an Amazon Cognito Identity User Pool and its client ID.

See: cognitoIdentityProvider smart constructor.

Instances

Eq CognitoIdentityProvider

Methods

(==) :: CognitoIdentityProvider -> CognitoIdentityProvider -> Bool

(/=) :: CognitoIdentityProvider -> CognitoIdentityProvider -> Bool

Data CognitoIdentityProvider

Methods

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

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

toConstr :: CognitoIdentityProvider -> Constr

dataTypeOf :: CognitoIdentityProvider -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CognitoIdentityProvider)

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

gmapT :: (forall b. Data b => b -> b) -> CognitoIdentityProvider -> CognitoIdentityProvider

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

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

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

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

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

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

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

Read CognitoIdentityProvider

Methods

readsPrec :: Int -> ReadS CognitoIdentityProvider

readList :: ReadS [CognitoIdentityProvider]

readPrec :: ReadPrec CognitoIdentityProvider

readListPrec :: ReadPrec [CognitoIdentityProvider]

Show CognitoIdentityProvider

Methods

showsPrec :: Int -> CognitoIdentityProvider -> ShowS

show :: CognitoIdentityProvider -> String

showList :: [CognitoIdentityProvider] -> ShowS

Generic CognitoIdentityProvider

Associated Types

type Rep CognitoIdentityProvider :: * -> *

Methods

from :: CognitoIdentityProvider -> Rep CognitoIdentityProvider x

to :: Rep CognitoIdentityProvider x -> CognitoIdentityProvider

Hashable CognitoIdentityProvider

Methods

hashWithSalt :: Int -> CognitoIdentityProvider -> Int

hash :: CognitoIdentityProvider -> Int

NFData CognitoIdentityProvider

Methods

rnf :: CognitoIdentityProvider -> ()

FromJSON CognitoIdentityProvider

Methods

parseJSON :: Value -> Parser CognitoIdentityProvider

ToJSON CognitoIdentityProvider

Methods

toJSON :: CognitoIdentityProvider -> Value

toEncoding :: CognitoIdentityProvider -> Encoding

type Rep CognitoIdentityProvider

type Rep CognitoIdentityProvider = D1 (MetaData "CognitoIdentityProvider" "Network.AWS.CognitoIdentity.Types.Product" "amazonka-cognito-identity-1.4.4-HCXYru6jCnl38KjgmeNXOZ" False) (C1 (MetaCons "CognitoIdentityProvider'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_cipClientId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cipProviderName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))

cognitoIdentityProvider :: CognitoIdentityProvider

Creates a value of CognitoIdentityProvider with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cipClientId
• cipProviderName

cipClientId :: Lens' CognitoIdentityProvider (Maybe Text)

The client ID for the Amazon Cognito Identity User Pool.

cipProviderName :: Lens' CognitoIdentityProvider (Maybe Text)

The provider name for an Amazon Cognito Identity User Pool. For example, 'cognito-idp.us-east-1.amazonaws.com\/us-east-1_123456789'.

Credentials

data Credentials

Credentials for the provided identity ID.

See: credentials smart constructor.

Instances

Eq Credentials

Methods

(==) :: Credentials -> Credentials -> Bool

(/=) :: Credentials -> Credentials -> Bool

Data Credentials

Methods

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

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

toConstr :: Credentials -> Constr

dataTypeOf :: Credentials -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Credentials)

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

gmapT :: (forall b. Data b => b -> b) -> Credentials -> Credentials

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

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

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

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

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

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

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

Read Credentials

Methods

readsPrec :: Int -> ReadS Credentials

readList :: ReadS [Credentials]

readPrec :: ReadPrec Credentials

readListPrec :: ReadPrec [Credentials]

Show Credentials

Methods

showsPrec :: Int -> Credentials -> ShowS

show :: Credentials -> String

showList :: [Credentials] -> ShowS

Generic Credentials

Associated Types

type Rep Credentials :: * -> *

Methods

from :: Credentials -> Rep Credentials x

to :: Rep Credentials x -> Credentials

Hashable Credentials

Methods

hashWithSalt :: Int -> Credentials -> Int

hash :: Credentials -> Int

NFData Credentials

Methods

rnf :: Credentials -> ()

FromJSON Credentials

Methods

parseJSON :: Value -> Parser Credentials

type Rep Credentials

type Rep Credentials = D1 (MetaData "Credentials" "Network.AWS.CognitoIdentity.Types.Product" "amazonka-cognito-identity-1.4.4-HCXYru6jCnl38KjgmeNXOZ" False) (C1 (MetaCons "Credentials'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cSessionToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cExpiration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX)))) ((:*:) (S1 (MetaSel (Just Symbol "_cSecretKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cAccessKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

credentials :: Credentials

Creates a value of Credentials with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cSessionToken
• cExpiration
• cSecretKey
• cAccessKeyId

cSessionToken :: Lens' Credentials (Maybe Text)

The Session Token portion of the credentials

cExpiration :: Lens' Credentials (Maybe UTCTime)

The date at which these credentials will expire.

cSecretKey :: Lens' Credentials (Maybe Text)

The Secret Access Key portion of the credentials

cAccessKeyId :: Lens' Credentials (Maybe Text)

The Access Key portion of the credentials.

IdentityDescription

data IdentityDescription

A description of the identity.

See: identityDescription smart constructor.

Instances

Eq IdentityDescription

Methods

(==) :: IdentityDescription -> IdentityDescription -> Bool

(/=) :: IdentityDescription -> IdentityDescription -> Bool

Data IdentityDescription

Methods

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

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

toConstr :: IdentityDescription -> Constr

dataTypeOf :: IdentityDescription -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c IdentityDescription)

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

gmapT :: (forall b. Data b => b -> b) -> IdentityDescription -> IdentityDescription

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

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

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

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

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

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

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

Read IdentityDescription

Methods

readsPrec :: Int -> ReadS IdentityDescription

readList :: ReadS [IdentityDescription]

readPrec :: ReadPrec IdentityDescription

readListPrec :: ReadPrec [IdentityDescription]

Show IdentityDescription

Methods

showsPrec :: Int -> IdentityDescription -> ShowS

show :: IdentityDescription -> String

showList :: [IdentityDescription] -> ShowS

Generic IdentityDescription

Associated Types

type Rep IdentityDescription :: * -> *

Methods

from :: IdentityDescription -> Rep IdentityDescription x

to :: Rep IdentityDescription x -> IdentityDescription

Hashable IdentityDescription

Methods

hashWithSalt :: Int -> IdentityDescription -> Int

hash :: IdentityDescription -> Int

NFData IdentityDescription

Methods

rnf :: IdentityDescription -> ()

FromJSON IdentityDescription

Methods

parseJSON :: Value -> Parser IdentityDescription

type Rep IdentityDescription

type Rep IdentityDescription = D1 (MetaData "IdentityDescription" "Network.AWS.CognitoIdentity.Types.Product" "amazonka-cognito-identity-1.4.4-HCXYru6jCnl38KjgmeNXOZ" False) (C1 (MetaCons "IdentityDescription'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_idLastModifiedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) (S1 (MetaSel (Just Symbol "_idCreationDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX)))) ((:*:) (S1 (MetaSel (Just Symbol "_idLogins") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_idIdentityId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

identityDescription :: IdentityDescription

Creates a value of IdentityDescription with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• idLastModifiedDate
• idCreationDate
• idLogins
• idIdentityId

idLastModifiedDate :: Lens' IdentityDescription (Maybe UTCTime)

Date on which the identity was last modified.

idCreationDate :: Lens' IdentityDescription (Maybe UTCTime)

Date on which the identity was created.

idLogins :: Lens' IdentityDescription [Text]

A set of optional name-value pairs that map provider names to provider tokens.

idIdentityId :: Lens' IdentityDescription (Maybe Text)

A unique identifier in the format REGION:GUID.

IdentityPool

data IdentityPool

An object representing a Cognito identity pool.

See: identityPool smart constructor.

Instances

Eq IdentityPool

Methods

(==) :: IdentityPool -> IdentityPool -> Bool

(/=) :: IdentityPool -> IdentityPool -> Bool

Data IdentityPool

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

Methods

readsPrec :: Int -> ReadS IdentityPool

readList :: ReadS [IdentityPool]

readPrec :: ReadPrec IdentityPool

readListPrec :: ReadPrec [IdentityPool]

Show IdentityPool

Methods

showsPrec :: Int -> IdentityPool -> ShowS

show :: IdentityPool -> String

showList :: [IdentityPool] -> ShowS

Generic IdentityPool

Associated Types

type Rep IdentityPool :: * -> *

Methods

from :: IdentityPool -> Rep IdentityPool x

to :: Rep IdentityPool x -> IdentityPool

Hashable IdentityPool

Methods

hashWithSalt :: Int -> IdentityPool -> Int

hash :: IdentityPool -> Int

NFData IdentityPool

Methods

rnf :: IdentityPool -> ()

FromJSON IdentityPool

Methods

parseJSON :: Value -> Parser IdentityPool

ToJSON IdentityPool

Methods

toJSON :: IdentityPool -> Value

toEncoding :: IdentityPool -> Encoding

type Rep IdentityPool

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

identityPool

Arguments

:: Text

ipIdentityPoolId

-> Text

ipIdentityPoolName

-> Bool

ipAllowUnauthenticatedIdentities

-> 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
• ipSupportedLoginProviders
• ipDeveloperProviderName
• ipOpenIdConnectProviderARNs
• ipCognitoIdentityProviders
• ipIdentityPoolId
• ipIdentityPoolName
• ipAllowUnauthenticatedIdentities

ipSamlProviderARNs :: Lens' IdentityPool [Text]

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

ipSupportedLoginProviders :: Lens' IdentityPool (HashMap Text Text)

Optional key:value pairs mapping provider names to provider app IDs.

ipDeveloperProviderName :: Lens' IdentityPool (Maybe Text)

The "domain" by which Cognito will refer to your users.

ipOpenIdConnectProviderARNs :: Lens' IdentityPool [Text]

A list of OpendID Connect provider ARNs.

ipCognitoIdentityProviders :: Lens' IdentityPool [CognitoIdentityProvider]

A list representing an Amazon Cognito Identity User Pool and its client ID.

ipIdentityPoolId :: Lens' IdentityPool Text

An identity pool ID in the format REGION:GUID.

ipIdentityPoolName :: Lens' IdentityPool Text

A string that you provide.

ipAllowUnauthenticatedIdentities :: Lens' IdentityPool Bool

TRUE if the identity pool supports unauthenticated logins.

IdentityPoolShortDescription

data IdentityPoolShortDescription

A description of the identity pool.

See: identityPoolShortDescription smart constructor.

Instances

Eq IdentityPoolShortDescription

Methods

(==) :: IdentityPoolShortDescription -> IdentityPoolShortDescription -> Bool

(/=) :: IdentityPoolShortDescription -> IdentityPoolShortDescription -> Bool

Data IdentityPoolShortDescription

Methods

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

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

toConstr :: IdentityPoolShortDescription -> Constr

dataTypeOf :: IdentityPoolShortDescription -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c IdentityPoolShortDescription)

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

gmapT :: (forall b. Data b => b -> b) -> IdentityPoolShortDescription -> IdentityPoolShortDescription

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

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

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

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

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

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

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

Read IdentityPoolShortDescription

Methods

readsPrec :: Int -> ReadS IdentityPoolShortDescription

readList :: ReadS [IdentityPoolShortDescription]

readPrec :: ReadPrec IdentityPoolShortDescription

readListPrec :: ReadPrec [IdentityPoolShortDescription]

Show IdentityPoolShortDescription

Methods

showsPrec :: Int -> IdentityPoolShortDescription -> ShowS

show :: IdentityPoolShortDescription -> String

showList :: [IdentityPoolShortDescription] -> ShowS

Generic IdentityPoolShortDescription

Associated Types

type Rep IdentityPoolShortDescription :: * -> *

Methods

from :: IdentityPoolShortDescription -> Rep IdentityPoolShortDescription x

to :: Rep IdentityPoolShortDescription x -> IdentityPoolShortDescription

Hashable IdentityPoolShortDescription

Methods

hashWithSalt :: Int -> IdentityPoolShortDescription -> Int

hash :: IdentityPoolShortDescription -> Int

NFData IdentityPoolShortDescription

Methods

rnf :: IdentityPoolShortDescription -> ()

FromJSON IdentityPoolShortDescription

Methods

parseJSON :: Value -> Parser IdentityPoolShortDescription

type Rep IdentityPoolShortDescription

type Rep IdentityPoolShortDescription = D1 (MetaData "IdentityPoolShortDescription" "Network.AWS.CognitoIdentity.Types.Product" "amazonka-cognito-identity-1.4.4-HCXYru6jCnl38KjgmeNXOZ" False) (C1 (MetaCons "IdentityPoolShortDescription'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ipsdIdentityPoolId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ipsdIdentityPoolName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))

identityPoolShortDescription :: IdentityPoolShortDescription

Creates a value of IdentityPoolShortDescription with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ipsdIdentityPoolId
• ipsdIdentityPoolName

ipsdIdentityPoolId :: Lens' IdentityPoolShortDescription (Maybe Text)

An identity pool ID in the format REGION:GUID.

ipsdIdentityPoolName :: Lens' IdentityPoolShortDescription (Maybe Text)

A string that you provide.

UnprocessedIdentityId

data UnprocessedIdentityId

An array of UnprocessedIdentityId objects, each of which contains an ErrorCode and IdentityId.

See: unprocessedIdentityId smart constructor.

Instances

Eq UnprocessedIdentityId

Methods

(==) :: UnprocessedIdentityId -> UnprocessedIdentityId -> Bool

(/=) :: UnprocessedIdentityId -> UnprocessedIdentityId -> Bool

Data UnprocessedIdentityId

Methods

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

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

toConstr :: UnprocessedIdentityId -> Constr

dataTypeOf :: UnprocessedIdentityId -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UnprocessedIdentityId)

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

gmapT :: (forall b. Data b => b -> b) -> UnprocessedIdentityId -> UnprocessedIdentityId

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

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

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

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

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

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

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

Read UnprocessedIdentityId

Methods

readsPrec :: Int -> ReadS UnprocessedIdentityId

readList :: ReadS [UnprocessedIdentityId]

readPrec :: ReadPrec UnprocessedIdentityId

readListPrec :: ReadPrec [UnprocessedIdentityId]

Show UnprocessedIdentityId

Methods

showsPrec :: Int -> UnprocessedIdentityId -> ShowS

show :: UnprocessedIdentityId -> String

showList :: [UnprocessedIdentityId] -> ShowS

Generic UnprocessedIdentityId

Associated Types

type Rep UnprocessedIdentityId :: * -> *

Methods

from :: UnprocessedIdentityId -> Rep UnprocessedIdentityId x

to :: Rep UnprocessedIdentityId x -> UnprocessedIdentityId

Hashable UnprocessedIdentityId

Methods

hashWithSalt :: Int -> UnprocessedIdentityId -> Int

hash :: UnprocessedIdentityId -> Int

NFData UnprocessedIdentityId

Methods

rnf :: UnprocessedIdentityId -> ()

FromJSON UnprocessedIdentityId

Methods

parseJSON :: Value -> Parser UnprocessedIdentityId

type Rep UnprocessedIdentityId

type Rep UnprocessedIdentityId = D1 (MetaData "UnprocessedIdentityId" "Network.AWS.CognitoIdentity.Types.Product" "amazonka-cognito-identity-1.4.4-HCXYru6jCnl38KjgmeNXOZ" False) (C1 (MetaCons "UnprocessedIdentityId'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_uiiErrorCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CognitoErrorCode))) (S1 (MetaSel (Just Symbol "_uiiIdentityId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))

unprocessedIdentityId :: UnprocessedIdentityId

Creates a value of UnprocessedIdentityId with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• uiiErrorCode
• uiiIdentityId

uiiErrorCode :: Lens' UnprocessedIdentityId (Maybe CognitoErrorCode)

The error code indicating the type of error that occurred.

uiiIdentityId :: Lens' UnprocessedIdentityId (Maybe Text)

A unique identifier in the format REGION:GUID.