com.amazonaws.services.kafka

Class AWSKafkaClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.kafka.AWSKafkaClient

All Implemented Interfaces:

AWSKafka

Direct Known Subclasses:

AWSKafkaAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSKafkaClient
extends AmazonWebServiceClient
implements AWSKafka

Client for accessing Kafka. All service calls made using this client are blocking, and will not return until the service call completes.

The operations for managing an Amazon MSK cluster.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.kafka.AWSKafka

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSKafkaClientBuilder	builder()
CreateClusterResult	createCluster(CreateClusterRequest request) Creates a new MSK cluster.
CreateConfigurationResult	createConfiguration(CreateConfigurationRequest request) Creates a new MSK configuration.
DeleteClusterResult	deleteCluster(DeleteClusterRequest request) Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.
DescribeClusterResult	describeCluster(DescribeClusterRequest request) Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
DescribeClusterOperationResult	describeClusterOperation(DescribeClusterOperationRequest request) Returns a description of the cluster operation specified by the ARN.
DescribeConfigurationResult	describeConfiguration(DescribeConfigurationRequest request) Returns a description of this MSK configuration.
DescribeConfigurationRevisionResult	describeConfigurationRevision(DescribeConfigurationRevisionRequest request) Returns a description of this revision of the configuration.
GetBootstrapBrokersResult	getBootstrapBrokers(GetBootstrapBrokersRequest request) A list of brokers that a client application can use to bootstrap.
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.
GetCompatibleKafkaVersionsResult	getCompatibleKafkaVersions(GetCompatibleKafkaVersionsRequest request) Gets the Apache Kafka versions to which you can update the MSK cluster.
ListClusterOperationsResult	listClusterOperations(ListClusterOperationsRequest request) Returns a list of all the operations that have been performed on the specified MSK cluster.
ListClustersResult	listClusters(ListClustersRequest request) Returns a list of all the MSK clusters in the current Region.
ListConfigurationRevisionsResult	listConfigurationRevisions(ListConfigurationRevisionsRequest request) Returns a list of all the MSK configurations in this Region.
ListConfigurationsResult	listConfigurations(ListConfigurationsRequest request) Returns a list of all the MSK configurations in this Region.
ListKafkaVersionsResult	listKafkaVersions(ListKafkaVersionsRequest request) Returns a list of Kafka versions.
ListNodesResult	listNodes(ListNodesRequest request) Returns a list of the broker nodes in the cluster.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Returns a list of the tags associated with the specified resource.
TagResourceResult	tagResource(TagResourceRequest request) Adds tags to the specified MSK resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes the tags associated with the keys that are provided in the query.
UpdateBrokerCountResult	updateBrokerCount(UpdateBrokerCountRequest request) Updates the number of broker nodes in the cluster.
UpdateBrokerStorageResult	updateBrokerStorage(UpdateBrokerStorageRequest request) Updates the EBS storage associated with MSK brokers.
UpdateClusterConfigurationResult	updateClusterConfiguration(UpdateClusterConfigurationRequest request) Updates the cluster with the configuration that is specified in the request body.
UpdateClusterKafkaVersionResult	updateClusterKafkaVersion(UpdateClusterKafkaVersionRequest request) Updates the Apache Kafka version for the cluster.
UpdateMonitoringResult	updateMonitoring(UpdateMonitoringRequest request) Updates the monitoring settings for the cluster.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.kafka.AWSKafka

shutdown

Method Detail

builder

public static AWSKafkaClientBuilder builder()

createCluster

public CreateClusterResult createCluster(CreateClusterRequest request)

Creates a new MSK cluster.

Specified by:

createCluster in interface AWSKafka

Parameters:

createClusterRequest -

Returns:

Result of the CreateCluster operation returned by the service.

Throws:

BadRequestException -

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

InternalServerErrorException -

There was an unexpected internal server error. Retrying your request might resolve the issue.

UnauthorizedException -

The request is not authorized. The provided credentials couldn't be validated.

ForbiddenException -

Access forbidden. Check your credentials and then retry your request.

ServiceUnavailableException -

503 response

TooManyRequestsException -

429 response

ConflictException -

This cluster name already exists. Retry your request using another name.

See Also:

AWS API Documentation

createConfiguration

public CreateConfigurationResult createConfiguration(CreateConfigurationRequest request)

Creates a new MSK configuration.

Specified by:

createConfiguration in interface AWSKafka

Parameters:

createConfigurationRequest -

Returns:

Result of the CreateConfiguration operation returned by the service.

Throws:

BadRequestException -

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

InternalServerErrorException -

There was an unexpected internal server error. Retrying your request might resolve the issue.

UnauthorizedException -

The request is not authorized. The provided credentials couldn't be validated.

ForbiddenException -

Access forbidden. Check your credentials and then retry your request.

ServiceUnavailableException -

503 response

TooManyRequestsException -

429 response

ConflictException -

This cluster name already exists. Retry your request using another name.

See Also:

AWS API Documentation

deleteCluster

public DeleteClusterResult deleteCluster(DeleteClusterRequest request)

Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.

Specified by:

deleteCluster in interface AWSKafka

Parameters:

deleteClusterRequest -

Returns:

Result of the DeleteCluster operation returned by the service.

Throws:

NotFoundException -

The resource could not be found due to incorrect input. Correct the input, then retry the request.

BadRequestException -

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

InternalServerErrorException -

There was an unexpected internal server error. Retrying your request might resolve the issue.

ForbiddenException -

Access forbidden. Check your credentials and then retry your request.

See Also:

AWS API Documentation

describeCluster

public DescribeClusterResult describeCluster(DescribeClusterRequest request)

Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.

Specified by:

describeCluster in interface AWSKafka

Parameters:

describeClusterRequest -

Returns:

Result of the DescribeCluster operation returned by the service.

Throws:

NotFoundException -

The resource could not be found due to incorrect input. Correct the input, then retry the request.

BadRequestException -

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

UnauthorizedException -

The request is not authorized. The provided credentials couldn't be validated.

InternalServerErrorException -

There was an unexpected internal server error. Retrying your request might resolve the issue.

ForbiddenException -

Access forbidden. Check your credentials and then retry your request.

See Also:

AWS API Documentation

describeClusterOperation

public DescribeClusterOperationResult describeClusterOperation(DescribeClusterOperationRequest request)

Returns a description of the cluster operation specified by the ARN.

Specified by:

describeClusterOperation in interface AWSKafka

Parameters:

describeClusterOperationRequest -

Returns:

Result of the DescribeClusterOperation operation returned by the service.

Throws:

NotFoundException -

The resource could not be found due to incorrect input. Correct the input, then retry the request.

BadRequestException -

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

UnauthorizedException -

The request is not authorized. The provided credentials couldn't be validated.

InternalServerErrorException -

There was an unexpected internal server error. Retrying your request might resolve the issue.

ForbiddenException -

Access forbidden. Check your credentials and then retry your request.

See Also:

AWS API Documentation

describeConfiguration

public DescribeConfigurationResult describeConfiguration(DescribeConfigurationRequest request)

Returns a description of this MSK configuration.

Specified by:

describeConfiguration in interface AWSKafka

Parameters:

describeConfigurationRequest -

Returns:

Result of the DescribeConfiguration operation returned by the service.

Throws:

BadRequestException -

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

UnauthorizedException -

The request is not authorized. The provided credentials couldn't be validated.

InternalServerErrorException -

There was an unexpected internal server error. Retrying your request might resolve the issue.

ForbiddenException -

Access forbidden. Check your credentials and then retry your request.

NotFoundException -

The resource could not be found due to incorrect input. Correct the input, then retry the request.

ServiceUnavailableException -

503 response

See Also:

AWS API Documentation

describeConfigurationRevision

public DescribeConfigurationRevisionResult describeConfigurationRevision(DescribeConfigurationRevisionRequest request)

Returns a description of this revision of the configuration.

Specified by:

describeConfigurationRevision in interface AWSKafka

Parameters:

describeConfigurationRevisionRequest -

Returns:

Result of the DescribeConfigurationRevision operation returned by the service.

Throws:

BadRequestException -

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

UnauthorizedException -

The request is not authorized. The provided credentials couldn't be validated.

InternalServerErrorException -

There was an unexpected internal server error. Retrying your request might resolve the issue.

ForbiddenException -

Access forbidden. Check your credentials and then retry your request.

NotFoundException -

The resource could not be found due to incorrect input. Correct the input, then retry the request.

ServiceUnavailableException -

503 response

See Also:

AWS API Documentation

getBootstrapBrokers

public GetBootstrapBrokersResult getBootstrapBrokers(GetBootstrapBrokersRequest request)

A list of brokers that a client application can use to bootstrap.

Specified by:

getBootstrapBrokers in interface AWSKafka

Parameters:

getBootstrapBrokersRequest -

Returns:

Result of the GetBootstrapBrokers operation returned by the service.

Throws:

BadRequestException -

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

UnauthorizedException -

The request is not authorized. The provided credentials couldn't be validated.

InternalServerErrorException -

There was an unexpected internal server error. Retrying your request might resolve the issue.

ConflictException -

This cluster name already exists. Retry your request using another name.

ForbiddenException -

Access forbidden. Check your credentials and then retry your request.

See Also:

AWS API Documentation

getCompatibleKafkaVersions

public GetCompatibleKafkaVersionsResult getCompatibleKafkaVersions(GetCompatibleKafkaVersionsRequest request)

Gets the Apache Kafka versions to which you can update the MSK cluster.

Specified by:

getCompatibleKafkaVersions in interface AWSKafka

Parameters:

getCompatibleKafkaVersionsRequest -

Returns:

Result of the GetCompatibleKafkaVersions operation returned by the service.

Throws:

BadRequestException - n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

n

UnauthorizedException - n

The request is not authorized. The provided credentials couldn't be validated.

n

InternalServerErrorException - n

There was an unexpected internal server error. Retrying your request might resolve the issue.

n

ForbiddenException - n

Access forbidden. Check your credentials and then retry your request.

n

NotFoundException - n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

n

ServiceUnavailableException - n

503 response

n

TooManyRequestsException - n

429 response

n

See Also:

AWS API Documentation

listClusterOperations

public ListClusterOperationsResult listClusterOperations(ListClusterOperationsRequest request)

Returns a list of all the operations that have been performed on the specified MSK cluster.

Specified by:

listClusterOperations in interface AWSKafka

Parameters:

listClusterOperationsRequest -

Returns:

Result of the ListClusterOperations operation returned by the service.

Throws:

BadRequestException -

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

InternalServerErrorException -

There was an unexpected internal server error. Retrying your request might resolve the issue.

UnauthorizedException -

The request is not authorized. The provided credentials couldn't be validated.

ForbiddenException -

Access forbidden. Check your credentials and then retry your request.

See Also:

AWS API Documentation

listClusters

public ListClustersResult listClusters(ListClustersRequest request)

Returns a list of all the MSK clusters in the current Region.

Specified by:

listClusters in interface AWSKafka

Parameters:

listClustersRequest -

Returns:

Result of the ListClusters operation returned by the service.

Throws:

BadRequestException -

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

InternalServerErrorException -

There was an unexpected internal server error. Retrying your request might resolve the issue.

UnauthorizedException -

The request is not authorized. The provided credentials couldn't be validated.

ForbiddenException -

Access forbidden. Check your credentials and then retry your request.

See Also:

AWS API Documentation

listConfigurationRevisions

public ListConfigurationRevisionsResult listConfigurationRevisions(ListConfigurationRevisionsRequest request)

Returns a list of all the MSK configurations in this Region.

Specified by:

listConfigurationRevisions in interface AWSKafka

Parameters:

listConfigurationRevisionsRequest -

Returns:

Result of the ListConfigurationRevisions operation returned by the service.

Throws:

BadRequestException -

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

UnauthorizedException -

The request is not authorized. The provided credentials couldn't be validated.

InternalServerErrorException -

There was an unexpected internal server error. Retrying your request might resolve the issue.

ForbiddenException -

Access forbidden. Check your credentials and then retry your request.

NotFoundException -

The resource could not be found due to incorrect input. Correct the input, then retry the request.

ServiceUnavailableException -

503 response

See Also:

AWS API Documentation

listConfigurations

public ListConfigurationsResult listConfigurations(ListConfigurationsRequest request)

Returns a list of all the MSK configurations in this Region.

Specified by:

listConfigurations in interface AWSKafka

Parameters:

listConfigurationsRequest -

Returns:

Result of the ListConfigurations operation returned by the service.

Throws:

ServiceUnavailableException -

503 response

BadRequestException -

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

UnauthorizedException -

The request is not authorized. The provided credentials couldn't be validated.

InternalServerErrorException -

There was an unexpected internal server error. Retrying your request might resolve the issue.

ForbiddenException -

Access forbidden. Check your credentials and then retry your request.

See Also:

AWS API Documentation

listKafkaVersions

public ListKafkaVersionsResult listKafkaVersions(ListKafkaVersionsRequest request)

Returns a list of Kafka versions.

Specified by:

listKafkaVersions in interface AWSKafka

Parameters:

listKafkaVersionsRequest -

Returns:

Result of the ListKafkaVersions operation returned by the service.

Throws:

BadRequestException -

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

UnauthorizedException -

The request is not authorized. The provided credentials couldn't be validated.

InternalServerErrorException -

There was an unexpected internal server error. Retrying your request might resolve the issue.

ForbiddenException -

Access forbidden. Check your credentials and then retry your request.

See Also:

AWS API Documentation

listNodes

public ListNodesResult listNodes(ListNodesRequest request)

Returns a list of the broker nodes in the cluster.

Specified by:

listNodes in interface AWSKafka

Parameters:

listNodesRequest -

Returns:

Result of the ListNodes operation returned by the service.

Throws:

NotFoundException -

The resource could not be found due to incorrect input. Correct the input, then retry the request.

BadRequestException -

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

InternalServerErrorException -

There was an unexpected internal server error. Retrying your request might resolve the issue.

ForbiddenException -

Access forbidden. Check your credentials and then retry your request.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Returns a list of the tags associated with the specified resource.

Specified by:

listTagsForResource in interface AWSKafka

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

NotFoundException -

The resource could not be found due to incorrect input. Correct the input, then retry the request.

BadRequestException -

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

InternalServerErrorException -

There was an unexpected internal server error. Retrying your request might resolve the issue.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Adds tags to the specified MSK resource.

Specified by:

tagResource in interface AWSKafka

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

NotFoundException -

The resource could not be found due to incorrect input. Correct the input, then retry the request.

BadRequestException -

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

InternalServerErrorException -

There was an unexpected internal server error. Retrying your request might resolve the issue.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes the tags associated with the keys that are provided in the query.

Specified by:

untagResource in interface AWSKafka

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

NotFoundException -

The resource could not be found due to incorrect input. Correct the input, then retry the request.

BadRequestException -

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

InternalServerErrorException -

There was an unexpected internal server error. Retrying your request might resolve the issue.

See Also:

AWS API Documentation

updateBrokerCount

public UpdateBrokerCountResult updateBrokerCount(UpdateBrokerCountRequest request)

Updates the number of broker nodes in the cluster.

Specified by:

updateBrokerCount in interface AWSKafka

Parameters:

updateBrokerCountRequest -

Returns:

Result of the UpdateBrokerCount operation returned by the service.

Throws:

ServiceUnavailableException -

503 response

BadRequestException -

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

UnauthorizedException -

The request is not authorized. The provided credentials couldn't be validated.

InternalServerErrorException -

There was an unexpected internal server error. Retrying your request might resolve the issue.

ForbiddenException -

Access forbidden. Check your credentials and then retry your request.

See Also:

AWS API Documentation

updateBrokerStorage

public UpdateBrokerStorageResult updateBrokerStorage(UpdateBrokerStorageRequest request)

Updates the EBS storage associated with MSK brokers.

Specified by:

updateBrokerStorage in interface AWSKafka

Parameters:

updateBrokerStorageRequest -

Returns:

Result of the UpdateBrokerStorage operation returned by the service.

Throws:

ServiceUnavailableException -

503 response

BadRequestException -

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

UnauthorizedException -

The request is not authorized. The provided credentials couldn't be validated.

InternalServerErrorException -

There was an unexpected internal server error. Retrying your request might resolve the issue.

ForbiddenException -

Access forbidden. Check your credentials and then retry your request.

See Also:

AWS API Documentation

updateClusterConfiguration

public UpdateClusterConfigurationResult updateClusterConfiguration(UpdateClusterConfigurationRequest request)

Updates the cluster with the configuration that is specified in the request body.

Specified by:

updateClusterConfiguration in interface AWSKafka

Parameters:

updateClusterConfigurationRequest -

Returns:

Result of the UpdateClusterConfiguration operation returned by the service.

Throws:

BadRequestException -

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

UnauthorizedException -

The request is not authorized. The provided credentials couldn't be validated.

InternalServerErrorException -

There was an unexpected internal server error. Retrying your request might resolve the issue.

ForbiddenException -

Access forbidden. Check your credentials and then retry your request.

NotFoundException -

The resource could not be found due to incorrect input. Correct the input, then retry the request.

ServiceUnavailableException -

503 response

See Also:

AWS API Documentation

updateClusterKafkaVersion

public UpdateClusterKafkaVersionResult updateClusterKafkaVersion(UpdateClusterKafkaVersionRequest request)

Updates the Apache Kafka version for the cluster.

Specified by:

updateClusterKafkaVersion in interface AWSKafka

Parameters:

updateClusterKafkaVersionRequest -

Returns:

Result of the UpdateClusterKafkaVersion operation returned by the service.

Throws:

BadRequestException -

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

UnauthorizedException -

The request is not authorized. The provided credentials couldn't be validated.

InternalServerErrorException -

There was an unexpected internal server error. Retrying your request might resolve the issue.

ForbiddenException -

Access forbidden. Check your credentials and then retry your request.

NotFoundException -

The resource could not be found due to incorrect input. Correct the input, then retry the request.

ServiceUnavailableException -

503 response

TooManyRequestsException -

429 response

See Also:

AWS API Documentation

updateMonitoring

public UpdateMonitoringResult updateMonitoring(UpdateMonitoringRequest request)

Updates the monitoring settings for the cluster. You can use this operation to specify which Apache Kafka metrics you want Amazon MSK to send to Amazon CloudWatch. You can also specify settings for open monitoring with Prometheus.

Specified by:

updateMonitoring in interface AWSKafka

Parameters:

updateMonitoringRequest - Request body for UpdateMonitoring.

Returns:

Result of the UpdateMonitoring operation returned by the service.

Throws:

ServiceUnavailableException -

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

BadRequestException -

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

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.

ForbiddenException -

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

See Also:

AWS API Documentation

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSKafka

Parameters:

request - The originally executed request

Returns:

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