Skip to content

list_custom_plugins 

list_custom_plugins(
    *,
    config_overrides: Optional[KafkaConnectClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[__string] = None,
    name_prefix: Optional[__string] = None,
) -> ListCustomPluginsResponse

Returns a list of all of the custom plugins in this account and Region.

Parameters:

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of custom plugins to list in one response.

  • next_token (Optional[__string], default: None ) –

    If the response of a ListCustomPlugins operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.

  • name_prefix (Optional[__string], default: None ) –

    Lists custom plugin names that start with the specified text string.

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 
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
def list_custom_plugins(
    self,
    *,
    config_overrides: Optional[KafkaConnectClientConfig] = None,
    max_results: Optional["capo_kafkaconnect.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_kafkaconnect.types.__string.__string"] = None,
    name_prefix: Optional["capo_kafkaconnect.types.__string.__string"] = None,
) -> (
    "capo_kafkaconnect.types.list_custom_plugins_response.ListCustomPluginsResponse"
):
    """<p>Returns a list of all of the custom plugins in this account and Region.</p>

    Args:
        max_results: <p>The maximum number of custom plugins to list in one response.</p>
        next_token: <p>If the response of a ListCustomPlugins operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.</p>
        name_prefix: <p>Lists custom plugin names that start with the specified text string.</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.list_custom_plugins_request.ListCustomPluginsRequest]",
    ) -> OperationResponse[
        "capo_kafkaconnect.types.list_custom_plugins_response.ListCustomPluginsResponse"
    ]:
        import capo_kafkaconnect._operations.kafka_connect.list_custom_plugins

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListCustomPlugins")
    )
    input_: capo_kafkaconnect.types.list_custom_plugins_request.ListCustomPluginsRequest = {}
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if name_prefix is not None:
        input_["name_prefix"] = name_prefix

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