Table Of Contents

Feedback

User Guide

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

[ aws . pinpoint ]

update-sms-template

Description

Updates an existing message template that you can use in messages that are sent through the SMS channel.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-sms-template
--sms-template-request <value>
--template-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--sms-template-request (structure)

Specifies the content and settings for a message template that can be used in text messages that are sent through the SMS channel.

Shorthand Syntax:

Body=string,DefaultSubstitutions=string,tags={KeyName1=string,KeyName2=string},TemplateDescription=string

JSON Syntax:

{
  "Body": "string",
  "DefaultSubstitutions": "string",
  "tags": {"string": "string"
    ...},
  "TemplateDescription": "string"
}

--template-name (string)

The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

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

See 'aws help' for descriptions of global parameters.

Output

MessageBody -> (structure)

Provides information about an API request or response.

Message -> (string)

The message that's returned from the API.

RequestID -> (string)

The unique identifier for the request or response.