The user pool ID for the user pool you want to delete.

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.

The template for verification messages.

The contents of the email verification message.

The contents of the SMS authentication message.

Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".

The subject of the email verification message.

Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.

Email configuration.

A container with information about the SMS verification message.

Can be one of the following values:

• OFF - MFA tokens are not required and cannot be specified during user registration.
• ON - MFA tokens are required for all user registrations. You can only specify ON when you are 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.

The Lambda configuration information from the request to update the user pool.

SMS configuration.

The configuration for AdminCreateUser requests.

Device configuration.

The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.

A container with the policies you wish to update in a user pool.

The user pool ID for the user pool you want to update.

The response's http status code.

The domain name for the custom domain that hosts the sign-up and sign-in pages for your application. For example: auth.example.com.

This string can include only lowercase letters, numbers, and hyphens. Do not use a hyphen for the first or last character. Use periods to separate subdomain names.

The ID of the user pool that is associated with the custom domain that you are updating the certificate for.

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.

The Amazon CloudFront endpoint that Amazon Cognito set up when you added the custom domain to your user pool.

The response's http status code.

The domain string.

The user pool ID.

The response's http status code.

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 does not provide the ClientMetadata value as input:

• Post authentication
• Custom message
• Pre token generation
• Create auth challenge
• Define auth challenge
• Verify auth challenge

For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

Take the following limitations into consideration when you use the ClientMetadata parameter:

• Amazon Cognito does not store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
• Amazon Cognito does not validate the ClientMetadata value.
• Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

The analytics metadata for collecting Amazon Pinpoint metrics for AdminInitiateAuth calls.

The authentication parameters. These are inputs corresponding to the AuthFlow that you are invoking. The required values depend on the value of AuthFlow:

• For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY.
• For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY.
• For ADMIN_NO_SRP_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), PASSWORD (required), DEVICE_KEY.
• For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY. To start the authentication flow with password verification, include ChallengeName: SRP_A and SRP_A: (The SRP_A Value).

The ID of the Amazon Cognito user pool.

The app client ID.

The authentication flow for this call to execute. The API action will depend on this value. For example:

• REFRESH_TOKEN_AUTH will take in a valid refresh token and return new tokens.
• USER_SRP_AUTH will take in USERNAME and SRP_A and return the SRP variables to be used for next challenge execution.
• USER_PASSWORD_AUTH will take in USERNAME and PASSWORD and return the next challenge or tokens.

Valid values include:

• USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.
• REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.
• CUSTOM_AUTH: Custom authentication flow.
• ADMIN_NO_SRP_AUTH: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client.
• USER_PASSWORD_AUTH: Non-SRP authentication flow; USERNAME and PASSWORD are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if the USERNAME is not found in the user pool.
• ADMIN_USER_PASSWORD_AUTH: Admin-based user password authentication. This replaces the ADMIN_NO_SRP_AUTH authentication flow. In this flow, Cognito receives the password in the request instead of using the SRP process to verify passwords.

The name of the challenge which you are responding to with this call. This is returned to you in the AdminInitiateAuth response if you need to pass another challenge.

• MFA_SETUP: If MFA is required, users who do not have at least one of the MFA methods set up are presented with an MFA_SETUP challenge. The user must set up at least one MFA type to continue to authenticate.
• SELECT_MFA_TYPE: Selects the MFA type. Valid MFA options are SMS_MFA for text SMS MFA, and SOFTWARE_TOKEN_MFA for TOTP software token MFA.
• SMS_MFA: Next challenge is to supply an SMS_MFA_CODE, delivered via SMS.
• PASSWORD_VERIFIER: Next challenge is to supply PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after the client-side SRP calculations.
• CUSTOM_CHALLENGE: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued.
• DEVICE_SRP_AUTH: If device tracking was enabled on your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device.
• DEVICE_PASSWORD_VERIFIER: Similar to PASSWORD_VERIFIER, but for devices only.
• ADMIN_NO_SRP_AUTH: This is returned if you need to authenticate with USERNAME and PASSWORD directly. An app client must be enabled to use this flow.
• NEW_PASSWORD_REQUIRED: For users who are required to change their passwords after successful first login. This challenge should be passed with NEW_PASSWORD and any other required attributes.

• MFA_SETUP: For users who are required to setup an MFA factor before they can sign-in. The MFA types enabled for the user pool will be listed in the challenge parameters MFA_CAN_SETUP value.

  To setup 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 setup 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.

The challenge parameters. These are returned to you in the AdminInitiateAuth response if you need to pass another challenge. The responses in this parameter should be used to compute inputs to the next call (AdminRespondToAuthChallenge).

All challenges require USERNAME and SECRET_HASH (if applicable).

The value of the USER_ID_FOR_SRP attribute will be the user's actual username, not an alias (such as email address or phone number), even if you specified an alias in your call to AdminInitiateAuth. This is because, in the AdminRespondToAuthChallenge API ChallengeResponses, the USERNAME attribute cannot be an alias.

The result of the authentication response. This is only returned if the caller does not need to pass another challenge. If the caller does need to pass another challenge before it gets tokens, ChallengeName, ChallengeParameters, and Session are returned.

The session which should be passed both ways in challenge-response calls to the service. If AdminInitiateAuth or AdminRespondToAuthChallenge API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next AdminRespondToAuthChallenge API call.

The response's http status code.

The user pool ID for the user pool.

The existing user in the user pool to be linked to the external identity provider user account. Can be a native (Username + Password) Cognito User Pools user or a federated user (for example, a SAML or Facebook user). If the user doesn't exist, an exception is thrown. This is the user that is returned when the new user (with the linked identity provider attribute) signs in.

For a native username + password user, the ProviderAttributeValue for the DestinationUser should be the username in the user pool. For a federated user, it should be the provider-specific user_id.

The ProviderAttributeName of the DestinationUser is ignored.

The ProviderName should be set to Cognito for users in Cognito user pools.

An external identity provider account for a user who does not currently exist yet in the user pool. This user must be a federated user (for example, a SAML or Facebook user), not another native user.

If the SourceUser is a federated social identity provider user (Facebook, Google, or Login with Amazon), you must set the ProviderAttributeName to Cognito_Subject. For social identity providers, the ProviderName will be Facebook, Google, or LoginWithAmazon, and Cognito will automatically parse the Facebook, Google, and Login with Amazon tokens for id, sub, and user_id, respectively. The ProviderAttributeValue for the user must be the same value as the id, sub, or user_id value found in the social identity provider token.

For SAML, the ProviderAttributeName can be any value that matches a claim in the SAML assertion. If you wish to link SAML users based on the subject of the SAML assertion, you should map the subject to a claim through the SAML identity provider and submit that claim name as the ProviderAttributeName. If you set ProviderAttributeName to Cognito_Subject, Cognito will automatically parse the default unique identifier found in the subject from the SAML token.

The response's http status code.

The user pool ID for the user pool where you want to enable the user.

The user name of the user you wish to enable.

The response's http status code.

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.

Take the following limitations into consideration when you use the ClientMetadata parameter:

• Amazon Cognito does not store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
• Amazon Cognito does not validate the ClientMetadata value.
• Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

The access token returned by the server response to get the user attribute verification code.

The attribute name returned by the server response to get the user attribute verification code.

The code delivery details returned by the server in response to the request to get the user attribute verification code.

The response's http status code.

The SMS text message MFA configuration.

The software token MFA configuration.

The MFA configuration. Users who don't have an MFA factor set up won't be able to sign-in if you set the MfaConfiguration value to ‘ON’. See Adding Multi-Factor Authentication (MFA) to a User Pool to learn more. Valid values include:

• OFF MFA will not be used for any users.
• ON MFA is required for all users to sign in.
• OPTIONAL MFA will be required only for individual users who have an MFA factor enabled.

The user pool ID.

The SMS text message MFA configuration.

The software token MFA configuration.

The MFA configuration. Valid values include:

• OFF MFA will not be used for any users.
• ON MFA is required for all users to sign in.
• OPTIONAL MFA will be required only for individual users who have an MFA factor enabled.

The response's http status code.

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 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.

Take the following limitations into consideration when you use the ClientMetadata parameter:

• Amazon Cognito does not store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
• Amazon Cognito does not validate the ClientMetadata value.
• Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

The access token for the request to update user attributes.

The code delivery details list from the server for the request to update user attributes.

The response's http status code.

An array of strings representing the user attribute names you wish to delete.

For custom attributes, you must prepend the custom: prefix to the attribute name.

The access token used in the request to delete user attributes.

The response's http status code.

Represents the access token of the request to verify user attributes.

The attribute name in the request to verify user attributes.

The verification code in the request to verify user attributes.

The response's http status code.

The user pool ID for the user pool where you want to disable the user.

The user name of the user you wish to disable.

The response's http status code.

The configuration of the device secret verifier.

The device name.

The access token.

The device key.

Indicates whether the user confirmation is necessary to confirm the device response.

The response's http status code.

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.

Take the following limitations into consideration when you use the ClientMetadata parameter:

• Amazon Cognito does not store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
• Amazon Cognito does not validate the ClientMetadata value.
• Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword calls.

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

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.

The app client ID of the app associated with the user pool.

The user name of the user for whom you want to enter a code to retrieve a forgotten password.

The confirmation code sent by a user's request to retrieve a forgotten password. For more information, see ForgotPassword.

The password sent by a user's request to retrieve a forgotten password.

The response's http status code.

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.

The user pool ID for the user pool that the users are being imported into.

The maximum number of import jobs you want the request to return.

An identifier that can be used to return the next set of user import jobs in the list.

The user import jobs.

The response's http status code.

The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.

The tags that are assigned to the user pool.

The response's http status code.

The user pool ID.

The identity provider name.

The response's http status code.

The identity provider that was deleted.

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.

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.

Maximum number of users to be returned.

A filter string of the form "AttributeName Filter-Type "AttributeValue"". Quotation marks within the filter string must be escaped using the backslash (\) character. For example, "family_name = \"Reddy\"".

• AttributeName: The name of the attribute to search for. You can only search for one attribute at a time.
• Filter-Type: For an exact match, use =, for example, "given_name = \"Jon\"". For a prefix ("starts with") match, use ^=, for example, "given_name ^= \"Jon\"".
• AttributeValue: The attribute value that must be matched for each user.

If the filter string is empty, ListUsers returns all users in the user pool.

You can only search for the following standard attributes:

• username (case-sensitive)

• email

• phone_number

• name

• given_name

• family_name

• preferred_username

• cognito:user_status (called Status in the Console) (case-insensitive)

• status (called Enabled in the Console) (case-sensitive)

• sub

Custom attributes are not searchable.

For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer Guide.

The user pool ID for the user pool on which the search should be performed.

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.

The users returned in the request to list users.

The response's http status code.

The user pool ID for the user pool where you want to delete user attributes.

The user name of the user from which you would like to delete attributes.

An array of strings representing the user attribute names you wish to delete.

For custom attributes, you must prepend the custom: prefix to the attribute name.

The response's http status code.

The domain string.

A domain description object containing information about the domain.

The response's http status code.

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.

Take the following limitations into consideration when you use the ClientMetadata parameter:

• Amazon Cognito does not store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
• Amazon Cognito does not validate the ClientMetadata value.
• Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

The user pool ID for the user pool where you want to update user attributes.

The user name of the user for whom you want to update user attributes.

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

The response's http status code.

The user pool ID for the user pool where you want to get information about the user.

The user name of the user you wish to retrieve.

Indicates that the status is enabled.

The user status. Can be one of the following:

• UNCONFIRMED - User has been created but not confirmed.
• CONFIRMED - User has been confirmed.
• ARCHIVED - User is no longer active.
• COMPROMISED - User is disabled due to a potential security threat.
• UNKNOWN - User status is not known.
• RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or she can sign in.
• FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change his or her password to a new value before doing anything else.

An array of name-value pairs representing user attributes.

The date the user was created.

The MFA options that are enabled for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.

This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about TOTP software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.

The date the user was last modified.

The user's preferred MFA setting.

The response's http status code.

The user name of the user about whom you are receiving information.

The user pool ID.

The user name.

The response's http status code.

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.

The limit of the request to list users.

The user pool ID for the user pool.

The name of the group.

The users returned in the request to list users.

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.

The response's http status code.

The access token.

The session which should be passed both ways in challenge-response calls to the service. This allows authentication of the user as part of the MFA setup process.

A unique generated shared secret code that is used in the TOTP algorithm to generate a one time code.

The session which should be passed both ways in challenge-response calls to the service. This allows authentication of the user as part of the MFA setup process.

The response's http status code.

The user pool ID for the user pool.

The user to be disabled.

The response's http status code.

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.

Take the following limitations into consideration when you use the ClientMetadata parameter:

• Amazon Cognito does not store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
• Amazon Cognito does not validate the ClientMetadata value.
• Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

The Amazon Pinpoint analytics metadata for collecting metrics for ForgotPassword calls.

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

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.

The ID of the client associated with the user pool.

The user name of the user for whom you want to enter a code to reset a forgotten password.

The code delivery details returned by the server in response to the request to reset a password.

The response's http status code.

The user pool ID for the user pool you want to describe.

The container of metadata returned by the server to describe the pool.

The response's http status code.

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 does not provide the ClientMetadata value as input:

• Post authentication
• Custom message
• Pre token generation
• Create auth challenge
• Define auth challenge
• Verify auth challenge

For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

Take the following limitations into consideration when you use the ClientMetadata parameter:

• Amazon Cognito does not store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
• Amazon Cognito does not validate the ClientMetadata value.
• Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

The Amazon Pinpoint analytics metadata for collecting metrics for InitiateAuth calls.

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

The authentication parameters. These are inputs corresponding to the AuthFlow that you are invoking. The required values depend on the value of AuthFlow:

• For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY.
• For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY.
• For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY. To start the authentication flow with password verification, include ChallengeName: SRP_A and SRP_A: (The SRP_A Value).

The authentication flow for this call to execute. The API action will depend on this value. For example:

• REFRESH_TOKEN_AUTH will take in a valid refresh token and return new tokens.
• USER_SRP_AUTH will take in USERNAME and SRP_A and return the SRP variables to be used for next challenge execution.
• USER_PASSWORD_AUTH will take in USERNAME and PASSWORD and return the next challenge or tokens.

Valid values include:

• USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.
• REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.
• CUSTOM_AUTH: Custom authentication flow.
• USER_PASSWORD_AUTH: Non-SRP authentication flow; USERNAME and PASSWORD are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if the USERNAME is not found in the user pool.
• ADMIN_USER_PASSWORD_AUTH: Admin-based user password authentication. This replaces the ADMIN_NO_SRP_AUTH authentication flow. In this flow, Cognito receives the password in the request instead of using the SRP process to verify passwords.

ADMIN_NO_SRP_AUTH is not a valid value.

The app client ID.

The name of the challenge which you are responding to with this call. This is returned to you in the AdminInitiateAuth response if you need to pass another challenge.

Valid values include the following. Note that all of these challenges require USERNAME and SECRET_HASH (if applicable) in the parameters.

• SMS_MFA: Next challenge is to supply an SMS_MFA_CODE, delivered via SMS.
• PASSWORD_VERIFIER: Next challenge is to supply PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after the client-side SRP calculations.
• CUSTOM_CHALLENGE: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued.
• DEVICE_SRP_AUTH: If device tracking was enabled on your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device.
• DEVICE_PASSWORD_VERIFIER: Similar to PASSWORD_VERIFIER, but for devices only.
• NEW_PASSWORD_REQUIRED: For users who are required to change their passwords after successful first login. This challenge should be passed with NEW_PASSWORD and any other required attributes.

• MFA_SETUP: For users who are required to setup an MFA factor before they can sign-in. The MFA types enabled for the user pool will be listed in the challenge parameters MFA_CAN_SETUP value.

  To setup 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 setup 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.

The challenge parameters. These are returned to you in the InitiateAuth response if you need to pass another challenge. The responses in this parameter should be used to compute inputs to the next call (RespondToAuthChallenge).

All challenges require USERNAME and SECRET_HASH (if applicable).

The result of the authentication response. This is only returned if the caller does not need to pass another challenge. If the caller does need to pass another challenge before it gets tokens, ChallengeName, ChallengeParameters, and Session are returned.

The session which should be passed both ways in challenge-response calls to the service. If the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.

The response's http status code.

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.

The limit of the request to list groups.

The username for the user.

The user pool ID for the user pool.

The groups that the user belongs to.

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.

The response's http status code.

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.

Take the following limitations into consideration when you use the ClientMetadata parameter:

• Amazon Cognito does not store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
• Amazon Cognito does not validate the ClientMetadata value.
• Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

The user pool ID for which you want to confirm user registration.

The user name for which you want to confirm user registration.

The response's http status code.

The user pool ID.

The user pool username.

The authentication event ID.

The authentication event feedback value.

The response's http status code.

True if the password is permanent, False if it is temporary.

The user pool ID for the user pool where you want to set the user's password.

The user name of the user whose password you wish to set.

The password for the user.

The response's http status code.

The user pool ID for the user pool that the users are being imported into.

The job ID for the user import job.

The job object that represents the user import job.

The response's http status code.

A list of identity provider identifiers.

A mapping of identity provider attributes to standard and custom user pool attributes.