CustomerProfiles / Client / associate_stream_for_segments

associate_stream_for_segments¶

CustomerProfiles.Client.associate_stream_for_segments(**kwargs)¶

Associates an Amazon Kinesis data stream to receive segment membership events for a given domain. This is a domain-level configuration that applies to all segment subscriptions within the domain. A domain can have only one associated stream at a time.

Request Syntax

response = client.associate_stream_for_segments(
    DomainName='string',
    DestinationArn='string',
    DestinationRoleArn='string'
)

Parameters:

DomainName (string) –
[REQUIRED]

The unique name of the domain.
DestinationArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the Amazon Kinesis data stream to deliver segment membership events to. For example, arn:aws:kinesis:region:account-id:stream/stream-name.
DestinationRoleArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the IAM role that allows Customer Profiles service principal to assume the role for conducting AWS Key Management Service (KMS) and Amazon Kinesis operations. The role must grant the following Amazon Kinesis permissions to deliver segment membership events to the stream:
- kinesis:PutRecord
- kinesis:PutRecords
- kinesis:DescribeStream

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

(dict) –

Exceptions

CustomerProfiles.Client.exceptions.ResourceNotFoundException
CustomerProfiles.Client.exceptions.InternalServerException
CustomerProfiles.Client.exceptions.BadRequestException
CustomerProfiles.Client.exceptions.ThrottlingException
CustomerProfiles.Client.exceptions.AccessDeniedException