CustomerProfiles / Client / get_segment_subscription

get_segment_subscription

CustomerProfiles.Client.get_segment_subscription(**kwargs)

Returns the current subscription configuration, execution schedule, and status for segment membership events.

See also: AWS API Documentation

Request Syntax

response = client.get_segment_subscription(
    DomainName='string',
    SegmentDefinitionName='string'
)
Parameters:

  • DomainName (string) –

    [REQUIRED]

    The unique name of the domain.

  • SegmentDefinitionName (string) –

    [REQUIRED]

    The unique name of the segment definition.

Return type:

dict

Returns:

Response Syntax

{
    'Status': 'STARTING'|'RUNNING'|'STOPPED'|'FAILED',
    'Message': 'string',
    'ScheduleConfiguration': {
        'Interval': 123,
        'Unit': 'HOURLY'
    },
    'ScheduledExecutions': {
        'NextExecutedAt': datetime(2015, 1, 1),
        'LastExecutedAt': datetime(2015, 1, 1)
    },
    'StartedAt': datetime(2015, 1, 1),
    'LastUpdatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • Status (string) –

      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).

    • Message (string) –

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

    • ScheduleConfiguration (dict) –

      The schedule configuration for periodic membership event notifications.

      • Interval (integer) –

        The interval between scheduled executions.

      • Unit (string) –

        The unit for the interval. The following are valid values:

        • HOURLY: The interval is measured in hours.

    • ScheduledExecutions (dict) –

      Information about scheduled execution timestamps.

      • NextExecutedAt (datetime) –

        The timestamp of the next scheduled execution.

      • LastExecutedAt (datetime) –

        The timestamp of the last successful scheduled execution.

    • StartedAt (datetime) –

      The timestamp of when the subscription was first started.

    • LastUpdatedAt (datetime) –

      The timestamp of the most recent configuration change.

Exceptions

  • CustomerProfiles.Client.exceptions.ResourceNotFoundException

  • CustomerProfiles.Client.exceptions.InternalServerException

  • CustomerProfiles.Client.exceptions.BadRequestException

  • CustomerProfiles.Client.exceptions.ThrottlingException

  • CustomerProfiles.Client.exceptions.AccessDeniedException