Skip to content

CampaignLimits

Source code in docs_src/capo_pinpoint/types/campaign_limits.py 
11
12
13
14
15
16
17
18
19
20
21
class CampaignLimits(TypedDict, closed=True):
    daily: NotRequired["capo_pinpoint.types.__integer.__integer"]
    """<p>The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.</p>"""
    maximum_duration: NotRequired["capo_pinpoint.types.__integer.__integer"]
    """<p>The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.</p>"""
    messages_per_second: NotRequired["capo_pinpoint.types.__integer.__integer"]
    """<p>The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 1. The maximum value is 20,000.</p>"""
    total: NotRequired["capo_pinpoint.types.__integer.__integer"]
    """<p>The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.</p>"""
    session: NotRequired["capo_pinpoint.types.__integer.__integer"]
    """<p>The maximum total number of messages that the campaign can send per user session.</p>"""

daily instance-attribute 

daily: NotRequired[__integer]

The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.

maximum_duration instance-attribute 

maximum_duration: NotRequired[__integer]

The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.

messages_per_second instance-attribute 

messages_per_second: NotRequired[__integer]

The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 1. The maximum value is 20,000.

session instance-attribute 

session: NotRequired[__integer]

The maximum total number of messages that the campaign can send per user session.

total instance-attribute 

total: NotRequired[__integer]

The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.