update-notify-configuration¶

Description¶

Updates an existing notify configuration. You can update the default template, pool association, enabled channels, enabled countries, and deletion protection settings.

Synopsis¶

  update-notify-configuration
--notify-configuration-id <value>
[--default-template-id <value>]
[--pool-id <value>]
[--enabled-countries <value>]
[--enabled-channels <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-configuration-id (string) [required]

The identifier of the notify configuration to update. The NotifyConfigurationId can be found using the DescribeNotifyConfigurations operation.

Constraints:

min: 1

max: 256

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

--default-template-id (string)

The template ID to set as the default, or the special value UNSET_DEFAULT_TEMPLATE to clear the current default template.

Constraints:

min: 0

max: 256

pattern: ([A-Za-z0-9_-]*|UNSET_DEFAULT_TEMPLATE)

--pool-id (string)

The pool ID or ARN to associate, or the special value UNSET_DEFAULT_POOL_FOR_NOTIFY to clear the current default pool.

Constraints:

min: 1

max: 256

pattern: ([A-Za-z0-9_:/-]+|UNSET_DEFAULT_POOL_FOR_NOTIFY)

--enabled-countries (list)

An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, that are enabled for the notify configuration.

Constraints:

min: 0

max: 300

(string)

Constraints:

min: 2

max: 2

pattern: [A-Z]{2}

Syntax:

"string" "string" ...

--enabled-channels (list)

An array of channels to enable for the notify configuration. Supported values include SMS and VOICE .

Constraints:

min: 1

max: 4

(string)

Possible values:

SMS

VOICE

MMS

RCS

Syntax:

"string" "string" ...

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

When set to true the notify configuration can’t be deleted.

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

NotifyConfigurationArn -> (string)

The Amazon Resource Name (ARN) for the notify configuration.

Constraints:

min: 1

max: 256

pattern: arn:\S+

NotifyConfigurationId -> (string)

The unique identifier for the notify configuration.

Constraints:

min: 1

max: 64

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

DisplayName -> (string)

The display name associated with the notify configuration.

Constraints:

min: 1

max: 15

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

UseCase -> (string)

The use case for the notify configuration.

Possible values:

CODE_VERIFICATION

DefaultTemplateId -> (string)

The default template identifier associated with the notify configuration.

Constraints:

min: 0

max: 256

pattern: ([A-Za-z0-9_-]*|UNSET_DEFAULT_TEMPLATE)

PoolId -> (string)

The identifier of the pool associated with the notify configuration.

EnabledCountries -> (list)

An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, that are enabled for the notify configuration.

Constraints:

min: 0

max: 300

(string)

Constraints:

min: 2

max: 2

pattern: [A-Z]{2}

EnabledChannels -> (list)

An array of channels enabled for the notify configuration. Supported values include SMS and VOICE .

Constraints:

min: 1

max: 4

(string)

Possible values:

SMS

VOICE

MMS

RCS

Tier -> (string)

The tier of the notify configuration.

Possible values:

BASIC

ADVANCED

TierUpgradeStatus -> (string)

The tier upgrade status of the notify configuration.

Possible values:

BASIC

PENDING_UPGRADE

ADVANCED

REJECTED

Status -> (string)

The current status of the notify configuration.

Possible values:

PENDING

ACTIVE

REJECTED

REQUIRES_VERIFICATION

RejectionReason -> (string)

The reason the notify configuration was rejected, if applicable.

DeletionProtectionEnabled -> (boolean)

When set to true deletion protection is enabled. By default this is set to false.

CreatedTimestamp -> (timestamp)

The time when the notify configuration was created, in UNIX epoch time format.

Table of Contents

Feedback

User Guide