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.Types
Contents
Description
- cognitoIdentity :: Service
- _InvalidIdentityPoolConfigurationException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError
- _NotAuthorizedException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalErrorException :: AsError a => Getting (First ServiceError) a ServiceError
- _ExternalServiceException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceConflictException :: AsError a => Getting (First ServiceError) a ServiceError
- _DeveloperUserAlreadyRegisteredException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- data AmbiguousRoleResolutionType
- data CognitoErrorCode
- data MappingRuleMatchType
- = Contains
- | Equals
- | NotEqual
- | StartsWith
- data RoleMappingType
- data CognitoIdentityProvider
- cognitoIdentityProvider :: CognitoIdentityProvider
- cipClientId :: Lens' CognitoIdentityProvider (Maybe Text)
- cipServerSideTokenCheck :: Lens' CognitoIdentityProvider (Maybe Bool)
- cipProviderName :: Lens' CognitoIdentityProvider (Maybe Text)
- data Credentials
- credentials :: Credentials
- cSessionToken :: Lens' Credentials (Maybe Text)
- cExpiration :: Lens' Credentials (Maybe UTCTime)
- cSecretKey :: Lens' Credentials (Maybe Text)
- cAccessKeyId :: Lens' Credentials (Maybe Text)
- data IdentityDescription
- identityDescription :: IdentityDescription
- idLastModifiedDate :: Lens' IdentityDescription (Maybe UTCTime)
- idCreationDate :: Lens' IdentityDescription (Maybe UTCTime)
- idLogins :: Lens' IdentityDescription [Text]
- idIdentityId :: Lens' IdentityDescription (Maybe Text)
- data IdentityPool
- identityPool :: Text -> Text -> Bool -> 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
- data IdentityPoolShortDescription
- identityPoolShortDescription :: IdentityPoolShortDescription
- ipsdIdentityPoolId :: Lens' IdentityPoolShortDescription (Maybe Text)
- ipsdIdentityPoolName :: Lens' IdentityPoolShortDescription (Maybe Text)
- data MappingRule
- mappingRule :: Text -> MappingRuleMatchType -> Text -> Text -> MappingRule
- mrClaim :: Lens' MappingRule Text
- mrMatchType :: Lens' MappingRule MappingRuleMatchType
- mrValue :: Lens' MappingRule Text
- mrRoleARN :: Lens' MappingRule Text
- data RoleMapping
- roleMapping :: RoleMappingType -> RoleMapping
- rmRulesConfiguration :: Lens' RoleMapping (Maybe RulesConfigurationType)
- rmAmbiguousRoleResolution :: Lens' RoleMapping (Maybe AmbiguousRoleResolutionType)
- rmType :: Lens' RoleMapping RoleMappingType
- data RulesConfigurationType
- rulesConfigurationType :: NonEmpty MappingRule -> RulesConfigurationType
- rctRules :: Lens' RulesConfigurationType (NonEmpty MappingRule)
- data UnprocessedIdentityId
- unprocessedIdentityId :: UnprocessedIdentityId
- uiiErrorCode :: Lens' UnprocessedIdentityId (Maybe CognitoErrorCode)
- uiiIdentityId :: Lens' UnprocessedIdentityId (Maybe Text)
Service Configuration
API version 2014-06-30
of the Amazon Cognito Identity SDK configuration.
Errors
_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 :: AsError a => Getting (First ServiceError) a ServiceError #
Thrown for missing or bad input parameter(s).
_NotAuthorizedException :: AsError a => Getting (First ServiceError) a ServiceError #
Thrown when a user is not authorized to access the requested resource.
_InternalErrorException :: AsError a => Getting (First ServiceError) a ServiceError #
Thrown when the service encounters an error during processing the request.
_ExternalServiceException :: AsError a => Getting (First ServiceError) a ServiceError #
An exception thrown when a dependent service such as Facebook or Twitter is not responding
_TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError #
Thrown when a request is throttled.
_ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError #
Thrown if there are parallel requests to modify a resource.
_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 :: AsError a => Getting (First ServiceError) a ServiceError #
The provided developer user identifier is already registered with Cognito under a different identity ID.
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError #
Thrown when the requested resource (for example, a dataset or record) does not exist.
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError #
Thrown when the total number of user pools has exceeded a preset limit.
AmbiguousRoleResolutionType
data AmbiguousRoleResolutionType #
Constructors
AuthenticatedRole | |
Deny |
Instances
CognitoErrorCode
data CognitoErrorCode #
Constructors
AccessDenied | |
InternalServerError |
Instances
MappingRuleMatchType
data MappingRuleMatchType #
Constructors
Contains | |
Equals | |
NotEqual | |
StartsWith |
Instances
RoleMappingType
data RoleMappingType #
Instances
CognitoIdentityProvider
data CognitoIdentityProvider #
A provider representing an Amazon Cognito Identity User Pool and its client ID.
See: cognitoIdentityProvider
smart constructor.
Instances
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
- The client ID for the Amazon Cognito Identity User Pool.cipServerSideTokenCheck
- TRUE if server-side token validation is enabled for the identity provider’s token.cipProviderName
- The provider name for an Amazon Cognito Identity User Pool. For example,cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789
.
cipClientId :: Lens' CognitoIdentityProvider (Maybe Text) #
The client ID for the Amazon Cognito Identity User Pool.
cipServerSideTokenCheck :: Lens' CognitoIdentityProvider (Maybe Bool) #
TRUE if server-side token validation is enabled for the identity provider’s token.
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
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
- The Session Token portion of the credentialscExpiration
- The date at which these credentials will expire.cSecretKey
- The Secret Access Key portion of the credentialscAccessKeyId
- The Access Key portion of the credentials.
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.
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
- Date on which the identity was last modified.idCreationDate
- Date on which the identity was created.idLogins
- A set of optional name-value pairs that map provider names to provider tokens.idIdentityId
- A unique identifier in the format REGION:GUID.
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 an Amazon Cognito identity pool.
See: identityPool
smart constructor.
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.
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
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
- An identity pool ID in the format REGION:GUID.ipsdIdentityPoolName
- A string that you provide.
ipsdIdentityPoolId :: Lens' IdentityPoolShortDescription (Maybe Text) #
An identity pool ID in the format REGION:GUID.
ipsdIdentityPoolName :: Lens' IdentityPoolShortDescription (Maybe Text) #
A string that you provide.
MappingRule
data MappingRule #
A rule that maps a claim name, a claim value, and a match type to a role ARN.
See: mappingRule
smart constructor.
Instances
Arguments
:: Text | |
-> MappingRuleMatchType | |
-> Text | |
-> Text | |
-> MappingRule |
Creates a value of MappingRule
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mrClaim
- The claim name that must be present in the token, for example, "isAdmin" or "paid".mrMatchType
- The match condition that specifies how closely the claim value in the IdP token must matchValue
.mrValue
- A brief string that the claim must match, for example, "paid" or "yes".mrRoleARN
- The role ARN.
mrClaim :: Lens' MappingRule Text #
The claim name that must be present in the token, for example, "isAdmin" or "paid".
mrMatchType :: Lens' MappingRule MappingRuleMatchType #
The match condition that specifies how closely the claim value in the IdP token must match Value
.
mrValue :: Lens' MappingRule Text #
A brief string that the claim must match, for example, "paid" or "yes".
mrRoleARN :: Lens' MappingRule Text #
The role ARN.
RoleMapping
Arguments
:: RoleMappingType | |
-> RoleMapping |
Creates a value of RoleMapping
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rmRulesConfiguration
- The rules to be used for mapping users to roles. If you specify Rules as the role mapping type,RulesConfiguration
is required.rmAmbiguousRoleResolution
- If you specify Token or Rules as theType
,AmbiguousRoleResolution
is required. Specifies the action to be taken if either no rules match the claim value for theRules
type, or there is nocognito:preferred_role
claim and there are multiplecognito:roles
matches for theToken
type.rmType
- The role mapping type. Token will usecognito:roles
andcognito:preferred_role
claims from the Cognito identity provider token to map groups to roles. Rules will attempt to match claims from the token to map to a role.
rmRulesConfiguration :: Lens' RoleMapping (Maybe RulesConfigurationType) #
The rules to be used for mapping users to roles. If you specify Rules as the role mapping type, RulesConfiguration
is required.
rmAmbiguousRoleResolution :: Lens' RoleMapping (Maybe AmbiguousRoleResolutionType) #
If you specify Token or Rules as the Type
, AmbiguousRoleResolution
is required. Specifies the action to be taken if either no rules match the claim value for the Rules
type, or there is no cognito:preferred_role
claim and there are multiple cognito:roles
matches for the Token
type.
rmType :: Lens' RoleMapping RoleMappingType #
The role mapping type. Token will use cognito:roles
and cognito:preferred_role
claims from the Cognito identity provider token to map groups to roles. Rules will attempt to match claims from the token to map to a role.
RulesConfigurationType
data RulesConfigurationType #
A container for rules.
See: rulesConfigurationType
smart constructor.
Instances
Arguments
:: NonEmpty MappingRule | |
-> RulesConfigurationType |
Creates a value of RulesConfigurationType
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rctRules
- An array of rules. You can specify up to 25 rules per identity provider. Rules are evaluated in order. The first one to match specifies the role.
rctRules :: Lens' RulesConfigurationType (NonEmpty MappingRule) #
An array of rules. You can specify up to 25 rules per identity provider. Rules are evaluated in order. The first one to match specifies the role.
UnprocessedIdentityId
data UnprocessedIdentityId #
An array of UnprocessedIdentityId objects, each of which contains an ErrorCode and IdentityId.
See: unprocessedIdentityId
smart constructor.
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
- The error code indicating the type of error that occurred.uiiIdentityId
- A unique identifier in the format REGION:GUID.
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.