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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Creating a Request

data DeleteSmsTemplate Source #

See: newDeleteSmsTemplate smart constructor.

Constructors

DeleteSmsTemplate'

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

newDeleteSmsTemplate Source #

Arguments

:: Text	`DeleteSmsTemplate`
-> DeleteSmsTemplate

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

DeleteSmsTemplate, deleteSmsTemplate_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.

DeleteSmsTemplate, deleteSmsTemplate_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

deleteSmsTemplate_version :: Lens' DeleteSmsTemplate (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.

deleteSmsTemplate_templateName :: Lens' DeleteSmsTemplate 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 DeleteSmsTemplateResponse Source #

See: newDeleteSmsTemplateResponse smart constructor.

Constructors

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

Instances

Instances details

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

newDeleteSmsTemplateResponse Source #

Arguments

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

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

$sel:messageBody:DeleteSmsTemplateResponse', deleteSmsTemplateResponse_messageBody - Undocumented member.

Response Lenses

deleteSmsTemplateResponse_httpStatus :: Lens' DeleteSmsTemplateResponse Int Source #

The response's http status code.

deleteSmsTemplateResponse_messageBody :: Lens' DeleteSmsTemplateResponse MessageBody Source #

Undocumented member.