Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Pinpoint.Types.Template

Description

Synopsis

data Template = Template' {
- name :: Maybe Text
- version :: Maybe Text
}
newTemplate :: Template
template_name :: Lens' Template (Maybe Text)
template_version :: Lens' Template (Maybe Text)

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

FromJSON Template Source #
Instance details Defined in Amazonka.Pinpoint.Types.Template Methods parseJSON :: Value -> Parser Template # parseJSONList :: Value -> Parser [Template] #
ToJSON Template Source #
Instance details Defined in Amazonka.Pinpoint.Types.Template Methods toJSON :: Template -> Value # toEncoding :: Template -> Encoding # toJSONList :: [Template] -> Value # toEncodingList :: [Template] -> Encoding #
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 #
Read Template Source #
Instance details Defined in Amazonka.Pinpoint.Types.Template Methods readsPrec :: Int -> ReadS Template # readList :: ReadS [Template] # readPrec :: ReadPrec Template # readListPrec :: ReadPrec [Template] #
Show Template Source #
Instance details Defined in Amazonka.Pinpoint.Types.Template Methods showsPrec :: Int -> Template -> ShowS # show :: Template -> String # showList :: [Template] -> ShowS #
NFData Template Source #
Instance details Defined in Amazonka.Pinpoint.Types.Template Methods rnf :: Template -> () #
Eq Template Source #
Instance details Defined in Amazonka.Pinpoint.Types.Template Methods (==) :: Template -> Template -> Bool # (/=) :: Template -> Template -> Bool #
Hashable Template Source #
Instance details Defined in Amazonka.Pinpoint.Types.Template Methods hashWithSalt :: Int -> Template -> Int # hash :: Template -> Int #
type Rep Template Source #
Instance details Defined in Amazonka.Pinpoint.Types.Template type Rep Template = D1 ('MetaData "Template" "Amazonka.Pinpoint.Types.Template" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" '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.