Skip to content

describe_topic async

describe_topic(
    cluster_arn: __string,
    topic_name: __string,
    *,
    config_overrides: Optional[AsyncKafkaClientConfig] = None,
) -> DescribeTopicResponse

Returns topic details of this topic on a MSK cluster.

Parameters:

  • cluster_arn (__string) –

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

  • topic_name (__string) –

    The Kafka topic name that uniquely identifies the topic.

Raises:

Source code in docs_src/capo_kafka/_services/async_kafka.py
async def describe_topic(
    self,
    cluster_arn: "capo_kafka.types.__string.__string",
    topic_name: "capo_kafka.types.__string.__string",
    *,
    config_overrides: Optional[AsyncKafkaClientConfig] = None,
) -> "capo_kafka.types.describe_topic_response.DescribeTopicResponse":
    """<p>Returns topic details of this topic on a MSK cluster.</p>

    Args:
        cluster_arn: <p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p>
        topic_name: <p>The Kafka topic name that uniquely identifies the topic.</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.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_topic_request.DescribeTopicRequest]",
    ) -> AsyncOperationResponse[
        "capo_kafka.types.describe_topic_response.DescribeTopicResponse"
    ]:
        import capo_kafka._operations.kafka.describe_topic

        (
            output,
            http_response,
        ) = await capo_kafka._operations.kafka.describe_topic.async_describe_topic(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeTopic")
    )
    input_: capo_kafka.types.describe_topic_request.DescribeTopicRequest = {
        "cluster_arn": cluster_arn,
        "topic_name": topic_name,
    }

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