CustomerProfiles / Client / list_event_streams

list_event_streams#

CustomerProfiles.Client.list_event_streams(**kwargs)#

Returns a list of all the event streams in a specific domain.

See also: AWS API Documentation

Request Syntax

response = client.list_event_streams(
    DomainName='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • DomainName (string) –

    [REQUIRED]

    The unique name of the domain.

  • NextToken (string) – Identifies the next page of results to return.

  • MaxResults (integer) – The maximum number of objects returned per page.

Return type:

dict

Returns:

Response Syntax

{
    'Items': [
        {
            'DomainName': 'string',
            'EventStreamName': 'string',
            'EventStreamArn': 'string',
            'State': 'RUNNING'|'STOPPED',
            'StoppedSince': datetime(2015, 1, 1),
            'DestinationSummary': {
                'Uri': 'string',
                'Status': 'HEALTHY'|'UNHEALTHY',
                'UnhealthySince': datetime(2015, 1, 1)
            },
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Items (list) –

      Contains summary information about an EventStream.

      • (dict) –

        An instance of EventStream in a list of EventStreams.

        • DomainName (string) –

          The unique name of the domain.

        • EventStreamName (string) –

          The name of the event stream.

        • EventStreamArn (string) –

          A unique identifier for the event stream.

        • State (string) –

          The operational state of destination stream for export.

        • StoppedSince (datetime) –

          The timestamp when the State changed to STOPPED.

        • DestinationSummary (dict) –

          Summary information about the Kinesis data stream.

          • Uri (string) –

            The StreamARN of the destination to deliver profile events to. For example, arn:aws:kinesis:region:account-id:stream/stream-name.

          • Status (string) –

            The status of enabling the Kinesis stream as a destination for export.

          • UnhealthySince (datetime) –

            The timestamp when the status last changed to UNHEALHY.

        • Tags (dict) –

          The tags used to organize, track, or control access for this resource.

          • (string) –

            • (string) –

    • NextToken (string) –

      Identifies the next page of results to return.

Exceptions