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 |
Deletes a message template for messages that were sent through the SMS channel.
Synopsis
- data DeleteSmsTemplate = DeleteSmsTemplate' {
- version :: Maybe Text
- templateName :: Text
- newDeleteSmsTemplate :: Text -> DeleteSmsTemplate
- deleteSmsTemplate_version :: Lens' DeleteSmsTemplate (Maybe Text)
- deleteSmsTemplate_templateName :: Lens' DeleteSmsTemplate Text
- data DeleteSmsTemplateResponse = DeleteSmsTemplateResponse' {}
- newDeleteSmsTemplateResponse :: Int -> MessageBody -> DeleteSmsTemplateResponse
- deleteSmsTemplateResponse_httpStatus :: Lens' DeleteSmsTemplateResponse Int
- deleteSmsTemplateResponse_messageBody :: Lens' DeleteSmsTemplateResponse MessageBody
Creating a Request
data DeleteSmsTemplate Source #
See: newDeleteSmsTemplate
smart constructor.
DeleteSmsTemplate' | |
|
Instances
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.
DeleteSmsTemplateResponse' | |
|
Instances
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
deleteSmsTemplateResponse_httpStatus :: Lens' DeleteSmsTemplateResponse Int Source #
The response's http status code.
deleteSmsTemplateResponse_messageBody :: Lens' DeleteSmsTemplateResponse MessageBody Source #
Undocumented member.