AccountTakeoverActionType lowAction
Action to take for a low risk.
AccountTakeoverActionType mediumAction
Action to take for a medium risk.
AccountTakeoverActionType highAction
Action to take for a high risk.
Boolean notify
Flag specifying whether to send a notification.
String eventAction
The event action.
BLOCK Choosing this action will block the request.
MFA_IF_CONFIGURED Throw MFA challenge if user has configured it, else allow the request.
MFA_REQUIRED Throw MFA challenge if user has configured it, else block the request.
NO_ACTION Allow the user sign-in.
NotifyConfigurationType notifyConfiguration
The notify configuration used to construct email notifications.
AccountTakeoverActionsType actions
Account takeover risk configuration actions
String userPoolId
The user pool ID for which you want to confirm user registration.
String username
The user name for which you want to confirm user registration.
Map<K,V> clientMetadata
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
If your user pool configuration includes triggers, the AdminConfirmSignUp API action invokes the AWS Lambda
function that is specified for the post confirmation trigger. When Amazon Cognito invokes this function,
it passes a JSON payload, which the function receives as input. In this payload, the clientMetadata
attribute provides the data that you assigned to the ClientMetadata parameter in your AdminConfirmSignUp request.
In your function code in AWS Lambda, you can process the ClientMetadata value to enhance your workflow for your
specific needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
Take the following limitations into consideration when you use the ClientMetadata parameter:
Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
Amazon Cognito does not validate the ClientMetadata value.
Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
Boolean allowAdminCreateUserOnly
Set to True if only the administrator is allowed to create user profiles. Set to False
if users can sign themselves up via an app.
Integer unusedAccountValidityDays
The user account expiration limit, in days, after which the account is no longer usable. To reset the account
after that time limit, you must call AdminCreateUser again, specifying "RESEND" for the
MessageAction parameter. The default value for this parameter is 7.
If you set a value for TemporaryPasswordValidityDays in PasswordPolicy, that value will
be used and UnusedAccountValidityDays will be deprecated for that user pool.
MessageTemplateType inviteMessageTemplate
The message template to be used for the welcome message to new users.
See also Customizing User Invitation Messages.
String userPoolId
The user pool ID for the user pool where the user will be created.
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.
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 (when creating a user pool 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).
For custom attributes, you must prepend the custom: prefix to the attribute name.
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
can also do this by calling 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.
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.
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.
Map<K,V> clientMetadata
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the
AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the pre sign-up
trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as
input. This payload contains a clientMetadata attribute, which provides the data that you assigned
to the ClientMetadata parameter in your AdminCreateUser request. In your function code in AWS Lambda, you can
process the clientMetadata value to enhance your workflow for your specific needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
Take the following limitations into consideration when you use the ClientMetadata parameter:
Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
Amazon Cognito does not validate the ClientMetadata value.
Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
UserType user
The newly created user.
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.
For custom attributes, you must prepend the custom: prefix to the attribute name.
String userPoolId
The user pool ID for the user pool.
ProviderUserIdentifierType user
The user to be disabled.
DeviceType device
The device.
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:
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.
RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or she can sign in.
FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change his or her password to a new value before doing anything else.
List<E> mFAOptions
This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about TOTP software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.
String preferredMfaSetting
The user's preferred MFA setting.
List<E> userMFASettingList
The MFA options that are enabled for the user. The possible values in this list are SMS_MFA and
SOFTWARE_TOKEN_MFA.
String userPoolId
The ID of the Amazon Cognito user pool.
String clientId
The app client ID.
String authFlow
The authentication flow for this call to execute. The API action will depend on this value. For example:
REFRESH_TOKEN_AUTH will take in a valid refresh token and return new tokens.
USER_SRP_AUTH will take in USERNAME and SRP_A and return the SRP variables
to be used for next challenge execution.
USER_PASSWORD_AUTH will take in USERNAME and PASSWORD and return the next
challenge or tokens.
Valid values include:
USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.
REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token
and ID token by supplying a valid refresh token.
CUSTOM_AUTH: Custom authentication flow.
ADMIN_NO_SRP_AUTH: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly
if the flow is enabled for calling the app client.
USER_PASSWORD_AUTH: Non-SRP authentication flow; USERNAME and PASSWORD are passed directly. If a
user migration Lambda trigger is set, this flow will invoke the user migration Lambda if the USERNAME is not
found in the user pool.
ADMIN_USER_PASSWORD_AUTH: Admin-based user password authentication. This replaces the
ADMIN_NO_SRP_AUTH authentication flow. In this flow, Cognito receives the password in the request
instead of using the SRP process to verify passwords.
Map<K,V> authParameters
The authentication parameters. These are inputs corresponding to the AuthFlow that you are invoking.
The required values depend on the value of AuthFlow:
For USER_SRP_AUTH: USERNAME (required), SRP_A (required),
SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY
.
For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required),
SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY
.
For ADMIN_NO_SRP_AUTH: USERNAME (required), SECRET_HASH (if app client is
configured with client secret), PASSWORD (required), DEVICE_KEY.
For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is
configured with client secret), DEVICE_KEY. To start the authentication flow with password
verification, include ChallengeName: SRP_A and SRP_A: (The SRP_A Value).
Map<K,V> clientMetadata
A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.
You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminInitiateAuth API action, Amazon Cognito invokes the AWS Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:
Pre signup
Pre authentication
User migration
When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function
receives as input. This payload contains a validationData attribute, which provides the data that
you assigned to the ClientMetadata parameter in your AdminInitiateAuth request. In your function code in AWS
Lambda, you can process the validationData value to enhance your workflow for your specific needs.
When you use the AdminInitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it does not provide the ClientMetadata value as input:
Post authentication
Custom message
Pre token generation
Create auth challenge
Define auth challenge
Verify auth challenge
For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
Take the following limitations into consideration when you use the ClientMetadata parameter:
Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
Amazon Cognito does not validate the ClientMetadata value.
Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
AnalyticsMetadataType analyticsMetadata
The analytics metadata for collecting Amazon Pinpoint metrics for AdminInitiateAuth calls.
ContextDataType contextData
Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
String challengeName
The name of the challenge which you are responding to with this call. This is returned to you in the
AdminInitiateAuth response if you need to pass another challenge.
MFA_SETUP: If MFA is required, users who do not have at least one of the MFA methods set up are
presented with an MFA_SETUP challenge. The user must set up at least one MFA type to continue to
authenticate.
SELECT_MFA_TYPE: Selects the MFA type. Valid MFA options are SMS_MFA for text SMS MFA,
and SOFTWARE_TOKEN_MFA for TOTP software token MFA.
SMS_MFA: Next challenge is to supply an SMS_MFA_CODE, delivered via SMS.
PASSWORD_VERIFIER: Next challenge is to supply PASSWORD_CLAIM_SIGNATURE,
PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after the client-side SRP calculations.
CUSTOM_CHALLENGE: This is returned if your custom authentication flow determines that the user
should pass another challenge before tokens are issued.
DEVICE_SRP_AUTH: If device tracking was enabled on your user pool and the previous challenges were
passed, this challenge is returned so that Amazon Cognito can start tracking this device.
DEVICE_PASSWORD_VERIFIER: Similar to PASSWORD_VERIFIER, but for devices only.
ADMIN_NO_SRP_AUTH: This is returned if you need to authenticate with USERNAME and
PASSWORD directly. An app client must be enabled to use this flow.
NEW_PASSWORD_REQUIRED: For users which are required to change their passwords after successful first
login. This challenge should be passed with NEW_PASSWORD and any other required attributes.
String session
The session which should be passed both ways in challenge-response calls to the service. If
AdminInitiateAuth or AdminRespondToAuthChallenge API call determines that the caller
needs to go through another challenge, they return a session with other challenge parameters. This session should
be passed as it is to the next AdminRespondToAuthChallenge API call.
Map<K,V> challengeParameters
The challenge parameters. These are returned to you in the AdminInitiateAuth response if you need to
pass another challenge. The responses in this parameter should be used to compute inputs to the next call (
AdminRespondToAuthChallenge).
All challenges require USERNAME and SECRET_HASH (if applicable).
The value of the USER_ID_FOR_SRP attribute will be the user's actual username, not an alias (such as
email address or phone number), even if you specified an alias in your call to AdminInitiateAuth.
This is because, in the AdminRespondToAuthChallenge API ChallengeResponses, the
USERNAME attribute cannot be an alias.
AuthenticationResultType authenticationResult
The result of the authentication response. This is only returned if the caller does not need to pass another
challenge. If the caller does need to pass another challenge before it gets tokens, ChallengeName,
ChallengeParameters, and Session are returned.
String userPoolId
The user pool ID for the user pool.
ProviderUserIdentifierType destinationUser
The existing user in the user pool to be linked to the external identity provider user account. Can be a native (Username + Password) Cognito User Pools user or a federated user (for example, a SAML or Facebook user). If the user doesn't exist, an exception is thrown. This is the user that is returned when the new user (with the linked identity provider attribute) signs in.
For a native username + password user, the ProviderAttributeValue for the
DestinationUser should be the username in the user pool. For a federated user, it should be the
provider-specific user_id.
The ProviderAttributeName of the DestinationUser is ignored.
The ProviderName should be set to Cognito for users in Cognito user pools.
ProviderUserIdentifierType sourceUser
An external identity provider account for a user who does not currently exist yet in the user pool. This user must be a federated user (for example, a SAML or Facebook user), not another native user.
If the SourceUser is a federated social identity provider user (Facebook, Google, or Login with
Amazon), you must set the ProviderAttributeName to Cognito_Subject. For social identity
providers, the ProviderName will be Facebook, Google, or
LoginWithAmazon, and Cognito will automatically parse the Facebook, Google, and Login with Amazon
tokens for id, sub, and user_id, respectively. The
ProviderAttributeValue for the user must be the same value as the id, sub,
or user_id value found in the social identity provider token.
For SAML, the ProviderAttributeName can be any value that matches a claim in the SAML assertion. If
you wish to link SAML users based on the subject of the SAML assertion, you should map the subject to a claim
through the SAML identity provider and submit that claim name as the ProviderAttributeName. If you
set ProviderAttributeName to Cognito_Subject, Cognito will automatically parse the
default unique identifier found in the subject from the SAML token.
String username
The username for the user.
String userPoolId
The user pool ID for the user pool.
Integer limit
The limit of the request to list groups.
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 the user pool where you want to reset the user's password.
String username
The user name of the user whose password you wish to reset.
Map<K,V> clientMetadata
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the
AdminResetUserPassword API action, Amazon Cognito invokes the function that is assigned to the custom
message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function
receives as input. This payload contains a clientMetadata attribute, which provides the data that
you assigned to the ClientMetadata parameter in your AdminResetUserPassword request. In your function code in AWS
Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
Take the following limitations into consideration when you use the ClientMetadata parameter:
Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
Amazon Cognito does not validate the ClientMetadata value.
Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
String userPoolId
The ID of the Amazon Cognito user pool.
String clientId
The app client ID.
String challengeName
The challenge name. For more information, see AdminInitiateAuth.
Map<K,V> challengeResponses
The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:
SMS_MFA: SMS_MFA_CODE, USERNAME, SECRET_HASH (if app client
is configured with client secret).
PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK,
TIMESTAMP, USERNAME, SECRET_HASH (if app client is configured with client
secret).
ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH (if app
client is configured with client secret).
NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes,
USERNAME, SECRET_HASH (if app client is configured with client secret).
The value of the USERNAME attribute must be the user's actual username, not an alias (such as email
address or phone number). To make this easier, the AdminInitiateAuth response includes the actual
username value in the USERNAMEUSER_ID_FOR_SRP attribute, even if you specified an alias in your call
to AdminInitiateAuth.
String session
The session which should be passed both ways in challenge-response calls to the service. If
InitiateAuth or RespondToAuthChallenge API call determines that the caller needs to go
through another challenge, they return a session with other challenge parameters. This session should be passed
as it is to the next RespondToAuthChallenge API call.
AnalyticsMetadataType analyticsMetadata
The analytics metadata for collecting Amazon Pinpoint metrics for AdminRespondToAuthChallenge calls.
ContextDataType contextData
Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
Map<K,V> clientMetadata
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the
AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following
triggers: pre sign-up, custom message, post authentication, user migration, pre
token generation, define auth challenge, create auth challenge, and verify auth challenge
response. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function
receives as input. This payload contains a clientMetadata attribute, which provides the data that
you assigned to the ClientMetadata parameter in your AdminRespondToAuthChallenge request. In your function code
in AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific
needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
Take the following limitations into consideration when you use the ClientMetadata parameter:
Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
Amazon Cognito does not validate the ClientMetadata value.
Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
String challengeName
The name of the challenge. For more information, see AdminInitiateAuth.
String session
The session which should be passed both ways in challenge-response calls to the service. If the caller needs to
go through another challenge, they return a session with other challenge parameters. This session should be
passed as it is to the next RespondToAuthChallenge API call.
Map<K,V> challengeParameters
The challenge parameters. For more information, see AdminInitiateAuth.
AuthenticationResultType authenticationResult
The result returned by the server in response to the authentication request.
SMSMfaSettingsType sMSMfaSettings
The SMS text message MFA settings.
SoftwareTokenMfaSettingsType softwareTokenMfaSettings
The time-based one-time password software token MFA settings.
String username
The user pool username or alias.
String userPoolId
The user pool ID.
String userPoolId
The user pool ID for the user pool where you want to set the user's password.
String username
The user name of the user whose password you wish to set.
String password
The password for the user.
Boolean permanent
True if the password is permanent, False if it is temporary.
String userPoolId
The ID of the user pool that contains the user that you are setting options for.
String username
The user name of the user that you are setting options for.
List<E> mFAOptions
You can use this parameter only to set an SMS configuration that uses SMS for delivery.
String userPoolId
The user pool ID for the user pool where you want to update user attributes.
String username
The user name of the user for whom you want to update user attributes.
List<E> userAttributes
An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom: prefix to the attribute name.
Map<K,V> clientMetadata
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the
AdminUpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the custom
message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function
receives as input. This payload contains a clientMetadata attribute, which provides the data that
you assigned to the ClientMetadata parameter in your AdminUpdateUserAttributes request. In your function code in
AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific
needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
Take the following limitations into consideration when you use the ClientMetadata parameter:
Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
Amazon Cognito does not validate the ClientMetadata value.
Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
String applicationId
The application ID for an Amazon Pinpoint application.
String applicationArn
The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project for Pinpoint integration with the chosen User Pool Client. Amazon Cognito publishes events to the pinpoint project declared by the app ARN.
String roleArn
The ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.
String externalId
The external ID.
Boolean userDataShared
If UserDataShared is true, Amazon Cognito will include user data in the events it
publishes to Amazon Pinpoint analytics.
String analyticsEndpointId
The endpoint ID.
String secretCode
A unique generated shared secret code that is used in the TOTP algorithm to generate a one time code.
String session
The session which should be passed both ways in challenge-response calls to the service. This allows authentication of the user as part of the MFA setup process.
String accessToken
The access token.
Integer expiresIn
The expiration period of the authentication result in seconds.
String tokenType
The token type.
String refreshToken
The refresh token.
String idToken
The ID token.
NewDeviceMetadataType newDeviceMetadata
The new device metadata from an authentication result.
String eventId
The event ID.
String eventType
The event type.
Date creationDate
The creation date
String eventResponse
The event response.
EventRiskType eventRisk
The event risk.
List<E> challengeResponses
The challenge responses.
EventContextDataType eventContextData
The user context data captured at the time of an event request. It provides additional information about the client from which event the request is received.
EventFeedbackType eventFeedback
A flag specifying the user feedback captured at the time of an event request is good or bad.
String eventAction
The event action.
List<E> eventFilter
Perform the action for these events. The default is to perform all events if no event filter is specified.
CompromisedCredentialsActionsType actions
The compromised credentials risk configuration actions.
String accessToken
The access token.
String deviceKey
The device key.
DeviceSecretVerifierConfigType deviceSecretVerifierConfig
The configuration of the device secret verifier.
String deviceName
The device name.
Boolean userConfirmationNecessary
Indicates whether the user confirmation is necessary to confirm the device response.
String clientId
The app client ID of the app 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. For more information, see ForgotPassword.
String password
The password sent by a user's request to retrieve a forgotten password.
AnalyticsMetadataType analyticsMetadata
The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword calls.
UserContextDataType userContextData
Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
Map<K,V> clientMetadata
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the
ConfirmForgotPassword API action, Amazon Cognito invokes the function that is assigned to the post
confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function
receives as input. This payload contains a clientMetadata attribute, which provides the data that
you assigned to the ClientMetadata parameter in your ConfirmForgotPassword request. In your function code in AWS
Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
Take the following limitations into consideration when you use the ClientMetadata parameter:
Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
Amazon Cognito does not validate the ClientMetadata value.
Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
String clientId
The ID of the app 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.
AnalyticsMetadataType analyticsMetadata
The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp calls.
UserContextDataType userContextData
Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
Map<K,V> clientMetadata
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the
ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the post confirmation
trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as
input. This payload contains a clientMetadata attribute, which provides the data that you assigned
to the ClientMetadata parameter in your ConfirmSignUp request. In your function code in AWS Lambda, you can
process the clientMetadata value to enhance your workflow for your specific needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
Take the following limitations into consideration when you use the ClientMetadata parameter:
Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
Amazon Cognito does not validate the ClientMetadata value.
Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
String ipAddress
Source IP address of your user.
String serverName
Your server endpoint where this API is invoked.
String serverPath
Your server path where this API is invoked.
List<E> httpHeaders
HttpHeaders received on your server in same order.
String encodedData
Encoded data containing device fingerprinting details, collected using the Amazon Cognito context data collection library.
String groupName
The name of the group. Must be unique.
String userPoolId
The user pool ID for the user pool.
String description
A string containing the description of the group.
String roleArn
The role ARN for the group.
Integer precedence
A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user
can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence
values take precedence over groups with higher or null Precedence values. If a user belongs to two
or more groups, it is the group with the lowest precedence value whose role ARN will be used in the
cognito:roles and cognito:preferred_role claims in the user's tokens.
Two groups can have the same Precedence value. If this happens, neither group takes precedence over
the other. If two groups with the same Precedence have the same role ARN, that role is used in the
cognito:preferred_role claim in tokens for users in each group. If the two groups have different
role ARNs, the cognito:preferred_role claim is not set in users' tokens.
The default Precedence value is null.
GroupType group
The group object for the group.
String userPoolId
The user pool ID.
String providerName
The identity provider name.
String providerType
The identity provider type.
Map<K,V> providerDetails
The identity provider details. The following list describes the provider detail keys for each identity provider type.
For Google and Login with Amazon:
client_id
client_secret
authorize_scopes
For Facebook:
client_id
client_secret
authorize_scopes
api_version
For Sign in with Apple:
client_id
team_id
key_id
private_key
authorize_scopes
For OIDC providers:
client_id
client_secret
attributes_request_method
oidc_issuer
authorize_scopes
authorize_url if not available from discovery URL specified by oidc_issuer key
token_url if not available from discovery URL specified by oidc_issuer key
attributes_url if not available from discovery URL specified by oidc_issuer key
jwks_uri if not available from discovery URL specified by oidc_issuer key
For SAML providers:
MetadataFile OR MetadataURL
IDPSignout optional
Map<K,V> attributeMapping
A mapping of identity provider attributes to standard and custom user pool attributes.
List<E> idpIdentifiers
A list of identity provider identifiers.
IdentityProviderType identityProvider
The newly created identity provider object.
String userPoolId
The user pool ID for the user pool.
String identifier
A unique resource server identifier for the resource server. This could be an HTTPS endpoint where the resource
server is located. For example, https://my-weather-api.example.com.
String name
A friendly name for the resource server.
List<E> scopes
A list of scopes. Each scope is map, where the keys are name and description.
ResourceServerType resourceServer
The newly created resource server.
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.
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.
Integer refreshTokenValidity
The time limit, in days, after which the refresh token is no longer valid and cannot be used.
Integer accessTokenValidity
The time limit, between 5 minutes and 1 day, after which the access token is no longer valid and cannot be used. This value will be overridden if you have entered a value in TokenValidityUnits.
Integer idTokenValidity
The time limit, between 5 minutes and 1 day, after which the ID token is no longer valid and cannot be used. This value will be overridden if you have entered a value in TokenValidityUnits.
TokenValidityUnitsType tokenValidityUnits
The units in which the validity times are represented in. Default for RefreshToken is days, and default for ID and access tokens are hours.
List<E> readAttributes
The read attributes.
List<E> writeAttributes
The user pool attributes that the app client can write to.
If your app client allows users to sign in through an identity provider, this array must include all attributes that are mapped to identity provider attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If your app client lacks write access to a mapped attribute, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.
List<E> explicitAuthFlows
The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_
prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with
ALLOW_ prefix cannot be used along with values without ALLOW_ prefix.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow
ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With
this authentication flow, Cognito receives the password in the request instead of using the SRP (Secure Remote
Password protocol) protocol to verify passwords.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Cognito receives
the password in the request instead of using the SRP protocol to verify passwords.
ALLOW_USER_SRP_AUTH: Enable SRP based authentication.
ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
List<E> supportedIdentityProviders
A list of provider names for the identity providers that are supported on this client. The following are
supported: COGNITO, Facebook, Google and LoginWithAmazon.
List<E> callbackURLs
A list of allowed redirect (callback) URLs for the identity providers.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
List<E> logoutURLs
A list of allowed logout URLs for the identity providers.
String defaultRedirectURI
The default redirect URI. Must be in the CallbackURLs list.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
List<E> allowedOAuthFlows
The allowed OAuth flows.
Set to code to initiate a code grant flow, which provides an authorization code as the response.
This code can be exchanged for access tokens with the token endpoint.
Set to implicit to specify that the client should get the access token (and, optionally, ID token,
based on scopes) directly.
Set to client_credentials to specify that the client should get the access token (and, optionally,
ID token, based on scopes) from the token endpoint using a combination of client and client_secret.
List<E> allowedOAuthScopes
The allowed OAuth scopes. Possible values provided by OAuth are: phone, email,
openid, and profile. Possible values provided by AWS are:
aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.
Boolean allowedOAuthFlowsUserPoolClient
Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
AnalyticsConfigurationType analyticsConfiguration
The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
In regions where Pinpoint is not available, Cognito User Pools only supports sending events to Amazon Pinpoint projects in us-east-1. In regions where Pinpoint is available, Cognito User Pools will support sending events to Amazon Pinpoint projects within that same region.
String preventUserExistenceErrors
Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account
confirmation, and password recovery when the user does not exist in the user pool. When set to
ENABLED and the user does not exist, authentication returns an error indicating either the username
or password was incorrect, and account confirmation and password recovery return a response indicating a code was
sent to a simulated destination. When set to LEGACY, those APIs will return a
UserNotFoundException exception if the user does not exist in the user pool.
Valid values include:
ENABLED - This prevents user existence-related errors.
LEGACY - This represents the old behavior of Cognito where user existence related errors are not
prevented.
After February 15th 2020, the value of PreventUserExistenceErrors will default to
ENABLED for newly created user pool clients if no value is provided.
UserPoolClientType userPoolClient
The user pool client that was just created.
String domain
The domain string.
String userPoolId
The user pool ID.
CustomDomainConfigType customDomainConfig
The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain instead.
For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.
String cloudFrontDomain
The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
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.
In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you will need to make an extra call to add permission for these event sources to invoke your Lambda function.
For more information on using the Lambda API to add permission, see AddPermission .
For adding permission using the AWS CLI, see add-permission .
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.
List<E> usernameAttributes
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
String smsVerificationMessage
A string representing the SMS verification message.
String emailVerificationMessage
A string representing the email verification message. EmailVerificationMessage is allowed only if EmailSendingAccount is DEVELOPER.
String emailVerificationSubject
A string representing the email verification subject. EmailVerificationSubject is allowed only if EmailSendingAccount is DEVELOPER.
VerificationMessageTemplateType verificationMessageTemplate
The template for the verification message that the user sees when the app requests permission to access the user's information.
String smsAuthenticationMessage
A string representing the SMS authentication message.
String mfaConfiguration
Specifies MFA configuration details.
DeviceConfigurationType deviceConfiguration
The device configuration.
EmailConfigurationType emailConfiguration
The email configuration.
SmsConfigurationType smsConfiguration
The SMS configuration.
Map<K,V> userPoolTags
The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
AdminCreateUserConfigType adminCreateUserConfig
The configuration for AdminCreateUser requests.
List<E> schema
An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
UserPoolAddOnsType userPoolAddOns
Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value
"AUDIT".
UsernameConfigurationType usernameConfiguration
You can choose to set case sensitivity on the username input for the selected sign-in option. For example, when
this is set to False, users will be able to sign in using either "username" or "Username". This
configuration is immutable once it has been set. For more information, see UsernameConfigurationType.
AccountRecoverySettingType accountRecoverySetting
Use this setting to define which verified available method a user can use to recover their password when they
call ForgotPassword. It allows you to define a preferred method when a user has more than one method
available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has
SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery
method where SMS is preferred over email.
UserPoolType userPool
A container for the user pool details.
String certificateArn
The Amazon Resource Name (ARN) of an AWS Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain.
String lambdaVersion
The Lambda version represents the signature of the "request" attribute in the "event" information Amazon Cognito
passes to your custom email Lambda function. The only supported value is V1_0.
String lambdaArn
The Lambda Amazon Resource Name of the Lambda function that Amazon Cognito triggers to send email notifications to users.
String lambdaVersion
The Lambda version represents the signature of the "request" attribute in the "event" information Amazon Cognito
passes to your custom SMS Lambda function. The only supported value is V1_0.
String lambdaArn
The Lambda Amazon Resource Name of the Lambda function that Amazon Cognito triggers to send SMS notifications to users.
List<E> userAttributeNames
An array of strings representing the user attribute names you wish to delete.
For custom attributes, you must prepend the custom: prefix to the attribute name.
String accessToken
The access token used in the request to delete user attributes.
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.
IdentityProviderType identityProvider
The identity provider that was deleted.
ResourceServerType resourceServer
The resource server.
RiskConfigurationType riskConfiguration
The risk configuration.
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 domain
The domain string.
DomainDescriptionType domainDescription
A domain description object containing information about the domain.
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 deviceKey
The device key.
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 userPoolId
The user pool ID.
String aWSAccountId
The AWS account ID for the user pool owner.
String domain
The domain string.
String s3Bucket
The S3 bucket where the static files for this domain are stored.
String cloudFrontDistribution
The ARN of the CloudFront distribution.
String version
The app version.
String status
The domain status.
CustomDomainConfigType customDomainConfig
The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
String sourceArn
The Amazon Resource Name (ARN) of a verified email address in Amazon SES. This email address is used in one of
the following ways, depending on the value that you specify for the EmailSendingAccount parameter:
If you specify COGNITO_DEFAULT, Amazon Cognito uses this address as the custom FROM address when it
emails your users by using its built-in email account.
If you specify DEVELOPER, Amazon Cognito emails your users with this address by calling Amazon SES
on your behalf.
String replyToEmailAddress
The destination to which the receiver of the email should reply to.
String emailSendingAccount
Specifies whether Amazon Cognito emails your users by using its built-in email functionality or your Amazon SES email configuration. Specify one of the following values:
When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. For typical production environments, the default email limit is below the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration.
To look up the email delivery limit for the default option, see Limits in Amazon Cognito in the Amazon Cognito Developer Guide.
The default FROM address is [email protected]. To customize the FROM address, provide the ARN of an
Amazon SES verified email address for the SourceArn parameter.
If EmailSendingAccount is COGNITO_DEFAULT, the following parameters aren't allowed:
EmailVerificationMessage
EmailVerificationSubject
InviteMessageTemplate.EmailMessage
InviteMessageTemplate.EmailSubject
VerificationMessageTemplate.EmailMessage
VerificationMessageTemplate.EmailMessageByLink
VerificationMessageTemplate.EmailSubject,
VerificationMessageTemplate.EmailSubjectByLink
DEVELOPER EmailSendingAccount is required.
When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your AWS account.
If you use this option, you must provide the ARN of an Amazon SES verified email address for the
SourceArn parameter.
Before Amazon Cognito can email your users, it requires additional permissions to call Amazon SES on your behalf. When you update your user pool with this option, Amazon Cognito creates a service-linked role, which is a type of IAM role, in your AWS account. This role contains the permissions that allow Amazon Cognito to access Amazon SES and send email messages with your address. For more information about the service-linked role that Amazon Cognito creates, see Using Service-Linked Roles for Amazon Cognito in the Amazon Cognito Developer Guide.
String from
Identifies either the sender’s email address or the sender’s name with their email address. For example,
[email protected] or Test User <[email protected]>. This address will
appear before the body of the email.
String configurationSet
The set of configuration rules that can be applied to emails sent using Amazon SES. A configuration set is applied to an email by including a reference to the configuration set in the headers of the email. Once applied, all of the rules in that configuration set are applied to the email. Configuration sets can be used to apply the following types of rules to emails:
Event publishing – Amazon SES can track the number of send, delivery, open, click, bounce, and complaint events for each email sent. Use event publishing to send information about these events to other AWS services such as SNS and CloudWatch.
IP pool management – When leasing dedicated IP addresses with Amazon SES, you can create groups of IP addresses, called dedicated IP pools. You can then associate the dedicated IP pools with configuration sets.
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.
UserContextDataType userContextData
Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
String username
The user name of the user for whom you want to enter a code to reset a forgotten password.
AnalyticsMetadataType analyticsMetadata
The Amazon Pinpoint analytics metadata for collecting metrics for ForgotPassword calls.
Map<K,V> clientMetadata
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the
ForgotPassword API action, Amazon Cognito invokes any functions that are assigned to the following triggers:
pre sign-up, custom message, and user migration. When Amazon Cognito invokes any of these
functions, it passes a JSON payload, which the function receives as input. This payload contains a
clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter
in your ForgotPassword request. In your function code in AWS Lambda, you can process the
clientMetadata value to enhance your workflow for your specific needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
Take the following limitations into consideration when you use the ClientMetadata parameter:
Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
Amazon Cognito does not validate the ClientMetadata value.
Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
CodeDeliveryDetailsType codeDeliveryDetails
The code delivery details returned by the server in response to the request to reset a password.
String userPoolId
The user pool ID for the user pool that the users are to be imported into.
DeviceType device
The device.
GroupType group
The group object for the group.
IdentityProviderType identityProvider
The identity provider object.
String userPoolId
The user pool ID.
String certificate
The signing certificate.
UICustomizationType uICustomization
The UI customization information.
String accessToken
The access token returned by the server response to get the user attribute verification code.
String attributeName
The attribute name returned by the server response to get the user attribute verification code.
Map<K,V> clientMetadata
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the
GetUserAttributeVerificationCode API action, Amazon Cognito invokes the function that is assigned to the
custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the
function receives as input. This payload contains a clientMetadata attribute, which provides the
data that you assigned to the ClientMetadata parameter in your GetUserAttributeVerificationCode request. In your
function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow for
your specific needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
Take the following limitations into consideration when you use the ClientMetadata parameter:
Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
Amazon Cognito does not validate the ClientMetadata value.
Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
CodeDeliveryDetailsType codeDeliveryDetails
The code delivery details returned by the server in response to the request to get the user attribute verification code.
String userPoolId
The user pool ID.
SmsMfaConfigType smsMfaConfiguration
The SMS text message multi-factor (MFA) configuration.
SoftwareTokenMfaConfigType softwareTokenMfaConfiguration
The software token multi-factor (MFA) configuration.
String mfaConfiguration
The multi-factor (MFA) configuration. Valid values include:
OFF MFA will not be used for any users.
ON MFA is required for all users to sign in.
OPTIONAL MFA will be required only for individual users who have an MFA factor enabled.
String accessToken
The access token returned by the server response to get information about the user.
String username
The user name of the user you wish to retrieve from the get user request.
List<E> userAttributes
An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom: prefix to the attribute name.
List<E> mFAOptions
This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about TOTP software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.
String preferredMfaSetting
The user's preferred MFA setting.
List<E> userMFASettingList
The MFA options that are enabled for the user. The possible values in this list are SMS_MFA and
SOFTWARE_TOKEN_MFA.
String accessToken
The access token.
String groupName
The name of the group.
String userPoolId
The user pool ID for the user pool.
String description
A string containing the description of the group.
String roleArn
The role ARN for the group.
Integer precedence
A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user
can belong to in the user pool. If a user belongs to two or more groups, it is the group with the highest
precedence whose role ARN will be used in the cognito:roles and cognito:preferred_role
claims in the user's tokens. Groups with higher Precedence values take precedence over groups with
lower Precedence values or with null Precedence values.
Two groups can have the same Precedence value. If this happens, neither group takes precedence over
the other. If two groups with the same Precedence have the same role ARN, that role is used in the
cognito:preferred_role claim in tokens for users in each group. If the two groups have different
role ARNs, the cognito:preferred_role claim is not set in users' tokens.
The default Precedence value is null.
Date lastModifiedDate
The date the group was last modified.
Date creationDate
The date the group was created.
String userPoolId
The user pool ID.
String providerName
The identity provider name.
String providerType
The identity provider type.
Map<K,V> providerDetails
The identity provider details. The following list describes the provider detail keys for each identity provider type.
For Google and Login with Amazon:
client_id
client_secret
authorize_scopes
For Facebook:
client_id
client_secret
authorize_scopes
api_version
For Sign in with Apple:
client_id
team_id
key_id
private_key
authorize_scopes
For OIDC providers:
client_id
client_secret
attributes_request_method
oidc_issuer
authorize_scopes
authorize_url if not available from discovery URL specified by oidc_issuer key
token_url if not available from discovery URL specified by oidc_issuer key
attributes_url if not available from discovery URL specified by oidc_issuer key
jwks_uri if not available from discovery URL specified by oidc_issuer key
authorize_scopes
For SAML providers:
MetadataFile OR MetadataURL
IDPSignOut optional
Map<K,V> attributeMapping
A mapping of identity provider attributes to standard and custom user pool attributes.
List<E> idpIdentifiers
A list of identity provider identifiers.
Date lastModifiedDate
The date the identity provider was last modified.
Date creationDate
The date the identity provider was created.
String authFlow
The authentication flow for this call to execute. The API action will depend on this value. For example:
REFRESH_TOKEN_AUTH will take in a valid refresh token and return new tokens.
USER_SRP_AUTH will take in USERNAME and SRP_A and return the SRP variables
to be used for next challenge execution.
USER_PASSWORD_AUTH will take in USERNAME and PASSWORD and return the next
challenge or tokens.
Valid values include:
USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.
REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token
and ID token by supplying a valid refresh token.
CUSTOM_AUTH: Custom authentication flow.
USER_PASSWORD_AUTH: Non-SRP authentication flow; USERNAME and PASSWORD are passed directly. If a
user migration Lambda trigger is set, this flow will invoke the user migration Lambda if the USERNAME is not
found in the user pool.
ADMIN_USER_PASSWORD_AUTH: Admin-based user password authentication. This replaces the
ADMIN_NO_SRP_AUTH authentication flow. In this flow, Cognito receives the password in the request
instead of using the SRP process to verify passwords.
ADMIN_NO_SRP_AUTH is not a valid value.
Map<K,V> authParameters
The authentication parameters. These are inputs corresponding to the AuthFlow that you are invoking.
The required values depend on the value of AuthFlow:
For USER_SRP_AUTH: USERNAME (required), SRP_A (required),
SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY
.
For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required),
SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY
.
For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is
configured with client secret), DEVICE_KEY. To start the authentication flow with password
verification, include ChallengeName: SRP_A and SRP_A: (The SRP_A Value).
Map<K,V> clientMetadata
A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.
You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the InitiateAuth API action, Amazon Cognito invokes the AWS Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:
Pre signup
Pre authentication
User migration
When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function
receives as input. This payload contains a validationData attribute, which provides the data that
you assigned to the ClientMetadata parameter in your InitiateAuth request. In your function code in AWS Lambda,
you can process the validationData value to enhance your workflow for your specific needs.
When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it does not provide the ClientMetadata value as input:
Post authentication
Custom message
Pre token generation
Create auth challenge
Define auth challenge
Verify auth challenge
For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
Take the following limitations into consideration when you use the ClientMetadata parameter:
Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
Amazon Cognito does not validate the ClientMetadata value.
Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
String clientId
The app client ID.
AnalyticsMetadataType analyticsMetadata
The Amazon Pinpoint analytics metadata for collecting metrics for InitiateAuth calls.
UserContextDataType userContextData
Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
String challengeName
The name of the challenge which you are responding to with this call. This is returned to you in the
AdminInitiateAuth response if you need to pass another challenge.
Valid values include the following. Note that all of these challenges require USERNAME and
SECRET_HASH (if applicable) in the parameters.
SMS_MFA: Next challenge is to supply an SMS_MFA_CODE, delivered via SMS.
PASSWORD_VERIFIER: Next challenge is to supply PASSWORD_CLAIM_SIGNATURE,
PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after the client-side SRP calculations.
CUSTOM_CHALLENGE: This is returned if your custom authentication flow determines that the user
should pass another challenge before tokens are issued.
DEVICE_SRP_AUTH: If device tracking was enabled on your user pool and the previous challenges were
passed, this challenge is returned so that Amazon Cognito can start tracking this device.
DEVICE_PASSWORD_VERIFIER: Similar to PASSWORD_VERIFIER, but for devices only.
NEW_PASSWORD_REQUIRED: For users which are required to change their passwords after successful first
login. This challenge should be passed with NEW_PASSWORD and any other required attributes.
String session
The session which should be passed both ways in challenge-response calls to the service. If the caller needs to
go through another challenge, they return a session with other challenge parameters. This session should be
passed as it is to the next RespondToAuthChallenge API call.
Map<K,V> challengeParameters
The challenge parameters. These are returned to you in the InitiateAuth response if you need to pass
another challenge. The responses in this parameter should be used to compute inputs to the next call (
RespondToAuthChallenge).
All challenges require USERNAME and SECRET_HASH (if applicable).
AuthenticationResultType authenticationResult
The result of the authentication response. This is only returned if the caller does not need to pass another
challenge. If the caller does need to pass another challenge before it gets tokens, ChallengeName,
ChallengeParameters, and Session are returned.
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 defineAuthChallenge
Defines the authentication challenge.
String createAuthChallenge
Creates an authentication challenge.
String verifyAuthChallengeResponse
Verifies the authentication challenge response.
String preTokenGeneration
A Lambda trigger that is invoked before token generation.
String userMigration
The user migration Lambda config type.
CustomSMSLambdaVersionConfigType customSMSSender
A custom SMS sender AWS Lambda trigger.
CustomEmailLambdaVersionConfigType customEmailSender
A custom email sender AWS Lambda trigger.
String kMSKeyID
The Amazon Resource Name of Key Management Service Customer master keys . Amazon Cognito uses the
key to encrypt codes and temporary passwords sent to CustomEmailSender and
CustomSMSSender.
String resourceArn
The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.
String userPoolId
The user pool ID for the user pool that the users are being imported into.
Integer maxResults
The maximum number of import jobs you want the request to return.
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.
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 the user pool.
String groupName
The name of the group.
Integer limit
The limit of the request to list users.
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 the user pool on which the search should be performed.
List<E> attributesToGet
An array of strings, where each string is the name of a user attribute to be returned for each user in the search results. If the array is null, all attributes are returned.
Integer limit
Maximum number of users to be returned.
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 filter
A filter string of the form "AttributeName Filter-Type "AttributeValue"". Quotation marks
within the filter string must be escaped using the backslash (\) character. For example, "
family_name = \"Reddy\"".
AttributeName: The name of the attribute to search for. You can only search for one attribute at a time.
Filter-Type: For an exact match, use =, for example, "given_name = \"Jon\"". For a prefix
("starts with") match, use ^=, for example, "given_name ^= \"Jon\"".
AttributeValue: The attribute value that must be matched for each user.
If the filter string is empty, ListUsers returns all users in the user pool.
You can only search for the following standard attributes:
username (case-sensitive)
email
phone_number
name
given_name
family_name
preferred_username
cognito:user_status (called Status in the Console) (case-insensitive)
status (called Enabled in the Console) (case-sensitive)
sub
Custom attributes are not searchable.
For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer Guide.
String sMSMessage
The message template for SMS messages.
String emailMessage
The message template for email messages. EmailMessage is allowed only if EmailSendingAccount is DEVELOPER.
String emailSubject
The subject line for email messages. EmailSubject is allowed only if EmailSendingAccount is DEVELOPER.
String from
The email address that is sending the email. It must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.
String replyTo
The destination to which the receiver of an email should reply to.
String sourceArn
The Amazon Resource Name (ARN) of the identity that is associated with the sending authorization policy. It
permits Amazon Cognito to send for the email address specified in the From parameter.
NotifyEmailType blockEmail
Email template used when a detected risk event is blocked.
NotifyEmailType noActionEmail
The email template used when a detected risk event is allowed.
NotifyEmailType mfaEmail
The MFA email template used when MFA is challenged as part of a detected risk.
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.
Integer temporaryPasswordValidityDays
In the password policy you have set, refers to the number of days a temporary password is valid. If the user does not sign-in during this time, their password will need to be reset by an administrator.
When you set TemporaryPasswordValidityDays for a user pool, you will no longer be able to set the
deprecated UnusedAccountValidityDays value for that user pool.
String providerName
The name of the provider, for example, Facebook, Google, or Login with Amazon.
String providerAttributeName
The name of the provider attribute to link to, for example, NameID.
String providerAttributeValue
The value of the provider attribute to link to, for example, xxxxx_account.
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.
UserContextDataType userContextData
Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
String username
The user name of the user to whom you wish to resend a confirmation code.
AnalyticsMetadataType analyticsMetadata
The Amazon Pinpoint analytics metadata for collecting metrics for ResendConfirmationCode calls.
Map<K,V> clientMetadata
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the
ResendConfirmationCode API action, Amazon Cognito invokes the function that is assigned to the custom
message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function
receives as input. This payload contains a clientMetadata attribute, which provides the data that
you assigned to the ClientMetadata parameter in your ResendConfirmationCode request. In your function code in AWS
Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
Take the following limitations into consideration when you use the ClientMetadata parameter:
Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
Amazon Cognito does not validate the ClientMetadata value.
Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
CodeDeliveryDetailsType codeDeliveryDetails
The code delivery details returned by the server in response to the request to resend the confirmation code.
String clientId
The app client ID.
String challengeName
The challenge name. For more information, see InitiateAuth.
ADMIN_NO_SRP_AUTH is not a valid value.
String session
The session which should be passed both ways in challenge-response calls to the service. If
InitiateAuth or RespondToAuthChallenge API call determines that the caller needs to go
through another challenge, they return a session with other challenge parameters. This session should be passed
as it is to the next RespondToAuthChallenge API call.
Map<K,V> challengeResponses
The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:
SECRET_HASH (if app client is configured with client secret) applies to all inputs below (including
SOFTWARE_TOKEN_MFA).
SMS_MFA: SMS_MFA_CODE, USERNAME.
PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK,
TIMESTAMP, USERNAME.
NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes,
USERNAME.
SOFTWARE_TOKEN_MFA: USERNAME and SOFTWARE_TOKEN_MFA_CODE are required
attributes.
DEVICE_SRP_AUTH requires USERNAME, DEVICE_KEY, SRP_A (and
SECRET_HASH).
DEVICE_PASSWORD_VERIFIER requires everything that PASSWORD_VERIFIER requires plus
DEVICE_KEY.
AnalyticsMetadataType analyticsMetadata
The Amazon Pinpoint analytics metadata for collecting metrics for RespondToAuthChallenge calls.
UserContextDataType userContextData
Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
Map<K,V> clientMetadata
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the
RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following
triggers: post authentication, pre token generation, define auth challenge, create auth
challenge, and verify auth challenge. When Amazon Cognito invokes any of these functions, it passes a
JSON payload, which the function receives as input. This payload contains a clientMetadata
attribute, which provides the data that you assigned to the ClientMetadata parameter in your
RespondToAuthChallenge request. In your function code in AWS Lambda, you can process the
clientMetadata value to enhance your workflow for your specific needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
Take the following limitations into consideration when you use the ClientMetadata parameter:
Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
Amazon Cognito does not validate the ClientMetadata value.
Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
String challengeName
The challenge name. For more information, see InitiateAuth.
String session
The session which should be passed both ways in challenge-response calls to the service. If the caller needs to
go through another challenge, they return a session with other challenge parameters. This session should be
passed as it is to the next RespondToAuthChallenge API call.
Map<K,V> challengeParameters
The challenge parameters. For more information, see InitiateAuth.
AuthenticationResultType authenticationResult
The result returned by the server in response to the request to respond to the authentication challenge.
String userPoolId
The user pool ID.
String clientId
The app client ID.
CompromisedCredentialsRiskConfigurationType compromisedCredentialsRiskConfiguration
The compromised credentials risk configuration object including the EventFilter and the
EventAction
AccountTakeoverRiskConfigurationType accountTakeoverRiskConfiguration
The account takeover risk configuration object including the NotifyConfiguration object and
Actions to take in the case of an account takeover.
RiskExceptionConfigurationType riskExceptionConfiguration
The configuration to override the risk decision.
Date lastModifiedDate
The last modified date.
List<E> blockedIPRangeList
Overrides the risk decision to always block the pre-authentication requests. The IP range is in CIDR notation: a compact representation of an IP address and its associated routing prefix.
List<E> skippedIPRangeList
Risk detection is not performed on the IP addresses in the range list. The IP range is in CIDR notation.
String name
A schema attribute of the name type.
String attributeDataType
The attribute data type.
Boolean developerOnlyAttribute
We recommend that you use WriteAttributes in the user pool client to control how attributes can be mutated for new use cases instead
of using DeveloperOnlyAttribute.
Specifies whether the attribute type is developer only. This attribute can only be modified by an administrator.
Users will not be able to modify this attribute using their access token. For example,
DeveloperOnlyAttribute can be modified using AdminUpdateUserAttributes but cannot be updated using
UpdateUserAttributes.
Boolean mutable
Specifies whether the value of the attribute can be changed.
For any user pool attribute that's mapped to an identity provider attribute, you must set this parameter to
true. Amazon Cognito updates mapped attributes when users sign in to your application through an
identity provider. If an attribute is immutable, Amazon Cognito throws an error when it attempts to update the
attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.
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 userPoolId
The user pool ID.
String clientId
The app client ID. If ClientId is null, then the risk configuration is mapped to
userPoolId. When the client ID is null, the same risk configuration is applied to all the clients in
the userPool.
Otherwise, ClientId is mapped to the client. When the client ID is not null, the user pool
configuration is overridden and the risk configuration for the client is used instead.
CompromisedCredentialsRiskConfigurationType compromisedCredentialsRiskConfiguration
The compromised credentials risk configuration.
AccountTakeoverRiskConfigurationType accountTakeoverRiskConfiguration
The account takeover risk configuration.
RiskExceptionConfigurationType riskExceptionConfiguration
The configuration to override the risk decision.
RiskConfigurationType riskConfiguration
The risk configuration.
String userPoolId
The user pool ID for the user pool.
String clientId
The client ID for the client app.
String cSS
The CSS values in the UI customization.
ByteBuffer imageFile
The uploaded logo image for the UI customization.
UICustomizationType uICustomization
The UI customization information.
SMSMfaSettingsType sMSMfaSettings
The SMS text message multi-factor authentication (MFA) settings.
SoftwareTokenMfaSettingsType softwareTokenMfaSettings
The time-based one-time password software token MFA settings.
String accessToken
The access token for the user.
String userPoolId
The user pool ID.
SmsMfaConfigType smsMfaConfiguration
The SMS text message MFA configuration.
SoftwareTokenMfaConfigType softwareTokenMfaConfiguration
The software token MFA configuration.
String mfaConfiguration
The MFA configuration. Valid values include:
OFF MFA will not be used for any users.
ON MFA is required for all users to sign in.
OPTIONAL MFA will be required only for individual users who have an MFA factor enabled.
SmsMfaConfigType smsMfaConfiguration
The SMS text message MFA configuration.
SoftwareTokenMfaConfigType softwareTokenMfaConfiguration
The software token MFA configuration.
String mfaConfiguration
The MFA configuration. Valid values include:
OFF MFA will not be used for any users.
ON MFA is required for all users to sign in.
OPTIONAL MFA will be required only for individual users who have an MFA factor enabled.
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.
For custom attributes, you must prepend the custom: prefix to the attribute name.
List<E> validationData
The validation data in the request to register a user.
AnalyticsMetadataType analyticsMetadata
The Amazon Pinpoint analytics metadata for collecting metrics for SignUp calls.
UserContextDataType userContextData
Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
Map<K,V> clientMetadata
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the SignUp API
action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up,
custom message, and post confirmation. When Amazon Cognito invokes any of these functions, it
passes a JSON payload, which the function receives as input. This payload contains a clientMetadata
attribute, which provides the data that you assigned to the ClientMetadata parameter in your SignUp request. In
your function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow
for your specific needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
Take the following limitations into consideration when you use the ClientMetadata parameter:
Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
Amazon Cognito does not validate the ClientMetadata value.
Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
Boolean userConfirmed
A response from the server indicating that a user registration has been confirmed.
CodeDeliveryDetailsType codeDeliveryDetails
The code delivery details returned by the server response to the user registration request.
String userSub
The UUID of the authenticated user. This is not the same as username.
String snsCallerArn
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) caller. This is the ARN of the IAM role in your AWS account which Cognito will use to send SMS messages. SMS messages are subject to a spending limit.
String externalId
The external ID is a value that we recommend you use to add security to your IAM role which is used to call
Amazon SNS to send SMS messages for your user pool. If you provide an ExternalId, the Cognito User
Pool will include it when attempting to assume your IAM role, so that you can set your roles trust policy to
require the ExternalID. If you use the Cognito Management Console to create a role for SMS MFA,
Cognito will create a role with the required permissions and a trust policy that demonstrates use of the
ExternalId.
String smsAuthenticationMessage
The SMS authentication message that will be sent to users with the code they need to sign in. The message must contain the ‘{####}’ placeholder, which will be replaced with the code. If the message is not included, and default message will be used.
SmsConfigurationType smsConfiguration
The SMS configuration.
Boolean enabled
Specifies whether SMS text message MFA is enabled. If an MFA type is enabled for a user, the user will be prompted for MFA during all sign in attempts, unless device tracking is turned on and the device has been trusted.
Boolean preferredMfa
Specifies whether SMS is the preferred MFA method.
Boolean enabled
Specifies whether software token MFA is enabled.
Boolean enabled
Specifies whether software token MFA is enabled. If an MFA type is enabled for a user, the user will be prompted for MFA during all sign in attempts, unless device tracking is turned on and the device has been trusted.
Boolean preferredMfa
Specifies whether software token MFA is the preferred MFA method.
UserImportJobType userImportJob
The job object that represents the user import job.
UserImportJobType userImportJob
The job object that represents the user import job.
String accessToken
A time unit in “seconds”, “minutes”, “hours” or “days” for the value in AccessTokenValidity, defaults to hours.
String idToken
A time unit in “seconds”, “minutes”, “hours” or “days” for the value in IdTokenValidity, defaults to hours.
String refreshToken
A time unit in “seconds”, “minutes”, “hours” or “days” for the value in RefreshTokenValidity, defaults to days.
String userPoolId
The user pool ID for the user pool.
String clientId
The client ID for the client app.
String imageUrl
The logo image for the UI customization.
String cSS
The CSS values in the UI customization.
String cSSVersion
The CSS version number.
Date lastModifiedDate
The last-modified date for the UI customization.
Date creationDate
The creation date for the UI customization.
String groupName
The name of the group.
String userPoolId
The user pool ID for the user pool.
String description
A string containing the new description of the group.
String roleArn
The new role ARN for the group. This is used for setting the cognito:roles and
cognito:preferred_role claims in the token.
Integer precedence
The new precedence value for the group. For more information about this parameter, see CreateGroup.
GroupType group
The group object for the group.
String userPoolId
The user pool ID.
String providerName
The identity provider name.
Map<K,V> providerDetails
The identity provider details to be updated, such as MetadataURL and MetadataFile.
Map<K,V> attributeMapping
The identity provider attribute mapping to be changed.
List<E> idpIdentifiers
A list of identity provider identifiers.
IdentityProviderType identityProvider
The identity provider object.
ResourceServerType resourceServer
The resource server.
List<E> userAttributes
An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom: prefix to the attribute name.
String accessToken
The access token for the request to update user attributes.
Map<K,V> clientMetadata
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the
UpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the custom
message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function
receives as input. This payload contains a clientMetadata attribute, which provides the data that
you assigned to the ClientMetadata parameter in your UpdateUserAttributes request. In your function code in AWS
Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
Take the following limitations into consideration when you use the ClientMetadata parameter:
Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
Amazon Cognito does not validate the ClientMetadata value.
Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
String userPoolId
The user pool ID for the user pool where you want to update the user pool client.
String clientId
The ID of the client associated with the user pool.
String clientName
The client name from the update user pool client request.
Integer refreshTokenValidity
The time limit, in days, after which the refresh token is no longer valid and cannot be used.
Integer accessTokenValidity
The time limit, after which the access token is no longer valid and cannot be used.
Integer idTokenValidity
The time limit, after which the ID token is no longer valid and cannot be used.
TokenValidityUnitsType tokenValidityUnits
The units in which the validity times are represented in. Default for RefreshToken is days, and default for ID and access tokens are hours.
List<E> readAttributes
The read-only attributes of the user pool.
List<E> writeAttributes
The writeable attributes of the user pool.
List<E> explicitAuthFlows
The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_
prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with
ALLOW_ prefix cannot be used along with values without ALLOW_ prefix.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow
ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With
this authentication flow, Cognito receives the password in the request instead of using the SRP (Secure Remote
Password protocol) protocol to verify passwords.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Cognito receives
the password in the request instead of using the SRP protocol to verify passwords.
ALLOW_USER_SRP_AUTH: Enable SRP based authentication.
ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
List<E> supportedIdentityProviders
A list of provider names for the identity providers that are supported on this client.
List<E> callbackURLs
A list of allowed redirect (callback) URLs for the identity providers.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
List<E> logoutURLs
A list of allowed logout URLs for the identity providers.
String defaultRedirectURI
The default redirect URI. Must be in the CallbackURLs list.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
List<E> allowedOAuthFlows
The allowed OAuth flows.
Set to code to initiate a code grant flow, which provides an authorization code as the response.
This code can be exchanged for access tokens with the token endpoint.
Set to implicit to specify that the client should get the access token (and, optionally, ID token,
based on scopes) directly.
Set to client_credentials to specify that the client should get the access token (and, optionally,
ID token, based on scopes) from the token endpoint using a combination of client and client_secret.
List<E> allowedOAuthScopes
The allowed OAuth scopes. Possible values provided by OAuth are: phone, email,
openid, and profile. Possible values provided by AWS are:
aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.
Boolean allowedOAuthFlowsUserPoolClient
Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
AnalyticsConfigurationType analyticsConfiguration
The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
In regions where Pinpoint is not available, Cognito User Pools only supports sending events to Amazon Pinpoint projects in us-east-1. In regions where Pinpoint is available, Cognito User Pools will support sending events to Amazon Pinpoint projects within that same region.
String preventUserExistenceErrors
Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account
confirmation, and password recovery when the user does not exist in the user pool. When set to
ENABLED and the user does not exist, authentication returns an error indicating either the username
or password was incorrect, and account confirmation and password recovery return a response indicating a code was
sent to a simulated destination. When set to LEGACY, those APIs will return a
UserNotFoundException exception if the user does not exist in the user pool.
Valid values include:
ENABLED - This prevents user existence-related errors.
LEGACY - This represents the old behavior of Cognito where user existence related errors are not
prevented.
After February 15th 2020, the value of PreventUserExistenceErrors will default to
ENABLED for newly created user pool clients if no value is provided.
UserPoolClientType userPoolClient
The user pool client value from the response from the server when an update user pool client request is made.
String domain
The domain name for the custom domain that hosts the sign-up and sign-in pages for your application. For example:
auth.example.com.
This string can include only lowercase letters, numbers, and hyphens. Do not use a hyphen for the first or last character. Use periods to separate subdomain names.
String userPoolId
The ID of the user pool that is associated with the custom domain that you are updating the certificate for.
CustomDomainConfigType customDomainConfig
The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. Use this object to specify an SSL certificate that is managed by ACM.
String cloudFrontDomain
The Amazon CloudFront endpoint that Amazon Cognito set up when you added the custom domain to your user pool.
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 verification message.
VerificationMessageTemplateType verificationMessageTemplate
The template for verification messages.
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.
DeviceConfigurationType deviceConfiguration
Device configuration.
EmailConfigurationType emailConfiguration
Email configuration.
SmsConfigurationType smsConfiguration
SMS configuration.
Map<K,V> userPoolTags
The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
AdminCreateUserConfigType adminCreateUserConfig
The configuration for AdminCreateUser requests.
UserPoolAddOnsType userPoolAddOns
Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value
"AUDIT".
AccountRecoverySettingType accountRecoverySetting
Use this setting to define which verified available method a user can use to recover their password when they
call ForgotPassword. It allows you to define a preferred method when a user has more than one method
available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has
SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery
method where SMS is preferred over email.
String encodedData
Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
String jobName
The job name for the user import job.
String jobId
The job ID for the user import job.
String userPoolId
The user pool ID for the user pool that the users are being imported into.
String preSignedUrl
The pre-signed URL to be used to upload the .csv file.
Date creationDate
The date the user import job was created.
Date startDate
The date when the user import job was started.
Date completionDate
The date when the user import 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.
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.
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.
Boolean caseSensitive
Specifies whether username case sensitivity will be applied for all users in the user pool through Cognito APIs.
Valid values include:
True : Enables case sensitivity for all username input. When this option is set to
True, users must sign in using the exact capitalization of their given username. For example,
“UserName”. This is the default value.
False : Enables case insensitivity for all username input. For example, when this option is
set to False, users will be able to sign in using either "username" or "Username". This option also
enables both preferred_username and email alias to be case insensitive, in addition to
the username attribute.
String advancedSecurityMode
The advanced security mode.
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 date the user pool client was last modified.
Date creationDate
The date the user pool client was created.
Integer refreshTokenValidity
The time limit, in days, after which the refresh token is no longer valid and cannot be used.
Integer accessTokenValidity
The time limit, specified by tokenValidityUnits, defaulting to hours, after which the access token is no longer valid and cannot be used.
Integer idTokenValidity
The time limit, specified by tokenValidityUnits, defaulting to hours, after which the refresh token is no longer valid and cannot be used.
TokenValidityUnitsType tokenValidityUnits
The time units used to specify the token validity times of their respective token.
List<E> readAttributes
The Read-only attributes.
List<E> writeAttributes
The writeable attributes.
List<E> explicitAuthFlows
The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_
prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with
ALLOW_ prefix cannot be used along with values without ALLOW_ prefix.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow
ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With
this authentication flow, Cognito receives the password in the request instead of using the SRP (Secure Remote
Password protocol) protocol to verify passwords.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Cognito receives
the password in the request instead of using the SRP protocol to verify passwords.
ALLOW_USER_SRP_AUTH: Enable SRP based authentication.
ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
List<E> supportedIdentityProviders
A list of provider names for the identity providers that are supported on this client.
List<E> callbackURLs
A list of allowed redirect (callback) URLs for the identity providers.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
List<E> logoutURLs
A list of allowed logout URLs for the identity providers.
String defaultRedirectURI
The default redirect URI. Must be in the CallbackURLs list.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
List<E> allowedOAuthFlows
The allowed OAuth flows.
Set to code to initiate a code grant flow, which provides an authorization code as the response.
This code can be exchanged for access tokens with the token endpoint.
Set to implicit to specify that the client should get the access token (and, optionally, ID token,
based on scopes) directly.
Set to client_credentials to specify that the client should get the access token (and, optionally,
ID token, based on scopes) from the token endpoint using a combination of client and client_secret.
List<E> allowedOAuthScopes
The allowed OAuth scopes. Possible values provided by OAuth are: phone, email,
openid, and profile. Possible values provided by AWS are:
aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.
Boolean allowedOAuthFlowsUserPoolClient
Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
AnalyticsConfigurationType analyticsConfiguration
The Amazon Pinpoint analytics configuration for the user pool client.
Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the region in which the user pool resides.
String preventUserExistenceErrors
Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account
confirmation, and password recovery when the user does not exist in the user pool. When set to
ENABLED and the user does not exist, authentication returns an error indicating either the username
or password was incorrect, and account confirmation and password recovery return a response indicating a code was
sent to a simulated destination. When set to LEGACY, those APIs will return a
UserNotFoundException exception if the user does not exist in the user pool.
Valid values include:
ENABLED - This prevents user existence-related errors.
LEGACY - This represents the old behavior of Cognito where user existence related errors are not
prevented.
After February 15th 2020, the value of PreventUserExistenceErrors will default to
ENABLED for newly created user pool clients if no value is provided.
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 date the user pool description was last modified.
Date creationDate
The date the user pool description was created.
PasswordPolicyType passwordPolicy
The password policy.
String id
The ID of the user pool.
String name
The name of the user pool.
UserPoolPolicyType policies
The policies associated with the user pool.
LambdaConfigType lambdaConfig
The AWS Lambda triggers associated with the user pool.
String status
The status of a user pool.
Date lastModifiedDate
The date the user pool was last modified.
Date creationDate
The date the user pool was created.
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.
List<E> usernameAttributes
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
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.
VerificationMessageTemplateType verificationMessageTemplate
The template for verification messages.
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.
DeviceConfigurationType deviceConfiguration
The device configuration.
Integer estimatedNumberOfUsers
A number estimating the size of the user pool.
EmailConfigurationType emailConfiguration
The email configuration.
SmsConfigurationType smsConfiguration
The SMS configuration.
Map<K,V> userPoolTags
The tags that are assigned to the user pool. A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
String smsConfigurationFailure
The reason why the SMS configuration cannot send the messages to your users.
String emailConfigurationFailure
The reason why the email configuration cannot send the messages to your users.
String domain
Holds the domain prefix if the user pool has a domain associated with it.
String customDomain
A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a custom domain
to host the sign-up and sign-in pages for your application. For example: auth.example.com.
For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
AdminCreateUserConfigType adminCreateUserConfig
The configuration for AdminCreateUser requests.
UserPoolAddOnsType userPoolAddOns
The user pool add-ons.
UsernameConfigurationType usernameConfiguration
You can choose to enable case sensitivity on the username input for the selected sign-in option. For example,
when this is set to False, users will be able to sign in using either "username" or "Username". This
configuration is immutable once it has been set. For more information, see UsernameConfigurationType.
String arn
The Amazon Resource Name (ARN) for the user pool.
AccountRecoverySettingType accountRecoverySetting
Use this setting to define which verified available method a user can use to recover their password when they
call ForgotPassword. It allows you to define a preferred method when a user has more than one method
available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has
SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery
method where SMS is preferred over email.
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:
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.
RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or she can sign in.
FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change his or her password to a new value before doing anything else.
List<E> mFAOptions
The MFA options for the user.
String smsMessage
The SMS message template.
String emailMessage
The email message template. EmailMessage is allowed only if EmailSendingAccount is DEVELOPER.
String emailSubject
The subject line for the email message template. EmailSubject is allowed only if EmailSendingAccount is DEVELOPER.
String emailMessageByLink
The email message template for sending a confirmation link to the user. EmailMessageByLink is allowed only if EmailSendingAccount is DEVELOPER.
String emailSubjectByLink
The subject line for the email message template for sending a confirmation link to the user. EmailSubjectByLink is allowed only EmailSendingAccount is DEVELOPER.
String defaultEmailOption
The default email option.
String accessToken
The access token.
String session
The session which should be passed both ways in challenge-response calls to the service.
String userCode
The one time password computed using the secret code returned by AssociateSoftwareToken".
String friendlyDeviceName
The friendly device name.
Copyright © 2020. All rights reserved.