You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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 the AWS Lambda function to use as a code hook for a campaign.

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 send messages for a campaign.

Returns:

  • (String)


1891
1892
1893
1894
1895
1896
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1891

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

#modeString

Specifies which Lambda mode to use when invoking the AWS Lambda function.

Returns:

  • (String)


1891
1892
1893
1894
1895
1896
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1891

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

#web_urlString

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

Returns:

  • (String)


1891
1892
1893
1894
1895
1896
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1891

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