describe_custom_plugin ¶

describe_custom_plugin(
    custom_plugin_arn: __string,
    *,
    config_overrides: Optional[KafkaConnectClientConfig] = None,
) -> DescribeCustomPluginResponse

A summary description of the custom plugin.

Parameters:

custom_plugin_arn (__string) –

Returns information about a custom plugin.

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/kafka_connect.py

def describe_custom_plugin(
    self,
    custom_plugin_arn: "capo_kafkaconnect.types.__string.__string",
    *,
    config_overrides: Optional[KafkaConnectClientConfig] = None,
) -> "capo_kafkaconnect.types.describe_custom_plugin_response.DescribeCustomPluginResponse":
    """<p>A summary description of the custom plugin.</p>

    Args:
        custom_plugin_arn: <p>Returns information about a custom plugin.</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.
    """

    def _handler(
        req: "OperationRequest[capo_kafkaconnect.types.describe_custom_plugin_request.DescribeCustomPluginRequest]",
    ) -> OperationResponse[
        "capo_kafkaconnect.types.describe_custom_plugin_response.DescribeCustomPluginResponse"
    ]:
        import capo_kafkaconnect._operations.kafka_connect.describe_custom_plugin

        output, http_response = (
            capo_kafkaconnect._operations.kafka_connect.describe_custom_plugin.describe_custom_plugin(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeCustomPlugin")
    )
    input_: capo_kafkaconnect.types.describe_custom_plugin_request.DescribeCustomPluginRequest = {
        "custom_plugin_arn": custom_plugin_arn
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output