Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Pinpoint.Types.VoiceTemplateRequest

Description

Documentation

data VoiceTemplateRequest Source #

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

See: newVoiceTemplateRequest smart constructor.

Constructors

VoiceTemplateRequest'

Fields

languageCode :: Maybe Text
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.
body :: Maybe Text
The text of the script to use in messages that are based on the message template, in plain text format.
templateDescription :: Maybe Text
A custom description of the message template.
defaultSubstitutions :: Maybe Text
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.
voiceId :: Maybe Text
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.
tags :: Maybe (HashMap Text Text)
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.

Instances

Instances details

Eq VoiceTemplateRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.VoiceTemplateRequest Methods (==) :: VoiceTemplateRequest -> VoiceTemplateRequest -> Bool # (/=) :: VoiceTemplateRequest -> VoiceTemplateRequest -> Bool #
Read VoiceTemplateRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.VoiceTemplateRequest Methods readsPrec :: Int -> ReadS VoiceTemplateRequest # readList :: ReadS [VoiceTemplateRequest] # readPrec :: ReadPrec VoiceTemplateRequest # readListPrec :: ReadPrec [VoiceTemplateRequest] #
Show VoiceTemplateRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.VoiceTemplateRequest Methods showsPrec :: Int -> VoiceTemplateRequest -> ShowS # show :: VoiceTemplateRequest -> String # showList :: [VoiceTemplateRequest] -> ShowS #
Generic VoiceTemplateRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.VoiceTemplateRequest Associated Types type Rep VoiceTemplateRequest :: Type -> Type # Methods from :: VoiceTemplateRequest -> Rep VoiceTemplateRequest x # to :: Rep VoiceTemplateRequest x -> VoiceTemplateRequest #
NFData VoiceTemplateRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.VoiceTemplateRequest Methods rnf :: VoiceTemplateRequest -> () #
Hashable VoiceTemplateRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.VoiceTemplateRequest Methods hashWithSalt :: Int -> VoiceTemplateRequest -> Int # hash :: VoiceTemplateRequest -> Int #
ToJSON VoiceTemplateRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.VoiceTemplateRequest Methods toJSON :: VoiceTemplateRequest -> Value # toEncoding :: VoiceTemplateRequest -> Encoding # toJSONList :: [VoiceTemplateRequest] -> Value # toEncodingList :: [VoiceTemplateRequest] -> Encoding #
type Rep VoiceTemplateRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.VoiceTemplateRequest type Rep VoiceTemplateRequest = D1 ('MetaData "VoiceTemplateRequest" "Amazonka.Pinpoint.Types.VoiceTemplateRequest" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "VoiceTemplateRequest'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "templateDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "defaultSubstitutions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "voiceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))))

newVoiceTemplateRequest :: VoiceTemplateRequest Source #

Create a value of VoiceTemplateRequest with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:languageCode:VoiceTemplateRequest', voiceTemplateRequest_languageCode - 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.

$sel:body:VoiceTemplateRequest', voiceTemplateRequest_body - The text of the script to use in messages that are based on the message template, in plain text format.

$sel:templateDescription:VoiceTemplateRequest', voiceTemplateRequest_templateDescription - A custom description of the message template.

$sel:defaultSubstitutions:VoiceTemplateRequest', voiceTemplateRequest_defaultSubstitutions - 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.

$sel:voiceId:VoiceTemplateRequest', voiceTemplateRequest_voiceId - 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.

$sel:tags:VoiceTemplateRequest', voiceTemplateRequest_tags - 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.

voiceTemplateRequest_languageCode :: Lens' VoiceTemplateRequest (Maybe Text) Source #

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.

voiceTemplateRequest_body :: Lens' VoiceTemplateRequest (Maybe Text) Source #

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

voiceTemplateRequest_templateDescription :: Lens' VoiceTemplateRequest (Maybe Text) Source #

A custom description of the message template.

voiceTemplateRequest_defaultSubstitutions :: Lens' VoiceTemplateRequest (Maybe Text) Source #

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.

voiceTemplateRequest_voiceId :: Lens' VoiceTemplateRequest (Maybe Text) Source #

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.

voiceTemplateRequest_tags :: Lens' VoiceTemplateRequest (Maybe (HashMap Text Text)) Source #

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.