Returns the current configuration and state of a channel.
Parameters:
-
channel_arn
(__string)
–
The Amazon Resource Name (ARN) that uniquely identifies the channel.
-
cluster_arn
(__string)
–
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
Raises:
Source code in docs_src/capo_kafka/_services/async_kafka.py
| async def describe_channel(
self,
channel_arn: "capo_kafka.types.__string.__string",
cluster_arn: "capo_kafka.types.__string.__string",
*,
config_overrides: Optional[AsyncKafkaClientConfig] = None,
) -> "capo_kafka.types.describe_channel_response.DescribeChannelResponse":
"""<p>Returns the current configuration and state of a channel.</p>
Args:
channel_arn: <p>The Amazon Resource Name (ARN) that uniquely identifies the channel.</p>
cluster_arn: <p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p>
Raises:
capo_kafka.errors.bad_request_exception.BadRequestException: <p>Returns information about an error.</p>
capo_kafka.errors.forbidden_exception.ForbiddenException: <p>Returns information about an error.</p>
capo_kafka.errors.internal_server_error_exception.InternalServerErrorException: <p>Returns information about an error.</p>
capo_kafka.errors.not_found_exception.NotFoundException: <p>Returns information about an error.</p>
capo_kafka.errors.service_unavailable_exception.ServiceUnavailableException: <p>Returns information about an error.</p>
capo_kafka.errors.too_many_requests_exception.TooManyRequestsException: <p>Returns information about an error.</p>
capo_kafka.errors.unauthorized_exception.UnauthorizedException: <p>Returns information about an error.</p>
capo_kafka.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_kafka.types.describe_channel_request.DescribeChannelRequest]",
) -> AsyncOperationResponse[
"capo_kafka.types.describe_channel_response.DescribeChannelResponse"
]:
import capo_kafka._operations.kafka.describe_channel
(
output,
http_response,
) = await capo_kafka._operations.kafka.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_kafka.types.describe_channel_request.DescribeChannelRequest = {
"channel_arn": channel_arn,
"cluster_arn": cluster_arn,
}
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|