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

Description

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

Synopsis

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

Defined in Amazonka.Pinpoint.DeleteVoiceTemplate

Read DeleteVoiceTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.DeleteVoiceTemplate

Show DeleteVoiceTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.DeleteVoiceTemplate

Generic DeleteVoiceTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.DeleteVoiceTemplate

Associated Types

type Rep DeleteVoiceTemplate :: Type -> Type #

NFData DeleteVoiceTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.DeleteVoiceTemplate

Methods

rnf :: DeleteVoiceTemplate -> () #

Hashable DeleteVoiceTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.DeleteVoiceTemplate

AWSRequest DeleteVoiceTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.DeleteVoiceTemplate

Associated Types

type AWSResponse DeleteVoiceTemplate #

ToHeaders DeleteVoiceTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.DeleteVoiceTemplate

ToPath DeleteVoiceTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.DeleteVoiceTemplate

ToQuery DeleteVoiceTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.DeleteVoiceTemplate

type Rep DeleteVoiceTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.DeleteVoiceTemplate

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

Defined in Amazonka.Pinpoint.DeleteVoiceTemplate

newDeleteVoiceTemplate Source #

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:

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

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

Instances

Instances details
Eq DeleteVoiceTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.DeleteVoiceTemplate

Read DeleteVoiceTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.DeleteVoiceTemplate

Show DeleteVoiceTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.DeleteVoiceTemplate

Generic DeleteVoiceTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.DeleteVoiceTemplate

Associated Types

type Rep DeleteVoiceTemplateResponse :: Type -> Type #

NFData DeleteVoiceTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.DeleteVoiceTemplate

type Rep DeleteVoiceTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.DeleteVoiceTemplate

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

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