Class: Aws::Pinpoint::Types::CampaignHook

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb

Overview

Note:

When making an API call, you may pass CampaignHook data as a hash:

{
  lambda_function_name: "__string",
  mode: "DELIVERY", # accepts DELIVERY, FILTER
  web_url: "__string",
}

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#lambda_function_nameString

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

Returns:

  • (String)


2576
2577
2578
2579
2580
2581
2582
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2576

class CampaignHook < Struct.new(
  :lambda_function_name,
  :mode,
  :web_url)
  SENSITIVE = []
  include Aws::Structure
end

#modeString

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.

Returns:

  • (String)


2576
2577
2578
2579
2580
2581
2582
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2576

class CampaignHook < Struct.new(
  :lambda_function_name,
  :mode,
  :web_url)
  SENSITIVE = []
  include Aws::Structure
end

#web_urlString

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

Returns:

  • (String)


2576
2577
2578
2579
2580
2581
2582
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2576

class CampaignHook < Struct.new(
  :lambda_function_name,
  :mode,
  :web_url)
  SENSITIVE = []
  include Aws::Structure
end