Table Of Contents

Feedback

User Guide

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

[ aws . pinpoint ]

get-sms-template

Description

Retrieves the content and settings for a 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

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

Options

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

SMSTemplateResponse -> (structure)

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

Arn -> (string)

The Amazon Resource Name (ARN) of the message template.

Body -> (string)

The message body that's used in text messages that are based on the message template.

CreationDate -> (string)

The date when the message template was created.

LastModifiedDate -> (string)

The date when the message template was last modified.

tags -> (map)

A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.

key -> (string)

value -> (string)

TemplateName -> (string)

The name of the message template.

TemplateType -> (string)

The type of channel that the message template is designed for. For an SMS template, this value is SMS.