Table Of Contents

Feedback

User Guide

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

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . pinpoint ]

create-email-template

Description

Creates a message template for messages that are sent through the email channel.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-email-template
--email-template-request <value>
--template-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--email-template-request (structure)

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

Shorthand Syntax:

DefaultSubstitutions=string,HtmlPart=string,RecommenderId=string,Subject=string,tags={KeyName1=string,KeyName2=string},TemplateDescription=string,TextPart=string

JSON Syntax:

{
  "DefaultSubstitutions": "string",
  "HtmlPart": "string",
  "RecommenderId": "string",
  "Subject": "string",
  "tags": {"string": "string"
    ...},
  "TemplateDescription": "string",
  "TextPart": "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

CreateTemplateMessageBody -> (structure)

Provides information about a request to create a message template.

Arn -> (string)

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

Message -> (string)

The message that's returned from the API for the request to create the message template.

RequestID -> (string)

The unique identifier for the request to create the message template.