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

Description

 
Synopsis

Documentation

data CustomMessageActivity Source #

The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.

See: newCustomMessageActivity smart constructor.

Constructors

CustomMessageActivity' 

Fields

  • templateName :: Maybe Text

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

  • templateVersion :: 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.

  • endpointTypes :: Maybe [EndpointTypesElement]

    The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.

  • nextActivity :: Maybe Text

    The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.

  • deliveryUri :: Maybe Text

    The destination to send the campaign or treatment to. This value can be one of the following:

    • The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
    • The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
  • messageConfig :: Maybe JourneyCustomMessage

    Specifies the message data included in a custom channel message that's sent to participants in a journey.

Instances

Instances details
Eq CustomMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CustomMessageActivity

Read CustomMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CustomMessageActivity

Show CustomMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CustomMessageActivity

Generic CustomMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CustomMessageActivity

Associated Types

type Rep CustomMessageActivity :: Type -> Type #

NFData CustomMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CustomMessageActivity

Methods

rnf :: CustomMessageActivity -> () #

Hashable CustomMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CustomMessageActivity

ToJSON CustomMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CustomMessageActivity

FromJSON CustomMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CustomMessageActivity

type Rep CustomMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CustomMessageActivity

type Rep CustomMessageActivity = D1 ('MetaData "CustomMessageActivity" "Amazonka.Pinpoint.Types.CustomMessageActivity" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "CustomMessageActivity'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "templateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "templateVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "endpointTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EndpointTypesElement])))) :*: (S1 ('MetaSel ('Just "nextActivity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "deliveryUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "messageConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JourneyCustomMessage))))))

newCustomMessageActivity :: CustomMessageActivity Source #

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

$sel:templateVersion:CustomMessageActivity', customMessageActivity_templateVersion - 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.

$sel:endpointTypes:CustomMessageActivity', customMessageActivity_endpointTypes - The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.

$sel:nextActivity:CustomMessageActivity', customMessageActivity_nextActivity - The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.

$sel:deliveryUri:CustomMessageActivity', customMessageActivity_deliveryUri - The destination to send the campaign or treatment to. This value can be one of the following:

  • The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
  • The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.

$sel:messageConfig:CustomMessageActivity', customMessageActivity_messageConfig - Specifies the message data included in a custom channel message that's sent to participants in a journey.

customMessageActivity_templateName :: Lens' CustomMessageActivity (Maybe Text) Source #

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

customMessageActivity_templateVersion :: Lens' CustomMessageActivity (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.

customMessageActivity_endpointTypes :: Lens' CustomMessageActivity (Maybe [EndpointTypesElement]) Source #

The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.

customMessageActivity_nextActivity :: Lens' CustomMessageActivity (Maybe Text) Source #

The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.

customMessageActivity_deliveryUri :: Lens' CustomMessageActivity (Maybe Text) Source #

The destination to send the campaign or treatment to. This value can be one of the following:

  • The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
  • The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.

customMessageActivity_messageConfig :: Lens' CustomMessageActivity (Maybe JourneyCustomMessage) Source #

Specifies the message data included in a custom channel message that's sent to participants in a journey.