com.amazonaws.services.kafkaconnect

Interface AWSKafkaConnect

All Known Subinterfaces:

AWSKafkaConnectAsync

All Known Implementing Classes:

AbstractAWSKafkaConnect, AbstractAWSKafkaConnectAsync, AWSKafkaConnectAsyncClient, AWSKafkaConnectClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSKafkaConnect

Interface for accessing Kafka Connect.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSKafkaConnect instead.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateConnectorResult	createConnector(CreateConnectorRequest createConnectorRequest) Creates a connector using the specified properties.
CreateCustomPluginResult	createCustomPlugin(CreateCustomPluginRequest createCustomPluginRequest) Creates a custom plugin using the specified properties.
CreateWorkerConfigurationResult	createWorkerConfiguration(CreateWorkerConfigurationRequest createWorkerConfigurationRequest) Creates a worker configuration using the specified properties.
DeleteConnectorResult	deleteConnector(DeleteConnectorRequest deleteConnectorRequest) Deletes the specified connector.
DeleteCustomPluginResult	deleteCustomPlugin(DeleteCustomPluginRequest deleteCustomPluginRequest) Deletes a custom plugin.
DescribeConnectorResult	describeConnector(DescribeConnectorRequest describeConnectorRequest) Returns summary information about the connector.
DescribeCustomPluginResult	describeCustomPlugin(DescribeCustomPluginRequest describeCustomPluginRequest) A summary description of the custom plugin.
DescribeWorkerConfigurationResult	describeWorkerConfiguration(DescribeWorkerConfigurationRequest describeWorkerConfigurationRequest) Returns information about a worker configuration.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
ListConnectorsResult	listConnectors(ListConnectorsRequest listConnectorsRequest) Returns a list of all the connectors in this account and Region.
ListCustomPluginsResult	listCustomPlugins(ListCustomPluginsRequest listCustomPluginsRequest) Returns a list of all of the custom plugins in this account and Region.
ListWorkerConfigurationsResult	listWorkerConfigurations(ListWorkerConfigurationsRequest listWorkerConfigurationsRequest) Returns a list of all of the worker configurations in this account and Region.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateConnectorResult	updateConnector(UpdateConnectorRequest updateConnectorRequest) Updates the specified connector.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

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 Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createConnector

CreateConnectorResult createConnector(CreateConnectorRequest createConnectorRequest)

Creates a connector using the specified properties.

Parameters:

createConnectorRequest -

Returns:

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.

ConflictException - HTTP Status Code 409: Conflict. A resource with this name already exists. Retry your request with another name.

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.

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.

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

See Also:

AWS API Documentation

createCustomPlugin

CreateCustomPluginResult createCustomPlugin(CreateCustomPluginRequest createCustomPluginRequest)

Creates a custom plugin using the specified properties.

Parameters:

createCustomPluginRequest -

Returns:

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.

ConflictException - HTTP Status Code 409: Conflict. A resource with this name already exists. Retry your request with another name.

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.

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.

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

See Also:

AWS API Documentation

createWorkerConfiguration

CreateWorkerConfigurationResult createWorkerConfiguration(CreateWorkerConfigurationRequest createWorkerConfigurationRequest)

Creates a worker configuration using the specified properties.

Parameters:

createWorkerConfigurationRequest -

Returns:

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.

ConflictException - HTTP Status Code 409: Conflict. A resource with this name already exists. Retry your request with another name.

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.

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.

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

See Also:

AWS API Documentation

deleteConnector

DeleteConnectorResult deleteConnector(DeleteConnectorRequest deleteConnectorRequest)

Deletes the specified connector.

Parameters:

deleteConnectorRequest -

Returns:

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.

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.

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.

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

See Also:

AWS API Documentation

deleteCustomPlugin

DeleteCustomPluginResult deleteCustomPlugin(DeleteCustomPluginRequest deleteCustomPluginRequest)

Deletes a custom plugin.

Parameters:

deleteCustomPluginRequest -

Returns:

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.

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.

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.

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

See Also:

AWS API Documentation

describeConnector

DescribeConnectorResult describeConnector(DescribeConnectorRequest describeConnectorRequest)

Returns summary information about the connector.

Parameters:

describeConnectorRequest -

Returns:

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.

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.

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.

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

See Also:

AWS API Documentation

describeCustomPlugin

DescribeCustomPluginResult describeCustomPlugin(DescribeCustomPluginRequest describeCustomPluginRequest)

A summary description of the custom plugin.

Parameters:

describeCustomPluginRequest -

Returns:

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.

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.

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.

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

See Also:

AWS API Documentation

describeWorkerConfiguration

DescribeWorkerConfigurationResult describeWorkerConfiguration(DescribeWorkerConfigurationRequest describeWorkerConfigurationRequest)

Returns information about a worker configuration.

Parameters:

describeWorkerConfigurationRequest -

Returns:

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.

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.

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.

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

See Also:

AWS API Documentation

listConnectors

ListConnectorsResult listConnectors(ListConnectorsRequest listConnectorsRequest)

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.

Parameters:

listConnectorsRequest -

Returns:

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.

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.

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.

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

See Also:

AWS API Documentation

listCustomPlugins

ListCustomPluginsResult listCustomPlugins(ListCustomPluginsRequest listCustomPluginsRequest)

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

Parameters:

listCustomPluginsRequest -

Returns:

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.

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.

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.

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

See Also:

AWS API Documentation

listWorkerConfigurations

ListWorkerConfigurationsResult listWorkerConfigurations(ListWorkerConfigurationsRequest listWorkerConfigurationsRequest)

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

Parameters:

listWorkerConfigurationsRequest -

Returns:

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.

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.

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.

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

See Also:

AWS API Documentation

updateConnector

UpdateConnectorResult updateConnector(UpdateConnectorRequest updateConnectorRequest)

Updates the specified connector.

Parameters:

updateConnectorRequest -

Returns:

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.

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.

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.

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

See Also:

AWS API Documentation

shutdown

void shutdown()

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.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

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.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.