Skip to content

GetStreamOutput

Source code in docs_src/capo_dsql/types/get_stream_output.py
class GetStreamOutput(TypedDict, closed=True):
    cluster_identifier: "capo_dsql.types.cluster_id.ClusterId"
    """<p>The ID of the cluster for the retrieved stream.</p>"""
    stream_identifier: "capo_dsql.types.stream_id.StreamId"
    """<p>The ID of the retrieved stream.</p>"""
    arn: "capo_dsql.types.stream_arn.StreamArn"
    """<p>The ARN of the retrieved stream.</p>"""
    status: "capo_dsql.types.stream_status.StreamStatus"
    """<p>The current status of the retrieved stream.</p>"""
    creation_time: "capo_dsql.types.stream_creation_time.StreamCreationTime"
    """<p>The time when the stream was created.</p>"""
    ordering: "capo_dsql.types.stream_ordering.StreamOrdering"
    """<p>The ordering mode of the stream.</p>"""
    format: "capo_dsql.types.stream_format.StreamFormat"
    """<p>The format of the stream records.</p>"""
    target_definition: NotRequired["capo_dsql.types.target_definition.TargetDefinition"]
    """<p>The target definition for the stream destination.</p>"""
    status_reason: NotRequired["capo_dsql.types.status_reason.StatusReason"]
    """<p>Stream status reason with error code and timestamp (if applicable).</p>"""
    tags: NotRequired["capo_dsql.types.tag_map.TagMap"]
    """<p>A map of tags associated with the stream.</p>"""

arn instance-attribute

arn: StreamArn

The ARN of the retrieved stream.

cluster_identifier instance-attribute

cluster_identifier: ClusterId

The ID of the cluster for the retrieved stream.

creation_time instance-attribute

creation_time: StreamCreationTime

The time when the stream was created.

format instance-attribute

format: StreamFormat

The format of the stream records.

ordering instance-attribute

ordering: StreamOrdering

The ordering mode of the stream.

status instance-attribute

status: StreamStatus

The current status of the retrieved stream.

status_reason instance-attribute

status_reason: NotRequired[StatusReason]

Stream status reason with error code and timestamp (if applicable).

stream_identifier instance-attribute

stream_identifier: StreamId

The ID of the retrieved stream.

tags instance-attribute

tags: NotRequired[TagMap]

A map of tags associated with the stream.

target_definition instance-attribute

target_definition: NotRequired[TargetDefinition]

The target definition for the stream destination.