describe_connector `async` ¶

describe_connector(
    connector_arn: __string,
    *,
    config_overrides: Optional[AsyncKafkaConnectClientConfig] = None,
) -> DescribeConnectorResponse

Returns summary information about the connector.

Parameters:

connector_arn (__string) –

The Amazon Resource Name (ARN) of the connector that you want to describe.

Raises:

BadRequestException –

HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
ForbiddenException –

HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
InternalServerErrorException –

HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
NotFoundException –

HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
ServiceUnavailableException –

HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.
TooManyRequestsException –

HTTP Status Code 429: Limit exceeded. Resource limit reached.
UnauthorizedException –

HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.
UnknownServiceError –

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

Source code in docs_src/capo_kafkaconnect/_services/async_kafka_connect.py

async def describe_connector(
    self,
    connector_arn: "capo_kafkaconnect.types.__string.__string",
    *,
    config_overrides: Optional[AsyncKafkaConnectClientConfig] = None,
) -> (
    "capo_kafkaconnect.types.describe_connector_response.DescribeConnectorResponse"
):
    """<p>Returns summary information about the connector.</p>

    Args:
        connector_arn: <p>The Amazon Resource Name (ARN) of the connector that you want to describe.</p>

    Raises:
        capo_kafkaconnect.errors.bad_request_exception.BadRequestException: <p>HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.</p>
        capo_kafkaconnect.errors.forbidden_exception.ForbiddenException: <p>HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.</p>
        capo_kafkaconnect.errors.internal_server_error_exception.InternalServerErrorException: <p>HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.</p>
        capo_kafkaconnect.errors.not_found_exception.NotFoundException: <p>HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.</p>
        capo_kafkaconnect.errors.service_unavailable_exception.ServiceUnavailableException: <p>HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.</p>
        capo_kafkaconnect.errors.too_many_requests_exception.TooManyRequestsException: <p>HTTP Status Code 429: Limit exceeded. Resource limit reached.</p>
        capo_kafkaconnect.errors.unauthorized_exception.UnauthorizedException: <p>HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.</p>
        capo_kafkaconnect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_kafkaconnect.types.describe_connector_request.DescribeConnectorRequest]",
    ) -> AsyncOperationResponse[
        "capo_kafkaconnect.types.describe_connector_response.DescribeConnectorResponse"
    ]:
        import capo_kafkaconnect._operations.kafka_connect.describe_connector

        (
            output,
            http_response,
        ) = await capo_kafkaconnect._operations.kafka_connect.describe_connector.async_describe_connector(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_kafkaconnect.types.describe_connector_response.DescribeConnectorResponse",
    ) -> dict[str, Any]:
        import capo_kafkaconnect.types.describe_connector_response

        return capo_kafkaconnect.types.describe_connector_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeConnector", redact_output=_redact_output),
    )
    input_: capo_kafkaconnect.types.describe_connector_request.DescribeConnectorRequest = {
        "connector_arn": connector_arn
    }

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

describe_connector async ¶

describe_connector `async` ¶