Skip to content

GetSegmentSubscriptionResponse

Source code in docs_src/capo_customer_profiles/types/get_segment_subscription_response.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
class GetSegmentSubscriptionResponse(TypedDict, closed=True):
    status: NotRequired[
        "capo_customer_profiles.types.segment_subscription_status.SegmentSubscriptionStatus"
    ]
    """<p>The current lifecycle status of the subscription. The following are valid values: </p> <ul> <li> <p> <b>STARTING</b>: Initial snapshot is in progress. </p> </li> <li> <p> <b>RUNNING</b>: Notifications are active and running. </p> </li> <li> <p> <b>STOPPED</b>: Notifications have been stopped. </p> </li> <li> <p> <b>FAILED</b>: Notifications failed (for example, the Amazon Kinesis data stream became inaccessible). </p> </li> </ul>"""
    message: NotRequired["capo_customer_profiles.types.string1_to1000.string1To1000"]
    """<p>A status message providing additional context, such as a failure reason. </p>"""
    schedule_configuration: NotRequired[
        "capo_customer_profiles.types.schedule_configuration.ScheduleConfiguration"
    ]
    """<p>The schedule configuration for periodic membership event notifications. </p>"""
    scheduled_executions: NotRequired[
        "capo_customer_profiles.types.scheduled_executions.ScheduledExecutions"
    ]
    """<p>Information about scheduled execution timestamps. </p>"""
    started_at: NotRequired["capo_customer_profiles.types.timestamp.timestamp"]
    """<p>The timestamp of when the subscription was first started. </p>"""
    last_updated_at: NotRequired["capo_customer_profiles.types.timestamp.timestamp"]
    """<p>The timestamp of the most recent configuration change. </p>"""

last_updated_at instance-attribute 

last_updated_at: NotRequired[timestamp]

The timestamp of the most recent configuration change.

message instance-attribute 

message: NotRequired[string1To1000]

A status message providing additional context, such as a failure reason.

schedule_configuration instance-attribute 

schedule_configuration: NotRequired[ScheduleConfiguration]

The schedule configuration for periodic membership event notifications.

scheduled_executions instance-attribute 

scheduled_executions: NotRequired[ScheduledExecutions]

Information about scheduled execution timestamps.

started_at instance-attribute 

started_at: NotRequired[timestamp]

The timestamp of when the subscription was first started.

status instance-attribute 

status: NotRequired[SegmentSubscriptionStatus]

The current lifecycle status of the subscription. The following are valid values:

  • STARTING: Initial snapshot is in progress.

  • RUNNING: Notifications are active and running.

  • STOPPED: Notifications have been stopped.

  • FAILED: Notifications failed (for example, the Amazon Kinesis data stream became inaccessible).