String userPoolId
The user pool ID for which you want to confirm user registration.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+
String username
The user name for which you want to confirm user registration.
Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
String userPoolId
The user pool ID for the user pool where the user will be created.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+
String username
The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username cannot be changed.
Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
List<E> userAttributes
An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (in CreateUserPool or in the Attributes tab of the console) must be supplied either by you (in your call to AdminCreateUser) or by the user (when he or she signs up in response to your welcome message).
To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.
In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. (You cannot do this by calling other operations such as AdminUpdateUserAttributes.)
email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if "EMAIL" is specified in the DesiredDeliveryMediums parameter.
phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if "SMS" is specified in the DesiredDeliveryMediums parameter.
List<E> validationData
The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.
To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
The user's validation data is not persisted.
String temporaryPassword
The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.
The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page along with a new password to be used in all future sign-ins.
This parameter is not required. If you do not specify a value, Amazon Cognito generates one for you.
The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call AdminCreateUser again, specifying "RESEND" for the MessageAction parameter.
Constraints:
Length: 6 - 256
Pattern: [\S]+
Boolean forceAliasCreation
This parameter is only used if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored.
If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter 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. The previous user will no longer be able to log in using that alias.
If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.
String messageAction
Set to "RESEND" to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to "SUPPRESS" to suppress sending the message. Only one value can be specified.
Constraints:
Allowed Values: RESEND, SUPPRESS
List<E> desiredDeliveryMediums
Specify "EMAIL" if email will be used to send the welcome message. Specify "SMS" if the phone number will be used. The default value is "SMS". More than one value can be specified.
UserType user
The user returned in the request to create a new user.
String userPoolId
The user pool ID.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+
String username
The user name.
Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
String deviceKey
The device key.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-f-]+
String deviceKey
The device key.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-f-]+
String userPoolId
The user pool ID.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+
String username
The user name.
Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
DeviceType device
The device.
String userPoolId
The ID of the Amazon Cognito user pool.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+
String clientId
The client app ID.
Constraints:
Length: 1 - 128
Pattern: [\w+]+
String authFlow
The authentication flow.
Constraints:
Allowed Values: USER_SRP_AUTH, REFRESH_TOKEN_AUTH, REFRESH_TOKEN,
CUSTOM_AUTH, ADMIN_NO_SRP_AUTH
Map<K,V> authParameters
The authentication parameters.
Map<K,V> clientMetadata
The client app metadata.
String challengeName
The name of the challenge.
Constraints:
Allowed Values: SMS_MFA, PASSWORD_VERIFIER, CUSTOM_CHALLENGE,
DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH,
NEW_PASSWORD_REQUIRED
String session
The session.
Constraints:
Length: 20 - 2048
Map<K,V> challengeParameters
The challenge parameters.
AuthenticationResultType authenticationResult
The result type of the authentication result.
String userPoolId
The user pool ID.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+
String username
The user name.
Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
Integer limit
The limit of the devices request.
Constraints:
Range: 0 - 60
String paginationToken
The pagination token.
Constraints:
Length: 1 -
Pattern: [\S]+
String userPoolId
The ID of the Amazon Cognito user pool.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+
String clientId
The client ID.
Constraints:
Length: 1 - 128
Pattern: [\w+]+
String challengeName
The name of the challenge.
Constraints:
Allowed Values: SMS_MFA, PASSWORD_VERIFIER, CUSTOM_CHALLENGE,
DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH,
NEW_PASSWORD_REQUIRED
Map<K,V> challengeResponses
The challenge response.
String session
The session.
Constraints:
Length: 20 - 2048
String challengeName
The name of the challenge.
Constraints:
Allowed Values: SMS_MFA, PASSWORD_VERIFIER, CUSTOM_CHALLENGE,
DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH,
NEW_PASSWORD_REQUIRED
String session
The session.
Constraints:
Length: 20 - 2048
Map<K,V> challengeParameters
The challenge parameters.
AuthenticationResultType authenticationResult
The result type of the authentication result.
String userPoolId
The user pool ID for the user pool where you want to set the user's settings, such as MFA options.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+
String username
The user name of the user for whom you wish to set user settings.
Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
List<E> mFAOptions
Specifies the options for MFA (e.g., email or phone number).
String userPoolId
The user pool ID>
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+
String username
The user name.
Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
String deviceKey
The device key.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-f-]+
String deviceRememberedStatus
The status indicating whether a device has been remembered or not.
Constraints:
Allowed Values: remembered, not_remembered
String analyticsEndpointId
A
String accessToken
The access token of the authentication result.
Constraints:
Pattern: [A-Za-z0-9-_=.]+
Integer expiresIn
The expiration period of the authentication result.
String tokenType
The token type of the authentication result.
String refreshToken
The refresh token of the authentication result.
Constraints:
Pattern: [A-Za-z0-9-_=.]+
String idToken
The ID token of the authentication result.
Constraints:
Pattern: [A-Za-z0-9-_=.]+
NewDeviceMetadataType newDeviceMetadata
The new device metadata from an authentication result.
String previousPassword
The old password in the change password request.
Constraints:
Length: 6 - 256
Pattern: [\S]+
String proposedPassword
The new password in the change password request.
Constraints:
Length: 6 - 256
Pattern: [\S]+
String accessToken
The access token in the change password request.
Constraints:
Pattern: [A-Za-z0-9-_=.]+
String destination
The destination for the code delivery details.
String deliveryMedium
The delivery medium (email message or phone number).
Constraints:
Allowed Values: SMS, EMAIL
String attributeName
The name of the attribute in the code delivery details type.
Constraints:
Length: 1 - 32
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
String accessToken
The access token.
Constraints:
Pattern: [A-Za-z0-9-_=.]+
String deviceKey
The device key.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-f-]+
DeviceSecretVerifierConfigType deviceSecretVerifierConfig
The configuration of the device secret verifier.
String deviceName
The device name.
Constraints:
Length: 1 - 1024
Boolean userConfirmationNecessary
Indicates whether the user confirmation is necessary to confirm the device response.
String clientId
The ID of the client associated with the user pool.
Constraints:
Length: 1 - 128
Pattern: [\w+]+
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.
Constraints:
Length: 1 - 128
Pattern: [\w+=/]+
String username
The user name of the user for whom you want to enter a code to retrieve a forgotten password.
Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
String confirmationCode
The confirmation code sent by a user's request to retrieve a forgotten password.
Constraints:
Length: 1 - 2048
Pattern: [\S]+
String password
The password sent by sent by a user's request to retrieve a forgotten password.
Constraints:
Length: 6 - 256
Pattern: [\S]+
UserContextDataType userContextData
Base64 encoded string for user context data collected for risk evaluation
AnalyticsMetadataType analyticsMetadata
The pinpoint installation id.
String clientId
The ID of the client associated with the user pool.
Constraints:
Length: 1 - 128
Pattern: [\w+]+
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.
Constraints:
Length: 1 - 128
Pattern: [\w+=/]+
String username
The user name of the user whose registration you wish to confirm.
Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
String confirmationCode
The confirmation code sent by a user's request to confirm registration.
Constraints:
Length: 1 - 2048
Pattern: [\S]+
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.
UserContextDataType userContextData
Base64 encoded string for user context data collected for risk evaluation
AnalyticsMetadataType analyticsMetadata
The pinpoint installation id.
String jobName
The job name for the user import job.
Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+
String userPoolId
The user pool ID for the user pool that the users are being imported into.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+
String cloudWatchLogsRoleArn
The role ARN for the Amazon CloudWatch Logging role for the user import job.
Constraints:
Length: 20 - 2048
Pattern:
arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=
/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
UserImportJobType userImportJob
The job object that represents the user import job.
String userPoolId
The user pool ID for the user pool where you want to create a user pool client.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+
String clientName
The client name for the user pool client you would like to create.
Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+
Boolean generateSecret
Boolean to specify whether you want to generate a secret for the user pool client being created.
Integer refreshTokenValidity
Refreshes the token validity.
Constraints:
Range: 0 - 3650
List<E> readAttributes
The read attributes.
List<E> writeAttributes
The write attributes.
List<E> explicitAuthFlows
The explicit authentication flows.
UserPoolClientType userPoolClient
The user pool client that was just created.
String userPoolId
The user pool ID for the user pool you want to delete.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+
String accessToken
The access token from a request to delete a user.
Constraints:
Pattern: [A-Za-z0-9-_=.]+
UserImportJobType userImportJob
The job object that represents the user import job.
UserPoolClientType userPoolClient
The user pool client from a server response to describe the user pool client.
String deviceKey
The device key.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-f-]+
List<E> deviceAttributes
The device attributes.
Date deviceCreateDate
The creation date of the device.
Date deviceLastModifiedDate
The last modified date of the device.
Date deviceLastAuthenticatedDate
The date in which the device was last authenticated.
String clientId
The ID of the client associated with the user pool.
Constraints:
Length: 1 - 128
Pattern: [\w+]+
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.
Constraints:
Length: 1 - 128
Pattern: [\w+=/]+
String username
The user name of the user for whom you want to enter a code to retrieve a forgotten password.
Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
UserContextDataType userContextData
Base64 encoded string for user context data collected for risk evaluation
AnalyticsMetadataType analyticsMetadata
The pinpoint installation id.
CodeDeliveryDetailsType codeDeliveryDetails
The type of code delivery details being returned from the server.
String userPoolId
The user pool ID for the user pool that the users are to be imported into.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+
DeviceType device
The device.
String accessToken
The access token returned by the server response to get the user attribute verification code.
Constraints:
Pattern: [A-Za-z0-9-_=.]+
String attributeName
The attribute name returned by the server response to get the user attribute verification code.
Constraints:
Length: 1 - 32
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
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.
Constraints:
Pattern: [A-Za-z0-9-_=.]+
String username
The user name of the user you wish to retrieve from the get user request.
Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
List<E> userAttributes
An array of name-value pairs representing user attributes.
List<E> mFAOptions
Specifies the options for MFA (e.g., email or phone number).
String accessToken
The access token.
Constraints:
Pattern: [A-Za-z0-9-_=.]+
String authFlow
The authentication flow.
Constraints:
Allowed Values: USER_SRP_AUTH, REFRESH_TOKEN_AUTH, REFRESH_TOKEN,
CUSTOM_AUTH, ADMIN_NO_SRP_AUTH
Map<K,V> authParameters
The authentication parameters.
Map<K,V> clientMetadata
The client app's metadata.
String clientId
The client ID.
Constraints:
Length: 1 - 128
Pattern: [\w+]+
UserContextDataType userContextData
Base64 encoded string for user context data collected for risk evaluation
AnalyticsMetadataType analyticsMetadata
The pinpoint installation id.
String challengeName
The name of the challenge.
Constraints:
Allowed Values: SMS_MFA, PASSWORD_VERIFIER, CUSTOM_CHALLENGE,
DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH,
NEW_PASSWORD_REQUIRED
String session
The session.
Constraints:
Length: 20 - 2048
Map<K,V> challengeParameters
The challenge parameters.
AuthenticationResultType authenticationResult
The result type of the authentication result.
String accessToken
The access tokens for the request to list devices.
Constraints:
Pattern: [A-Za-z0-9-_=.]+
Integer limit
The limit of the device request.
Constraints:
Range: 0 - 60
String paginationToken
The pagination token for the list request.
Constraints:
Length: 1 -
Pattern: [\S]+
String userPoolId
The user pool ID for the user pool that the users are being imported into.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+
Integer maxResults
The maximum number of import jobs you want the request to return.
Constraints:
Range: 1 - 60
String paginationToken
An identifier that was returned from the previous call to ListUserImportJobs, which can be used to return the next set of import jobs in the list.
Constraints:
Length: 1 -
Pattern: [\S]+
String userPoolId
The user pool ID for the user pool where you want to list user pool clients.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+
Integer maxResults
The maximum number of results you want the request to return when listing the user pool clients.
Constraints:
Range: 1 - 60
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.
Constraints:
Length: 1 -
Pattern: [\S]+
List<E> userPoolClients
The user pool clients in the response that lists 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.
Constraints:
Length: 1 -
Pattern: [\S]+
String userPoolId
The user pool ID for which you want to list users.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+
List<E> attributesToGet
The attributes to get from the request to list users.
Integer limit
The limit of the request to list users.
Constraints:
Range: 0 - 60
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.
Constraints:
Length: 1 -
Pattern: [\S]+
String filter
The filter for the list users request.
Constraints:
Length: - 256
String clientId
The ID of the client associated with the user pool.
Constraints:
Length: 1 - 128
Pattern: [\w+]+
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.
Constraints:
Length: 1 - 128
Pattern: [\w+=/]+
String username
The user name of the user to whom you wish to resend a confirmation code.
Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
UserContextDataType userContextData
Base64 encoded string for user context data collected for risk evaluation
AnalyticsMetadataType analyticsMetadata
The pinpoint installation id.
CodeDeliveryDetailsType codeDeliveryDetails
The type of code delivery details being returned from the server.
String clientId
The client ID.
Constraints:
Length: 1 - 128
Pattern: [\w+]+
String challengeName
The name of the challenge.
Constraints:
Allowed Values: SMS_MFA, PASSWORD_VERIFIER, CUSTOM_CHALLENGE,
DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH,
NEW_PASSWORD_REQUIRED
String session
The session.
Constraints:
Length: 20 - 2048
Map<K,V> challengeResponses
The responses to the authentication challenge.
UserContextDataType userContextData
Base64 encoded string for user context data collected for risk evaluation
AnalyticsMetadataType analyticsMetadata
The pinpoint installation id.
String challengeName
The challenge name.
Constraints:
Allowed Values: SMS_MFA, PASSWORD_VERIFIER, CUSTOM_CHALLENGE,
DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH,
NEW_PASSWORD_REQUIRED
String session
The session.
Constraints:
Length: 20 - 2048
Map<K,V> challengeParameters
The challenge parameters.
AuthenticationResultType authenticationResult
The result type of the authentication result.
String name
A schema attribute of the name type.
Constraints:
Length: 1 - 20
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
String attributeDataType
The attribute data type.
Constraints:
Allowed Values: String, Number, DateTime, Boolean
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.
SMSMfaSettingsType sMSMfaSettings
SoftwareTokenMfaSettingsType softwareTokenMfaSettings
String accessToken
Constraints:
Pattern: [A-Za-z0-9-_=.]+
String clientId
The ID of the client associated with the user pool.
Constraints:
Length: 1 - 128
Pattern: [\w+]+
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.
Constraints:
Length: 1 - 128
Pattern: [\w+=/]+
String username
The user name of the user you wish to register.
Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
String password
The password of the user you wish to register.
Constraints:
Length: 6 - 256
Pattern: [\S]+
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.
UserContextDataType userContextData
Base64 encoded string for user context data collected for risk evaluation
AnalyticsMetadataType analyticsMetadata
The pinpoint installation id.
Boolean userConfirmed
A response from the server indicating that a user registration has been confirmed.
CodeDeliveryDetailsType codeDeliveryDetails
The type of code delivery details being returned from the server.
UserImportJobType userImportJob
The job object that represents the user import job.
UserImportJobType userImportJob
The job object that represents the user import job.
String accessToken
The access token.
Constraints:
Pattern: [A-Za-z0-9-_=.]+
String deviceKey
The device key.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-f-]+
String deviceRememberedStatus
The status of whether a device is remembered.
Constraints:
Allowed Values: remembered, not_remembered
String userPoolId
The user pool ID for the user pool where you want to update the user pool client.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+
String clientId
The ID of the client associated with the user pool.
Constraints:
Length: 1 - 128
Pattern: [\w+]+
String clientName
The client name from the update user pool client request.
Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+
Integer refreshTokenValidity
The validity of the refresh token.
Constraints:
Range: 0 - 3650
List<E> readAttributes
The read-only attributes of the user pool.
List<E> writeAttributes
The writeable attributes of the user pool.
List<E> explicitAuthFlows
Explicit authentication flows.
UserPoolClientType userPoolClient
The user pool client value from the response from the server when an update user pool client request is made.
String encodedData
String jobName
The job name for the user import job.
Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+
String jobId
The job ID for the user import job.
Constraints:
Length: 1 - 55
Pattern: import-[0-9a-zA-Z-]+
String userPoolId
The user pool ID for the user pool that the users are being imported into.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+
String preSignedUrl
The pre-signed URL to be used to upload the .csv file.
Constraints:
Length: 0 - 2048
Date creationDate
The date when the user import job was created.
Date startDate
The date when the user import job was started.
Date completionDate
The date when the user imoprt job was completed.
String status
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.
Constraints:
Allowed Values: Created, Pending, InProgress, Stopping, Expired,
Stopped, Failed, Succeeded
String cloudWatchLogsRoleArn
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.
Constraints:
Length: 20 - 2048
Pattern:
arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=
/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
Long importedUsers
The number of users that were successfully imported.
Long skippedUsers
The number of users that were skipped.
Long failedUsers
The number of users that could not be imported.
String completionMessage
The message returned when the user import job is completed.
Constraints:
Length: 1 - 128
Pattern: [\w]+
String clientId
The ID of the client associated with the user pool.
Constraints:
Length: 1 - 128
Pattern: [\w+]+
String userPoolId
The user pool ID for the user pool where you want to describe the user pool client.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+
String clientName
The client name from the user pool client description.
Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+
String userPoolId
The user pool ID for the user pool client.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+
String clientName
The client name from the user pool request of the client type.
Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+
String clientId
The ID of the client associated with the user pool.
Constraints:
Length: 1 - 128
Pattern: [\w+]+
String clientSecret
The client secret from the user pool request of the client type.
Constraints:
Length: 1 - 64
Pattern: [\w+]+
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.
Integer refreshTokenValidity
The validity of the refresh token.
Constraints:
Range: 0 - 3650
List<E> readAttributes
The Read-only attributes.
List<E> writeAttributes
The writeable attributes.
List<E> explicitAuthFlows
The explicit authentication flows.
String username
The user name of the user you wish to describe.
Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
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:
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.
Constraints:
Allowed Values: UNCONFIRMED, CONFIRMED, ARCHIVED, COMPROMISED,
UNKNOWN, RESET_REQUIRED, FORCE_CHANGE_PASSWORD
List<E> mFAOptions
The MFA options for the user.
String accessToken
Constraints:
Pattern: [A-Za-z0-9-_=.]+
String session
Constraints:
Length: 20 - 2048
String userCode
Constraints:
Length: 6 - 6
Pattern: [0-9]+
String friendlyDeviceName
String accessToken
Represents the access token of the request to verify user attributes.
Constraints:
Pattern: [A-Za-z0-9-_=.]+
String attributeName
The attribute name in the request to verify user attributes.
Constraints:
Length: 1 - 32
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
String code
The verification code in the request to verify user attributes.
Constraints:
Length: 1 - 2048
Pattern: [\S]+
Copyright © 2018. All rights reserved.