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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Deletes a message template for messages that were sent through a push notification channel.

Creating a Request

data DeletePushTemplate Source #

See: newDeletePushTemplate smart constructor.

Constructors

DeletePushTemplate'

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

newDeletePushTemplate Source #

Arguments

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

Create a value of DeletePushTemplate 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:DeletePushTemplate', deletePushTemplate_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:DeletePushTemplate', deletePushTemplate_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

deletePushTemplate_version :: Lens' DeletePushTemplate (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.

deletePushTemplate_templateName :: Lens' DeletePushTemplate 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 DeletePushTemplateResponse Source #

See: newDeletePushTemplateResponse smart constructor.

Constructors

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

Instances

Instances details

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

newDeletePushTemplateResponse Source #

Arguments

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

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

$sel:messageBody:DeletePushTemplateResponse', deletePushTemplateResponse_messageBody - Undocumented member.

Response Lenses

deletePushTemplateResponse_httpStatus :: Lens' DeletePushTemplateResponse Int Source #

The response's http status code.

deletePushTemplateResponse_messageBody :: Lens' DeletePushTemplateResponse MessageBody Source #

Undocumented member.