admin_update_device_status

CognitoIdentityProvider.Client.admin_update_device_status(**kwargs)

Updates the device status as an administrator.

Calling this action requires developer credentials.

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

• 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

• CognitoIdentityProvider.Client.exceptions.InvalidParameterException
• CognitoIdentityProvider.Client.exceptions.ResourceNotFoundException
• CognitoIdentityProvider.Client.exceptions.InvalidUserPoolConfigurationException
• CognitoIdentityProvider.Client.exceptions.TooManyRequestsException
• CognitoIdentityProvider.Client.exceptions.NotAuthorizedException
• CognitoIdentityProvider.Client.exceptions.UserNotFoundException
• CognitoIdentityProvider.Client.exceptions.InternalErrorException