Skip to content

describe_configuration async

describe_configuration(
    arn: __string, *, config_overrides: Optional[AsyncKafkaClientConfig] = None
) -> DescribeConfigurationResponse

Returns a description of this MSK configuration.

Parameters:

  • arn (__string) –

    The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.

Raises:

Source code in docs_src/capo_kafka/_services/async_kafka.py
async def describe_configuration(
    self,
    arn: "capo_kafka.types.__string.__string",
    *,
    config_overrides: Optional[AsyncKafkaClientConfig] = None,
) -> (
    "capo_kafka.types.describe_configuration_response.DescribeConfigurationResponse"
):
    """<p>Returns a description of this MSK configuration.</p>

    Args:
        arn: <p>The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.</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.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_configuration_request.DescribeConfigurationRequest]",
    ) -> AsyncOperationResponse[
        "capo_kafka.types.describe_configuration_response.DescribeConfigurationResponse"
    ]:
        import capo_kafka._operations.kafka.describe_configuration

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeConfiguration")
    )
    input_: capo_kafka.types.describe_configuration_request.DescribeConfigurationRequest = {
        "arn": arn
    }

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