Amazon Cognito Identity Provider 2016-04-18

AddCustomAttributes

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

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

Result Syntax

[]

Result Details

Errors

• ResourceNotFoundException:

  This exception is thrown when the Amazon Cognito service cannot 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 is not authorized.

• UserImportInProgressException:

  This exception is thrown when you are 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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result 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 cannot 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 is not authorized.

• UserNotFoundException:

  This exception is thrown when a user is not found.

• InternalErrorException:

  This exception is thrown when Amazon Cognito encounters an internal error.

AdminConfirmSignUp

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceNotFoundException:

  This exception is thrown when the Amazon Cognito service cannot find the requested resource.

• InvalidParameterException:

  This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

• UnexpectedLambdaException:

  This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.

• UserLambdaValidationException:

  This exception is thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.

• NotAuthorizedException:

  This exception is thrown when a user is not authorized.

• TooManyFailedAttemptsException:

  This exception is thrown when the user has made too many failed attempts for a given action (e.g., sign in).

• InvalidLambdaResponseException:

  This exception is thrown when the Amazon Cognito service encounters an invalid AWS 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 AWS resource.

• UserNotFoundException:

  This exception is thrown when a user is not found.

• InternalErrorException:

  This exception is thrown when Amazon Cognito encounters an internal error.

AdminCreateUser

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

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

Result Syntax

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

Result Details

Errors

• ResourceNotFoundException:

  This exception is thrown when the Amazon Cognito service cannot 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 is not 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 the Amazon Cognito service encounters an invalid password.

• CodeDeliveryFailureException:

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

• UnexpectedLambdaException:

  This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.

• UserLambdaValidationException:

  This exception is thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.

• InvalidLambdaResponseException:

  This exception is thrown when the Amazon Cognito service encounters an invalid AWS 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 does not have permission to publish using Amazon SNS.

• InvalidSmsRoleTrustRelationshipException:

  This exception is thrown when the trust relationship is invalid for the role provided for SMS configuration. This can happen if you do not 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 is not authorized.

• UnsupportedUserStateException:

  The request failed because the user is in an unsupported state.

• InternalErrorException:

  This exception is thrown when Amazon Cognito encounters an internal error.

AdminDeleteUser

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceNotFoundException:

  This exception is thrown when the Amazon Cognito service cannot 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 is not authorized.

• UserNotFoundException:

  This exception is thrown when a user is not found.

• InternalErrorException:

  This exception is thrown when Amazon Cognito encounters an internal error.

AdminDeleteUserAttributes

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceNotFoundException:

  This exception is thrown when the Amazon Cognito service cannot 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 is not authorized.

• UserNotFoundException:

  This exception is thrown when a user is not found.

• InternalErrorException:

  This exception is thrown when Amazon Cognito encounters an internal error.

AdminDisableProviderForUser

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceNotFoundException:

  This exception is thrown when the Amazon Cognito service cannot 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 is not authorized.

• UserNotFoundException:

  This exception is thrown when a user is not found.

• AliasExistsException:

  This exception is thrown when a user tries to confirm the account with an email or phone number that has already been supplied as an alias from a different account. This exception tells user that an account with this email or phone already exists.

• InternalErrorException:

  This exception is thrown when Amazon Cognito encounters an internal error.

AdminDisableUser

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceNotFoundException:

  This exception is thrown when the Amazon Cognito service cannot 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 is not authorized.

• UserNotFoundException:

  This exception is thrown when a user is not found.

• InternalErrorException:

  This exception is thrown when Amazon Cognito encounters an internal error.

AdminEnableUser

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceNotFoundException:

  This exception is thrown when the Amazon Cognito service cannot 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 is not authorized.

• UserNotFoundException:

  This exception is thrown when a user is not found.

• InternalErrorException:

  This exception is thrown when Amazon Cognito encounters an internal error.

AdminForgetDevice

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceNotFoundException:

  This exception is thrown when the Amazon Cognito service cannot 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 invalid.

• 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 is not authorized.

• UserNotFoundException:

  This exception is thrown when a user is not found.

• InternalErrorException:

  This exception is thrown when Amazon Cognito encounters an internal error.

AdminGetDevice

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• ResourceNotFoundException:

  This exception is thrown when the Amazon Cognito service cannot 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 invalid.

• 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 is not authorized.

AdminGetUser

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• ResourceNotFoundException:

  This exception is thrown when the Amazon Cognito service cannot 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 is not authorized.

• UserNotFoundException:

  This exception is thrown when a user is not found.

• InternalErrorException:

  This exception is thrown when Amazon Cognito encounters an internal error.

AdminInitiateAuth

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

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

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

Errors

• ResourceNotFoundException:

  This exception is thrown when the Amazon Cognito service cannot 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 is not 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 the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.

• InvalidUserPoolConfigurationException:

  This exception is thrown when the user pool configuration is invalid.

• UserLambdaValidationException:

  This exception is thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.

• InvalidLambdaResponseException:

  This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.

• MFAMethodNotFoundException:

  This exception is thrown when Amazon Cognito cannot find a multi-factor authentication (MFA) method.

• InvalidSmsRoleAccessPolicyException:

  This exception is returned when the role provided for SMS configuration does not have permission to publish using Amazon SNS.

• InvalidSmsRoleTrustRelationshipException:

  This exception is thrown when the trust relationship is invalid for the role provided for SMS configuration. This can happen if you do not 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 is not found.

• UserNotConfirmedException:

  This exception is thrown when a user is not confirmed successfully.

AdminLinkProviderForUser

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

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

Result Syntax

[]

Result Details

Errors

• ResourceNotFoundException:

  This exception is thrown when the Amazon Cognito service cannot 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 is not authorized.

• UserNotFoundException:

  This exception is thrown when a user is not found.

• AliasExistsException:

  This exception is thrown when a user tries to confirm the account with an email or phone number that has already been supplied as an alias from a different account. This exception tells user that an account with this email or phone already exists.

• LimitExceededException:

  This exception is thrown when a user exceeds the limit for a requested AWS resource.

• InternalErrorException:

  This exception is thrown when Amazon Cognito encounters an internal error.

AdminListDevices

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result 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 cannot find the requested resource.

• InvalidUserPoolConfigurationException:

  This exception is thrown when the user pool configuration is invalid.

• 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 is not authorized.

AdminListGroupsForUser

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result 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 cannot 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 is not authorized.

• UserNotFoundException:

  This exception is thrown when a user is not found.

• InternalErrorException:

  This exception is thrown when Amazon Cognito encounters an internal error.

AdminListUserAuthEvents

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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 cannot 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 is not authorized.

• UserNotFoundException:

  This exception is thrown when a user is not found.

• UserPoolAddOnNotEnabledException:

  This exception is thrown when user pool add-ons are not enabled.

• InternalErrorException:

  This exception is thrown when Amazon Cognito encounters an internal error.

AdminRemoveUserFromGroup

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result 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 cannot 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 is not authorized.

• UserNotFoundException:

  This exception is thrown when a user is not found.

• InternalErrorException:

  This exception is thrown when Amazon Cognito encounters an internal error.

AdminResetUserPassword

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceNotFoundException:

  This exception is thrown when the Amazon Cognito service cannot find the requested resource.

• InvalidParameterException:

  This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

• UnexpectedLambdaException:

  This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.

• UserLambdaValidationException:

  This exception is thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.

• NotAuthorizedException:

  This exception is thrown when a user is not authorized.

• InvalidLambdaResponseException:

  This exception is thrown when the Amazon Cognito service encounters an invalid AWS 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 AWS resource.

• UserNotFoundException:

  This exception is thrown when a user is not found.

• InvalidSmsRoleAccessPolicyException:

  This exception is returned when the role provided for SMS configuration does not have permission to publish using Amazon SNS.

• InvalidEmailRoleAccessPolicyException:

  This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code: 400.

• InvalidSmsRoleTrustRelationshipException:

  This exception is thrown when the trust relationship is invalid for the role provided for SMS configuration. This can happen if you do not 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([/* ... */]);

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

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

Errors

• ResourceNotFoundException:

  This exception is thrown when the Amazon Cognito service cannot 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 is not authorized.

• CodeMismatchException:

  This exception is thrown if the provided code does not match what the server was expecting.

• ExpiredCodeException:

  This exception is thrown if a code has expired.

• UnexpectedLambdaException:

  This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.

• InvalidPasswordException:

  This exception is thrown when the Amazon Cognito service encounters an invalid password.

• UserLambdaValidationException:

  This exception is thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.

• InvalidLambdaResponseException:

  This exception is thrown when the Amazon Cognito service encounters an invalid AWS 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 invalid.

• InternalErrorException:

  This exception is thrown when Amazon Cognito encounters an internal error.

• MFAMethodNotFoundException:

  This exception is thrown when Amazon Cognito cannot find a multi-factor authentication (MFA) method.

• InvalidSmsRoleAccessPolicyException:

  This exception is returned when the role provided for SMS configuration does not have permission to publish using Amazon SNS.

• InvalidSmsRoleTrustRelationshipException:

  This exception is thrown when the trust relationship is invalid for the role provided for SMS configuration. This can happen if you do not 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 or phone number that has already been supplied as an alias from a different account. This exception tells user that an account with this email or phone already exists.

• PasswordResetRequiredException:

  This exception is thrown when a password reset is required.

• UserNotFoundException:

  This exception is thrown when a user is not found.

• UserNotConfirmedException:

  This exception is thrown when a user is not confirmed successfully.

• SoftwareTokenMFANotFoundException:

  This exception is thrown when the software token TOTP multi-factor authentication (MFA) is not enabled for the user pool.

AdminSetUserMFAPreference

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

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

Result Syntax

[]

Result Details

Errors

• ResourceNotFoundException:

  This exception is thrown when the Amazon Cognito service cannot 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 is not authorized.

• PasswordResetRequiredException:

  This exception is thrown when a password reset is required.

• UserNotFoundException:

  This exception is thrown when a user is not found.

• UserNotConfirmedException:

  This exception is thrown when a user is not confirmed successfully.

• InternalErrorException:

  This exception is thrown when Amazon Cognito encounters an internal error.

AdminSetUserPassword

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceNotFoundException:

  This exception is thrown when the Amazon Cognito service cannot find the requested resource.

• NotAuthorizedException:

  This exception is thrown when a user is not authorized.

• UserNotFoundException:

  This exception is thrown when a user is not 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 the Amazon Cognito service encounters an invalid password.

AdminSetUserSettings

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceNotFoundException:

  This exception is thrown when the Amazon Cognito service cannot 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 is not authorized.

• UserNotFoundException:

  This exception is thrown when a user is not found.

• InternalErrorException:

  This exception is thrown when Amazon Cognito encounters an internal error.

AdminUpdateAuthEventFeedback

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result 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 cannot 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 is not authorized.

• UserNotFoundException:

  This exception is thrown when a user is not found.

• UserPoolAddOnNotEnabledException:

  This exception is thrown when user pool add-ons are not enabled.

• InternalErrorException:

  This exception is thrown when Amazon Cognito encounters an internal error.

AdminUpdateDeviceStatus

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result 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 cannot find the requested resource.

• InvalidUserPoolConfigurationException:

  This exception is thrown when the user pool configuration is invalid.

• 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 is not authorized.

• UserNotFoundException:

  This exception is thrown when a user is not found.

• InternalErrorException:

  This exception is thrown when Amazon Cognito encounters an internal error.

AdminUpdateUserAttributes

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceNotFoundException:

  This exception is thrown when the Amazon Cognito service cannot find the requested resource.

• InvalidParameterException:

  This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

• UnexpectedLambdaException:

  This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.

• UserLambdaValidationException:

  This exception is thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.

• InvalidLambdaResponseException:

  This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.

• AliasExistsException:

  This exception is thrown when a user tries to confirm the account with an email or phone number that has already been supplied as an alias from a different account. This exception tells user that an account with this email or phone already exists.

• 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 is not authorized.

• UserNotFoundException:

  This exception is thrown when a user is not 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 does not have permission to publish using Amazon SNS.

• InvalidEmailRoleAccessPolicyException:

  This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code: 400.

• InvalidSmsRoleTrustRelationshipException:

  This exception is thrown when the trust relationship is invalid for the role provided for SMS configuration. This can happen if you do not 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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceNotFoundException:

  This exception is thrown when the Amazon Cognito service cannot 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 is not authorized.

• UserNotFoundException:

  This exception is thrown when a user is not found.

• InternalErrorException:

  This exception is thrown when Amazon Cognito encounters an internal error.

AssociateSoftwareToken

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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 is not authorized.

• ResourceNotFoundException:

  This exception is thrown when the Amazon Cognito service cannot 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 TOTP multi-factor authentication (MFA) is not enabled for the user pool.

ChangePassword

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceNotFoundException:

  This exception is thrown when the Amazon Cognito service cannot find the requested resource.

• InvalidParameterException:

  This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

• InvalidPasswordException:

  This exception is thrown when the Amazon Cognito service encounters an invalid password.

• NotAuthorizedException:

  This exception is thrown when a user is not 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 AWS resource.

• PasswordResetRequiredException:

  This exception is thrown when a password reset is required.

• UserNotFoundException:

  This exception is thrown when a user is not found.

• UserNotConfirmedException:

  This exception is thrown when a user is not confirmed successfully.

• InternalErrorException:

  This exception is thrown when Amazon Cognito encounters an internal error.

ConfirmDevice

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• ResourceNotFoundException:

  This exception is thrown when the Amazon Cognito service cannot 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 is not authorized.

• InvalidPasswordException:

  This exception is thrown when the Amazon Cognito service encounters an invalid password.

• InvalidLambdaResponseException:

  This exception is thrown when the Amazon Cognito service encounters an invalid AWS 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 invalid.

• 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 is not found.

• UserNotConfirmedException:

  This exception is thrown when a user is not confirmed successfully.

• InternalErrorException:

  This exception is thrown when Amazon Cognito encounters an internal error.

ConfirmForgotPassword

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

Parameter Syntax

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

Parameter Details