CognitoIdentityProvider / Client / admin_update_device_status

admin_update_device_status#

CognitoIdentityProvider.Client.admin_update_device_status(**kwargs)#

Updates the device status as an administrator.

Note

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

See also: AWS API Documentation

Request Syntax

response = client.admin_update_device_status(
    UserPoolId='string',
    Username='string',
    DeviceKey='string',
    DeviceRememberedStatus='remembered'|'not_remembered'
)
Parameters:

  • UserPoolId (string) –

    [REQUIRED]

    The user pool ID.

  • Username (string) –

    [REQUIRED]

    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.

  • DeviceKey (string) –

    [REQUIRED]

    The device key.

  • DeviceRememberedStatus (string) – The status indicating whether a device has been remembered or not.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

    The status response to the request to update the device, as an administrator.

Exceptions