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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates an existing message template for messages that are sent through the voice channel.

Synopsis

data UpdateVoiceTemplate = UpdateVoiceTemplate' {
- version :: Maybe Text
- createNewVersion :: Maybe Bool
- templateName :: Text
- voiceTemplateRequest :: VoiceTemplateRequest
}
newUpdateVoiceTemplate :: Text -> VoiceTemplateRequest -> UpdateVoiceTemplate
updateVoiceTemplate_version :: Lens' UpdateVoiceTemplate (Maybe Text)
updateVoiceTemplate_createNewVersion :: Lens' UpdateVoiceTemplate (Maybe Bool)
updateVoiceTemplate_templateName :: Lens' UpdateVoiceTemplate Text
updateVoiceTemplate_voiceTemplateRequest :: Lens' UpdateVoiceTemplate VoiceTemplateRequest
data UpdateVoiceTemplateResponse = UpdateVoiceTemplateResponse' {
- httpStatus :: Int
- messageBody :: MessageBody
}
newUpdateVoiceTemplateResponse :: Int -> MessageBody -> UpdateVoiceTemplateResponse
updateVoiceTemplateResponse_httpStatus :: Lens' UpdateVoiceTemplateResponse Int
updateVoiceTemplateResponse_messageBody :: Lens' UpdateVoiceTemplateResponse MessageBody

Creating a Request

data UpdateVoiceTemplate Source #

See: newUpdateVoiceTemplate smart constructor.

Constructors

UpdateVoiceTemplate'

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.
createNewVersion :: Maybe Bool
Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.
If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.
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.
voiceTemplateRequest :: VoiceTemplateRequest

Instances

Instances details

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

newUpdateVoiceTemplate Source #

Arguments

:: Text	`$sel:templateName:UpdateVoiceTemplate'`
-> VoiceTemplateRequest	`$sel:voiceTemplateRequest:UpdateVoiceTemplate'`
-> UpdateVoiceTemplate

Create a value of UpdateVoiceTemplate 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:UpdateVoiceTemplate', updateVoiceTemplate_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:createNewVersion:UpdateVoiceTemplate', updateVoiceTemplate_createNewVersion - Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.

If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.

$sel:templateName:UpdateVoiceTemplate', updateVoiceTemplate_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.

$sel:voiceTemplateRequest:UpdateVoiceTemplate', updateVoiceTemplate_voiceTemplateRequest - Undocumented member.

Request Lenses

updateVoiceTemplate_version :: Lens' UpdateVoiceTemplate (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.

updateVoiceTemplate_createNewVersion :: Lens' UpdateVoiceTemplate (Maybe Bool) Source #

Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.

If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.

updateVoiceTemplate_templateName :: Lens' UpdateVoiceTemplate 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.

updateVoiceTemplate_voiceTemplateRequest :: Lens' UpdateVoiceTemplate VoiceTemplateRequest Source #

Undocumented member.

Destructuring the Response

data UpdateVoiceTemplateResponse Source #

See: newUpdateVoiceTemplateResponse smart constructor.

Constructors

UpdateVoiceTemplateResponse'
Fields httpStatus :: Int The response's http status code. messageBody :: MessageBody

Instances

Instances details

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

newUpdateVoiceTemplateResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateVoiceTemplateResponse'`
-> MessageBody	`$sel:messageBody:UpdateVoiceTemplateResponse'`
-> UpdateVoiceTemplateResponse

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

$sel:messageBody:UpdateVoiceTemplateResponse', updateVoiceTemplateResponse_messageBody - Undocumented member.

Response Lenses

updateVoiceTemplateResponse_httpStatus :: Lens' UpdateVoiceTemplateResponse Int Source #

The response's http status code.

updateVoiceTemplateResponse_messageBody :: Lens' UpdateVoiceTemplateResponse MessageBody Source #

Undocumented member.