[ aws . cognito-idp ]

update-device-status

Description

Updates the device status.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-device-status
--access-token <value>
--device-key <value>
[--device-remembered-status <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--access-token (string)

The access token.

--device-key (string)

The device key.

--device-remembered-status (string)

The status of whether a device is remembered.

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.

See ‘aws help’ for descriptions of global parameters.

Examples

To update device status

This example updates the status for a device to “not_remembered”.

Command:

aws cognito-idp update-device-status --access-token ACCESS_TOKEN --device-key DEVICE_KEY --device-remembered-status "not_remembered"

Output

None