AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . pinpoint-sms-voice-v2 ]

create-notify-configuration

Description

Creates a new notify configuration for managed messaging. A notify configuration defines the settings for sending templated messages, including the display name, use case, enabled channels, and enabled countries.

See also: AWS API Documentation

Synopsis

  create-notify-configuration
--display-name <value>
--use-case <value>
[--default-template-id <value>]
[--pool-id <value>]
[--enabled-countries <value>]
--enabled-channels <value>
[--deletion-protection-enabled | --no-deletion-protection-enabled]
[--client-token <value>]
[--tags <value>]
[--cli-input-json <value>]
[--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>]
[--v2-debug]

Options

--display-name (string)

The display name to associate with the notify configuration.

--use-case (string)

The use case for the notify configuration.

Possible values:

  • CODE_VERIFICATION

--default-template-id (string)

The default template identifier to associate with the notify configuration. If specified, this template is used when sending messages without an explicit template identifier.

--pool-id (string)

The identifier of the pool to associate with the notify configuration.

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

(string)

Syntax:

"string" "string" ...

--enabled-channels (list)

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

(string)

Syntax:

"string" "string" ...

Where valid values are:
  SMS
  VOICE
  MMS
  RCS

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

By default this is set to false. When set to true the notify configuration can’t be deleted. You can change this value using the UpdateNotifyConfiguration action.

--client-token (string)

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, a randomly generated token is used for the request to ensure idempotency.

--tags (list)

An array of tags (key and value pairs) associated with the notify configuration.

(structure)

The list of tags to be added to the specified topic.

Key -> (string)

The key identifier, or name, of the tag.

Value -> (string)

The string value associated with the key of the tag.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

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

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

NotifyConfigurationArn -> (string)

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

NotifyConfigurationId -> (string)

The unique identifier for the notify configuration.

DisplayName -> (string)

The display name associated with the notify configuration.

UseCase -> (string)

The use case for the notify configuration.

DefaultTemplateId -> (string)

The default template identifier associated with the notify configuration.

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.

(string)

EnabledChannels -> (list)

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

(string)

Tier -> (string)

The tier of the notify configuration.

TierUpgradeStatus -> (string)

The tier upgrade status of the notify configuration.

Status -> (string)

The current status of the notify configuration.

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.

Tags -> (list)

An array of tags (key and value pairs) associated with the notify configuration.

(structure)

The list of tags to be added to the specified topic.

Key -> (string)

The key identifier, or name, of the tag.

Value -> (string)

The string value associated with the key of the tag.

CreatedTimestamp -> (timestamp)

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