amazonka-pinpoint-2.0: Amazon Pinpoint SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Pinpoint.Types.TemplateResponse

Description

 
Synopsis

Documentation

data TemplateResponse Source #

Provides information about a message template that's associated with your Amazon Pinpoint account.

See: newTemplateResponse smart constructor.

Constructors

TemplateResponse' 

Fields

  • arn :: Maybe Text

    The Amazon Resource Name (ARN) of the message template. This value isn't included in a TemplateResponse object. To retrieve the ARN of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the ARN for.

  • defaultSubstitutions :: Maybe Text

    The JSON object that specifies the default values that are used for message variables in the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.

  • templateDescription :: Maybe Text

    The custom description of the message template. This value isn't included in a TemplateResponse object. To retrieve the description of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the description for.

  • version :: Maybe Text

    The unique identifier, as an integer, for the active version of the message template.

  • tags :: Maybe (HashMap Text Text)

    A map of key-value pairs that identifies the tags that are associated with the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.

  • lastModifiedDate :: Text

    The date, in ISO 8601 format, when the message template was last modified.

  • creationDate :: Text

    The date, in ISO 8601 format, when the message template was created.

  • templateName :: Text

    The name of the message template.

  • templateType :: TemplateType

    The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, and VOICE.

Instances

Instances details
FromJSON TemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateResponse

Generic TemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateResponse

Associated Types

type Rep TemplateResponse :: Type -> Type #

Read TemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateResponse

Show TemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateResponse

NFData TemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateResponse

Methods

rnf :: TemplateResponse -> () #

Eq TemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateResponse

Hashable TemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateResponse

type Rep TemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateResponse

newTemplateResponse Source #

Create a value of TemplateResponse 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:arn:TemplateResponse', templateResponse_arn - The Amazon Resource Name (ARN) of the message template. This value isn't included in a TemplateResponse object. To retrieve the ARN of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the ARN for.

$sel:defaultSubstitutions:TemplateResponse', templateResponse_defaultSubstitutions - The JSON object that specifies the default values that are used for message variables in the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.

$sel:templateDescription:TemplateResponse', templateResponse_templateDescription - The custom description of the message template. This value isn't included in a TemplateResponse object. To retrieve the description of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the description for.

$sel:version:TemplateResponse', templateResponse_version - The unique identifier, as an integer, for the active version of the message template.

$sel:tags:TemplateResponse', templateResponse_tags - A map of key-value pairs that identifies the tags that are associated with the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.

$sel:lastModifiedDate:TemplateResponse', templateResponse_lastModifiedDate - The date, in ISO 8601 format, when the message template was last modified.

$sel:creationDate:TemplateResponse', templateResponse_creationDate - The date, in ISO 8601 format, when the message template was created.

$sel:templateName:TemplateResponse', templateResponse_templateName - The name of the message template.

$sel:templateType:TemplateResponse', templateResponse_templateType - The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, and VOICE.

templateResponse_arn :: Lens' TemplateResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the message template. This value isn't included in a TemplateResponse object. To retrieve the ARN of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the ARN for.

templateResponse_defaultSubstitutions :: Lens' TemplateResponse (Maybe Text) Source #

The JSON object that specifies the default values that are used for message variables in the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.

templateResponse_templateDescription :: Lens' TemplateResponse (Maybe Text) Source #

The custom description of the message template. This value isn't included in a TemplateResponse object. To retrieve the description of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the description for.

templateResponse_version :: Lens' TemplateResponse (Maybe Text) Source #

The unique identifier, as an integer, for the active version of the message template.

templateResponse_tags :: Lens' TemplateResponse (Maybe (HashMap Text Text)) Source #

A map of key-value pairs that identifies the tags that are associated with the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.

templateResponse_lastModifiedDate :: Lens' TemplateResponse Text Source #

The date, in ISO 8601 format, when the message template was last modified.

templateResponse_creationDate :: Lens' TemplateResponse Text Source #

The date, in ISO 8601 format, when the message template was created.

templateResponse_templateName :: Lens' TemplateResponse Text Source #

The name of the message template.

templateResponse_templateType :: Lens' TemplateResponse TemplateType Source #

The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, and VOICE.