com.amazonaws.services.kafka

Interface AWSKafka

All Known Subinterfaces:

AWSKafkaAsync

All Known Implementing Classes:

AbstractAWSKafka, AbstractAWSKafkaAsync, AWSKafkaAsyncClient, AWSKafkaClient

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

Interface for accessing Kafka.

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

The operations for managing an Amazon MSK cluster.

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
BatchAssociateScramSecretResult	batchAssociateScramSecret(BatchAssociateScramSecretRequest batchAssociateScramSecretRequest) Associates one or more Scram Secrets with an Amazon MSK cluster.
BatchDisassociateScramSecretResult	batchDisassociateScramSecret(BatchDisassociateScramSecretRequest batchDisassociateScramSecretRequest) Disassociates one or more Scram Secrets from an Amazon MSK cluster.
CreateClusterResult	createCluster(CreateClusterRequest createClusterRequest) Creates a new MSK cluster.
CreateClusterV2Result	createClusterV2(CreateClusterV2Request createClusterV2Request) Creates a new MSK cluster.
CreateConfigurationResult	createConfiguration(CreateConfigurationRequest createConfigurationRequest) Creates a new MSK configuration.
CreateReplicatorResult	createReplicator(CreateReplicatorRequest createReplicatorRequest) Creates the replicator.
CreateVpcConnectionResult	createVpcConnection(CreateVpcConnectionRequest createVpcConnectionRequest) Creates a new MSK VPC connection.
DeleteClusterResult	deleteCluster(DeleteClusterRequest deleteClusterRequest) Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.
DeleteClusterPolicyResult	deleteClusterPolicy(DeleteClusterPolicyRequest deleteClusterPolicyRequest) Deletes the MSK cluster policy specified by the Amazon Resource Name (ARN) in the request.
DeleteConfigurationResult	deleteConfiguration(DeleteConfigurationRequest deleteConfigurationRequest) Deletes an MSK Configuration.
DeleteReplicatorResult	deleteReplicator(DeleteReplicatorRequest deleteReplicatorRequest) Deletes a replicator.
DeleteVpcConnectionResult	deleteVpcConnection(DeleteVpcConnectionRequest deleteVpcConnectionRequest) Deletes a MSK VPC connection.
DescribeClusterResult	describeCluster(DescribeClusterRequest describeClusterRequest) Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
DescribeClusterOperationResult	describeClusterOperation(DescribeClusterOperationRequest describeClusterOperationRequest) Returns a description of the cluster operation specified by the ARN.
DescribeClusterOperationV2Result	describeClusterOperationV2(DescribeClusterOperationV2Request describeClusterOperationV2Request) Returns a description of the cluster operation specified by the ARN.
DescribeClusterV2Result	describeClusterV2(DescribeClusterV2Request describeClusterV2Request) Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
DescribeConfigurationResult	describeConfiguration(DescribeConfigurationRequest describeConfigurationRequest) Returns a description of this MSK configuration.
DescribeConfigurationRevisionResult	describeConfigurationRevision(DescribeConfigurationRevisionRequest describeConfigurationRevisionRequest) Returns a description of this revision of the configuration.
DescribeReplicatorResult	describeReplicator(DescribeReplicatorRequest describeReplicatorRequest) Describes a replicator.
DescribeVpcConnectionResult	describeVpcConnection(DescribeVpcConnectionRequest describeVpcConnectionRequest) Returns a description of this MSK VPC connection.
GetBootstrapBrokersResult	getBootstrapBrokers(GetBootstrapBrokersRequest getBootstrapBrokersRequest) 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.
GetClusterPolicyResult	getClusterPolicy(GetClusterPolicyRequest getClusterPolicyRequest) Get the MSK cluster policy specified by the Amazon Resource Name (ARN) in the request.
GetCompatibleKafkaVersionsResult	getCompatibleKafkaVersions(GetCompatibleKafkaVersionsRequest getCompatibleKafkaVersionsRequest) Gets the Apache Kafka versions to which you can update the MSK cluster.
ListClientVpcConnectionsResult	listClientVpcConnections(ListClientVpcConnectionsRequest listClientVpcConnectionsRequest) Returns a list of all the VPC connections in this Region.
ListClusterOperationsResult	listClusterOperations(ListClusterOperationsRequest listClusterOperationsRequest) Returns a list of all the operations that have been performed on the specified MSK cluster.
ListClusterOperationsV2Result	listClusterOperationsV2(ListClusterOperationsV2Request listClusterOperationsV2Request) Returns a list of all the operations that have been performed on the specified MSK cluster.
ListClustersResult	listClusters(ListClustersRequest listClustersRequest) Returns a list of all the MSK clusters in the current Region.
ListClustersV2Result	listClustersV2(ListClustersV2Request listClustersV2Request) Returns a list of all the MSK clusters in the current Region.
ListConfigurationRevisionsResult	listConfigurationRevisions(ListConfigurationRevisionsRequest listConfigurationRevisionsRequest) Returns a list of all the MSK configurations in this Region.
ListConfigurationsResult	listConfigurations(ListConfigurationsRequest listConfigurationsRequest) Returns a list of all the MSK configurations in this Region.
ListKafkaVersionsResult	listKafkaVersions(ListKafkaVersionsRequest listKafkaVersionsRequest) Returns a list of Apache Kafka versions.
ListNodesResult	listNodes(ListNodesRequest listNodesRequest) Returns a list of the broker nodes in the cluster.
ListReplicatorsResult	listReplicators(ListReplicatorsRequest listReplicatorsRequest) Lists the replicators.
ListScramSecretsResult	listScramSecrets(ListScramSecretsRequest listScramSecretsRequest) Returns a list of the Scram Secrets associated with an Amazon MSK cluster.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Returns a list of the tags associated with the specified resource.
ListVpcConnectionsResult	listVpcConnections(ListVpcConnectionsRequest listVpcConnectionsRequest) Returns a list of all the VPC connections in this Region.
PutClusterPolicyResult	putClusterPolicy(PutClusterPolicyRequest putClusterPolicyRequest) Creates or updates the MSK cluster policy specified by the cluster Amazon Resource Name (ARN) in the request.
RebootBrokerResult	rebootBroker(RebootBrokerRequest rebootBrokerRequest) Reboots brokers.
RejectClientVpcConnectionResult	rejectClientVpcConnection(RejectClientVpcConnectionRequest rejectClientVpcConnectionRequest) Returns empty response.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Adds tags to the specified MSK resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes the tags associated with the keys that are provided in the query.
UpdateBrokerCountResult	updateBrokerCount(UpdateBrokerCountRequest updateBrokerCountRequest) Updates the number of broker nodes in the cluster.
UpdateBrokerStorageResult	updateBrokerStorage(UpdateBrokerStorageRequest updateBrokerStorageRequest) Updates the EBS storage associated with MSK brokers.
UpdateBrokerTypeResult	updateBrokerType(UpdateBrokerTypeRequest updateBrokerTypeRequest) Updates EC2 instance type.
UpdateClusterConfigurationResult	updateClusterConfiguration(UpdateClusterConfigurationRequest updateClusterConfigurationRequest) Updates the cluster with the configuration that is specified in the request body.
UpdateClusterKafkaVersionResult	updateClusterKafkaVersion(UpdateClusterKafkaVersionRequest updateClusterKafkaVersionRequest) Updates the Apache Kafka version for the cluster.
UpdateConfigurationResult	updateConfiguration(UpdateConfigurationRequest updateConfigurationRequest) Updates an MSK configuration.
UpdateConnectivityResult	updateConnectivity(UpdateConnectivityRequest updateConnectivityRequest) Updates the cluster's connectivity configuration.
UpdateMonitoringResult	updateMonitoring(UpdateMonitoringRequest updateMonitoringRequest) Updates the monitoring settings for the cluster.
UpdateReplicationInfoResult	updateReplicationInfo(UpdateReplicationInfoRequest updateReplicationInfoRequest) Updates replication info of a replicator.
UpdateSecurityResult	updateSecurity(UpdateSecurityRequest updateSecurityRequest) Updates the security settings for the cluster.
UpdateStorageResult	updateStorage(UpdateStorageRequest updateStorageRequest) Updates cluster broker volume size (or) sets cluster storage mode to TIERED.

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

batchAssociateScramSecret

BatchAssociateScramSecretResult batchAssociateScramSecret(BatchAssociateScramSecretRequest batchAssociateScramSecretRequest)

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

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

BatchDisassociateScramSecretResult batchDisassociateScramSecret(BatchDisassociateScramSecretRequest batchDisassociateScramSecretRequest)

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

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

CreateClusterResult createCluster(CreateClusterRequest createClusterRequest)

Creates a new MSK cluster.

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

CreateClusterV2Result createClusterV2(CreateClusterV2Request createClusterV2Request)

Creates a new MSK cluster.

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

CreateConfigurationResult createConfiguration(CreateConfigurationRequest createConfigurationRequest)

Creates a new MSK configuration.

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

createReplicator

CreateReplicatorResult createReplicator(CreateReplicatorRequest createReplicatorRequest)

Creates the replicator.

Parameters:

createReplicatorRequest - Creates a replicator using the specified configuration.

Returns:

Result of the CreateReplicator operation returned by the service.

Throws:

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.

NotFoundException - HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.

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.

ConflictException - HTTP Status Code 409: Conflict. This replicator name already exists. Retry your request with another name.

See Also:

AWS API Documentation

createVpcConnection

CreateVpcConnectionResult createVpcConnection(CreateVpcConnectionRequest createVpcConnectionRequest)

Creates a new MSK VPC connection.

Parameters:

createVpcConnectionRequest -

Returns:

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

See Also:

AWS API Documentation

deleteCluster

DeleteClusterResult deleteCluster(DeleteClusterRequest deleteClusterRequest)

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

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

deleteClusterPolicy

DeleteClusterPolicyResult deleteClusterPolicy(DeleteClusterPolicyRequest deleteClusterPolicyRequest)

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

Parameters:

deleteClusterPolicyRequest -

Returns:

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

DeleteConfigurationResult deleteConfiguration(DeleteConfigurationRequest deleteConfigurationRequest)

Deletes an MSK Configuration.

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

deleteReplicator

DeleteReplicatorResult deleteReplicator(DeleteReplicatorRequest deleteReplicatorRequest)

Deletes a replicator.

Parameters:

deleteReplicatorRequest -

Returns:

Result of the DeleteReplicator operation returned by the service.

Throws:

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.

NotFoundException - HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.

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.

See Also:

AWS API Documentation

deleteVpcConnection

DeleteVpcConnectionResult deleteVpcConnection(DeleteVpcConnectionRequest deleteVpcConnectionRequest)

Deletes a MSK VPC connection.

Parameters:

deleteVpcConnectionRequest -

Returns:

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

DescribeClusterResult describeCluster(DescribeClusterRequest describeClusterRequest)

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

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

DescribeClusterOperationResult describeClusterOperation(DescribeClusterOperationRequest describeClusterOperationRequest)

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

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

describeClusterOperationV2

DescribeClusterOperationV2Result describeClusterOperationV2(DescribeClusterOperationV2Request describeClusterOperationV2Request)

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

Parameters:

describeClusterOperationV2Request -

Returns:

Result of the DescribeClusterOperationV2 operation returned by the service.

Throws:

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.

NotFoundException -

HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.

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.

See Also:

AWS API Documentation

describeClusterV2

DescribeClusterV2Result describeClusterV2(DescribeClusterV2Request describeClusterV2Request)

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

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

DescribeConfigurationResult describeConfiguration(DescribeConfigurationRequest describeConfigurationRequest)

Returns a description of this MSK configuration.

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

DescribeConfigurationRevisionResult describeConfigurationRevision(DescribeConfigurationRevisionRequest describeConfigurationRevisionRequest)

Returns a description of this revision of the configuration.

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

describeReplicator

DescribeReplicatorResult describeReplicator(DescribeReplicatorRequest describeReplicatorRequest)

Describes a replicator.

Parameters:

describeReplicatorRequest -

Returns:

Result of the DescribeReplicator operation returned by the service.

Throws:

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.

NotFoundException - HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.

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.

See Also:

AWS API Documentation

describeVpcConnection

DescribeVpcConnectionResult describeVpcConnection(DescribeVpcConnectionRequest describeVpcConnectionRequest)

Returns a description of this MSK VPC connection.

Parameters:

describeVpcConnectionRequest -

Returns:

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

GetBootstrapBrokersResult getBootstrapBrokers(GetBootstrapBrokersRequest getBootstrapBrokersRequest)

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

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

getClusterPolicy

GetClusterPolicyResult getClusterPolicy(GetClusterPolicyRequest getClusterPolicyRequest)

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

Parameters:

getClusterPolicyRequest -

Returns:

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

getCompatibleKafkaVersions

GetCompatibleKafkaVersionsResult getCompatibleKafkaVersions(GetCompatibleKafkaVersionsRequest getCompatibleKafkaVersionsRequest)

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

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

listClientVpcConnections

ListClientVpcConnectionsResult listClientVpcConnections(ListClientVpcConnectionsRequest listClientVpcConnectionsRequest)

Returns a list of all the VPC connections in this Region.

Parameters:

listClientVpcConnectionsRequest -

Returns:

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

listClusterOperations

ListClusterOperationsResult listClusterOperations(ListClusterOperationsRequest listClusterOperationsRequest)

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

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

listClusterOperationsV2

ListClusterOperationsV2Result listClusterOperationsV2(ListClusterOperationsV2Request listClusterOperationsV2Request)

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

Parameters:

listClusterOperationsV2Request -

Returns:

Result of the ListClusterOperationsV2 operation returned by the service.

Throws:

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.

NotFoundException -

HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.

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.

See Also:

AWS API Documentation

listClusters

ListClustersResult listClusters(ListClustersRequest listClustersRequest)

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

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

ListClustersV2Result listClustersV2(ListClustersV2Request listClustersV2Request)

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

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

ListConfigurationRevisionsResult listConfigurationRevisions(ListConfigurationRevisionsRequest listConfigurationRevisionsRequest)

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

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

ListConfigurationsResult listConfigurations(ListConfigurationsRequest listConfigurationsRequest)

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

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

ListKafkaVersionsResult listKafkaVersions(ListKafkaVersionsRequest listKafkaVersionsRequest)

Returns a list of Apache Kafka versions.

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

ListNodesResult listNodes(ListNodesRequest listNodesRequest)

Returns a list of the broker nodes in the cluster.

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

listReplicators

ListReplicatorsResult listReplicators(ListReplicatorsRequest listReplicatorsRequest)

Lists the replicators.

Parameters:

listReplicatorsRequest -

Returns:

Result of the ListReplicators operation returned by the service.

Throws:

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.

NotFoundException - HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.

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.

See Also:

AWS API Documentation

listScramSecrets

ListScramSecretsResult listScramSecrets(ListScramSecretsRequest listScramSecretsRequest)

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

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

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

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

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

listVpcConnections

ListVpcConnectionsResult listVpcConnections(ListVpcConnectionsRequest listVpcConnectionsRequest)

Returns a list of all the VPC connections in this Region.

Parameters:

listVpcConnectionsRequest -

Returns:

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

putClusterPolicy

PutClusterPolicyResult putClusterPolicy(PutClusterPolicyRequest putClusterPolicyRequest)

Creates or updates the MSK cluster policy specified by the cluster Amazon Resource Name (ARN) in the request.

Parameters:

putClusterPolicyRequest -

Returns:

Result of the PutClusterPolicy 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.

ForbiddenException -

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

See Also:

AWS API Documentation

rebootBroker

RebootBrokerResult rebootBroker(RebootBrokerRequest rebootBrokerRequest)

Reboots brokers.

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

rejectClientVpcConnection

RejectClientVpcConnectionResult rejectClientVpcConnection(RejectClientVpcConnectionRequest rejectClientVpcConnectionRequest)

Returns empty response.

Parameters:

rejectClientVpcConnectionRequest -

Returns:

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

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Adds tags to the specified MSK resource.

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

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

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

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

UpdateBrokerCountResult updateBrokerCount(UpdateBrokerCountRequest updateBrokerCountRequest)

Updates the number of broker nodes in the cluster.

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

UpdateBrokerStorageResult updateBrokerStorage(UpdateBrokerStorageRequest updateBrokerStorageRequest)

Updates the EBS storage associated with MSK brokers.

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

UpdateBrokerTypeResult updateBrokerType(UpdateBrokerTypeRequest updateBrokerTypeRequest)

Updates EC2 instance type.

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

UpdateClusterConfigurationResult updateClusterConfiguration(UpdateClusterConfigurationRequest updateClusterConfigurationRequest)

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

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

UpdateClusterKafkaVersionResult updateClusterKafkaVersion(UpdateClusterKafkaVersionRequest updateClusterKafkaVersionRequest)

Updates the Apache Kafka version for the cluster.

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

UpdateConfigurationResult updateConfiguration(UpdateConfigurationRequest updateConfigurationRequest)

Updates an MSK configuration.

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

UpdateConnectivityResult updateConnectivity(UpdateConnectivityRequest updateConnectivityRequest)

Updates the cluster's connectivity configuration.

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

UpdateMonitoringResult updateMonitoring(UpdateMonitoringRequest updateMonitoringRequest)

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.

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

updateReplicationInfo

UpdateReplicationInfoResult updateReplicationInfo(UpdateReplicationInfoRequest updateReplicationInfoRequest)

Updates replication info of a replicator.

Parameters:

updateReplicationInfoRequest - Update information relating to replication between a given source and target Kafka cluster.

Returns:

Result of the UpdateReplicationInfo operation returned by the service.

Throws:

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.

NotFoundException - HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.

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.

See Also:

AWS API Documentation

updateSecurity

UpdateSecurityResult updateSecurity(UpdateSecurityRequest updateSecurityRequest)

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

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

updateStorage

UpdateStorageResult updateStorage(UpdateStorageRequest updateStorageRequest)

Updates cluster broker volume size (or) sets cluster storage mode to TIERED.

Parameters:

updateStorageRequest -

Request object for UpdateStorage api. Its used to update the storage attributes for the cluster.

Returns:

Result of the UpdateStorage operation returned by the service.

Throws:

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.

NotFoundException - HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.

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.

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.