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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CampaignHook as input to an Aws::Client method, you can use a vanilla 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.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#lambda_function_name ⇒ String

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) —

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

#mode ⇒ String

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.

    Possible values:

    • DELIVERY
    • FILTER

Returns:

  • (String) —

    The mode that Amazon Pinpoint uses to invoke the AWS Lambda function.

#web_url ⇒ String

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

Returns:

  • (String) —

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