String userPoolId
The user pool ID for the user pool where you want to delete user attributes.
String username
The user name of the user from which you would like to delete attributes.
List<E> userAttributeNames
An array of strings representing the user attribute names you wish to delete.
String username
The user name of the user about whom you are receiving information.
List<E> userAttributes
An array of name-value pairs representing user attributes.
Date userCreateDate
The date the user was created.
Date userLastModifiedDate
The date the user was last modified.
Boolean enabled
Indicates that the status is enabled.
String userStatus
The user status. Can be one of the following:
List<E> mFAOptions
Specifies the options for MFA (e.g., email or phone number).
String userPoolId
The user pool ID for the user pool where you want to set the user's settings, such as MFA options.
String username
The user name of the user for whom you wish to set user settings.
List<E> mFAOptions
Specifies the options for MFA (e.g., email or phone number).
String clientId
The ID of the client associated with the user pool.
String secretHash
A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
String username
The user name of the user for whom you want to enter a code to retrieve a forgotten password.
String confirmationCode
The confirmation code sent by a user's request to retrieve a forgotten password.
String password
The password sent by sent by a user's request to retrieve a forgotten password.
String clientId
The ID of the client associated with the user pool.
String secretHash
A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
String username
The user name of the user whose registration you wish to confirm.
String confirmationCode
The confirmation code sent by a user's request to confirm registration.
Boolean forceAliasCreation
Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error.
String userPoolId
The user pool ID for the user pool where you want to create a user pool client.
String clientName
The client name for the user pool client you would like to create.
Boolean generateSecret
Boolean to specify whether you want to generate a secret for the user pool client being created.
UserPoolClientType userPoolClient
The user pool client that was just created.
String poolName
A string used to name the user pool.
UserPoolPolicyType policies
The policies associated with the new user pool.
LambdaConfigType lambdaConfig
The Lambda trigger configuration information for the new user pool.
List<E> autoVerifiedAttributes
The attributes to be auto-verified. Possible values: email, phone_number.
List<E> aliasAttributes
Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
String smsVerificationMessage
A string representing the SMS verification message.
String emailVerificationMessage
A string representing the email verification message.
String emailVerificationSubject
A string representing the email verification subject.
String smsAuthenticationMessage
A string representing the SMS authentication message.
String mfaConfiguration
Specifies MFA configuration details.
UserPoolType userPool
A container for the user pool details.
String userPoolId
The user pool ID for the user pool you want to delete.
String accessToken
The access token from a request to delete a user.
UserPoolClientType userPoolClient
The user pool client from a server response to describe the user pool client.
String userPoolId
The user pool ID for the user pool you want to describe.
UserPoolType userPool
The container of metadata returned by the server to describe the pool.
String clientId
The ID of the client associated with the user pool.
String secretHash
A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
String username
The user name of the user for whom you want to enter a code to retrieve a forgotten password.
CodeDeliveryDetailsType codeDeliveryDetails
CodeDeliveryDetailsType codeDeliveryDetails
The code delivery details returned by the server response to get the user attribute verification code.
String accessToken
The access token returned by the server response to get information about the user.
String preSignUp
A pre-registration AWS Lambda trigger.
String customMessage
A custom Message AWS Lambda trigger.
String postConfirmation
A post-confirmation AWS Lambda trigger.
String preAuthentication
A pre-authentication AWS Lambda trigger.
String postAuthentication
A post-authentication AWS Lambda trigger.
String userPoolId
The user pool ID for the user pool where you want to list user pool clients.
Integer maxResults
The maximum number of results you want the request to return when listing the user pool clients.
String nextToken
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
String userPoolId
The user pool ID for which you want to list users.
List<E> attributesToGet
The attributes to get from the request to list users.
Integer limit
The limit of the request to list users.
String paginationToken
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
String userStatus
The user status. Can be one of the following:
Integer minimumLength
The minimum length of the password policy that you have set. Cannot be less than 6.
Boolean requireUppercase
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.
Boolean requireLowercase
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.
Boolean requireNumbers
In the password policy that you have set, refers to whether you have required users to use at least one number in their password.
Boolean requireSymbols
In the password policy that you have set, refers to whether you have required users to use at least one symbol in their password.
String clientId
The ID of the client associated with the user pool.
String secretHash
A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
String username
The user name of the user to whom you wish to resend a confirmation code.
CodeDeliveryDetailsType codeDeliveryDetails
String name
A schema attribute of the name type.
String attributeDataType
The attribute data type.
Boolean developerOnlyAttribute
Specifies whether the attribute type is developer only.
Boolean mutable
Specifies whether the attribute can be changed once it has been created.
Boolean required
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.
NumberAttributeConstraintsType numberAttributeConstraints
Specifies the constraints for an attribute of the number type.
StringAttributeConstraintsType stringAttributeConstraints
Specifies the constraints for an attribute of the string type.
String clientId
The ID of the client associated with the user pool.
String secretHash
A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
String username
The user name of the user you wish to register.
String password
The password of the user you wish to register.
List<E> userAttributes
An array of name-value pairs representing user attributes.
List<E> validationData
The validation data in the request to register a user.
Boolean userConfirmed
A response from the server indicating that a user registration has been confirmed.
CodeDeliveryDetailsType codeDeliveryDetails
UserPoolClientType userPoolClient
The user pool client value from the response from the server when an update user pool client request is made.
String userPoolId
The user pool ID for the user pool you want to update.
UserPoolPolicyType policies
A container with the policies you wish to update in a user pool.
LambdaConfigType lambdaConfig
The AWS Lambda configuration information from the request to update the user pool.
List<E> autoVerifiedAttributes
The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
String smsVerificationMessage
A container with information about the SMS verification message.
String emailVerificationMessage
The contents of the email verification message.
String emailVerificationSubject
The subject of the email verfication message
String smsAuthenticationMessage
The contents of the SMS authentication message.
String mfaConfiguration
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.String userPoolId
The user pool ID for the user pool client.
String clientName
The client name from the user pool request of the client type.
String clientId
The ID of the client associated with the user pool.
String clientSecret
The client secret from the user pool request of the client type.
Date lastModifiedDate
The last modified date from the user pool request of the client type.
Date creationDate
The creation date from the user pool request of the client type.
String id
The ID in a user pool description.
String name
The name in a user pool description.
LambdaConfigType lambdaConfig
The AWS Lambda configuration information in a user pool description.
String status
The user pool status in a user pool description.
Date lastModifiedDate
The last modified date in a user pool description.
Date creationDate
The creation date in a user pool description.
PasswordPolicyType passwordPolicy
A container with information about the user pool password policy.
String id
The ID of the user pool.
String name
The name of the user pool.
UserPoolPolicyType policies
A container describing the policies associated with a user pool.
LambdaConfigType lambdaConfig
A container describing the AWS Lambda triggers associated with a user pool.
String status
The status of a user pool.
Date lastModifiedDate
The last modified date of a user pool.
Date creationDate
The creation date of a user pool.
List<E> schemaAttributes
A container with the schema attributes of a user pool.
List<E> autoVerifiedAttributes
Specifies the attributes that are auto-verified in a user pool.
List<E> aliasAttributes
Specifies the attributes that are aliased in a user pool.
String smsVerificationMessage
The contents of the SMS verification message.
String emailVerificationMessage
The contents of the email verification message.
String emailVerificationSubject
The subject of the email verification message.
String smsAuthenticationMessage
The contents of the SMS authentication message.
String mfaConfiguration
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.Integer estimatedNumberOfUsers
A number estimating the size of the user pool.
String username
The user name of the user you wish to describe.
List<E> attributes
A container with information about the user type attributes.
Date userCreateDate
The creation date of the user.
Date userLastModifiedDate
The last modified date of the user.
Boolean enabled
Specifies whether the user is enabled.
String userStatus
The user status. Can be one of the following:
Copyright © 2016. All rights reserved.