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

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-voice-template
--template-name <value>
--voice-template-request <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.

--voice-template-request (structure)

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

Body -> (string)

The text of the script to use in messages that are based on the message template, in plain text format.

DefaultSubstitutions -> (string)

A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

LanguageCode -> (string)

The code for the language to use when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide .

tags -> (map)

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

key -> (string)

value -> (string)

TemplateDescription -> (string)

A custom description of the message template.

VoiceId -> (string)

The name of the voice to use when delivering messages that are based on the message template. For a list of supported voices, see the Amazon Polly Developer Guide .

Shorthand Syntax:

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

JSON Syntax:

{
  "Body": "string",
  "DefaultSubstitutions": "string",
  "LanguageCode": "string",
  "tags": {"string": "string"
    ...},
  "TemplateDescription": "string",
  "VoiceId": "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. 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.