View a markdown version of this page

AssociatedSegment - Amazon Connect Customer

AssociatedSegment

Represents a segment associated with a membership event stream.

Contents

Message

An optional message providing context, such as a failure reason.

Type: String

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

Required: No

SegmentName

The unique name of the segment definition.

Type: String

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

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

Required: No

Status

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.

Type: String

Valid Values: STARTING | RUNNING | STOPPED | FAILED

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: