Amazon Connect Customer Profiles

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

See also: AWS API Documentation

Request Syntax

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

type DomainName

string

param DomainName

[REQUIRED]

The unique name of the domain.

type NextToken

string

param NextToken

Identifies the next page of results to return.

type MaxResults

integer

param MaxResults

The maximum number of objects returned per page.

rtype

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.

Disables and deletes the specified event stream.

See also: AWS API Documentation

Request Syntax

client.delete_event_stream(
    DomainName='string',
    EventStreamName='string'
)

type DomainName

string

param DomainName

[REQUIRED]

The unique name of the domain.

type EventStreamName

string

param EventStreamName

[REQUIRED]

The name of the event stream

rtype

dict

returns

Response Syntax

{}

Response Structure

• (dict) --

Creates an event stream, which is a subscription to real-time events, such as when profiles are created and updated through Amazon Connect Customer Profiles.

Each event stream can be associated with only one Kinesis Data Stream destination in the same region and Amazon Web Services account as the customer profiles domain

See also: AWS API Documentation

Request Syntax

client.create_event_stream(
    DomainName='string',
    Uri='string',
    EventStreamName='string',
    Tags={
        'string': 'string'
    }
)

type DomainName

string

param DomainName

[REQUIRED]

The unique name of the domain.

type Uri

string

param Uri

[REQUIRED]

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

type EventStreamName

string

param EventStreamName

[REQUIRED]

The name of the event stream.

type Tags

dict

param Tags

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

• (string) --

  • (string) --

rtype

dict

returns

Response Syntax

{
    'EventStreamArn': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

• (dict) --

  • EventStreamArn (string) --

    A unique identifier for the event stream.

  • Tags (dict) --

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

    • (string) --

      • (string) --

Returns information about the specified event stream in a specific domain.

See also: AWS API Documentation

Request Syntax

client.get_event_stream(
    DomainName='string',
    EventStreamName='string'
)

type DomainName

string

param DomainName

[REQUIRED]

The unique name of the domain.

type EventStreamName

string

param EventStreamName

[REQUIRED]

The name of the event stream provided during create operations.

rtype

dict

returns

Response Syntax

{
    'DomainName': 'string',
    'EventStreamArn': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'State': 'RUNNING'|'STOPPED',
    'StoppedSince': datetime(2015, 1, 1),
    'DestinationDetails': {
        'Uri': 'string',
        'Status': 'HEALTHY'|'UNHEALTHY',
        'UnhealthySince': datetime(2015, 1, 1),
        'Message': 'string'
    },
    'Tags': {
        'string': 'string'
    }
}

Response Structure

• (dict) --

  • DomainName (string) --

    The unique name of the domain.

  • EventStreamArn (string) --

    A unique identifier for the event stream.

  • CreatedAt (datetime) --

    The timestamp of when the export was created.

  • State (string) --

    The operational state of destination stream for export.

  • StoppedSince (datetime) --

    The timestamp when the State changed to STOPPED .

  • DestinationDetails (dict) --

    Details regarding the Kinesis 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 .

    • Message (string) --

      The human-readable string that corresponds to the error or success while enabling the streaming destination.

  • Tags (dict) --

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

    • (string) --

      • (string) --