[ aws . pinpoint ]

update-sms-channel

Description

Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-sms-channel
--application-id <value>
--sms-channel-request <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--application-id (string)

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

--sms-channel-request (structure)

Specifies the status and settings of the SMS channel for an application.

Enabled -> (boolean)

Specifies whether to enable the SMS channel for the application.

SenderId -> (string)

The identity that you want to display on recipients’ devices when they receive messages from the SMS channel.

ShortCode -> (string)

The registered short code that you want to use when you send messages through the SMS channel.

Shorthand Syntax:

Enabled=boolean,SenderId=string,ShortCode=string

JSON Syntax:

{
  "Enabled": true|false,
  "SenderId": "string",
  "ShortCode": "string"
}

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

SMSChannelResponse -> (structure)

Provides information about the status and settings of the SMS channel for an application.

ApplicationId -> (string)

The unique identifier for the application that the SMS channel applies to.

CreationDate -> (string)

The date and time, in ISO 8601 format, when the SMS channel was enabled.

Enabled -> (boolean)

Specifies whether the SMS channel is enabled for the application.

HasCredential -> (boolean)

(Not used) This property is retained only for backward compatibility.

Id -> (string)

(Deprecated) An identifier for the SMS channel. This property is retained only for backward compatibility.

IsArchived -> (boolean)

Specifies whether the SMS channel is archived.

LastModifiedBy -> (string)

The user who last modified the SMS channel.

LastModifiedDate -> (string)

The date and time, in ISO 8601 format, when the SMS channel was last modified.

Platform -> (string)

The type of messaging or notification platform for the channel. For the SMS channel, this value is SMS.

PromotionalMessagesPerSecond -> (integer)

The maximum number of promotional messages that you can send through the SMS channel each second.

SenderId -> (string)

The identity that displays on recipients’ devices when they receive messages from the SMS channel.

ShortCode -> (string)

The registered short code to use when you send messages through the SMS channel.

TransactionalMessagesPerSecond -> (integer)

The maximum number of transactional messages that you can send through the SMS channel each second.

Version -> (integer)

The current version of the SMS channel.