Skip to content

CampaignHook

Source code in docs_src/capo_pinpoint/types/campaign_hook.py 
12
13
14
15
16
17
18
class CampaignHook(TypedDict, closed=True):
    lambda_function_name: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.</p>"""
    mode: NotRequired["capo_pinpoint.types.mode.Mode"]
    """<p>The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:</p> <ul><li><p>FILTER - Invoke the function to customize the segment that's used by a campaign.</p></li> <li><p>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.</p></li></ul>"""
    web_url: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.</p>"""

lambda_function_name instance-attribute 

lambda_function_name: NotRequired[__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 instance-attribute 

mode: NotRequired[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.

web_url instance-attribute 

web_url: NotRequired[__string]

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