Skip to content

DescribeChannelResponse

Source code in docs_src/capo_kafka/types/describe_channel_response.py
class DescribeChannelResponse(TypedDict, closed=True):
    channel_arn: NotRequired["capo_kafka.types.__string.__string"]
    """<p>The Amazon Resource Name (ARN) that uniquely identifies the channel.</p>"""
    channel_name: NotRequired["capo_kafka.types.__string.__string"]
    """<p>The name of the channel.</p>"""
    encryption_configuration: NotRequired[
        "capo_kafka.types.encryption_configuration.EncryptionConfiguration"
    ]
    """<p>The encryption configuration applied to the channel.</p>"""
    iceberg_destination_configuration: NotRequired[
        "capo_kafka.types.iceberg_destination_configuration.IcebergDestinationConfiguration"
    ]
    """<p>The Apache Iceberg destination for the channel, if configured.</p>"""
    s3_destination_configuration: NotRequired[
        "capo_kafka.types.s3_destination_configuration.S3DestinationConfiguration"
    ]
    """<p>The Amazon S3 destination for the channel, if configured.</p>"""
    status: NotRequired["capo_kafka.types.channel_status.ChannelStatus"]
    """<p>The current lifecycle state of the channel.</p>"""
    destination_type: NotRequired[
        "capo_kafka.types.channel_destination_type.ChannelDestinationType"
    ]
    """<p>The type of destination configured for the channel.</p>"""
    creation_time: NotRequired[
        "capo_kafka.types.__timestamp_iso8601.__timestampIso8601"
    ]
    """<p>The time when the channel was created.</p>"""
    topic_configuration_list: NotRequired[
        "capo_kafka.types.__list_of_topic_configuration.__listOfTopicConfiguration"
    ]
    """<p>The list of topic configurations for the channel.</p>"""
    logging_info: NotRequired[
        "capo_kafka.types.channel_logging_info.ChannelLoggingInfo"
    ]
    """<p>The destinations to which the channel publishes operational logs.</p>"""
    state_info: NotRequired["capo_kafka.types.channel_state_info.ChannelStateInfo"]
    """<p>Additional context for the current channel state, populated when the channel is in FAILED.</p>"""
    cluster_operation_arn: NotRequired["capo_kafka.types.__string.__string"]
    """<p>The Amazon Resource Name (ARN) of the in-flight cluster operation. Returned only while the channel is in CREATING, UPDATING, or DELETING.</p>"""
    tags: NotRequired["capo_kafka.types.__map_of__string.__mapOf__string"]
    """<p>The tags attached to the channel.</p>"""

channel_arn instance-attribute

channel_arn: NotRequired[__string]

The Amazon Resource Name (ARN) that uniquely identifies the channel.

channel_name instance-attribute

channel_name: NotRequired[__string]

The name of the channel.

cluster_operation_arn instance-attribute

cluster_operation_arn: NotRequired[__string]

The Amazon Resource Name (ARN) of the in-flight cluster operation. Returned only while the channel is in CREATING, UPDATING, or DELETING.

creation_time instance-attribute

creation_time: NotRequired[__timestampIso8601]

The time when the channel was created.

destination_type instance-attribute

destination_type: NotRequired[ChannelDestinationType]

The type of destination configured for the channel.

encryption_configuration instance-attribute

encryption_configuration: NotRequired[EncryptionConfiguration]

The encryption configuration applied to the channel.

iceberg_destination_configuration instance-attribute

iceberg_destination_configuration: NotRequired[IcebergDestinationConfiguration]

The Apache Iceberg destination for the channel, if configured.

logging_info instance-attribute

logging_info: NotRequired[ChannelLoggingInfo]

The destinations to which the channel publishes operational logs.

s3_destination_configuration instance-attribute

s3_destination_configuration: NotRequired[S3DestinationConfiguration]

The Amazon S3 destination for the channel, if configured.

state_info instance-attribute

state_info: NotRequired[ChannelStateInfo]

Additional context for the current channel state, populated when the channel is in FAILED.

status instance-attribute

status: NotRequired[ChannelStatus]

The current lifecycle state of the channel.

tags instance-attribute

tags: NotRequired[__mapOf__string]

The tags attached to the channel.

topic_configuration_list instance-attribute

topic_configuration_list: NotRequired[__listOfTopicConfiguration]

The list of topic configurations for the channel.