[ aws . pinpoint ]



Verify an OTP

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


--application-id <value>
--verify-otp-message-request-parameters <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]


--application-id (string)

The unique ID of your Amazon Pinpoint application.

--verify-otp-message-request-parameters (structure)

Verify OTP message request.

DestinationIdentity -> (string)

The destination identity to send OTP to.

Otp -> (string)

The OTP the end user provided for verification.

ReferenceId -> (string)

The reference identifier provided when the OTP was previously sent.

Shorthand Syntax:


JSON Syntax:

  "DestinationIdentity": "string",
  "Otp": "string",
  "ReferenceId": "string"

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


VerificationResponse -> (structure)

Verify OTP Message Response.

Valid -> (boolean)

Specifies whether the OTP is valid or not.