describe_channel `async` ¶

describe_channel(
    channel_arn: ChannelARN,
    *,
    config_overrides: Optional[AsyncKinesisClientConfig] = None,
) -> 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:

channel_arn (ChannelARN) –

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

Raises:

AccessDeniedException –

Specifies that you do not have the permissions required to perform this operation.
InvalidArgumentException –

A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.
LimitExceededException –

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
ResourceNotFoundException –

The requested resource could not be found. The stream might not be specified correctly.
ValidationException –

Specifies that you tried to invoke this API for a data stream with the on-demand capacity mode. This API is only supported for data streams with the provisioned capacity mode.
UnknownServiceError –

The service returned an error code this client does not model.

Examples:

To describe a channel

>>> await client.describe_channel(channel_arn='arn:aws:kinesis:us-east-1:123456789012:channel/my-channel-id')

Source code in docs_src/capo_kinesis/_services/async_kinesis.py

async def describe_channel(
    self,
    channel_arn: "capo_kinesis.types.channel_arn.ChannelARN",
    *,
    config_overrides: Optional[AsyncKinesisClientConfig] = None,
) -> "capo_kinesis.types.describe_channel_output.DescribeChannelOutput":
    """<p>Describes the specified channel, including its configuration and current status.</p> <p>Use this operation to verify that a channel reached the <code>ACTIVE</code> state after creation, or to diagnose a channel in the <code>FAILED</code> state by reading the <code>ChannelStatusReason</code>.</p> <p>This operation has a call limit of 5 transactions per second (TPS) for each Amazon Web Services account. Exceeding 5 TPS results in a <code>LimitExceededException</code>.</p>

    Args:
        channel_arn: <p>The Amazon Resource Name (ARN) of the channel to describe.</p>

    Raises:
        capo_kinesis.errors.access_denied_exception.AccessDeniedException: <p>Specifies that you do not have the permissions required to perform this operation.</p>
        capo_kinesis.errors.invalid_argument_exception.InvalidArgumentException: <p>A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.</p>
        capo_kinesis.errors.limit_exceeded_exception.LimitExceededException: <p>The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed. </p>
        capo_kinesis.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource could not be found. The stream might not be specified correctly.</p>
        capo_kinesis.errors.validation_exception.ValidationException: <p>Specifies that you tried to invoke this API for a data stream with the on-demand capacity mode. This API is only supported for data streams with the provisioned capacity mode. </p>
        capo_kinesis.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To describe a channel

        >>> await client.describe_channel(channel_arn='arn:aws:kinesis:us-east-1:123456789012:channel/my-channel-id')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_kinesis.types.describe_channel_input.DescribeChannelInput]",
    ) -> AsyncOperationResponse[
        "capo_kinesis.types.describe_channel_output.DescribeChannelOutput"
    ]:
        import capo_kinesis._operations.kinesis_20131202.describe_channel

        (
            output,
            http_response,
        ) = await capo_kinesis._operations.kinesis_20131202.describe_channel.async_describe_channel(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeChannel")
    )
    input_: capo_kinesis.types.describe_channel_input.DescribeChannelInput = {
        "channel_arn": channel_arn
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

describe_channel async ¶

describe_channel `async` ¶