CustomerProfiles / Client / get_stream_for_segments

get_stream_for_segments¶

CustomerProfiles.Client.get_stream_for_segments(**kwargs)¶

Returns information about the segment membership event stream configured for a specific domain, including the stream state and associated segments.

Request Syntax

response = client.get_stream_for_segments(
    DomainName='string'
)

Parameters:

DomainName (string) –

[REQUIRED]

The unique name of the domain.

Return type:

dict

Returns:

Response Syntax

{
    'AssociatedAt': datetime(2015, 1, 1),
    'AssociatedSegments': [
        {
            'SegmentName': 'string',
            'Status': 'STARTING'|'RUNNING'|'STOPPED'|'FAILED',
            'Message': 'string'
        },
    ],
    'DomainName': 'string',
    'DestinationArn': 'string',
    'DestinationRoleArn': 'string',
    'State': 'RUNNING'|'UNHEALTHY'|'STOPPED',
    'DisassociatedAt': datetime(2015, 1, 1),
    'FailureReason': 'string'
}

Response Structure

(dict) –
- AssociatedAt (datetime) –
  
  The timestamp of when the stream was associated.
- AssociatedSegments (list) –
  
  A list of segments currently associated with the stream and their subscription status.
  - (dict) –
    
    Represents a segment associated with a membership event stream.
    - SegmentName (string) –
      
      The unique name of the segment definition.
    - Status (string) –
      
      The subscription status of the segment. The following are valid values:
      - STARTING: The segment is being prepared to publish membership events.
      - RUNNING: The segment is actively publishing membership events to the stream.
      - STOPPED: The segment has stopped publishing membership events.
      - FAILED: The segment failed to publish membership events.
    - Message (string) –
      
      An optional message providing context, such as a failure reason.
- DomainName (string) –
  
  The unique name of the domain.
- DestinationArn (string) –
  
  The Amazon Resource Name (ARN) of the Amazon Kinesis data stream receiving segment membership events.
- DestinationRoleArn (string) –
  
  The Amazon Resource Name (ARN) of the IAM role used for Amazon Kinesis and AWS Key Management Service (KMS) operations.
- State (string) –
  
  The operational state of the destination stream. The following are valid values:
  - RUNNING: The stream is associated and healthy. Segment membership events are being published.
  - UNHEALTHY: The stream is associated but events cannot currently be published. See FailureReason for details.
  - STOPPED: The stream is no longer publishing segment membership events.
- DisassociatedAt (datetime) –
  
  The timestamp of when the stream was disassociated.
- FailureReason (string) –
  
  The reason why the stream is in an unhealthy state, if applicable.

Exceptions

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