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 a user to a group.
AdminConfirmSignUp ( array $params = [] )
This IAM-authenticated API operation provides a code that Amazon Cognito sent to your user when they signed up in your user pool.
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 = [] )
Deactivates a user and revokes all access tokens for the 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 a 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 = [] )
Some API operations in a user pool generate a challenge, like a prompt for an MFA code, for device authentication that bypasses MFA, or for a custom authentication challenge.
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 = [] )
This action might generate an SMS text message.
AdminUserGlobalSignOut ( array $params = [] )
Invalidates the identity, access, and refresh tokens that Amazon Cognito issued to a user.
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 = [] )
This public API operation provides a code that Amazon Cognito sent to your user when they signed up in your user pool via the SignUp API operation.
CreateGroup ( array $params = [] )
Creates a new group in the specified user pool.
CreateIdentityProvider ( array $params = [] )
Adds a configuration and trust relationship between a third-party identity provider (IdP) and a user pool.
CreateResourceServer ( array $params = [] )
Creates a new OAuth2.
CreateUserImportJob ( array $params = [] )
Creates a user import job.
CreateUserPool ( array $params = [] )
This action might generate an SMS text message.
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 their own user profile.
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.
GetLogDeliveryConfiguration ( array $params = [] )
Gets the detailed activity logging configuration for a user pool.
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 = [] )
Invalidates the identity, access, and refresh tokens that Amazon Cognito issued to a user.
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 user import jobs for a user pool.
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 users and their basic details in a 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 = [] )
Some API operations in a user pool generate a challenge, like a prompt for an MFA code, for device authentication that bypasses MFA, or for a custom authentication challenge.
RevokeToken ( array $params = [] )
Revokes all of the access tokens generated by, and at the same time as, the specified refresh token.
SetLogDeliveryConfiguration ( array $params = [] )
Sets up or modifies the detailed activity logging configuration of a user pool.
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 = [] )
With this operation, your users can update one or more of their attributes with their own credentials.
UpdateUserPool ( array $params = [] )
This action might generate an SMS text message.
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.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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 a user to a group. A user who is in a group can present a preferred-role claim to an identity pool, and populates a cognito:groups claim to their access and identity tokens.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

Parameter Syntax

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

Parameter Details

Members
GroupName
Required: Yes
Type: string

The name of the group that you want to add your user to.

UserPoolId
Required: Yes
Type: string

The user pool ID for the user pool.

Username
Required: Yes
Type: string

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

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([/* ... */]);

This IAM-authenticated API operation provides a code that Amazon Cognito sent to your user when they signed up in your user pool. After your user enters their code, they confirm ownership of the email address or phone number that they provided, and their user account becomes active. Depending on your user pool configuration, your users will receive their confirmation code in an email or SMS message.

Local users who signed up in your user pool are the only type of user who can confirm sign-up with a code. Users who federate through an external identity provider (IdP) have already been confirmed by their IdP. Administrator-created users confirm their accounts when they respond to their invitation email message and choose a password.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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 username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

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.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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 set for your user pool. To reset the account after that time limit, you must call AdminCreateUser again and specify 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 value that you want to set as the username sign-in attribute. The following conditions apply to the username parameter.

  • The username can't be a duplicate of another username in the same user pool.

  • You can't change the value of a username after you create it.

  • You can only provide a value if usernames are a valid sign-in attribute for your user pool. If your user pool only supports phone numbers or email addresses as sign-in attributes, Amazon Cognito automatically generates a username value. For more information, see Customizing sign-in attributes.

ValidationData
Type: Array of AttributeType structures

Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. This set of key-value pairs are for custom validation of information that you collect from your users but don't need to retain.

Your Lambda function can analyze this additional data and act on it. Your function might perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs. Validation data might also affect the response that your function returns to Amazon Cognito, like automatically confirming the user if they sign up from within your network.

For more information about the pre sign-up Lambda trigger, see Pre sign-up Lambda trigger.

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|EXTERNAL_PROVIDER',
        '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.

Examples

Example 1: An AdminCreateUser request for for a test user named John.

This request submits a value for all possible parameters for AdminCreateUser.

$result = $client->adminCreateUser([
    'DesiredDeliveryMediums' => [
        'SMS',
    ],
    'MessageAction' => 'SUPPRESS',
    'TemporaryPassword' => 'This-is-my-test-99!',
    'UserAttributes' => [
        [
            'Name' => 'name',
            'Value' => 'John',
        ],
        [
            'Name' => 'phone_number',
            'Value' => '+12065551212',
        ],
        [
            'Name' => 'email',
            'Value' => 'testuser@example.com',
        ],
    ],
    'UserPoolId' => 'us-east-1_EXAMPLE',
    'Username' => 'testuser',
]);

Result syntax:

[
    'User' => [
        'Attributes' => [
            [
                'Name' => 'sub',
                'Value' => 'd16b4aa8-8633-4abd-93b3-5062a8e1b5f8',
            ],
            [
                'Name' => 'name',
                'Value' => 'John',
            ],
            [
                'Name' => 'phone_number',
                'Value' => '+12065551212',
            ],
            [
                'Name' => 'email',
                'Value' => 'testuser@example.com',
            ],
        ],
        'Enabled' => 1,
        'UserCreateDate' => ,
        'UserLastModifiedDate' => ,
        'UserStatus' => 'FORCE_CHANGE_PASSWORD',
        'Username' => 'testuser',
    ],
]

AdminDeleteUser

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

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

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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 username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

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.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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 username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

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.

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.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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([/* ... */]);

Deactivates a user and revokes all access tokens for the user. A deactivated user can't sign in, but still appears in the responses to GetUser and ListUsers API requests.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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 username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

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.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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 username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

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.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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 username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

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.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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 username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

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.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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 username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

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|EXTERNAL_PROVIDER',
    '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 and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

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.

  • 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 username of the user that you requested.

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.

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.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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 ADMIN_USER_PASSWORD_AUTH: USERNAME (required), PASSWORD (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).

For more information about SECRET_HASH, see Computing secret hash values. For information about DEVICE_KEY, see Working with user devices in your user pool.

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

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

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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 local (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 OIDC, the ProviderAttributeName can be any value that matches a claim in the ID token, or that your app retrieves from the userInfo endpoint. You must map the claim to a user pool attribute in your IdP configuration, and set the user pool attribute name as the value of ProviderAttributeName in your AdminLinkProviderForUser request.

For SAML, the ProviderAttributeName can be any value that matches a claim in the SAML assertion. To link SAML users based on the subject of the SAML assertion, map the subject to a claim through the SAML IdP and set that claim name as the value of ProviderAttributeName in your AdminLinkProviderForUser request.

For both OIDC and SAML users, when you set ProviderAttributeName to Cognito_Subject, Amazon Cognito will automatically parse the default unique identifier found in the subject from the IdP 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.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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

This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

UserPoolId
Required: Yes
Type: string

The user pool ID.

Username
Required: Yes
Type: string

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

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 identifier that Amazon Cognito returned with the previous request to this operation. When you include a pagination token in your request, Amazon Cognito returns the next set of items in the list. By use of this token, you can paginate through the full list of items.

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 a user belongs to.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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 of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

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.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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. Returns 60 events if you set MaxResults to 0, or if you don't include a MaxResults parameter.

NextToken
Type: string

A pagination token.

UserPoolId
Required: Yes
Type: string

The user pool ID.

Username
Required: Yes
Type: string

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

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' => 'Pass|Fail|InProgress',
            'EventRisk' => [
                'CompromisedCredentialsDetected' => true || false,
                'RiskDecision' => 'NoRisk|AccountTakeover|Block',
                'RiskLevel' => 'Low|Medium|High',
            ],
            'EventType' => 'SignIn|SignUp|ForgotPassword|PasswordChange|ResendCode',
        ],
        // ...
    ],
    '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.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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 of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

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.

To use this API operation, your user pool must have self-service account recovery configured. Use AdminSetUserPassword if you manage passwords as an administrator.

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.

Deactivates a user's password, requiring them to change it. If a user tries to sign in after the API is called, Amazon Cognito responds with a PasswordResetRequiredException error. Your app must then perform the actions that reset your user's password: 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.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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 username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

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([/* ... */]);

Some API operations in a user pool generate a challenge, like a prompt for an MFA code, for device authentication that bypasses MFA, or for a custom authentication challenge. An AdminRespondToAuthChallenge API request provides the answer to that challenge, like a code or a secure remote password (SRP). The parameters of a response to an authentication challenge vary with the type of challenge.

For more information about custom authentication challenges, see Custom authentication challenge Lambda triggers.

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.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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 responses to the challenge that you received in the previous request. Each challenge has its own required response parameters. The following examples are partial JSON request bodies that highlight challenge-response parameters.

You must provide a SECRET_HASH parameter in all challenge responses to an app client that has a client secret.

SMS_MFA

"ChallengeName": "SMS_MFA", "ChallengeResponses": {"SMS_MFA_CODE": "[SMS_code]", "USERNAME": "[username]"}

PASSWORD_VERIFIER

"ChallengeName": "PASSWORD_VERIFIER", "ChallengeResponses": {"PASSWORD_CLAIM_SIGNATURE": "[claim_signature]", "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]", "TIMESTAMP": [timestamp], "USERNAME": "[username]"}

Add "DEVICE_KEY" when you sign in with a remembered device.

CUSTOM_CHALLENGE

"ChallengeName": "CUSTOM_CHALLENGE", "ChallengeResponses": {"USERNAME": "[username]", "ANSWER": "[challenge_answer]"}

Add "DEVICE_KEY" when you sign in with a remembered device.

NEW_PASSWORD_REQUIRED

"ChallengeName": "NEW_PASSWORD_REQUIRED", "ChallengeResponses": {"NEW_PASSWORD": "[new_password]", "USERNAME": "[username]"}

To set any required attributes that InitiateAuth returned in an requiredAttributes parameter, add "userAttributes.[attribute_name]": "[attribute_value]". 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

"ChallengeName": "SOFTWARE_TOKEN_MFA", "ChallengeResponses": {"USERNAME": "[username]", "SOFTWARE_TOKEN_MFA_CODE": [authenticator_code]}

DEVICE_SRP_AUTH

"ChallengeName": "DEVICE_SRP_AUTH", "ChallengeResponses": {"USERNAME": "[username]", "DEVICE_KEY": "[device_key]", "SRP_A": "[srp_a]"}

DEVICE_PASSWORD_VERIFIER

"ChallengeName": "DEVICE_PASSWORD_VERIFIER", "ChallengeResponses": {"DEVICE_KEY": "[device_key]", "PASSWORD_CLAIM_SIGNATURE": "[claim_signature]", "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]", "TIMESTAMP": [timestamp], "USERNAME": "[username]"}

MFA_SETUP

"ChallengeName": "MFA_SETUP", "ChallengeResponses": {"USERNAME": "[username]"}, "SESSION": "[Session ID from VerifySoftwareToken]"

SELECT_MFA_TYPE

"ChallengeName": "SELECT_MFA_TYPE", "ChallengeResponses": {"USERNAME": "[username]", "ANSWER": "[SMS_MFA or SOFTWARE_TOKEN_MFA]"}

For more information about SECRET_HASH, see Computing secret hash values. For information about DEVICE_KEY, see Working with user devices in your user pool.

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

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.

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.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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

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 username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

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.

AdminSetUserPassword can set a password for the user profile that Amazon Cognito creates for third-party federated users. When you set a password, the federated user's status changes from EXTERNAL_PROVIDER to CONFIRMED. A user in this state can sign in as a federated user, and initiate authentication flows in the API like a linked native user. They can also modify their password and attributes in token-authenticated API requests like ChangePassword and UpdateUserAttributes. As a best security practice and to keep users in sync with your external IdP, don't set passwords on federated user profiles. To set up a federated user for native sign-in with a linked native user, refer to Linking federated users to an existing user profile.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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 username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

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.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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 username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

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.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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. When you provide a FeedbackValue value of valid, you tell Amazon Cognito that you trust a user session where Amazon Cognito has evaluated some level of risk. When you provide a FeedbackValue value of invalid, you tell Amazon Cognito that you don't trust a user session, or you don't believe that Amazon Cognito evaluated a high-enough risk level.

UserPoolId
Required: Yes
Type: string

The user pool ID.

Username
Required: Yes
Type: string

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

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.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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 username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

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([/* ... */]);

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.

Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user. To delete an attribute from your user, submit the attribute in your API request with a blank value.

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.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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 username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

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([/* ... */]);

Invalidates the identity, access, and refresh tokens that Amazon Cognito issued to a user. Call this operation with your administrative credentials when your user signs out of your app. This results in the following behavior.

  • Amazon Cognito no longer accepts token-authorized user operations that you authorize with a signed-out user's access tokens. For more information, see Using the Amazon Cognito user pools API and user pool endpoints.

    Amazon Cognito returns an Access Token has been revoked error when your app attempts to authorize a user pools API request with a revoked access token that contains the scope aws.cognito.signin.user.admin.

  • Amazon Cognito no longer accepts a signed-out user's ID token in a GetId request to an identity pool with ServerSideTokenCheck enabled for its user pool IdP configuration in CognitoIdentityProvider.

  • Amazon Cognito no longer accepts a signed-out user's refresh tokens in refresh requests.

Other requests might be valid until your user's token expires.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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 username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

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.

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

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.

Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

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. For more information about device authentication, see Working with user devices in your user pool.

Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

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

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.

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

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. For more information about SecretHash, see Computing secret hash values.

UserContextData
Type: UserContextDataType 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.

Username
Required: Yes
Type: string

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

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([/* ... */]);

This public API operation provides a code that Amazon Cognito sent to your user when they signed up in your user pool via the SignUp API operation. After your user enters their code, they confirm ownership of the email address or phone number that they provided, and their user account becomes active. Depending on your user pool configuration, your users will receive their confirmation code in an email or SMS message.

Local users who signed up in your user pool are the only type of user who can confirm sign-up with a code. Users who federate through an external identity provider (IdP) have already been confirmed by their IdP. Administrator-created users, users created with the AdminCreateUser API operation, confirm their accounts when they respond to their invitation email message and choose a password. They do not receive a confirmation code. Instead, they receive a temporary password.

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

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

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.

Username
Required: Yes
Type: string

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

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.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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([/* ... */]);

Adds a configuration and trust relationship between a third-party identity provider (IdP) and a user pool.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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 scopes, URLs, and identifiers for your external identity provider. The following examples describe the provider detail keys for each IdP type. These values and their schema are subject to change. Social IdP authorize_scopes values must match the values listed here.

OpenID Connect (OIDC)

Amazon Cognito accepts the following elements when it can't discover endpoint URLs from oidc_issuer: attributes_url, authorize_url, jwks_uri, token_url.

Create or update request: "ProviderDetails": { "attributes_request_method": "GET", "attributes_url": "https://auth.example.com/userInfo", "authorize_scopes": "openid profile email", "authorize_url": "https://auth.example.com/authorize", "client_id": "1example23456789", "client_secret": "provider-app-client-secret", "jwks_uri": "https://auth.example.com/.well-known/jwks.json", "oidc_issuer": "https://auth.example.com", "token_url": "https://example.com/token" }

Describe response: "ProviderDetails": { "attributes_request_method": "GET", "attributes_url": "https://auth.example.com/userInfo", "attributes_url_add_attributes": "false", "authorize_scopes": "openid profile email", "authorize_url": "https://auth.example.com/authorize", "client_id": "1example23456789", "client_secret": "provider-app-client-secret", "jwks_uri": "https://auth.example.com/.well-known/jwks.json", "oidc_issuer": "https://auth.example.com", "token_url": "https://example.com/token" }

SAML

Create or update request with Metadata URL: "ProviderDetails": { "IDPInit": "true", "IDPSignout": "true", "EncryptedResponses" : "true", "MetadataURL": "https://auth.example.com/sso/saml/metadata", "RequestSigningAlgorithm": "rsa-sha256" }

Create or update request with Metadata file: "ProviderDetails": { "IDPInit": "true", "IDPSignout": "true", "EncryptedResponses" : "true", "MetadataFile": "[metadata XML]", "RequestSigningAlgorithm": "rsa-sha256" }

The value of MetadataFile must be the plaintext metadata document with all quote (") characters escaped by backslashes.

Describe response: "ProviderDetails": { "IDPInit": "true", "IDPSignout": "true", "EncryptedResponses" : "true", "ActiveEncryptionCertificate": "[certificate]", "MetadataURL": "https://auth.example.com/sso/saml/metadata", "RequestSigningAlgorithm": "rsa-sha256", "SLORedirectBindingURI": "https://auth.example.com/slo/saml", "SSORedirectBindingURI": "https://auth.example.com/sso/saml" }

LoginWithAmazon

Create or update request: "ProviderDetails": { "authorize_scopes": "profile postal_code", "client_id": "amzn1.application-oa2-client.1example23456789", "client_secret": "provider-app-client-secret"

Describe response: "ProviderDetails": { "attributes_url": "https://api.amazon.com/user/profile", "attributes_url_add_attributes": "false", "authorize_scopes": "profile postal_code", "authorize_url": "https://www.amazon.com/ap/oa", "client_id": "amzn1.application-oa2-client.1example23456789", "client_secret": "provider-app-client-secret", "token_request_method": "POST", "token_url": "https://api.amazon.com/auth/o2/token" }

Google

Create or update request: "ProviderDetails": { "authorize_scopes": "email profile openid", "client_id": "1example23456789.apps.googleusercontent.com", "client_secret": "provider-app-client-secret" }

Describe response: "ProviderDetails": { "attributes_url": "https://people.googleapis.com/v1/people/me?personFields=", "attributes_url_add_attributes": "true", "authorize_scopes": "email profile openid", "authorize_url": "https://accounts.google.com/o/oauth2/v2/auth", "client_id": "1example23456789.apps.googleusercontent.com", "client_secret": "provider-app-client-secret", "oidc_issuer": "https://accounts.google.com", "token_request_method": "POST", "token_url": "https://www.googleapis.com/oauth2/v4/token" }

SignInWithApple

Create or update request: "ProviderDetails": { "authorize_scopes": "email name", "client_id": "com.example.cognito", "private_key": "1EXAMPLE", "key_id": "2EXAMPLE", "team_id": "3EXAMPLE" }

Describe response: "ProviderDetails": { "attributes_url_add_attributes": "false", "authorize_scopes": "email name", "authorize_url": "https://appleid.apple.com/auth/authorize", "client_id": "com.example.cognito", "key_id": "1EXAMPLE", "oidc_issuer": "https://appleid.apple.com", "team_id": "2EXAMPLE", "token_request_method": "POST", "token_url": "https://appleid.apple.com/auth/token" }

Facebook

Create or update request: "ProviderDetails": { "api_version": "v17.0", "authorize_scopes": "public_profile, email", "client_id": "1example23456789", "client_secret": "provider-app-client-secret" }

Describe response: "ProviderDetails": { "api_version": "v17.0", "attributes_url": "https://graph.facebook.com/v17.0/me?fields=", "attributes_url_add_attributes": "true", "authorize_scopes": "public_profile, email", "authorize_url": "https://www.facebook.com/v17.0/dialog/oauth", "client_id": "1example23456789", "client_secret": "provider-app-client-secret", "token_request_method": "GET", "token_url": "https://graph.facebook.com/v17.0/oauth/access_token" }

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.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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. The identifier can be an API friendly name like solar-system-data. You can also set an API URL like https://solar-system-data-api.example.com as your identifier.

Amazon Cognito represents scopes in the access token in the format $resource-server-identifier/$scope. Longer scope-identifier strings increase the size of your access tokens.

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 a user import job.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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([/* ... */]);

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.

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

If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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>', ...],
    'DeletionProtection' => 'ACTIVE|INACTIVE',
    '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>',
        'PreTokenGenerationConfig' => [
            'LambdaArn' => '<string>', // REQUIRED
            'LambdaVersion' => 'V1_0|V2_0', // REQUIRED
        ],
        '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.

DeletionProtection
Type: string

When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.

When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.

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

This parameter is no longer used. See VerificationMessageTemplateType.

EmailVerificationSubject
Type: string

This parameter is no longer used. See VerificationMessageTemplateType.

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

This parameter is no longer used. See VerificationMessageTemplateType.

UserAttributeUpdateSettings

The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.

UserPoolAddOns
Type: UserPoolAddOnsType structure

User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to AUDIT. To configure automatic security responses to risky traffic to your user pool, set to ENFORCED.

For more information, see Adding advanced security to a user pool.

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. When case sensitivity is set to False (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, username, USERNAME, or UserName, or for email, email@example.com or EMaiL@eXamplE.Com. For most use cases, set case sensitivity to False (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user.

This configuration is immutable after you set it. For more information, see UsernameConfigurationType.

VerificationMessageTemplate

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>',
        'DeletionProtection' => 'ACTIVE|INACTIVE',
        '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>',
            'PreTokenGenerationConfig' => [
                'LambdaArn' => '<string>',
                'LambdaVersion' => 'V1_0|V2_0',
            ],
            '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.

Examples

Example 1: Example user pool with email and username sign-in

The following example creates a user pool with all configurable properties set to an example value. The resulting user pool allows sign-in with username or email address, has optional MFA, and has a Lambda function assigned to each possible trigger.

$result = $client->createUserPool([
    'AccountRecoverySetting' => [
        'RecoveryMechanisms' => [
            [
                'Name' => 'verified_email',
                'Priority' => 1,
            ],
        ],
    ],
    'AdminCreateUserConfig' => [
        'AllowAdminCreateUserOnly' => ,
        'InviteMessageTemplate' => [
            'EmailMessage' => 'Your username is {username} and temporary password is {####}.',
            'EmailSubject' => 'Your sign-in information',
            'SMSMessage' => 'Your username is {username} and temporary password is {####}.',
        ],
    ],
    'AliasAttributes' => [
        'email',
    ],
    'AutoVerifiedAttributes' => [
        'email',
    ],
    'DeletionProtection' => 'ACTIVE',
    'DeviceConfiguration' => [
        'ChallengeRequiredOnNewDevice' => 1,
        'DeviceOnlyRememberedOnUserPrompt' => 1,
    ],
    'EmailConfiguration' => [
        'ConfigurationSet' => 'my-test-ses-configuration-set',
        'EmailSendingAccount' => 'DEVELOPER',
        'From' => 'support@example.com',
        'ReplyToEmailAddress' => 'support@example.com',
        'SourceArn' => 'arn:aws:ses:us-east-1:123456789012:identity/support@example.com',
    ],
    'EmailVerificationMessage' => 'Your verification code is {####}.',
    'EmailVerificationSubject' => 'Verify your email address',
    'LambdaConfig' => [
        'CustomEmailSender' => [
            'LambdaArn' => 'arn:aws:lambda:us-east-1:123456789012:function:MyFunction',
            'LambdaVersion' => 'V1_0',
        ],
        'CustomMessage' => 'arn:aws:lambda:us-east-1:123456789012:function:MyFunction',
        'CustomSMSSender' => [
            'LambdaArn' => 'arn:aws:lambda:us-east-1:123456789012:function:MyFunction',
            'LambdaVersion' => 'V1_0',
        ],
        'DefineAuthChallenge' => 'arn:aws:lambda:us-east-1:123456789012:function:MyFunction',
        'KMSKeyID' => 'arn:aws:kms:us-east-1:123456789012:key/a6c4f8e2-0c45-47db-925f-87854bc9e357',
        'PostAuthentication' => 'arn:aws:lambda:us-east-1:123456789012:function:MyFunction',
        'PostConfirmation' => 'arn:aws:lambda:us-east-1:123456789012:function:MyFunction',
        'PreAuthentication' => 'arn:aws:lambda:us-east-1:123456789012:function:MyFunction',
        'PreSignUp' => 'arn:aws:lambda:us-east-1:123456789012:function:MyFunction',
        'PreTokenGeneration' => 'arn:aws:lambda:us-east-1:123456789012:function:MyFunction',
        'UserMigration' => 'arn:aws:lambda:us-east-1:123456789012:function:MyFunction',
        'VerifyAuthChallengeResponse' => 'arn:aws:lambda:us-east-1:123456789012:function:MyFunction',
    ],
    'MfaConfiguration' => 'OPTIONAL',
    'Policies' => [
        'PasswordPolicy' => [
            'MinimumLength' => 6,
            'RequireLowercase' => 1,
            'RequireNumbers' => 1,
            'RequireSymbols' => 1,
            'RequireUppercase' => 1,
            'TemporaryPasswordValidityDays' => 7,
        ],
    ],
    'PoolName' => 'my-test-user-pool',
    'Schema' => [
        [
            'AttributeDataType' => 'Number',
            'DeveloperOnlyAttribute' => 1,
            'Mutable' => 1,
            'Name' => 'mydev',
            'NumberAttributeConstraints' => [
                'MaxValue' => '99',
                'MinValue' => '1',
            ],
            'Required' => ,
            'StringAttributeConstraints' => [
                'MaxLength' => '99',
                'MinLength' => '1',
            ],
        ],
    ],
    'SmsAuthenticationMessage' => 'Your verification code is {####}.',
    'SmsConfiguration' => [
        'ExternalId' => 'my-role-external-id',
        'SnsCallerArn' => 'arn:aws:iam::123456789012:role/service-role/test-cognito-SMS-Role',
    ],
    'SmsVerificationMessage' => 'Your verification code is {####}.',
    'UserAttributeUpdateSettings' => [
        'AttributesRequireVerificationBeforeUpdate' => [
            'email',
        ],
    ],
    'UserPoolAddOns' => [
        'AdvancedSecurityMode' => 'OFF',
    ],
    'UserPoolTags' => [
        'my-test-tag-key' => 'my-test-tag-key',
    ],
    'UsernameConfiguration' => [
        'CaseSensitive' => 1,
    ],
    'VerificationMessageTemplate' => [
        'DefaultEmailOption' => 'CONFIRM_WITH_CODE',
        'EmailMessage' => 'Your confirmation code is {####}',
        'EmailMessageByLink' => 'Choose this link to {##verify your email##}',
        'EmailSubject' => 'Here is your confirmation code',
        'EmailSubjectByLink' => 'Here is your confirmation link',
        'SmsMessage' => 'Your confirmation code is {####}',
    ],
]);

Result syntax:

[
    'UserPool' => [
        'AccountRecoverySetting' => [
            'RecoveryMechanisms' => [
                [
                    'Name' => 'verified_email',
                    'Priority' => 1,
                ],
            ],
        ],
        'AdminCreateUserConfig' => [
            'AllowAdminCreateUserOnly' => ,
            'InviteMessageTemplate' => [
                'EmailMessage' => 'Your username is {username} and temporary password is {####}.',
                'EmailSubject' => 'Your sign-in information',
                'SMSMessage' => 'Your username is {username} and temporary password is {####}.',
            ],
            'UnusedAccountValidityDays' => 7,
        ],
        'AliasAttributes' => [
            'email',
        ],
        'Arn' => 'arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_EXAMPLE',
        'AutoVerifiedAttributes' => [
            'email',
        ],
        'CreationDate' => ,
        'DeletionProtection' => 'ACTIVE',
        'DeviceConfiguration' => [
            'ChallengeRequiredOnNewDevice' => 1,
            'DeviceOnlyRememberedOnUserPrompt' => 1,
        ],
        'EmailConfiguration' => [
            'ConfigurationSet' => 'my-test-ses-configuration-set',
            'EmailSendingAccount' => 'DEVELOPER',
            'From' => 'support@example.com',
            'ReplyToEmailAddress' => 'support@example.com',
            'SourceArn' => 'arn:aws:ses:us-east-1:123456789012:identity/support@example.com',
        ],
        'EmailVerificationMessage' => 'Your verification code is {####}.',
        'EmailVerificationSubject' => 'Verify your email address',
        'EstimatedNumberOfUsers' => 0,
        'Id' => 'us-east-1_EXAMPLE',
        'LambdaConfig' => [
            'CustomEmailSender' => [
                'LambdaArn' => 'arn:aws:lambda:us-east-1:123456789012:function:MyFunction',
                'LambdaVersion' => 'V1_0',
            ],
            'CustomMessage' => 'arn:aws:lambda:us-east-1:123456789012:function:MyFunction',
            'CustomSMSSender' => [
                'LambdaArn' => 'arn:aws:lambda:us-east-1:123456789012:function:MyFunction',
                'LambdaVersion' => 'V1_0',
            ],
            'DefineAuthChallenge' => 'arn:aws:lambda:us-east-1:123456789012:function:MyFunction',
            'KMSKeyID' => 'arn:aws:kms:us-east-1:767671399759:key/4d43904c-8edf-4bb4-9fca-fb1a80e41cbe',
            'PostAuthentication' => 'arn:aws:lambda:us-east-1:123456789012:function:MyFunction',
            'PostConfirmation' => 'arn:aws:lambda:us-east-1:123456789012:function:MyFunction',
            'PreAuthentication' => 'arn:aws:lambda:us-east-1:123456789012:function:MyFunction',
            'PreSignUp' => 'arn:aws:lambda:us-east-1:123456789012:function:MyFunction',
            'PreTokenGeneration' => 'arn:aws:lambda:us-east-1:123456789012:function:MyFunction',
            'UserMigration' => 'arn:aws:lambda:us-east-1:123456789012:function:MyFunction',
            'VerifyAuthChallengeResponse' => 'arn:aws:lambda:us-east-1:123456789012:function:MyFunction',
        ],
        'LastModifiedDate' => ,
        'MfaConfiguration' => 'OPTIONAL',
        'Name' => 'my-test-user-pool',
        'Policies' => [
            'PasswordPolicy' => [
                'MinimumLength' => 6,
                'RequireLowercase' => 1,
                'RequireNumbers' => 1,
                'RequireSymbols' => 1,
                'RequireUppercase' => 1,
                'TemporaryPasswordValidityDays' => 7,
            ],
        ],
        'SchemaAttributes' => [
            [
                'AttributeDataType' => 'String',
                'DeveloperOnlyAttribute' => ,
                'Mutable' => ,
                'Name' => 'sub',
                'Required' => 1,
                'StringAttributeConstraints' => [
                    'MaxLength' => '2048',
                    'MinLength' => '1',
                ],
            ],
            [
                'AttributeDataType' => 'String',
                'DeveloperOnlyAttribute' => ,
                'Mutable' => 1,
                'Name' => 'name',
                'Required' => ,
                'StringAttributeConstraints' => [
                    'MaxLength' => '2048',
                    'MinLength' => '0',
                ],
            ],
            [
                'AttributeDataType' => 'String',
                'DeveloperOnlyAttribute' => ,
                'Mutable' => 1,
                'Name' => 'given_name',
                'Required' => ,
                'StringAttributeConstraints' => [
                    'MaxLength' => '2048',
                    'MinLength' => '0',
                ],
            ],
            [
                'AttributeDataType' => 'String',
                'DeveloperOnlyAttribute' => ,
                'Mutable' => 1,
                'Name' => 'family_name',
                'Required' => ,
                'StringAttributeConstraints' => [
                    'MaxLength' => '2048',
                    'MinLength' => '0',
                ],
            ],
            [
                'AttributeDataType' => 'String',
                'DeveloperOnlyAttribute' => ,
                'Mutable' => 1,
                'Name' => 'middle_name',
                'Required' => ,
                'StringAttributeConstraints' => [
                    'MaxLength' => '2048',
                    'MinLength' => '0',
                ],
            ],
            [
                'AttributeDataType' => 'String',
                'DeveloperOnlyAttribute' => ,
                'Mutable' => 1,
                'Name' => 'nickname',
                'Required' => ,
                'StringAttributeConstraints' => [
                    'MaxLength' => '2048',
                    'MinLength' => '0',
                ],
            ],
            [
                'AttributeDataType' => 'String',
                'DeveloperOnlyAttribute' => ,
                'Mutable' => 1,
                'Name' => 'preferred_username',
                'Required' => ,
                'StringAttributeConstraints' => [
                    'MaxLength' => '2048',
                    'MinLength' => '0',
                ],
            ],
            [
                'AttributeDataType' => 'String',
                'DeveloperOnlyAttribute' => ,
                'Mutable' => 1,
                'Name' => 'profile',
                'Required' => ,
                'StringAttributeConstraints' => [
                    'MaxLength' => '2048',
                    'MinLength' => '0',
                ],
            ],
            [
                'AttributeDataType' => 'String',
                'DeveloperOnlyAttribute' => ,
                'Mutable' => 1,
                'Name' => 'picture',
                'Required' => ,
                'StringAttributeConstraints' => [
                    'MaxLength' => '2048',
                    'MinLength' => '0',
                ],
            ],
            [
                'AttributeDataType' => 'String',
                'DeveloperOnlyAttribute' => ,
                'Mutable' => 1,
                'Name' => 'website',
                'Required' => ,
                'StringAttributeConstraints' => [
                    'MaxLength' => '2048',
                    'MinLength' => '0',
                ],
            ],
            [
                'AttributeDataType' => 'String',
                'DeveloperOnlyAttribute' => ,
                'Mutable' => 1,
                'Name' => 'email',
                'Required' => ,
                'StringAttributeConstraints' => [
                    'MaxLength' => '2048',
                    'MinLength' => '0',
                ],
            ],
            [
                'AttributeDataType' => 'Boolean',
                'DeveloperOnlyAttribute' => ,
                'Mutable' => 1,
                'Name' => 'email_verified',
                'Required' => ,
            ],
            [
                'AttributeDataType' => 'String',
                'DeveloperOnlyAttribute' => ,
                'Mutable' => 1,
                'Name' => 'gender',
                'Required' => ,
                'StringAttributeConstraints' => [
                    'MaxLength' => '2048',
                    'MinLength' => '0',
                ],
            ],
            [
                'AttributeDataType' => 'String',
                'DeveloperOnlyAttribute' => ,
                'Mutable' => 1,
                'Name' => 'birthdate',
                'Required' => ,
                'StringAttributeConstraints' => [
                    'MaxLength' => '10',
                    'MinLength' => '10',
                ],
            ],
            [
                'AttributeDataType' => 'String',
                'DeveloperOnlyAttribute' => ,
                'Mutable' => 1,
                'Name' => 'zoneinfo',
                'Required' => ,
                'StringAttributeConstraints' => [
                    'MaxLength' => '2048',
                    'MinLength' => '0',
                ],
            ],
            [
                'AttributeDataType' => 'String',
                'DeveloperOnlyAttribute' => ,
                'Mutable' => 1,
                'Name' => 'locale',
                'Required' => ,
                'StringAttributeConstraints' => [
                    'MaxLength' => '2048',
                    'MinLength' => '0',
                ],
            ],
            [
                'AttributeDataType' => 'String',
                'DeveloperOnlyAttribute' => ,
                'Mutable' => 1,
                'Name' => 'phone_number',
                'Required' => ,
                'StringAttributeConstraints' => [
                    'MaxLength' => '2048',
                    'MinLength' => '0',
                ],
            ],
            [
                'AttributeDataType' => 'Boolean',
                'DeveloperOnlyAttribute' => ,
                'Mutable' => 1,
                'Name' => 'phone_number_verifie',
                'Required' => ,
            ],
            [
                'AttributeDataType' => 'String',
                'DeveloperOnlyAttribute' => ,
                'Mutable' => 1,
                'Name' => 'address',
                'Required' => ,
                'StringAttributeConstraints' => [
                    'MaxLength' => '2048',
                    'MinLength' => '0',
                ],
            ],
            [
                'AttributeDataType' => 'Number',
                'DeveloperOnlyAttribute' => ,
                'Mutable' => 1,
                'Name' => 'updated_at',
                'NumberAttributeConstraints' => [
                    'MinValue' => '0',
                ],
                'Required' => ,
            ],
            [
                'AttributeDataType' => 'Number',
                'DeveloperOnlyAttribute' => 1,
                'Mutable' => 1,
                'Name' => 'dev:custom:mydev',
                'NumberAttributeConstraints' => [
                    'MaxValue' => '99',
                    'MinValue' => '1',
                ],
                'Required' => ,
            ],
        ],
        'SmsAuthenticationMessage' => 'Your verification code is {####}.',
        'SmsConfiguration' => [
            'ExternalId' => 'my-role-external-id',
            'SnsCallerArn' => 'arn:aws:iam::123456789012:role/service-role/test-cognito-SMS-Role',
            'SnsRegion' => 'us-east-1',
        ],
        'SmsVerificationMessage' => 'Your verification code is {####}.',
        'UserAttributeUpdateSettings' => [
            'AttributesRequireVerificationBeforeUpdate' => [
                'email',
            ],
        ],
        'UserPoolAddOns' => [
            'AdvancedSecurityMode' => 'OFF',
        ],
        'UserPoolTags' => [
            'my-test-tag-key' => 'my-test-tag-value',
        ],
        'UsernameConfiguration' => [
            'CaseSensitive' => 1,
        ],
        'VerificationMessageTemplate' => [
            'DefaultEmailOption' => 'CONFIRM_WITH_CODE',
            'EmailMessage' => 'Your confirmation code is {####}',
            'EmailMessageByLink' => 'Choose this link to {##verify your email##}',
            'EmailSubject' => 'Here is your confirmation code',
            'EmailSubjectByLink' => 'Here is your confirmation link',
            'SmsMessage' => 'Your confirmation code is {####}',
        ],
    ],
]

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.

If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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,
    ],
    'AuthSessionValidity' => <integer>,
    '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.

If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.

AllowedOAuthFlows
Type: Array of strings

The OAuth grant types that you want your app client to generate. To create an app client that generates client credentials grants, you must add client_credentials as the only allowed OAuth flow.

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 to use OAuth 2.0 features in your user pool app client.

AllowedOAuthFlowsUserPoolClient must be true before you can configure the following features in your app client.

  • CallBackURLs: Callback URLs.

  • LogoutURLs: Sign-out redirect URLs.

  • AllowedOAuthScopes: OAuth 2.0 scopes.

  • AllowedOAuthFlows: Support for authorization code, implicit, and client credentials OAuth 2.0 grants.

To use OAuth 2.0 features, configure one of these features in the Amazon Cognito console or set AllowedOAuthFlowsUserPoolClient to true in a CreateUserPoolClient or UpdateUserPoolClient API request. If you don't set a value for AllowedOAuthFlowsUserPoolClient in a request with the CLI or SDKs, it defaults to false.

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.

AuthSessionValidity
Type: int

Amazon Cognito creates a session token for each API request in an authentication flow. AuthSessionValidity is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.

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. In app clients with one assigned IdP, replaces redirect_uri in authentication requests. 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.

For more information, see Default redirect URI.

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 you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.

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

Valid values include:

  • ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.

  • ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.

  • ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.

  • ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.

  • ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.

In some environments, you will see the values ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or USER_PASSWORD_AUTH. You can't assign these legacy ExplicitAuthFlows values to user pool clients at the same time as values that begin with ALLOW_, like ALLOW_USER_SRP_AUTH.

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 IdTokenValidity in an API request is hours. Valid range is displayed below in seconds.

If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.

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 list of user attributes that you want your app client to have read-only access to. After your user authenticates in your app, their access token authorizes them to read their own attribute value for any attribute in this list. An example of this kind of activity is when your user selects a link to view their profile information. Your app makes a GetUser API request to retrieve and display your user's profile data.

When you don't specify the ReadAttributes for your app client, your app can read the values of email_verified, phone_number_verified, and the Standard attributes of your user pool. When your user pool has read access to these default attributes, ReadAttributes doesn't return any information. Amazon Cognito only populates ReadAttributes in the API response if you have specified your own custom set of 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.

If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.

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 list of user attributes that you want your app client to have write access to. After your user authenticates in your app, their access token authorizes them to set or modify their own attribute value for any attribute in this list. An example of this kind of activity is when you present your user with a form to update their profile information and they change their last name. Your app then makes an UpdateUserAttributes API request and sets family_name to the new value.

When you don't specify the WriteAttributes for your app client, your app can write the values of the Standard attributes of your user pool. When your user pool has write access to these default attributes, WriteAttributes doesn't return any information. Amazon Cognito only populates WriteAttributes in the API response if you have specified your own custom set of write attributes.

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,
        ],
        'AuthSessionValidity' => <integer>,
        '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.

Examples

Example 1: Example user pool app client with email and username sign-in

The following example creates an app client with all configurable properties set to an example value. The resulting user pool client connects to an analytics client, allows sign-in with username and password, and has two external identity providers associated with it.

$result = $client->createUserPoolClient([
    'AccessTokenValidity' => 6,
    'AllowedOAuthFlows' => [
        'code',
    ],
    'AllowedOAuthFlowsUserPoolClient' => 1,
    'AllowedOAuthScopes' => [
        'aws.cognito.signin.user.admin',
        'openid',
    ],
    'AnalyticsConfiguration' => [
        'ApplicationId' => 'd70b2ba36a8c4dc5a04a0451a31a1e12',
        'ExternalId' => 'my-external-id',
        'RoleArn' => 'arn:aws:iam::123456789012:role/test-cognitouserpool-role',
        'UserDataShared' => 1,
    ],
    'CallbackURLs' => [
        'https://example.com',
        'http://localhost',
        'myapp://example',
    ],
    'ClientName' => 'my-test-app-client',
    'DefaultRedirectURI' => 'https://example.com',
    'ExplicitAuthFlows' => [
        'ALLOW_ADMIN_USER_PASSWORD_AUTH',
        'ALLOW_USER_PASSWORD_AUTH',
        'ALLOW_REFRESH_TOKEN_AUTH',
    ],
    'GenerateSecret' => 1,
    'IdTokenValidity' => 6,
    'LogoutURLs' => [
        'https://example.com/logout',
    ],
    'PreventUserExistenceErrors' => 'ENABLED',
    'ReadAttributes' => [
        'email',
        'address',
        'preferred_username',
    ],
    'RefreshTokenValidity' => 6,
    'SupportedIdentityProviders' => [
        'SignInWithApple',
        'MySSO',
    ],
    'TokenValidityUnits' => [
        'AccessToken' => 'hours',
        'IdToken' => 'minutes',
        'RefreshToken' => 'days',
    ],
    'UserPoolId' => 'us-east-1_EXAMPLE',
    'WriteAttributes' => [
        'family_name',
        'email',
    ],
]);

Result syntax:

[
    'UserPoolClient' => [
        'AccessTokenValidity' => 6,
        'AllowedOAuthFlows' => [
            'code',
        ],
        'AllowedOAuthFlowsUserPoolClient' => 1,
        'AllowedOAuthScopes' => [
            'aws.cognito.signin.user.admin',
            'openid',
        ],
        'AnalyticsConfiguration' => [
            'ApplicationId' => 'd70b2ba36a8c4dc5a04a0451a31a1e12',
            'ExternalId' => 'my-external-id',
            'RoleArn' => 'arn:aws:iam::123456789012:role/test-cognitouserpool-role',
            'UserDataShared' => 1,
        ],
        'AuthSessionValidity' => 3,
        'CallbackURLs' => [
            'https://example.com',
            'http://localhost',
            'myapp://example',
        ],
        'ClientId' => '26cb2c60kq7nbmas7rbme9b6pp',
        'ClientName' => 'my-test-app-client',
        'ClientSecret' => '13ka4h7u28d9oo44tqpq9djqsfvhvu8rk4d2ighvpu0k8fj1c2r9',
        'CreationDate' => ,
        'DefaultRedirectURI' => 'https://example.com',
        'EnablePropagateAdditionalUserContextData' => ,
        'EnableTokenRevocation' => 1,
        'ExplicitAuthFlows' => [
            'ALLOW_USER_PASSWORD_AUTH',
            'ALLOW_ADMIN_USER_PASSWORD_AUTH',
            'ALLOW_REFRESH_TOKEN_AUTH',
        ],
        'IdTokenValidity' => 6,
        'LastModifiedDate' => ,
        'LogoutURLs' => [
            'https://example.com/logout',
        ],
        'PreventUserExistenceErrors' => 'ENABLED',
        'ReadAttributes' => [
            'address',
            'preferred_username',
            'email',
        ],
        'RefreshTokenValidity' => 6,
        'SupportedIdentityProviders' => [
            'SignInWithApple',
            'MySSO',
        ],
        'TokenValidityUnits' => [
            'AccessToken' => 'hours',
            'IdToken' => 'minutes',
            'RefreshToken' => 'days',
        ],
        'UserPoolId' => 'us-east-1_EXAMPLE',
        'WriteAttributes' => [
            'family_name',
            'email',
        ],
    ],
]

CreateUserPoolDomain

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

Creates a new domain for a user pool.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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. Amazon Cognito returns this value if you set a custom domain with CustomDomainConfig. If you set an Amazon Cognito prefix domain, this operation returns a blank response.

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.

ConcurrentModificationException:

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

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 their own user profile.

Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

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.

Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

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.

ConcurrentModificationException:

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

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 identity provider details.

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

A unique resource server identifier for the resource server. The identifier can be an API friendly name like solar-system-data. You can also set an API URL like https://solar-system-data-api.example.com as your identifier.

Amazon Cognito represents scopes in the access token in the format $resource-server-identifier/$scope. Longer scope-identifier strings increase the size of your access tokens.

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.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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>',
        'DeletionProtection' => 'ACTIVE|INACTIVE',
        '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>',
            'PreTokenGenerationConfig' => [
                'LambdaArn' => '<string>',
                'LambdaVersion' => 'V1_0|V2_0',
            ],
            '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.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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,
        ],
        'AuthSessionValidity' => <integer>,
        '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. For more information about device authentication, see Working with user devices in your user pool.

Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

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. To use the confirmation code for resetting the password, call ConfirmForgotPassword.

If neither a verified phone number nor a verified email exists, this API returns InvalidParameterException. If your app client has a client secret and you don't provide a SECRET_HASH parameter, this API returns NotAuthorizedException.

To use this API operation, your user pool must have self-service account recovery configured. Use AdminSetUserPassword if you manage passwords as an administrator.

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

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.

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

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.

Username
Required: Yes
Type: string

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

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. For more information about device authentication, see Working with user devices in your user pool.

Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

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 identity provider details.

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.

GetLogDeliveryConfiguration

$result = $client->getLogDeliveryConfiguration([/* ... */]);
$promise = $client->getLogDeliveryConfigurationAsync([/* ... */]);

Gets the detailed activity logging configuration for a user pool.

Parameter Syntax

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

Parameter Details

Members
UserPoolId
Required: Yes
Type: string

The ID of the user pool where you want to view detailed activity logging configuration.

Result Syntax

[
    'LogDeliveryConfiguration' => [
        'LogConfigurations' => [
            [
                'CloudWatchLogsConfiguration' => [
                    'LogGroupArn' => '<string>',
                ],
                'EventSource' => 'userNotification',
                'LogLevel' => 'ERROR',
            ],
            // ...
        ],
        'UserPoolId' => '<string>',
    ],
]

Result Details

Members
LogDeliveryConfiguration

The detailed activity logging configuration of the requested user pool.

Errors

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.

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.

ResourceNotFoundException:

This exception is thrown when the Amazon Cognito service can't find the requested resource.

GetSigningCertificate

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

This method takes a user pool ID, and returns the signing certificate. The issued certificate is valid for 10 years from the date of issue.

Amazon Cognito issues and assigns a new signing certificate annually. This process returns a new value in the response to GetSigningCertificate, but doesn't invalidate the original 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.

Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

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

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
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 username of the user that you requested.

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.

Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

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.

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([/* ... */]);

Invalidates the identity, access, and refresh tokens that Amazon Cognito issued to a user. Call this operation when your user signs out of your app. This results in the following behavior.

  • Amazon Cognito no longer accepts token-authorized user operations that you authorize with a signed-out user's access tokens. For more information, see Using the Amazon Cognito user pools API and user pool endpoints.

    Amazon Cognito returns an Access Token has been revoked error when your app attempts to authorize a user pools API request with a revoked access token that contains the scope aws.cognito.signin.user.admin.

  • Amazon Cognito no longer accepts a signed-out user's ID token in a GetId request to an identity pool with ServerSideTokenCheck enabled for its user pool IdP configuration in CognitoIdentityProvider.

  • Amazon Cognito no longer accepts a signed-out user's refresh tokens in refresh requests.

Other requests might be valid until your user's token expires.

Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

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.

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

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.

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 USER_PASSWORD_AUTH: USERNAME (required), PASSWORD (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).

For more information about SECRET_HASH, see Computing secret hash values. For information about DEVICE_KEY, see Working with user devices in your user pool.

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

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

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.

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

Examples

Example 1: Example username and password sign-in for a user who has TOTP MFA

The following example signs in the user mytestuser with analytics data, client metadata, and user context data for advanced security.

$result = $client->initiateAuth([
    'AnalyticsMetadata' => [
        'AnalyticsEndpointId' => 'd70b2ba36a8c4dc5a04a0451a31a1e12',
    ],
    'AuthFlow' => 'USER_PASSWORD_AUTH',
    'AuthParameters' => [
        'PASSWORD' => 'This-is-my-test-99!',
        'SECRET_HASH' => 'oT5ZkS8ctnrhYeeGsGTvOzPhoc/Jd1cO5fueBWFVmp8=',
        'USERNAME' => 'mytestuser',
    ],
    'ClientId' => '1example23456789',
    'ClientMetadata' => [
        'MyTestKey' => 'MyTestValue',
    ],
    'UserContextData' => [
        'EncodedData' => 'AmazonCognitoAdvancedSecurityData_object',
        'IpAddress' => '192.0.2.1',
    ],
]);

Result syntax:

[
    'ChallengeName' => 'SOFTWARE_TOKEN_MFA',
    'ChallengeParameters' => [
        'FRIENDLY_DEVICE_NAME' => 'mytestauthenticator',
        'USER_ID_FOR_SRP' => 'mytestuser',
    ],
    'Session' => 'AYABeC1-y8qooiuysEv0uM4wAqQAHQABAAdTZXJ2aWNlABBDb2duaXRvVXNlclBvb2xzAAEAB2F3cy1rbXMAS2Fybjphd3M6a21zOnVzLXdlc3QtMjowMTU3MzY3MjcxOTg6a2V5LzI5OTFhNGE5LTM5YTAtNDQ0Mi04MWU4LWRkYjY4NTllMTg2MQC4AQIBAHhjxv5lVLhE2_WNrC1zuomqn08qDUUp3z9v4EGAjazZ-wGP3HuBF5Izvxf-9WkCT5uyAAAAfjB8BgkqhkiG9w0BBwagbzBtAgEAMGgGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQMeQoT5e6Dpfh52caqAgEQgDvuL8uLMhPt0WmQpZnkNED1gob6xbqt5LaQo_H4L5CuT4Kj499dGCoZ1q1trmlZSRgRm0wwGGG8lFU37QIAAAAADAAAEAAAAAAAAAAAAAAAAADuLe9_UJ4oZAMsQYr0ntiT_____wAAAAEAAAAAAAAAAAAAAAEAAADnLDGmKBQtsCafNokRmPLgl2itBKuKR2dfZBQb5ucCYkzThM5HOfQUSEL-A3dZzfYDC0IODsrcMkrbeeVyMJk-FCzsxS9Og8BEBVnvi9WjZkPJ4mF0YS6FUXnoPSBV5oUqGzRaT-tJ169SUFZAUfFM1fGeJ8T57-QdCxjyISRCWV1VG5_7TiCioyRGfWwzNVWh7exJortF3ccfOyiEyxeqJ2VJvJq3m_w8NP24_PMDpktpRMKftObIMlD5ewRTNCdrUXQ1BW5KIxhJLGjYfRzJDZuKzmEgS-VHsKz0z76w-AlAgdfvdAjflLnsgduU5kUX4YP6jqnetg',
]

ListDevices

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

Lists the sign-in devices that Amazon Cognito has registered to the current user. For more information about device authentication, see Working with user devices in your user pool.

Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

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

This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

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 identifier that Amazon Cognito returned with the previous request to this operation. When you include a pagination token in your request, Amazon Cognito returns the next set of items in the list. By use of this token, you can paginate through the full list of items.

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.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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 user import jobs for a user pool.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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

This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

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

The identifier that Amazon Cognito returned with the previous request to this operation. When you include a pagination token in your request, Amazon Cognito returns the next set of items in the list. By use of this token, you can paginate through the full list of items.

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.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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>',
                'PreTokenGenerationConfig' => [
                    'LambdaArn' => '<string>',
                    'LambdaVersion' => 'V1_0|V2_0',
                ],
                '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 users and their basic details in a user pool.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

Parameter Syntax

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

Parameter Details

Members
AttributesToGet
Type: Array of strings

A JSON array of user attribute names, for example given_name, that you want Amazon Cognito to include in the response for each user. When you don't provide an AttributesToGet parameter, Amazon Cognito returns all attributes for each user.

Use AttributesToGet with required attributes in your user pool, or in conjunction with Filter. Amazon Cognito returns an error if not all users in the results have set a value for the attribute you request. Attributes that you can't filter on, including custom attributes, must have a value set in every user profile before an AttributesToGet parameter returns results.

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

This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

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|EXTERNAL_PROVIDER',
            'Username' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
PaginationToken
Type: string

The identifier that Amazon Cognito returned with the previous request to this operation. When you include a pagination token in your request, Amazon Cognito returns the next set of items in the list. By use of this token, you can paginate through the full list of items.

Users
Type: Array of UserType structures

A list of the user pool users, and their attributes, that match your query.

Amazon Cognito creates a profile in your user pool for each native user in your user pool, and each unique user ID from your third-party identity providers (IdPs). When you link users with the AdminLinkProviderForUser API operation, the output of ListUsers displays both the IdP user and the native user that you linked. You can identify IdP users in the Users object of this API response by the IdP prefix that Amazon Cognito appends to Username.

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.

Examples

Example 1: A ListUsers request for the next 3 users whose email address starts with "testuser."

This request submits a value for all possible parameters for ListUsers. By iterating the PaginationToken, you can page through and collect all users in a user pool.

$result = $client->listUsers([
    'AttributesToGet' => [
        'email',
        'sub',
    ],
    'Filter' => '"email"^="testuser"',
    'Limit' => 3,
    'PaginationToken' => 'abcd1234EXAMPLE',
    'UserPoolId' => 'us-east-1_EXAMPLE',
]);

Result syntax:

[
    'PaginationToken' => 'efgh5678EXAMPLE',
    'Users' => [
        [
            'Attributes' => [
                [
                    'Name' => 'sub',
                    'Value' => 'eaad0219-2117-439f-8d46-4db20e59268f',
                ],
                [
                    'Name' => 'email',
                    'Value' => 'testuser@example.com',
                ],
            ],
            'Enabled' => 1,
            'UserCreateDate' => ,
            'UserLastModifiedDate' => ,
            'UserStatus' => 'CONFIRMED',
            'Username' => 'testuser',
        ],
        [
            'Attributes' => [
                [
                    'Name' => 'sub',
                    'Value' => '3b994cfd-0b07-4581-be46-3c82f9a70c90',
                ],
                [
                    'Name' => 'email',
                    'Value' => 'testuser2@example.com',
                ],
            ],
            'Enabled' => 1,
            'UserCreateDate' => ,
            'UserLastModifiedDate' => ,
            'UserStatus' => 'UNCONFIRMED',
            'Username' => 'testuser2',
        ],
        [
            'Attributes' => [
                [
                    'Name' => 'sub',
                    'Value' => '5929e0d1-4c34-42d1-9b79-a5ecacfe66f7',
                ],
                [
                    'Name' => 'email',
                    'Value' => 'testuser3@example.com',
                ],
            ],
            'Enabled' => 1,
            'UserCreateDate' => ,
            'UserLastModifiedDate' => ,
            'UserStatus' => 'UNCONFIRMED',
            'Username' => 'testuser3@example.com',
        ],
    ],
]

ListUsersInGroup

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

Lists the users in the specified group.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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 maximum number of users that you want to retrieve before pagination.

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|EXTERNAL_PROVIDER',
            '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

A list of users in the group, and their attributes.

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.

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

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.

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

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.

Username
Required: Yes
Type: string

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

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([/* ... */]);

Some API operations in a user pool generate a challenge, like a prompt for an MFA code, for device authentication that bypasses MFA, or for a custom authentication challenge. A RespondToAuthChallenge API request provides the answer to that challenge, like a code or a secure remote password (SRP). The parameters of a response to an authentication challenge vary with the type of challenge.

For more information about custom authentication challenges, see Custom authentication challenge Lambda triggers.

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

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.

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 responses to the challenge that you received in the previous request. Each challenge has its own required response parameters. The following examples are partial JSON request bodies that highlight challenge-response parameters.

You must provide a SECRET_HASH parameter in all challenge responses to an app client that has a client secret.

SMS_MFA

"ChallengeName": "SMS_MFA", "ChallengeResponses": {"SMS_MFA_CODE": "[SMS_code]", "USERNAME": "[username]"}

PASSWORD_VERIFIER

"ChallengeName": "PASSWORD_VERIFIER", "ChallengeResponses": {"PASSWORD_CLAIM_SIGNATURE": "[claim_signature]", "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]", "TIMESTAMP": [timestamp], "USERNAME": "[username]"}

Add "DEVICE_KEY" when you sign in with a remembered device.

CUSTOM_CHALLENGE

"ChallengeName": "CUSTOM_CHALLENGE", "ChallengeResponses": {"USERNAME": "[username]", "ANSWER": "[challenge_answer]"}

Add "DEVICE_KEY" when you sign in with a remembered device.

NEW_PASSWORD_REQUIRED

"ChallengeName": "NEW_PASSWORD_REQUIRED", "ChallengeResponses": {"NEW_PASSWORD": "[new_password]", "USERNAME": "[username]"}

To set any required attributes that InitiateAuth returned in an requiredAttributes parameter, add "userAttributes.[attribute_name]": "[attribute_value]". 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

"ChallengeName": "SOFTWARE_TOKEN_MFA", "ChallengeResponses": {"USERNAME": "[username]", "SOFTWARE_TOKEN_MFA_CODE": [authenticator_code]}

DEVICE_SRP_AUTH

"ChallengeName": "DEVICE_SRP_AUTH", "ChallengeResponses": {"USERNAME": "[username]", "DEVICE_KEY": "[device_key]", "SRP_A": "[srp_a]"}

DEVICE_PASSWORD_VERIFIER

"ChallengeName": "DEVICE_PASSWORD_VERIFIER", "ChallengeResponses": {"DEVICE_KEY": "[device_key]", "PASSWORD_CLAIM_SIGNATURE": "[claim_signature]", "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]", "TIMESTAMP": [timestamp], "USERNAME": "[username]"}

MFA_SETUP

"ChallengeName": "MFA_SETUP", "ChallengeResponses": {"USERNAME": "[username]"}, "SESSION": "[Session ID from VerifySoftwareToken]"

SELECT_MFA_TYPE

"ChallengeName": "SELECT_MFA_TYPE", "ChallengeResponses": {"USERNAME": "[username]", "ANSWER": "[SMS_MFA or SOFTWARE_TOKEN_MFA]"}

For more information about SECRET_HASH, see Computing secret hash values. For information about DEVICE_KEY, see Working with user devices in your user pool.

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

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.

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

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.

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, and at the same time as, the specified refresh token. After a token is revoked, you can't use the revoked token to access Amazon Cognito user APIs, or to authorize access to your resource server.

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

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.

SetLogDeliveryConfiguration

$result = $client->setLogDeliveryConfiguration([/* ... */]);
$promise = $client->setLogDeliveryConfigurationAsync([/* ... */]);

Sets up or modifies the detailed activity logging configuration of a user pool.

Parameter Syntax

$result = $client->setLogDeliveryConfiguration([
    'LogConfigurations' => [ // REQUIRED
        [
            'CloudWatchLogsConfiguration' => [
                'LogGroupArn' => '<string>',
            ],
            'EventSource' => 'userNotification', // REQUIRED
            'LogLevel' => 'ERROR', // REQUIRED
        ],
        // ...
    ],
    'UserPoolId' => '<string>', // REQUIRED
]);

Parameter Details

Members
LogConfigurations
Required: Yes
Type: Array of LogConfigurationType structures

A collection of all of the detailed activity logging configurations for a user pool.

UserPoolId
Required: Yes
Type: string

The ID of the user pool where you want to configure detailed activity logging .

Result Syntax

[
    'LogDeliveryConfiguration' => [
        'LogConfigurations' => [
            [
                'CloudWatchLogsConfiguration' => [
                    'LogGroupArn' => '<string>',
                ],
                'EventSource' => 'userNotification',
                'LogLevel' => 'ERROR',
            ],
            // ...
        ],
        'UserPoolId' => '<string>',
    ],
]

Result Details

Members
LogDeliveryConfiguration

The detailed activity logging configuration that you applied to the requested user pool.

Errors

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.

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.

ResourceNotFoundException:

This exception is thrown when the Amazon Cognito service can't find the requested resource.

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

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

The compromised credentials risk configuration.

RiskExceptionConfiguration

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.

Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

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

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.

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.

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.

ConcurrentModificationException:

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

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([/* ... */]);

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

Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

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.

SignUp

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

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

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

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.

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

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.

Username
Required: Yes
Type: string

The username of the user that you want to sign up. The value of this parameter is typically a username, but can be any alias attribute in your user pool.

ValidationData
Type: Array of AttributeType structures

Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. This set of key-value pairs are for custom validation of information that you collect from your users but don't need to retain.

Your Lambda function can analyze this additional data and act on it. Your function might perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs. Validation data might also affect the response that your function returns to Amazon Cognito, like automatically confirming the user if they sign up from within your network.

For more information about the pre sign-up Lambda trigger, see Pre sign-up Lambda trigger.

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.

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.

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.

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

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. When you provide a FeedbackValue value of valid, you tell Amazon Cognito that you trust a user session where Amazon Cognito has evaluated some level of risk. When you provide a FeedbackValue value of invalid, you tell Amazon Cognito that you don't trust a user session, or you don't believe that Amazon Cognito evaluated a high-enough risk level.

UserPoolId
Required: Yes
Type: string

The user pool ID.

Username
Required: Yes
Type: string

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

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. For more information about device authentication, see Working with user devices in your user pool.

Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

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.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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 scopes, URLs, and identifiers for your external identity provider. The following examples describe the provider detail keys for each IdP type. These values and their schema are subject to change. Social IdP authorize_scopes values must match the values listed here.

OpenID Connect (OIDC)

Amazon Cognito accepts the following elements when it can't discover endpoint URLs from oidc_issuer: attributes_url, authorize_url, jwks_uri, token_url.

Create or update request: "ProviderDetails": { "attributes_request_method": "GET", "attributes_url": "https://auth.example.com/userInfo", "authorize_scopes": "openid profile email", "authorize_url": "https://auth.example.com/authorize", "client_id": "1example23456789", "client_secret": "provider-app-client-secret", "jwks_uri": "https://auth.example.com/.well-known/jwks.json", "oidc_issuer": "https://auth.example.com", "token_url": "https://example.com/token" }

Describe response: "ProviderDetails": { "attributes_request_method": "GET", "attributes_url": "https://auth.example.com/userInfo", "attributes_url_add_attributes": "false", "authorize_scopes": "openid profile email", "authorize_url": "https://auth.example.com/authorize", "client_id": "1example23456789", "client_secret": "provider-app-client-secret", "jwks_uri": "https://auth.example.com/.well-known/jwks.json", "oidc_issuer": "https://auth.example.com", "token_url": "https://example.com/token" }

SAML

Create or update request with Metadata URL: "ProviderDetails": { "IDPInit": "true", "IDPSignout": "true", "EncryptedResponses" : "true", "MetadataURL": "https://auth.example.com/sso/saml/metadata", "RequestSigningAlgorithm": "rsa-sha256" }

Create or update request with Metadata file: "ProviderDetails": { "IDPInit": "true", "IDPSignout": "true", "EncryptedResponses" : "true", "MetadataFile": "[metadata XML]", "RequestSigningAlgorithm": "rsa-sha256" }

The value of MetadataFile must be the plaintext metadata document with all quote (") characters escaped by backslashes.

Describe response: "ProviderDetails": { "IDPInit": "true", "IDPSignout": "true", "EncryptedResponses" : "true", "ActiveEncryptionCertificate": "[certificate]", "MetadataURL": "https://auth.example.com/sso/saml/metadata", "RequestSigningAlgorithm": "rsa-sha256", "SLORedirectBindingURI": "https://auth.example.com/slo/saml", "SSORedirectBindingURI": "https://auth.example.com/sso/saml" }

LoginWithAmazon

Create or update request: "ProviderDetails": { "authorize_scopes": "profile postal_code", "client_id": "amzn1.application-oa2-client.1example23456789", "client_secret": "provider-app-client-secret"

Describe response: "ProviderDetails": { "attributes_url": "https://api.amazon.com/user/profile", "attributes_url_add_attributes": "false", "authorize_scopes": "profile postal_code", "authorize_url": "https://www.amazon.com/ap/oa", "client_id": "amzn1.application-oa2-client.1example23456789", "client_secret": "provider-app-client-secret", "token_request_method": "POST", "token_url": "https://api.amazon.com/auth/o2/token" }

Google

Create or update request: "ProviderDetails": { "authorize_scopes": "email profile openid", "client_id": "1example23456789.apps.googleusercontent.com", "client_secret": "provider-app-client-secret" }

Describe response: "ProviderDetails": { "attributes_url": "https://people.googleapis.com/v1/people/me?personFields=", "attributes_url_add_attributes": "true", "authorize_scopes": "email profile openid", "authorize_url": "https://accounts.google.com/o/oauth2/v2/auth", "client_id": "1example23456789.apps.googleusercontent.com", "client_secret": "provider-app-client-secret", "oidc_issuer": "https://accounts.google.com", "token_request_method": "POST", "token_url": "https://www.googleapis.com/oauth2/v4/token" }

SignInWithApple

Create or update request: "ProviderDetails": { "authorize_scopes": "email name", "client_id": "com.example.cognito", "private_key": "1EXAMPLE", "key_id": "2EXAMPLE", "team_id": "3EXAMPLE" }

Describe response: "ProviderDetails": { "attributes_url_add_attributes": "false", "authorize_scopes": "email name", "authorize_url": "https://appleid.apple.com/auth/authorize", "client_id": "com.example.cognito", "key_id": "1EXAMPLE", "oidc_issuer": "https://appleid.apple.com", "team_id": "2EXAMPLE", "token_request_method": "POST", "token_url": "https://appleid.apple.com/auth/token" }

Facebook

Create or update request: "ProviderDetails": { "api_version": "v17.0", "authorize_scopes": "public_profile, email", "client_id": "1example23456789", "client_secret": "provider-app-client-secret" }

Describe response: "ProviderDetails": { "api_version": "v17.0", "attributes_url": "https://graph.facebook.com/v17.0/me?fields=", "attributes_url_add_attributes": "true", "authorize_scopes": "public_profile, email", "authorize_url": "https://www.facebook.com/v17.0/dialog/oauth", "client_id": "1example23456789", "client_secret": "provider-app-client-secret", "token_request_method": "GET", "token_url": "https://graph.facebook.com/v17.0/oauth/access_token" }

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 identity provider details.

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.

ConcurrentModificationException:

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

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.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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

A unique resource server identifier for the resource server. The identifier can be an API friendly name like solar-system-data. You can also set an API URL like https://solar-system-data-api.example.com as your identifier.

Amazon Cognito represents scopes in the access token in the format $resource-server-identifier/$scope. Longer scope-identifier strings increase the size of your access tokens.

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([/* ... */]);

With this operation, your users can update one or more of their attributes with their own credentials. You authorize this API request with the user's access token. To delete an attribute from your user, submit the attribute in your API request with a blank value. Custom attribute values in this request must include the custom: prefix.

Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

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.

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([/* ... */]);

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.

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, Amazon Cognito sets it to its default value.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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>', ...],
    'DeletionProtection' => 'ACTIVE|INACTIVE',
    '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>',
        'PreTokenGenerationConfig' => [
            'LambdaArn' => '<string>', // REQUIRED
            'LambdaVersion' => 'V1_0|V2_0', // REQUIRED
        ],
        '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

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.

AutoVerifiedAttributes
Type: Array of strings

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

DeletionProtection
Type: string

When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.

When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.

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

This parameter is no longer used. See VerificationMessageTemplateType.

EmailVerificationSubject
Type: string

This parameter is no longer used. See VerificationMessageTemplateType.

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

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

This parameter is no longer used. See VerificationMessageTemplateType.

UserAttributeUpdateSettings

The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.

UserPoolAddOns
Type: UserPoolAddOnsType structure

User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to AUDIT. To configure automatic security responses to risky traffic to your user pool, set to ENFORCED.

For more information, see Adding advanced security to a user pool.

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

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, Amazon Cognito sets it to its default value.

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

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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,
    ],
    'AuthSessionValidity' => <integer>,
    '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

The access token time limit. After this limit expires, your user can't use their access token. To specify the time unit for AccessTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.

For example, when you set AccessTokenValidity to 10 and TokenValidityUnits to hours, your user can authorize access with their access token for 10 hours.

The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.

If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.

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 to use OAuth 2.0 features in your user pool app client.

AllowedOAuthFlowsUserPoolClient must be true before you can configure the following features in your app client.

  • CallBackURLs: Callback URLs.

  • LogoutURLs: Sign-out redirect URLs.

  • AllowedOAuthScopes: OAuth 2.0 scopes.

  • AllowedOAuthFlows: Support for authorization code, implicit, and client credentials OAuth 2.0 grants.

To use OAuth 2.0 features, configure one of these features in the Amazon Cognito console or set AllowedOAuthFlowsUserPoolClient to true in a CreateUserPoolClient or UpdateUserPoolClient API request. If you don't set a value for AllowedOAuthFlowsUserPoolClient in a request with the CLI or SDKs, it defaults to false.

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

AuthSessionValidity
Type: int

Amazon Cognito creates a session token for each API request in an authentication flow. AuthSessionValidity is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.

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

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.

ExplicitAuthFlows
Type: Array of strings

The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.

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

Valid values include:

  • ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.

  • ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.

  • ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.

  • ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.

  • ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.

In some environments, you will see the values ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or USER_PASSWORD_AUTH. You can't assign these legacy ExplicitAuthFlows values to user pool clients at the same time as values that begin with ALLOW_, like ALLOW_USER_SRP_AUTH.

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 IdTokenValidity in an API request is hours. Valid range is displayed below in seconds.

If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.

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 list of user attributes that you want your app client to have read-only access to. After your user authenticates in your app, their access token authorizes them to read their own attribute value for any attribute in this list. An example of this kind of activity is when your user selects a link to view their profile information. Your app makes a GetUser API request to retrieve and display your user's profile data.

When you don't specify the ReadAttributes for your app client, your app can read the values of email_verified, phone_number_verified, and the Standard attributes of your user pool. When your user pool has read access to these default attributes, ReadAttributes doesn't return any information. Amazon Cognito only populates ReadAttributes in the API response if you have specified your own custom set of 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.

If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 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 time units you use when you set the duration of ID, access, and refresh tokens. 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 list of user attributes that you want your app client to have write access to. After your user authenticates in your app, their access token authorizes them to set or modify their own attribute value for any attribute in this list. An example of this kind of activity is when you present your user with a form to update their profile information and they change their last name. Your app then makes an UpdateUserAttributes API request and sets family_name to the new value.

When you don't specify the WriteAttributes for your app client, your app can write the values of the Standard attributes of your user pool. When your user pool has write access to these default attributes, WriteAttributes doesn't return any information. Amazon Cognito only populates WriteAttributes in the API response if you have specified your own custom set of write attributes.

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,
        ],
        'AuthSessionValidity' => <integer>,
        '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.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

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<