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 |
- Service Configuration
- Errors
- PasswordResetRequiredException
- InvalidParameterException
- InvalidLambdaResponseException
- InvalidEmailRoleAccessPolicyException
- UserNotFoundException
- UnexpectedLambdaException
- NotAuthorizedException
- InternalErrorException
- InvalidUserPoolConfigurationException
- InvalidSmsRoleAccessPolicyException
- CodeMismatchException
- UserImportInProgressException
- InvalidSmsRoleTrustRelationshipException
- TooManyRequestsException
- ConcurrentModificationException
- UserLambdaValidationException
- PreconditionNotMetException
- ExpiredCodeException
- TooManyFailedAttemptsException
- UserNotConfirmedException
- CodeDeliveryFailureException
- ResourceNotFoundException
- MFAMethodNotFoundException
- AliasExistsException
- LimitExceededException
- InvalidPasswordException
- UsernameExistsException
- Waiters
- Operations
- DeleteUserPool
- UpdateUserPool
- AdminInitiateAuth
- AdminEnableUser
- GetUserAttributeVerificationCode
- UpdateUserAttributes
- DeleteUserAttributes
- VerifyUserAttribute
- AdminDisableUser
- ConfirmDevice
- ConfirmForgotPassword
- ListUserImportJobs
- ListUsers
- AdminDeleteUserAttributes
- AdminUpdateUserAttributes
- AdminGetUser
- AdminUserGlobalSignOut
- ForgotPassword
- DescribeUserPool
- InitiateAuth
- AdminConfirmSignUp
- StartUserImportJob
- GetDevice
- SignUp
- ChangePassword
- RespondToAuthChallenge
- CreateUserPool
- AdminGetDevice
- ConfirmSignUp
- ListUserPools
- AdminResetUserPassword
- CreateUserImportJob
- GetUser
- GetCSVHeader
- AdminDeleteUser
- AdminForgetDevice
- AdminUpdateDeviceStatus
- AddCustomAttributes
- ListUserPoolClients
- UpdateUserPoolClient
- DeleteUserPoolClient
- UpdateDeviceStatus
- ForgetDevice
- DeleteUser
- CreateUserPoolClient
- StopUserImportJob
- DescribeUserImportJob
- GlobalSignOut
- AdminRespondToAuthChallenge
- SetUserSettings
- AdminListDevices
- DescribeUserPoolClient
- ResendConfirmationCode
- AdminSetUserSettings
- ListDevices
- Types
- AliasAttributeType
- AttributeDataType
- AuthFlowType
- ChallengeNameType
- DeliveryMediumType
- DeviceRememberedStatusType
- ExplicitAuthFlowsType
- StatusType
- UserImportJobStatusType
- UserPoolMFAType
- UserStatusType
- VerifiedAttributeType
- AttributeType
- AuthenticationResultType
- CodeDeliveryDetailsType
- DeviceConfigurationType
- DeviceSecretVerifierConfigType
- DeviceType
- EmailConfigurationType
- LambdaConfigType
- MFAOptionType
- NewDeviceMetadataType
- NumberAttributeConstraintsType
- PasswordPolicyType
- SchemaAttributeType
- SmsConfigurationType
- StringAttributeConstraintsType
- UserImportJobType
- UserPoolClientDescription
- UserPoolClientType
- UserPoolDescriptionType
- UserPoolPolicyType
- UserPoolType
- UserType
You can create a user pool in Amazon Cognito Identity to manage directories and users. You can authenticate a user to obtain tokens related to user identity and access policies.
This API reference provides information about user pools in Amazon Cognito Identity.
For more information, see Amazon Cognito.
- cognitoIdentityProvider :: Service
- _PasswordResetRequiredException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidLambdaResponseException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidEmailRoleAccessPolicyException :: AsError a => Getting (First ServiceError) a ServiceError
- _UserNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _UnexpectedLambdaException :: AsError a => Getting (First ServiceError) a ServiceError
- _NotAuthorizedException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalErrorException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidUserPoolConfigurationException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidSmsRoleAccessPolicyException :: AsError a => Getting (First ServiceError) a ServiceError
- _CodeMismatchException :: AsError a => Getting (First ServiceError) a ServiceError
- _UserImportInProgressException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidSmsRoleTrustRelationshipException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError
- _UserLambdaValidationException :: AsError a => Getting (First ServiceError) a ServiceError
- _PreconditionNotMetException :: AsError a => Getting (First ServiceError) a ServiceError
- _ExpiredCodeException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyFailedAttemptsException :: AsError a => Getting (First ServiceError) a ServiceError
- _UserNotConfirmedException :: AsError a => Getting (First ServiceError) a ServiceError
- _CodeDeliveryFailureException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _MFAMethodNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _AliasExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidPasswordException :: AsError a => Getting (First ServiceError) a ServiceError
- _UsernameExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- module Network.AWS.CognitoIdentityProvider.DeleteUserPool
- module Network.AWS.CognitoIdentityProvider.UpdateUserPool
- module Network.AWS.CognitoIdentityProvider.AdminInitiateAuth
- module Network.AWS.CognitoIdentityProvider.AdminEnableUser
- module Network.AWS.CognitoIdentityProvider.GetUserAttributeVerificationCode
- module Network.AWS.CognitoIdentityProvider.UpdateUserAttributes
- module Network.AWS.CognitoIdentityProvider.DeleteUserAttributes
- module Network.AWS.CognitoIdentityProvider.VerifyUserAttribute
- module Network.AWS.CognitoIdentityProvider.AdminDisableUser
- module Network.AWS.CognitoIdentityProvider.ConfirmDevice
- module Network.AWS.CognitoIdentityProvider.ConfirmForgotPassword
- module Network.AWS.CognitoIdentityProvider.ListUserImportJobs
- module Network.AWS.CognitoIdentityProvider.ListUsers
- module Network.AWS.CognitoIdentityProvider.AdminDeleteUserAttributes
- module Network.AWS.CognitoIdentityProvider.AdminUpdateUserAttributes
- module Network.AWS.CognitoIdentityProvider.AdminGetUser
- module Network.AWS.CognitoIdentityProvider.AdminUserGlobalSignOut
- module Network.AWS.CognitoIdentityProvider.ForgotPassword
- module Network.AWS.CognitoIdentityProvider.DescribeUserPool
- module Network.AWS.CognitoIdentityProvider.InitiateAuth
- module Network.AWS.CognitoIdentityProvider.AdminConfirmSignUp
- module Network.AWS.CognitoIdentityProvider.StartUserImportJob
- module Network.AWS.CognitoIdentityProvider.GetDevice
- module Network.AWS.CognitoIdentityProvider.SignUp
- module Network.AWS.CognitoIdentityProvider.ChangePassword
- module Network.AWS.CognitoIdentityProvider.RespondToAuthChallenge
- module Network.AWS.CognitoIdentityProvider.CreateUserPool
- module Network.AWS.CognitoIdentityProvider.AdminGetDevice
- module Network.AWS.CognitoIdentityProvider.ConfirmSignUp
- module Network.AWS.CognitoIdentityProvider.ListUserPools
- module Network.AWS.CognitoIdentityProvider.AdminResetUserPassword
- module Network.AWS.CognitoIdentityProvider.CreateUserImportJob
- module Network.AWS.CognitoIdentityProvider.GetUser
- module Network.AWS.CognitoIdentityProvider.GetCSVHeader
- module Network.AWS.CognitoIdentityProvider.AdminDeleteUser
- module Network.AWS.CognitoIdentityProvider.AdminForgetDevice
- module Network.AWS.CognitoIdentityProvider.AdminUpdateDeviceStatus
- module Network.AWS.CognitoIdentityProvider.AddCustomAttributes
- module Network.AWS.CognitoIdentityProvider.ListUserPoolClients
- module Network.AWS.CognitoIdentityProvider.UpdateUserPoolClient
- module Network.AWS.CognitoIdentityProvider.DeleteUserPoolClient
- module Network.AWS.CognitoIdentityProvider.UpdateDeviceStatus
- module Network.AWS.CognitoIdentityProvider.ForgetDevice
- module Network.AWS.CognitoIdentityProvider.DeleteUser
- module Network.AWS.CognitoIdentityProvider.CreateUserPoolClient
- module Network.AWS.CognitoIdentityProvider.StopUserImportJob
- module Network.AWS.CognitoIdentityProvider.DescribeUserImportJob
- module Network.AWS.CognitoIdentityProvider.GlobalSignOut
- module Network.AWS.CognitoIdentityProvider.AdminRespondToAuthChallenge
- module Network.AWS.CognitoIdentityProvider.SetUserSettings
- module Network.AWS.CognitoIdentityProvider.AdminListDevices
- module Network.AWS.CognitoIdentityProvider.DescribeUserPoolClient
- module Network.AWS.CognitoIdentityProvider.ResendConfirmationCode
- module Network.AWS.CognitoIdentityProvider.AdminSetUserSettings
- module Network.AWS.CognitoIdentityProvider.ListDevices
- data AliasAttributeType
- data AttributeDataType
- data AuthFlowType
- data ChallengeNameType
- data DeliveryMediumType
- data DeviceRememberedStatusType
- data ExplicitAuthFlowsType
- data StatusType
- data UserImportJobStatusType
- data UserPoolMFAType
- data UserStatusType
- data VerifiedAttributeType
- | PhoneNumber
- data AttributeType
- attributeType :: Text -> AttributeType
- atValue :: Lens' AttributeType (Maybe Text)
- atName :: Lens' AttributeType Text
- data AuthenticationResultType
- authenticationResultType :: AuthenticationResultType
- artAccessToken :: Lens' AuthenticationResultType (Maybe Text)
- artRefreshToken :: Lens' AuthenticationResultType (Maybe Text)
- artNewDeviceMetadata :: Lens' AuthenticationResultType (Maybe NewDeviceMetadataType)
- artExpiresIn :: Lens' AuthenticationResultType (Maybe Int)
- artTokenType :: Lens' AuthenticationResultType (Maybe Text)
- artIdToken :: Lens' AuthenticationResultType (Maybe Text)
- data CodeDeliveryDetailsType
- codeDeliveryDetailsType :: CodeDeliveryDetailsType
- cddtDestination :: Lens' CodeDeliveryDetailsType (Maybe Text)
- cddtDeliveryMedium :: Lens' CodeDeliveryDetailsType (Maybe DeliveryMediumType)
- cddtAttributeName :: Lens' CodeDeliveryDetailsType (Maybe Text)
- data DeviceConfigurationType
- deviceConfigurationType :: DeviceConfigurationType
- dctChallengeRequiredOnNewDevice :: Lens' DeviceConfigurationType (Maybe Bool)
- dctDeviceOnlyRememberedOnUserPrompt :: Lens' DeviceConfigurationType (Maybe Bool)
- data DeviceSecretVerifierConfigType
- deviceSecretVerifierConfigType :: DeviceSecretVerifierConfigType
- dsvctPasswordVerifier :: Lens' DeviceSecretVerifierConfigType (Maybe Text)
- dsvctSalt :: Lens' DeviceSecretVerifierConfigType (Maybe Text)
- data DeviceType
- deviceType :: DeviceType
- dtDeviceLastModifiedDate :: Lens' DeviceType (Maybe UTCTime)
- dtDeviceCreateDate :: Lens' DeviceType (Maybe UTCTime)
- dtDeviceAttributes :: Lens' DeviceType [AttributeType]
- dtDeviceKey :: Lens' DeviceType (Maybe Text)
- dtDeviceLastAuthenticatedDate :: Lens' DeviceType (Maybe UTCTime)
- data EmailConfigurationType
- emailConfigurationType :: EmailConfigurationType
- ectSourceARN :: Lens' EmailConfigurationType (Maybe Text)
- ectReplyToEmailAddress :: Lens' EmailConfigurationType (Maybe Text)
- data LambdaConfigType
- lambdaConfigType :: LambdaConfigType
- lctPreAuthentication :: Lens' LambdaConfigType (Maybe Text)
- lctCreateAuthChallenge :: Lens' LambdaConfigType (Maybe Text)
- lctVerifyAuthChallengeResponse :: Lens' LambdaConfigType (Maybe Text)
- lctPostAuthentication :: Lens' LambdaConfigType (Maybe Text)
- lctCustomMessage :: Lens' LambdaConfigType (Maybe Text)
- lctDefineAuthChallenge :: Lens' LambdaConfigType (Maybe Text)
- lctPostConfirmation :: Lens' LambdaConfigType (Maybe Text)
- lctPreSignUp :: Lens' LambdaConfigType (Maybe Text)
- data MFAOptionType
- mfaOptionType :: MFAOptionType
- motDeliveryMedium :: Lens' MFAOptionType (Maybe DeliveryMediumType)
- motAttributeName :: Lens' MFAOptionType (Maybe Text)
- data NewDeviceMetadataType
- newDeviceMetadataType :: NewDeviceMetadataType
- ndmtDeviceGroupKey :: Lens' NewDeviceMetadataType (Maybe Text)
- ndmtDeviceKey :: Lens' NewDeviceMetadataType (Maybe Text)
- data NumberAttributeConstraintsType
- numberAttributeConstraintsType :: NumberAttributeConstraintsType
- nactMaxValue :: Lens' NumberAttributeConstraintsType (Maybe Text)
- nactMinValue :: Lens' NumberAttributeConstraintsType (Maybe Text)
- data PasswordPolicyType
- passwordPolicyType :: PasswordPolicyType
- pptRequireNumbers :: Lens' PasswordPolicyType (Maybe Bool)
- pptRequireUppercase :: Lens' PasswordPolicyType (Maybe Bool)
- pptRequireLowercase :: Lens' PasswordPolicyType (Maybe Bool)
- pptMinimumLength :: Lens' PasswordPolicyType (Maybe Natural)
- pptRequireSymbols :: Lens' PasswordPolicyType (Maybe Bool)
- data SchemaAttributeType
- schemaAttributeType :: SchemaAttributeType
- satNumberAttributeConstraints :: Lens' SchemaAttributeType (Maybe NumberAttributeConstraintsType)
- satRequired :: Lens' SchemaAttributeType (Maybe Bool)
- satAttributeDataType :: Lens' SchemaAttributeType (Maybe AttributeDataType)
- satStringAttributeConstraints :: Lens' SchemaAttributeType (Maybe StringAttributeConstraintsType)
- satName :: Lens' SchemaAttributeType (Maybe Text)
- satDeveloperOnlyAttribute :: Lens' SchemaAttributeType (Maybe Bool)
- satMutable :: Lens' SchemaAttributeType (Maybe Bool)
- data SmsConfigurationType
- smsConfigurationType :: SmsConfigurationType
- sctSNSCallerARN :: Lens' SmsConfigurationType (Maybe Text)
- sctExternalId :: Lens' SmsConfigurationType (Maybe Text)
- data StringAttributeConstraintsType
- stringAttributeConstraintsType :: StringAttributeConstraintsType
- sactMaxLength :: Lens' StringAttributeConstraintsType (Maybe Text)
- sactMinLength :: Lens' StringAttributeConstraintsType (Maybe Text)
- data UserImportJobType
- userImportJobType :: UserImportJobType
- uijtStatus :: Lens' UserImportJobType (Maybe UserImportJobStatusType)
- uijtSkippedUsers :: Lens' UserImportJobType (Maybe Integer)
- uijtJobId :: Lens' UserImportJobType (Maybe Text)
- uijtUserPoolId :: Lens' UserImportJobType (Maybe Text)
- uijtJobName :: Lens' UserImportJobType (Maybe Text)
- uijtPreSignedURL :: Lens' UserImportJobType (Maybe Text)
- uijtFailedUsers :: Lens' UserImportJobType (Maybe Integer)
- uijtStartDate :: Lens' UserImportJobType (Maybe UTCTime)
- uijtCompletionMessage :: Lens' UserImportJobType (Maybe Text)
- uijtCreationDate :: Lens' UserImportJobType (Maybe UTCTime)
- uijtCompletionDate :: Lens' UserImportJobType (Maybe UTCTime)
- uijtCloudWatchLogsRoleARN :: Lens' UserImportJobType (Maybe Text)
- uijtImportedUsers :: Lens' UserImportJobType (Maybe Integer)
- data UserPoolClientDescription
- userPoolClientDescription :: UserPoolClientDescription
- upcdClientId :: Lens' UserPoolClientDescription (Maybe Text)
- upcdUserPoolId :: Lens' UserPoolClientDescription (Maybe Text)
- upcdClientName :: Lens' UserPoolClientDescription (Maybe Text)
- data UserPoolClientType
- userPoolClientType :: UserPoolClientType
- upctRefreshTokenValidity :: Lens' UserPoolClientType (Maybe Natural)
- upctClientId :: Lens' UserPoolClientType (Maybe Text)
- upctExplicitAuthFlows :: Lens' UserPoolClientType [ExplicitAuthFlowsType]
- upctClientSecret :: Lens' UserPoolClientType (Maybe Text)
- upctLastModifiedDate :: Lens' UserPoolClientType (Maybe UTCTime)
- upctUserPoolId :: Lens' UserPoolClientType (Maybe Text)
- upctWriteAttributes :: Lens' UserPoolClientType [Text]
- upctCreationDate :: Lens' UserPoolClientType (Maybe UTCTime)
- upctReadAttributes :: Lens' UserPoolClientType [Text]
- upctClientName :: Lens' UserPoolClientType (Maybe Text)
- data UserPoolDescriptionType
- userPoolDescriptionType :: UserPoolDescriptionType
- updtStatus :: Lens' UserPoolDescriptionType (Maybe StatusType)
- updtLastModifiedDate :: Lens' UserPoolDescriptionType (Maybe UTCTime)
- updtName :: Lens' UserPoolDescriptionType (Maybe Text)
- updtId :: Lens' UserPoolDescriptionType (Maybe Text)
- updtCreationDate :: Lens' UserPoolDescriptionType (Maybe UTCTime)
- updtLambdaConfig :: Lens' UserPoolDescriptionType (Maybe LambdaConfigType)
- data UserPoolPolicyType
- userPoolPolicyType :: UserPoolPolicyType
- upptPasswordPolicy :: Lens' UserPoolPolicyType (Maybe PasswordPolicyType)
- data UserPoolType
- userPoolType :: UserPoolType
- uptStatus :: Lens' UserPoolType (Maybe StatusType)
- uptEmailConfigurationFailure :: Lens' UserPoolType (Maybe Text)
- uptLastModifiedDate :: Lens' UserPoolType (Maybe UTCTime)
- uptEstimatedNumberOfUsers :: Lens' UserPoolType (Maybe Int)
- uptEmailVerificationMessage :: Lens' UserPoolType (Maybe Text)
- uptSmsAuthenticationMessage :: Lens' UserPoolType (Maybe Text)
- uptSchemaAttributes :: Lens' UserPoolType (Maybe (NonEmpty SchemaAttributeType))
- uptEmailVerificationSubject :: Lens' UserPoolType (Maybe Text)
- uptAliasAttributes :: Lens' UserPoolType [AliasAttributeType]
- uptEmailConfiguration :: Lens' UserPoolType (Maybe EmailConfigurationType)
- uptSmsVerificationMessage :: Lens' UserPoolType (Maybe Text)
- uptName :: Lens' UserPoolType (Maybe Text)
- uptMFAConfiguration :: Lens' UserPoolType (Maybe UserPoolMFAType)
- uptId :: Lens' UserPoolType (Maybe Text)
- uptSmsConfigurationFailure :: Lens' UserPoolType (Maybe Text)
- uptCreationDate :: Lens' UserPoolType (Maybe UTCTime)
- uptLambdaConfig :: Lens' UserPoolType (Maybe LambdaConfigType)
- uptSmsConfiguration :: Lens' UserPoolType (Maybe SmsConfigurationType)
- uptDeviceConfiguration :: Lens' UserPoolType (Maybe DeviceConfigurationType)
- uptAutoVerifiedAttributes :: Lens' UserPoolType [VerifiedAttributeType]
- uptPolicies :: Lens' UserPoolType (Maybe UserPoolPolicyType)
- data UserType
- userType :: UserType
- utEnabled :: Lens' UserType (Maybe Bool)
- utUserStatus :: Lens' UserType (Maybe UserStatusType)
- utUsername :: Lens' UserType (Maybe Text)
- utUserCreateDate :: Lens' UserType (Maybe UTCTime)
- utAttributes :: Lens' UserType [AttributeType]
- utUserLastModifiedDate :: Lens' UserType (Maybe UTCTime)
Service Configuration
cognitoIdentityProvider :: Service Source #
API version '2016-04-18' of the Amazon Cognito Identity Provider 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 CognitoIdentityProvider
.
PasswordResetRequiredException
_PasswordResetRequiredException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when a password reset is required.
InvalidParameterException
_InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
InvalidLambdaResponseException
_InvalidLambdaResponseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.
InvalidEmailRoleAccessPolicyException
_InvalidEmailRoleAccessPolicyException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code: 400.
UserNotFoundException
_UserNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when a user is not found.
UnexpectedLambdaException
_UnexpectedLambdaException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception gets thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.
NotAuthorizedException
_NotAuthorizedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception gets thrown when a user is not authorized.
InternalErrorException
_InternalErrorException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when Amazon Cognito encounters an internal error.
InvalidUserPoolConfigurationException
_InvalidUserPoolConfigurationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the user pool configuration is invalid.
InvalidSmsRoleAccessPolicyException
_InvalidSmsRoleAccessPolicyException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is returned when the role provided for SMS configuration does not have permission to publish using Amazon SNS.
CodeMismatchException
_CodeMismatchException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown if the provided code does not match what the server was expecting.
UserImportInProgressException
_UserImportInProgressException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when you are trying to modify a user pool while a user import job is in progress for that pool.
InvalidSmsRoleTrustRelationshipException
_InvalidSmsRoleTrustRelationshipException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the trust relationship is invalid for the role provided for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.
TooManyRequestsException
_TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception gets thrown when the user has made too many requests for a given operation.
ConcurrentModificationException
_ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown if two or more modifications are happening concurrently.
UserLambdaValidationException
_UserLambdaValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.
PreconditionNotMetException
_PreconditionNotMetException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when a precondition is not met.
ExpiredCodeException
_ExpiredCodeException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown if a code has expired.
TooManyFailedAttemptsException
_TooManyFailedAttemptsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception gets thrown when the user has made too many failed attempts for a given action (e.g., sign in).
UserNotConfirmedException
_UserNotConfirmedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when a user is not confirmed successfully.
CodeDeliveryFailureException
_CodeDeliveryFailureException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when a verification code fails to deliver successfully.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the Amazon Cognito service cannot find the requested resource.
MFAMethodNotFoundException
_MFAMethodNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when Amazon Cognito cannot find a multi-factor authentication (MFA) method.
AliasExistsException
_AliasExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when a user tries to confirm the account with an email or phone number that has already been supplied as an alias from a different account. This exception tells user that an account with this email or phone already exists.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when a user exceeds the limit for a requested AWS resource.
InvalidPasswordException
_InvalidPasswordException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the Amazon Cognito service encounters an invalid password.
UsernameExistsException
_UsernameExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when Amazon Cognito encounters a user name that already exists in the user pool.
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.
DeleteUserPool
UpdateUserPool
AdminInitiateAuth
AdminEnableUser
GetUserAttributeVerificationCode
UpdateUserAttributes
DeleteUserAttributes
VerifyUserAttribute
AdminDisableUser
ConfirmDevice
ConfirmForgotPassword
ListUserImportJobs
ListUsers
AdminDeleteUserAttributes
AdminUpdateUserAttributes
AdminGetUser
AdminUserGlobalSignOut
ForgotPassword
DescribeUserPool
InitiateAuth
AdminConfirmSignUp
StartUserImportJob
GetDevice
SignUp
ChangePassword
RespondToAuthChallenge
CreateUserPool
AdminGetDevice
ConfirmSignUp
ListUserPools
AdminResetUserPassword
CreateUserImportJob
GetUser
GetCSVHeader
AdminDeleteUser
AdminForgetDevice
AdminUpdateDeviceStatus
AddCustomAttributes
ListUserPoolClients
UpdateUserPoolClient
DeleteUserPoolClient
UpdateDeviceStatus
ForgetDevice
DeleteUser
CreateUserPoolClient
StopUserImportJob
DescribeUserImportJob
GlobalSignOut
AdminRespondToAuthChallenge
SetUserSettings
AdminListDevices
DescribeUserPoolClient
ResendConfirmationCode
AdminSetUserSettings
ListDevices
Types
AliasAttributeType
data AliasAttributeType Source #
AttributeDataType
data AttributeDataType Source #
AuthFlowType
data AuthFlowType Source #
ChallengeNameType
data ChallengeNameType Source #
CNTAdminNoSrpAuth | |
CNTCustomChallenge | |
CNTDevicePasswordVerifier | |
CNTDeviceSrpAuth | |
CNTPasswordVerifier | |
CNTSmsMFA |
DeliveryMediumType
data DeliveryMediumType Source #
DeviceRememberedStatusType
data DeviceRememberedStatusType Source #
ExplicitAuthFlowsType
data ExplicitAuthFlowsType Source #
StatusType
data StatusType Source #
UserImportJobStatusType
data UserImportJobStatusType Source #
UserPoolMFAType
data UserPoolMFAType Source #
UserStatusType
data UserStatusType Source #
VerifiedAttributeType
data VerifiedAttributeType Source #
AttributeType
data AttributeType Source #
Specifies whether the attribute is standard or custom.
See: attributeType
smart constructor.
:: Text | |
-> AttributeType |
Creates a value of AttributeType
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
AuthenticationResultType
data AuthenticationResultType Source #
The result type of the authentication result.
See: authenticationResultType
smart constructor.
authenticationResultType :: AuthenticationResultType Source #
Creates a value of AuthenticationResultType
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
artAccessToken :: Lens' AuthenticationResultType (Maybe Text) Source #
The access token of the authentication result.
artRefreshToken :: Lens' AuthenticationResultType (Maybe Text) Source #
The refresh token of the authentication result.
artNewDeviceMetadata :: Lens' AuthenticationResultType (Maybe NewDeviceMetadataType) Source #
The new device metadata from an authentication result.
artExpiresIn :: Lens' AuthenticationResultType (Maybe Int) Source #
The expiration period of the authentication result.
artTokenType :: Lens' AuthenticationResultType (Maybe Text) Source #
The token type of the authentication result.
artIdToken :: Lens' AuthenticationResultType (Maybe Text) Source #
The ID token of the authentication result.
CodeDeliveryDetailsType
data CodeDeliveryDetailsType Source #
The type of code delivery details being returned from the server.
See: codeDeliveryDetailsType
smart constructor.
codeDeliveryDetailsType :: CodeDeliveryDetailsType Source #
Creates a value of CodeDeliveryDetailsType
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cddtDestination :: Lens' CodeDeliveryDetailsType (Maybe Text) Source #
The destination for the code delivery details.
cddtDeliveryMedium :: Lens' CodeDeliveryDetailsType (Maybe DeliveryMediumType) Source #
The delivery medium (email message or phone number).
cddtAttributeName :: Lens' CodeDeliveryDetailsType (Maybe Text) Source #
The name of the attribute in the code delivery details type.
DeviceConfigurationType
data DeviceConfigurationType Source #
The type of configuration for the user pool's device tracking.
See: deviceConfigurationType
smart constructor.
deviceConfigurationType :: DeviceConfigurationType Source #
Creates a value of DeviceConfigurationType
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dctChallengeRequiredOnNewDevice :: Lens' DeviceConfigurationType (Maybe Bool) Source #
Indicates whether a challenge is required on a new device. Only applicable to a new device.
dctDeviceOnlyRememberedOnUserPrompt :: Lens' DeviceConfigurationType (Maybe Bool) Source #
If true, a device is only remembered on user prompt.
DeviceSecretVerifierConfigType
data DeviceSecretVerifierConfigType Source #
The device verifier against which it will be authenticated.
See: deviceSecretVerifierConfigType
smart constructor.
deviceSecretVerifierConfigType :: DeviceSecretVerifierConfigType Source #
Creates a value of DeviceSecretVerifierConfigType
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dsvctPasswordVerifier :: Lens' DeviceSecretVerifierConfigType (Maybe Text) Source #
The password verifier.
DeviceType
data DeviceType Source #
The device type.
See: deviceType
smart constructor.
deviceType :: DeviceType Source #
Creates a value of DeviceType
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dtDeviceLastModifiedDate :: Lens' DeviceType (Maybe UTCTime) Source #
The last modified date of the device.
dtDeviceCreateDate :: Lens' DeviceType (Maybe UTCTime) Source #
The creation date of the device.
dtDeviceAttributes :: Lens' DeviceType [AttributeType] Source #
The device attributes.
dtDeviceKey :: Lens' DeviceType (Maybe Text) Source #
The device key.
dtDeviceLastAuthenticatedDate :: Lens' DeviceType (Maybe UTCTime) Source #
The date in which the device was last authenticated.
EmailConfigurationType
data EmailConfigurationType Source #
The email configuration type.
See: emailConfigurationType
smart constructor.
emailConfigurationType :: EmailConfigurationType Source #
Creates a value of EmailConfigurationType
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ectSourceARN :: Lens' EmailConfigurationType (Maybe Text) Source #
The Amazon Resource Name (ARN) of the email source.
ectReplyToEmailAddress :: Lens' EmailConfigurationType (Maybe Text) Source #
The REPLY-TO email address.
LambdaConfigType
data LambdaConfigType Source #
Specifies the type of configuration for AWS Lambda triggers.
See: lambdaConfigType
smart constructor.
lambdaConfigType :: LambdaConfigType Source #
Creates a value of LambdaConfigType
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lctPreAuthentication :: Lens' LambdaConfigType (Maybe Text) Source #
A pre-authentication AWS Lambda trigger.
lctCreateAuthChallenge :: Lens' LambdaConfigType (Maybe Text) Source #
Creates an authentication challenge.
lctVerifyAuthChallengeResponse :: Lens' LambdaConfigType (Maybe Text) Source #
Verifies the authentication challenge response.
lctPostAuthentication :: Lens' LambdaConfigType (Maybe Text) Source #
A post-authentication AWS Lambda trigger.
lctCustomMessage :: Lens' LambdaConfigType (Maybe Text) Source #
A custom Message AWS Lambda trigger.
lctDefineAuthChallenge :: Lens' LambdaConfigType (Maybe Text) Source #
Defines the authentication challenge.
lctPostConfirmation :: Lens' LambdaConfigType (Maybe Text) Source #
A post-confirmation AWS Lambda trigger.
lctPreSignUp :: Lens' LambdaConfigType (Maybe Text) Source #
A pre-registration AWS Lambda trigger.
MFAOptionType
data MFAOptionType Source #
Specifies the different settings for multi-factor authentication (MFA).
See: mfaOptionType
smart constructor.
mfaOptionType :: MFAOptionType Source #
Creates a value of MFAOptionType
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
motDeliveryMedium :: Lens' MFAOptionType (Maybe DeliveryMediumType) Source #
The delivery medium (email message or SMS message) to send the MFA code.
motAttributeName :: Lens' MFAOptionType (Maybe Text) Source #
The attribute name of the MFA option type.
NewDeviceMetadataType
data NewDeviceMetadataType Source #
The new device metadata type.
See: newDeviceMetadataType
smart constructor.
newDeviceMetadataType :: NewDeviceMetadataType Source #
Creates a value of NewDeviceMetadataType
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ndmtDeviceGroupKey :: Lens' NewDeviceMetadataType (Maybe Text) Source #
The device group key.
ndmtDeviceKey :: Lens' NewDeviceMetadataType (Maybe Text) Source #
The device key.
NumberAttributeConstraintsType
data NumberAttributeConstraintsType Source #
The minimum and maximum value of an attribute that is of the number data type.
See: numberAttributeConstraintsType
smart constructor.
numberAttributeConstraintsType :: NumberAttributeConstraintsType Source #
Creates a value of NumberAttributeConstraintsType
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
nactMaxValue :: Lens' NumberAttributeConstraintsType (Maybe Text) Source #
The maximum value of an attribute that is of the number data type.
nactMinValue :: Lens' NumberAttributeConstraintsType (Maybe Text) Source #
The minimum value of an attribute that is of the number data type.
PasswordPolicyType
data PasswordPolicyType Source #
The password policy type.
See: passwordPolicyType
smart constructor.
passwordPolicyType :: PasswordPolicyType Source #
Creates a value of PasswordPolicyType
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pptRequireNumbers :: Lens' PasswordPolicyType (Maybe Bool) Source #
In the password policy that you have set, refers to whether you have required users to use at least one number in their password.
pptRequireUppercase :: Lens' PasswordPolicyType (Maybe Bool) Source #
In the password policy that you have set, refers to whether you have required users to use at least one uppercase letter in their password.
pptRequireLowercase :: Lens' PasswordPolicyType (Maybe Bool) Source #
In the password policy that you have set, refers to whether you have required users to use at least one lowercase letter in their password.
pptMinimumLength :: Lens' PasswordPolicyType (Maybe Natural) Source #
The minimum length of the password policy that you have set. Cannot be less than 6.
pptRequireSymbols :: Lens' PasswordPolicyType (Maybe Bool) Source #
In the password policy that you have set, refers to whether you have required users to use at least one symbol in their password.
SchemaAttributeType
data SchemaAttributeType Source #
Contains information about the schema attribute.
See: schemaAttributeType
smart constructor.
schemaAttributeType :: SchemaAttributeType Source #
Creates a value of SchemaAttributeType
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
satNumberAttributeConstraints :: Lens' SchemaAttributeType (Maybe NumberAttributeConstraintsType) Source #
Specifies the constraints for an attribute of the number type.
satRequired :: Lens' SchemaAttributeType (Maybe Bool) Source #
Specifies whether a user pool attribute is required. If the attribute is required and the user does not provide a value, registration or sign-in will fail.
satAttributeDataType :: Lens' SchemaAttributeType (Maybe AttributeDataType) Source #
The attribute data type.
satStringAttributeConstraints :: Lens' SchemaAttributeType (Maybe StringAttributeConstraintsType) Source #
Specifies the constraints for an attribute of the string type.
satDeveloperOnlyAttribute :: Lens' SchemaAttributeType (Maybe Bool) Source #
Specifies whether the attribute type is developer only.
satMutable :: Lens' SchemaAttributeType (Maybe Bool) Source #
Specifies whether the attribute can be changed once it has been created.
SmsConfigurationType
data SmsConfigurationType Source #
The SMS configuratoin type.
See: smsConfigurationType
smart constructor.
smsConfigurationType :: SmsConfigurationType Source #
Creates a value of SmsConfigurationType
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sctSNSCallerARN :: Lens' SmsConfigurationType (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) caller.
sctExternalId :: Lens' SmsConfigurationType (Maybe Text) Source #
The external ID.
StringAttributeConstraintsType
data StringAttributeConstraintsType Source #
The type of constraints associated with an attribute of the string type.
See: stringAttributeConstraintsType
smart constructor.
stringAttributeConstraintsType :: StringAttributeConstraintsType Source #
Creates a value of StringAttributeConstraintsType
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sactMaxLength :: Lens' StringAttributeConstraintsType (Maybe Text) Source #
The maximum length of an attribute value of the string type.
sactMinLength :: Lens' StringAttributeConstraintsType (Maybe Text) Source #
The minimum length of an attribute value of the string type.
UserImportJobType
data UserImportJobType Source #
The user import job type.
See: userImportJobType
smart constructor.
userImportJobType :: UserImportJobType Source #
Creates a value of UserImportJobType
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
uijtStatus :: Lens' UserImportJobType (Maybe UserImportJobStatusType) Source #
The status of the user import job. One of the following:
- Created - The job was created but not started.
- Pending - A transition state. You have started the job, but it has not begun importing users yet.
- InProgress - The job has started, and users are being imported.
- Stopping - You have stopped the job, but the job has not stopped importing users yet.
- Stopped - You have stopped the job, and the job has stopped importing users.
- Succeeded - The job has completed successfully.
- Failed - The job has stopped due to an error.
- Expired - You created a job, but did not start the job within 24-48 hours. All data associated with the job was deleted, and the job cannot be started.
uijtSkippedUsers :: Lens' UserImportJobType (Maybe Integer) Source #
The number of users that were skipped.
uijtUserPoolId :: Lens' UserImportJobType (Maybe Text) Source #
The user pool ID for the user pool that the users are being imported into.
uijtJobName :: Lens' UserImportJobType (Maybe Text) Source #
The job name for the user import job.
uijtPreSignedURL :: Lens' UserImportJobType (Maybe Text) Source #
The pre-signed URL to be used to upload the .csv file.
uijtFailedUsers :: Lens' UserImportJobType (Maybe Integer) Source #
The number of users that could not be imported.
uijtStartDate :: Lens' UserImportJobType (Maybe UTCTime) Source #
The date when the user import job was started.
uijtCompletionMessage :: Lens' UserImportJobType (Maybe Text) Source #
The message returned when the user import job is completed.
uijtCreationDate :: Lens' UserImportJobType (Maybe UTCTime) Source #
The date when the user import job was created.
uijtCompletionDate :: Lens' UserImportJobType (Maybe UTCTime) Source #
The date when the user imoprt job was completed.
uijtCloudWatchLogsRoleARN :: Lens' UserImportJobType (Maybe Text) Source #
The role ARN for the Amazon CloudWatch Logging role for the user import job. For more information, see "Creating the CloudWatch Logs IAM Role" in the Amazon Cognito Developer Guide.
uijtImportedUsers :: Lens' UserImportJobType (Maybe Integer) Source #
The number of users that were successfully imported.
UserPoolClientDescription
data UserPoolClientDescription Source #
The description of the user poool client.
See: userPoolClientDescription
smart constructor.
userPoolClientDescription :: UserPoolClientDescription Source #
Creates a value of UserPoolClientDescription
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
upcdClientId :: Lens' UserPoolClientDescription (Maybe Text) Source #
The ID of the client associated with the user pool.
upcdUserPoolId :: Lens' UserPoolClientDescription (Maybe Text) Source #
The user pool ID for the user pool where you want to describe the user pool client.
upcdClientName :: Lens' UserPoolClientDescription (Maybe Text) Source #
The client name from the user pool client description.
UserPoolClientType
data UserPoolClientType Source #
A user pool of the client type.
See: userPoolClientType
smart constructor.
userPoolClientType :: UserPoolClientType Source #
Creates a value of UserPoolClientType
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
upctRefreshTokenValidity :: Lens' UserPoolClientType (Maybe Natural) Source #
The validity of the refresh token.
upctClientId :: Lens' UserPoolClientType (Maybe Text) Source #
The ID of the client associated with the user pool.
upctExplicitAuthFlows :: Lens' UserPoolClientType [ExplicitAuthFlowsType] Source #
The explicit authentication flows.
upctClientSecret :: Lens' UserPoolClientType (Maybe Text) Source #
The client secret from the user pool request of the client type.
upctLastModifiedDate :: Lens' UserPoolClientType (Maybe UTCTime) Source #
The last modified date from the user pool request of the client type.
upctUserPoolId :: Lens' UserPoolClientType (Maybe Text) Source #
The user pool ID for the user pool client.
upctWriteAttributes :: Lens' UserPoolClientType [Text] Source #
The writeable attributes.
upctCreationDate :: Lens' UserPoolClientType (Maybe UTCTime) Source #
The creation date from the user pool request of the client type.
upctReadAttributes :: Lens' UserPoolClientType [Text] Source #
The Read-only attributes.
upctClientName :: Lens' UserPoolClientType (Maybe Text) Source #
The client name from the user pool request of the client type.
UserPoolDescriptionType
data UserPoolDescriptionType Source #
A user pool description.
See: userPoolDescriptionType
smart constructor.
userPoolDescriptionType :: UserPoolDescriptionType Source #
Creates a value of UserPoolDescriptionType
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
updtStatus :: Lens' UserPoolDescriptionType (Maybe StatusType) Source #
The user pool status in a user pool description.
updtLastModifiedDate :: Lens' UserPoolDescriptionType (Maybe UTCTime) Source #
The last modified date in a user pool description.
updtCreationDate :: Lens' UserPoolDescriptionType (Maybe UTCTime) Source #
The creation date in a user pool description.
updtLambdaConfig :: Lens' UserPoolDescriptionType (Maybe LambdaConfigType) Source #
The AWS Lambda configuration information in a user pool description.
UserPoolPolicyType
data UserPoolPolicyType Source #
The type of policy in a user pool.
See: userPoolPolicyType
smart constructor.
userPoolPolicyType :: UserPoolPolicyType Source #
Creates a value of UserPoolPolicyType
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
upptPasswordPolicy :: Lens' UserPoolPolicyType (Maybe PasswordPolicyType) Source #
A container with information about the user pool password policy.
UserPoolType
data UserPoolType Source #
A container with information about the user pool type.
See: userPoolType
smart constructor.
userPoolType :: UserPoolType Source #
Creates a value of UserPoolType
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
uptStatus
uptEmailConfigurationFailure
uptLastModifiedDate
uptEstimatedNumberOfUsers
uptEmailVerificationMessage
uptSmsAuthenticationMessage
uptSchemaAttributes
uptEmailVerificationSubject
uptAliasAttributes
uptEmailConfiguration
uptSmsVerificationMessage
uptName
uptMFAConfiguration
uptId
uptSmsConfigurationFailure
uptCreationDate
uptLambdaConfig
uptSmsConfiguration
uptDeviceConfiguration
uptAutoVerifiedAttributes
uptPolicies
uptStatus :: Lens' UserPoolType (Maybe StatusType) Source #
The status of a user pool.
uptEmailConfigurationFailure :: Lens' UserPoolType (Maybe Text) Source #
The reason why the email configuration cannot send the messages to your users.
uptLastModifiedDate :: Lens' UserPoolType (Maybe UTCTime) Source #
The last modified date of a user pool.
uptEstimatedNumberOfUsers :: Lens' UserPoolType (Maybe Int) Source #
A number estimating the size of the user pool.
uptEmailVerificationMessage :: Lens' UserPoolType (Maybe Text) Source #
The contents of the email verification message.
uptSmsAuthenticationMessage :: Lens' UserPoolType (Maybe Text) Source #
The contents of the SMS authentication message.
uptSchemaAttributes :: Lens' UserPoolType (Maybe (NonEmpty SchemaAttributeType)) Source #
A container with the schema attributes of a user pool.
uptEmailVerificationSubject :: Lens' UserPoolType (Maybe Text) Source #
The subject of the email verification message.
uptAliasAttributes :: Lens' UserPoolType [AliasAttributeType] Source #
Specifies the attributes that are aliased in a user pool.
uptEmailConfiguration :: Lens' UserPoolType (Maybe EmailConfigurationType) Source #
The email configuration.
uptSmsVerificationMessage :: Lens' UserPoolType (Maybe Text) Source #
The contents of the SMS verification message.
uptMFAConfiguration :: Lens' UserPoolType (Maybe UserPoolMFAType) Source #
Can be one of the following values:
OFF
- MFA tokens are not required and cannot be specified during user registration.ON
- MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.OPTIONAL
- Users have the option when registering to create an MFA token.
uptSmsConfigurationFailure :: Lens' UserPoolType (Maybe Text) Source #
The reason why the SMS configuration cannot send the message(s) to your users.
uptCreationDate :: Lens' UserPoolType (Maybe UTCTime) Source #
The creation date of a user pool.
uptLambdaConfig :: Lens' UserPoolType (Maybe LambdaConfigType) Source #
A container describing the AWS Lambda triggers associated with a user pool.
uptSmsConfiguration :: Lens' UserPoolType (Maybe SmsConfigurationType) Source #
The SMS configuration.
uptDeviceConfiguration :: Lens' UserPoolType (Maybe DeviceConfigurationType) Source #
The device configuration.
uptAutoVerifiedAttributes :: Lens' UserPoolType [VerifiedAttributeType] Source #
Specifies the attributes that are auto-verified in a user pool.
uptPolicies :: Lens' UserPoolType (Maybe UserPoolPolicyType) Source #
A container describing the policies associated with a user pool.
UserType
The user type.
See: userType
smart constructor.
Creates a value of UserType
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
utUserStatus :: Lens' UserType (Maybe UserStatusType) Source #
The user status. Can be one of the following:
- UNCONFIRMED - User has been created but not confirmed.
- CONFIRMED - User has been confirmed.
- ARCHIVED - User is no longer active.
- COMPROMISED - User is disabled due to a potential security threat.
- UNKNOWN - User status is not known.
utAttributes :: Lens' UserType [AttributeType] Source #
A container with information about the user type attributes.