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.
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.
ListClustersResult	listClusters(ListClustersRequest request) Returns a list of clusters in an account.
ListConfigurationsResult	listConfigurations(ListConfigurationsRequest request) Returns a list of all the MSK configurations in this Region for this account.
ListNodesResult	listNodes(ListNodesRequest request) Returns a list of the broker nodes in the cluster.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Returns a list of tags attached to a resource.
TagResourceResult	tagResource(TagResourceRequest request) Tag a resource with given tags.
UntagResourceResult	untagResource(UntagResourceRequest request) Remove tags of a resource by given tag keys.

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 - Bad request due to incorrect input. Correct your request and then retry it.

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 - Because of incorrect input, the request isn't valid. Correct the input, then retry the request.

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 configuration 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 your request and then retry it.

BadRequestException - Bad request due to incorrect input. Correct your request and then retry it.

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 your request and then retry it.

BadRequestException - Bad request due to incorrect input. Correct your request and then retry it.

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 - Because of incorrect input, the request isn't valid. Correct the input, then retry the request.

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 - Because of incorrect input, the request isn't valid. Correct the input, then retry the request.

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 - Bad request due to incorrect input. Correct your request and then retry it.

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

listClusters

public ListClustersResult listClusters(ListClustersRequest request)

Returns a list of clusters in an account.

Specified by:

listClusters in interface AWSKafka

Parameters:

listClustersRequest -

Returns:

Result of the ListClusters operation returned by the service.

Throws:

BadRequestException - Bad request due to incorrect input. Correct your request and then retry it.

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

listConfigurations

public ListConfigurationsResult listConfigurations(ListConfigurationsRequest request)

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

Specified by:

listConfigurations in interface AWSKafka

Parameters:

listConfigurationsRequest -

Returns:

Result of the ListConfigurations operation returned by the service.

Throws:

ServiceUnavailableException - 503 response

BadRequestException - Because of incorrect input, the request isn't valid. Correct the input, then retry the request.

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 your request and then retry it.

BadRequestException - Bad request due to incorrect input. Correct your request and then retry it.

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 tags attached to a 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 your request and then retry it.

BadRequestException - Bad request due to incorrect input. Correct your request and then retry it.

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)

Tag a resource with given tags.

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 your request and then retry it.

BadRequestException - Bad request due to incorrect input. Correct your request and then retry it.

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)

Remove tags of a resource by given tag keys.

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 your request and then retry it.

BadRequestException - Bad request due to incorrect input. Correct your request and then retry it.

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

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.