Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Pinpoint.Types.CampaignHook

Description

Synopsis

data CampaignHook = CampaignHook' {
- lambdaFunctionName :: Maybe Text
- mode :: Maybe Mode
- webUrl :: Maybe Text
}
newCampaignHook :: CampaignHook
campaignHook_lambdaFunctionName :: Lens' CampaignHook (Maybe Text)
campaignHook_mode :: Lens' CampaignHook (Maybe Mode)
campaignHook_webUrl :: Lens' CampaignHook (Maybe Text)

Documentation

data CampaignHook Source #

Specifies settings for invoking an AWS Lambda function that customizes a segment for a campaign.

See: newCampaignHook smart constructor.

Constructors

CampaignHook'

Fields

lambdaFunctionName :: Maybe Text
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.
mode :: Maybe Mode
The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:
- FILTER - Invoke the function to customize the segment that's used by a campaign.
- DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.
webUrl :: Maybe Text
The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.

Instances

Instances details

Eq CampaignHook Source #
Instance details Defined in Amazonka.Pinpoint.Types.CampaignHook Methods (==) :: CampaignHook -> CampaignHook -> Bool # (/=) :: CampaignHook -> CampaignHook -> Bool #
Read CampaignHook Source #
Instance details Defined in Amazonka.Pinpoint.Types.CampaignHook Methods readsPrec :: Int -> ReadS CampaignHook # readList :: ReadS [CampaignHook] # readPrec :: ReadPrec CampaignHook # readListPrec :: ReadPrec [CampaignHook] #
Show CampaignHook Source #
Instance details Defined in Amazonka.Pinpoint.Types.CampaignHook Methods showsPrec :: Int -> CampaignHook -> ShowS # show :: CampaignHook -> String # showList :: [CampaignHook] -> ShowS #
Generic CampaignHook Source #
Instance details Defined in Amazonka.Pinpoint.Types.CampaignHook Associated Types type Rep CampaignHook :: Type -> Type # Methods from :: CampaignHook -> Rep CampaignHook x # to :: Rep CampaignHook x -> CampaignHook #
NFData CampaignHook Source #
Instance details Defined in Amazonka.Pinpoint.Types.CampaignHook Methods rnf :: CampaignHook -> () #
Hashable CampaignHook Source #
Instance details Defined in Amazonka.Pinpoint.Types.CampaignHook Methods hashWithSalt :: Int -> CampaignHook -> Int # hash :: CampaignHook -> Int #
ToJSON CampaignHook Source #
Instance details Defined in Amazonka.Pinpoint.Types.CampaignHook Methods toJSON :: CampaignHook -> Value # toEncoding :: CampaignHook -> Encoding # toJSONList :: [CampaignHook] -> Value # toEncodingList :: [CampaignHook] -> Encoding #
FromJSON CampaignHook Source #
Instance details Defined in Amazonka.Pinpoint.Types.CampaignHook Methods parseJSON :: Value -> Parser CampaignHook # parseJSONList :: Value -> Parser [CampaignHook] #
type Rep CampaignHook Source #
Instance details Defined in Amazonka.Pinpoint.Types.CampaignHook type Rep CampaignHook = D1 ('MetaData "CampaignHook" "Amazonka.Pinpoint.Types.CampaignHook" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "CampaignHook'" 'PrefixI 'True) (S1 ('MetaSel ('Just "lambdaFunctionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "mode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Mode)) :: S1 ('MetaSel ('Just "webUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newCampaignHook :: CampaignHook Source #

Create a value of CampaignHook 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:lambdaFunctionName:CampaignHook', campaignHook_lambdaFunctionName - The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.

$sel:mode:CampaignHook', campaignHook_mode - The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:

FILTER - Invoke the function to customize the segment that's used by a campaign.
DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.

$sel:webUrl:CampaignHook', campaignHook_webUrl - The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.

campaignHook_lambdaFunctionName :: Lens' CampaignHook (Maybe Text) Source #

The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.

campaignHook_mode :: Lens' CampaignHook (Maybe Mode) Source #

The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:

FILTER - Invoke the function to customize the segment that's used by a campaign.
DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.

campaignHook_webUrl :: Lens' CampaignHook (Maybe Text) Source #

The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.