Skip to content

Kinesis  >  Structures  >  ChannelDescription

ChannelDescription

Structure Class

ChannelDescription dataclass

Bases: _SerdeShape

Describes the configuration and current status of a channel.

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_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.

encryption_configuration class-attribute instance-attribute 
encryption_configuration: ChannelEncryptionConfiguration | None = ...

The Amazon Web Services KMS key configuration that Amazon Kinesis Data Streams uses to encrypt data delivered to the channel's destination.

logging_configuration instance-attribute 
logging_configuration: ChannelLoggingConfiguration

The Amazon CloudWatch Logs configuration for the channel.

s3_destination_configuration class-attribute instance-attribute 
s3_destination_configuration: S3DestinationDescription | None = ...

The configuration for delivery to a general purpose Amazon S3 bucket. Present only when the channel destination is a general purpose Amazon S3 bucket.

s3_tables_destination_configuration class-attribute instance-attribute 
s3_tables_destination_configuration: S3TablesDestinationDescription | None = ...

The configuration for delivery to streaming tables on Apache Iceberg in Amazon S3 Tables. Present only when the channel destination is a streaming table.

service_execution_role_arn instance-attribute 
service_execution_role_arn: str

The Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Data Streams assumes to write records to the destination.

stream_configuration_list instance-attribute 
stream_configuration_list: list[ChannelStreamDescription]

The source stream configuration for the channel.