Skip to content

ActivityResponse

Source code in docs_src/capo_pinpoint/types/activity_response.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
class ActivityResponse(TypedDict, closed=True):
    application_id: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The unique identifier for the application that the campaign applies to.</p>"""
    campaign_id: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The unique identifier for the campaign that the activity applies to.</p>"""
    end: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED.</p>"""
    id: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The unique identifier for the activity.</p>"""
    result: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL.</p>"""
    scheduled_start: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The scheduled start time, in ISO 8601 format, for the activity.</p>"""
    start: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The actual start time, in ISO 8601 format, of the activity.</p>"""
    state: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The current status of the activity. Possible values are: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.</p>"""
    successful_endpoint_count: NotRequired["capo_pinpoint.types.__integer.__integer"]
    """<p>The total number of endpoints that the campaign successfully delivered messages to.</p>"""
    timezones_completed_count: NotRequired["capo_pinpoint.types.__integer.__integer"]
    """<p>The total number of time zones that were completed.</p>"""
    timezones_total_count: NotRequired["capo_pinpoint.types.__integer.__integer"]
    """<p>The total number of unique time zones that are in the segment for the campaign.</p>"""
    total_endpoint_count: NotRequired["capo_pinpoint.types.__integer.__integer"]
    """<p>The total number of endpoints that the campaign attempted to deliver messages to.</p>"""
    treatment_id: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The unique identifier for the campaign treatment that the activity applies to. A treatment is a variation of a campaign that's used for A/B testing of a campaign.</p>"""
    execution_metrics: NotRequired["capo_pinpoint.types.map_of__string.MapOf__string"]
    """<p>A JSON object that contains metrics relating to the campaign execution for this campaign activity. For information about the structure and contents of the results, see <a href="https://docs.aws.amazon.com//pinpoint/latest/developerguide/analytics-standard-metrics.html">Standard Amazon Pinpoint analytics metrics</a> in the <i>Amazon Pinpoint Developer Guide</i>.</p>"""

application_id instance-attribute 

application_id: NotRequired[__string]

The unique identifier for the application that the campaign applies to.

campaign_id instance-attribute 

campaign_id: NotRequired[__string]

The unique identifier for the campaign that the activity applies to.

end instance-attribute 

end: NotRequired[__string]

The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED.

execution_metrics instance-attribute 

execution_metrics: NotRequired[MapOf__string]

A JSON object that contains metrics relating to the campaign execution for this campaign activity. For information about the structure and contents of the results, see Standard Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer Guide.

id instance-attribute 

id: NotRequired[__string]

The unique identifier for the activity.

result instance-attribute 

result: NotRequired[__string]

Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL.

scheduled_start instance-attribute 

scheduled_start: NotRequired[__string]

The scheduled start time, in ISO 8601 format, for the activity.

start instance-attribute 

start: NotRequired[__string]

The actual start time, in ISO 8601 format, of the activity.

state instance-attribute 

state: NotRequired[__string]

The current status of the activity. Possible values are: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.

successful_endpoint_count instance-attribute 

successful_endpoint_count: NotRequired[__integer]

The total number of endpoints that the campaign successfully delivered messages to.

timezones_completed_count instance-attribute 

timezones_completed_count: NotRequired[__integer]

The total number of time zones that were completed.

timezones_total_count instance-attribute 

timezones_total_count: NotRequired[__integer]

The total number of unique time zones that are in the segment for the campaign.

total_endpoint_count instance-attribute 

total_endpoint_count: NotRequired[__integer]

The total number of endpoints that the campaign attempted to deliver messages to.

treatment_id instance-attribute 

treatment_id: NotRequired[__string]

The unique identifier for the campaign treatment that the activity applies to. A treatment is a variation of a campaign that's used for A/B testing of a campaign.