CustomerProfiles / Client / create_event_stream

create_event_stream#

CustomerProfiles.Client.create_event_stream(**kwargs)#

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

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

  • DomainName (string) –

    [REQUIRED]

    The unique name of the domain.

  • Uri (string) –

    [REQUIRED]

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

  • EventStreamName (string) –

    [REQUIRED]

    The name of the event stream.

  • Tags (dict) –

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

    • (string) –

      • (string) –

Return type:

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

Exceptions

  • CustomerProfiles.Client.exceptions.BadRequestException

  • CustomerProfiles.Client.exceptions.ResourceNotFoundException

  • CustomerProfiles.Client.exceptions.AccessDeniedException

  • CustomerProfiles.Client.exceptions.ThrottlingException

  • CustomerProfiles.Client.exceptions.InternalServerException