ChannelDescription ¶

class ChannelDescription(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>"""
    service_execution_role_arn: "capo_kinesis.types.role_arn.RoleARN"
    """<p>The Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Data Streams assumes to write records to the destination.</p>"""
    stream_configuration_list: "capo_kinesis.types.channel_stream_description_list.ChannelStreamDescriptionList"
    """<p>The source stream configuration for the channel.</p>"""
    s3_destination_configuration: NotRequired[
        "capo_kinesis.types.s3_destination_description.S3DestinationDescription"
    ]
    """<p>The configuration for delivery to a general purpose Amazon S3 bucket. Present only when the channel destination is a general purpose Amazon S3 bucket.</p>"""
    s3_tables_destination_configuration: NotRequired[
        "capo_kinesis.types.s3_tables_destination_description.S3TablesDestinationDescription"
    ]
    """<p>The configuration for delivery to streaming tables on Apache Iceberg in Amazon S3 Tables. Present only when the channel destination is a streaming table.</p>"""
    encryption_configuration: NotRequired[
        "capo_kinesis.types.channel_encryption_configuration.ChannelEncryptionConfiguration"
    ]
    """<p>The Amazon Web Services KMS key configuration that Amazon Kinesis Data Streams uses to encrypt data delivered to the channel's destination.</p>"""
    logging_configuration: (
        "capo_kinesis.types.channel_logging_configuration.ChannelLoggingConfiguration"
    )
    """<p>The Amazon CloudWatch Logs configuration for the channel.</p>"""