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

Description

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

Synopsis

Creating a Request

data GetEmailTemplate Source #

See: newGetEmailTemplate smart constructor.

Constructors

GetEmailTemplate' 

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

Defined in Amazonka.Pinpoint.GetEmailTemplate

Read GetEmailTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.GetEmailTemplate

Show GetEmailTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.GetEmailTemplate

Generic GetEmailTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.GetEmailTemplate

Associated Types

type Rep GetEmailTemplate :: Type -> Type #

NFData GetEmailTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.GetEmailTemplate

Methods

rnf :: GetEmailTemplate -> () #

Hashable GetEmailTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.GetEmailTemplate

AWSRequest GetEmailTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.GetEmailTemplate

Associated Types

type AWSResponse GetEmailTemplate #

ToHeaders GetEmailTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.GetEmailTemplate

ToPath GetEmailTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.GetEmailTemplate

ToQuery GetEmailTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.GetEmailTemplate

type Rep GetEmailTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.GetEmailTemplate

type Rep GetEmailTemplate = D1 ('MetaData "GetEmailTemplate" "Amazonka.Pinpoint.GetEmailTemplate" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "GetEmailTemplate'" 'PrefixI 'True) (S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "templateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetEmailTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.GetEmailTemplate

newGetEmailTemplate Source #

Create a value of GetEmailTemplate 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:GetEmailTemplate', getEmailTemplate_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:GetEmailTemplate', getEmailTemplate_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

getEmailTemplate_version :: Lens' GetEmailTemplate (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.

getEmailTemplate_templateName :: Lens' GetEmailTemplate 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 GetEmailTemplateResponse Source #

See: newGetEmailTemplateResponse smart constructor.

Constructors

GetEmailTemplateResponse' 

Fields

Instances

Instances details
Eq GetEmailTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.GetEmailTemplate

Read GetEmailTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.GetEmailTemplate

Show GetEmailTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.GetEmailTemplate

Generic GetEmailTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.GetEmailTemplate

Associated Types

type Rep GetEmailTemplateResponse :: Type -> Type #

NFData GetEmailTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.GetEmailTemplate

type Rep GetEmailTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.GetEmailTemplate

type Rep GetEmailTemplateResponse = D1 ('MetaData "GetEmailTemplateResponse" "Amazonka.Pinpoint.GetEmailTemplate" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "GetEmailTemplateResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "emailTemplateResponse") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EmailTemplateResponse)))

newGetEmailTemplateResponse Source #

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

$sel:emailTemplateResponse:GetEmailTemplateResponse', getEmailTemplateResponse_emailTemplateResponse - Undocumented member.

Response Lenses