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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves the content and settings of a message template for messages sent through the in-app channel.

Creating a Request

data GetInAppTemplate Source #

See: newGetInAppTemplate smart constructor.

Constructors

GetInAppTemplate'

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

newGetInAppTemplate Source #

Arguments

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

Create a value of GetInAppTemplate 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:GetInAppTemplate', getInAppTemplate_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:GetInAppTemplate', getInAppTemplate_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

getInAppTemplate_version :: Lens' GetInAppTemplate (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.

getInAppTemplate_templateName :: Lens' GetInAppTemplate 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 GetInAppTemplateResponse Source #

See: newGetInAppTemplateResponse smart constructor.

Constructors

GetInAppTemplateResponse'
Fields httpStatus :: Int The response's http status code. inAppTemplateResponse :: InAppTemplateResponse

Instances

Instances details

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

newGetInAppTemplateResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetInAppTemplateResponse'`
-> InAppTemplateResponse	`$sel:inAppTemplateResponse:GetInAppTemplateResponse'`
-> GetInAppTemplateResponse

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

$sel:inAppTemplateResponse:GetInAppTemplateResponse', getInAppTemplateResponse_inAppTemplateResponse - Undocumented member.

Response Lenses

getInAppTemplateResponse_httpStatus :: Lens' GetInAppTemplateResponse Int Source #

The response's http status code.

getInAppTemplateResponse_inAppTemplateResponse :: Lens' GetInAppTemplateResponse InAppTemplateResponse Source #

Undocumented member.