[ aws . cognito-idp ]

confirm-device

Description

Confirms tracking of the device. This API call is the call that begins device tracking.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  confirm-device
--access-token <value>
--device-key <value>
[--device-secret-verifier-config <value>]
[--device-name <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-secret-verifier-config (structure)

The configuration of the device secret verifier.

PasswordVerifier -> (string)

The password verifier.

Salt -> (string)

The salt.

Shorthand Syntax:

PasswordVerifier=string,Salt=string

JSON Syntax:

{
  "PasswordVerifier": "string",
  "Salt": "string"
}

--device-name (string)

The device name.

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

Output

UserConfirmationNecessary -> (boolean)

Indicates whether the user confirmation must confirm the device response.