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

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 a push notification channel.

Creating a Request

data GetPushTemplate Source #

See: newGetPushTemplate smart constructor.

Constructors

GetPushTemplate'

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

newGetPushTemplate Source #

Arguments

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

Create a value of GetPushTemplate 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:GetPushTemplate', getPushTemplate_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:GetPushTemplate', getPushTemplate_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

getPushTemplate_version :: Lens' GetPushTemplate (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.

getPushTemplate_templateName :: Lens' GetPushTemplate 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 GetPushTemplateResponse Source #

See: newGetPushTemplateResponse smart constructor.

Constructors

GetPushTemplateResponse'
Fields httpStatus :: Int The response's http status code. pushNotificationTemplateResponse :: PushNotificationTemplateResponse

Instances

Instances details

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

newGetPushTemplateResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetPushTemplateResponse'`
-> PushNotificationTemplateResponse	`$sel:pushNotificationTemplateResponse:GetPushTemplateResponse'`
-> GetPushTemplateResponse

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

$sel:pushNotificationTemplateResponse:GetPushTemplateResponse', getPushTemplateResponse_pushNotificationTemplateResponse - Undocumented member.

Response Lenses

getPushTemplateResponse_httpStatus :: Lens' GetPushTemplateResponse Int Source #

The response's http status code.

getPushTemplateResponse_pushNotificationTemplateResponse :: Lens' GetPushTemplateResponse PushNotificationTemplateResponse Source #

Undocumented member.