Skip to content

describe_channel

Operation

describe_channel

describe_channel(request: DescribeChannelInput | DescribeChannelInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeChannelInputDict]) -> DescribeChannelOutput

Describes the specified channel, including its configuration and current status.

Use this operation to verify that a channel reached the ACTIVE state after creation, or to diagnose a channel in the FAILED state by reading the ChannelStatusReason.

This operation has a call limit of 5 transactions per second (TPS) for each Amazon Web Services account. Exceeding 5 TPS results in a LimitExceededException.

Parameters:

Name Type Description Default
request DescribeChannelInput | DescribeChannelInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[DescribeChannelInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeChannelOutput

An instance of DescribeChannelOutput.

describe_channel async

describe_channel(request: DescribeChannelInput | DescribeChannelInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeChannelInputDict]) -> DescribeChannelOutput

Describes the specified channel, including its configuration and current status.

Use this operation to verify that a channel reached the ACTIVE state after creation, or to diagnose a channel in the FAILED state by reading the ChannelStatusReason.

This operation has a call limit of 5 transactions per second (TPS) for each Amazon Web Services account. Exceeding 5 TPS results in a LimitExceededException.

Parameters:

Name Type Description Default
request DescribeChannelInput | DescribeChannelInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[DescribeChannelInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeChannelOutput

An instance of DescribeChannelOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DescribeChannelInputDict

Bases: TypedDict

Dictionary form of DescribeChannelInput.

Attributes

channel_arn instance-attribute
channel_arn: Required[str]

The Amazon Resource Name (ARN) of the channel to describe.

DescribeChannelInput dataclass

Bases: _SerdeShape

Dataclass for DescribeChannelInput structure.

Attributes

channel_arn class-attribute instance-attribute
channel_arn: str | None = ...

The Amazon Resource Name (ARN) of the channel to describe.

Output

DescribeChannelOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeChannelOutput structure.

Attributes

channel_description instance-attribute
channel_description: ChannelDescription

The configuration and current status of the channel, including its ARN, source stream, destination configuration, and lifecycle state.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.