Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . pinpoint ]

update-sms-channel

Description

Update an SMS channel.

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 <value>]
[--generate-cli-skeleton <value>]

Options

--application-id (string) The unique ID of your Amazon Pinpoint application.

--sms-channel-request (structure) SMS Channel Request

Shorthand Syntax:

Enabled=boolean,SenderId=string,ShortCode=string

JSON Syntax:

{
  "Enabled": true|false,
  "SenderId": "string",
  "ShortCode": "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.

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

See 'aws help' for descriptions of global parameters.

Output

SMSChannelResponse -> (structure)

SMS Channel Response.

ApplicationId -> (string)

The unique ID of the application to which the SMS channel belongs.

CreationDate -> (string)

The date that the settings were last updated in ISO 8601 format.

Enabled -> (boolean)

If the channel is enabled for sending messages.

HasCredential -> (boolean)

Not used. Retained for backwards compatibility.

Id -> (string)

Channel ID. Not used, only for backwards compatibility.

IsArchived -> (boolean)

Is this channel archived

LastModifiedBy -> (string)

Who last updated this entry

LastModifiedDate -> (string)

Last date this was updated

Platform -> (string)

Platform type. Will be "SMS"

PromotionalMessagesPerSecond -> (integer)

Promotional messages per second that can be sent

SenderId -> (string)

Sender identifier of your messages.

ShortCode -> (string)

The short code registered with the phone provider.

TransactionalMessagesPerSecond -> (integer)

Transactional messages per second that can be sent

Version -> (integer)

Version of channel