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 action to take in response to the account takeover action. Valid values are as follows:
BLOCK Choosing this action will block the request.
MFA_IF_CONFIGURED Present an MFA challenge if user has configured it, else allow the request.
MFA_REQUIRED Present an MFA challenge if user has configured it, else block the request.
NO_ACTION Allow the user to 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 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 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.
When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito 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 a new account that hasn't signed in 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 no longer be an available parameter 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 can't 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) either you should supply (in your call to AdminCreateUser) or the user should supply (when
they sign 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. You can do this 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 isn't 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 isn't required. If you don't 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 used only 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. You can
specify only one value.
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". You can specify more than one value.
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 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 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.
When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito 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 want 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're 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.
UNKNOWN - User status isn't known.
RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they 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 their 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 time-based one-time password (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 activated 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 run. 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 Secure Remote
Password (SRP) protocol variables to be used for next challenge execution.
ADMIN_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.
ADMIN_USER_PASSWORD_AUTH: Admin-based user password authentication. This replaces the
ADMIN_NO_SRP_AUTH authentication flow. In this flow, Amazon 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're 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 Lambda functions to user pool triggers. When you use the AdminInitiateAuth API action, Amazon Cognito invokes the 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 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 doesn't 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.
When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
AnalyticsMetadataType analyticsMetadata
The analytics metadata for collecting Amazon Pinpoint metrics for AdminInitiateAuth calls.
ContextDataType contextData
Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
String challengeName
The name of the challenge that you're responding to with this call. This is returned in the
AdminInitiateAuth response if you must pass another challenge.
MFA_SETUP: If MFA is required, users who don't 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 time-based one-time password (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 activated in 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 must authenticate with USERNAME and
PASSWORD directly. An app client must be enabled to use this flow.
NEW_PASSWORD_REQUIRED: For users who are required to change their passwords after successful first
login. Respond to this challenge with NEW_PASSWORD and any required attributes that Amazon Cognito
returned in the requiredAttributes parameter. You can also set values for attributes that aren't
required by your user pool and that your app client can write. For more information, see AdminRespondToAuthChallenge.
In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already
has a value. In AdminRespondToAuthChallenge, set a value for any keys that Amazon Cognito returned
in the requiredAttributes parameter, then use the AdminUpdateUserAttributes API
operation to modify the value of any additional attributes.
MFA_SETUP: For users who are required to set up an MFA factor before they can sign in. The MFA types
activated for the user pool will be listed in the challenge parameters MFA_CAN_SETUP value.
To set up software token MFA, use the session returned here from InitiateAuth as an input to
AssociateSoftwareToken, and use the session returned by VerifySoftwareToken as an input
to RespondToAuthChallenge with challenge name MFA_SETUP to complete sign-in. To set up
SMS MFA, users will need help from an administrator to add a phone number to their account and then call
InitiateAuth again to restart sign-in.
String session
The session that should be passed both ways in challenge-response calls to the service. If
AdminInitiateAuth or AdminRespondToAuthChallenge API call determines that the caller
must pass 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 must
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 is 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 happens because, in the AdminRespondToAuthChallenge API ChallengeResponses, the
USERNAME attribute can't be an alias.
AuthenticationResultType authenticationResult
The result of the authentication response. This is only returned if the caller doesn't 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 that you want to assign to the external IdP user account. This user can be a native (Username + Password) Amazon Cognito user pools user or a federated user (for example, a SAML or Facebook user). If the user doesn't exist, Amazon Cognito generates an exception. Amazon Cognito returns this user when the new user (with the linked IdP 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.
All attributes in the DestinationUser profile must be mutable. If you have assigned the user any immutable custom attributes, the operation won't succeed.
ProviderUserIdentifierType sourceUser
An external IdP account for a user who doesn't 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 using a federated social IdP, such as Facebook, Google, or Login with Amazon,
you must set the ProviderAttributeName to Cognito_Subject. For social IdPs, the
ProviderName will be Facebook, Google, or LoginWithAmazon,
and Amazon 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 IdP token.
For SAML, the ProviderAttributeName can be any value that matches a claim in the SAML assertion. If
you want to link SAML users based on the subject of the SAML assertion, you should map the subject to a claim
through the SAML IdP and submit that claim name as the ProviderAttributeName. If you set
ProviderAttributeName to Cognito_Subject, Amazon 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.
String username
The user pool username or an alias.
Integer maxResults
The maximum number of authentication events to return. Returns 60 events if you set MaxResults to 0,
or if you don't include a MaxResults parameter.
String nextToken
A pagination token.
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 want 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 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
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.
When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito 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).
PASSWORD_VERIFIER requires DEVICE_KEY when signing in with a remembered device.
ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH (if app
client is configured with client secret).
NEW_PASSWORD_REQUIRED: NEW_PASSWORD, USERNAME, SECRET_HASH
(if app client is configured with client secret). To set any required attributes that Amazon Cognito returned as
requiredAttributes in the AdminInitiateAuth response, add a
userAttributes.attributename parameter. This parameter can also set values for writable
attributes that aren't required by your user pool.
In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already
has a value. In AdminRespondToAuthChallenge, set a value for any keys that Amazon Cognito returned
in the requiredAttributes parameter, then use the AdminUpdateUserAttributes API
operation to modify the value of any additional attributes.
MFA_SETUP requires USERNAME, plus you must use the session value returned by
VerifySoftwareToken in the Session parameter.
The value of the USERNAME attribute must be the user's actual username, not an alias (such as an
email address or phone number). To make this simpler, the AdminInitiateAuth response includes the
actual username value in the USERNAMEUSER_ID_FOR_SRP attribute. This happens even if you specified
an alias in your call to AdminInitiateAuth.
String session
The session that should be passed both ways in challenge-response calls to the service. If an
InitiateAuth or RespondToAuthChallenge API call determines that the caller must pass
another challenge, it returns 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 about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
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 Lambda functions to user pool triggers. When you use the AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions that you have assigned to the following triggers:
pre sign-up
custom message
post authentication
user migration
pre token generation
define auth challenge
create auth challenge
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 that provides the data that you assigned to
the ClientMetadata parameter in your AdminRespondToAuthChallenge request. In your function code in 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.
When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
String challengeName
The name of the challenge. For more information, see AdminInitiateAuth.
String session
The session that should be passed both ways in challenge-response calls to the service. If the caller must pass
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 want 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 whose options you're setting.
String username
The user name of the user whose options you're setting.
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.
If your user pool requires verification before Amazon Cognito updates an attribute value that you specify in this request, Amazon Cognito doesn’t immediately update the value of that attribute. After your user receives and responds to a verification message to verify the new value, Amazon Cognito updates the attribute value. Your user can sign in and receive messages with the original attribute value until they verify the new value.
To update the value of an attribute that requires verification in the same API request, include the
email_verified or phone_number_verified attribute, with a value of true.
If you set the email_verified or phone_number_verified value for an email
or phone_number attribute that requires verification to true, Amazon Cognito doesn’t
send a verification message to your user.
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 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
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.
When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito 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 to integrate with the chosen user pool Client. Amazon Cognito publishes events to the Amazon Pinpoint project that the app ARN declares.
String roleArn
The ARN of an Identity and Access Management 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 includes user data in the events that it
publishes to Amazon Pinpoint analytics.
String analyticsEndpointId
The endpoint ID.
String accessToken
A valid access token that Amazon Cognito issued to the user whose software token you want to generate.
String session
The session that 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 secretCode
A unique generated shared secret code that is used in the TOTP algorithm to generate a one-time code.
String session
The session that 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
A valid access token that Amazon Cognito issued to the user who you want to authenticate.
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. This value 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 destination
The email address or phone number destination where Amazon Cognito sent the code.
String deliveryMedium
The method that Amazon Cognito used to send the code.
String attributeName
The name of the attribute that Amazon Cognito verifies with the code.
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
A valid access token that Amazon Cognito issued to the user whose device you want to confirm.
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 must 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 from your user's request to reset their password. For more information, see ForgotPassword.
String password
The new password that your user wants to set.
AnalyticsMetadataType analyticsMetadata
The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword calls.
UserContextDataType userContextData
Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
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 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
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.
When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito 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 want 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 about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
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 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 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.
When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
String ipAddress
The source IP address of your user's device.
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 device-fingerprint details that your app collected with the Amazon Cognito context data collection library. For more information, see Adding user device and session data to API requests.
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 Amazon Resource Name (ARN) for the group.
Integer precedence
A non-negative 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 is given in the user's tokens for
the cognito:roles and cognito:preferred_role claims.
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 isn't set in users' tokens.
The default Precedence value is null. The maximum Precedence value is
2^31-1.
GroupType group
The group object for the group.
String userPoolId
The user pool ID.
String providerName
The IdP name.
String providerType
The IdP type.
Map<K,V> providerDetails
The IdP details. The following list describes the provider detail keys for each IdP 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 OpenID Connect (OIDC) providers:
client_id
client_secret
attributes_request_method
oidc_issuer
authorize_scopes
The following keys are only present if Amazon Cognito didn't discover them at the oidc_issuer URL.
authorize_url
token_url
attributes_url
jwks_uri
Amazon Cognito sets the value of the following keys automatically. They are read-only.
attributes_url_add_attributes
For SAML providers:
MetadataFile or MetadataURL
IDPSignout optional
Map<K,V> attributeMapping
A mapping of IdP attributes to standard and custom user pool attributes.
List<E> idpIdentifiers
A list of IdP identifiers.
IdentityProviderType identityProvider
The newly created IdP 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, such as 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 a key-value map with the keys 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 refresh token time limit. After this limit expires, your user can't use their refresh token. To specify the
time unit for RefreshTokenValidity as seconds, minutes, hours
, or days, set a TokenValidityUnits value in your API request.
For example, when you set RefreshTokenValidity as 10 and
TokenValidityUnits as days, your user can refresh their session and retrieve new access
and ID tokens for 10 days.
The default time unit for RefreshTokenValidity in an API request is days. You can't set
RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the value with the default value of
30 days. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.
Integer accessTokenValidity
The access token time limit. After this limit expires, your user can't use their access token. To specify the
time unit for AccessTokenValidity as seconds, minutes, hours,
or days, set a TokenValidityUnits value in your API request.
For example, when you set AccessTokenValidity to 10 and TokenValidityUnits
to hours, your user can authorize access with their access token for 10 hours.
The default time unit for AccessTokenValidity in an API request is hours. Valid range is
displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.
Integer idTokenValidity
The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit
for IdTokenValidity as seconds, minutes, hours, or
days, set a TokenValidityUnits value in your API request.
For example, when you set IdTokenValidity as 10 and TokenValidityUnits as
hours, your user can authenticate their session with their ID token for 10 hours.
The default time unit for AccessTokenValidity in an API request is hours. Valid range is
displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
TokenValidityUnitsType tokenValidityUnits
The units in which the validity times are represented. The default unit 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 IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool.
List<E> explicitAuthFlows
The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.
If you don't specify a value for ExplicitAuthFlows, your user client supports
ALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.
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, your app passes a user name and password to Amazon Cognito in the request, instead of
using the Secure Remote Password (SRP) protocol to securely transmit the password.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon 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.
In some environments, you will see the values ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY,
or USER_PASSWORD_AUTH. You can't assign these legacy ExplicitAuthFlows values to user
pool clients at the same time as values that begin with ALLOW_, like
ALLOW_USER_SRP_AUTH.
List<E> supportedIdentityProviders
A list of provider names for the identity providers (IdPs) that are supported on this client. The following are
supported: COGNITO, Facebook, Google, SignInWithApple, and
LoginWithAmazon. You can also specify the names that you configured for the SAML and OIDC IdPs in
your user pool, for example MySAMLIdP or MyOIDCIdP.
List<E> callbackURLs
A list of allowed redirect (callback) URLs for the IdPs.
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 IdPs.
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.
Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for
access tokens with the /oauth2/token endpoint.
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
Issue the access token from the /oauth2/token endpoint directly to a non-person user using a
combination of the client ID 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 Amazon Web Services 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 Amazon Cognito user pools.
AnalyticsConfigurationType analyticsConfiguration
The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
String preventUserExistenceErrors
Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and
password recovery when the user doesn't exist in the user pool. When set to ENABLED and the user
doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account
confirmation and password recovery return a response indicating a code was sent to a simulated destination. When
set to LEGACY, those APIs return a UserNotFoundException exception if the user doesn't
exist in the user pool.
Valid values include:
ENABLED - This prevents user existence-related errors.
LEGACY - This represents the early behavior of Amazon Cognito where user existence related errors
aren't prevented.
Boolean enableTokenRevocation
Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
If you don't include this parameter, token revocation is automatically activated for the new user pool client.
Boolean enablePropagateAdditionalUserContextData
Activates the propagation of additional user context data. For more information about propagation of user context
data, see
Adding advanced security to a user pool. If you don’t include this parameter, you can't send device
fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate
EnablePropagateAdditionalUserContextData in an app client that has a client secret.
Integer authSessionValidity
Amazon Cognito creates a session token for each API request in an authentication flow.
AuthSessionValidity is the duration, in minutes, of that session token. Your user pool native user
must respond to each authentication challenge before the session expires.
UserPoolClientType userPoolClient
The user pool client that was just created.
String domain
The domain string. For custom domains, this is the fully-qualified domain name, such as
auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as
auth.
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.
String deletionProtection
When active, DeletionProtection prevents accidental deletion of your user pool. Before you can
delete a user pool that you have protected against deletion, you must deactivate this feature.
When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns
an InvalidParameterException error. To delete a protected user pool, send a new
DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool
API request.
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 must 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 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 a user can use an email address or phone number as a username when they sign up.
String smsVerificationMessage
This parameter is no longer used. See VerificationMessageTemplateType.
String emailVerificationMessage
This parameter is no longer used. See VerificationMessageTemplateType.
String emailVerificationSubject
This parameter is no longer used. See VerificationMessageTemplateType.
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.
UserAttributeUpdateSettingsType userAttributeUpdateSettings
The settings for updates to user attributes. These settings include the property
AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to
handle changes to the value of your users' email address and phone number attributes. For more information, see
Verifying updates to email addresses and phone numbers.
DeviceConfigurationType deviceConfiguration
The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.
When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito
device-remembering feature.
EmailConfigurationType emailConfiguration
The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.
SmsConfigurationType smsConfiguration
The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
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
Enables advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".
UsernameConfigurationType usernameConfiguration
Case sensitivity on the username input for the selected sign-in option. For example, when case sensitivity is set
to False, users can sign in using either "username" or "Username". This configuration is immutable
once it has been set. For more information, see UsernameConfigurationType.
AccountRecoverySettingType accountRecoverySetting
The available verified method a user can use to recover their password when they call ForgotPassword
. You can use this setting to define a preferred method when a user has more than one method available. With this
setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor
authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to
determine the recovery method where SMS is preferred through email.
UserPoolType userPool
A container for the user pool details.
String certificateArn
The Amazon Resource Name (ARN) of an Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain.
String lambdaVersion
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 Amazon Resource Name (ARN) of the Lambda function that Amazon Cognito activates to send email notifications to users.
String lambdaVersion
Signature of the "request" attribute in the "event" information that Amazon Cognito passes to your custom SMS
Lambda function. The only supported value is V1_0.
String lambdaArn
The Amazon Resource Name (ARN) of the Lambda function that Amazon Cognito activates to send SMS notifications to users.
List<E> userAttributeNames
An array of strings representing the user attribute names you want to delete.
For custom attributes, you must prependattach the custom: prefix to the front of the attribute name.
String accessToken
A valid access token that Amazon Cognito issued to the user whose attributes you want to delete.
String userPoolId
The user pool ID for the user pool you want to delete.
String accessToken
A valid access token that Amazon Cognito issued to the user whose user profile you want to delete.
IdentityProviderType identityProvider
The identity provider details.
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. For custom domains, this is the fully-qualified domain name, such as
auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as
auth.
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.
Boolean challengeRequiredOnNewDevice
When true, a remembered device can sign in with device authentication instead of SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).
Whether or not ChallengeRequiredOnNewDevice is true, users who sign in with devices that have not
been confirmed or remembered must still provide a second factor in a user pool that requires MFA.
Boolean deviceOnlyRememberedOnUserPrompt
When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a ConfirmDevice API request. In your app, create a prompt for your user to choose whether they want to remember their device. Return the user's choice in an UpdateDeviceStatus API request.
When DeviceOnlyRememberedOnUserPrompt is false, Amazon Cognito immediately remembers
devices that you register in a ConfirmDevice API request.
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 when the device was last authenticated.
String userPoolId
The user pool ID.
String aWSAccountId
The Amazon Web Services ID for the user pool owner.
String domain
The domain string. For custom domains, this is the fully-qualified domain name, such as
auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as
auth.
String s3Bucket
The Amazon S3 bucket where the static files for this domain are stored.
String cloudFrontDistribution
The Amazon Resource Name (ARN) of the Amazon 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 ARN of a verified email address in Amazon SES. Amazon Cognito uses this email address 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 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.
The Region value of the SourceArn parameter must indicate a supported Amazon Web Services Region of
your user pool. Typically, the Region in the SourceArn and the user pool Region are the same. For
more information, see Amazon SES email configuration regions in the Amazon Cognito
Developer Guide.
String replyToEmailAddress
The destination to which the receiver of the email should reply.
String emailSendingAccount
Specifies whether Amazon Cognito uses its built-in functionality to send your users email messages, or uses your Amazon Simple Email Service 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 less than 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 the Amazon Cognito Developer Guide.
The default FROM address is [email protected]. To customize the FROM address, provide
the Amazon Resource Name (ARN) of an Amazon SES verified email address for the SourceArn parameter.
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 Amazon Web Services account.
If you use this option, 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 role in your Amazon Web Services account. This role contains the permissions that allow you to access Amazon SES and send email messages from your email 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
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 appears
before the body of the email.
String configurationSet
The set of configuration rules that can be applied to emails sent using Amazon Simple Email Service. 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:
Amazon Simple Email Service 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 Amazon Web Services services such as and Amazon CloudWatch
When leasing dedicated IP addresses with Amazon Simple Email Service, 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 about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
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 that contributes to your 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 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 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.
When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito 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 details.
String userPoolId
The user pool ID.
String certificate
The signing certificate.
UICustomizationType uICustomization
The UI customization information.
String accessToken
A non-expired access token for the user whose attribute verification code you want to generate.
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 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 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.
When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito 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 authentication (MFA) configuration.
SoftwareTokenMfaConfigType softwareTokenMfaConfiguration
The software token multi-factor authentication (MFA) configuration.
String mfaConfiguration
The multi-factor authentication (MFA) configuration. Valid values include:
OFF MFA won't 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 activated.
String accessToken
A non-expired access token for the user whose information you want to query.
String username
The user name of the user you want 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 time-based one-time password (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 activated for the user. The possible values in this list are SMS_MFA and
SOFTWARE_TOKEN_MFA.
String accessToken
A valid access token that Amazon Cognito issued to the user who you want to sign out.
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 Amazon Resource Name (ARN) for the group.
Integer precedence
A non-negative 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 ornull Precedence values. If a user belongs to two or
more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for
the cognito:roles and cognito:preferred_role claims.
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 isn't 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 IdP name.
String providerType
The IdP type.
Map<K,V> providerDetails
The IdP details. The following list describes the provider detail keys for each IdP 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
You can submit a private_key when you add or update an IdP. Describe operations don't return the private key.
authorize_scopes
For OIDC providers:
client_id
client_secret
attributes_request_method
oidc_issuer
authorize_scopes
The following keys are only present if Amazon Cognito didn't discover them at the oidc_issuer URL.
authorize_url
token_url
attributes_url
jwks_uri
Amazon Cognito sets the value of the following keys automatically. They are read-only.
attributes_url_add_attributes
For SAML providers:
MetadataFile or MetadataURL
IDPSignout optional
Map<K,V> attributeMapping
A mapping of IdP attributes to standard and custom user pool attributes.
List<E> idpIdentifiers
A list of IdP identifiers.
Date lastModifiedDate
The date the IdP was last modified.
Date creationDate
The date the IdP was created.
String authFlow
The authentication flow for this call to run. The API action will depend on this value. For example:
REFRESH_TOKEN_AUTH takes in a valid refresh token and returns new tokens.
USER_SRP_AUTH takes in USERNAME and SRP_A and returns the SRP variables to
be used for next challenge execution.
USER_PASSWORD_AUTH takes in USERNAME and PASSWORD and returns 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; user name and password are passed directly. If a
user migration Lambda trigger is set, this flow will invoke the user migration Lambda if it doesn't find the user
name in the user pool.
ADMIN_NO_SRP_AUTH isn't a valid value.
Map<K,V> authParameters
The authentication parameters. These are inputs corresponding to the AuthFlow that you're 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 Lambda functions to user pool triggers. When you use the InitiateAuth API action, Amazon Cognito invokes the 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 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 doesn't 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.
When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
String clientId
The app client ID.
AnalyticsMetadataType analyticsMetadata
The Amazon Pinpoint analytics metadata that contributes to your metrics for InitiateAuth calls.
UserContextDataType userContextData
Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
String challengeName
The name of the challenge that you're responding to with this call. This name is returned in the
AdminInitiateAuth response if you must pass another challenge.
Valid values include the following:
All of the following 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 activated 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 who are required to change their passwords after successful first
login.
Respond to this challenge with NEW_PASSWORD and any required attributes that Amazon Cognito returned
in the requiredAttributes parameter. You can also set values for attributes that aren't required by
your user pool and that your app client can write. For more information, see RespondToAuthChallenge.
In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already
has a value. In RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the
requiredAttributes parameter, then use the UpdateUserAttributes API operation to modify
the value of any additional attributes.
MFA_SETUP: For users who are required to setup an MFA factor before they can sign in. The MFA types
activated for the user pool will be listed in the challenge parameters MFA_CAN_SETUP value.
To set up software token MFA, use the session returned here from InitiateAuth as an input to
AssociateSoftwareToken. Use the session returned by VerifySoftwareToken as an input to
RespondToAuthChallenge with challenge name MFA_SETUP to complete sign-in. To set up SMS
MFA, an administrator should help the user to add a phone number to their account, and then the user should call
InitiateAuth again to restart sign-in.
String session
The session that should pass both ways in challenge-response calls to the service. If the caller must pass
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 in the InitiateAuth response if you must 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 result is only returned if the caller doesn't 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 Lambda trigger.
String customMessage
A custom Message Lambda trigger.
String postConfirmation
A post-confirmation Lambda trigger.
String preAuthentication
A pre-authentication Lambda trigger.
String postAuthentication
A post-authentication 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 Lambda trigger.
CustomEmailLambdaVersionConfigType customEmailSender
A custom email sender Lambda trigger.
String kMSKeyID
The Amazon Resource Name (ARN) of an KMS key.
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 aren't searchable.
You can also list users with a client-side filter. The server-side filter matches no more than one attribute. For
an advanced search, use a client-side filter with the --query parameter of the
list-users action in the CLI. When you use a client-side filter, ListUsers returns a paginated list
of zero or more users. You can receive multiple pages in a row with zero results. Repeat the query with each
pagination token that is returned until you receive a null pagination token value, and then review the combined
result.
For more information about server-side and client-side filtering, see FilteringCLI output in the Command Line Interface User Guide.
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. The address must be either individually verified with Amazon Simple Email Service, 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. This
identity 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 multi-factor authentication (MFA) email template used when MFA is challenged as part of a detected risk.
Integer minimumLength
The minimum length of the password in the policy that you have set. This value can't 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
The number of days a temporary password is valid in the password policy. If the user doesn't sign in during this time, an administrator must reset their password.
When you set TemporaryPasswordValidityDays for a user pool, you can no longer set a value for the
legacy UnusedAccountValidityDays parameter in that user pool.
String providerName
The name of the provider, such as Facebook, Google, or Login with Amazon.
String providerAttributeName
The name of the provider attribute to link to, such as NameID.
String providerAttributeValue
The value of the provider attribute to link to, such as 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 about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
String username
The username attribute of the user to whom you want to resend a confirmation code.
AnalyticsMetadataType analyticsMetadata
The Amazon Pinpoint analytics metadata that contributes to your 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 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
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.
When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito 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 isn't a valid value.
String session
The session that should be passed both ways in challenge-response calls to the service. If
InitiateAuth or RespondToAuthChallenge API call determines that the caller must pass
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 of the inputs that
follow (including SOFTWARE_TOKEN_MFA).
SMS_MFA: SMS_MFA_CODE, USERNAME.
PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK,
TIMESTAMP, USERNAME.
PASSWORD_VERIFIER requires DEVICE_KEY when you sign in with a remembered device.
NEW_PASSWORD_REQUIRED: NEW_PASSWORD, USERNAME, SECRET_HASH
(if app client is configured with client secret). To set any required attributes that Amazon Cognito returned as
requiredAttributes in the InitiateAuth response, add a
userAttributes.attributename parameter. This parameter can also set values for writable
attributes that aren't required by your user pool.
In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already
has a value. In RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the
requiredAttributes parameter, then use the UpdateUserAttributes API operation to modify
the value of any additional attributes.
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.
MFA_SETUP requires USERNAME, plus you must use the session value returned by
VerifySoftwareToken in the Session parameter.
AnalyticsMetadataType analyticsMetadata
The Amazon Pinpoint analytics metadata that contributes to your metrics for RespondToAuthChallenge
calls.
UserContextDataType userContextData
Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
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 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 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.
When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
String challengeName
The challenge name. For more information, see InitiateAuth.
String session
The session that should be passed both ways in challenge-response calls to the service. If the caller must pass
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 if there is 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 routing prefix.
List<E> skippedIPRangeList
Risk detection isn't performed on the IP addresses in this 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
You should 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 won't be able to modify this attribute using their access token. For example,
DeveloperOnlyAttribute can be modified using AdminUpdateUserAttributes but can't be updated using
UpdateUserAttributes.
Boolean mutable
Specifies whether the value of the attribute can be changed.
For any user pool attribute that is mapped to an IdP attribute, you must set this parameter to true.
Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. 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 doesn't 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 isn't 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 (TOTP) software token MFA settings.
String accessToken
A valid access token that Amazon Cognito issued to the user whose MFA preference you want to set.
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. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor Authentication (MFA) to a user pool. Valid values include:
OFF MFA won't 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 activated.
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 won't 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 want to register.
String password
The password of the user you want 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 that contributes to your metrics for SignUp calls.
UserContextDataType userContextData
Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
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 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 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.
When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito 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 isn't the same as username.
String snsCallerArn
The Amazon Resource Name (ARN) of the Amazon SNS caller. This is the ARN of the IAM role in your Amazon Web Services account that Amazon Cognito will use to send SMS messages. SMS messages are subject to a spending limit.
String externalId
The external ID provides additional security for your IAM role. You can use an ExternalId with the
IAM role that you use with Amazon SNS to send SMS messages for your user pool. If you provide an
ExternalId, your Amazon Cognito user pool includes it in the request to assume your IAM role. You
can configure the role trust policy to require that Amazon Cognito, and any principal, provide the
ExternalID. If you use the Amazon Cognito Management Console to create a role for SMS multi-factor
authentication (MFA), Amazon Cognito creates a role with the required permissions and a trust policy that
demonstrates use of the ExternalId.
For more information about the ExternalId of a role, see How to use an
external ID when granting access to your Amazon Web Services resources to a third party
String snsRegion
The Amazon Web Services Region to use with Amazon SNS integration. You can choose the same Region as your user pool, or a supported Legacy Amazon SNS alternate Region.
Amazon Cognito resources in the Asia Pacific (Seoul) Amazon Web Services Region must use your Amazon SNS configuration in the Asia Pacific (Tokyo) Region. For more information, see SMS message settings for Amazon Cognito user pools.
String smsAuthenticationMessage
The SMS authentication message that will be sent to users with the code they must sign in. The message must contain the ‘{####}’ placeholder, which is replaced with the code. If the message isn't included, and default message will be used.
SmsConfigurationType smsConfiguration
The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To request Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role that you provide for your Amazon Web Services account.
Boolean enabled
Specifies whether SMS text message MFA is activated. If an MFA type is activated 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 activated.
Boolean enabled
Specifies whether software token MFA is activated. If an MFA type is activated 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 of seconds, minutes, hours, or days for the value
that you set in the AccessTokenValidity parameter. The default AccessTokenValidity time
unit is hours.
String idToken
A time unit of seconds, minutes, hours, or days for the value
that you set in the IdTokenValidity parameter. The default IdTokenValidity time unit is
hours.
String refreshToken
A time unit of seconds, minutes, hours, or days for the value
that you set in the RefreshTokenValidity parameter. The default RefreshTokenValidity
time unit is 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 Amazon Resource Name (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 IdP name.
Map<K,V> providerDetails
The IdP details to be updated, such as MetadataURL and MetadataFile.
Map<K,V> attributeMapping
The IdP attribute mapping to be changed.
List<E> idpIdentifiers
A list of IdP identifiers.
IdentityProviderType identityProvider
The identity provider details.
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.
If you have set an attribute to require verification before Amazon Cognito updates its value, this request doesn’t immediately update the value of that attribute. After your user receives and responds to a verification message to verify the new value, Amazon Cognito updates the attribute value. Your user can sign in and receive messages with the original attribute value until they verify the new value.
String accessToken
A valid access token that Amazon Cognito issued to the user whose user attributes you want to update.
Map<K,V> clientMetadata
A map of custom key-value pairs that you can provide as input for any custom workflows that this action initiates.
You create custom workflows by assigning 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
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.
When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito 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 refresh token time limit. After this limit expires, your user can't use their refresh token. To specify the
time unit for RefreshTokenValidity as seconds, minutes, hours
, or days, set a TokenValidityUnits value in your API request.
For example, when you set RefreshTokenValidity as 10 and
TokenValidityUnits as days, your user can refresh their session and retrieve new access
and ID tokens for 10 days.
The default time unit for RefreshTokenValidity in an API request is days. You can't set
RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the value with the default value of
30 days. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.
Integer accessTokenValidity
The access token time limit. After this limit expires, your user can't use their access token. To specify the
time unit for AccessTokenValidity as seconds, minutes, hours,
or days, set a TokenValidityUnits value in your API request.
For example, when you set AccessTokenValidity to 10 and TokenValidityUnits
to hours, your user can authorize access with their access token for 10 hours.
The default time unit for AccessTokenValidity in an API request is hours. Valid range is
displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.
Integer idTokenValidity
The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit
for IdTokenValidity as seconds, minutes, hours, or
days, set a TokenValidityUnits value in your API request.
For example, when you set IdTokenValidity as 10 and TokenValidityUnits as
hours, your user can authenticate their session with their ID token for 10 hours.
The default time unit for AccessTokenValidity in an API request is hours. Valid range is
displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
TokenValidityUnitsType tokenValidityUnits
The units in which the validity times are represented. The default unit for RefreshToken is days, and the default for ID and access tokens is 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 you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.
If you don't specify a value for ExplicitAuthFlows, your user client supports
ALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.
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, your app passes a user name and password to Amazon Cognito in the request, instead of
using the Secure Remote Password (SRP) protocol to securely transmit the password.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon 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.
In some environments, you will see the values ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY,
or USER_PASSWORD_AUTH. You can't assign these legacy ExplicitAuthFlows values to user
pool clients at the same time as values that begin with ALLOW_, like
ALLOW_USER_SRP_AUTH.
List<E> supportedIdentityProviders
A list of provider names for the IdPs that this client supports. The following are supported:
COGNITO, Facebook, Google, SignInWithApple,
LoginWithAmazon, and the names of your own SAML and OIDC providers.
List<E> callbackURLs
A list of allowed redirect (callback) URLs for the IdPs.
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 IdPs.
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.
Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for
access tokens with the /oauth2/token endpoint.
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
Issue the access token from the /oauth2/token endpoint directly to a non-person user using a
combination of the client ID 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 Amazon Web Services 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 Amazon Cognito user pools.
AnalyticsConfigurationType analyticsConfiguration
The Amazon Pinpoint analytics configuration necessary to collect metrics for this user pool.
In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
String preventUserExistenceErrors
Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and
password recovery when the user doesn't exist in the user pool. When set to ENABLED and the user
doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account
confirmation and password recovery return a response indicating a code was sent to a simulated destination. When
set to LEGACY, those APIs return a UserNotFoundException exception if the user doesn't
exist in the user pool.
Valid values include:
ENABLED - This prevents user existence-related errors.
LEGACY - This represents the early behavior of Amazon Cognito where user existence related errors
aren't prevented.
Boolean enableTokenRevocation
Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
Boolean enablePropagateAdditionalUserContextData
Activates the propagation of additional user context data. For more information about propagation of user context
data, see
Adding advanced security to a user pool. If you don’t include this parameter, you can't send device
fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate
EnablePropagateAdditionalUserContextData in an app client that has a client secret.
Integer authSessionValidity
Amazon Cognito creates a session token for each API request in an authentication flow.
AuthSessionValidity is the duration, in minutes, of that session token. Your user pool native user
must respond to each authentication challenge before the session expires.
UserPoolClientType userPoolClient
The user pool client value from the response from the server when you request to update the user pool client.
String domain
The domain name for the custom domain that hosts the sign-up and sign-in pages for your application. One example
might be auth.example.com.
This string can include only lowercase letters, numbers, and hyphens. Don't 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 whose certificate you're updating.
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 want to update in a user pool.
String deletionProtection
When active, DeletionProtection prevents accidental deletion of your user pool. Before you can
delete a user pool that you have protected against deletion, you must deactivate this feature.
When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns
an InvalidParameterException error. To delete a protected user pool, send a new
DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool
API request.
LambdaConfigType lambdaConfig
The Lambda configuration information from the request to update the user pool.
List<E> autoVerifiedAttributes
The attributes that are automatically verified when Amazon Cognito requests to update user pools.
String smsVerificationMessage
This parameter is no longer used. See VerificationMessageTemplateType.
String emailVerificationMessage
This parameter is no longer used. See VerificationMessageTemplateType.
String emailVerificationSubject
This parameter is no longer used. See VerificationMessageTemplateType.
VerificationMessageTemplateType verificationMessageTemplate
The template for verification messages.
String smsAuthenticationMessage
The contents of the SMS authentication message.
UserAttributeUpdateSettingsType userAttributeUpdateSettings
The settings for updates to user attributes. These settings include the property
AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to
handle changes to the value of your users' email address and phone number attributes. For more information, see
Verifying updates to email addresses and phone numbers.
String mfaConfiguration
Possible values include:
OFF - MFA tokens aren't required and can't be specified during user registration.
ON - MFA tokens are required for all user registrations. You can only specify ON when you're
initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools.
OPTIONAL - Users have the option when registering to create an MFA token.
DeviceConfigurationType deviceConfiguration
The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.
When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito
device-remembering feature.
EmailConfigurationType emailConfiguration
The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for email invitation and verification messages from your user pool.
SmsConfigurationType smsConfiguration
The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
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
Enables advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".
AccountRecoverySettingType accountRecoverySetting
The available verified method a user can use to recover their password when they call ForgotPassword
. You can use this setting to define a preferred method when a user has more than one method available. With this
setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor
authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to
determine the recovery method where SMS is preferred through email.
List<E> attributesRequireVerificationBeforeUpdate
Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute. When you update a user attribute that has this option activated, Amazon Cognito sends a verification message to the new phone number or email address. Amazon Cognito doesn’t change the value of the attribute until your user responds to the verification message and confirms the new value.
You can verify an updated email address or phone number with a VerifyUserAttribute API request. You can also call the UpdateUserAttributes or AdminUpdateUserAttributes API and set email_verified or phone_number_verified to
true.
When AttributesRequireVerificationBeforeUpdate is false, your user pool doesn't require that your
users verify attribute changes before Amazon Cognito updates them. In a user pool where
AttributesRequireVerificationBeforeUpdate is false, API operations that change attribute values can
immediately update a user’s email or phone_number attribute.
String ipAddress
The source IP address of your user's device.
String encodedData
Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library. For more information, see Adding user device and session data to API requests.
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 can't be started.
String cloudWatchLogsRoleArn
The role Amazon Resource Name (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 couldn't be imported.
String completionMessage
The message returned when the user import job is completed.
Boolean caseSensitive
Specifies whether user name case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs.
Valid values include:
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, such as “UserName”. This is the default value.
Enables case insensitivity for all username input. For example, when this option is set to False,
users can 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 refresh token time limit. After this limit expires, your user can't use their refresh token. To specify the
time unit for RefreshTokenValidity as seconds, minutes, hours
, or days, set a TokenValidityUnits value in your API request.
For example, when you set RefreshTokenValidity as 10 and
TokenValidityUnits as days, your user can refresh their session and retrieve new access
and ID tokens for 10 days.
The default time unit for RefreshTokenValidity in an API request is days. You can't set
RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the value with the default value of
30 days. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.
Integer accessTokenValidity
The access token time limit. After this limit expires, your user can't use their access token. To specify the
time unit for AccessTokenValidity as seconds, minutes, hours,
or days, set a TokenValidityUnits value in your API request.
For example, when you set AccessTokenValidity to 10 and TokenValidityUnits
to hours, your user can authorize access with their access token for 10 hours.
The default time unit for AccessTokenValidity in an API request is hours. Valid range is
displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.
Integer idTokenValidity
The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit
for IdTokenValidity as seconds, minutes, hours, or
days, set a TokenValidityUnits value in your API request.
For example, when you set IdTokenValidity as 10 and TokenValidityUnits as
hours, your user can authenticate their session with their ID token for 10 hours.
The default time unit for AccessTokenValidity in an API request is hours. Valid range is
displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
TokenValidityUnitsType tokenValidityUnits
The time units used to specify the token validity times of each token type: ID, access, and refresh.
List<E> readAttributes
The Read-only attributes.
List<E> writeAttributes
The writeable attributes.
List<E> explicitAuthFlows
The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.
If you don't specify a value for ExplicitAuthFlows, your user client supports
ALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.
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, your app passes a user name and password to Amazon Cognito in the request, instead of
using the Secure Remote Password (SRP) protocol to securely transmit the password.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon 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.
In some environments, you will see the values ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY,
or USER_PASSWORD_AUTH. You can't assign these legacy ExplicitAuthFlows values to user
pool clients at the same time as values that begin with ALLOW_, like
ALLOW_USER_SRP_AUTH.
List<E> supportedIdentityProviders
A list of provider names for the IdPs that this client supports. The following are supported:
COGNITO, Facebook, Google, SignInWithApple,
LoginWithAmazon, and the names of your own SAML and OIDC providers.
List<E> callbackURLs
A list of allowed redirect (callback) URLs for the IdPs.
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 IdPs.
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.
Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for
access tokens with the /oauth2/token endpoint.
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
Issue the access token from the /oauth2/token endpoint directly to a non-person user using a
combination of the client ID and client secret.
List<E> allowedOAuthScopes
The OAuth scopes that your app client supports. Possible values that OAuth provides are phone,
email, openid, and profile. Possible values that Amazon Web Services
provides are aws.cognito.signin.user.admin. Amazon Cognito also supports custom scopes that you
create in Resource Servers.
Boolean allowedOAuthFlowsUserPoolClient
Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
AnalyticsConfigurationType analyticsConfiguration
The Amazon Pinpoint analytics configuration for the user pool client.
Amazon Cognito user pools only support sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the Region where the user pool resides.
String preventUserExistenceErrors
Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and
password recovery when the user doesn't exist in the user pool. When set to ENABLED and the user
doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account
confirmation and password recovery return a response indicating a code was sent to a simulated destination. When
set to LEGACY, those APIs return a UserNotFoundException exception if the user doesn't
exist in the user pool.
Valid values include:
ENABLED - This prevents user existence-related errors.
LEGACY - This represents the old behavior of Amazon Cognito where user existence related errors
aren't prevented.
Boolean enableTokenRevocation
Indicates whether token revocation is activated for the user pool client. When you create a new user pool client, token revocation is activated by default. For more information about revoking tokens, see RevokeToken.
Boolean enablePropagateAdditionalUserContextData
When EnablePropagateAdditionalUserContextData is true, Amazon Cognito accepts an
IpAddress value that you send in the UserContextData parameter. The
UserContextData parameter sends information to Amazon Cognito advanced security for risk analysis.
You can send UserContextData when you sign in Amazon Cognito native users with the
InitiateAuth and RespondToAuthChallenge API operations.
When EnablePropagateAdditionalUserContextData is false, you can't send your user's source IP address
to Amazon Cognito advanced security with unauthenticated API operations.
EnablePropagateAdditionalUserContextData doesn't affect whether you can send a source IP address in
a ContextData parameter with the authenticated API operations AdminInitiateAuth and
AdminRespondToAuthChallenge.
You can only activate EnablePropagateAdditionalUserContextData in an app client that has a client
secret. For more information about propagation of user context data, see Adding user device and session data to API requests.
Integer authSessionValidity
Amazon Cognito creates a session token for each API request in an authentication flow.
AuthSessionValidity is the duration, in minutes, of that session token. Your user pool native user
must respond to each authentication challenge before the session expires.
String id
The ID in a user pool description.
String name
The name in a user pool description.
LambdaConfigType lambdaConfig
The 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.
String deletionProtection
When active, DeletionProtection prevents accidental deletion of your user pool. Before you can
delete a user pool that you have protected against deletion, you must deactivate this feature.
When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns
an InvalidParameterException error. To delete a protected user pool, send a new
DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool
API request.
LambdaConfigType lambdaConfig
The 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
The attributes that are auto-verified in a user pool.
List<E> aliasAttributes
The attributes that are aliased in a user pool.
List<E> usernameAttributes
Specifies whether a user can use an email address or phone number as a username when they sign up.
String smsVerificationMessage
This parameter is no longer used. See VerificationMessageTemplateType.
String emailVerificationMessage
This parameter is no longer used. See VerificationMessageTemplateType.
String emailVerificationSubject
This parameter is no longer used. See VerificationMessageTemplateType.
VerificationMessageTemplateType verificationMessageTemplate
The template for verification messages.
String smsAuthenticationMessage
The contents of the SMS authentication message.
UserAttributeUpdateSettingsType userAttributeUpdateSettings
The settings for updates to user attributes. These settings include the property
AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to
handle changes to the value of your users' email address and phone number attributes. For more information, see
Verifying updates to email addresses and phone numbers.
String mfaConfiguration
Can be one of the following values:
OFF - MFA tokens aren't required and can't be specified during user registration.
ON - MFA tokens are required for all user registrations. You can only specify required when you're
initially creating a user pool.
OPTIONAL - Users have the option when registering to create an MFA token.
DeviceConfigurationType deviceConfiguration
The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.
When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito
device-remembering feature.
Integer estimatedNumberOfUsers
A number estimating the size of the user pool.
EmailConfigurationType emailConfiguration
The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages tfrom your user pool.
SmsConfigurationType smsConfiguration
The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
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 can't send the messages to your users.
This message might include comma-separated values to describe why your SMS configuration can't send messages to user pool end users.
The Identity and Access Management role that Amazon Cognito uses to send SMS messages isn't properly configured. For more information, see SmsConfigurationType.
The Amazon Web Services account is in the SNS SMS Sandbox and messages will only reach verified end users. This parameter won’t get populated with SNSSandbox if the IAM user creating the user pool doesn’t have SNS permissions. To learn how to move your Amazon Web Services account out of the sandbox, see Moving out of the SMS sandbox.
String emailConfigurationFailure
Deprecated. Review error codes from API requests with EventSource:cognito-idp.amazonaws.com in
CloudTrail for information about problems with user pool email configuration.
String domain
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. An example of a custom domain name might be
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
Case sensitivity of the username input for the selected sign-in option. For example, when case sensitivity is set
to False, users can 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
The available verified method a user can use to recover their password when they call ForgotPassword
. You can use this setting to define a preferred method when a user has more than one method available. With this
setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor
authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to
determine the recovery method where SMS is preferred through email.
String username
The user name of the user you want 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. This can be one of the following:
UNCONFIRMED - User has been created but not confirmed.
CONFIRMED - User has been confirmed.
EXTERNAL_PROVIDER - User signed in with a third-party IdP.
ARCHIVED - User is no longer active.
UNKNOWN - User status isn't known.
RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they 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 their password to a new value before doing anything else.
List<E> mFAOptions
The MFA options for the user.
String smsMessage
The template for SMS messages that Amazon Cognito sends to your users.
String emailMessage
The template for email messages that Amazon Cognito sends to your users. You can set an EmailMessage
template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES
configuration.
String emailSubject
The subject line for the email message template. You can set an EmailSubject template only if the
value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES
configuration.
String emailMessageByLink
The email message template for sending a confirmation link to the user. You can set an
EmailMessageByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES
configuration.
String emailSubjectByLink
The subject line for the email message template for sending a confirmation link to the user. You can set an
EmailSubjectByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES
configuration.
String defaultEmailOption
The default email option.
String accessToken
A valid access token that Amazon Cognito issued to the user whose software token you want to verify.
String session
The session that 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.
String accessToken
A valid access token that Amazon Cognito issued to the user whose user attributes you want to verify.
String attributeName
The attribute name in the request to verify user attributes.
String code
The verification code in the request to verify user attributes.
Copyright © 2023. All rights reserved.