[ aws . cognito-idp ]



Updates the device status as an administrator.

Calling this action requires developer credentials.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


--user-pool-id <value>
--username <value>
--device-key <value>
[--device-remembered-status <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]


--user-pool-id (string)

The user pool ID.

--username (string)

The user name.

--device-key (string)

The device key.

--device-remembered-status (string)

The status indicating whether a device has been remembered or not.

Possible values:

  • remembered

  • not_remembered

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.


To update device status

This example sets the device remembered status for the device identified by device-key to not_remembered.


aws cognito-idp admin-update-device-status --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --device-key xxxx  --device-remembered-status not_remembered