update-notify-code-configuration¶

Description¶

Updates the mutable fields of a notify code configuration. Only the fields that you supply are changed. For the template and language fields, supplying an empty value clears the currently stored value.

Synopsis¶

  update-notify-code-configuration
--notify-code-configuration-id <value>
[--notify-code-configuration-name <value>]
[--code-configuration-parameters <value>]
[--channel-parameters <value>]
[--deletion-protection-enabled | --no-deletion-protection-enabled]
[--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¶

--notify-code-configuration-id (string) [required]

The unique identifier of the notify code configuration. You can specify either the bare ID or the full Amazon Resource Name (ARN).

Constraints:

min: 1

max: 256

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

--notify-code-configuration-name (string)

The name of the notify code configuration.

Constraints:

min: 1

max: 64

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

--code-configuration-parameters (structure)

The updated passcode policy parameters, including the code type, length, validity period, and maximum number of attempts. When you omit a member, its current value is preserved.

codeType -> (string)

The updated character set used to generate the one-time passcode. Omit this member to preserve the current value.

Possible values:

NUMERIC

ALPHA

ALPHANUMERIC

codeLength -> (integer)

The updated number of characters in the one-time passcode. Valid values range from 4 through 8. Omit this member to preserve the current value.

Constraints:

min: 4

max: 8

validityPeriodMinutes -> (integer)

The updated length of time, in minutes, that the one-time passcode remains valid. Valid values range from 1 through 60. Omit this member to preserve the current value.

Constraints:

min: 1

max: 60

maxAttempts -> (integer)

The updated maximum number of validation attempts that are allowed before the verification is locked. Valid values range from 1 through 5. Omit this member to preserve the current value.

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
}

--channel-parameters (structure)

The updated channel-specific parameters used to render and deliver the one-time passcode. This is a loose, nested update: when you omit a channel, that channel’s parameters remain unchanged. Within a supplied channel, an empty string on a string member, or an empty map on the destination-country parameters, clears the currently stored value, and absent members preserve the current value.

text -> (structure)

The text-channel parameters to update. Omit this member to leave the text-channel parameters unchanged.

inlineTemplateBody -> (string)

The updated freeform SMS or RCS template body. An empty string clears the previously stored value.

Constraints:

min: 0

max: 6000

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

destinationCountryParameters -> (map)

The updated map of country-specific parameters that control one-time passcode delivery. An empty map clears the previously stored value.

Constraints:

min: 0

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 voice-channel parameters to update. Omit this member to leave the voice-channel parameters unchanged.

inlineTemplateBody -> (string)

The updated freeform voice template body. An empty string clears the previously stored value.

Constraints:

min: 0

max: 6000

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

languageCode -> (string)

The updated BCP 47 language code. An empty string clears the previously stored value.

Constraints:

min: 0

max: 35

pattern: (\S{2,35})?

voiceId -> (string)

The updated Amazon Polly voice ID. An empty string clears the previously stored value.

Constraints:

min: 0

max: 64

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

voiceMessageBodyTextType -> (string)

The updated format of the voice message body. Valid values are TEXT and SSML. Omit this member to preserve the current value.

Possible values:

TEXT

SSML

notify -> (structure)

The notify-template-route parameters to update. Omit this member to leave them unchanged.

notifyTemplateId -> (string)

The updated identifier of a preapproved notify template for the SMS or voice channels. An empty string clears the previously stored value.

Constraints:

min: 0

max: 256

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

voiceId -> (string)

The updated Amazon Polly voice ID. An empty string clears the previously stored value.

Constraints:

min: 0

max: 64

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

whatsApp -> (structure)

The WhatsApp-channel parameters to update. Omit this member to leave the WhatsApp-channel parameters unchanged.

whatsAppTemplateName -> (string)

The updated name of the Meta-approved WhatsApp authentication template. An empty string clears the previously stored value.

Constraints:

min: 0

max: 512

pattern: \S*

languageCode -> (string)

The updated BCP 47 language code. An empty string clears the previously stored value.

Constraints:

min: 0

max: 35

pattern: (\S{2,35})?

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"
  }
}

--deletion-protection-enabled | --no-deletion-protection-enabled (boolean)

Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.

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

notifyCodeConfiguration -> (structure)

The notify code configuration resource.

notifyCodeConfigurationId -> (string) [required]

The unique identifier of the notify code configuration.

Constraints:

min: 1

max: 64

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

notifyCodeConfigurationArn -> (string) [required]

The Amazon Resource Name (ARN) of the notify code configuration.

Constraints:

min: 20

max: 256

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

notifyCodeConfigurationName -> (string) [required]

The name of the notify code configuration.

Constraints:

min: 1

max: 64

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

codeConfigurationParameters -> (structure)

The passcode policy parameters, including the code type, length, validity period, and maximum number of attempts.

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

channelParameters -> (structure)

The channel-specific parameters used to render and deliver the one-time passcode. A configuration can carry parameters for every channel at once, and the send route selects the matching channel at send time.

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+

deletionProtectionEnabled -> (boolean) [required]

Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.

createdAt -> (timestamp) [required]

The time when the resource was created, in Unix epoch time.

updatedAt -> (timestamp) [required]

The time when the resource was last updated, in Unix epoch time.

Table of Contents

Feedback

User Guide