[ aws . pinpoint-sms-voice-v2 ]

set-default-sender-id

Description

Sets default sender ID on a configuration set.

When sending a text message to a destination country that supports sender IDs, the default sender ID on the configuration set specified will be used if no dedicated origination phone numbers or registered sender IDs are available in your account.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  set-default-sender-id
--configuration-set-name <value>
--sender-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--configuration-set-name (string)

The configuration set to updated with a new default SenderId. This field can be the ConsigurationSetName or ConfigurationSetArn.

--sender-id (string)

The current sender ID for the configuration set. When sending a text message to a destination country which supports SenderIds, the default sender ID on the configuration set specified on SendTextMessage will be used if no dedicated origination phone numbers or registered SenderIds are available in your account, instead of a generic sender ID, such as ‘NOTICE’.

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

Output

ConfigurationSetArn -> (string)

The Amazon Resource Name (ARN) of the updated configuration set.

ConfigurationSetName -> (string)

The name of the configuration set that was updated.

SenderId -> (string)

The default sender ID to set for the ConfigurationSet.