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
BatchAssociateScramSecretResult	batchAssociateScramSecret(BatchAssociateScramSecretRequest request) Associates one or more Scram Secrets with an Amazon MSK cluster.
BatchDisassociateScramSecretResult	batchDisassociateScramSecret(BatchDisassociateScramSecretRequest request) Disassociates one or more Scram Secrets from an Amazon MSK cluster.
static AWSKafkaClientBuilder	builder()
CreateClusterResult	createCluster(CreateClusterRequest request) Creates a new MSK cluster.
CreateClusterV2Result	createClusterV2(CreateClusterV2Request 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.
DeleteConfigurationResult	deleteConfiguration(DeleteConfigurationRequest request) Deletes an MSK Configuration.
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.
DescribeClusterV2Result	describeClusterV2(DescribeClusterV2Request 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.
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.
ListClustersV2Result	listClustersV2(ListClustersV2Request 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 Apache Kafka versions.
ListNodesResult	listNodes(ListNodesRequest request) Returns a list of the broker nodes in the cluster.
ListScramSecretsResult	listScramSecrets(ListScramSecretsRequest request) Returns a list of the Scram Secrets associated with an Amazon MSK cluster.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Returns a list of the tags associated with the specified resource.
RebootBrokerResult	rebootBroker(RebootBrokerRequest request) Reboots brokers.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
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.
UpdateBrokerTypeResult	updateBrokerType(UpdateBrokerTypeRequest request) Updates EC2 instance type.
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.
UpdateConfigurationResult	updateConfiguration(UpdateConfigurationRequest request) Updates an MSK configuration.
UpdateConnectivityResult	updateConnectivity(UpdateConnectivityRequest request) Updates the cluster's connectivity configuration.
UpdateMonitoringResult	updateMonitoring(UpdateMonitoringRequest request) Updates the monitoring settings for the cluster.
UpdateSecurityResult	updateSecurity(UpdateSecurityRequest request) Updates the security 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, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static AWSKafkaClientBuilder builder()

batchAssociateScramSecret

public BatchAssociateScramSecretResult batchAssociateScramSecret(BatchAssociateScramSecretRequest request)

Associates one or more Scram Secrets with an Amazon MSK cluster.

Specified by:

batchAssociateScramSecret in interface AWSKafka

Parameters:

batchAssociateScramSecretRequest -

Associates sasl scram secrets to cluster.

Returns:

Result of the BatchAssociateScramSecret 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

batchDisassociateScramSecret

public BatchDisassociateScramSecretResult batchDisassociateScramSecret(BatchDisassociateScramSecretRequest request)

Disassociates one or more Scram Secrets from an Amazon MSK cluster.

Specified by:

batchDisassociateScramSecret in interface AWSKafka

Parameters:

batchDisassociateScramSecretRequest -

Disassociates sasl scram secrets to cluster.

Returns:

Result of the BatchDisassociateScramSecret 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

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

createClusterV2

public CreateClusterV2Result createClusterV2(CreateClusterV2Request request)

Creates a new MSK cluster.

Specified by:

createClusterV2 in interface AWSKafka

Parameters:

createClusterV2Request -

Returns:

Result of the CreateClusterV2 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

deleteConfiguration

public DeleteConfigurationResult deleteConfiguration(DeleteConfigurationRequest request)

Deletes an MSK Configuration.

Specified by:

deleteConfiguration in interface AWSKafka

Parameters:

deleteConfigurationRequest -

Returns:

Result of the DeleteConfiguration 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

describeClusterV2

public DescribeClusterV2Result describeClusterV2(DescribeClusterV2Request request)

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

Specified by:

describeClusterV2 in interface AWSKafka

Parameters:

describeClusterV2Request -

Returns:

Result of the DescribeClusterV2 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

listClustersV2

public ListClustersV2Result listClustersV2(ListClustersV2Request request)

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

Specified by:

listClustersV2 in interface AWSKafka

Parameters:

listClustersV2Request -

Returns:

Result of the ListClustersV2 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 Apache 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

listScramSecrets

public ListScramSecretsResult listScramSecrets(ListScramSecretsRequest request)

Returns a list of the Scram Secrets associated with an Amazon MSK cluster.

Specified by:

listScramSecrets in interface AWSKafka

Parameters:

listScramSecretsRequest -

Returns:

Result of the ListScramSecrets 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

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

rebootBroker

public RebootBrokerResult rebootBroker(RebootBrokerRequest request)

Reboots brokers.

Specified by:

rebootBroker in interface AWSKafka

Parameters:

rebootBrokerRequest - Reboots a node.

Returns:

Result of the RebootBroker 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

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

updateBrokerType

public UpdateBrokerTypeResult updateBrokerType(UpdateBrokerTypeRequest request)

Updates EC2 instance type.

Specified by:

updateBrokerType in interface AWSKafka

Parameters:

updateBrokerTypeRequest -

Returns:

Result of the UpdateBrokerType 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

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

updateConfiguration

public UpdateConfigurationResult updateConfiguration(UpdateConfigurationRequest request)

Updates an MSK configuration.

Specified by:

updateConfiguration in interface AWSKafka

Parameters:

updateConfigurationRequest -

Returns:

Result of the UpdateConfiguration 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

updateConnectivity

public UpdateConnectivityResult updateConnectivity(UpdateConnectivityRequest request)

Updates the cluster's connectivity configuration.

Specified by:

updateConnectivity in interface AWSKafka

Parameters:

updateConnectivityRequest - Request body for UpdateConnectivity.

Returns:

Result of the UpdateConnectivity 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

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 -

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

updateSecurity

public UpdateSecurityResult updateSecurity(UpdateSecurityRequest request)

Updates the security settings for the cluster. You can use this operation to specify encryption and authentication on existing clusters.

Specified by:

updateSecurity in interface AWSKafka

Parameters:

updateSecurityRequest -

Returns:

Result of the UpdateSecurity 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 -

The service cannot complete the request.

TooManyRequestsException -

The request throughput limit was exceeded.

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.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSKafka

Overrides:

shutdown in class AmazonWebServiceClient