send-notify-code-verification¶

Description¶

Generates a one-time passcode and delivers it to a recipient over the requested channel. The passcode policy is captured from the referenced notify code configuration at the time of the request, so later updates to the configuration do not affect verifications that are already in progress.

Synopsis¶

  send-notify-code-verification
--channel <value>
--destination-identity <value>
--origination-identity <value>
[--notify-code-configuration <value>]
[--override-channel-parameters <value>]
[--override-code-configuration-parameters <value>]
[--configuration-set-name <value>]
[--context <value>]
[--reference-id <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--channel (string) [required]

The channel used to deliver the one-time passcode to the recipient.

Possible values:

TEXT

VOICE

WHATSAPP

--destination-identity (string) [required]

The recipient identifier. For the TEXT and VOICE channels, specify an E.164 phone number. For the WhatsApp channel, specify a WhatsApp address.

Constraints:

min: 1

max: 20

pattern: [\x21-\x22\x24-\x7E]+

--origination-identity (string) [required]

The identity used to send the message, such as a phone number, sender ID, or pool that is owned by your account.

Constraints:

min: 1

max: 256

pattern: [A-Za-z0-9_:/+-]+

--notify-code-configuration (string)

The identifier or Amazon Resource Name (ARN) of the notify code configuration that supplies the passcode policy and template defaults. When you do not specify a configuration, you must supply the template in the request.

Constraints:

min: 1

max: 256

pattern: [A-Za-z0-9_:/-]+

--override-channel-parameters (structure)

The channel-specific parameters used to render and deliver the one-time passcode for this request. The route that is derived from the channel and the origination identity selects the matching channel. When you do not specify channel parameters, the service uses the parameters from the referenced notify code configuration.

text -> (structure)

The parameters for the text channel, which delivers over SMS or RCS.

inlineTemplateBody -> (string)

The freeform message template used to render the one-time passcode for the SMS or RCS channels. The template must contain the code placeholder.

Constraints:

min: 1

max: 6000

pattern: [\s\S]*\S[\s\S]*

destinationCountryParameters -> (map)

A map of country-specific parameters that control one-time passcode delivery.

Constraints:

min: 1

max: 10

key -> (string)

Key of a DestinationCountryParameters map entry. Up to 64 non-whitespace characters.

Constraints:

min: 1

max: 64

pattern: \S+

value -> (string)

Value of a DestinationCountryParameters map entry. Up to 64 non-whitespace characters.

Constraints:

min: 1

max: 64

pattern: \S+

voice -> (structure)

The parameters for the voice channel.

inlineTemplateBody -> (string)

The freeform message template used to render the one-time passcode for the voice channel. The template must contain the code placeholder.

Constraints:

min: 1

max: 6000

pattern: [\s\S]*\S[\s\S]*

languageCode -> (string)

The BCP 47 language code used to render the voice message.

Constraints:

min: 2

max: 35

pattern: \S+

voiceId -> (string)

The Amazon Polly voice ID used for the voice channel.

Constraints:

min: 1

max: 64

pattern: [A-Za-z0-9]+

voiceMessageBodyTextType -> (string)

The format of the voice message body. Valid values are TEXT and SSML.

Possible values:

TEXT

SSML

notify -> (structure)

The parameters for the preapproved notify-template route over the SMS or voice channels.

notifyTemplateId -> (string)

The identifier of a preapproved notify template for the SMS or voice channels.

Constraints:

min: 1

max: 256

pattern: [A-Za-z0-9_-]+

voiceId -> (string)

The Amazon Polly voice ID used when the notify template is delivered over the voice channel.

Constraints:

min: 1

max: 64

pattern: [A-Za-z0-9]+

whatsApp -> (structure)

The parameters for the WhatsApp channel.

whatsAppTemplateName -> (string)

The name of the Meta-approved WhatsApp authentication template.

Constraints:

min: 1

max: 512

pattern: \S+

languageCode -> (string)

The BCP 47 language code used to render the template. This value is required for the WhatsApp channel.

Constraints:

min: 2

max: 35

pattern: \S+

Shorthand Syntax:

text={inlineTemplateBody=string,destinationCountryParameters={KeyName1=string,KeyName2=string}},voice={inlineTemplateBody=string,languageCode=string,voiceId=string,voiceMessageBodyTextType=string},notify={notifyTemplateId=string,voiceId=string},whatsApp={whatsAppTemplateName=string,languageCode=string}

JSON Syntax:

{
  "text": {
    "inlineTemplateBody": "string",
    "destinationCountryParameters": {"string": "string"
      ...}
  },
  "voice": {
    "inlineTemplateBody": "string",
    "languageCode": "string",
    "voiceId": "string",
    "voiceMessageBodyTextType": "TEXT"|"SSML"
  },
  "notify": {
    "notifyTemplateId": "string",
    "voiceId": "string"
  },
  "whatsApp": {
    "whatsAppTemplateName": "string",
    "languageCode": "string"
  }
}

--override-code-configuration-parameters (structure)

The per-send overrides for the passcode policy parameters, including the code type, length, validity period, and maximum number of attempts. These values override the values from the referenced notify code configuration. When you do not specify a value, the value from the configuration is used, and if neither is set, the service default applies.

codeType -> (string)

The character set used to generate the one-time passcode. Valid values are NUMERIC (digits only), ALPHA (uppercase letters only), and ALPHANUMERIC (uppercase letters and digits). When you do not specify a value, the default is applied when a passcode is sent.

Possible values:

NUMERIC

ALPHA

ALPHANUMERIC

codeLength -> (integer)

The number of characters in the one-time passcode. Valid values range from 4 through 8. When you do not specify a value, the default is applied when a passcode is sent.

Constraints:

min: 4

max: 8

validityPeriodMinutes -> (integer)

The length of time, in minutes, that the one-time passcode remains valid. Valid values range from 1 through 60. When you do not specify a value, the default is applied when a passcode is sent.

Constraints:

min: 1

max: 60

maxAttempts -> (integer)

The maximum number of validation attempts that are allowed before the verification is locked. Valid values range from 1 through 5. When you do not specify a value, the default is applied when a passcode is sent.

Constraints:

min: 1

max: 5

Shorthand Syntax:

codeType=string,codeLength=integer,validityPeriodMinutes=integer,maxAttempts=integer

JSON Syntax:

{
  "codeType": "NUMERIC"|"ALPHA"|"ALPHANUMERIC",
  "codeLength": integer,
  "validityPeriodMinutes": integer,
  "maxAttempts": integer
}

--configuration-set-name (string)

The name of the configuration set used to control how delivery events for the message are handled.

Constraints:

min: 1

max: 256

pattern: [A-Za-z0-9_-]+

--context (map)

A map of custom key and value pairs that are propagated to the delivery events for this verification.

Constraints:

min: 0

max: 5

key -> (string)

Caller-supplied context propagated to delivery events for this verification.

Constraints:

min: 1

max: 100

pattern: \S+

value -> (string)

Caller-supplied context value. Blank space is not allowed at the front or end.

Constraints:

min: 1

max: 800

pattern: \S(?:[\s\S]*\S)?

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--reference-id (string)

A caller-supplied reference identifier that binds a send request to a later validate request. Specify the same value in both requests.

Constraints:

min: 1

max: 256

pattern: [A-Za-z0-9_-]+

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream
off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

verificationId -> (string)

The service-generated identifier for the verification.

Constraints:

min: 1

max: 64

pattern: [A-Za-z0-9_:/-]+

messageId -> (string)

The service-generated identifier for the message that delivers the one-time passcode.

Constraints:

min: 1

max: 256

pattern: [A-Za-z0-9_:/-]+

Table of Contents

Feedback

User Guide

send-notify-code-verification¶

Description¶

Synopsis¶

Options¶

Global Options¶

Output¶