Skip to content

Activity

Source code in docs_src/capo_pinpoint/types/activity.py
class Activity(TypedDict, closed=True):
    custom: NotRequired[
        "capo_pinpoint.types.custom_message_activity.CustomMessageActivity"
    ]
    """<p>The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.</p>"""
    conditional_split: NotRequired[
        "capo_pinpoint.types.conditional_split_activity.ConditionalSplitActivity"
    ]
    """<p>The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.</p>"""
    description: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The custom description of the activity.</p>"""
    email: NotRequired[
        "capo_pinpoint.types.email_message_activity.EmailMessageActivity"
    ]
    """<p>The settings for an email activity. This type of activity sends an email message to participants.</p>"""
    holdout: NotRequired["capo_pinpoint.types.holdout_activity.HoldoutActivity"]
    """<p>The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.</p>"""
    multi_condition: NotRequired[
        "capo_pinpoint.types.multi_conditional_split_activity.MultiConditionalSplitActivity"
    ]
    """<p>The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths (including a default <i>Else</i> path) in a journey, based on conditions that you specify.</p>"""
    push: NotRequired["capo_pinpoint.types.push_message_activity.PushMessageActivity"]
    """<p>The settings for a push notification activity. This type of activity sends a push notification to participants.</p>"""
    random_split: NotRequired[
        "capo_pinpoint.types.random_split_activity.RandomSplitActivity"
    ]
    """<p>The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.</p>"""
    sms: NotRequired["capo_pinpoint.types.sms_message_activity.SMSMessageActivity"]
    """<p>The settings for an SMS activity. This type of activity sends a text message to participants.</p>"""
    wait: NotRequired["capo_pinpoint.types.wait_activity.WaitActivity"]
    """<p>The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.</p>"""
    contact_center: NotRequired[
        "capo_pinpoint.types.contact_center_activity.ContactCenterActivity"
    ]
    """<p>The settings for a connect activity. This type of activity initiates a contact center call to participants.</p>"""

conditional_split instance-attribute

conditional_split: NotRequired[ConditionalSplitActivity]

The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.

contact_center instance-attribute

contact_center: NotRequired[ContactCenterActivity]

The settings for a connect activity. This type of activity initiates a contact center call to participants.

custom instance-attribute

custom: NotRequired[CustomMessageActivity]

The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.

description instance-attribute

description: NotRequired[__string]

The custom description of the activity.

email instance-attribute

email: NotRequired[EmailMessageActivity]

The settings for an email activity. This type of activity sends an email message to participants.

holdout instance-attribute

holdout: NotRequired[HoldoutActivity]

The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.

multi_condition instance-attribute

multi_condition: NotRequired[MultiConditionalSplitActivity]

The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.

push instance-attribute

push: NotRequired[PushMessageActivity]

The settings for a push notification activity. This type of activity sends a push notification to participants.

random_split instance-attribute

random_split: NotRequired[RandomSplitActivity]

The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.

sms instance-attribute

sms: NotRequired[SMSMessageActivity]

The settings for an SMS activity. This type of activity sends a text message to participants.

wait instance-attribute

wait: NotRequired[WaitActivity]

The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.