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.Types.Template

Description

 
Synopsis

Documentation

data Template Source #

Specifies the name and version of the message template to use for the message.

See: newTemplate smart constructor.

Constructors

Template' 

Fields

  • name :: Maybe Text

    The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

  • version :: Maybe Text

    The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

    If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

Instances

Instances details
Eq Template Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Template

Read Template Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Template

Show Template Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Template

Generic Template Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Template

Associated Types

type Rep Template :: Type -> Type #

Methods

from :: Template -> Rep Template x #

to :: Rep Template x -> Template #

NFData Template Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Template

Methods

rnf :: Template -> () #

Hashable Template Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Template

Methods

hashWithSalt :: Int -> Template -> Int #

hash :: Template -> Int #

ToJSON Template Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Template

FromJSON Template Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Template

type Rep Template Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Template

type Rep Template = D1 ('MetaData "Template" "Amazonka.Pinpoint.Types.Template" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "Template'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newTemplate :: Template Source #

Create a value of Template 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:name:Template', template_name - The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

$sel:version:Template', template_version - The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

template_name :: Lens' Template (Maybe Text) Source #

The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

template_version :: Lens' Template (Maybe Text) Source #

The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.