/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.kafkaconnect; import javax.annotation.Generated; import com.amazonaws.*; import com.amazonaws.regions.*; import com.amazonaws.services.kafkaconnect.model.*; /** * Interface for accessing Kafka Connect. *

* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.kafkaconnect.AbstractAWSKafkaConnect} instead. *

*

*

*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AWSKafkaConnect { /** * The region metadata service name for computing region endpoints. You can use this value to retrieve metadata * (such as supported regions) of the service. * * @see RegionUtils#getRegionsForService(String) */ String ENDPOINT_PREFIX = "kafkaconnect"; /** *

* Creates a connector using the specified properties. *

* * @param createConnectorRequest * @return Result of the CreateConnector operation returned by the service. * @throws NotFoundException * HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it. * @throws ConflictException * HTTP Status Code 409: Conflict. A resource with this name already exists. Retry your request with another * name. * @throws BadRequestException * HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it. * @throws ForbiddenException * HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request. * @throws ServiceUnavailableException * HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue. * @throws TooManyRequestsException * HTTP Status Code 429: Limit exceeded. Resource limit reached. * @throws UnauthorizedException * HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated. * @throws InternalServerErrorException * HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue. * @sample AWSKafkaConnect.CreateConnector * @see AWS * API Documentation */ CreateConnectorResult createConnector(CreateConnectorRequest createConnectorRequest); /** *

* Creates a custom plugin using the specified properties. *

* * @param createCustomPluginRequest * @return Result of the CreateCustomPlugin operation returned by the service. * @throws NotFoundException * HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it. * @throws ConflictException * HTTP Status Code 409: Conflict. A resource with this name already exists. Retry your request with another * name. * @throws BadRequestException * HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it. * @throws ForbiddenException * HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request. * @throws ServiceUnavailableException * HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue. * @throws TooManyRequestsException * HTTP Status Code 429: Limit exceeded. Resource limit reached. * @throws UnauthorizedException * HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated. * @throws InternalServerErrorException * HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue. * @sample AWSKafkaConnect.CreateCustomPlugin * @see AWS API Documentation */ CreateCustomPluginResult createCustomPlugin(CreateCustomPluginRequest createCustomPluginRequest); /** *

* Creates a worker configuration using the specified properties. *

* * @param createWorkerConfigurationRequest * @return Result of the CreateWorkerConfiguration operation returned by the service. * @throws NotFoundException * HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it. * @throws ConflictException * HTTP Status Code 409: Conflict. A resource with this name already exists. Retry your request with another * name. * @throws BadRequestException * HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it. * @throws ForbiddenException * HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request. * @throws ServiceUnavailableException * HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue. * @throws TooManyRequestsException * HTTP Status Code 429: Limit exceeded. Resource limit reached. * @throws UnauthorizedException * HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated. * @throws InternalServerErrorException * HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue. * @sample AWSKafkaConnect.CreateWorkerConfiguration * @see AWS API Documentation */ CreateWorkerConfigurationResult createWorkerConfiguration(CreateWorkerConfigurationRequest createWorkerConfigurationRequest); /** *

* Deletes the specified connector. *

* * @param deleteConnectorRequest * @return Result of the DeleteConnector operation returned by the service. * @throws NotFoundException * HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it. * @throws BadRequestException * HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it. * @throws ForbiddenException * HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request. * @throws ServiceUnavailableException * HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue. * @throws TooManyRequestsException * HTTP Status Code 429: Limit exceeded. Resource limit reached. * @throws UnauthorizedException * HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated. * @throws InternalServerErrorException * HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue. * @sample AWSKafkaConnect.DeleteConnector * @see AWS * API Documentation */ DeleteConnectorResult deleteConnector(DeleteConnectorRequest deleteConnectorRequest); /** *

* Deletes a custom plugin. *

* * @param deleteCustomPluginRequest * @return Result of the DeleteCustomPlugin operation returned by the service. * @throws NotFoundException * HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it. * @throws BadRequestException * HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it. * @throws ForbiddenException * HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request. * @throws ServiceUnavailableException * HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue. * @throws TooManyRequestsException * HTTP Status Code 429: Limit exceeded. Resource limit reached. * @throws UnauthorizedException * HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated. * @throws InternalServerErrorException * HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue. * @sample AWSKafkaConnect.DeleteCustomPlugin * @see AWS API Documentation */ DeleteCustomPluginResult deleteCustomPlugin(DeleteCustomPluginRequest deleteCustomPluginRequest); /** *

* Returns summary information about the connector. *

* * @param describeConnectorRequest * @return Result of the DescribeConnector operation returned by the service. * @throws NotFoundException * HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it. * @throws BadRequestException * HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it. * @throws ForbiddenException * HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request. * @throws ServiceUnavailableException * HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue. * @throws TooManyRequestsException * HTTP Status Code 429: Limit exceeded. Resource limit reached. * @throws UnauthorizedException * HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated. * @throws InternalServerErrorException * HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue. * @sample AWSKafkaConnect.DescribeConnector * @see AWS * API Documentation */ DescribeConnectorResult describeConnector(DescribeConnectorRequest describeConnectorRequest); /** *

* A summary description of the custom plugin. *

* * @param describeCustomPluginRequest * @return Result of the DescribeCustomPlugin operation returned by the service. * @throws NotFoundException * HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it. * @throws BadRequestException * HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it. * @throws ForbiddenException * HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request. * @throws ServiceUnavailableException * HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue. * @throws TooManyRequestsException * HTTP Status Code 429: Limit exceeded. Resource limit reached. * @throws UnauthorizedException * HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated. * @throws InternalServerErrorException * HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue. * @sample AWSKafkaConnect.DescribeCustomPlugin * @see AWS API Documentation */ DescribeCustomPluginResult describeCustomPlugin(DescribeCustomPluginRequest describeCustomPluginRequest); /** *

* Returns information about a worker configuration. *

* * @param describeWorkerConfigurationRequest * @return Result of the DescribeWorkerConfiguration operation returned by the service. * @throws NotFoundException * HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it. * @throws BadRequestException * HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it. * @throws ForbiddenException * HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request. * @throws ServiceUnavailableException * HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue. * @throws TooManyRequestsException * HTTP Status Code 429: Limit exceeded. Resource limit reached. * @throws UnauthorizedException * HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated. * @throws InternalServerErrorException * HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue. * @sample AWSKafkaConnect.DescribeWorkerConfiguration * @see AWS API Documentation */ DescribeWorkerConfigurationResult describeWorkerConfiguration(DescribeWorkerConfigurationRequest describeWorkerConfigurationRequest); /** *

* Returns a list of all the connectors in this account and Region. The list is limited to connectors whose name * starts with the specified prefix. The response also includes a description of each of the listed connectors. *

* * @param listConnectorsRequest * @return Result of the ListConnectors operation returned by the service. * @throws NotFoundException * HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it. * @throws BadRequestException * HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it. * @throws ForbiddenException * HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request. * @throws ServiceUnavailableException * HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue. * @throws TooManyRequestsException * HTTP Status Code 429: Limit exceeded. Resource limit reached. * @throws UnauthorizedException * HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated. * @throws InternalServerErrorException * HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue. * @sample AWSKafkaConnect.ListConnectors * @see AWS * API Documentation */ ListConnectorsResult listConnectors(ListConnectorsRequest listConnectorsRequest); /** *

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

* * @param listCustomPluginsRequest * @return Result of the ListCustomPlugins operation returned by the service. * @throws NotFoundException * HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it. * @throws BadRequestException * HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it. * @throws ForbiddenException * HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request. * @throws ServiceUnavailableException * HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue. * @throws TooManyRequestsException * HTTP Status Code 429: Limit exceeded. Resource limit reached. * @throws UnauthorizedException * HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated. * @throws InternalServerErrorException * HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue. * @sample AWSKafkaConnect.ListCustomPlugins * @see AWS * API Documentation */ ListCustomPluginsResult listCustomPlugins(ListCustomPluginsRequest listCustomPluginsRequest); /** *

* Returns a list of all of the worker configurations in this account and Region. *

* * @param listWorkerConfigurationsRequest * @return Result of the ListWorkerConfigurations operation returned by the service. * @throws NotFoundException * HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it. * @throws BadRequestException * HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it. * @throws ForbiddenException * HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request. * @throws ServiceUnavailableException * HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue. * @throws TooManyRequestsException * HTTP Status Code 429: Limit exceeded. Resource limit reached. * @throws UnauthorizedException * HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated. * @throws InternalServerErrorException * HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue. * @sample AWSKafkaConnect.ListWorkerConfigurations * @see AWS API Documentation */ ListWorkerConfigurationsResult listWorkerConfigurations(ListWorkerConfigurationsRequest listWorkerConfigurationsRequest); /** *

* Updates the specified connector. *

* * @param updateConnectorRequest * @return Result of the UpdateConnector operation returned by the service. * @throws NotFoundException * HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it. * @throws BadRequestException * HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it. * @throws ForbiddenException * HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request. * @throws ServiceUnavailableException * HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue. * @throws TooManyRequestsException * HTTP Status Code 429: Limit exceeded. Resource limit reached. * @throws UnauthorizedException * HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated. * @throws InternalServerErrorException * HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue. * @sample AWSKafkaConnect.UpdateConnector * @see AWS * API Documentation */ UpdateConnectorResult updateConnector(UpdateConnectorRequest updateConnectorRequest); /** * Shuts down this client object, releasing any resources that might be held open. This is an optional method, and * callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client * has been shutdown, it should not be used to make any more requests. */ void shutdown(); /** * Returns additional metadata for a previously executed successful request, typically used for debugging issues * where a service isn't acting as expected. This data isn't considered part of the result data returned by an * operation, so it's available through this separate, diagnostic interface. *

* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic * information for an executed request, you should use this method to retrieve it as soon as possible after * executing a request. * * @param request * The originally executed request. * * @return The response metadata for the specified request, or null if none is available. */ ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); }