AWS SDK for PHP 3.x

Client: Aws\CognitoIdentityProvider\CognitoIdentityProviderClient

Service ID: cognito-idp

Version: 2016-04-18

This page describes the parameters and results for the operations of the Amazon Cognito Identity Provider (2016-04-18), and shows how to use the Aws\CognitoIdentityProvider\CognitoIdentityProviderClient object to call the described operations. This documentation is specific to the 2016-04-18 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AddCustomAttributes ( array $params = [] )
Adds additional user attributes to the user pool schema.
AdminAddUserToGroup ( array $params = [] )
Adds the specified user to the specified group.
AdminConfirmSignUp ( array $params = [] )
Confirms user registration as an admin without using a confirmation code.
AdminCreateUser ( array $params = [] )
Creates a new user in the specified user pool.
AdminDeleteUser ( array $params = [] )
Deletes a user as an administrator.
AdminDeleteUserAttributes ( array $params = [] )
Deletes the user attributes in a user pool as an administrator.
AdminDisableProviderForUser ( array $params = [] )
Prevents the user from signing in with the specified external (SAML or social) identity provider (IdP).
AdminDisableUser ( array $params = [] )
Disables the specified user.
AdminEnableUser ( array $params = [] )
Enables the specified user as an administrator.
AdminForgetDevice ( array $params = [] )
Forgets the device, as an administrator.
AdminGetDevice ( array $params = [] )
Gets the device, as an administrator.
AdminGetUser ( array $params = [] )
Gets the specified user by user name in a user pool as an administrator.
AdminInitiateAuth ( array $params = [] )
Initiates the authentication flow, as an administrator.
AdminLinkProviderForUser ( array $params = [] )
Links an existing user account in a user pool (DestinationUser) to an identity from an external IdP (SourceUser) based on a specified attribute name and value from the external IdP.
AdminListDevices ( array $params = [] )
Lists devices, as an administrator.
AdminListGroupsForUser ( array $params = [] )
Lists the groups that the user belongs to.
AdminListUserAuthEvents ( array $params = [] )
A history of user activity and any risks detected as part of Amazon Cognito advanced security.
AdminRemoveUserFromGroup ( array $params = [] )
Removes the specified user from the specified group.
AdminResetUserPassword ( array $params = [] )
Resets the specified user's password in a user pool as an administrator.
AdminRespondToAuthChallenge ( array $params = [] )
Responds to an authentication challenge, as an administrator.
AdminSetUserMFAPreference ( array $params = [] )
The user's multi-factor authentication (MFA) preference, including which MFA options are activated, and if any are preferred.
AdminSetUserPassword ( array $params = [] )
Sets the specified user's password in a user pool as an administrator.
AdminSetUserSettings ( array $params = [] )
This action is no longer supported.
AdminUpdateAuthEventFeedback ( array $params = [] )
Provides feedback for an authentication event indicating if it was from a valid user.
AdminUpdateDeviceStatus ( array $params = [] )
Updates the device status as an administrator.
AdminUpdateUserAttributes ( array $params = [] )
Updates the specified user's attributes, including developer attributes, as an administrator.
AdminUserGlobalSignOut ( array $params = [] )
Signs out a user from all devices.
AssociateSoftwareToken ( array $params = [] )
Begins setup of time-based one-time password (TOTP) multi-factor authentication (MFA) for a user, with a unique private key that Amazon Cognito generates and returns in the API response.
ChangePassword ( array $params = [] )
Changes the password for a specified user in a user pool.
ConfirmDevice ( array $params = [] )
Confirms tracking of the device.
ConfirmForgotPassword ( array $params = [] )
Allows a user to enter a confirmation code to reset a forgotten password.
ConfirmSignUp ( array $params = [] )
Confirms registration of a new user.
CreateGroup ( array $params = [] )
Creates a new group in the specified user pool.
CreateIdentityProvider ( array $params = [] )
Creates an IdP for a user pool.
CreateResourceServer ( array $params = [] )
Creates a new OAuth2.
CreateUserImportJob ( array $params = [] )
Creates the user import job.
CreateUserPool ( array $params = [] )
Creates a new Amazon Cognito user pool and sets the password policy for the pool.
CreateUserPoolClient ( array $params = [] )
Creates the user pool client.
CreateUserPoolDomain ( array $params = [] )
Creates a new domain for a user pool.
DeleteGroup ( array $params = [] )
Deletes a group.
DeleteIdentityProvider ( array $params = [] )
Deletes an IdP for a user pool.
DeleteResourceServer ( array $params = [] )
Deletes a resource server.
DeleteUser ( array $params = [] )
Allows a user to delete himself or herself.
DeleteUserAttributes ( array $params = [] )
Deletes the attributes for a user.
DeleteUserPool ( array $params = [] )
Deletes the specified Amazon Cognito user pool.
DeleteUserPoolClient ( array $params = [] )
Allows the developer to delete the user pool client.
DeleteUserPoolDomain ( array $params = [] )
Deletes a domain for a user pool.
DescribeIdentityProvider ( array $params = [] )
Gets information about a specific IdP.
DescribeResourceServer ( array $params = [] )
Describes a resource server.
DescribeRiskConfiguration ( array $params = [] )
Describes the risk configuration.
DescribeUserImportJob ( array $params = [] )
Describes the user import job.
DescribeUserPool ( array $params = [] )
Returns the configuration information and metadata of the specified user pool.
DescribeUserPoolClient ( array $params = [] )
Client method for returning the configuration information and metadata of the specified user pool app client.
DescribeUserPoolDomain ( array $params = [] )
Gets information about a domain.
ForgetDevice ( array $params = [] )
Forgets the specified device.
ForgotPassword ( array $params = [] )
Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password.
GetCSVHeader ( array $params = [] )
Gets the header information for the comma-separated value (CSV) file to be used as input for the user import job.
GetDevice ( array $params = [] )
Gets the device.
GetGroup ( array $params = [] )
Gets a group.
GetIdentityProviderByIdentifier ( array $params = [] )
Gets the specified IdP.
GetSigningCertificate ( array $params = [] )
This method takes a user pool ID, and returns the signing certificate.
GetUICustomization ( array $params = [] )
Gets the user interface (UI) Customization information for a particular app client's app UI, if any such information exists for the client.
GetUser ( array $params = [] )
Gets the user attributes and metadata for a user.
GetUserAttributeVerificationCode ( array $params = [] )
Generates a user attribute verification code for the specified attribute name.
GetUserPoolMfaConfig ( array $params = [] )
Gets the user pool multi-factor authentication (MFA) configuration.
GlobalSignOut ( array $params = [] )
Signs out users from all devices.
InitiateAuth ( array $params = [] )
Initiates sign-in for a user in the Amazon Cognito user directory.
ListDevices ( array $params = [] )
Lists the sign-in devices that Amazon Cognito has registered to the current user.
ListGroups ( array $params = [] )
Lists the groups associated with a user pool.
ListIdentityProviders ( array $params = [] )
Lists information about all IdPs for a user pool.
ListResourceServers ( array $params = [] )
Lists the resource servers for a user pool.
ListTagsForResource ( array $params = [] )
Lists the tags that are assigned to an Amazon Cognito user pool.
ListUserImportJobs ( array $params = [] )
Lists the user import jobs.
ListUserPoolClients ( array $params = [] )
Lists the clients that have been created for the specified user pool.
ListUserPools ( array $params = [] )
Lists the user pools associated with an Amazon Web Services account.
ListUsers ( array $params = [] )
Lists the users in the Amazon Cognito user pool.
ListUsersInGroup ( array $params = [] )
Lists the users in the specified group.
ResendConfirmationCode ( array $params = [] )
Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
RespondToAuthChallenge ( array $params = [] )
Responds to the authentication challenge.
RevokeToken ( array $params = [] )
Revokes all of the access tokens generated by the specified refresh token.
SetRiskConfiguration ( array $params = [] )
Configures actions on detected risks.
SetUICustomization ( array $params = [] )
Sets the user interface (UI) customization information for a user pool's built-in app UI.
SetUserMFAPreference ( array $params = [] )
Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are activated and if any are preferred.
SetUserPoolMfaConfig ( array $params = [] )
Sets the user pool multi-factor authentication (MFA) configuration.
SetUserSettings ( array $params = [] )
This action is no longer supported.
SignUp ( array $params = [] )
Registers the user in the specified user pool and creates a user name, password, and user attributes.
StartUserImportJob ( array $params = [] )
Starts the user import.
StopUserImportJob ( array $params = [] )
Stops the user import job.
TagResource ( array $params = [] )
Assigns a set of tags to an Amazon Cognito user pool.
UntagResource ( array $params = [] )
Removes the specified tags from an Amazon Cognito user pool.
UpdateAuthEventFeedback ( array $params = [] )
Provides the feedback for an authentication event, whether it was from a valid user or not.
UpdateDeviceStatus ( array $params = [] )
Updates the device status.
UpdateGroup ( array $params = [] )
Updates the specified group with the specified attributes.
UpdateIdentityProvider ( array $params = [] )
Updates IdP information for a user pool.
UpdateResourceServer ( array $params = [] )
Updates the name and scopes of resource server.
UpdateUserAttributes ( array $params = [] )
Allows a user to update a specific attribute (one at a time).
UpdateUserPool ( array $params = [] )
Updates the specified user pool with the specified attributes.
UpdateUserPoolClient ( array $params = [] )
Updates the specified user pool app client with the specified attributes.
UpdateUserPoolDomain ( array $params = [] )
Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool.
VerifySoftwareToken ( array $params = [] )
Use this API to register a user's entered time-based one-time password (TOTP) code and mark the user's software token MFA status as "verified" if successful.
VerifyUserAttribute ( array $params = [] )
Verifies the specified user attributes in the user pool.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

AdminListGroupsForUser
AdminListUserAuthEvents
ListGroups
ListIdentityProviders
ListResourceServers
ListUserPoolClients
ListUserPools
ListUsers
ListUsersInGroup

Operations

AddCustomAttributes

$result = $client->addCustomAttributes([/* ... */]);
$promise = $client->addCustomAttributesAsync([/* ... */]);

Adds additional user attributes to the user pool schema.

Parameter Syntax

$result = $client->addCustomAttributes([
    'CustomAttributes' => [ // REQUIRED
        [
            'AttributeDataType' => 'String|Number|DateTime|Boolean',
            'DeveloperOnlyAttribute' => true || false,
            'Mutable' => true || false,
            'Name' => '<string>',
            'NumberAttributeConstraints' => [
                'MaxValue' => '<string>',
                'MinValue' => '<string>',
            ],
            'Required' => true || false,
            'StringAttributeConstraints' => [
                'MaxLength' => '<string>',
                'MinLength' => '<string>',
            ],
        ],
        // ...
    ],
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

CustomAttributes

Required: Yes
Type: Array of SchemaAttributeType structures

An array of custom attributes, such as Mutable and Name.

UserPoolId

Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
UserImportInProgressException:
This exception is thrown when you're trying to modify a user pool while a user import job is in progress for that pool.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

AdminAddUserToGroup

$result = $client->adminAddUserToGroup([/* ... */]);
$promise = $client->adminAddUserToGroupAsync([/* ... */]);

Adds the specified user to the specified group.

Calling this action requires developer credentials.

Parameter Syntax

$result = $client->adminAddUserToGroup([
    'GroupName' => '<string>', // REQUIRED
    'UserPoolId' => '<string>', // REQUIRED
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members

GroupName

Required: Yes
Type: string

The group name.

UserPoolId

Required: Yes
Type: string

The user pool ID for the user pool.

Username

Required: Yes
Type: string

The username for the user.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
UserNotFoundException:
This exception is thrown when a user isn't found.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

AdminConfirmSignUp

$result = $client->adminConfirmSignUp([/* ... */]);
$promise = $client->adminConfirmSignUpAsync([/* ... */]);

Confirms user registration as an admin without using a confirmation code. Works on any user.

Calling this action requires developer credentials.

Parameter Syntax

$result = $client->adminConfirmSignUp([
    'ClientMetadata' => ['<string>', ...],
    'UserPoolId' => '<string>', // REQUIRED
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members

ClientMetadata

Type: Associative array of custom strings keys (StringType) to strings

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.

UserPoolId

Required: Yes
Type: string

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

Username

Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
UnexpectedLambdaException:
This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.
UserLambdaValidationException:
This exception is thrown when the Amazon Cognito service encounters a user validation exception with the Lambda service.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
TooManyFailedAttemptsException:
This exception is thrown when the user has made too many failed attempts for a given action, such as sign-in.
InvalidLambdaResponseException:
This exception is thrown when Amazon Cognito encounters an invalid Lambda response.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
LimitExceededException:
This exception is thrown when a user exceeds the limit for a requested Amazon Web Services resource.
UserNotFoundException:
This exception is thrown when a user isn't found.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

AdminCreateUser

$result = $client->adminCreateUser([/* ... */]);
$promise = $client->adminCreateUserAsync([/* ... */]);

Creates a new user in the specified user pool.

If MessageAction isn't set, the default is to send a welcome message via email or phone (SMS).

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.

This message is based on a template that you configured in your call to create or update a user pool. This template includes your custom sign-up instructions and placeholders for user name and temporary password.

Alternatively, you can call AdminCreateUser with SUPPRESS for the MessageAction parameter, and Amazon Cognito won't send any email.

In either case, the user will be in the FORCE_CHANGE_PASSWORD state until they sign in and change their password.

AdminCreateUser requires developer credentials.

Parameter Syntax

$result = $client->adminCreateUser([
    'ClientMetadata' => ['<string>', ...],
    'DesiredDeliveryMediums' => ['<string>', ...],
    'ForceAliasCreation' => true || false,
    'MessageAction' => 'RESEND|SUPPRESS',
    'TemporaryPassword' => '<string>',
    'UserAttributes' => [
        [
            'Name' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'UserPoolId' => '<string>', // REQUIRED
    'Username' => '<string>', // REQUIRED
    'ValidationData' => [
        [
            'Name' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members

ClientMetadata

Type: Associative array of custom strings keys (StringType) to strings

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.

DesiredDeliveryMediums

Type: Array of strings

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.

ForceAliasCreation

Type: boolean

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.

MessageAction

Type: string

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.

TemporaryPassword

Type: string

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.

UserAttributes

Type: Array of AttributeType structures

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.

UserPoolId

Required: Yes
Type: string

The user pool ID for the user pool where the user will be created.

Username

Required: Yes
Type: string

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.

ValidationData

Type: Array of AttributeType structures

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.

Result Syntax

[
    'User' => [
        'Attributes' => [
            [
                'Name' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Enabled' => true || false,
        'MFAOptions' => [
            [
                'AttributeName' => '<string>',
                'DeliveryMedium' => 'SMS|EMAIL',
            ],
            // ...
        ],
        'UserCreateDate' => <DateTime>,
        'UserLastModifiedDate' => <DateTime>,
        'UserStatus' => 'UNCONFIRMED|CONFIRMED|ARCHIVED|COMPROMISED|UNKNOWN|RESET_REQUIRED|FORCE_CHANGE_PASSWORD',
        'Username' => '<string>',
    ],
]

Result Details

Members

User

Type: UserType structure

The newly created user.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
UserNotFoundException:
This exception is thrown when a user isn't found.
UsernameExistsException:
This exception is thrown when Amazon Cognito encounters a user name that already exists in the user pool.
InvalidPasswordException:
This exception is thrown when Amazon Cognito encounters an invalid password.
CodeDeliveryFailureException:
This exception is thrown when a verification code fails to deliver successfully.
UnexpectedLambdaException:
This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.
UserLambdaValidationException:
This exception is thrown when the Amazon Cognito service encounters a user validation exception with the Lambda service.
InvalidLambdaResponseException:
This exception is thrown when Amazon Cognito encounters an invalid Lambda response.
PreconditionNotMetException:
This exception is thrown when a precondition is not met.
InvalidSmsRoleAccessPolicyException:
This exception is returned when the role provided for SMS configuration doesn't have permission to publish using Amazon SNS.
InvalidSmsRoleTrustRelationshipException:
This exception is thrown when the trust relationship is not valid for the role provided for SMS configuration. This can happen if you don't trust cognito-idp.amazonaws.com or the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
UnsupportedUserStateException:
The request failed because the user is in an unsupported state.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

AdminDeleteUser

$result = $client->adminDeleteUser([/* ... */]);
$promise = $client->adminDeleteUserAsync([/* ... */]);

Deletes a user as an administrator. Works on any user.

Calling this action requires developer credentials.

Parameter Syntax

$result = $client->adminDeleteUser([
    'UserPoolId' => '<string>', // REQUIRED
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members

UserPoolId

Required: Yes
Type: string

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

Username

Required: Yes
Type: string

The user name of the user you want to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
UserNotFoundException:
This exception is thrown when a user isn't found.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

AdminDeleteUserAttributes

$result = $client->adminDeleteUserAttributes([/* ... */]);
$promise = $client->adminDeleteUserAttributesAsync([/* ... */]);

Deletes the user attributes in a user pool as an administrator. Works on any user.

Calling this action requires developer credentials.

Parameter Syntax

$result = $client->adminDeleteUserAttributes([
    'UserAttributeNames' => ['<string>', ...], // REQUIRED
    'UserPoolId' => '<string>', // REQUIRED
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members

UserAttributeNames

Required: Yes
Type: Array of strings

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.

UserPoolId

Required: Yes
Type: string

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

Username

Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
UserNotFoundException:
This exception is thrown when a user isn't found.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

AdminDisableProviderForUser

$result = $client->adminDisableProviderForUser([/* ... */]);
$promise = $client->adminDisableProviderForUserAsync([/* ... */]);

Prevents the user from signing in with the specified external (SAML or social) identity provider (IdP). If the user that you want to deactivate is a Amazon Cognito user pools native username + password user, they can't use their password to sign in. If the user to deactivate is a linked external IdP user, any link between that user and an existing user is removed. When the external user signs in again, and the user is no longer attached to the previously linked DestinationUser, the user must create a new user account. See AdminLinkProviderForUser.

This action is enabled only for admin access and requires developer credentials.

The ProviderName must match the value specified when creating an IdP for the pool.

To deactivate a native username + password user, the ProviderName value must be Cognito and the ProviderAttributeName must be Cognito_Subject. The ProviderAttributeValue must be the name that is used in the user pool for the user.

The ProviderAttributeName must always be Cognito_Subject for social IdPs. The ProviderAttributeValue must always be the exact subject that was used when the user was originally linked as a source user.

For de-linking a SAML identity, there are two scenarios. If the linked identity has not yet been used to sign in, the ProviderAttributeName and ProviderAttributeValue must be the same values that were used for the SourceUser when the identities were originally linked using AdminLinkProviderForUser call. (If the linking was done with ProviderAttributeName set to Cognito_Subject, the same applies here). However, if the user has already signed in, the ProviderAttributeName must be Cognito_Subject and ProviderAttributeValue must be the subject of the SAML assertion.

Parameter Syntax

$result = $client->adminDisableProviderForUser([
    'User' => [ // REQUIRED
        'ProviderAttributeName' => '<string>',
        'ProviderAttributeValue' => '<string>',
        'ProviderName' => '<string>',
    ],
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

User

Required: Yes
Type: ProviderUserIdentifierType structure

The user to be disabled.

UserPoolId

Required: Yes
Type: string

The user pool ID for the user pool.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
UserNotFoundException:
This exception is thrown when a user isn't found.
AliasExistsException:
This exception is thrown when a user tries to confirm the account with an email address or phone number that has already been supplied as an alias for a different user profile. This exception indicates that an account with this email address or phone already exists in a user pool that you've configured to use email address or phone number as a sign-in alias.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

AdminDisableUser

$result = $client->adminDisableUser([/* ... */]);
$promise = $client->adminDisableUserAsync([/* ... */]);

Disables the specified user.

Calling this action requires developer credentials.

Parameter Syntax

$result = $client->adminDisableUser([
    'UserPoolId' => '<string>', // REQUIRED
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members

UserPoolId

Required: Yes
Type: string

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

Username

Required: Yes
Type: string

The user name of the user you want to disable.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
UserNotFoundException:
This exception is thrown when a user isn't found.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

AdminEnableUser

$result = $client->adminEnableUser([/* ... */]);
$promise = $client->adminEnableUserAsync([/* ... */]);

Enables the specified user as an administrator. Works on any user.

Calling this action requires developer credentials.

Parameter Syntax

$result = $client->adminEnableUser([
    'UserPoolId' => '<string>', // REQUIRED
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members

UserPoolId

Required: Yes
Type: string

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

Username

Required: Yes
Type: string

The user name of the user you want to enable.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
UserNotFoundException:
This exception is thrown when a user isn't found.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

AdminForgetDevice

$result = $client->adminForgetDevice([/* ... */]);
$promise = $client->adminForgetDeviceAsync([/* ... */]);

Forgets the device, as an administrator.

Calling this action requires developer credentials.

Parameter Syntax

$result = $client->adminForgetDevice([
    'DeviceKey' => '<string>', // REQUIRED
    'UserPoolId' => '<string>', // REQUIRED
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members

DeviceKey

Required: Yes
Type: string

The device key.

UserPoolId

Required: Yes
Type: string

The user pool ID.

Username

Required: Yes
Type: string

The user name.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
InvalidUserPoolConfigurationException:
This exception is thrown when the user pool configuration is not valid.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
UserNotFoundException:
This exception is thrown when a user isn't found.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

AdminGetDevice

$result = $client->adminGetDevice([/* ... */]);
$promise = $client->adminGetDeviceAsync([/* ... */]);

Gets the device, as an administrator.

Calling this action requires developer credentials.

Parameter Syntax

$result = $client->adminGetDevice([
    'DeviceKey' => '<string>', // REQUIRED
    'UserPoolId' => '<string>', // REQUIRED
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members

DeviceKey

Required: Yes
Type: string

The device key.

UserPoolId

Required: Yes
Type: string

The user pool ID.

Username

Required: Yes
Type: string

The user name.

Result Syntax

[
    'Device' => [
        'DeviceAttributes' => [
            [
                'Name' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'DeviceCreateDate' => <DateTime>,
        'DeviceKey' => '<string>',
        'DeviceLastAuthenticatedDate' => <DateTime>,
        'DeviceLastModifiedDate' => <DateTime>,
    ],
]

Result Details

Members

Device

Required: Yes
Type: DeviceType structure

The device.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
InvalidUserPoolConfigurationException:
This exception is thrown when the user pool configuration is not valid.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.

AdminGetUser

$result = $client->adminGetUser([/* ... */]);
$promise = $client->adminGetUserAsync([/* ... */]);

Gets the specified user by user name in a user pool as an administrator. Works on any user.

Calling this action requires developer credentials.

Parameter Syntax

$result = $client->adminGetUser([
    'UserPoolId' => '<string>', // REQUIRED
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members

UserPoolId

Required: Yes
Type: string

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

Username

Required: Yes
Type: string

The user name of the user you want to retrieve.

Result Syntax

[
    'Enabled' => true || false,
    'MFAOptions' => [
        [
            'AttributeName' => '<string>',
            'DeliveryMedium' => 'SMS|EMAIL',
        ],
        // ...
    ],
    'PreferredMfaSetting' => '<string>',
    'UserAttributes' => [
        [
            'Name' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'UserCreateDate' => <DateTime>,
    'UserLastModifiedDate' => <DateTime>,
    'UserMFASettingList' => ['<string>', ...],
    'UserStatus' => 'UNCONFIRMED|CONFIRMED|ARCHIVED|COMPROMISED|UNKNOWN|RESET_REQUIRED|FORCE_CHANGE_PASSWORD',
    'Username' => '<string>',
]

Result Details

Members

Enabled

Type: boolean

Indicates that the status is enabled.

MFAOptions

Type: Array of MFAOptionType structures

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.

PreferredMfaSetting

Type: string

The user's preferred MFA setting.

UserAttributes

Type: Array of AttributeType structures

An array of name-value pairs representing user attributes.

UserCreateDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date the user was created.

UserLastModifiedDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date the user was last modified.

UserMFASettingList

Type: Array of strings

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

UserStatus

Type: string

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.

Username

Required: Yes
Type: string

The user name of the user about whom you're receiving information.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
UserNotFoundException:
This exception is thrown when a user isn't found.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

AdminInitiateAuth

$result = $client->adminInitiateAuth([/* ... */]);
$promise = $client->adminInitiateAuthAsync([/* ... */]);

Initiates the authentication flow, as an administrator.

Calling this action requires developer credentials.

Parameter Syntax

$result = $client->adminInitiateAuth([
    'AnalyticsMetadata' => [
        'AnalyticsEndpointId' => '<string>',
    ],
    'AuthFlow' => 'USER_SRP_AUTH|REFRESH_TOKEN_AUTH|REFRESH_TOKEN|CUSTOM_AUTH|ADMIN_NO_SRP_AUTH|USER_PASSWORD_AUTH|ADMIN_USER_PASSWORD_AUTH', // REQUIRED
    'AuthParameters' => ['<string>', ...],
    'ClientId' => '<string>', // REQUIRED
    'ClientMetadata' => ['<string>', ...],
    'ContextData' => [
        'EncodedData' => '<string>',
        'HttpHeaders' => [ // REQUIRED
            [
                'headerName' => '<string>',
                'headerValue' => '<string>',
            ],
            // ...
        ],
        'IpAddress' => '<string>', // REQUIRED
        'ServerName' => '<string>', // REQUIRED
        'ServerPath' => '<string>', // REQUIRED
    ],
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

AnalyticsMetadata

Type: AnalyticsMetadataType structure

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

AuthFlow

Required: Yes
Type: string

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.

AuthParameters

Type: Associative array of custom strings keys (StringType) to strings

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

ClientId

Required: Yes
Type: string

The app client ID.

ClientMetadata

Type: Associative array of custom strings keys (StringType) to strings

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.

ContextData

Type: ContextDataType structure

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.

UserPoolId

Required: Yes
Type: string

The ID of the Amazon Cognito user pool.

Result Syntax

[
    'AuthenticationResult' => [
        'AccessToken' => '<string>',
        'ExpiresIn' => <integer>,
        'IdToken' => '<string>',
        'NewDeviceMetadata' => [
            'DeviceGroupKey' => '<string>',
            'DeviceKey' => '<string>',
        ],
        'RefreshToken' => '<string>',
        'TokenType' => '<string>',
    ],
    'ChallengeName' => 'SMS_MFA|SOFTWARE_TOKEN_MFA|SELECT_MFA_TYPE|MFA_SETUP|PASSWORD_VERIFIER|CUSTOM_CHALLENGE|DEVICE_SRP_AUTH|DEVICE_PASSWORD_VERIFIER|ADMIN_NO_SRP_AUTH|NEW_PASSWORD_REQUIRED',
    'ChallengeParameters' => ['<string>', ...],
    'Session' => '<string>',
]

Result Details

Members

AuthenticationResult

Type: AuthenticationResultType structure

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.

ChallengeName

Type: string

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.

ChallengeParameters

Type: Associative array of custom strings keys (StringType) to strings

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.

Session

Type: string

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.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.
UnexpectedLambdaException:
This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.
InvalidUserPoolConfigurationException:
This exception is thrown when the user pool configuration is not valid.
UserLambdaValidationException:
This exception is thrown when the Amazon Cognito service encounters a user validation exception with the Lambda service.
InvalidLambdaResponseException:
This exception is thrown when Amazon Cognito encounters an invalid Lambda response.
MFAMethodNotFoundException:
This exception is thrown when Amazon Cognito can't find a multi-factor authentication (MFA) method.
InvalidSmsRoleAccessPolicyException:
This exception is returned when the role provided for SMS configuration doesn't have permission to publish using Amazon SNS.
InvalidSmsRoleTrustRelationshipException:
This exception is thrown when the trust relationship is not valid for the role provided for SMS configuration. This can happen if you don't trust cognito-idp.amazonaws.com or the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.
PasswordResetRequiredException:
This exception is thrown when a password reset is required.
UserNotFoundException:
This exception is thrown when a user isn't found.
UserNotConfirmedException:
This exception is thrown when a user isn't confirmed successfully.

AdminLinkProviderForUser

$result = $client->adminLinkProviderForUser([/* ... */]);
$promise = $client->adminLinkProviderForUserAsync([/* ... */]);

Links an existing user account in a user pool (DestinationUser) to an identity from an external IdP (SourceUser) based on a specified attribute name and value from the external IdP. This allows you to create a link from the existing user account to an external federated user identity that has not yet been used to sign in. You can then use the federated user identity to sign in as the existing user account.

For example, if there is an existing user with a username and password, this API links that user to a federated user identity. When the user signs in with a federated user identity, they sign in as the existing user account.

The maximum number of federated identities linked to a user is five.

Because this API allows a user with an external federated identity to sign in as an existing user in the user pool, it is critical that it only be used with external IdPs and provider attributes that have been trusted by the application owner.

This action is administrative and requires developer credentials.

Parameter Syntax

$result = $client->adminLinkProviderForUser([
    'DestinationUser' => [ // REQUIRED
        'ProviderAttributeName' => '<string>',
        'ProviderAttributeValue' => '<string>',
        'ProviderName' => '<string>',
    ],
    'SourceUser' => [ // REQUIRED
        'ProviderAttributeName' => '<string>',
        'ProviderAttributeValue' => '<string>',
        'ProviderName' => '<string>',
    ],
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

DestinationUser

Required: Yes
Type: ProviderUserIdentifierType structure

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.

SourceUser

Required: Yes
Type: ProviderUserIdentifierType structure

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.

UserPoolId

Required: Yes
Type: string

The user pool ID for the user pool.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
UserNotFoundException:
This exception is thrown when a user isn't found.
AliasExistsException:
This exception is thrown when a user tries to confirm the account with an email address or phone number that has already been supplied as an alias for a different user profile. This exception indicates that an account with this email address or phone already exists in a user pool that you've configured to use email address or phone number as a sign-in alias.
LimitExceededException:
This exception is thrown when a user exceeds the limit for a requested Amazon Web Services resource.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

AdminListDevices

$result = $client->adminListDevices([/* ... */]);
$promise = $client->adminListDevicesAsync([/* ... */]);

Lists devices, as an administrator.

Calling this action requires developer credentials.

Parameter Syntax

$result = $client->adminListDevices([
    'Limit' => <integer>,
    'PaginationToken' => '<string>',
    'UserPoolId' => '<string>', // REQUIRED
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members

Limit

Type: int

The limit of the devices request.

PaginationToken

Type: string

The pagination token.

UserPoolId

Required: Yes
Type: string

The user pool ID.

Username

Required: Yes
Type: string

The user name.

Result Syntax

[
    'Devices' => [
        [
            'DeviceAttributes' => [
                [
                    'Name' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'DeviceCreateDate' => <DateTime>,
            'DeviceKey' => '<string>',
            'DeviceLastAuthenticatedDate' => <DateTime>,
            'DeviceLastModifiedDate' => <DateTime>,
        ],
        // ...
    ],
    'PaginationToken' => '<string>',
]

Result Details

Members

Devices

Type: Array of DeviceType structures

The devices in the list of devices response.

PaginationToken

Type: string

The pagination token.

Errors

InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidUserPoolConfigurationException:
This exception is thrown when the user pool configuration is not valid.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.

AdminListGroupsForUser

$result = $client->adminListGroupsForUser([/* ... */]);
$promise = $client->adminListGroupsForUserAsync([/* ... */]);

Lists the groups that the user belongs to.

Calling this action requires developer credentials.

Parameter Syntax

$result = $client->adminListGroupsForUser([
    'Limit' => <integer>,
    'NextToken' => '<string>',
    'UserPoolId' => '<string>', // REQUIRED
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members

Limit

Type: int

The limit of the request to list groups.

NextToken

Type: string

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.

UserPoolId

Required: Yes
Type: string

The user pool ID for the user pool.

Username

Required: Yes
Type: string

The username for the user.

Result Syntax

[
    'Groups' => [
        [
            'CreationDate' => <DateTime>,
            'Description' => '<string>',
            'GroupName' => '<string>',
            'LastModifiedDate' => <DateTime>,
            'Precedence' => <integer>,
            'RoleArn' => '<string>',
            'UserPoolId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Groups

Type: Array of GroupType structures

The groups that the user belongs to.

NextToken

Type: string

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.

Errors

InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
UserNotFoundException:
This exception is thrown when a user isn't found.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

AdminListUserAuthEvents

$result = $client->adminListUserAuthEvents([/* ... */]);
$promise = $client->adminListUserAuthEventsAsync([/* ... */]);

A history of user activity and any risks detected as part of Amazon Cognito advanced security.

Parameter Syntax

$result = $client->adminListUserAuthEvents([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'UserPoolId' => '<string>', // REQUIRED
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of authentication events to return.

NextToken

Type: string

A pagination token.

UserPoolId

Required: Yes
Type: string

The user pool ID.

Username

Required: Yes
Type: string

The user pool username or an alias.

Result Syntax

[
    'AuthEvents' => [
        [
            'ChallengeResponses' => [
                [
                    'ChallengeName' => 'Password|Mfa',
                    'ChallengeResponse' => 'Success|Failure',
                ],
                // ...
            ],
            'CreationDate' => <DateTime>,
            'EventContextData' => [
                'City' => '<string>',
                'Country' => '<string>',
                'DeviceName' => '<string>',
                'IpAddress' => '<string>',
                'Timezone' => '<string>',
            ],
            'EventFeedback' => [
                'FeedbackDate' => <DateTime>,
                'FeedbackValue' => 'Valid|Invalid',
                'Provider' => '<string>',
            ],
            'EventId' => '<string>',
            'EventResponse' => 'Success|Failure',
            'EventRisk' => [
                'CompromisedCredentialsDetected' => true || false,
                'RiskDecision' => 'NoRisk|AccountTakeover|Block',
                'RiskLevel' => 'Low|Medium|High',
            ],
            'EventType' => 'SignIn|SignUp|ForgotPassword',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

AuthEvents

Type: Array of AuthEventType structures

The response object. It includes the EventID, EventType, CreationDate, EventRisk, and EventResponse.

NextToken

Type: string

A pagination token.

Errors

InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
UserNotFoundException:
This exception is thrown when a user isn't found.
UserPoolAddOnNotEnabledException:
This exception is thrown when user pool add-ons aren't enabled.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

AdminRemoveUserFromGroup

$result = $client->adminRemoveUserFromGroup([/* ... */]);
$promise = $client->adminRemoveUserFromGroupAsync([/* ... */]);

Removes the specified user from the specified group.

Calling this action requires developer credentials.

Parameter Syntax

$result = $client->adminRemoveUserFromGroup([
    'GroupName' => '<string>', // REQUIRED
    'UserPoolId' => '<string>', // REQUIRED
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members

GroupName

Required: Yes
Type: string

The group name.

UserPoolId

Required: Yes
Type: string

The user pool ID for the user pool.

Username

Required: Yes
Type: string

The username for the user.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
UserNotFoundException:
This exception is thrown when a user isn't found.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

AdminResetUserPassword

$result = $client->adminResetUserPassword([/* ... */]);
$promise = $client->adminResetUserPasswordAsync([/* ... */]);

Resets the specified user's password in a user pool as an administrator. Works on any user.

When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password.

Calling this action requires developer credentials.

Parameter Syntax

$result = $client->adminResetUserPassword([
    'ClientMetadata' => ['<string>', ...],
    'UserPoolId' => '<string>', // REQUIRED
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members

ClientMetadata

Type: Associative array of custom strings keys (StringType) to strings

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.

UserPoolId

Required: Yes
Type: string

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

Username

Required: Yes
Type: string

The user name of the user whose password you want to reset.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
UnexpectedLambdaException:
This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.
UserLambdaValidationException:
This exception is thrown when the Amazon Cognito service encounters a user validation exception with the Lambda service.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
InvalidLambdaResponseException:
This exception is thrown when Amazon Cognito encounters an invalid Lambda response.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
LimitExceededException:
This exception is thrown when a user exceeds the limit for a requested Amazon Web Services resource.
UserNotFoundException:
This exception is thrown when a user isn't found.
InvalidSmsRoleAccessPolicyException:
This exception is returned when the role provided for SMS configuration doesn't have permission to publish using Amazon SNS.
InvalidEmailRoleAccessPolicyException:
This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP status code: 400.
InvalidSmsRoleTrustRelationshipException:
This exception is thrown when the trust relationship is not valid for the role provided for SMS configuration. This can happen if you don't trust cognito-idp.amazonaws.com or the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

AdminRespondToAuthChallenge

$result = $client->adminRespondToAuthChallenge([/* ... */]);
$promise = $client->adminRespondToAuthChallengeAsync([/* ... */]);

Responds to an authentication challenge, as an administrator.

Calling this action requires developer credentials.

Parameter Syntax

$result = $client->adminRespondToAuthChallenge([
    'AnalyticsMetadata' => [
        'AnalyticsEndpointId' => '<string>',
    ],
    'ChallengeName' => 'SMS_MFA|SOFTWARE_TOKEN_MFA|SELECT_MFA_TYPE|MFA_SETUP|PASSWORD_VERIFIER|CUSTOM_CHALLENGE|DEVICE_SRP_AUTH|DEVICE_PASSWORD_VERIFIER|ADMIN_NO_SRP_AUTH|NEW_PASSWORD_REQUIRED', // REQUIRED
    'ChallengeResponses' => ['<string>', ...],
    'ClientId' => '<string>', // REQUIRED
    'ClientMetadata' => ['<string>', ...],
    'ContextData' => [
        'EncodedData' => '<string>',
        'HttpHeaders' => [ // REQUIRED
            [
                'headerName' => '<string>',
                'headerValue' => '<string>',
            ],
            // ...
        ],
        'IpAddress' => '<string>', // REQUIRED
        'ServerName' => '<string>', // REQUIRED
        'ServerPath' => '<string>', // REQUIRED
    ],
    'Session' => '<string>',
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

AnalyticsMetadata

Type: AnalyticsMetadataType structure

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

ChallengeName

Required: Yes
Type: string

The challenge name. For more information, see AdminInitiateAuth.

ChallengeResponses

Type: Associative array of custom strings keys (StringType) to strings

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.

ClientId

Required: Yes
Type: string

The app client ID.

ClientMetadata

Type: Associative array of custom strings keys (StringType) to strings

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.

ContextData

Type: ContextDataType structure

Session

Type: string

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.

UserPoolId

Required: Yes
Type: string

The ID of the Amazon Cognito user pool.

Result Syntax

[
    'AuthenticationResult' => [
        'AccessToken' => '<string>',
        'ExpiresIn' => <integer>,
        'IdToken' => '<string>',
        'NewDeviceMetadata' => [
            'DeviceGroupKey' => '<string>',
            'DeviceKey' => '<string>',
        ],
        'RefreshToken' => '<string>',
        'TokenType' => '<string>',
    ],
    'ChallengeName' => 'SMS_MFA|SOFTWARE_TOKEN_MFA|SELECT_MFA_TYPE|MFA_SETUP|PASSWORD_VERIFIER|CUSTOM_CHALLENGE|DEVICE_SRP_AUTH|DEVICE_PASSWORD_VERIFIER|ADMIN_NO_SRP_AUTH|NEW_PASSWORD_REQUIRED',
    'ChallengeParameters' => ['<string>', ...],
    'Session' => '<string>',
]

Result Details

Members

AuthenticationResult

Type: AuthenticationResultType structure

The result returned by the server in response to the authentication request.

ChallengeName

Type: string

The name of the challenge. For more information, see AdminInitiateAuth.

ChallengeParameters

Type: Associative array of custom strings keys (StringType) to strings

The challenge parameters. For more information, see AdminInitiateAuth.

Session

Type: string

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.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
CodeMismatchException:
This exception is thrown if the provided code doesn't match what the server was expecting.
ExpiredCodeException:
This exception is thrown if a code has expired.
UnexpectedLambdaException:
This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.
InvalidPasswordException:
This exception is thrown when Amazon Cognito encounters an invalid password.
UserLambdaValidationException:
This exception is thrown when the Amazon Cognito service encounters a user validation exception with the Lambda service.
InvalidLambdaResponseException:
This exception is thrown when Amazon Cognito encounters an invalid Lambda response.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
InvalidUserPoolConfigurationException:
This exception is thrown when the user pool configuration is not valid.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.
MFAMethodNotFoundException:
This exception is thrown when Amazon Cognito can't find a multi-factor authentication (MFA) method.
InvalidSmsRoleAccessPolicyException:
This exception is returned when the role provided for SMS configuration doesn't have permission to publish using Amazon SNS.
InvalidSmsRoleTrustRelationshipException:
This exception is thrown when the trust relationship is not valid for the role provided for SMS configuration. This can happen if you don't trust cognito-idp.amazonaws.com or the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.
AliasExistsException:
This exception is thrown when a user tries to confirm the account with an email address or phone number that has already been supplied as an alias for a different user profile. This exception indicates that an account with this email address or phone already exists in a user pool that you've configured to use email address or phone number as a sign-in alias.
PasswordResetRequiredException:
This exception is thrown when a password reset is required.
UserNotFoundException:
This exception is thrown when a user isn't found.
UserNotConfirmedException:
This exception is thrown when a user isn't confirmed successfully.
SoftwareTokenMFANotFoundException:
This exception is thrown when the software token time-based one-time password (TOTP) multi-factor authentication (MFA) isn't activated for the user pool.

AdminSetUserMFAPreference

$result = $client->adminSetUserMFAPreference([/* ... */]);
$promise = $client->adminSetUserMFAPreferenceAsync([/* ... */]);

The user's multi-factor authentication (MFA) preference, including which MFA options are activated, and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are activated. If multiple options are activated and no preference is set, a challenge to choose an MFA option will be returned during sign-in.

Parameter Syntax

$result = $client->adminSetUserMFAPreference([
    'SMSMfaSettings' => [
        'Enabled' => true || false,
        'PreferredMfa' => true || false,
    ],
    'SoftwareTokenMfaSettings' => [
        'Enabled' => true || false,
        'PreferredMfa' => true || false,
    ],
    'UserPoolId' => '<string>', // REQUIRED
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members

SMSMfaSettings

Type: SMSMfaSettingsType structure

The SMS text message MFA settings.

SoftwareTokenMfaSettings

Type: SoftwareTokenMfaSettingsType structure

The time-based one-time password software token MFA settings.

UserPoolId

Required: Yes
Type: string

The user pool ID.

Username

Required: Yes
Type: string

The user pool username or alias.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
PasswordResetRequiredException:
This exception is thrown when a password reset is required.
UserNotFoundException:
This exception is thrown when a user isn't found.
UserNotConfirmedException:
This exception is thrown when a user isn't confirmed successfully.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

AdminSetUserPassword

$result = $client->adminSetUserPassword([/* ... */]);
$promise = $client->adminSetUserPasswordAsync([/* ... */]);

Sets the specified user's password in a user pool as an administrator. Works on any user.

The password can be temporary or permanent. If it is temporary, the user status enters the FORCE_CHANGE_PASSWORD state. When the user next tries to sign in, the InitiateAuth/AdminInitiateAuth response will contain the NEW_PASSWORD_REQUIRED challenge. If the user doesn't sign in before it expires, the user won't be able to sign in, and an administrator must reset their password.

Once the user has set a new password, or the password is permanent, the user status is set to Confirmed.

Parameter Syntax

$result = $client->adminSetUserPassword([
    'Password' => '<string>', // REQUIRED
    'Permanent' => true || false,
    'UserPoolId' => '<string>', // REQUIRED
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members

Password

Required: Yes
Type: string

The password for the user.

Permanent

Type: boolean

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

UserPoolId

Required: Yes
Type: string

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

Username

Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
UserNotFoundException:
This exception is thrown when a user isn't found.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
InvalidPasswordException:
This exception is thrown when Amazon Cognito encounters an invalid password.

AdminSetUserSettings

$result = $client->adminSetUserSettings([/* ... */]);
$promise = $client->adminSetUserSettingsAsync([/* ... */]);

This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software token MFA. To configure either type of MFA, use AdminSetUserMFAPreference instead.

Parameter Syntax

$result = $client->adminSetUserSettings([
    'MFAOptions' => [ // REQUIRED
        [
            'AttributeName' => '<string>',
            'DeliveryMedium' => 'SMS|EMAIL',
        ],
        // ...
    ],
    'UserPoolId' => '<string>', // REQUIRED
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members

MFAOptions

Required: Yes
Type: Array of MFAOptionType structures

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

UserPoolId

Required: Yes
Type: string

The ID of the user pool that contains the user whose options you're setting.

Username

Required: Yes
Type: string

The user name of the user whose options you're setting.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
UserNotFoundException:
This exception is thrown when a user isn't found.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

AdminUpdateAuthEventFeedback

$result = $client->adminUpdateAuthEventFeedback([/* ... */]);
$promise = $client->adminUpdateAuthEventFeedbackAsync([/* ... */]);

Provides feedback for an authentication event indicating if it was from a valid user. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.

Parameter Syntax

$result = $client->adminUpdateAuthEventFeedback([
    'EventId' => '<string>', // REQUIRED
    'FeedbackValue' => 'Valid|Invalid', // REQUIRED
    'UserPoolId' => '<string>', // REQUIRED
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members

EventId

Required: Yes
Type: string

The authentication event ID.

FeedbackValue

Required: Yes
Type: string

The authentication event feedback value.

UserPoolId

Required: Yes
Type: string

The user pool ID.

Username

Required: Yes
Type: string

The user pool username.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
UserNotFoundException:
This exception is thrown when a user isn't found.
UserPoolAddOnNotEnabledException:
This exception is thrown when user pool add-ons aren't enabled.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

AdminUpdateDeviceStatus

$result = $client->adminUpdateDeviceStatus([/* ... */]);
$promise = $client->adminUpdateDeviceStatusAsync([/* ... */]);

Updates the device status as an administrator.

Calling this action requires developer credentials.

Parameter Syntax

$result = $client->adminUpdateDeviceStatus([
    'DeviceKey' => '<string>', // REQUIRED
    'DeviceRememberedStatus' => 'remembered|not_remembered',
    'UserPoolId' => '<string>', // REQUIRED
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members

DeviceKey

Required: Yes
Type: string

The device key.

DeviceRememberedStatus

Type: string

The status indicating whether a device has been remembered or not.

UserPoolId

Required: Yes
Type: string

The user pool ID.

Username

Required: Yes
Type: string

The user name.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidUserPoolConfigurationException:
This exception is thrown when the user pool configuration is not valid.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
UserNotFoundException:
This exception is thrown when a user isn't found.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

AdminUpdateUserAttributes

$result = $client->adminUpdateUserAttributes([/* ... */]);
$promise = $client->adminUpdateUserAttributesAsync([/* ... */]);

Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.

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

In addition to updating user attributes, this API can also be used to mark phone and email as verified.

Calling this action requires developer credentials.

Parameter Syntax

$result = $client->adminUpdateUserAttributes([
    'ClientMetadata' => ['<string>', ...],
    'UserAttributes' => [ // REQUIRED
        [
            'Name' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'UserPoolId' => '<string>', // REQUIRED
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members

ClientMetadata

Type: Associative array of custom strings keys (StringType) to strings

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.

UserAttributes

Required: Yes
Type: Array of AttributeType structures

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.

UserPoolId

Required: Yes
Type: string

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

Username

Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
UnexpectedLambdaException:
This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.
UserLambdaValidationException:
This exception is thrown when the Amazon Cognito service encounters a user validation exception with the Lambda service.
InvalidLambdaResponseException:
This exception is thrown when Amazon Cognito encounters an invalid Lambda response.
AliasExistsException:
This exception is thrown when a user tries to confirm the account with an email address or phone number that has already been supplied as an alias for a different user profile. This exception indicates that an account with this email address or phone already exists in a user pool that you've configured to use email address or phone number as a sign-in alias.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
UserNotFoundException:
This exception is thrown when a user isn't found.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.
InvalidSmsRoleAccessPolicyException:
This exception is returned when the role provided for SMS configuration doesn't have permission to publish using Amazon SNS.
InvalidEmailRoleAccessPolicyException:
This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP status code: 400.
InvalidSmsRoleTrustRelationshipException:
This exception is thrown when the trust relationship is not valid for the role provided for SMS configuration. This can happen if you don't trust cognito-idp.amazonaws.com or the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.

AdminUserGlobalSignOut

$result = $client->adminUserGlobalSignOut([/* ... */]);
$promise = $client->adminUserGlobalSignOutAsync([/* ... */]);

Signs out a user from all devices. You must sign AdminUserGlobalSignOut requests with Amazon Web Services credentials. It also invalidates all refresh tokens that Amazon Cognito has issued to a user. The user's current access and ID tokens remain valid until they expire. By default, access and ID tokens expire one hour after they're issued. A user can still use a hosted UI cookie to retrieve new tokens for the duration of the cookie validity period of 1 hour.

Calling this action requires developer credentials.

Parameter Syntax

$result = $client->adminUserGlobalSignOut([
    'UserPoolId' => '<string>', // REQUIRED
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members

UserPoolId

Required: Yes
Type: string

The user pool ID.

Username

Required: Yes
Type: string

The user name.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
UserNotFoundException:
This exception is thrown when a user isn't found.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

AssociateSoftwareToken

$result = $client->associateSoftwareToken([/* ... */]);
$promise = $client->associateSoftwareTokenAsync([/* ... */]);

Begins setup of time-based one-time password (TOTP) multi-factor authentication (MFA) for a user, with a unique private key that Amazon Cognito generates and returns in the API response. You can authorize an AssociateSoftwareToken request with either the user's access token, or a session string from a challenge response that you received from Amazon Cognito.

Amazon Cognito disassociates an existing software token when you verify the new token in a VerifySoftwareToken API request. If you don't verify the software token and your user pool doesn't require MFA, the user can then authenticate with user name and password credentials alone. If your user pool requires TOTP MFA, Amazon Cognito generates an MFA_SETUP or SOFTWARE_TOKEN_SETUP challenge each time your user signs. Complete setup with AssociateSoftwareToken and VerifySoftwareToken.

After you set up software token MFA for your user, Amazon Cognito generates a SOFTWARE_TOKEN_MFA challenge when they authenticate. Respond to this challenge with your user's TOTP.

Parameter Syntax

$result = $client->associateSoftwareToken([
    'AccessToken' => '<string>',
    'Session' => '<string>',
]);

Parameter Details

Members

AccessToken

Type: string

A valid access token that Amazon Cognito issued to the user whose software token you want to generate.

Session

Type: string

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.

Result Syntax

[
    'SecretCode' => '<string>',
    'Session' => '<string>',
]

Result Details

Members

SecretCode

Type: string

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

Session

Type: string

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.

Errors

ConcurrentModificationException:
This exception is thrown if two or more modifications are happening concurrently.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.
SoftwareTokenMFANotFoundException:
This exception is thrown when the software token time-based one-time password (TOTP) multi-factor authentication (MFA) isn't activated for the user pool.
ForbiddenException:
This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.

ChangePassword

$result = $client->changePassword([/* ... */]);
$promise = $client->changePasswordAsync([/* ... */]);

Changes the password for a specified user in a user pool.

Parameter Syntax

$result = $client->changePassword([
    'AccessToken' => '<string>', // REQUIRED
    'PreviousPassword' => '<string>', // REQUIRED
    'ProposedPassword' => '<string>', // REQUIRED
]);

Parameter Details

Members

AccessToken

Required: Yes
Type: string

A valid access token that Amazon Cognito issued to the user whose password you want to change.

PreviousPassword

Required: Yes
Type: string

The old password.

ProposedPassword

Required: Yes
Type: string

The new password.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
InvalidPasswordException:
This exception is thrown when Amazon Cognito encounters an invalid password.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
LimitExceededException:
This exception is thrown when a user exceeds the limit for a requested Amazon Web Services resource.
PasswordResetRequiredException:
This exception is thrown when a password reset is required.
UserNotFoundException:
This exception is thrown when a user isn't found.
UserNotConfirmedException:
This exception is thrown when a user isn't confirmed successfully.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.
ForbiddenException:
This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.

ConfirmDevice

$result = $client->confirmDevice([/* ... */]);
$promise = $client->confirmDeviceAsync([/* ... */]);

Confirms tracking of the device. This API call is the call that begins device tracking.

Parameter Syntax

$result = $client->confirmDevice([
    'AccessToken' => '<string>', // REQUIRED
    'DeviceKey' => '<string>', // REQUIRED
    'DeviceName' => '<string>',
    'DeviceSecretVerifierConfig' => [
        'PasswordVerifier' => '<string>',
        'Salt' => '<string>',
    ],
]);

Parameter Details

Members

AccessToken

Required: Yes
Type: string

A valid access token that Amazon Cognito issued to the user whose device you want to confirm.

DeviceKey

Required: Yes
Type: string

The device key.

DeviceName

Type: string

The device name.

DeviceSecretVerifierConfig

Type: DeviceSecretVerifierConfigType structure

The configuration of the device secret verifier.

Result Syntax

[
    'UserConfirmationNecessary' => true || false,
]

Result Details

Members

UserConfirmationNecessary

Type: boolean

Indicates whether the user confirmation must confirm the device response.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
InvalidPasswordException:
This exception is thrown when Amazon Cognito encounters an invalid password.
InvalidLambdaResponseException:
This exception is thrown when Amazon Cognito encounters an invalid Lambda response.
UsernameExistsException:
This exception is thrown when Amazon Cognito encounters a user name that already exists in the user pool.
InvalidUserPoolConfigurationException:
This exception is thrown when the user pool configuration is not valid.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
PasswordResetRequiredException:
This exception is thrown when a password reset is required.
UserNotFoundException:
This exception is thrown when a user isn't found.
UserNotConfirmedException:
This exception is thrown when a user isn't confirmed successfully.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.
ForbiddenException:
This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.

ConfirmForgotPassword

$result = $client->confirmForgotPassword([/* ... */]);
$promise = $client->confirmForgotPasswordAsync([/* ... */]);

Allows a user to enter a confirmation code to reset a forgotten password.

Parameter Syntax

$result = $client->confirmForgotPassword([
    'AnalyticsMetadata' => [
        'AnalyticsEndpointId' => '<string>',
    ],
    'ClientId' => '<string>', // REQUIRED
    'ClientMetadata' => ['<string>', ...],
    'ConfirmationCode' => '<string>', // REQUIRED
    'Password' => '<string>', // REQUIRED
    'SecretHash' => '<string>',
    'UserContextData' => [
        'EncodedData' => '<string>',
        'IpAddress' => '<string>',
    ],
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members

AnalyticsMetadata

Type: AnalyticsMetadataType structure

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

ClientId

Required: Yes
Type: string

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

ClientMetadata

Type: Associative array of custom strings keys (StringType) to strings

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.

ConfirmationCode

Required: Yes
Type: string

The confirmation code from your user's request to reset their password. For more information, see ForgotPassword.

Password

Required: Yes
Type: string

The new password that your user wants to set.

SecretHash

Type: string

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.

UserContextData

Type: UserContextDataType structure

Username

Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
UnexpectedLambdaException:
This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.
UserLambdaValidationException:
This exception is thrown when the Amazon Cognito service encounters a user validation exception with the Lambda service.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
InvalidPasswordException:
This exception is thrown when Amazon Cognito encounters an invalid password.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
CodeMismatchException:
This exception is thrown if the provided code doesn't match what the server was expecting.
ExpiredCodeException:
This exception is thrown if a code has expired.
TooManyFailedAttemptsException:
This exception is thrown when the user has made too many failed attempts for a given action, such as sign-in.
InvalidLambdaResponseException:
This exception is thrown when Amazon Cognito encounters an invalid Lambda response.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
LimitExceededException:
This exception is thrown when a user exceeds the limit for a requested Amazon Web Services resource.
UserNotFoundException:
This exception is thrown when a user isn't found.
UserNotConfirmedException:
This exception is thrown when a user isn't confirmed successfully.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.
ForbiddenException:
This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.

ConfirmSignUp

$result = $client->confirmSignUp([/* ... */]);
$promise = $client->confirmSignUpAsync([/* ... */]);

Confirms registration of a new user.

Parameter Syntax

$result = $client->confirmSignUp([
    'AnalyticsMetadata' => [
        'AnalyticsEndpointId' => '<string>',
    ],
    'ClientId' => '<string>', // REQUIRED
    'ClientMetadata' => ['<string>', ...],
    'ConfirmationCode' => '<string>', // REQUIRED
    'ForceAliasCreation' => true || false,
    'SecretHash' => '<string>',
    'UserContextData' => [
        'EncodedData' => '<string>',
        'IpAddress' => '<string>',
    ],
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members

AnalyticsMetadata

Type: AnalyticsMetadataType structure

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

ClientId

Required: Yes
Type: string

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

ClientMetadata

Type: Associative array of custom strings keys (StringType) to strings

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.

ConfirmationCode

Required: Yes
Type: string

The confirmation code sent by a user's request to confirm registration.

ForceAliasCreation

Type: boolean

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.

SecretHash

Type: string

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.

UserContextData

Type: UserContextDataType structure

Username

Required: Yes
Type: string

The user name of the user whose registration you want to confirm.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
UnexpectedLambdaException:
This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.
UserLambdaValidationException:
This exception is thrown when the Amazon Cognito service encounters a user validation exception with the Lambda service.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
TooManyFailedAttemptsException:
This exception is thrown when the user has made too many failed attempts for a given action, such as sign-in.
CodeMismatchException:
This exception is thrown if the provided code doesn't match what the server was expecting.
ExpiredCodeException:
This exception is thrown if a code has expired.
InvalidLambdaResponseException:
This exception is thrown when Amazon Cognito encounters an invalid Lambda response.
AliasExistsException:
This exception is thrown when a user tries to confirm the account with an email address or phone number that has already been supplied as an alias for a different user profile. This exception indicates that an account with this email address or phone already exists in a user pool that you've configured to use email address or phone number as a sign-in alias.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
LimitExceededException:
This exception is thrown when a user exceeds the limit for a requested Amazon Web Services resource.
UserNotFoundException:
This exception is thrown when a user isn't found.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.
ForbiddenException:
This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.

CreateGroup

$result = $client->createGroup([/* ... */]);
$promise = $client->createGroupAsync([/* ... */]);

Creates a new group in the specified user pool.

Calling this action requires developer credentials.

Parameter Syntax

$result = $client->createGroup([
    'Description' => '<string>',
    'GroupName' => '<string>', // REQUIRED
    'Precedence' => <integer>,
    'RoleArn' => '<string>',
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

Description

Type: string

A string containing the description of the group.

GroupName

Required: Yes
Type: string

The name of the group. Must be unique.

Precedence

Type: int

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.

RoleArn

Type: string

The role Amazon Resource Name (ARN) for the group.

UserPoolId

Required: Yes
Type: string

The user pool ID for the user pool.

Result Syntax

[
    'Group' => [
        'CreationDate' => <DateTime>,
        'Description' => '<string>',
        'GroupName' => '<string>',
        'LastModifiedDate' => <DateTime>,
        'Precedence' => <integer>,
        'RoleArn' => '<string>',
        'UserPoolId' => '<string>',
    ],
]

Result Details

Members

Group

Type: GroupType structure

The group object for the group.

Errors

InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
GroupExistsException:
This exception is thrown when Amazon Cognito encounters a group that already exists in the user pool.
ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
LimitExceededException:
This exception is thrown when a user exceeds the limit for a requested Amazon Web Services resource.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

CreateIdentityProvider

$result = $client->createIdentityProvider([/* ... */]);
$promise = $client->createIdentityProviderAsync([/* ... */]);

Creates an IdP for a user pool.

Parameter Syntax

$result = $client->createIdentityProvider([
    'AttributeMapping' => ['<string>', ...],
    'IdpIdentifiers' => ['<string>', ...],
    'ProviderDetails' => ['<string>', ...], // REQUIRED
    'ProviderName' => '<string>', // REQUIRED
    'ProviderType' => 'SAML|Facebook|Google|LoginWithAmazon|SignInWithApple|OIDC', // REQUIRED
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

AttributeMapping

Type: Associative array of custom strings keys (AttributeMappingKeyType) to strings

A mapping of IdP attributes to standard and custom user pool attributes.

IdpIdentifiers

Type: Array of strings

A list of IdP identifiers.

ProviderDetails

Required: Yes
Type: Associative array of custom strings keys (StringType) to strings

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

ProviderName

Required: Yes
Type: string

The IdP name.

ProviderType

Required: Yes
Type: string

The IdP type.

UserPoolId

Required: Yes
Type: string

The user pool ID.

Result Syntax

[
    'IdentityProvider' => [
        'AttributeMapping' => ['<string>', ...],
        'CreationDate' => <DateTime>,
        'IdpIdentifiers' => ['<string>', ...],
        'LastModifiedDate' => <DateTime>,
        'ProviderDetails' => ['<string>', ...],
        'ProviderName' => '<string>',
        'ProviderType' => 'SAML|Facebook|Google|LoginWithAmazon|SignInWithApple|OIDC',
        'UserPoolId' => '<string>',
    ],
]

Result Details

Members

IdentityProvider

Required: Yes
Type: IdentityProviderType structure

The newly created IdP object.

Errors

InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
DuplicateProviderException:
This exception is thrown when the provider is already supported by the user pool.
ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
LimitExceededException:
This exception is thrown when a user exceeds the limit for a requested Amazon Web Services resource.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

CreateResourceServer

$result = $client->createResourceServer([/* ... */]);
$promise = $client->createResourceServerAsync([/* ... */]);

Creates a new OAuth2.0 resource server and defines custom scopes within it.

Parameter Syntax

$result = $client->createResourceServer([
    'Identifier' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Scopes' => [
        [
            'ScopeDescription' => '<string>', // REQUIRED
            'ScopeName' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

Identifier

Required: Yes
Type: string

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.

Name

Required: Yes
Type: string

A friendly name for the resource server.

Scopes

Type: Array of ResourceServerScopeType structures

A list of scopes. Each scope is a key-value map with the keys name and description.

UserPoolId

Required: Yes
Type: string

The user pool ID for the user pool.

Result Syntax

[
    'ResourceServer' => [
        'Identifier' => '<string>',
        'Name' => '<string>',
        'Scopes' => [
            [
                'ScopeDescription' => '<string>',
                'ScopeName' => '<string>',
            ],
            // ...
        ],
        'UserPoolId' => '<string>',
    ],
]

Result Details

Members

ResourceServer

Required: Yes
Type: ResourceServerType structure

The newly created resource server.

Errors

InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
LimitExceededException:
This exception is thrown when a user exceeds the limit for a requested Amazon Web Services resource.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

CreateUserImportJob

$result = $client->createUserImportJob([/* ... */]);
$promise = $client->createUserImportJobAsync([/* ... */]);

Creates the user import job.

Parameter Syntax

$result = $client->createUserImportJob([
    'CloudWatchLogsRoleArn' => '<string>', // REQUIRED
    'JobName' => '<string>', // REQUIRED
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

CloudWatchLogsRoleArn

Required: Yes
Type: string

The role ARN for the Amazon CloudWatch Logs Logging role for the user import job.

JobName

Required: Yes
Type: string

The job name for the user import job.

UserPoolId

Required: Yes
Type: string

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

Result Syntax

[
    'UserImportJob' => [
        'CloudWatchLogsRoleArn' => '<string>',
        'CompletionDate' => <DateTime>,
        'CompletionMessage' => '<string>',
        'CreationDate' => <DateTime>,
        'FailedUsers' => <integer>,
        'ImportedUsers' => <integer>,
        'JobId' => '<string>',
        'JobName' => '<string>',
        'PreSignedUrl' => '<string>',
        'SkippedUsers' => <integer>,
        'StartDate' => <DateTime>,
        'Status' => 'Created|Pending|InProgress|Stopping|Expired|Stopped|Failed|Succeeded',
        'UserPoolId' => '<string>',
    ],
]

Result Details

Members

UserImportJob

Type: UserImportJobType structure

The job object that represents the user import job.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
PreconditionNotMetException:
This exception is thrown when a precondition is not met.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
LimitExceededException:
This exception is thrown when a user exceeds the limit for a requested Amazon Web Services resource.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

CreateUserPool

$result = $client->createUserPool([/* ... */]);
$promise = $client->createUserPoolAsync([/* ... */]);

Creates a new Amazon Cognito user pool and sets the password policy for the pool.

Parameter Syntax

$result = $client->createUserPool([
    'AccountRecoverySetting' => [
        'RecoveryMechanisms' => [
            [
                'Name' => 'verified_email|verified_phone_number|admin_only', // REQUIRED
                'Priority' => <integer>, // REQUIRED
            ],
            // ...
        ],
    ],
    'AdminCreateUserConfig' => [
        'AllowAdminCreateUserOnly' => true || false,
        'InviteMessageTemplate' => [
            'EmailMessage' => '<string>',
            'EmailSubject' => '<string>',
            'SMSMessage' => '<string>',
        ],
        'UnusedAccountValidityDays' => <integer>,
    ],
    'AliasAttributes' => ['<string>', ...],
    'AutoVerifiedAttributes' => ['<string>', ...],
    'DeviceConfiguration' => [
        'ChallengeRequiredOnNewDevice' => true || false,
        'DeviceOnlyRememberedOnUserPrompt' => true || false,
    ],
    'EmailConfiguration' => [
        'ConfigurationSet' => '<string>',
        'EmailSendingAccount' => 'COGNITO_DEFAULT|DEVELOPER',
        'From' => '<string>',
        'ReplyToEmailAddress' => '<string>',
        'SourceArn' => '<string>',
    ],
    'EmailVerificationMessage' => '<string>',
    'EmailVerificationSubject' => '<string>',
    'LambdaConfig' => [
        'CreateAuthChallenge' => '<string>',
        'CustomEmailSender' => [
            'LambdaArn' => '<string>', // REQUIRED
            'LambdaVersion' => 'V1_0', // REQUIRED
        ],
        'CustomMessage' => '<string>',
        'CustomSMSSender' => [
            'LambdaArn' => '<string>', // REQUIRED
            'LambdaVersion' => 'V1_0', // REQUIRED
        ],
        'DefineAuthChallenge' => '<string>',
        'KMSKeyID' => '<string>',
        'PostAuthentication' => '<string>',
        'PostConfirmation' => '<string>',
        'PreAuthentication' => '<string>',
        'PreSignUp' => '<string>',
        'PreTokenGeneration' => '<string>',
        'UserMigration' => '<string>',
        'VerifyAuthChallengeResponse' => '<string>',
    ],
    'MfaConfiguration' => 'OFF|ON|OPTIONAL',
    'Policies' => [
        'PasswordPolicy' => [
            'MinimumLength' => <integer>,
            'RequireLowercase' => true || false,
            'RequireNumbers' => true || false,
            'RequireSymbols' => true || false,
            'RequireUppercase' => true || false,
            'TemporaryPasswordValidityDays' => <integer>,
        ],
    ],
    'PoolName' => '<string>', // REQUIRED
    'Schema' => [
        [
            'AttributeDataType' => 'String|Number|DateTime|Boolean',
            'DeveloperOnlyAttribute' => true || false,
            'Mutable' => true || false,
            'Name' => '<string>',
            'NumberAttributeConstraints' => [
                'MaxValue' => '<string>',
                'MinValue' => '<string>',
            ],
            'Required' => true || false,
            'StringAttributeConstraints' => [
                'MaxLength' => '<string>',
                'MinLength' => '<string>',
            ],
        ],
        // ...
    ],
    'SmsAuthenticationMessage' => '<string>',
    'SmsConfiguration' => [
        'ExternalId' => '<string>',
        'SnsCallerArn' => '<string>', // REQUIRED
        'SnsRegion' => '<string>',
    ],
    'SmsVerificationMessage' => '<string>',
    'UserAttributeUpdateSettings' => [
        'AttributesRequireVerificationBeforeUpdate' => ['<string>', ...],
    ],
    'UserPoolAddOns' => [
        'AdvancedSecurityMode' => 'OFF|AUDIT|ENFORCED', // REQUIRED
    ],
    'UserPoolTags' => ['<string>', ...],
    'UsernameAttributes' => ['<string>', ...],
    'UsernameConfiguration' => [
        'CaseSensitive' => true || false, // REQUIRED
    ],
    'VerificationMessageTemplate' => [
        'DefaultEmailOption' => 'CONFIRM_WITH_LINK|CONFIRM_WITH_CODE',
        'EmailMessage' => '<string>',
        'EmailMessageByLink' => '<string>',
        'EmailSubject' => '<string>',
        'EmailSubjectByLink' => '<string>',
        'SmsMessage' => '<string>',
    ],
]);

Parameter Details

Members

AccountRecoverySetting

Type: AccountRecoverySettingType structure

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.

AdminCreateUserConfig

Type: AdminCreateUserConfigType structure

The configuration for AdminCreateUser requests.

AliasAttributes

Type: Array of strings

Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

AutoVerifiedAttributes

Type: Array of strings

The attributes to be auto-verified. Possible values: email, phone_number.

DeviceConfiguration

Type: DeviceConfigurationType structure

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.

EmailConfiguration

Type: EmailConfigurationType structure

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.

EmailVerificationMessage

Type: string

A string representing the email verification message. EmailVerificationMessage is allowed only if EmailSendingAccount is DEVELOPER.

EmailVerificationSubject

Type: string

A string representing the email verification subject. EmailVerificationSubject is allowed only if EmailSendingAccount is DEVELOPER.

LambdaConfig

Type: LambdaConfigType structure

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 .

MfaConfiguration

Type: string

Specifies MFA configuration details.

Policies

Type: UserPoolPolicyType structure

The policies associated with the new user pool.

PoolName

Required: Yes
Type: string

A string used to name the user pool.

Schema

Type: Array of SchemaAttributeType structures

An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.

SmsAuthenticationMessage

Type: string

A string representing the SMS authentication message.

SmsConfiguration

Type: SmsConfigurationType structure

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.

SmsVerificationMessage

Type: string

A string representing the SMS verification message.

UserAttributeUpdateSettings

Type: UserAttributeUpdateSettingsType structure

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.

UserPoolAddOns

Type: UserPoolAddOnsType structure

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

UserPoolTags

Type: Associative array of custom strings keys (TagKeysType) to strings

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.

UsernameAttributes

Type: Array of strings

Specifies whether a user can use an email address or phone number as a username when they sign up.

UsernameConfiguration

Type: UsernameConfigurationType structure

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.

VerificationMessageTemplate

Type: VerificationMessageTemplateType structure

The template for the verification message that the user sees when the app requests permission to access the user's information.

Result Syntax

[
    'UserPool' => [
        'AccountRecoverySetting' => [
            'RecoveryMechanisms' => [
                [
                    'Name' => 'verified_email|verified_phone_number|admin_only',
                    'Priority' => <integer>,
                ],
                // ...
            ],
        ],
        'AdminCreateUserConfig' => [
            'AllowAdminCreateUserOnly' => true || false,
            'InviteMessageTemplate' => [
                'EmailMessage' => '<string>',
                'EmailSubject' => '<string>',
                'SMSMessage' => '<string>',
            ],
            'UnusedAccountValidityDays' => <integer>,
        ],
        'AliasAttributes' => ['<string>', ...],
        'Arn' => '<string>',
        'AutoVerifiedAttributes' => ['<string>', ...],
        'CreationDate' => <DateTime>,
        'CustomDomain' => '<string>',
        'DeviceConfiguration' => [
            'ChallengeRequiredOnNewDevice' => true || false,
            'DeviceOnlyRememberedOnUserPrompt' => true || false,
        ],
        'Domain' => '<string>',
        'EmailConfiguration' => [
            'ConfigurationSet' => '<string>',
            'EmailSendingAccount' => 'COGNITO_DEFAULT|DEVELOPER',
            'From' => '<string>',
            'ReplyToEmailAddress' => '<string>',
            'SourceArn' => '<string>',
        ],
        'EmailConfigurationFailure' => '<string>',
        'EmailVerificationMessage' => '<string>',
        'EmailVerificationSubject' => '<string>',
        'EstimatedNumberOfUsers' => <integer>,
        'Id' => '<string>',
        'LambdaConfig' => [
            'CreateAuthChallenge' => '<string>',
            'CustomEmailSender' => [
                'LambdaArn' => '<string>',
                'LambdaVersion' => 'V1_0',
            ],
            'CustomMessage' => '<string>',
            'CustomSMSSender' => [
                'LambdaArn' => '<string>',
                'LambdaVersion' => 'V1_0',
            ],
            'DefineAuthChallenge' => '<string>',
            'KMSKeyID' => '<string>',
            'PostAuthentication' => '<string>',
            'PostConfirmation' => '<string>',
            'PreAuthentication' => '<string>',
            'PreSignUp' => '<string>',
            'PreTokenGeneration' => '<string>',
            'UserMigration' => '<string>',
            'VerifyAuthChallengeResponse' => '<string>',
        ],
        'LastModifiedDate' => <DateTime>,
        'MfaConfiguration' => 'OFF|ON|OPTIONAL',
        'Name' => '<string>',
        'Policies' => [
            'PasswordPolicy' => [
                'MinimumLength' => <integer>,
                'RequireLowercase' => true || false,
                'RequireNumbers' => true || false,
                'RequireSymbols' => true || false,
                'RequireUppercase' => true || false,
                'TemporaryPasswordValidityDays' => <integer>,
            ],
        ],
        'SchemaAttributes' => [
            [
                'AttributeDataType' => 'String|Number|DateTime|Boolean',
                'DeveloperOnlyAttribute' => true || false,
                'Mutable' => true || false,
                'Name' => '<string>',
                'NumberAttributeConstraints' => [
                    'MaxValue' => '<string>',
                    'MinValue' => '<string>',
                ],
                'Required' => true || false,
                'StringAttributeConstraints' => [
                    'MaxLength' => '<string>',
                    'MinLength' => '<string>',
                ],
            ],
            // ...
        ],
        'SmsAuthenticationMessage' => '<string>',
        'SmsConfiguration' => [
            'ExternalId' => '<string>',
            'SnsCallerArn' => '<string>',
            'SnsRegion' => '<string>',
        ],
        'SmsConfigurationFailure' => '<string>',
        'SmsVerificationMessage' => '<string>',
        'Status' => 'Enabled|Disabled',
        'UserAttributeUpdateSettings' => [
            'AttributesRequireVerificationBeforeUpdate' => ['<string>', ...],
        ],
        'UserPoolAddOns' => [
            'AdvancedSecurityMode' => 'OFF|AUDIT|ENFORCED',
        ],
        'UserPoolTags' => ['<string>', ...],
        'UsernameAttributes' => ['<string>', ...],
        'UsernameConfiguration' => [
            'CaseSensitive' => true || false,
        ],
        'VerificationMessageTemplate' => [
            'DefaultEmailOption' => 'CONFIRM_WITH_LINK|CONFIRM_WITH_CODE',
            'EmailMessage' => '<string>',
            'EmailMessageByLink' => '<string>',
            'EmailSubject' => '<string>',
            'EmailSubjectByLink' => '<string>',
            'SmsMessage' => '<string>',
        ],
    ],
]

Result Details

Members

UserPool

Type: UserPoolType structure

A container for the user pool details.

Errors

InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
LimitExceededException:
This exception is thrown when a user exceeds the limit for a requested Amazon Web Services resource.
InvalidSmsRoleAccessPolicyException:
This exception is returned when the role provided for SMS configuration doesn't have permission to publish using Amazon SNS.
InvalidSmsRoleTrustRelationshipException:
This exception is thrown when the trust relationship is not valid for the role provided for SMS configuration. This can happen if you don't trust cognito-idp.amazonaws.com or the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.
InvalidEmailRoleAccessPolicyException:
This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP status code: 400.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
UserPoolTaggingException:
This exception is thrown when a user pool tag can't be set or updated.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

CreateUserPoolClient

$result = $client->createUserPoolClient([/* ... */]);
$promise = $client->createUserPoolClientAsync([/* ... */]);

Creates the user pool client.

When you create a new user pool client, token revocation is automatically activated. For more information about revoking tokens, see RevokeToken.

Parameter Syntax

$result = $client->createUserPoolClient([
    'AccessTokenValidity' => <integer>,
    'AllowedOAuthFlows' => ['<string>', ...],
    'AllowedOAuthFlowsUserPoolClient' => true || false,
    'AllowedOAuthScopes' => ['<string>', ...],
    'AnalyticsConfiguration' => [
        'ApplicationArn' => '<string>',
        'ApplicationId' => '<string>',
        'ExternalId' => '<string>',
        'RoleArn' => '<string>',
        'UserDataShared' => true || false,
    ],
    'CallbackURLs' => ['<string>', ...],
    'ClientName' => '<string>', // REQUIRED
    'DefaultRedirectURI' => '<string>',
    'EnablePropagateAdditionalUserContextData' => true || false,
    'EnableTokenRevocation' => true || false,
    'ExplicitAuthFlows' => ['<string>', ...],
    'GenerateSecret' => true || false,
    'IdTokenValidity' => <integer>,
    'LogoutURLs' => ['<string>', ...],
    'PreventUserExistenceErrors' => 'LEGACY|ENABLED',
    'ReadAttributes' => ['<string>', ...],
    'RefreshTokenValidity' => <integer>,
    'SupportedIdentityProviders' => ['<string>', ...],
    'TokenValidityUnits' => [
        'AccessToken' => 'seconds|minutes|hours|days',
        'IdToken' => 'seconds|minutes|hours|days',
        'RefreshToken' => 'seconds|minutes|hours|days',
    ],
    'UserPoolId' => '<string>', // REQUIRED
    'WriteAttributes' => ['<string>', ...],
]);

Parameter Details

Members

AccessTokenValidity

Type: int

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.

AllowedOAuthFlows

Type: Array of strings

The allowed OAuth flows.

code: 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.
implicit: Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
client_credentials: 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.

AllowedOAuthFlowsUserPoolClient

Type: boolean

Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.

AllowedOAuthScopes

Type: Array of strings

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.

AnalyticsConfiguration

Type: AnalyticsConfigurationType structure

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.

CallbackURLs

Type: Array of strings

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.

ClientName

Required: Yes
Type: string

The client name for the user pool client you would like to create.

DefaultRedirectURI

Type: string

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.

EnablePropagateAdditionalUserContextData

Type: boolean

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.

EnableTokenRevocation

Type: boolean

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.

ExplicitAuthFlows

Type: Array of strings

The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are no longer supported, in favor of new names with the ALLOW_ prefix.

Values with ALLOW_ prefix must be used only along with the ALLOW_ prefix.

Valid values include:

ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, Amazon Cognito receives the password in the request instead of using the Secure Remote Password (SRP) protocol to verify passwords.
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 the authflow that refreshes tokens.

If you don't specify a value for ExplicitAuthFlows, your user client supports ALLOW_USER_SRP_AUTH and ALLOW_CUSTOM_AUTH.

GenerateSecret

Type: boolean

Boolean to specify whether you want to generate a secret for the user pool client being created.

IdTokenValidity

Type: int

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.

LogoutURLs

Type: Array of strings

A list of allowed logout URLs for the IdPs.

PreventUserExistenceErrors

Type: string

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.

ReadAttributes

Type: Array of strings

The read attributes.

RefreshTokenValidity

Type: int

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.

SupportedIdentityProviders

Type: Array of strings

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.

TokenValidityUnits

Type: TokenValidityUnitsType structure

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.

UserPoolId

Required: Yes
Type: string

The user pool ID for the user pool where you want to create a user pool client.

WriteAttributes

Type: Array of strings

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.

Result Syntax

[
    'UserPoolClient' => [
        'AccessTokenValidity' => <integer>,
        'AllowedOAuthFlows' => ['<string>', ...],
        'AllowedOAuthFlowsUserPoolClient' => true || false,
        'AllowedOAuthScopes' => ['<string>', ...],
        'AnalyticsConfiguration' => [
            'ApplicationArn' => '<string>',
            'ApplicationId' => '<string>',
            'ExternalId' => '<string>',
            'RoleArn' => '<string>',
            'UserDataShared' => true || false,
        ],
        'CallbackURLs' => ['<string>', ...],
        'ClientId' => '<string>',
        'ClientName' => '<string>',
        'ClientSecret' => '<string>',
        'CreationDate' => <DateTime>,
        'DefaultRedirectURI' => '<string>',
        'EnablePropagateAdditionalUserContextData' => true || false,
        'EnableTokenRevocation' => true || false,
        'ExplicitAuthFlows' => ['<string>', ...],
        'IdTokenValidity' => <integer>,
        'LastModifiedDate' => <DateTime>,
        'LogoutURLs' => ['<string>', ...],
        'PreventUserExistenceErrors' => 'LEGACY|ENABLED',
        'ReadAttributes' => ['<string>', ...],
        'RefreshTokenValidity' => <integer>,
        'SupportedIdentityProviders' => ['<string>', ...],
        'TokenValidityUnits' => [
            'AccessToken' => 'seconds|minutes|hours|days',
            'IdToken' => 'seconds|minutes|hours|days',
            'RefreshToken' => 'seconds|minutes|hours|days',
        ],
        'UserPoolId' => '<string>',
        'WriteAttributes' => ['<string>', ...],
    ],
]

Result Details

Members

UserPoolClient

Type: UserPoolClientType structure

The user pool client that was just created.

Errors

InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
LimitExceededException:
This exception is thrown when a user exceeds the limit for a requested Amazon Web Services resource.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
ScopeDoesNotExistException:
This exception is thrown when the specified scope doesn't exist.
InvalidOAuthFlowException:
This exception is thrown when the specified OAuth flow is not valid.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

CreateUserPoolDomain

$result = $client->createUserPoolDomain([/* ... */]);
$promise = $client->createUserPoolDomainAsync([/* ... */]);

Creates a new domain for a user pool.

Parameter Syntax

$result = $client->createUserPoolDomain([
    'CustomDomainConfig' => [
        'CertificateArn' => '<string>', // REQUIRED
    ],
    'Domain' => '<string>', // REQUIRED
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

CustomDomainConfig

Type: CustomDomainConfigType structure

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.

Domain

Required: Yes
Type: string

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.

UserPoolId

Required: Yes
Type: string

The user pool ID.

Result Syntax

[
    'CloudFrontDomain' => '<string>',
]

Result Details

Members

CloudFrontDomain

Type: string

The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.

Errors

InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
LimitExceededException:
This exception is thrown when a user exceeds the limit for a requested Amazon Web Services resource.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

DeleteGroup

$result = $client->deleteGroup([/* ... */]);
$promise = $client->deleteGroupAsync([/* ... */]);

Deletes a group.

Calling this action requires developer credentials.

Parameter Syntax

$result = $client->deleteGroup([
    'GroupName' => '<string>', // REQUIRED
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

GroupName

Required: Yes
Type: string

The name of the group.

UserPoolId

Required: Yes
Type: string

The user pool ID for the user pool.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

DeleteIdentityProvider

$result = $client->deleteIdentityProvider([/* ... */]);
$promise = $client->deleteIdentityProviderAsync([/* ... */]);

Deletes an IdP for a user pool.

Parameter Syntax

$result = $client->deleteIdentityProvider([
    'ProviderName' => '<string>', // REQUIRED
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ProviderName

Required: Yes
Type: string

The IdP name.

UserPoolId

Required: Yes
Type: string

The user pool ID.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
UnsupportedIdentityProviderException:
This exception is thrown when the specified identifier isn't supported.
ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

DeleteResourceServer

$result = $client->deleteResourceServer([/* ... */]);
$promise = $client->deleteResourceServerAsync([/* ... */]);

Deletes a resource server.

Parameter Syntax

$result = $client->deleteResourceServer([
    'Identifier' => '<string>', // REQUIRED
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

Identifier

Required: Yes
Type: string

The identifier for the resource server.

UserPoolId

Required: Yes
Type: string

The user pool ID for the user pool that hosts the resource server.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

DeleteUser

$result = $client->deleteUser([/* ... */]);
$promise = $client->deleteUserAsync([/* ... */]);

Allows a user to delete himself or herself.

Parameter Syntax

$result = $client->deleteUser([
    'AccessToken' => '<string>', // REQUIRED
]);

Parameter Details

Members

AccessToken

Required: Yes
Type: string

A valid access token that Amazon Cognito issued to the user whose user profile you want to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
PasswordResetRequiredException:
This exception is thrown when a password reset is required.
UserNotFoundException:
This exception is thrown when a user isn't found.
UserNotConfirmedException:
This exception is thrown when a user isn't confirmed successfully.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.
ForbiddenException:
This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.

DeleteUserAttributes

$result = $client->deleteUserAttributes([/* ... */]);
$promise = $client->deleteUserAttributesAsync([/* ... */]);

Deletes the attributes for a user.

Parameter Syntax

$result = $client->deleteUserAttributes([
    'AccessToken' => '<string>', // REQUIRED
    'UserAttributeNames' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

AccessToken

Required: Yes
Type: string

A valid access token that Amazon Cognito issued to the user whose attributes you want to delete.

UserAttributeNames

Required: Yes
Type: Array of strings

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
PasswordResetRequiredException:
This exception is thrown when a password reset is required.
UserNotFoundException:
This exception is thrown when a user isn't found.
UserNotConfirmedException:
This exception is thrown when a user isn't confirmed successfully.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.
ForbiddenException:
This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.

DeleteUserPool

$result = $client->deleteUserPool([/* ... */]);
$promise = $client->deleteUserPoolAsync([/* ... */]);

Deletes the specified Amazon Cognito user pool.

Parameter Syntax

$result = $client->deleteUserPool([
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

UserPoolId

Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
UserImportInProgressException:
This exception is thrown when you're trying to modify a user pool while a user import job is in progress for that pool.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

DeleteUserPoolClient

$result = $client->deleteUserPoolClient([/* ... */]);
$promise = $client->deleteUserPoolClientAsync([/* ... */]);

Allows the developer to delete the user pool client.

Parameter Syntax

$result = $client->deleteUserPoolClient([
    'ClientId' => '<string>', // REQUIRED
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ClientId

Required: Yes
Type: string

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

UserPoolId

Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

DeleteUserPoolDomain

$result = $client->deleteUserPoolDomain([/* ... */]);
$promise = $client->deleteUserPoolDomainAsync([/* ... */]);

Deletes a domain for a user pool.

Parameter Syntax

$result = $client->deleteUserPoolDomain([
    'Domain' => '<string>', // REQUIRED
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

Domain

Required: Yes
Type: string

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.

UserPoolId

Required: Yes
Type: string

The user pool ID.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

NotAuthorizedException:
This exception is thrown when a user isn't authorized.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

DescribeIdentityProvider

$result = $client->describeIdentityProvider([/* ... */]);
$promise = $client->describeIdentityProviderAsync([/* ... */]);

Gets information about a specific IdP.

Parameter Syntax

$result = $client->describeIdentityProvider([
    'ProviderName' => '<string>', // REQUIRED
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ProviderName

Required: Yes
Type: string

The IdP name.

UserPoolId

Required: Yes
Type: string

The user pool ID.

Result Syntax

[
    'IdentityProvider' => [
        'AttributeMapping' => ['<string>', ...],
        'CreationDate' => <DateTime>,
        'IdpIdentifiers' => ['<string>', ...],
        'LastModifiedDate' => <DateTime>,
        'ProviderDetails' => ['<string>', ...],
        'ProviderName' => '<string>',
        'ProviderType' => 'SAML|Facebook|Google|LoginWithAmazon|SignInWithApple|OIDC',
        'UserPoolId' => '<string>',
    ],
]

Result Details

Members

IdentityProvider

Required: Yes
Type: IdentityProviderType structure

The IdP that was deleted.

Errors

InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

DescribeResourceServer

$result = $client->describeResourceServer([/* ... */]);
$promise = $client->describeResourceServerAsync([/* ... */]);

Describes a resource server.

Parameter Syntax

$result = $client->describeResourceServer([
    'Identifier' => '<string>', // REQUIRED
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

Identifier

Required: Yes
Type: string

The identifier for the resource server

UserPoolId

Required: Yes
Type: string

The user pool ID for the user pool that hosts the resource server.

Result Syntax

[
    'ResourceServer' => [
        'Identifier' => '<string>',
        'Name' => '<string>',
        'Scopes' => [
            [
                'ScopeDescription' => '<string>',
                'ScopeName' => '<string>',
            ],
            // ...
        ],
        'UserPoolId' => '<string>',
    ],
]

Result Details

Members

ResourceServer

Required: Yes
Type: ResourceServerType structure

The resource server.

Errors

InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

DescribeRiskConfiguration

$result = $client->describeRiskConfiguration([/* ... */]);
$promise = $client->describeRiskConfigurationAsync([/* ... */]);

Describes the risk configuration.

Parameter Syntax

$result = $client->describeRiskConfiguration([
    'ClientId' => '<string>',
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ClientId

Type: string

The app client ID.

UserPoolId

Required: Yes
Type: string

The user pool ID.

Result Syntax

[
    'RiskConfiguration' => [
        'AccountTakeoverRiskConfiguration' => [
            'Actions' => [
                'HighAction' => [
                    'EventAction' => 'BLOCK|MFA_IF_CONFIGURED|MFA_REQUIRED|NO_ACTION',
                    'Notify' => true || false,
                ],
                'LowAction' => [
                    'EventAction' => 'BLOCK|MFA_IF_CONFIGURED|MFA_REQUIRED|NO_ACTION',
                    'Notify' => true || false,
                ],
                'MediumAction' => [
                    'EventAction' => 'BLOCK|MFA_IF_CONFIGURED|MFA_REQUIRED|NO_ACTION',
                    'Notify' => true || false,
                ],
            ],
            'NotifyConfiguration' => [
                'BlockEmail' => [
                    'HtmlBody' => '<string>',
                    'Subject' => '<string>',
                    'TextBody' => '<string>',
                ],
                'From' => '<string>',
                'MfaEmail' => [
                    'HtmlBody' => '<string>',
                    'Subject' => '<string>',
                    'TextBody' => '<string>',
                ],
                'NoActionEmail' => [
                    'HtmlBody' => '<string>',
                    'Subject' => '<string>',
                    'TextBody' => '<string>',
                ],
                'ReplyTo' => '<string>',
                'SourceArn' => '<string>',
            ],
        ],
        'ClientId' => '<string>',
        'CompromisedCredentialsRiskConfiguration' => [
            'Actions' => [
                'EventAction' => 'BLOCK|NO_ACTION',
            ],
            'EventFilter' => ['<string>', ...],
        ],
        'LastModifiedDate' => <DateTime>,
        'RiskExceptionConfiguration' => [
            'BlockedIPRangeList' => ['<string>', ...],
            'SkippedIPRangeList' => ['<string>', ...],
        ],
        'UserPoolId' => '<string>',
    ],
]

Result Details

Members

RiskConfiguration

Required: Yes
Type: RiskConfigurationType structure

The risk configuration.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
UserPoolAddOnNotEnabledException:
This exception is thrown when user pool add-ons aren't enabled.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

DescribeUserImportJob

$result = $client->describeUserImportJob([/* ... */]);
$promise = $client->describeUserImportJobAsync([/* ... */]);

Describes the user import job.

Parameter Syntax

$result = $client->describeUserImportJob([
    'JobId' => '<string>', // REQUIRED
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

JobId

Required: Yes
Type: string

The job ID for the user import job.

UserPoolId

Required: Yes
Type: string

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

Result Syntax

[
    'UserImportJob' => [
        'CloudWatchLogsRoleArn' => '<string>',
        'CompletionDate' => <DateTime>,
        'CompletionMessage' => '<string>',
        'CreationDate' => <DateTime>,
        'FailedUsers' => <integer>,
        'ImportedUsers' => <integer>,
        'JobId' => '<string>',
        'JobName' => '<string>',
        'PreSignedUrl' => '<string>',
        'SkippedUsers' => <integer>,
        'StartDate' => <DateTime>,
        'Status' => 'Created|Pending|InProgress|Stopping|Expired|Stopped|Failed|Succeeded',
        'UserPoolId' => '<string>',
    ],
]

Result Details

Members

UserImportJob

Type: UserImportJobType structure

The job object that represents the user import job.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

DescribeUserPool

$result = $client->describeUserPool([/* ... */]);
$promise = $client->describeUserPoolAsync([/* ... */]);

Returns the configuration information and metadata of the specified user pool.

Parameter Syntax

$result = $client->describeUserPool([
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

UserPoolId

Required: Yes
Type: string

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

Result Syntax

[
    'UserPool' => [
        'AccountRecoverySetting' => [
            'RecoveryMechanisms' => [
                [
                    'Name' => 'verified_email|verified_phone_number|admin_only',
                    'Priority' => <integer>,
                ],
                // ...
            ],
        ],
        'AdminCreateUserConfig' => [
            'AllowAdminCreateUserOnly' => true || false,
            'InviteMessageTemplate' => [
                'EmailMessage' => '<string>',
                'EmailSubject' => '<string>',
                'SMSMessage' => '<string>',
            ],
            'UnusedAccountValidityDays' => <integer>,
        ],
        'AliasAttributes' => ['<string>', ...],
        'Arn' => '<string>',
        'AutoVerifiedAttributes' => ['<string>', ...],
        'CreationDate' => <DateTime>,
        'CustomDomain' => '<string>',
        'DeviceConfiguration' => [
            'ChallengeRequiredOnNewDevice' => true || false,
            'DeviceOnlyRememberedOnUserPrompt' => true || false,
        ],
        'Domain' => '<string>',
        'EmailConfiguration' => [
            'ConfigurationSet' => '<string>',
            'EmailSendingAccount' => 'COGNITO_DEFAULT|DEVELOPER',
            'From' => '<string>',
            'ReplyToEmailAddress' => '<string>',
            'SourceArn' => '<string>',
        ],
        'EmailConfigurationFailure' => '<string>',
        'EmailVerificationMessage' => '<string>',
        'EmailVerificationSubject' => '<string>',
        'EstimatedNumberOfUsers' => <integer>,
        'Id' => '<string>',
        'LambdaConfig' => [
            'CreateAuthChallenge' => '<string>',
            'CustomEmailSender' => [
                'LambdaArn' => '<string>',
                'LambdaVersion' => 'V1_0',
            ],
            'CustomMessage' => '<string>',
            'CustomSMSSender' => [
                'LambdaArn' => '<string>',
                'LambdaVersion' => 'V1_0',
            ],
            'DefineAuthChallenge' => '<string>',
            'KMSKeyID' => '<string>',
            'PostAuthentication' => '<string>',
            'PostConfirmation' => '<string>',
            'PreAuthentication' => '<string>',
            'PreSignUp' => '<string>',
            'PreTokenGeneration' => '<string>',
            'UserMigration' => '<string>',
            'VerifyAuthChallengeResponse' => '<string>',
        ],
        'LastModifiedDate' => <DateTime>,
        'MfaConfiguration' => 'OFF|ON|OPTIONAL',
        'Name' => '<string>',
        'Policies' => [
            'PasswordPolicy' => [
                'MinimumLength' => <integer>,
                'RequireLowercase' => true || false,
                'RequireNumbers' => true || false,
                'RequireSymbols' => true || false,
                'RequireUppercase' => true || false,
                'TemporaryPasswordValidityDays' => <integer>,
            ],
        ],
        'SchemaAttributes' => [
            [
                'AttributeDataType' => 'String|Number|DateTime|Boolean',
                'DeveloperOnlyAttribute' => true || false,
                'Mutable' => true || false,
                'Name' => '<string>',
                'NumberAttributeConstraints' => [
                    'MaxValue' => '<string>',
                    'MinValue' => '<string>',
                ],
                'Required' => true || false,
                'StringAttributeConstraints' => [
                    'MaxLength' => '<string>',
                    'MinLength' => '<string>',
                ],
            ],
            // ...
        ],
        'SmsAuthenticationMessage' => '<string>',
        'SmsConfiguration' => [
            'ExternalId' => '<string>',
            'SnsCallerArn' => '<string>',
            'SnsRegion' => '<string>',
        ],
        'SmsConfigurationFailure' => '<string>',
        'SmsVerificationMessage' => '<string>',
        'Status' => 'Enabled|Disabled',
        'UserAttributeUpdateSettings' => [
            'AttributesRequireVerificationBeforeUpdate' => ['<string>', ...],
        ],
        'UserPoolAddOns' => [
            'AdvancedSecurityMode' => 'OFF|AUDIT|ENFORCED',
        ],
        'UserPoolTags' => ['<string>', ...],
        'UsernameAttributes' => ['<string>', ...],
        'UsernameConfiguration' => [
            'CaseSensitive' => true || false,
        ],
        'VerificationMessageTemplate' => [
            'DefaultEmailOption' => 'CONFIRM_WITH_LINK|CONFIRM_WITH_CODE',
            'EmailMessage' => '<string>',
            'EmailMessageByLink' => '<string>',
            'EmailSubject' => '<string>',
            'EmailSubjectByLink' => '<string>',
            'SmsMessage' => '<string>',
        ],
    ],
]

Result Details

Members

UserPool

Type: UserPoolType structure

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

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
UserPoolTaggingException:
This exception is thrown when a user pool tag can't be set or updated.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

DescribeUserPoolClient

$result = $client->describeUserPoolClient([/* ... */]);
$promise = $client->describeUserPoolClientAsync([/* ... */]);

Client method for returning the configuration information and metadata of the specified user pool app client.

Parameter Syntax

$result = $client->describeUserPoolClient([
    'ClientId' => '<string>', // REQUIRED
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ClientId

Required: Yes
Type: string

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

UserPoolId

Required: Yes
Type: string

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

Result Syntax

[
    'UserPoolClient' => [
        'AccessTokenValidity' => <integer>,
        'AllowedOAuthFlows' => ['<string>', ...],
        'AllowedOAuthFlowsUserPoolClient' => true || false,
        'AllowedOAuthScopes' => ['<string>', ...],
        'AnalyticsConfiguration' => [
            'ApplicationArn' => '<string>',
            'ApplicationId' => '<string>',
            'ExternalId' => '<string>',
            'RoleArn' => '<string>',
            'UserDataShared' => true || false,
        ],
        'CallbackURLs' => ['<string>', ...],
        'ClientId' => '<string>',
        'ClientName' => '<string>',
        'ClientSecret' => '<string>',
        'CreationDate' => <DateTime>,
        'DefaultRedirectURI' => '<string>',
        'EnablePropagateAdditionalUserContextData' => true || false,
        'EnableTokenRevocation' => true || false,
        'ExplicitAuthFlows' => ['<string>', ...],
        'IdTokenValidity' => <integer>,
        'LastModifiedDate' => <DateTime>,
        'LogoutURLs' => ['<string>', ...],
        'PreventUserExistenceErrors' => 'LEGACY|ENABLED',
        'ReadAttributes' => ['<string>', ...],
        'RefreshTokenValidity' => <integer>,
        'SupportedIdentityProviders' => ['<string>', ...],
        'TokenValidityUnits' => [
            'AccessToken' => 'seconds|minutes|hours|days',
            'IdToken' => 'seconds|minutes|hours|days',
            'RefreshToken' => 'seconds|minutes|hours|days',
        ],
        'UserPoolId' => '<string>',
        'WriteAttributes' => ['<string>', ...],
    ],
]

Result Details

Members

UserPoolClient

Type: UserPoolClientType structure

The user pool client from a server response to describe the user pool client.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

DescribeUserPoolDomain

$result = $client->describeUserPoolDomain([/* ... */]);
$promise = $client->describeUserPoolDomainAsync([/* ... */]);

Gets information about a domain.

Parameter Syntax

$result = $client->describeUserPoolDomain([
    'Domain' => '<string>', // REQUIRED
]);

Parameter Details

Members

Domain

Required: Yes
Type: string

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.

Result Syntax

[
    'DomainDescription' => [
        'AWSAccountId' => '<string>',
        'CloudFrontDistribution' => '<string>',
        'CustomDomainConfig' => [
            'CertificateArn' => '<string>',
        ],
        'Domain' => '<string>',
        'S3Bucket' => '<string>',
        'Status' => 'CREATING|DELETING|UPDATING|ACTIVE|FAILED',
        'UserPoolId' => '<string>',
        'Version' => '<string>',
    ],
]

Result Details

Members

DomainDescription

Type: DomainDescriptionType structure

A domain description object containing information about the domain.

Errors

NotAuthorizedException:
This exception is thrown when a user isn't authorized.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

ForgetDevice

$result = $client->forgetDevice([/* ... */]);
$promise = $client->forgetDeviceAsync([/* ... */]);

Forgets the specified device.

Parameter Syntax

$result = $client->forgetDevice([
    'AccessToken' => '<string>',
    'DeviceKey' => '<string>', // REQUIRED
]);

Parameter Details

Members

AccessToken

Type: string

A valid access token that Amazon Cognito issued to the user whose registered device you want to forget.

DeviceKey

Required: Yes
Type: string

The device key.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
InvalidUserPoolConfigurationException:
This exception is thrown when the user pool configuration is not valid.
PasswordResetRequiredException:
This exception is thrown when a password reset is required.
UserNotFoundException:
This exception is thrown when a user isn't found.
UserNotConfirmedException:
This exception is thrown when a user isn't confirmed successfully.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.
ForbiddenException:
This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.

ForgotPassword

$result = $client->forgotPassword([/* ... */]);
$promise = $client->forgotPasswordAsync([/* ... */]);

Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password. For the Username parameter, you can use the username or user alias. The method used to send the confirmation code is sent according to the specified AccountRecoverySetting. For more information, see Recovering User Accounts in the Amazon Cognito Developer Guide. If neither a verified phone number nor a verified email exists, an InvalidParameterException is thrown. To use the confirmation code for resetting the password, call ConfirmForgotPassword.

Parameter Syntax

$result = $client->forgotPassword([
    'AnalyticsMetadata' => [
        'AnalyticsEndpointId' => '<string>',
    ],
    'ClientId' => '<string>', // REQUIRED
    'ClientMetadata' => ['<string>', ...],
    'SecretHash' => '<string>',
    'UserContextData' => [
        'EncodedData' => '<string>',
        'IpAddress' => '<string>',
    ],
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members

AnalyticsMetadata

Type: AnalyticsMetadataType structure

The Amazon Pinpoint analytics metadata that contributes to your metrics for ForgotPassword calls.

ClientId

Required: Yes
Type: string

The ID of the client associated with the user pool.

ClientMetadata

Type: Associative array of custom strings keys (StringType) to strings

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.

SecretHash

Type: string

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.

UserContextData

Type: UserContextDataType structure

Username

Required: Yes
Type: string

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

Result Syntax

[
    'CodeDeliveryDetails' => [
        'AttributeName' => '<string>',
        'DeliveryMedium' => 'SMS|EMAIL',
        'Destination' => '<string>',
    ],
]

Result Details

Members

CodeDeliveryDetails

Type: CodeDeliveryDetailsType structure

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

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
UnexpectedLambdaException:
This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.
UserLambdaValidationException:
This exception is thrown when the Amazon Cognito service encounters a user validation exception with the Lambda service.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
InvalidLambdaResponseException:
This exception is thrown when Amazon Cognito encounters an invalid Lambda response.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
LimitExceededException:
This exception is thrown when a user exceeds the limit for a requested Amazon Web Services resource.
InvalidSmsRoleAccessPolicyException:
This exception is returned when the role provided for SMS configuration doesn't have permission to publish using Amazon SNS.
InvalidSmsRoleTrustRelationshipException:
This exception is thrown when the trust relationship is not valid for the role provided for SMS configuration. This can happen if you don't trust cognito-idp.amazonaws.com or the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.
InvalidEmailRoleAccessPolicyException:
This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP status code: 400.
CodeDeliveryFailureException:
This exception is thrown when a verification code fails to deliver successfully.
UserNotFoundException:
This exception is thrown when a user isn't found.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.
ForbiddenException:
This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.

GetCSVHeader

$result = $client->getCSVHeader([/* ... */]);
$promise = $client->getCSVHeaderAsync([/* ... */]);

Gets the header information for the comma-separated value (CSV) file to be used as input for the user import job.

Parameter Syntax

$result = $client->getCSVHeader([
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

UserPoolId

Required: Yes
Type: string

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

Result Syntax

[
    'CSVHeader' => ['<string>', ...],
    'UserPoolId' => '<string>',
]

Result Details

Members

CSVHeader

Type: Array of strings

The header information of the CSV file for the user import job.

UserPoolId

Type: string

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

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

GetDevice

$result = $client->getDevice([/* ... */]);
$promise = $client->getDeviceAsync([/* ... */]);

Gets the device.

Parameter Syntax

$result = $client->getDevice([
    'AccessToken' => '<string>',
    'DeviceKey' => '<string>', // REQUIRED
]);

Parameter Details

Members

AccessToken

Type: string

A valid access token that Amazon Cognito issued to the user whose device information you want to request.

DeviceKey

Required: Yes
Type: string

The device key.

Result Syntax

[
    'Device' => [
        'DeviceAttributes' => [
            [
                'Name' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'DeviceCreateDate' => <DateTime>,
        'DeviceKey' => '<string>',
        'DeviceLastAuthenticatedDate' => <DateTime>,
        'DeviceLastModifiedDate' => <DateTime>,
    ],
]

Result Details

Members

Device

Required: Yes
Type: DeviceType structure

The device.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
InvalidUserPoolConfigurationException:
This exception is thrown when the user pool configuration is not valid.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
PasswordResetRequiredException:
This exception is thrown when a password reset is required.
UserNotFoundException:
This exception is thrown when a user isn't found.
UserNotConfirmedException:
This exception is thrown when a user isn't confirmed successfully.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.
ForbiddenException:
This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.

GetGroup

$result = $client->getGroup([/* ... */]);
$promise = $client->getGroupAsync([/* ... */]);

Gets a group.

Calling this action requires developer credentials.

Parameter Syntax

$result = $client->getGroup([
    'GroupName' => '<string>', // REQUIRED
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

GroupName

Required: Yes
Type: string

The name of the group.

UserPoolId

Required: Yes
Type: string

The user pool ID for the user pool.

Result Syntax

[
    'Group' => [
        'CreationDate' => <DateTime>,
        'Description' => '<string>',
        'GroupName' => '<string>',
        'LastModifiedDate' => <DateTime>,
        'Precedence' => <integer>,
        'RoleArn' => '<string>',
        'UserPoolId' => '<string>',
    ],
]

Result Details

Members

Group

Type: GroupType structure

The group object for the group.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

GetIdentityProviderByIdentifier

$result = $client->getIdentityProviderByIdentifier([/* ... */]);
$promise = $client->getIdentityProviderByIdentifierAsync([/* ... */]);

Gets the specified IdP.

Parameter Syntax

$result = $client->getIdentityProviderByIdentifier([
    'IdpIdentifier' => '<string>', // REQUIRED
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

IdpIdentifier

Required: Yes
Type: string

The IdP identifier.

UserPoolId

Required: Yes
Type: string

The user pool ID.

Result Syntax

[
    'IdentityProvider' => [
        'AttributeMapping' => ['<string>', ...],
        'CreationDate' => <DateTime>,
        'IdpIdentifiers' => ['<string>', ...],
        'LastModifiedDate' => <DateTime>,
        'ProviderDetails' => ['<string>', ...],
        'ProviderName' => '<string>',
        'ProviderType' => 'SAML|Facebook|Google|LoginWithAmazon|SignInWithApple|OIDC',
        'UserPoolId' => '<string>',
    ],
]

Result Details

Members

IdentityProvider

Required: Yes
Type: IdentityProviderType structure

The IdP object.

Errors

InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

GetSigningCertificate

$result = $client->getSigningCertificate([/* ... */]);
$promise = $client->getSigningCertificateAsync([/* ... */]);

This method takes a user pool ID, and returns the signing certificate.

Parameter Syntax

$result = $client->getSigningCertificate([
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

UserPoolId

Required: Yes
Type: string

The user pool ID.

Result Syntax

[
    'Certificate' => '<string>',
]

Result Details

Members

Certificate

Type: string

The signing certificate.

Errors

InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.

GetUICustomization

$result = $client->getUICustomization([/* ... */]);
$promise = $client->getUICustomizationAsync([/* ... */]);

Gets the user interface (UI) Customization information for a particular app client's app UI, if any such information exists for the client. If nothing is set for the particular client, but there is an existing pool level customization (the app clientId is ALL), then that information is returned. If nothing is present, then an empty shape is returned.

Parameter Syntax

$result = $client->getUICustomization([
    'ClientId' => '<string>',
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ClientId

Type: string

The client ID for the client app.

UserPoolId

Required: Yes
Type: string

The user pool ID for the user pool.

Result Syntax

[
    'UICustomization' => [
        'CSS' => '<string>',
        'CSSVersion' => '<string>',
        'ClientId' => '<string>',
        'CreationDate' => <DateTime>,
        'ImageUrl' => '<string>',
        'LastModifiedDate' => <DateTime>,
        'UserPoolId' => '<string>',
    ],
]

Result Details

Members

UICustomization

Required: Yes
Type: UICustomizationType structure

The UI customization information.

Errors

InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

GetUser

$result = $client->getUser([/* ... */]);
$promise = $client->getUserAsync([/* ... */]);

Gets the user attributes and metadata for a user.

Parameter Syntax

$result = $client->getUser([
    'AccessToken' => '<string>', // REQUIRED
]);

Parameter Details

Members

AccessToken

Required: Yes
Type: string

A non-expired access token for the user whose information you want to query.

Result Syntax

[
    'MFAOptions' => [
        [
            'AttributeName' => '<string>',
            'DeliveryMedium' => 'SMS|EMAIL',
        ],
        // ...
    ],
    'PreferredMfaSetting' => '<string>',
    'UserAttributes' => [
        [
            'Name' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'UserMFASettingList' => ['<string>', ...],
    'Username' => '<string>',
]

Result Details

Members

MFAOptions

Type: Array of MFAOptionType structures

PreferredMfaSetting

Type: string

The user's preferred MFA setting.

UserAttributes

Required: Yes
Type: Array of AttributeType structures

An array of name-value pairs representing user attributes.

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

UserMFASettingList

Type: Array of strings

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

Username

Required: Yes
Type: string

The user name of the user you want to retrieve from the get user request.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
PasswordResetRequiredException:
This exception is thrown when a password reset is required.
UserNotFoundException:
This exception is thrown when a user isn't found.
UserNotConfirmedException:
This exception is thrown when a user isn't confirmed successfully.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.
ForbiddenException:
This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.

GetUserAttributeVerificationCode

$result = $client->getUserAttributeVerificationCode([/* ... */]);
$promise = $client->getUserAttributeVerificationCodeAsync([/* ... */]);

Generates a user attribute verification code for the specified attribute name. Sends a message to a user with a code that they must return in a VerifyUserAttribute request.

Parameter Syntax

$result = $client->getUserAttributeVerificationCode([
    'AccessToken' => '<string>', // REQUIRED
    'AttributeName' => '<string>', // REQUIRED
    'ClientMetadata' => ['<string>', ...],
]);

Parameter Details

Members

AccessToken

Required: Yes
Type: string

A non-expired access token for the user whose attribute verification code you want to generate.

AttributeName

Required: Yes
Type: string

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

ClientMetadata

Type: Associative array of custom strings keys (StringType) to strings

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.

Result Syntax

[
    'CodeDeliveryDetails' => [
        'AttributeName' => '<string>',
        'DeliveryMedium' => 'SMS|EMAIL',
        'Destination' => '<string>',
    ],
]

Result Details

Members

CodeDeliveryDetails

Type: CodeDeliveryDetailsType structure

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

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
UnexpectedLambdaException:
This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.
UserLambdaValidationException:
This exception is thrown when the Amazon Cognito service encounters a user validation exception with the Lambda service.
InvalidLambdaResponseException:
This exception is thrown when Amazon Cognito encounters an invalid Lambda response.
InvalidSmsRoleAccessPolicyException:
This exception is returned when the role provided for SMS configuration doesn't have permission to publish using Amazon SNS.
InvalidSmsRoleTrustRelationshipException:
This exception is thrown when the trust relationship is not valid for the role provided for SMS configuration. This can happen if you don't trust cognito-idp.amazonaws.com or the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.
InvalidEmailRoleAccessPolicyException:
This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP status code: 400.
CodeDeliveryFailureException:
This exception is thrown when a verification code fails to deliver successfully.
LimitExceededException:
This exception is thrown when a user exceeds the limit for a requested Amazon Web Services resource.
PasswordResetRequiredException:
This exception is thrown when a password reset is required.
UserNotFoundException:
This exception is thrown when a user isn't found.
UserNotConfirmedException:
This exception is thrown when a user isn't confirmed successfully.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.
ForbiddenException:
This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.

GetUserPoolMfaConfig

$result = $client->getUserPoolMfaConfig([/* ... */]);
$promise = $client->getUserPoolMfaConfigAsync([/* ... */]);

Gets the user pool multi-factor authentication (MFA) configuration.

Parameter Syntax

$result = $client->getUserPoolMfaConfig([
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

UserPoolId

Required: Yes
Type: string

The user pool ID.

Result Syntax

[
    'MfaConfiguration' => 'OFF|ON|OPTIONAL',
    'SmsMfaConfiguration' => [
        'SmsAuthenticationMessage' => '<string>',
        'SmsConfiguration' => [
            'ExternalId' => '<string>',
            'SnsCallerArn' => '<string>',
            'SnsRegion' => '<string>',
        ],
    ],
    'SoftwareTokenMfaConfiguration' => [
        'Enabled' => true || false,
    ],
]

Result Details

Members

MfaConfiguration

Type: string

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.

SmsMfaConfiguration

Type: SmsMfaConfigType structure

The SMS text message multi-factor authentication (MFA) configuration.

SoftwareTokenMfaConfiguration

Type: SoftwareTokenMfaConfigType structure

The software token multi-factor authentication (MFA) configuration.

Errors

InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

GlobalSignOut

$result = $client->globalSignOut([/* ... */]);
$promise = $client->globalSignOutAsync([/* ... */]);

Signs out users from all devices. It also invalidates all refresh tokens that Amazon Cognito has issued to a user. The user's current access and ID tokens remain valid until their expiry. By default, access and ID tokens expire one hour after Amazon Cognito issues them. A user can still use a hosted UI cookie to retrieve new tokens for the duration of the cookie validity period of 1 hour.

Parameter Syntax

$result = $client->globalSignOut([
    'AccessToken' => '<string>', // REQUIRED
]);

Parameter Details

Members

AccessToken

Required: Yes
Type: string

A valid access token that Amazon Cognito issued to the user who you want to sign out.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
PasswordResetRequiredException:
This exception is thrown when a password reset is required.
UserNotConfirmedException:
This exception is thrown when a user isn't confirmed successfully.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.
ForbiddenException:
This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.

InitiateAuth

$result = $client->initiateAuth([/* ... */]);
$promise = $client->initiateAuthAsync([/* ... */]);

Initiates sign-in for a user in the Amazon Cognito user directory. You can't sign in a user with a federated IdP with InitiateAuth. For more information, see Adding user pool sign-in through a third party.

Parameter Syntax

$result = $client->initiateAuth([
    'AnalyticsMetadata' => [
        'AnalyticsEndpointId' => '<string>',
    ],
    'AuthFlow' => 'USER_SRP_AUTH|REFRESH_TOKEN_AUTH|REFRESH_TOKEN|CUSTOM_AUTH|ADMIN_NO_SRP_AUTH|USER_PASSWORD_AUTH|ADMIN_USER_PASSWORD_AUTH', // REQUIRED
    'AuthParameters' => ['<string>', ...],
    'ClientId' => '<string>', // REQUIRED
    'ClientMetadata' => ['<string>', ...],
    'UserContextData' => [
        'EncodedData' => '<string>',
        'IpAddress' => '<string>',
    ],
]);

Parameter Details

Members

AnalyticsMetadata

Type: AnalyticsMetadataType structure

The Amazon Pinpoint analytics metadata that contributes to your metrics for InitiateAuth calls.

AuthFlow

Required: Yes
Type: string

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.

AuthParameters

Type: Associative array of custom strings keys (StringType) to strings

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

ClientId

Required: Yes
Type: string

The app client ID.

ClientMetadata

Type: Associative array of custom strings keys (StringType) to strings

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.

UserContextData

Type: UserContextDataType structure

Result Syntax

[
    'AuthenticationResult' => [
        'AccessToken' => '<string>',
        'ExpiresIn' => <integer>,
        'IdToken' => '<string>',
        'NewDeviceMetadata' => [
            'DeviceGroupKey' => '<string>',
            'DeviceKey' => '<string>',
        ],
        'RefreshToken' => '<string>',
        'TokenType' => '<string>',
    ],
    'ChallengeName' => 'SMS_MFA|SOFTWARE_TOKEN_MFA|SELECT_MFA_TYPE|MFA_SETUP|PASSWORD_VERIFIER|CUSTOM_CHALLENGE|DEVICE_SRP_AUTH|DEVICE_PASSWORD_VERIFIER|ADMIN_NO_SRP_AUTH|NEW_PASSWORD_REQUIRED',
    'ChallengeParameters' => ['<string>', ...],
    'Session' => '<string>',
]

Result Details

Members

AuthenticationResult

Type: AuthenticationResultType structure

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.

ChallengeName

Type: string

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.

ChallengeParameters

Type: Associative array of custom strings keys (StringType) to strings

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

Session

Type: string

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.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
UnexpectedLambdaException:
This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.
InvalidUserPoolConfigurationException:
This exception is thrown when the user pool configuration is not valid.
UserLambdaValidationException:
This exception is thrown when the Amazon Cognito service encounters a user validation exception with the Lambda service.
InvalidLambdaResponseException:
This exception is thrown when Amazon Cognito encounters an invalid Lambda response.
PasswordResetRequiredException:
This exception is thrown when a password reset is required.
UserNotFoundException:
This exception is thrown when a user isn't found.
UserNotConfirmedException:
This exception is thrown when a user isn't confirmed successfully.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.
InvalidSmsRoleAccessPolicyException:
This exception is returned when the role provided for SMS configuration doesn't have permission to publish using Amazon SNS.
InvalidSmsRoleTrustRelationshipException:
This exception is thrown when the trust relationship is not valid for the role provided for SMS configuration. This can happen if you don't trust cognito-idp.amazonaws.com or the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.
ForbiddenException:
This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.

ListDevices

$result = $client->listDevices([/* ... */]);
$promise = $client->listDevicesAsync([/* ... */]);

Lists the sign-in devices that Amazon Cognito has registered to the current user.

Parameter Syntax

$result = $client->listDevices([
    'AccessToken' => '<string>', // REQUIRED
    'Limit' => <integer>,
    'PaginationToken' => '<string>',
]);

Parameter Details

Members

AccessToken

Required: Yes
Type: string

A valid access token that Amazon Cognito issued to the user whose list of devices you want to view.

Limit

Type: int

The limit of the device request.

PaginationToken

Type: string

The pagination token for the list request.

Result Syntax

[
    'Devices' => [
        [
            'DeviceAttributes' => [
                [
                    'Name' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'DeviceCreateDate' => <DateTime>,
            'DeviceKey' => '<string>',
            'DeviceLastAuthenticatedDate' => <DateTime>,
            'DeviceLastModifiedDate' => <DateTime>,
        ],
        // ...
    ],
    'PaginationToken' => '<string>',
]

Result Details

Members

Devices

Type: Array of DeviceType structures

The devices returned in the list devices response.

PaginationToken

Type: string

The pagination token for the list device response.

Errors

InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
InvalidUserPoolConfigurationException:
This exception is thrown when the user pool configuration is not valid.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
PasswordResetRequiredException:
This exception is thrown when a password reset is required.
UserNotFoundException:
This exception is thrown when a user isn't found.
UserNotConfirmedException:
This exception is thrown when a user isn't confirmed successfully.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.
ForbiddenException:
This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.

ListGroups

$result = $client->listGroups([/* ... */]);
$promise = $client->listGroupsAsync([/* ... */]);

Lists the groups associated with a user pool.

Calling this action requires developer credentials.

Parameter Syntax

$result = $client->listGroups([
    'Limit' => <integer>,
    'NextToken' => '<string>',
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

Limit

Type: int

The limit of the request to list groups.

NextToken

Type: string

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.

UserPoolId

Required: Yes
Type: string

The user pool ID for the user pool.

Result Syntax

[
    'Groups' => [
        [
            'CreationDate' => <DateTime>,
            'Description' => '<string>',
            'GroupName' => '<string>',
            'LastModifiedDate' => <DateTime>,
            'Precedence' => <integer>,
            'RoleArn' => '<string>',
            'UserPoolId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Groups

Type: Array of GroupType structures

The group objects for the groups.

NextToken

Type: string

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.

Errors

InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

ListIdentityProviders

$result = $client->listIdentityProviders([/* ... */]);
$promise = $client->listIdentityProvidersAsync([/* ... */]);

Lists information about all IdPs for a user pool.

Parameter Syntax

$result = $client->listIdentityProviders([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of IdPs to return.

NextToken

Type: string

A pagination token.

UserPoolId

Required: Yes
Type: string

The user pool ID.

Result Syntax

[
    'NextToken' => '<string>',
    'Providers' => [
        [
            'CreationDate' => <DateTime>,
            'LastModifiedDate' => <DateTime>,
            'ProviderName' => '<string>',
            'ProviderType' => 'SAML|Facebook|Google|LoginWithAmazon|SignInWithApple|OIDC',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

A pagination token.

Providers

Required: Yes
Type: Array of ProviderDescription structures

A list of IdP objects.

Errors

InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

ListResourceServers

$result = $client->listResourceServers([/* ... */]);
$promise = $client->listResourceServersAsync([/* ... */]);

Lists the resource servers for a user pool.

Parameter Syntax

$result = $client->listResourceServers([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of resource servers to return.

NextToken

Type: string

A pagination token.

UserPoolId

Required: Yes
Type: string

The user pool ID for the user pool.

Result Syntax

[
    'NextToken' => '<string>',
    'ResourceServers' => [
        [
            'Identifier' => '<string>',
            'Name' => '<string>',
            'Scopes' => [
                [
                    'ScopeDescription' => '<string>',
                    'ScopeName' => '<string>',
                ],
                // ...
            ],
            'UserPoolId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

A pagination token.

ResourceServers

Required: Yes
Type: Array of ResourceServerType structures

The resource servers.

Errors

InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists the tags that are assigned to an Amazon Cognito 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.

You can use this action up to 10 times per second, per account.

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

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

Result Syntax

[
    'Tags' => ['<string>', ...],
]

Result Details

Members

Tags

Type: Associative array of custom strings keys (TagKeysType) to strings

The tags that are assigned to the user pool.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

ListUserImportJobs

$result = $client->listUserImportJobs([/* ... */]);
$promise = $client->listUserImportJobsAsync([/* ... */]);

Lists the user import jobs.

Parameter Syntax

$result = $client->listUserImportJobs([
    'MaxResults' => <integer>, // REQUIRED
    'PaginationToken' => '<string>',
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

MaxResults

Required: Yes
Type: int

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

PaginationToken

Type: string

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.

UserPoolId

Required: Yes
Type: string

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

Result Syntax

[
    'PaginationToken' => '<string>',
    'UserImportJobs' => [
        [
            'CloudWatchLogsRoleArn' => '<string>',
            'CompletionDate' => <DateTime>,
            'CompletionMessage' => '<string>',
            'CreationDate' => <DateTime>,
            'FailedUsers' => <integer>,
            'ImportedUsers' => <integer>,
            'JobId' => '<string>',
            'JobName' => '<string>',
            'PreSignedUrl' => '<string>',
            'SkippedUsers' => <integer>,
            'StartDate' => <DateTime>,
            'Status' => 'Created|Pending|InProgress|Stopping|Expired|Stopped|Failed|Succeeded',
            'UserPoolId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

PaginationToken

Type: string

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

UserImportJobs

Type: Array of UserImportJobType structures

The user import jobs.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

ListUserPoolClients

$result = $client->listUserPoolClients([/* ... */]);
$promise = $client->listUserPoolClientsAsync([/* ... */]);

Lists the clients that have been created for the specified user pool.

Parameter Syntax

$result = $client->listUserPoolClients([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of results you want the request to return when listing the user pool clients.

NextToken

Type: string

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.

UserPoolId

Required: Yes
Type: string

The user pool ID for the user pool where you want to list user pool clients.

Result Syntax

[
    'NextToken' => '<string>',
    'UserPoolClients' => [
        [
            'ClientId' => '<string>',
            'ClientName' => '<string>',
            'UserPoolId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

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.

UserPoolClients

Type: Array of UserPoolClientDescription structures

The user pool clients in the response that lists user pool clients.

Errors

InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

ListUserPools

$result = $client->listUserPools([/* ... */]);
$promise = $client->listUserPoolsAsync([/* ... */]);

Lists the user pools associated with an Amazon Web Services account.

Parameter Syntax

$result = $client->listUserPools([
    'MaxResults' => <integer>, // REQUIRED
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Required: Yes
Type: int

The maximum number of results you want the request to return when listing the user pools.

NextToken

Type: string

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.

Result Syntax

[
    'NextToken' => '<string>',
    'UserPools' => [
        [
            'CreationDate' => <DateTime>,
            'Id' => '<string>',
            'LambdaConfig' => [
                'CreateAuthChallenge' => '<string>',
                'CustomEmailSender' => [
                    'LambdaArn' => '<string>',
                    'LambdaVersion' => 'V1_0',
                ],
                'CustomMessage' => '<string>',
                'CustomSMSSender' => [
                    'LambdaArn' => '<string>',
                    'LambdaVersion' => 'V1_0',
                ],
                'DefineAuthChallenge' => '<string>',
                'KMSKeyID' => '<string>',
                'PostAuthentication' => '<string>',
                'PostConfirmation' => '<string>',
                'PreAuthentication' => '<string>',
                'PreSignUp' => '<string>',
                'PreTokenGeneration' => '<string>',
                'UserMigration' => '<string>',
                'VerifyAuthChallengeResponse' => '<string>',
            ],
            'LastModifiedDate' => <DateTime>,
            'Name' => '<string>',
            'Status' => 'Enabled|Disabled',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

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.

UserPools

Type: Array of UserPoolDescriptionType structures

The user pools from the response to list users.

Errors

InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

ListUsers

$result = $client->listUsers([/* ... */]);
$promise = $client->listUsersAsync([/* ... */]);

Lists the users in the Amazon Cognito user pool.

Parameter Syntax

$result = $client->listUsers([
    'AttributesToGet' => ['<string>', ...],
    'Filter' => '<string>',
    'Limit' => <integer>,
    'PaginationToken' => '<string>',
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

AttributesToGet

Type: Array of strings

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.

Filter

Type: string

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.

Limit

Type: int

Maximum number of users to be returned.

PaginationToken

Type: string

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.

UserPoolId

Required: Yes
Type: string

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

Result Syntax

[
    'PaginationToken' => '<string>',
    'Users' => [
        [
            'Attributes' => [
                [
                    'Name' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'Enabled' => true || false,
            'MFAOptions' => [
                [
                    'AttributeName' => '<string>',
                    'DeliveryMedium' => 'SMS|EMAIL',
                ],
                // ...
            ],
            'UserCreateDate' => <DateTime>,
            'UserLastModifiedDate' => <DateTime>,
            'UserStatus' => 'UNCONFIRMED|CONFIRMED|ARCHIVED|COMPROMISED|UNKNOWN|RESET_REQUIRED|FORCE_CHANGE_PASSWORD',
            'Username' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

PaginationToken

Type: string

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.

Users

Type: Array of UserType structures

The users returned in the request to list users.

Errors

InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

ListUsersInGroup

$result = $client->listUsersInGroup([/* ... */]);
$promise = $client->listUsersInGroupAsync([/* ... */]);

Lists the users in the specified group.

Calling this action requires developer credentials.

Parameter Syntax

$result = $client->listUsersInGroup([
    'GroupName' => '<string>', // REQUIRED
    'Limit' => <integer>,
    'NextToken' => '<string>',
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

GroupName

Required: Yes
Type: string

The name of the group.

Limit

Type: int

The limit of the request to list users.

NextToken

Type: string

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.

UserPoolId

Required: Yes
Type: string

The user pool ID for the user pool.

Result Syntax

[
    'NextToken' => '<string>',
    'Users' => [
        [
            'Attributes' => [
                [
                    'Name' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'Enabled' => true || false,
            'MFAOptions' => [
                [
                    'AttributeName' => '<string>',
                    'DeliveryMedium' => 'SMS|EMAIL',
                ],
                // ...
            ],
            'UserCreateDate' => <DateTime>,
            'UserLastModifiedDate' => <DateTime>,
            'UserStatus' => 'UNCONFIRMED|CONFIRMED|ARCHIVED|COMPROMISED|UNKNOWN|RESET_REQUIRED|FORCE_CHANGE_PASSWORD',
            'Username' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

An identifier that you can use in a later request to return the next set of items in the list.

Users

Type: Array of UserType structures

The users returned in the request to list users.

Errors

InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

ResendConfirmationCode

$result = $client->resendConfirmationCode([/* ... */]);
$promise = $client->resendConfirmationCodeAsync([/* ... */]);

Resends the confirmation (for confirmation of registration) to a specific user in the user pool.

Parameter Syntax

$result = $client->resendConfirmationCode([
    'AnalyticsMetadata' => [
        'AnalyticsEndpointId' => '<string>',
    ],
    'ClientId' => '<string>', // REQUIRED
    'ClientMetadata' => ['<string>', ...],
    'SecretHash' => '<string>',
    'UserContextData' => [
        'EncodedData' => '<string>',
        'IpAddress' => '<string>',
    ],
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members

AnalyticsMetadata

Type: AnalyticsMetadataType structure

The Amazon Pinpoint analytics metadata that contributes to your metrics for ResendConfirmationCode calls.

ClientId

Required: Yes
Type: string

The ID of the client associated with the user pool.

ClientMetadata

Type: Associative array of custom strings keys (StringType) to strings

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.

SecretHash

Type: string

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.

UserContextData

Type: UserContextDataType structure

Username

Required: Yes
Type: string

The username attribute of the user to whom you want to resend a confirmation code.

Result Syntax

[
    'CodeDeliveryDetails' => [
        'AttributeName' => '<string>',
        'DeliveryMedium' => 'SMS|EMAIL',
        'Destination' => '<string>',
    ],
]

Result Details

Members

CodeDeliveryDetails

Type: CodeDeliveryDetailsType structure

The code delivery details returned by the server in response to the request to resend the confirmation code.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
UnexpectedLambdaException:
This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.
UserLambdaValidationException:
This exception is thrown when the Amazon Cognito service encounters a user validation exception with the Lambda service.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
InvalidLambdaResponseException:
This exception is thrown when Amazon Cognito encounters an invalid Lambda response.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
LimitExceededException:
This exception is thrown when a user exceeds the limit for a requested Amazon Web Services resource.
InvalidSmsRoleAccessPolicyException:
This exception is returned when the role provided for SMS configuration doesn't have permission to publish using Amazon SNS.
InvalidSmsRoleTrustRelationshipException:
This exception is thrown when the trust relationship is not valid for the role provided for SMS configuration. This can happen if you don't trust cognito-idp.amazonaws.com or the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.
InvalidEmailRoleAccessPolicyException:
This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP status code: 400.
CodeDeliveryFailureException:
This exception is thrown when a verification code fails to deliver successfully.
UserNotFoundException:
This exception is thrown when a user isn't found.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.
ForbiddenException:
This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.

RespondToAuthChallenge

$result = $client->respondToAuthChallenge([/* ... */]);
$promise = $client->respondToAuthChallengeAsync([/* ... */]);

Responds to the authentication challenge.

Parameter Syntax

$result = $client->respondToAuthChallenge([
    'AnalyticsMetadata' => [
        'AnalyticsEndpointId' => '<string>',
    ],
    'ChallengeName' => 'SMS_MFA|SOFTWARE_TOKEN_MFA|SELECT_MFA_TYPE|MFA_SETUP|PASSWORD_VERIFIER|CUSTOM_CHALLENGE|DEVICE_SRP_AUTH|DEVICE_PASSWORD_VERIFIER|ADMIN_NO_SRP_AUTH|NEW_PASSWORD_REQUIRED', // REQUIRED
    'ChallengeResponses' => ['<string>', ...],
    'ClientId' => '<string>', // REQUIRED
    'ClientMetadata' => ['<string>', ...],
    'Session' => '<string>',
    'UserContextData' => [
        'EncodedData' => '<string>',
        'IpAddress' => '<string>',
    ],
]);

Parameter Details

Members

AnalyticsMetadata

Type: AnalyticsMetadataType structure

The Amazon Pinpoint analytics metadata that contributes to your metrics for RespondToAuthChallenge calls.

ChallengeName

Required: Yes
Type: string

The challenge name. For more information, see InitiateAuth.

ADMIN_NO_SRP_AUTH isn't a valid value.

ChallengeResponses

Type: Associative array of custom strings keys (StringType) to strings

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.

ClientId

Required: Yes
Type: string

The app client ID.

ClientMetadata

Type: Associative array of custom strings keys (StringType) to strings

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.

Session

Type: string

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.

UserContextData

Type: UserContextDataType structure

Result Syntax

[
    'AuthenticationResult' => [
        'AccessToken' => '<string>',
        'ExpiresIn' => <integer>,
        'IdToken' => '<string>',
        'NewDeviceMetadata' => [
            'DeviceGroupKey' => '<string>',
            'DeviceKey' => '<string>',
        ],
        'RefreshToken' => '<string>',
        'TokenType' => '<string>',
    ],
    'ChallengeName' => 'SMS_MFA|SOFTWARE_TOKEN_MFA|SELECT_MFA_TYPE|MFA_SETUP|PASSWORD_VERIFIER|CUSTOM_CHALLENGE|DEVICE_SRP_AUTH|DEVICE_PASSWORD_VERIFIER|ADMIN_NO_SRP_AUTH|NEW_PASSWORD_REQUIRED',
    'ChallengeParameters' => ['<string>', ...],
    'Session' => '<string>',
]

Result Details

Members

AuthenticationResult

Type: AuthenticationResultType structure

The result returned by the server in response to the request to respond to the authentication challenge.

ChallengeName

Type: string

The challenge name. For more information, see InitiateAuth.

ChallengeParameters

Type: Associative array of custom strings keys (StringType) to strings

The challenge parameters. For more information, see InitiateAuth.

Session

Type: string

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
CodeMismatchException:
This exception is thrown if the provided code doesn't match what the server was expecting.
ExpiredCodeException:
This exception is thrown if a code has expired.
UnexpectedLambdaException:
This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.
UserLambdaValidationException:
This exception is thrown when the Amazon Cognito service encounters a user validation exception with the Lambda service.
InvalidPasswordException:
This exception is thrown when Amazon Cognito encounters an invalid password.
InvalidLambdaResponseException:
This exception is thrown when Amazon Cognito encounters an invalid Lambda response.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
InvalidUserPoolConfigurationException:
This exception is thrown when the user pool configuration is not valid.
MFAMethodNotFoundException:
This exception is thrown when Amazon Cognito can't find a multi-factor authentication (MFA) method.
PasswordResetRequiredException:
This exception is thrown when a password reset is required.
UserNotFoundException:
This exception is thrown when a user isn't found.
UserNotConfirmedException:
This exception is thrown when a user isn't confirmed successfully.
InvalidSmsRoleAccessPolicyException:
This exception is returned when the role provided for SMS configuration doesn't have permission to publish using Amazon SNS.
InvalidSmsRoleTrustRelationshipException:
This exception is thrown when the trust relationship is not valid for the role provided for SMS configuration. This can happen if you don't trust cognito-idp.amazonaws.com or the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.
AliasExistsException:
This exception is thrown when a user tries to confirm the account with an email address or phone number that has already been supplied as an alias for a different user profile. This exception indicates that an account with this email address or phone already exists in a user pool that you've configured to use email address or phone number as a sign-in alias.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.
SoftwareTokenMFANotFoundException:
This exception is thrown when the software token time-based one-time password (TOTP) multi-factor authentication (MFA) isn't activated for the user pool.
ForbiddenException:
This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.

RevokeToken

$result = $client->revokeToken([/* ... */]);
$promise = $client->revokeTokenAsync([/* ... */]);

Revokes all of the access tokens generated by the specified refresh token. After the token is revoked, you can't use the revoked token to access Amazon Cognito authenticated APIs.

Parameter Syntax

$result = $client->revokeToken([
    'ClientId' => '<string>', // REQUIRED
    'ClientSecret' => '<string>',
    'Token' => '<string>', // REQUIRED
]);

Parameter Details

Members

ClientId

Required: Yes
Type: string

The client ID for the token that you want to revoke.

ClientSecret

Type: string

The secret for the client ID. This is required only if the client ID has a secret.

Token

Required: Yes
Type: string

The refresh token that you want to revoke.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.
UnauthorizedException:
Exception that is thrown when the request isn't authorized. This can happen due to an invalid access token in the request.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
UnsupportedOperationException:
Exception that is thrown when you attempt to perform an operation that isn't enabled for the user pool client.
UnsupportedTokenTypeException:
Exception that is thrown when an unsupported token is passed to an operation.
ForbiddenException:
This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.

SetRiskConfiguration

$result = $client->setRiskConfiguration([/* ... */]);
$promise = $client->setRiskConfigurationAsync([/* ... */]);

Configures actions on detected risks. To delete the risk configuration for UserPoolId or ClientId, pass null values for all four configuration types.

To activate Amazon Cognito advanced security features, update the user pool to include the UserPoolAddOns keyAdvancedSecurityMode.

Parameter Syntax

$result = $client->setRiskConfiguration([
    'AccountTakeoverRiskConfiguration' => [
        'Actions' => [ // REQUIRED
            'HighAction' => [
                'EventAction' => 'BLOCK|MFA_IF_CONFIGURED|MFA_REQUIRED|NO_ACTION', // REQUIRED
                'Notify' => true || false, // REQUIRED
            ],
            'LowAction' => [
                'EventAction' => 'BLOCK|MFA_IF_CONFIGURED|MFA_REQUIRED|NO_ACTION', // REQUIRED
                'Notify' => true || false, // REQUIRED
            ],
            'MediumAction' => [
                'EventAction' => 'BLOCK|MFA_IF_CONFIGURED|MFA_REQUIRED|NO_ACTION', // REQUIRED
                'Notify' => true || false, // REQUIRED
            ],
        ],
        'NotifyConfiguration' => [
            'BlockEmail' => [
                'HtmlBody' => '<string>',
                'Subject' => '<string>', // REQUIRED
                'TextBody' => '<string>',
            ],
            'From' => '<string>',
            'MfaEmail' => [
                'HtmlBody' => '<string>',
                'Subject' => '<string>', // REQUIRED
                'TextBody' => '<string>',
            ],
            'NoActionEmail' => [
                'HtmlBody' => '<string>',
                'Subject' => '<string>', // REQUIRED
                'TextBody' => '<string>',
            ],
            'ReplyTo' => '<string>',
            'SourceArn' => '<string>', // REQUIRED
        ],
    ],
    'ClientId' => '<string>',
    'CompromisedCredentialsRiskConfiguration' => [
        'Actions' => [ // REQUIRED
            'EventAction' => 'BLOCK|NO_ACTION', // REQUIRED
        ],
        'EventFilter' => ['<string>', ...],
    ],
    'RiskExceptionConfiguration' => [
        'BlockedIPRangeList' => ['<string>', ...],
        'SkippedIPRangeList' => ['<string>', ...],
    ],
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

AccountTakeoverRiskConfiguration

Type: AccountTakeoverRiskConfigurationType structure

The account takeover risk configuration.

ClientId

Type: string

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.

CompromisedCredentialsRiskConfiguration

Type: CompromisedCredentialsRiskConfigurationType structure

The compromised credentials risk configuration.

RiskExceptionConfiguration

Type: RiskExceptionConfigurationType structure

The configuration to override the risk decision.

UserPoolId

Required: Yes
Type: string

The user pool ID.

Result Syntax

[
    'RiskConfiguration' => [
        'AccountTakeoverRiskConfiguration' => [
            'Actions' => [
                'HighAction' => [
                    'EventAction' => 'BLOCK|MFA_IF_CONFIGURED|MFA_REQUIRED|NO_ACTION',
                    'Notify' => true || false,
                ],
                'LowAction' => [
                    'EventAction' => 'BLOCK|MFA_IF_CONFIGURED|MFA_REQUIRED|NO_ACTION',
                    'Notify' => true || false,
                ],
                'MediumAction' => [
                    'EventAction' => 'BLOCK|MFA_IF_CONFIGURED|MFA_REQUIRED|NO_ACTION',
                    'Notify' => true || false,
                ],
            ],
            'NotifyConfiguration' => [
                'BlockEmail' => [
                    'HtmlBody' => '<string>',
                    'Subject' => '<string>',
                    'TextBody' => '<string>',
                ],
                'From' => '<string>',
                'MfaEmail' => [
                    'HtmlBody' => '<string>',
                    'Subject' => '<string>',
                    'TextBody' => '<string>',
                ],
                'NoActionEmail' => [
                    'HtmlBody' => '<string>',
                    'Subject' => '<string>',
                    'TextBody' => '<string>',
                ],
                'ReplyTo' => '<string>',
                'SourceArn' => '<string>',
            ],
        ],
        'ClientId' => '<string>',
        'CompromisedCredentialsRiskConfiguration' => [
            'Actions' => [
                'EventAction' => 'BLOCK|NO_ACTION',
            ],
            'EventFilter' => ['<string>', ...],
        ],
        'LastModifiedDate' => <DateTime>,
        'RiskExceptionConfiguration' => [
            'BlockedIPRangeList' => ['<string>', ...],
            'SkippedIPRangeList' => ['<string>', ...],
        ],
        'UserPoolId' => '<string>',
    ],
]

Result Details

Members

RiskConfiguration

Required: Yes
Type: RiskConfigurationType structure

The risk configuration.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
UserPoolAddOnNotEnabledException:
This exception is thrown when user pool add-ons aren't enabled.
CodeDeliveryFailureException:
This exception is thrown when a verification code fails to deliver successfully.
InvalidEmailRoleAccessPolicyException:
This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP status code: 400.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

SetUICustomization

$result = $client->setUICustomization([/* ... */]);
$promise = $client->setUICustomizationAsync([/* ... */]);

Sets the user interface (UI) customization information for a user pool's built-in app UI.

You can specify app UI customization settings for a single client (with a specific clientId) or for all clients (by setting the clientId to ALL). If you specify ALL, the default configuration is used for every client that has no previously set UI customization. If you specify UI customization settings for a particular client, it will no longer return to the ALL configuration.

To use this API, your user pool must have a domain associated with it. Otherwise, there is no place to host the app's pages, and the service will throw an error.

Parameter Syntax

$result = $client->setUICustomization([
    'CSS' => '<string>',
    'ClientId' => '<string>',
    'ImageFile' => <string || resource || Psr\Http\Message\StreamInterface>,
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

CSS

Type: string

The CSS values in the UI customization.

ClientId

Type: string

The client ID for the client app.

ImageFile

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The uploaded logo image for the UI customization.

UserPoolId

Required: Yes
Type: string

The user pool ID for the user pool.

Result Syntax

[
    'UICustomization' => [
        'CSS' => '<string>',
        'CSSVersion' => '<string>',
        'ClientId' => '<string>',
        'CreationDate' => <DateTime>,
        'ImageUrl' => '<string>',
        'LastModifiedDate' => <DateTime>,
        'UserPoolId' => '<string>',
    ],
]

Result Details

Members

UICustomization

Required: Yes
Type: UICustomizationType structure

The UI customization information.

Errors

InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

SetUserMFAPreference

$result = $client->setUserMFAPreference([/* ... */]);
$promise = $client->setUserMFAPreferenceAsync([/* ... */]);

Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are activated and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are activated. If multiple options are activated and no preference is set, a challenge to choose an MFA option will be returned during sign-in. 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. If you want MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate MFA for users and turn on Adaptive Authentication for the user pool.

Parameter Syntax

$result = $client->setUserMFAPreference([
    'AccessToken' => '<string>', // REQUIRED
    'SMSMfaSettings' => [
        'Enabled' => true || false,
        'PreferredMfa' => true || false,
    ],
    'SoftwareTokenMfaSettings' => [
        'Enabled' => true || false,
        'PreferredMfa' => true || false,
    ],
]);

Parameter Details

Members

AccessToken

Required: Yes
Type: string

A valid access token that Amazon Cognito issued to the user whose MFA preference you want to set.

SMSMfaSettings

Type: SMSMfaSettingsType structure

The SMS text message multi-factor authentication (MFA) settings.

SoftwareTokenMfaSettings

Type: SoftwareTokenMfaSettingsType structure

The time-based one-time password (TOTP) software token MFA settings.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
PasswordResetRequiredException:
This exception is thrown when a password reset is required.
UserNotFoundException:
This exception is thrown when a user isn't found.
UserNotConfirmedException:
This exception is thrown when a user isn't confirmed successfully.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.
ForbiddenException:
This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.

SetUserPoolMfaConfig

$result = $client->setUserPoolMfaConfig([/* ... */]);
$promise = $client->setUserPoolMfaConfigAsync([/* ... */]);

Sets the user pool multi-factor authentication (MFA) configuration.

Parameter Syntax

$result = $client->setUserPoolMfaConfig([
    'MfaConfiguration' => 'OFF|ON|OPTIONAL',
    'SmsMfaConfiguration' => [
        'SmsAuthenticationMessage' => '<string>',
        'SmsConfiguration' => [
            'ExternalId' => '<string>',
            'SnsCallerArn' => '<string>', // REQUIRED
            'SnsRegion' => '<string>',
        ],
    ],
    'SoftwareTokenMfaConfiguration' => [
        'Enabled' => true || false,
    ],
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

MfaConfiguration

Type: string

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.

SmsMfaConfiguration

Type: SmsMfaConfigType structure

The SMS text message MFA configuration.

SoftwareTokenMfaConfiguration

Type: SoftwareTokenMfaConfigType structure

The software token MFA configuration.

UserPoolId

Required: Yes
Type: string

The user pool ID.

Result Syntax

[
    'MfaConfiguration' => 'OFF|ON|OPTIONAL',
    'SmsMfaConfiguration' => [
        'SmsAuthenticationMessage' => '<string>',
        'SmsConfiguration' => [
            'ExternalId' => '<string>',
            'SnsCallerArn' => '<string>',
            'SnsRegion' => '<string>',
        ],
    ],
    'SoftwareTokenMfaConfiguration' => [
        'Enabled' => true || false,
    ],
]

Result Details

Members

MfaConfiguration

Type: string

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.

SmsMfaConfiguration

Type: SmsMfaConfigType structure

The SMS text message MFA configuration.

SoftwareTokenMfaConfiguration

Type: SoftwareTokenMfaConfigType structure

The software token MFA configuration.

Errors

InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidSmsRoleAccessPolicyException:
This exception is returned when the role provided for SMS configuration doesn't have permission to publish using Amazon SNS.
InvalidSmsRoleTrustRelationshipException:
This exception is thrown when the trust relationship is not valid for the role provided for SMS configuration. This can happen if you don't trust cognito-idp.amazonaws.com or the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

SetUserSettings

$result = $client->setUserSettings([/* ... */]);
$promise = $client->setUserSettingsAsync([/* ... */]);

Parameter Syntax

$result = $client->setUserSettings([
    'AccessToken' => '<string>', // REQUIRED
    'MFAOptions' => [ // REQUIRED
        [
            'AttributeName' => '<string>',
            'DeliveryMedium' => 'SMS|EMAIL',
        ],
        // ...
    ],
]);

Parameter Details

Members

AccessToken

Required: Yes
Type: string

A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.

MFAOptions

Required: Yes
Type: Array of MFAOptionType structures

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
PasswordResetRequiredException:
This exception is thrown when a password reset is required.
UserNotFoundException:
This exception is thrown when a user isn't found.
UserNotConfirmedException:
This exception is thrown when a user isn't confirmed successfully.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.
ForbiddenException:
This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.

$result = $client->signUp([/* ... */]);
$promise = $client->signUpAsync([/* ... */]);

Registers the user in the specified user pool and creates a user name, password, and user attributes.

Parameter Syntax

$result = $client->signUp([
    'AnalyticsMetadata' => [
        'AnalyticsEndpointId' => '<string>',
    ],
    'ClientId' => '<string>', // REQUIRED
    'ClientMetadata' => ['<string>', ...],
    'Password' => '<string>', // REQUIRED
    'SecretHash' => '<string>',
    'UserAttributes' => [
        [
            'Name' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'UserContextData' => [
        'EncodedData' => '<string>',
        'IpAddress' => '<string>',
    ],
    'Username' => '<string>', // REQUIRED
    'ValidationData' => [
        [
            'Name' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members

AnalyticsMetadata

Type: AnalyticsMetadataType structure

The Amazon Pinpoint analytics metadata that contributes to your metrics for SignUp calls.

ClientId

Required: Yes
Type: string

The ID of the client associated with the user pool.

ClientMetadata

Type: Associative array of custom strings keys (StringType) to strings

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.

Password

Required: Yes
Type: string

The password of the user you want to register.

SecretHash

Type: string

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.

UserAttributes

Type: Array of AttributeType structures

An array of name-value pairs representing user attributes.

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

UserContextData

Type: UserContextDataType structure

Username

Required: Yes
Type: string

The user name of the user you want to register.

ValidationData

Type: Array of AttributeType structures

The validation data in the request to register a user.

Result Syntax

[
    'CodeDeliveryDetails' => [
        'AttributeName' => '<string>',
        'DeliveryMedium' => 'SMS|EMAIL',
        'Destination' => '<string>',
    ],
    'UserConfirmed' => true || false,
    'UserSub' => '<string>',
]

Result Details

Members

CodeDeliveryDetails

Type: CodeDeliveryDetailsType structure

The code delivery details returned by the server response to the user registration request.

UserConfirmed

Required: Yes
Type: boolean

A response from the server indicating that a user registration has been confirmed.

UserSub

Required: Yes
Type: string

The UUID of the authenticated user. This isn't the same as username.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
UnexpectedLambdaException:
This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.
UserLambdaValidationException:
This exception is thrown when the Amazon Cognito service encounters a user validation exception with the Lambda service.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
InvalidPasswordException:
This exception is thrown when Amazon Cognito encounters an invalid password.
InvalidLambdaResponseException:
This exception is thrown when Amazon Cognito encounters an invalid Lambda response.
UsernameExistsException:
This exception is thrown when Amazon Cognito encounters a user name that already exists in the user pool.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.
InvalidSmsRoleAccessPolicyException:
This exception is returned when the role provided for SMS configuration doesn't have permission to publish using Amazon SNS.
InvalidSmsRoleTrustRelationshipException:
This exception is thrown when the trust relationship is not valid for the role provided for SMS configuration. This can happen if you don't trust cognito-idp.amazonaws.com or the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.
InvalidEmailRoleAccessPolicyException:
This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP status code: 400.
CodeDeliveryFailureException:
This exception is thrown when a verification code fails to deliver successfully.
ForbiddenException:
This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.

StartUserImportJob

$result = $client->startUserImportJob([/* ... */]);
$promise = $client->startUserImportJobAsync([/* ... */]);

Starts the user import.

Parameter Syntax

$result = $client->startUserImportJob([
    'JobId' => '<string>', // REQUIRED
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

JobId

Required: Yes
Type: string

The job ID for the user import job.

UserPoolId

Required: Yes
Type: string

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

Result Syntax

[
    'UserImportJob' => [
        'CloudWatchLogsRoleArn' => '<string>',
        'CompletionDate' => <DateTime>,
        'CompletionMessage' => '<string>',
        'CreationDate' => <DateTime>,
        'FailedUsers' => <integer>,
        'ImportedUsers' => <integer>,
        'JobId' => '<string>',
        'JobName' => '<string>',
        'PreSignedUrl' => '<string>',
        'SkippedUsers' => <integer>,
        'StartDate' => <DateTime>,
        'Status' => 'Created|Pending|InProgress|Stopping|Expired|Stopped|Failed|Succeeded',
        'UserPoolId' => '<string>',
    ],
]

Result Details

Members

UserImportJob

Type: UserImportJobType structure

The job object that represents the user import job.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.
PreconditionNotMetException:
This exception is thrown when a precondition is not met.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.

StopUserImportJob

$result = $client->stopUserImportJob([/* ... */]);
$promise = $client->stopUserImportJobAsync([/* ... */]);

Stops the user import job.

Parameter Syntax

$result = $client->stopUserImportJob([
    'JobId' => '<string>', // REQUIRED
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

JobId

Required: Yes
Type: string

The job ID for the user import job.

UserPoolId

Required: Yes
Type: string

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

Result Syntax

[
    'UserImportJob' => [
        'CloudWatchLogsRoleArn' => '<string>',
        'CompletionDate' => <DateTime>,
        'CompletionMessage' => '<string>',
        'CreationDate' => <DateTime>,
        'FailedUsers' => <integer>,
        'ImportedUsers' => <integer>,
        'JobId' => '<string>',
        'JobName' => '<string>',
        'PreSignedUrl' => '<string>',
        'SkippedUsers' => <integer>,
        'StartDate' => <DateTime>,
        'Status' => 'Created|Pending|InProgress|Stopping|Expired|Stopped|Failed|Succeeded',
        'UserPoolId' => '<string>',
    ],
]

Result Details

Members

UserImportJob

Type: UserImportJobType structure

The job object that represents the user import job.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.
PreconditionNotMetException:
This exception is thrown when a precondition is not met.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Assigns a set of tags to an Amazon Cognito 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.

Each tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two versions of a user pool, one for testing and another for production, you might assign an Environment tag key to both user pools. The value of this key might be Test for one user pool, and Production for the other.

Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your user pools. In an Identity and Access Management policy, you can constrain permissions for user pools based on specific tags or tag values.

You can use this action up to 5 times per second, per account. A user pool can have as many as 50 tags.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the user pool to assign the tags to.

Tags

Required: Yes
Type: Associative array of custom strings keys (TagKeysType) to strings

The tags to assign to the user pool.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5 times per second, per account.

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

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

TagKeys

Required: Yes
Type: Array of strings

The keys of the tags to remove from the user pool.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

UpdateAuthEventFeedback

$result = $client->updateAuthEventFeedback([/* ... */]);
$promise = $client->updateAuthEventFeedbackAsync([/* ... */]);

Provides the feedback for an authentication event, whether it was from a valid user or not. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.

Parameter Syntax

$result = $client->updateAuthEventFeedback([
    'EventId' => '<string>', // REQUIRED
    'FeedbackToken' => '<string>', // REQUIRED
    'FeedbackValue' => 'Valid|Invalid', // REQUIRED
    'UserPoolId' => '<string>', // REQUIRED
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members

EventId

Required: Yes
Type: string

The event ID.

FeedbackToken

Required: Yes
Type: string

The feedback token.

FeedbackValue

Required: Yes
Type: string

The authentication event feedback value.

UserPoolId

Required: Yes
Type: string

The user pool ID.

Username

Required: Yes
Type: string

The user pool username.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
UserNotFoundException:
This exception is thrown when a user isn't found.
UserPoolAddOnNotEnabledException:
This exception is thrown when user pool add-ons aren't enabled.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

UpdateDeviceStatus

$result = $client->updateDeviceStatus([/* ... */]);
$promise = $client->updateDeviceStatusAsync([/* ... */]);

Updates the device status.

Parameter Syntax

$result = $client->updateDeviceStatus([
    'AccessToken' => '<string>', // REQUIRED
    'DeviceKey' => '<string>', // REQUIRED
    'DeviceRememberedStatus' => 'remembered|not_remembered',
]);

Parameter Details

Members

AccessToken

Required: Yes
Type: string

A valid access token that Amazon Cognito issued to the user whose device status you want to update.

DeviceKey

Required: Yes
Type: string

The device key.

DeviceRememberedStatus

Type: string

The status of whether a device is remembered.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
InvalidUserPoolConfigurationException:
This exception is thrown when the user pool configuration is not valid.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
PasswordResetRequiredException:
This exception is thrown when a password reset is required.
UserNotFoundException:
This exception is thrown when a user isn't found.
UserNotConfirmedException:
This exception is thrown when a user isn't confirmed successfully.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.
ForbiddenException:
This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.

UpdateGroup

$result = $client->updateGroup([/* ... */]);
$promise = $client->updateGroupAsync([/* ... */]);

Updates the specified group with the specified attributes.

Calling this action requires developer credentials.

Parameter Syntax

$result = $client->updateGroup([
    'Description' => '<string>',
    'GroupName' => '<string>', // REQUIRED
    'Precedence' => <integer>,
    'RoleArn' => '<string>',
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

Description

Type: string

A string containing the new description of the group.

GroupName

Required: Yes
Type: string

The name of the group.

Precedence

Type: int

The new precedence value for the group. For more information about this parameter, see CreateGroup.

RoleArn

Type: string

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.

UserPoolId

Required: Yes
Type: string

The user pool ID for the user pool.

Result Syntax

[
    'Group' => [
        'CreationDate' => <DateTime>,
        'Description' => '<string>',
        'GroupName' => '<string>',
        'LastModifiedDate' => <DateTime>,
        'Precedence' => <integer>,
        'RoleArn' => '<string>',
        'UserPoolId' => '<string>',
    ],
]

Result Details

Members

Group

Type: GroupType structure

The group object for the group.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

UpdateIdentityProvider

$result = $client->updateIdentityProvider([/* ... */]);
$promise = $client->updateIdentityProviderAsync([/* ... */]);

Updates IdP information for a user pool.

Parameter Syntax

$result = $client->updateIdentityProvider([
    'AttributeMapping' => ['<string>', ...],
    'IdpIdentifiers' => ['<string>', ...],
    'ProviderDetails' => ['<string>', ...],
    'ProviderName' => '<string>', // REQUIRED
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

AttributeMapping

Type: Associative array of custom strings keys (AttributeMappingKeyType) to strings

The IdP attribute mapping to be changed.

IdpIdentifiers

Type: Array of strings

A list of IdP identifiers.

ProviderDetails

Type: Associative array of custom strings keys (StringType) to strings

The IdP details to be updated, such as MetadataURL and MetadataFile.

ProviderName

Required: Yes
Type: string

The IdP name.

UserPoolId

Required: Yes
Type: string

The user pool ID.

Result Syntax

[
    'IdentityProvider' => [
        'AttributeMapping' => ['<string>', ...],
        'CreationDate' => <DateTime>,
        'IdpIdentifiers' => ['<string>', ...],
        'LastModifiedDate' => <DateTime>,
        'ProviderDetails' => ['<string>', ...],
        'ProviderName' => '<string>',
        'ProviderType' => 'SAML|Facebook|Google|LoginWithAmazon|SignInWithApple|OIDC',
        'UserPoolId' => '<string>',
    ],
]

Result Details

Members

IdentityProvider

Required: Yes
Type: IdentityProviderType structure

The IdP object.

Errors

InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
UnsupportedIdentityProviderException:
This exception is thrown when the specified identifier isn't supported.
ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

UpdateResourceServer

$result = $client->updateResourceServer([/* ... */]);
$promise = $client->updateResourceServerAsync([/* ... */]);

Updates the name and scopes of resource server. All other fields are read-only.

If you don't provide a value for an attribute, it is set to the default value.

Parameter Syntax

$result = $client->updateResourceServer([
    'Identifier' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Scopes' => [
        [
            'ScopeDescription' => '<string>', // REQUIRED
            'ScopeName' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

Identifier

Required: Yes
Type: string

The identifier for the resource server.

Name

Required: Yes
Type: string

The name of the resource server.

Scopes

Type: Array of ResourceServerScopeType structures

The scope values to be set for the resource server.

UserPoolId

Required: Yes
Type: string

The user pool ID for the user pool.

Result Syntax

[
    'ResourceServer' => [
        'Identifier' => '<string>',
        'Name' => '<string>',
        'Scopes' => [
            [
                'ScopeDescription' => '<string>',
                'ScopeName' => '<string>',
            ],
            // ...
        ],
        'UserPoolId' => '<string>',
    ],
]

Result Details

Members

ResourceServer

Required: Yes
Type: ResourceServerType structure

The resource server.

Errors

InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

UpdateUserAttributes

$result = $client->updateUserAttributes([/* ... */]);
$promise = $client->updateUserAttributesAsync([/* ... */]);

Allows a user to update a specific attribute (one at a time).

Parameter Syntax

$result = $client->updateUserAttributes([
    'AccessToken' => '<string>', // REQUIRED
    'ClientMetadata' => ['<string>', ...],
    'UserAttributes' => [ // REQUIRED
        [
            'Name' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members

AccessToken

Required: Yes
Type: string

A valid access token that Amazon Cognito issued to the user whose user attributes you want to update.

ClientMetadata

Type: Associative array of custom strings keys (StringType) to strings

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.

UserAttributes

Required: Yes
Type: Array of AttributeType structures

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.

Result Syntax

[
    'CodeDeliveryDetailsList' => [
        [
            'AttributeName' => '<string>',
            'DeliveryMedium' => 'SMS|EMAIL',
            'Destination' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

CodeDeliveryDetailsList

Type: Array of CodeDeliveryDetailsType structures

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

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
CodeMismatchException:
This exception is thrown if the provided code doesn't match what the server was expecting.
ExpiredCodeException:
This exception is thrown if a code has expired.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
UnexpectedLambdaException:
This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.
UserLambdaValidationException:
This exception is thrown when the Amazon Cognito service encounters a user validation exception with the Lambda service.
InvalidLambdaResponseException:
This exception is thrown when Amazon Cognito encounters an invalid Lambda response.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
AliasExistsException:
This exception is thrown when a user tries to confirm the account with an email address or phone number that has already been supplied as an alias for a different user profile. This exception indicates that an account with this email address or phone already exists in a user pool that you've configured to use email address or phone number as a sign-in alias.
InvalidSmsRoleAccessPolicyException:
This exception is returned when the role provided for SMS configuration doesn't have permission to publish using Amazon SNS.
InvalidSmsRoleTrustRelationshipException:
This exception is thrown when the trust relationship is not valid for the role provided for SMS configuration. This can happen if you don't trust cognito-idp.amazonaws.com or the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.
InvalidEmailRoleAccessPolicyException:
This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP status code: 400.
CodeDeliveryFailureException:
This exception is thrown when a verification code fails to deliver successfully.
PasswordResetRequiredException:
This exception is thrown when a password reset is required.
UserNotFoundException:
This exception is thrown when a user isn't found.
UserNotConfirmedException:
This exception is thrown when a user isn't confirmed successfully.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.
ForbiddenException:
This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.

UpdateUserPool

$result = $client->updateUserPool([/* ... */]);
$promise = $client->updateUserPoolAsync([/* ... */]);

Updates the specified user pool with the specified attributes. You can get a list of the current user pool settings using DescribeUserPool. If you don't provide a value for an attribute, it will be set to the default value.

Parameter Syntax

$result = $client->updateUserPool([
    'AccountRecoverySetting' => [
        'RecoveryMechanisms' => [
            [
                'Name' => 'verified_email|verified_phone_number|admin_only', // REQUIRED
                'Priority' => <integer>, // REQUIRED
            ],
            // ...
        ],
    ],
    'AdminCreateUserConfig' => [
        'AllowAdminCreateUserOnly' => true || false,
        'InviteMessageTemplate' => [
            'EmailMessage' => '<string>',
            'EmailSubject' => '<string>',
            'SMSMessage' => '<string>',
        ],
        'UnusedAccountValidityDays' => <integer>,
    ],
    'AutoVerifiedAttributes' => ['<string>', ...],
    'DeviceConfiguration' => [
        'ChallengeRequiredOnNewDevice' => true || false,
        'DeviceOnlyRememberedOnUserPrompt' => true || false,
    ],
    'EmailConfiguration' => [
        'ConfigurationSet' => '<string>',
        'EmailSendingAccount' => 'COGNITO_DEFAULT|DEVELOPER',
        'From' => '<string>',
        'ReplyToEmailAddress' => '<string>',
        'SourceArn' => '<string>',
    ],
    'EmailVerificationMessage' => '<string>',
    'EmailVerificationSubject' => '<string>',
    'LambdaConfig' => [
        'CreateAuthChallenge' => '<string>',
        'CustomEmailSender' => [
            'LambdaArn' => '<string>', // REQUIRED
            'LambdaVersion' => 'V1_0', // REQUIRED
        ],
        'CustomMessage' => '<string>',
        'CustomSMSSender' => [
            'LambdaArn' => '<string>', // REQUIRED
            'LambdaVersion' => 'V1_0', // REQUIRED
        ],
        'DefineAuthChallenge' => '<string>',
        'KMSKeyID' => '<string>',
        'PostAuthentication' => '<string>',
        'PostConfirmation' => '<string>',
        'PreAuthentication' => '<string>',
        'PreSignUp' => '<string>',
        'PreTokenGeneration' => '<string>',
        'UserMigration' => '<string>',
        'VerifyAuthChallengeResponse' => '<string>',
    ],
    'MfaConfiguration' => 'OFF|ON|OPTIONAL',
    'Policies' => [
        'PasswordPolicy' => [
            'MinimumLength' => <integer>,
            'RequireLowercase' => true || false,
            'RequireNumbers' => true || false,
            'RequireSymbols' => true || false,
            'RequireUppercase' => true || false,
            'TemporaryPasswordValidityDays' => <integer>,
        ],
    ],
    'SmsAuthenticationMessage' => '<string>',
    'SmsConfiguration' => [
        'ExternalId' => '<string>',
        'SnsCallerArn' => '<string>', // REQUIRED
        'SnsRegion' => '<string>',
    ],
    'SmsVerificationMessage' => '<string>',
    'UserAttributeUpdateSettings' => [
        'AttributesRequireVerificationBeforeUpdate' => ['<string>', ...],
    ],
    'UserPoolAddOns' => [
        'AdvancedSecurityMode' => 'OFF|AUDIT|ENFORCED', // REQUIRED
    ],
    'UserPoolId' => '<string>', // REQUIRED
    'UserPoolTags' => ['<string>', ...],
    'VerificationMessageTemplate' => [
        'DefaultEmailOption' => 'CONFIRM_WITH_LINK|CONFIRM_WITH_CODE',
        'EmailMessage' => '<string>',
        'EmailMessageByLink' => '<string>',
        'EmailSubject' => '<string>',
        'EmailSubjectByLink' => '<string>',
        'SmsMessage' => '<string>',
    ],
]);

Parameter Details

Members

AccountRecoverySetting

Type: AccountRecoverySettingType structure

AdminCreateUserConfig

Type: AdminCreateUserConfigType structure

The configuration for AdminCreateUser requests.

AutoVerifiedAttributes

Type: Array of strings

The attributes that are automatically verified when Amazon Cognito requests to update user pools.

DeviceConfiguration

Type: DeviceConfigurationType structure

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.

EmailConfiguration

Type: EmailConfigurationType structure

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.

EmailVerificationMessage

Type: string

The contents of the email verification message.

EmailVerificationSubject

Type: string

The subject of the email verification message.

LambdaConfig

Type: LambdaConfigType structure

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

MfaConfiguration

Type: string

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.

Policies

Type: UserPoolPolicyType structure

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

SmsAuthenticationMessage

Type: string

The contents of the SMS authentication message.

SmsConfiguration

Type: SmsConfigurationType structure

SmsVerificationMessage

Type: string

A container with information about the SMS verification message.

UserAttributeUpdateSettings

Type: UserAttributeUpdateSettingsType structure

UserPoolAddOns

Type: UserPoolAddOnsType structure

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

UserPoolId

Required: Yes
Type: string

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

UserPoolTags

Type: Associative array of custom strings keys (TagKeysType) to strings

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.

VerificationMessageTemplate

Type: VerificationMessageTemplateType structure

The template for verification messages.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
ConcurrentModificationException:
This exception is thrown if two or more modifications are happening concurrently.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
UserImportInProgressException:
This exception is thrown when you're trying to modify a user pool while a user import job is in progress for that pool.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.
InvalidSmsRoleAccessPolicyException:
This exception is returned when the role provided for SMS configuration doesn't have permission to publish using Amazon SNS.
InvalidSmsRoleTrustRelationshipException:
This exception is thrown when the trust relationship is not valid for the role provided for SMS configuration. This can happen if you don't trust cognito-idp.amazonaws.com or the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.
UserPoolTaggingException:
This exception is thrown when a user pool tag can't be set or updated.
InvalidEmailRoleAccessPolicyException:
This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP status code: 400.

UpdateUserPoolClient

$result = $client->updateUserPoolClient([/* ... */]);
$promise = $client->updateUserPoolClientAsync([/* ... */]);

Updates the specified user pool app client with the specified attributes. You can get a list of the current user pool app client settings using DescribeUserPoolClient.

If you don't provide a value for an attribute, it will be set to the default value.

You can also use this operation to enable token revocation for user pool clients. For more information about revoking tokens, see RevokeToken.

Parameter Syntax

$result = $client->updateUserPoolClient([
    'AccessTokenValidity' => <integer>,
    'AllowedOAuthFlows' => ['<string>', ...],
    'AllowedOAuthFlowsUserPoolClient' => true || false,
    'AllowedOAuthScopes' => ['<string>', ...],
    'AnalyticsConfiguration' => [
        'ApplicationArn' => '<string>',
        'ApplicationId' => '<string>',
        'ExternalId' => '<string>',
        'RoleArn' => '<string>',
        'UserDataShared' => true || false,
    ],
    'CallbackURLs' => ['<string>', ...],
    'ClientId' => '<string>', // REQUIRED
    'ClientName' => '<string>',
    'DefaultRedirectURI' => '<string>',
    'EnablePropagateAdditionalUserContextData' => true || false,
    'EnableTokenRevocation' => true || false,
    'ExplicitAuthFlows' => ['<string>', ...],
    'IdTokenValidity' => <integer>,
    'LogoutURLs' => ['<string>', ...],
    'PreventUserExistenceErrors' => 'LEGACY|ENABLED',
    'ReadAttributes' => ['<string>', ...],
    'RefreshTokenValidity' => <integer>,
    'SupportedIdentityProviders' => ['<string>', ...],
    'TokenValidityUnits' => [
        'AccessToken' => 'seconds|minutes|hours|days',
        'IdToken' => 'seconds|minutes|hours|days',
        'RefreshToken' => 'seconds|minutes|hours|days',
    ],
    'UserPoolId' => '<string>', // REQUIRED
    'WriteAttributes' => ['<string>', ...],
]);

Parameter Details

Members

AccessTokenValidity

Type: int

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.

AllowedOAuthFlows

Type: Array of strings

The allowed OAuth flows.

code: 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.
implicit: Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
client_credentials: 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.

AllowedOAuthFlowsUserPoolClient

Type: boolean

Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.

AllowedOAuthScopes

Type: Array of strings

AnalyticsConfiguration

Type: AnalyticsConfigurationType structure

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.

CallbackURLs

Type: Array of strings

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.

ClientId

Required: Yes
Type: string

The ID of the client associated with the user pool.

ClientName

Type: string

The client name from the update user pool client request.

DefaultRedirectURI

Type: string

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.

EnablePropagateAdditionalUserContextData

Type: boolean

EnableTokenRevocation

Type: boolean

Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.

ExplicitAuthFlows

Type: Array of strings

The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are no longer supported in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix must be used only along with values with the ALLOW_ prefix.

Valid values include:

ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, Amazon Cognito receives the password in the request instead of using the Secure Remote Password (SRP) protocol to verify passwords.
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.

IdTokenValidity

Type: int

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.

LogoutURLs

Type: Array of strings

A list of allowed logout URLs for the IdPs.

PreventUserExistenceErrors

Type: string

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.

ReadAttributes

Type: Array of strings

The read-only attributes of the user pool.

RefreshTokenValidity

Type: int

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.

SupportedIdentityProviders

Type: Array of strings

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.

TokenValidityUnits

Type: TokenValidityUnitsType structure

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.

UserPoolId

Required: Yes
Type: string

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

WriteAttributes

Type: Array of strings

The writeable attributes of the user pool.

Result Syntax

[
    'UserPoolClient' => [
        'AccessTokenValidity' => <integer>,
        'AllowedOAuthFlows' => ['<string>', ...],
        'AllowedOAuthFlowsUserPoolClient' => true || false,
        'AllowedOAuthScopes' => ['<string>', ...],
        'AnalyticsConfiguration' => [
            'ApplicationArn' => '<string>',
            'ApplicationId' => '<string>',
            'ExternalId' => '<string>',
            'RoleArn' => '<string>',
            'UserDataShared' => true || false,
        ],
        'CallbackURLs' => ['<string>', ...],
        'ClientId' => '<string>',
        'ClientName' => '<string>',
        'ClientSecret' => '<string>',
        'CreationDate' => <DateTime>,
        'DefaultRedirectURI' => '<string>',
        'EnablePropagateAdditionalUserContextData' => true || false,
        'EnableTokenRevocation' => true || false,
        'ExplicitAuthFlows' => ['<string>', ...],
        'IdTokenValidity' => <integer>,
        'LastModifiedDate' => <DateTime>,
        'LogoutURLs' => ['<string>', ...],
        'PreventUserExistenceErrors' => 'LEGACY|ENABLED',
        'ReadAttributes' => ['<string>', ...],
        'RefreshTokenValidity' => <integer>,
        'SupportedIdentityProviders' => ['<string>', ...],
        'TokenValidityUnits' => [
            'AccessToken' => 'seconds|minutes|hours|days',
            'IdToken' => 'seconds|minutes|hours|days',
            'RefreshToken' => 'seconds|minutes|hours|days',
        ],
        'UserPoolId' => '<string>',
        'WriteAttributes' => ['<string>', ...],
    ],
]

Result Details

Members

UserPoolClient

Type: UserPoolClientType structure

The user pool client value from the response from the server when you request to update the user pool client.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
ConcurrentModificationException:
This exception is thrown if two or more modifications are happening concurrently.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
ScopeDoesNotExistException:
This exception is thrown when the specified scope doesn't exist.
InvalidOAuthFlowException:
This exception is thrown when the specified OAuth flow is not valid.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

UpdateUserPoolDomain

$result = $client->updateUserPoolDomain([/* ... */]);
$promise = $client->updateUserPoolDomainAsync([/* ... */]);

Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool.

You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate to Amazon Cognito. You can't use it to change the domain for a user pool.

A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and sign-in pages for your application. When you set up a custom domain, you provide a certificate that you manage with Certificate Manager (ACM). When necessary, you can use this operation to change the certificate that you applied to your custom domain.

Usually, this is unnecessary following routine certificate renewal with ACM. When you renew your existing certificate in ACM, the ARN for your certificate remains the same, and your custom domain uses the new certificate automatically.

However, if you replace your existing certificate with a new one, ACM gives the new certificate a new ARN. To apply the new certificate to your custom domain, you must provide this ARN to Amazon Cognito.

When you add your new certificate in ACM, you must choose US East (N. Virginia) as the Amazon Web Services Region.

After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new certificate to your custom domain.

For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.

Parameter Syntax

$result = $client->updateUserPoolDomain([
    'CustomDomainConfig' => [ // REQUIRED
        'CertificateArn' => '<string>', // REQUIRED
    ],
    'Domain' => '<string>', // REQUIRED
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members

CustomDomainConfig

Required: Yes
Type: CustomDomainConfigType structure

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.

Domain

Required: Yes
Type: string

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.

UserPoolId

Required: Yes
Type: string

The ID of the user pool that is associated with the custom domain whose certificate you're updating.

Result Syntax

[
    'CloudFrontDomain' => '<string>',
]

Result Details

Members

CloudFrontDomain

Type: string

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

Errors

InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.

VerifySoftwareToken

$result = $client->verifySoftwareToken([/* ... */]);
$promise = $client->verifySoftwareTokenAsync([/* ... */]);

Use this API to register a user's entered time-based one-time password (TOTP) code and mark the user's software token MFA status as "verified" if successful. The request takes an access token or a session string, but not both.

Parameter Syntax

$result = $client->verifySoftwareToken([
    'AccessToken' => '<string>',
    'FriendlyDeviceName' => '<string>',
    'Session' => '<string>',
    'UserCode' => '<string>', // REQUIRED
]);

Parameter Details

Members

AccessToken

Type: string

A valid access token that Amazon Cognito issued to the user whose software token you want to verify.

FriendlyDeviceName

Type: string

The friendly device name.

Session

Type: string

The session that should be passed both ways in challenge-response calls to the service.

UserCode

Required: Yes
Type: string

The one- time password computed using the secret code returned by AssociateSoftwareToken.

Result Syntax

[
    'Session' => '<string>',
    'Status' => 'SUCCESS|ERROR',
]

Result Details

Members

Session

Type: string

The session that should be passed both ways in challenge-response calls to the service.

Status

Type: string

The status of the verify software token.

Errors

InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidUserPoolConfigurationException:
This exception is thrown when the user pool configuration is not valid.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
PasswordResetRequiredException:
This exception is thrown when a password reset is required.
UserNotFoundException:
This exception is thrown when a user isn't found.
UserNotConfirmedException:
This exception is thrown when a user isn't confirmed successfully.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.
EnableSoftwareTokenMFAException:
This exception is thrown when there is a code mismatch and the service fails to configure the software token TOTP multi-factor authentication (MFA).
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
SoftwareTokenMFANotFoundException:
This exception is thrown when the software token time-based one-time password (TOTP) multi-factor authentication (MFA) isn't activated for the user pool.
CodeMismatchException:
This exception is thrown if the provided code doesn't match what the server was expecting.
ForbiddenException:
This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.

VerifyUserAttribute

$result = $client->verifyUserAttribute([/* ... */]);
$promise = $client->verifyUserAttributeAsync([/* ... */]);

Verifies the specified user attributes in the user pool.

If your user pool requires verification before Amazon Cognito updates the attribute value, VerifyUserAttribute updates the affected attribute to its pending value. For more information, see UserAttributeUpdateSettingsType.

Parameter Syntax

$result = $client->verifyUserAttribute([
    'AccessToken' => '<string>', // REQUIRED
    'AttributeName' => '<string>', // REQUIRED
    'Code' => '<string>', // REQUIRED
]);

Parameter Details

Members

AccessToken

Required: Yes
Type: string

A valid access token that Amazon Cognito issued to the user whose user attributes you want to verify.

AttributeName

Required: Yes
Type: string

The attribute name in the request to verify user attributes.

Code

Required: Yes
Type: string

The verification code in the request to verify user attributes.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
This exception is thrown when the Amazon Cognito service can't find the requested resource.
InvalidParameterException:
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
CodeMismatchException:
This exception is thrown if the provided code doesn't match what the server was expecting.
ExpiredCodeException:
This exception is thrown if a code has expired.
NotAuthorizedException:
This exception is thrown when a user isn't authorized.
TooManyRequestsException:
This exception is thrown when the user has made too many requests for a given operation.
LimitExceededException:
This exception is thrown when a user exceeds the limit for a requested Amazon Web Services resource.
PasswordResetRequiredException:
This exception is thrown when a password reset is required.
UserNotFoundException:
This exception is thrown when a user isn't found.
UserNotConfirmedException:
This exception is thrown when a user isn't confirmed successfully.
InternalErrorException:
This exception is thrown when Amazon Cognito encounters an internal error.
AliasExistsException:
This exception is thrown when a user tries to confirm the account with an email address or phone number that has already been supplied as an alias for a different user profile. This exception indicates that an account with this email address or phone already exists in a user pool that you've configured to use email address or phone number as a sign-in alias.
ForbiddenException:
This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.

Shapes

AccountRecoverySettingType

Description

The data type for AccountRecoverySetting.

Members

RecoveryMechanisms

Type: Array of RecoveryOptionType structures

The list of RecoveryOptionTypes.

AccountTakeoverActionType

Description

Account takeover action type.

Members

EventAction

Required: Yes
Type: string

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.

Notify

Required: Yes
Type: boolean

Flag specifying whether to send a notification.

AccountTakeoverActionsType

Description

Account takeover actions type.

Members

HighAction

Type: AccountTakeoverActionType structure

Action to take for a high risk.

LowAction

Type: AccountTakeoverActionType structure

Action to take for a low risk.

MediumAction

Type: AccountTakeoverActionType structure

Action to take for a medium risk.

AccountTakeoverRiskConfigurationType

Description

Configuration for mitigation actions and notification for different levels of risk detected for a potential account takeover.

Members

Actions

Required: Yes
Type: AccountTakeoverActionsType structure

Account takeover risk configuration actions.

NotifyConfiguration

Type: NotifyConfigurationType structure

The notify configuration used to construct email notifications.

AdminCreateUserConfigType

Description

The configuration for creating a new user profile.

Members

AllowAdminCreateUserOnly

Type: boolean

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.

InviteMessageTemplate

Type: MessageTemplateType structure

The message template to be used for the welcome message to new users.

UnusedAccountValidityDays

Type: int

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.

AliasExistsException

Description

This exception is thrown when a user tries to confirm the account with an email address or phone number that has already been supplied as an alias for a different user profile. This exception indicates that an account with this email address or phone already exists in a user pool that you've configured to use email address or phone number as a sign-in alias.

Members

message

Type: string

The message that Amazon Cognito sends to the user when the value of an alias attribute is already linked to another user profile.

AnalyticsConfigurationType

Description

The Amazon Pinpoint analytics configuration necessary to collect metrics for a user pool.

In Regions where Amazon Pinpointisn'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.

Members

ApplicationArn

Type: string

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.

ApplicationId

Type: string

The application ID for an Amazon Pinpoint application.

ExternalId

Type: string

The external ID.

RoleArn

Type: string

The ARN of an Identity and Access Management role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.

UserDataShared

Type: boolean

If UserDataShared is true, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.

AnalyticsMetadataType

Description

An Amazon Pinpoint analytics endpoint.

An endpoint uniquely identifies a mobile device, email address, or phone number that can receive messages from Amazon Pinpoint analytics. For more information about Amazon Web Services Regions that can contain Amazon Pinpoint resources for use with Amazon Cognito user pools, see Using Amazon Pinpoint analytics with Amazon Cognito user pools.

Members

AnalyticsEndpointId

Type: string

The endpoint ID.

AttributeType

Description

Specifies whether the attribute is standard or custom.

Members

Name

Required: Yes
Type: string

The name of the attribute.

Value

Type: string

The value of the attribute.

AuthEventType

Description

The authentication event type.

Members

ChallengeResponses

Type: Array of ChallengeResponseType structures

The challenge responses.

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation date

EventContextData

Type: EventContextDataType structure

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.

EventFeedback

Type: EventFeedbackType structure

A flag specifying the user feedback captured at the time of an event request is good or bad.

EventId

Type: string

The event ID.

EventResponse

Type: string

The event response.

EventRisk

Type: EventRiskType structure

The event risk.

EventType

Type: string

The event type.

AuthenticationResultType

Description

The authentication result.

Members

AccessToken

Type: string

A valid access token that Amazon Cognito issued to the user who you want to authenticate.

ExpiresIn

Type: int

The expiration period of the authentication result in seconds.

IdToken

Type: string

The ID token.

NewDeviceMetadata

Type: NewDeviceMetadataType structure

The new device metadata from an authentication result.

RefreshToken

Type: string

The refresh token.

TokenType

Type: string

The token type.

ChallengeResponseType

Description

The challenge response type.

Members

ChallengeName

Type: string

The challenge name.

ChallengeResponse

Type: string

The challenge response.

CodeDeliveryDetailsType

Description

The delivery details for an email or SMS message that Amazon Cognito sent for authentication or verification.

Members

AttributeName

Type: string

The name of the attribute that Amazon Cognito verifies with the code.

DeliveryMedium

Type: string

The method that Amazon Cognito used to send the code.

Destination

Type: string

The email address or phone number destination where Amazon Cognito sent the code.

CodeDeliveryFailureException

Description

This exception is thrown when a verification code fails to deliver successfully.

Members

message

Type: string

The message sent when a verification code fails to deliver successfully.

CodeMismatchException

Description

This exception is thrown if the provided code doesn't match what the server was expecting.

Members

message

Type: string

The message provided when the code mismatch exception is thrown.

CompromisedCredentialsActionsType

Description

The compromised credentials actions type.

Members

EventAction

Required: Yes
Type: string

The event action.

CompromisedCredentialsRiskConfigurationType

Description

The compromised credentials risk configuration type.

Members

Actions

Required: Yes
Type: CompromisedCredentialsActionsType structure

The compromised credentials risk configuration actions.

EventFilter

Type: Array of strings

Perform the action for these events. The default is to perform all events if no event filter is specified.

ConcurrentModificationException

Description

This exception is thrown if two or more modifications are happening concurrently.

Members

message

Type: string

The message provided when the concurrent exception is thrown.

ContextDataType

Description

Contextual user data type used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

Members

EncodedData

Type: string

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.

HttpHeaders

Required: Yes
Type: Array of HttpHeader structures

HttpHeaders received on your server in same order.

IpAddress

Required: Yes
Type: string

The source IP address of your user's device.

ServerName

Required: Yes
Type: string

Your server endpoint where this API is invoked.

ServerPath

Required: Yes
Type: string

Your server path where this API is invoked.

CustomDomainConfigType

Description

The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.

Members

CertificateArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of an Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain.

CustomEmailLambdaVersionConfigType

Description

A custom email sender Lambda configuration type.

Members

LambdaArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Lambda function that Amazon Cognito activates to send email notifications to users.

LambdaVersion

Required: Yes
Type: string

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.

CustomSMSLambdaVersionConfigType

Description

A custom SMS sender Lambda configuration type.

Members

LambdaArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Lambda function that Amazon Cognito activates to send SMS notifications to users.

LambdaVersion

Required: Yes
Type: string

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.

DeviceConfigurationType

Description

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.

Members

ChallengeRequiredOnNewDevice

Type: boolean

When true, device authentication can replace SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).

Regardless of the value of this field, users that sign in with new devices that have not been confirmed or remembered must provide a second factor if your user pool requires MFA.

DeviceOnlyRememberedOnUserPrompt

Type: boolean

When true, Amazon Cognito doesn't remember newly-confirmed devices. Users who want to authenticate with their device can instead opt in to remembering their device. To collect a choice from your user, create an input prompt in your app and return the value that the user chooses in an UpdateDeviceStatus API request.

DeviceSecretVerifierConfigType

Description

The device verifier against which it is authenticated.

Members

PasswordVerifier

Type: string

The password verifier.

Salt

Type: string

The salt

DeviceType

Description

The device type.

Members

DeviceAttributes

Type: Array of AttributeType structures

The device attributes.

DeviceCreateDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation date of the device.

DeviceKey

Type: string

The device key.

DeviceLastAuthenticatedDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date when the device was last authenticated.

DeviceLastModifiedDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The last modified date of the device.

DomainDescriptionType

Description

A container for information about a domain.

Members

AWSAccountId

Type: string

The Amazon Web Services ID for the user pool owner.

CloudFrontDistribution

Type: string

The Amazon Resource Name (ARN) of the Amazon CloudFront distribution.

CustomDomainConfig

Type: CustomDomainConfigType structure

The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.

Domain

Type: string

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.

S3Bucket

Type: string

The Amazon S3 bucket where the static files for this domain are stored.

Status

Type: string

The domain status.

UserPoolId

Type: string

The user pool ID.

Version

Type: string

The app version.

DuplicateProviderException

Description

This exception is thrown when the provider is already supported by the user pool.

Members

message

Type: string

EmailConfigurationType

Description

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.

Amazon Cognito can send email messages with Amazon Simple Email Service resources in the Amazon Web Services Region where you created your user pool, and in alternate Regions in some cases. For more information on the supported Regions, see Email settings for Amazon Cognito user pools.

Members

ConfigurationSet

Type: string

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:

Event publishing: 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
IP pool management: 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.

EmailSendingAccount

Type: string

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:

COGNITO_DEFAULT

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 in the Developer Guide.

The default FROM address is no-reply@verificationemail.com. To customize the FROM address, provide the Amazon Resource Name (ARN) of an Amazon SES verified email address for the SourceArn parameter.

DEVELOPER

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 to access Amazon SES and send email messages with your address. For more information about the service-linked role that Amazon Cognito creates, see Using Service-Linked Roles for Amazon Cognito in the Amazon Cognito Developer Guide.

From

Type: string

Either the sender’s email address or the sender’s name with their email address. For example, testuser@example.com or Test User <testuser@example.com>. This address appears before the body of the email.

ReplyToEmailAddress

Type: string

The destination to which the receiver of the email should reply.

SourceArn

Type: string

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.

EnableSoftwareTokenMFAException

Description

This exception is thrown when there is a code mismatch and the service fails to configure the software token TOTP multi-factor authentication (MFA).

Members

message

Type: string

EventContextDataType

Description

Specifies the user context data captured at the time of an event request.

Members

City

Type: string

The user's city.

Country

Type: string

The user's country.

DeviceName

Type: string

The user's device name.

IpAddress

Type: string

The source IP address of your user's device.

Timezone

Type: string

The user's time zone.

EventFeedbackType

Description

Specifies the event feedback type.

Members

FeedbackDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The event feedback date.

FeedbackValue

Required: Yes
Type: string

The event feedback value.

Provider

Required: Yes
Type: string

The provider.

EventRiskType

Description

The event risk type.

Members

CompromisedCredentialsDetected

Type: boolean

Indicates whether compromised credentials were detected during an authentication event.

RiskDec

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

Amazon Cognito Identity Provider 2016-04-18

Operation Summary

Paginators

Operations

AddCustomAttributes

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

AdminAddUserToGroup

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

AdminConfirmSignUp

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

AdminCreateUser

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AdminDeleteUser

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

AdminDeleteUserAttributes

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

AdminDisableProviderForUser

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

AdminDisableUser

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

AdminEnableUser

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

AdminForgetDevice

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details