Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetStreamForSegments

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

Request Syntax


GET /domains/DomainName/segment-streams HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

DomainName

The unique name of the domain.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "AssociatedAt": number,
   "AssociatedSegments": [ 
      { 
         "Message": "string",
         "SegmentName": "string",
         "Status": "string"
      }
   ],
   "DestinationArn": "string",
   "DestinationRoleArn": "string",
   "DisassociatedAt": number,
   "DomainName": "string",
   "FailureReason": "string",
   "State": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AssociatedAt

The timestamp of when the stream was associated.

Type: Timestamp

AssociatedSegments

A list of segments currently associated with the stream and their subscription status.

Type: Array of AssociatedSegment objects

DestinationArn

The Amazon Resource Name (ARN) of the Amazon Kinesis data stream receiving segment membership events.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

DestinationRoleArn

The Amazon Resource Name (ARN) of the IAM role used for Amazon Kinesis and AWS Key Management Service (KMS) operations.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: .*arn:aws:iam:.*:[0-9]+:.*

DisassociatedAt

The timestamp of when the stream was disassociated.

Type: Timestamp

DomainName

The unique name of the domain.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_-]+$

FailureReason

The reason why the stream is in an unhealthy state, if applicable.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

State

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.

Type: String

Valid Values: RUNNING | UNHEALTHY | STOPPED

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

InternalServerException

An internal service error occurred.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource does not exist, or access was denied.

HTTP Status Code: 404

ThrottlingException

You exceeded the maximum number of requests.

HTTP Status Code: 429