Skip to content

Kinesis  >  Structures  >  ChannelSummary

ChannelSummary

Structure Class

ChannelSummary dataclass

Bases: _SerdeShape

A summary of a channel, returned by ListChannels.

Attributes

channel_arn instance-attribute 
channel_arn: str

The Amazon Resource Name (ARN) of the channel.

channel_creation_timestamp instance-attribute 
channel_creation_timestamp: datetime

The time at which the channel was created.

channel_destination_type instance-attribute 
channel_destination_type: str

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: str

The unique identifier of the channel.

channel_name instance-attribute 
channel_name: str

The name of the channel.

channel_status instance-attribute 
channel_status: str

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 class-attribute instance-attribute 
channel_status_reason: str | None = ...

A message describing the reason for a FAILED status.

streams instance-attribute 
streams: list[ChannelStreamIdentifier]

The source streams associated with the channel.