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

Description

 
Synopsis

Documentation

data CustomDeliveryConfiguration Source #

Specifies the delivery configuration settings for sending a campaign or campaign treatment through a custom channel. This object is required if you use the CampaignCustomMessage object to define the message to send for the campaign or campaign treatment.

See: newCustomDeliveryConfiguration smart constructor.

Constructors

CustomDeliveryConfiguration' 

Fields

  • endpointTypes :: Maybe [EndpointTypesElement]

    The types of endpoints to send the campaign or treatment 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.

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

Instances

Instances details
FromJSON CustomDeliveryConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CustomDeliveryConfiguration

ToJSON CustomDeliveryConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CustomDeliveryConfiguration

Generic CustomDeliveryConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CustomDeliveryConfiguration

Associated Types

type Rep CustomDeliveryConfiguration :: Type -> Type #

Read CustomDeliveryConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CustomDeliveryConfiguration

Show CustomDeliveryConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CustomDeliveryConfiguration

NFData CustomDeliveryConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CustomDeliveryConfiguration

Eq CustomDeliveryConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CustomDeliveryConfiguration

Hashable CustomDeliveryConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CustomDeliveryConfiguration

type Rep CustomDeliveryConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CustomDeliveryConfiguration

type Rep CustomDeliveryConfiguration = D1 ('MetaData "CustomDeliveryConfiguration" "Amazonka.Pinpoint.Types.CustomDeliveryConfiguration" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "CustomDeliveryConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "endpointTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EndpointTypesElement])) :*: S1 ('MetaSel ('Just "deliveryUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCustomDeliveryConfiguration Source #

Create a value of CustomDeliveryConfiguration 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:endpointTypes:CustomDeliveryConfiguration', customDeliveryConfiguration_endpointTypes - The types of endpoints to send the campaign or treatment 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:deliveryUri:CustomDeliveryConfiguration', customDeliveryConfiguration_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.

customDeliveryConfiguration_endpointTypes :: Lens' CustomDeliveryConfiguration (Maybe [EndpointTypesElement]) Source #

The types of endpoints to send the campaign or treatment 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.

customDeliveryConfiguration_deliveryUri :: Lens' CustomDeliveryConfiguration 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.