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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves the content and settings of a message template for messages that are sent through the voice channel.

Creating a Request

data GetVoiceTemplate Source #

See: newGetVoiceTemplate smart constructor.

Constructors

GetVoiceTemplate'

Fields

version :: Maybe Text
The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
- For a get operation, retrieves information about the active version of the template.
- For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
- For a delete operation, deletes the template, including all versions of the template.
templateName :: Text
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.

Instances

Instances details

Eq GetVoiceTemplate Source #
Instance details Defined in Amazonka.Pinpoint.GetVoiceTemplate Methods (==) :: GetVoiceTemplate -> GetVoiceTemplate -> Bool # (/=) :: GetVoiceTemplate -> GetVoiceTemplate -> Bool #
Read GetVoiceTemplate Source #
Instance details Defined in Amazonka.Pinpoint.GetVoiceTemplate Methods readsPrec :: Int -> ReadS GetVoiceTemplate # readList :: ReadS [GetVoiceTemplate] # readPrec :: ReadPrec GetVoiceTemplate # readListPrec :: ReadPrec [GetVoiceTemplate] #
Show GetVoiceTemplate Source #
Instance details Defined in Amazonka.Pinpoint.GetVoiceTemplate Methods showsPrec :: Int -> GetVoiceTemplate -> ShowS # show :: GetVoiceTemplate -> String # showList :: [GetVoiceTemplate] -> ShowS #
Generic GetVoiceTemplate Source #
Instance details Defined in Amazonka.Pinpoint.GetVoiceTemplate Associated Types type Rep GetVoiceTemplate :: Type -> Type # Methods from :: GetVoiceTemplate -> Rep GetVoiceTemplate x # to :: Rep GetVoiceTemplate x -> GetVoiceTemplate #
NFData GetVoiceTemplate Source #
Instance details Defined in Amazonka.Pinpoint.GetVoiceTemplate Methods rnf :: GetVoiceTemplate -> () #
Hashable GetVoiceTemplate Source #
Instance details Defined in Amazonka.Pinpoint.GetVoiceTemplate Methods hashWithSalt :: Int -> GetVoiceTemplate -> Int # hash :: GetVoiceTemplate -> Int #
AWSRequest GetVoiceTemplate Source #
Instance details Defined in Amazonka.Pinpoint.GetVoiceTemplate Associated Types type AWSResponse GetVoiceTemplate # Methods request :: GetVoiceTemplate -> Request GetVoiceTemplate # response :: MonadResource m => Logger -> Service -> Proxy GetVoiceTemplate -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetVoiceTemplate))) #
ToHeaders GetVoiceTemplate Source #
Instance details Defined in Amazonka.Pinpoint.GetVoiceTemplate Methods toHeaders :: GetVoiceTemplate -> [Header] #
ToPath GetVoiceTemplate Source #
Instance details Defined in Amazonka.Pinpoint.GetVoiceTemplate Methods toPath :: GetVoiceTemplate -> ByteString #
ToQuery GetVoiceTemplate Source #
Instance details Defined in Amazonka.Pinpoint.GetVoiceTemplate Methods toQuery :: GetVoiceTemplate -> QueryString #
type Rep GetVoiceTemplate Source #
Instance details Defined in Amazonka.Pinpoint.GetVoiceTemplate type Rep GetVoiceTemplate = D1 ('MetaData "GetVoiceTemplate" "Amazonka.Pinpoint.GetVoiceTemplate" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "GetVoiceTemplate'" 'PrefixI 'True) (S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "templateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetVoiceTemplate Source #
Instance details Defined in Amazonka.Pinpoint.GetVoiceTemplate type AWSResponse GetVoiceTemplate = GetVoiceTemplateResponse

newGetVoiceTemplate Source #

Arguments

:: Text	`$sel:templateName:GetVoiceTemplate'`
-> GetVoiceTemplate

Create a value of GetVoiceTemplate 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:version:GetVoiceTemplate', getVoiceTemplate_version - The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.

$sel:templateName:GetVoiceTemplate', getVoiceTemplate_templateName - 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.

Request Lenses

getVoiceTemplate_version :: Lens' GetVoiceTemplate (Maybe Text) Source #

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.

getVoiceTemplate_templateName :: Lens' GetVoiceTemplate Text Source #

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.

Destructuring the Response

data GetVoiceTemplateResponse Source #

See: newGetVoiceTemplateResponse smart constructor.

Constructors

GetVoiceTemplateResponse'
Fields httpStatus :: Int The response's http status code. voiceTemplateResponse :: VoiceTemplateResponse

Instances

Instances details

Eq GetVoiceTemplateResponse Source #
Instance details Defined in Amazonka.Pinpoint.GetVoiceTemplate Methods (==) :: GetVoiceTemplateResponse -> GetVoiceTemplateResponse -> Bool # (/=) :: GetVoiceTemplateResponse -> GetVoiceTemplateResponse -> Bool #
Read GetVoiceTemplateResponse Source #
Instance details Defined in Amazonka.Pinpoint.GetVoiceTemplate Methods readsPrec :: Int -> ReadS GetVoiceTemplateResponse # readList :: ReadS [GetVoiceTemplateResponse] # readPrec :: ReadPrec GetVoiceTemplateResponse # readListPrec :: ReadPrec [GetVoiceTemplateResponse] #
Show GetVoiceTemplateResponse Source #
Instance details Defined in Amazonka.Pinpoint.GetVoiceTemplate Methods showsPrec :: Int -> GetVoiceTemplateResponse -> ShowS # show :: GetVoiceTemplateResponse -> String # showList :: [GetVoiceTemplateResponse] -> ShowS #
Generic GetVoiceTemplateResponse Source #
Instance details Defined in Amazonka.Pinpoint.GetVoiceTemplate Associated Types type Rep GetVoiceTemplateResponse :: Type -> Type # Methods from :: GetVoiceTemplateResponse -> Rep GetVoiceTemplateResponse x # to :: Rep GetVoiceTemplateResponse x -> GetVoiceTemplateResponse #
NFData GetVoiceTemplateResponse Source #
Instance details Defined in Amazonka.Pinpoint.GetVoiceTemplate Methods rnf :: GetVoiceTemplateResponse -> () #
type Rep GetVoiceTemplateResponse Source #
Instance details Defined in Amazonka.Pinpoint.GetVoiceTemplate type Rep GetVoiceTemplateResponse = D1 ('MetaData "GetVoiceTemplateResponse" "Amazonka.Pinpoint.GetVoiceTemplate" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "GetVoiceTemplateResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "voiceTemplateResponse") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 VoiceTemplateResponse)))

newGetVoiceTemplateResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetVoiceTemplateResponse'`
-> VoiceTemplateResponse	`$sel:voiceTemplateResponse:GetVoiceTemplateResponse'`
-> GetVoiceTemplateResponse

Create a value of GetVoiceTemplateResponse 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:httpStatus:GetVoiceTemplateResponse', getVoiceTemplateResponse_httpStatus - The response's http status code.

$sel:voiceTemplateResponse:GetVoiceTemplateResponse', getVoiceTemplateResponse_voiceTemplateResponse - Undocumented member.

Response Lenses

getVoiceTemplateResponse_httpStatus :: Lens' GetVoiceTemplateResponse Int Source #

The response's http status code.

getVoiceTemplateResponse_voiceTemplateResponse :: Lens' GetVoiceTemplateResponse VoiceTemplateResponse Source #

Undocumented member.