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 |
Synopsis
- data VoiceTemplateResponse = VoiceTemplateResponse' {
- languageCode :: Maybe Text
- arn :: Maybe Text
- body :: Maybe Text
- templateDescription :: Maybe Text
- defaultSubstitutions :: Maybe Text
- version :: Maybe Text
- voiceId :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- lastModifiedDate :: Text
- creationDate :: Text
- templateName :: Text
- templateType :: TemplateType
- newVoiceTemplateResponse :: Text -> Text -> Text -> TemplateType -> VoiceTemplateResponse
- voiceTemplateResponse_languageCode :: Lens' VoiceTemplateResponse (Maybe Text)
- voiceTemplateResponse_arn :: Lens' VoiceTemplateResponse (Maybe Text)
- voiceTemplateResponse_body :: Lens' VoiceTemplateResponse (Maybe Text)
- voiceTemplateResponse_templateDescription :: Lens' VoiceTemplateResponse (Maybe Text)
- voiceTemplateResponse_defaultSubstitutions :: Lens' VoiceTemplateResponse (Maybe Text)
- voiceTemplateResponse_version :: Lens' VoiceTemplateResponse (Maybe Text)
- voiceTemplateResponse_voiceId :: Lens' VoiceTemplateResponse (Maybe Text)
- voiceTemplateResponse_tags :: Lens' VoiceTemplateResponse (Maybe (HashMap Text Text))
- voiceTemplateResponse_lastModifiedDate :: Lens' VoiceTemplateResponse Text
- voiceTemplateResponse_creationDate :: Lens' VoiceTemplateResponse Text
- voiceTemplateResponse_templateName :: Lens' VoiceTemplateResponse Text
- voiceTemplateResponse_templateType :: Lens' VoiceTemplateResponse TemplateType
Documentation
data VoiceTemplateResponse Source #
Provides information about the content and settings for a message template that can be used in messages that are sent through the voice channel.
See: newVoiceTemplateResponse
smart constructor.
VoiceTemplateResponse' | |
|
Instances
newVoiceTemplateResponse Source #
:: Text | |
-> Text | |
-> Text | |
-> TemplateType | |
-> VoiceTemplateResponse |
Create a value of VoiceTemplateResponse
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:VoiceTemplateResponse'
, voiceTemplateResponse_languageCode
- The code for the language that's used 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:arn:VoiceTemplateResponse'
, voiceTemplateResponse_arn
- The Amazon Resource Name (ARN) of the message template.
$sel:body:VoiceTemplateResponse'
, voiceTemplateResponse_body
- The text of the script that's used in messages that are based on the
message template, in plain text format.
$sel:templateDescription:VoiceTemplateResponse'
, voiceTemplateResponse_templateDescription
- The custom description of the message template.
$sel:defaultSubstitutions:VoiceTemplateResponse'
, voiceTemplateResponse_defaultSubstitutions
- The JSON object that specifies the default values that are used 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.
$sel:version:VoiceTemplateResponse'
, voiceTemplateResponse_version
- The unique identifier, as an integer, for the active version of the
message template, or the version of the template that you specified by
using the version parameter in your request.
$sel:voiceId:VoiceTemplateResponse'
, voiceTemplateResponse_voiceId
- The name of the voice that's used when delivering messages that are
based on the message template. For a list of supported voices, see the
Amazon Polly Developer Guide.
$sel:tags:VoiceTemplateResponse'
, voiceTemplateResponse_tags
- 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.
$sel:lastModifiedDate:VoiceTemplateResponse'
, voiceTemplateResponse_lastModifiedDate
- The date, in ISO 8601 format, when the message template was last
modified.
$sel:creationDate:VoiceTemplateResponse'
, voiceTemplateResponse_creationDate
- The date, in ISO 8601 format, when the message template was created.
$sel:templateName:VoiceTemplateResponse'
, voiceTemplateResponse_templateName
- The name of the message template.
$sel:templateType:VoiceTemplateResponse'
, voiceTemplateResponse_templateType
- The type of channel that the message template is designed for. For a
voice template, this value is VOICE.
voiceTemplateResponse_languageCode :: Lens' VoiceTemplateResponse (Maybe Text) Source #
The code for the language that's used 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.
voiceTemplateResponse_arn :: Lens' VoiceTemplateResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the message template.
voiceTemplateResponse_body :: Lens' VoiceTemplateResponse (Maybe Text) Source #
The text of the script that's used in messages that are based on the message template, in plain text format.
voiceTemplateResponse_templateDescription :: Lens' VoiceTemplateResponse (Maybe Text) Source #
The custom description of the message template.
voiceTemplateResponse_defaultSubstitutions :: Lens' VoiceTemplateResponse (Maybe Text) Source #
The JSON object that specifies the default values that are used 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.
voiceTemplateResponse_version :: Lens' VoiceTemplateResponse (Maybe Text) Source #
The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.
voiceTemplateResponse_voiceId :: Lens' VoiceTemplateResponse (Maybe Text) Source #
The name of the voice that's used when delivering messages that are based on the message template. For a list of supported voices, see the Amazon Polly Developer Guide.
voiceTemplateResponse_tags :: Lens' VoiceTemplateResponse (Maybe (HashMap Text Text)) Source #
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.
voiceTemplateResponse_lastModifiedDate :: Lens' VoiceTemplateResponse Text Source #
The date, in ISO 8601 format, when the message template was last modified.
voiceTemplateResponse_creationDate :: Lens' VoiceTemplateResponse Text Source #
The date, in ISO 8601 format, when the message template was created.
voiceTemplateResponse_templateName :: Lens' VoiceTemplateResponse Text Source #
The name of the message template.
voiceTemplateResponse_templateType :: Lens' VoiceTemplateResponse TemplateType Source #
The type of channel that the message template is designed for. For a voice template, this value is VOICE.