Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Pinpoint.DeleteVoiceTemplate

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Deletes a message template for messages that were sent through the voice channel.

Creating a Request

data DeleteVoiceTemplate Source #

See: newDeleteVoiceTemplate smart constructor.

Constructors

DeleteVoiceTemplate'

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

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

newDeleteVoiceTemplate Source #

Arguments

:: Text	`DeleteVoiceTemplate`
-> DeleteVoiceTemplate

Create a value of DeleteVoiceTemplate 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:

DeleteVoiceTemplate, deleteVoiceTemplate_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.

DeleteVoiceTemplate, deleteVoiceTemplate_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

deleteVoiceTemplate_version :: Lens' DeleteVoiceTemplate (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.

deleteVoiceTemplate_templateName :: Lens' DeleteVoiceTemplate 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 DeleteVoiceTemplateResponse Source #

See: newDeleteVoiceTemplateResponse smart constructor.

Constructors

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

Instances

Instances details

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

newDeleteVoiceTemplateResponse Source #

Arguments

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

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

$sel:messageBody:DeleteVoiceTemplateResponse', deleteVoiceTemplateResponse_messageBody - Undocumented member.

Response Lenses

deleteVoiceTemplateResponse_httpStatus :: Lens' DeleteVoiceTemplateResponse Int Source #

The response's http status code.

deleteVoiceTemplateResponse_messageBody :: Lens' DeleteVoiceTemplateResponse MessageBody Source #

Undocumented member.