Skip to content

GetStreamOutput

Source code in docs_src/capo_keyspacesstreams/types/get_stream_output.py
class GetStreamOutput(TypedDict, closed=True):
    stream_arn: "capo_keyspacesstreams.types.stream_arn.StreamArn"
    """<p> The Amazon Resource Name (ARN) that uniquely identifies the stream within Amazon Keyspaces. This ARN can be used in other API operations to reference this specific stream. </p>"""
    stream_label: "str"
    """<p> A timestamp that serves as a unique identifier for this stream, used for debugging and monitoring purposes. The stream label represents the point in time when the stream was created. </p>"""
    stream_status: "capo_keyspacesstreams.types.stream_status.StreamStatus"
    """<p> The current status of the stream. Values can be <code>ENABLING</code>, <code>ENABLED</code>, <code>DISABLING</code>, or <code>DISABLED</code>. Operations on the stream depend on its current status. </p>"""
    stream_view_type: "capo_keyspacesstreams.types.stream_view_type.StreamViewType"
    """<p> The format of the data records in this stream. Currently, this can be one of the following options: </p> <ul> <li> <p> <code>NEW_AND_OLD_IMAGES</code> - both versions of the row, before and after the change. This is the default.</p> </li> <li> <p> <code>NEW_IMAGE</code> - the version of the row after the change.</p> </li> <li> <p> <code>OLD_IMAGE</code> - the version of the row before the change.</p> </li> <li> <p> <code>KEYS_ONLY</code> - the partition and clustering keys of the row that was changed.</p> </li> </ul>"""
    creation_request_date_time: "capo_keyspacesstreams.types.date.Date"
    """<p> The date and time when the request to create this stream was issued. The value is represented in ISO 8601 format. </p>"""
    keyspace_name: "capo_keyspacesstreams.types.keyspace_name.KeyspaceName"
    """<p> The name of the keyspace containing the table associated with this stream. The keyspace name is part of the table's hierarchical identifier in Amazon Keyspaces. </p>"""
    table_name: "capo_keyspacesstreams.types.table_name.TableName"
    """<p> The name of the table associated with this stream. The stream captures changes to rows in this Amazon Keyspaces table. </p>"""
    shards: NotRequired[
        "capo_keyspacesstreams.types.shard_description_list.ShardDescriptionList"
    ]
    """<p> An array of shard objects associated with this stream. Each shard contains a subset of the stream's data records and has its own unique identifier. The collection of shards represents the complete stream data. </p>"""
    next_token: NotRequired["capo_keyspacesstreams.types.shard_id_token.ShardIdToken"]
    """<p> A pagination token that can be used in a subsequent <code>GetStream</code> request. This token is returned if the response contains more shards than can be returned in a single response. </p>"""

creation_request_date_time instance-attribute

creation_request_date_time: Date

The date and time when the request to create this stream was issued. The value is represented in ISO 8601 format.

keyspace_name instance-attribute

keyspace_name: KeyspaceName

The name of the keyspace containing the table associated with this stream. The keyspace name is part of the table's hierarchical identifier in Amazon Keyspaces.

next_token instance-attribute

next_token: NotRequired[ShardIdToken]

A pagination token that can be used in a subsequent GetStream request. This token is returned if the response contains more shards than can be returned in a single response.

shards instance-attribute

shards: NotRequired[ShardDescriptionList]

An array of shard objects associated with this stream. Each shard contains a subset of the stream's data records and has its own unique identifier. The collection of shards represents the complete stream data.

stream_arn instance-attribute

stream_arn: StreamArn

The Amazon Resource Name (ARN) that uniquely identifies the stream within Amazon Keyspaces. This ARN can be used in other API operations to reference this specific stream.

stream_label instance-attribute

stream_label: str

A timestamp that serves as a unique identifier for this stream, used for debugging and monitoring purposes. The stream label represents the point in time when the stream was created.

stream_status instance-attribute

stream_status: StreamStatus

The current status of the stream. Values can be ENABLING, ENABLED, DISABLING, or DISABLED. Operations on the stream depend on its current status.

stream_view_type instance-attribute

stream_view_type: StreamViewType

The format of the data records in this stream. Currently, this can be one of the following options:

  • NEW_AND_OLD_IMAGES - both versions of the row, before and after the change. This is the default.

  • NEW_IMAGE - the version of the row after the change.

  • OLD_IMAGE - the version of the row before the change.

  • KEYS_ONLY - the partition and clustering keys of the row that was changed.

table_name instance-attribute

table_name: TableName

The name of the table associated with this stream. The stream captures changes to rows in this Amazon Keyspaces table.