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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves the content and settings of a message template for messages that are sent through the SMS channel.

Creating a Request

data GetSmsTemplate Source #

See: newGetSmsTemplate smart constructor.

Constructors

GetSmsTemplate'

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

newGetSmsTemplate Source #

Arguments

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

Create a value of GetSmsTemplate 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:GetSmsTemplate', getSmsTemplate_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:GetSmsTemplate', getSmsTemplate_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

getSmsTemplate_version :: Lens' GetSmsTemplate (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.

getSmsTemplate_templateName :: Lens' GetSmsTemplate 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 GetSmsTemplateResponse Source #

See: newGetSmsTemplateResponse smart constructor.

Constructors

GetSmsTemplateResponse'
Fields httpStatus :: Int The response's http status code. sMSTemplateResponse :: SMSTemplateResponse

Instances

Instances details

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

newGetSmsTemplateResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetSmsTemplateResponse'`
-> SMSTemplateResponse	`$sel:sMSTemplateResponse:GetSmsTemplateResponse'`
-> GetSmsTemplateResponse

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

$sel:sMSTemplateResponse:GetSmsTemplateResponse', getSmsTemplateResponse_sMSTemplateResponse - Undocumented member.

Response Lenses

getSmsTemplateResponse_httpStatus :: Lens' GetSmsTemplateResponse Int Source #

The response's http status code.

getSmsTemplateResponse_sMSTemplateResponse :: Lens' GetSmsTemplateResponse SMSTemplateResponse Source #

Undocumented member.