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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Creating a Request

data DeleteEmailTemplate Source #

See: newDeleteEmailTemplate smart constructor.

Constructors

DeleteEmailTemplate'

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

newDeleteEmailTemplate Source #

Arguments

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

Create a value of DeleteEmailTemplate 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:DeleteEmailTemplate', deleteEmailTemplate_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:DeleteEmailTemplate', deleteEmailTemplate_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

deleteEmailTemplate_version :: Lens' DeleteEmailTemplate (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.

deleteEmailTemplate_templateName :: Lens' DeleteEmailTemplate 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 DeleteEmailTemplateResponse Source #

See: newDeleteEmailTemplateResponse smart constructor.

Constructors

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

Instances

Instances details

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

newDeleteEmailTemplateResponse Source #

Arguments

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

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

$sel:messageBody:DeleteEmailTemplateResponse', deleteEmailTemplateResponse_messageBody - Undocumented member.

Response Lenses

deleteEmailTemplateResponse_httpStatus :: Lens' DeleteEmailTemplateResponse Int Source #

The response's http status code.

deleteEmailTemplateResponse_messageBody :: Lens' DeleteEmailTemplateResponse MessageBody Source #

Undocumented member.