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
- InvalidParameterException
- InvalidLambdaResponseException
- UnexpectedLambdaException
- NotAuthorizedException
- InternalErrorException
- CodeMismatchException
- TooManyRequestsException
- ConcurrentModificationException
- UserLambdaValidationException
- ExpiredCodeException
- TooManyFailedAttemptsException
- ResourceNotFoundException
- AliasExistsException
- LimitExceededException
- InvalidPasswordException
- UsernameExistsException
- Waiters
- Operations
- DeleteUserPool
- UpdateUserPool
- AdminEnableUser
- GetUserAttributeVerificationCode
- UpdateUserAttributes
- DeleteUserAttributes
- VerifyUserAttribute
- AdminDisableUser
- ConfirmForgotPassword
- ListUsers
- AdminDeleteUserAttributes
- AdminUpdateUserAttributes
- AdminGetUser
- ForgotPassword
- DescribeUserPool
- AdminConfirmSignUp
- SignUp
- ChangePassword
- CreateUserPool
- ConfirmSignUp
- ListUserPools
- AdminResetUserPassword
- GetUser
- AdminDeleteUser
- AddCustomAttributes
- ListUserPoolClients
- UpdateUserPoolClient
- DeleteUserPoolClient
- DeleteUser
- CreateUserPoolClient
- SetUserSettings
- DescribeUserPoolClient
- ResendConfirmationCode
- AdminSetUserSettings
- Types
- AliasAttributeType
- AttributeDataType
- DeliveryMediumType
- StatusType
- UserPoolMFAType
- UserStatusType
- VerifiedAttributeType
- AttributeType
- CodeDeliveryDetailsType
- LambdaConfigType
- MFAOptionType
- NumberAttributeConstraintsType
- PasswordPolicyType
- SchemaAttributeType
- StringAttributeConstraintsType
- 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, which is a new capability that is available as a beta.
- cognitoIdentityProvider :: Service
- _InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidLambdaResponseException :: 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
- _CodeMismatchException :: 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
- _ExpiredCodeException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyFailedAttemptsException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: 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.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.ConfirmForgotPassword
- module Network.AWS.CognitoIdentityProvider.ListUsers
- module Network.AWS.CognitoIdentityProvider.AdminDeleteUserAttributes
- module Network.AWS.CognitoIdentityProvider.AdminUpdateUserAttributes
- module Network.AWS.CognitoIdentityProvider.AdminGetUser
- module Network.AWS.CognitoIdentityProvider.ForgotPassword
- module Network.AWS.CognitoIdentityProvider.DescribeUserPool
- module Network.AWS.CognitoIdentityProvider.AdminConfirmSignUp
- module Network.AWS.CognitoIdentityProvider.SignUp
- module Network.AWS.CognitoIdentityProvider.ChangePassword
- module Network.AWS.CognitoIdentityProvider.CreateUserPool
- module Network.AWS.CognitoIdentityProvider.ConfirmSignUp
- module Network.AWS.CognitoIdentityProvider.ListUserPools
- module Network.AWS.CognitoIdentityProvider.AdminResetUserPassword
- module Network.AWS.CognitoIdentityProvider.GetUser
- module Network.AWS.CognitoIdentityProvider.AdminDeleteUser
- module Network.AWS.CognitoIdentityProvider.AddCustomAttributes
- module Network.AWS.CognitoIdentityProvider.ListUserPoolClients
- module Network.AWS.CognitoIdentityProvider.UpdateUserPoolClient
- module Network.AWS.CognitoIdentityProvider.DeleteUserPoolClient
- module Network.AWS.CognitoIdentityProvider.DeleteUser
- module Network.AWS.CognitoIdentityProvider.CreateUserPoolClient
- module Network.AWS.CognitoIdentityProvider.SetUserSettings
- module Network.AWS.CognitoIdentityProvider.DescribeUserPoolClient
- module Network.AWS.CognitoIdentityProvider.ResendConfirmationCode
- module Network.AWS.CognitoIdentityProvider.AdminSetUserSettings
- data AliasAttributeType
- data AttributeDataType
- data DeliveryMediumType
- data StatusType
- data UserPoolMFAType
- data UserStatusType
- data VerifiedAttributeType
- | PhoneNumber
- data AttributeType
- attributeType :: Text -> AttributeType
- atValue :: Lens' AttributeType (Maybe Text)
- atName :: Lens' AttributeType Text
- data CodeDeliveryDetailsType
- codeDeliveryDetailsType :: CodeDeliveryDetailsType
- cddtDestination :: Lens' CodeDeliveryDetailsType (Maybe Text)
- cddtDeliveryMedium :: Lens' CodeDeliveryDetailsType (Maybe DeliveryMediumType)
- cddtAttributeName :: Lens' CodeDeliveryDetailsType (Maybe Text)
- data LambdaConfigType
- lambdaConfigType :: LambdaConfigType
- lctPreAuthentication :: Lens' LambdaConfigType (Maybe Text)
- lctPostAuthentication :: Lens' LambdaConfigType (Maybe Text)
- lctCustomMessage :: 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 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 StringAttributeConstraintsType
- stringAttributeConstraintsType :: StringAttributeConstraintsType
- sactMaxLength :: Lens' StringAttributeConstraintsType (Maybe Text)
- sactMinLength :: Lens' StringAttributeConstraintsType (Maybe Text)
- data UserPoolClientDescription
- userPoolClientDescription :: UserPoolClientDescription
- upcdClientId :: Lens' UserPoolClientDescription (Maybe Text)
- upcdUserPoolId :: Lens' UserPoolClientDescription (Maybe Text)
- upcdClientName :: Lens' UserPoolClientDescription (Maybe Text)
- data UserPoolClientType
- userPoolClientType :: UserPoolClientType
- upctClientId :: Lens' UserPoolClientType (Maybe Text)
- upctClientSecret :: Lens' UserPoolClientType (Maybe Text)
- upctLastModifiedDate :: Lens' UserPoolClientType (Maybe UTCTime)
- upctUserPoolId :: Lens' UserPoolClientType (Maybe Text)
- upctCreationDate :: Lens' UserPoolClientType (Maybe UTCTime)
- 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)
- 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]
- uptSmsVerificationMessage :: Lens' UserPoolType (Maybe Text)
- uptName :: Lens' UserPoolType (Maybe Text)
- uptMFAConfiguration :: Lens' UserPoolType (Maybe UserPoolMFAType)
- uptId :: Lens' UserPoolType (Maybe Text)
- uptCreationDate :: Lens' UserPoolType (Maybe UTCTime)
- uptLambdaConfig :: Lens' UserPoolType (Maybe LambdaConfigType)
- 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
.
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.
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.
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.
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.
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).
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the Amazon Cognito service cannot find the requested resource.
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
AdminEnableUser
GetUserAttributeVerificationCode
UpdateUserAttributes
DeleteUserAttributes
VerifyUserAttribute
AdminDisableUser
ConfirmForgotPassword
ListUsers
AdminDeleteUserAttributes
AdminUpdateUserAttributes
AdminGetUser
ForgotPassword
DescribeUserPool
AdminConfirmSignUp
SignUp
ChangePassword
CreateUserPool
ConfirmSignUp
ListUserPools
AdminResetUserPassword
GetUser
AdminDeleteUser
AddCustomAttributes
ListUserPoolClients
UpdateUserPoolClient
DeleteUserPoolClient
DeleteUser
CreateUserPoolClient
SetUserSettings
DescribeUserPoolClient
ResendConfirmationCode
AdminSetUserSettings
Types
AliasAttributeType
data AliasAttributeType Source #
AttributeDataType
data AttributeDataType Source #
DeliveryMediumType
data DeliveryMediumType Source #
StatusType
data StatusType 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:
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.
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.
lctPostAuthentication :: Lens' LambdaConfigType (Maybe Text) Source #
A post-authentication AWS Lambda trigger.
lctCustomMessage :: Lens' LambdaConfigType (Maybe Text) Source #
A custom Message AWS Lambda trigger.
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.
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.
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.
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:
upctClientId :: Lens' UserPoolClientType (Maybe Text) Source #
The ID of the client associated with the user pool.
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.
upctCreationDate :: Lens' UserPoolClientType (Maybe UTCTime) Source #
The creation date from the user pool request of the client type.
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 :: Lens' UserPoolType (Maybe StatusType) Source #
The status of a user pool.
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.
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.
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.
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.