libZSservicesZSamazonka-pinpointZSamazonka-pinpoint
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Pinpoint.DeleteSmsTemplate

Description

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

Synopsis

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
Eq DeleteSmsTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.DeleteSmsTemplate

Read DeleteSmsTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.DeleteSmsTemplate

Show DeleteSmsTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.DeleteSmsTemplate

Generic DeleteSmsTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.DeleteSmsTemplate

Associated Types

type Rep DeleteSmsTemplate :: Type -> Type #

NFData DeleteSmsTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.DeleteSmsTemplate

Methods

rnf :: DeleteSmsTemplate -> () #

Hashable DeleteSmsTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.DeleteSmsTemplate

AWSRequest DeleteSmsTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.DeleteSmsTemplate

Associated Types

type AWSResponse DeleteSmsTemplate #

ToHeaders DeleteSmsTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.DeleteSmsTemplate

ToPath DeleteSmsTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.DeleteSmsTemplate

ToQuery DeleteSmsTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.DeleteSmsTemplate

type Rep DeleteSmsTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.DeleteSmsTemplate

type Rep DeleteSmsTemplate = D1 ('MetaData "DeleteSmsTemplate" "Amazonka.Pinpoint.DeleteSmsTemplate" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" '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)))
type AWSResponse DeleteSmsTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.DeleteSmsTemplate

newDeleteSmsTemplate Source #

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:

$sel:version: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.

$sel:templateName: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

Instances

Instances details
Eq DeleteSmsTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.DeleteSmsTemplate

Read DeleteSmsTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.DeleteSmsTemplate

Show DeleteSmsTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.DeleteSmsTemplate

Generic DeleteSmsTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.DeleteSmsTemplate

Associated Types

type Rep DeleteSmsTemplateResponse :: Type -> Type #

NFData DeleteSmsTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.DeleteSmsTemplate

type Rep DeleteSmsTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.DeleteSmsTemplate

type Rep DeleteSmsTemplateResponse = D1 ('MetaData "DeleteSmsTemplateResponse" "Amazonka.Pinpoint.DeleteSmsTemplate" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" '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 #

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