Skip to content

ChannelSummary

Source code in docs_src/capo_kinesis/types/channel_summary.py
class ChannelSummary(TypedDict, closed=True):
    channel_name: "capo_kinesis.types.channel_name.ChannelName"
    """<p>The name of the channel.</p>"""
    channel_arn: "capo_kinesis.types.channel_arn.ChannelARN"
    """<p>The Amazon Resource Name (ARN) of the channel.</p>"""
    channel_id: "capo_kinesis.types.channel_id.ChannelId"
    """<p>The unique identifier of the channel.</p>"""
    channel_status: "capo_kinesis.types.channel_status.ChannelStatus"
    """<p>The current status of the channel. Valid values:</p> <ul> <li> <p> <code>CREATING</code> - The channel is being created.</p> </li> <li> <p> <code>ACTIVE</code> - The channel is ready to deliver records.</p> </li> <li> <p> <code>UPDATING</code> - The channel configuration is being updated.</p> </li> <li> <p> <code>DELETING</code> - The channel is being deleted.</p> </li> <li> <p> <code>FAILED</code> - See <code>ChannelStatusReason</code> for the failure cause.</p> </li> </ul>"""
    channel_status_reason: NotRequired[
        "capo_kinesis.types.channel_status_reason.ChannelStatusReason"
    ]
    """<p>A message describing the reason for a <code>FAILED</code> status.</p>"""
    channel_creation_timestamp: "capo_kinesis.types.timestamp.Timestamp"
    """<p>The time at which the channel was created.</p>"""
    channel_destination_type: (
        "capo_kinesis.types.channel_destination_type.ChannelDestinationType"
    )
    """<p>The destination type of the channel. Valid values:</p> <ul> <li> <p> <code>S3</code> - Delivery to a general purpose Amazon S3 bucket.</p> </li> <li> <p> <code>S3_TABLES</code> - Delivery to streaming tables on Apache Iceberg.</p> </li> </ul>"""
    streams: (
        "capo_kinesis.types.channel_stream_identifier_list.ChannelStreamIdentifierList"
    )
    """<p>The source streams associated with the channel.</p>"""

channel_arn instance-attribute

channel_arn: ChannelARN

The Amazon Resource Name (ARN) of the channel.

channel_creation_timestamp instance-attribute

channel_creation_timestamp: Timestamp

The time at which the channel was created.

channel_destination_type instance-attribute

channel_destination_type: ChannelDestinationType

The destination type of the channel. Valid values:

  • S3 - Delivery to a general purpose Amazon S3 bucket.

  • S3_TABLES - Delivery to streaming tables on Apache Iceberg.

channel_id instance-attribute

channel_id: ChannelId

The unique identifier of the channel.

channel_name instance-attribute

channel_name: ChannelName

The name of the channel.

channel_status instance-attribute

channel_status: ChannelStatus

The current status of the channel. Valid values:

  • CREATING - The channel is being created.

  • ACTIVE - The channel is ready to deliver records.

  • UPDATING - The channel configuration is being updated.

  • DELETING - The channel is being deleted.

  • FAILED - See ChannelStatusReason for the failure cause.

channel_status_reason instance-attribute

channel_status_reason: NotRequired[ChannelStatusReason]

A message describing the reason for a FAILED status.

streams instance-attribute

The source streams associated with the channel.