CognitoIdentityProvider / Client / forget_device

forget_device#

CognitoIdentityProvider.Client.forget_device(**kwargs)#

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.

Note

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.

See also: AWS API Documentation

Request Syntax

response = client.forget_device(
    AccessToken='string',
    DeviceKey='string'
)
Parameters:

  • AccessToken (string) – A valid access token that Amazon Cognito issued to the user whose registered device you want to forget.

  • DeviceKey (string) –

    [REQUIRED]

    The device key.

Returns:

None

Exceptions