Package software.amazon.awssdk.services.kafka

Interface KafkaClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface KafkaClient
extends AwsClient

Service client for accessing Kafka. This can be created using the static builder() method.

The operations for managing an Amazon MSK cluster.

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default BatchAssociateScramSecretResponse	batchAssociateScramSecret(Consumer<BatchAssociateScramSecretRequest.Builder> batchAssociateScramSecretRequest)	Associates one or more Scram Secrets with an Amazon MSK cluster.
default BatchAssociateScramSecretResponse	batchAssociateScramSecret(BatchAssociateScramSecretRequest batchAssociateScramSecretRequest)	Associates one or more Scram Secrets with an Amazon MSK cluster.
default BatchDisassociateScramSecretResponse	batchDisassociateScramSecret(Consumer<BatchDisassociateScramSecretRequest.Builder> batchDisassociateScramSecretRequest)	Disassociates one or more Scram Secrets from an Amazon MSK cluster.
default BatchDisassociateScramSecretResponse	batchDisassociateScramSecret(BatchDisassociateScramSecretRequest batchDisassociateScramSecretRequest)	Disassociates one or more Scram Secrets from an Amazon MSK cluster.
static KafkaClientBuilder	builder()	Create a builder that can be used to configure and create a KafkaClient.
static KafkaClient	create()	Create a KafkaClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateClusterResponse	createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest)	Creates a new MSK cluster.
default CreateClusterResponse	createCluster(CreateClusterRequest createClusterRequest)	Creates a new MSK cluster.
default CreateClusterV2Response	createClusterV2(Consumer<CreateClusterV2Request.Builder> createClusterV2Request)	Creates a new MSK cluster.
default CreateClusterV2Response	createClusterV2(CreateClusterV2Request createClusterV2Request)	Creates a new MSK cluster.
default CreateConfigurationResponse	createConfiguration(Consumer<CreateConfigurationRequest.Builder> createConfigurationRequest)	Creates a new MSK configuration.
default CreateConfigurationResponse	createConfiguration(CreateConfigurationRequest createConfigurationRequest)	Creates a new MSK configuration.
default CreateReplicatorResponse	createReplicator(Consumer<CreateReplicatorRequest.Builder> createReplicatorRequest)	Creates the replicator.
default CreateReplicatorResponse	createReplicator(CreateReplicatorRequest createReplicatorRequest)	Creates the replicator.
default CreateVpcConnectionResponse	createVpcConnection(Consumer<CreateVpcConnectionRequest.Builder> createVpcConnectionRequest)	Creates a new MSK VPC connection.
default CreateVpcConnectionResponse	createVpcConnection(CreateVpcConnectionRequest createVpcConnectionRequest)	Creates a new MSK VPC connection.
default DeleteClusterResponse	deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest)	Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.
default DeleteClusterResponse	deleteCluster(DeleteClusterRequest deleteClusterRequest)	Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.
default DeleteClusterPolicyResponse	deleteClusterPolicy(Consumer<DeleteClusterPolicyRequest.Builder> deleteClusterPolicyRequest)	Deletes the MSK cluster policy specified by the Amazon Resource Name (ARN) in the request.
default DeleteClusterPolicyResponse	deleteClusterPolicy(DeleteClusterPolicyRequest deleteClusterPolicyRequest)	Deletes the MSK cluster policy specified by the Amazon Resource Name (ARN) in the request.
default DeleteConfigurationResponse	deleteConfiguration(Consumer<DeleteConfigurationRequest.Builder> deleteConfigurationRequest)	Deletes an MSK Configuration.
default DeleteConfigurationResponse	deleteConfiguration(DeleteConfigurationRequest deleteConfigurationRequest)	Deletes an MSK Configuration.
default DeleteReplicatorResponse	deleteReplicator(Consumer<DeleteReplicatorRequest.Builder> deleteReplicatorRequest)	Deletes a replicator.
default DeleteReplicatorResponse	deleteReplicator(DeleteReplicatorRequest deleteReplicatorRequest)	Deletes a replicator.
default DeleteVpcConnectionResponse	deleteVpcConnection(Consumer<DeleteVpcConnectionRequest.Builder> deleteVpcConnectionRequest)	Deletes a MSK VPC connection.
default DeleteVpcConnectionResponse	deleteVpcConnection(DeleteVpcConnectionRequest deleteVpcConnectionRequest)	Deletes a MSK VPC connection.
default DescribeClusterResponse	describeCluster(Consumer<DescribeClusterRequest.Builder> describeClusterRequest)	Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
default DescribeClusterResponse	describeCluster(DescribeClusterRequest describeClusterRequest)	Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
default DescribeClusterOperationResponse	describeClusterOperation(Consumer<DescribeClusterOperationRequest.Builder> describeClusterOperationRequest)	Returns a description of the cluster operation specified by the ARN.
default DescribeClusterOperationResponse	describeClusterOperation(DescribeClusterOperationRequest describeClusterOperationRequest)	Returns a description of the cluster operation specified by the ARN.
default DescribeClusterOperationV2Response	describeClusterOperationV2(Consumer<DescribeClusterOperationV2Request.Builder> describeClusterOperationV2Request)	Returns a description of the cluster operation specified by the ARN.
default DescribeClusterOperationV2Response	describeClusterOperationV2(DescribeClusterOperationV2Request describeClusterOperationV2Request)	Returns a description of the cluster operation specified by the ARN.
default DescribeClusterV2Response	describeClusterV2(Consumer<DescribeClusterV2Request.Builder> describeClusterV2Request)	Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
default DescribeClusterV2Response	describeClusterV2(DescribeClusterV2Request describeClusterV2Request)	Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
default DescribeConfigurationResponse	describeConfiguration(Consumer<DescribeConfigurationRequest.Builder> describeConfigurationRequest)	Returns a description of this MSK configuration.
default DescribeConfigurationResponse	describeConfiguration(DescribeConfigurationRequest describeConfigurationRequest)	Returns a description of this MSK configuration.
default DescribeConfigurationRevisionResponse	describeConfigurationRevision(Consumer<DescribeConfigurationRevisionRequest.Builder> describeConfigurationRevisionRequest)	Returns a description of this revision of the configuration.
default DescribeConfigurationRevisionResponse	describeConfigurationRevision(DescribeConfigurationRevisionRequest describeConfigurationRevisionRequest)	Returns a description of this revision of the configuration.
default DescribeReplicatorResponse	describeReplicator(Consumer<DescribeReplicatorRequest.Builder> describeReplicatorRequest)	Describes a replicator.
default DescribeReplicatorResponse	describeReplicator(DescribeReplicatorRequest describeReplicatorRequest)	Describes a replicator.
default DescribeVpcConnectionResponse	describeVpcConnection(Consumer<DescribeVpcConnectionRequest.Builder> describeVpcConnectionRequest)	Returns a description of this MSK VPC connection.
default DescribeVpcConnectionResponse	describeVpcConnection(DescribeVpcConnectionRequest describeVpcConnectionRequest)	Returns a description of this MSK VPC connection.
default GetBootstrapBrokersResponse	getBootstrapBrokers(Consumer<GetBootstrapBrokersRequest.Builder> getBootstrapBrokersRequest)	A list of brokers that a client application can use to bootstrap.
default GetBootstrapBrokersResponse	getBootstrapBrokers(GetBootstrapBrokersRequest getBootstrapBrokersRequest)	A list of brokers that a client application can use to bootstrap.
default GetClusterPolicyResponse	getClusterPolicy(Consumer<GetClusterPolicyRequest.Builder> getClusterPolicyRequest)	Get the MSK cluster policy specified by the Amazon Resource Name (ARN) in the request.
default GetClusterPolicyResponse	getClusterPolicy(GetClusterPolicyRequest getClusterPolicyRequest)	Get the MSK cluster policy specified by the Amazon Resource Name (ARN) in the request.
default GetCompatibleKafkaVersionsResponse	getCompatibleKafkaVersions(Consumer<GetCompatibleKafkaVersionsRequest.Builder> getCompatibleKafkaVersionsRequest)	Gets the Apache Kafka versions to which you can update the MSK cluster.
default GetCompatibleKafkaVersionsResponse	getCompatibleKafkaVersions(GetCompatibleKafkaVersionsRequest getCompatibleKafkaVersionsRequest)	Gets the Apache Kafka versions to which you can update the MSK cluster.
default ListClientVpcConnectionsResponse	listClientVpcConnections(Consumer<ListClientVpcConnectionsRequest.Builder> listClientVpcConnectionsRequest)	Returns a list of all the VPC connections in this Region.
default ListClientVpcConnectionsResponse	listClientVpcConnections(ListClientVpcConnectionsRequest listClientVpcConnectionsRequest)	Returns a list of all the VPC connections in this Region.
default ListClientVpcConnectionsIterable	listClientVpcConnectionsPaginator(Consumer<ListClientVpcConnectionsRequest.Builder> listClientVpcConnectionsRequest)	This is a variant of listClientVpcConnections(software.amazon.awssdk.services.kafka.model.ListClientVpcConnectionsRequest) operation.
default ListClientVpcConnectionsIterable	listClientVpcConnectionsPaginator(ListClientVpcConnectionsRequest listClientVpcConnectionsRequest)	This is a variant of listClientVpcConnections(software.amazon.awssdk.services.kafka.model.ListClientVpcConnectionsRequest) operation.
default ListClusterOperationsResponse	listClusterOperations(Consumer<ListClusterOperationsRequest.Builder> listClusterOperationsRequest)	Returns a list of all the operations that have been performed on the specified MSK cluster.
default ListClusterOperationsResponse	listClusterOperations(ListClusterOperationsRequest listClusterOperationsRequest)	Returns a list of all the operations that have been performed on the specified MSK cluster.
default ListClusterOperationsIterable	listClusterOperationsPaginator(Consumer<ListClusterOperationsRequest.Builder> listClusterOperationsRequest)	This is a variant of listClusterOperations(software.amazon.awssdk.services.kafka.model.ListClusterOperationsRequest) operation.
default ListClusterOperationsIterable	listClusterOperationsPaginator(ListClusterOperationsRequest listClusterOperationsRequest)	This is a variant of listClusterOperations(software.amazon.awssdk.services.kafka.model.ListClusterOperationsRequest) operation.
default ListClusterOperationsV2Response	listClusterOperationsV2(Consumer<ListClusterOperationsV2Request.Builder> listClusterOperationsV2Request)	Returns a list of all the operations that have been performed on the specified MSK cluster.
default ListClusterOperationsV2Response	listClusterOperationsV2(ListClusterOperationsV2Request listClusterOperationsV2Request)	Returns a list of all the operations that have been performed on the specified MSK cluster.
default ListClusterOperationsV2Iterable	listClusterOperationsV2Paginator(Consumer<ListClusterOperationsV2Request.Builder> listClusterOperationsV2Request)	This is a variant of listClusterOperationsV2(software.amazon.awssdk.services.kafka.model.ListClusterOperationsV2Request) operation.
default ListClusterOperationsV2Iterable	listClusterOperationsV2Paginator(ListClusterOperationsV2Request listClusterOperationsV2Request)	This is a variant of listClusterOperationsV2(software.amazon.awssdk.services.kafka.model.ListClusterOperationsV2Request) operation.
default ListClustersResponse	listClusters()	Returns a list of all the MSK clusters in the current Region.
default ListClustersResponse	listClusters(Consumer<ListClustersRequest.Builder> listClustersRequest)	Returns a list of all the MSK clusters in the current Region.
default ListClustersResponse	listClusters(ListClustersRequest listClustersRequest)	Returns a list of all the MSK clusters in the current Region.
default ListClustersIterable	listClustersPaginator()	This is a variant of listClusters(software.amazon.awssdk.services.kafka.model.ListClustersRequest) operation.
default ListClustersIterable	listClustersPaginator(Consumer<ListClustersRequest.Builder> listClustersRequest)	This is a variant of listClusters(software.amazon.awssdk.services.kafka.model.ListClustersRequest) operation.
default ListClustersIterable	listClustersPaginator(ListClustersRequest listClustersRequest)	This is a variant of listClusters(software.amazon.awssdk.services.kafka.model.ListClustersRequest) operation.
default ListClustersV2Response	listClustersV2(Consumer<ListClustersV2Request.Builder> listClustersV2Request)	Returns a list of all the MSK clusters in the current Region.
default ListClustersV2Response	listClustersV2(ListClustersV2Request listClustersV2Request)	Returns a list of all the MSK clusters in the current Region.
default ListClustersV2Iterable	listClustersV2Paginator(Consumer<ListClustersV2Request.Builder> listClustersV2Request)	This is a variant of listClustersV2(software.amazon.awssdk.services.kafka.model.ListClustersV2Request) operation.
default ListClustersV2Iterable	listClustersV2Paginator(ListClustersV2Request listClustersV2Request)	This is a variant of listClustersV2(software.amazon.awssdk.services.kafka.model.ListClustersV2Request) operation.
default ListConfigurationRevisionsResponse	listConfigurationRevisions(Consumer<ListConfigurationRevisionsRequest.Builder> listConfigurationRevisionsRequest)	Returns a list of all the MSK configurations in this Region.
default ListConfigurationRevisionsResponse	listConfigurationRevisions(ListConfigurationRevisionsRequest listConfigurationRevisionsRequest)	Returns a list of all the MSK configurations in this Region.
default ListConfigurationRevisionsIterable	listConfigurationRevisionsPaginator(Consumer<ListConfigurationRevisionsRequest.Builder> listConfigurationRevisionsRequest)	This is a variant of listConfigurationRevisions(software.amazon.awssdk.services.kafka.model.ListConfigurationRevisionsRequest) operation.
default ListConfigurationRevisionsIterable	listConfigurationRevisionsPaginator(ListConfigurationRevisionsRequest listConfigurationRevisionsRequest)	This is a variant of listConfigurationRevisions(software.amazon.awssdk.services.kafka.model.ListConfigurationRevisionsRequest) operation.
default ListConfigurationsResponse	listConfigurations(Consumer<ListConfigurationsRequest.Builder> listConfigurationsRequest)	Returns a list of all the MSK configurations in this Region.
default ListConfigurationsResponse	listConfigurations(ListConfigurationsRequest listConfigurationsRequest)	Returns a list of all the MSK configurations in this Region.
default ListConfigurationsIterable	listConfigurationsPaginator(Consumer<ListConfigurationsRequest.Builder> listConfigurationsRequest)	This is a variant of listConfigurations(software.amazon.awssdk.services.kafka.model.ListConfigurationsRequest) operation.
default ListConfigurationsIterable	listConfigurationsPaginator(ListConfigurationsRequest listConfigurationsRequest)	This is a variant of listConfigurations(software.amazon.awssdk.services.kafka.model.ListConfigurationsRequest) operation.
default ListKafkaVersionsResponse	listKafkaVersions(Consumer<ListKafkaVersionsRequest.Builder> listKafkaVersionsRequest)	Returns a list of Apache Kafka versions.
default ListKafkaVersionsResponse	listKafkaVersions(ListKafkaVersionsRequest listKafkaVersionsRequest)	Returns a list of Apache Kafka versions.
default ListKafkaVersionsIterable	listKafkaVersionsPaginator(Consumer<ListKafkaVersionsRequest.Builder> listKafkaVersionsRequest)	This is a variant of listKafkaVersions(software.amazon.awssdk.services.kafka.model.ListKafkaVersionsRequest) operation.
default ListKafkaVersionsIterable	listKafkaVersionsPaginator(ListKafkaVersionsRequest listKafkaVersionsRequest)	This is a variant of listKafkaVersions(software.amazon.awssdk.services.kafka.model.ListKafkaVersionsRequest) operation.
default ListNodesResponse	listNodes(Consumer<ListNodesRequest.Builder> listNodesRequest)	Returns a list of the broker nodes in the cluster.
default ListNodesResponse	listNodes(ListNodesRequest listNodesRequest)	Returns a list of the broker nodes in the cluster.
default ListNodesIterable	listNodesPaginator(Consumer<ListNodesRequest.Builder> listNodesRequest)	This is a variant of listNodes(software.amazon.awssdk.services.kafka.model.ListNodesRequest) operation.
default ListNodesIterable	listNodesPaginator(ListNodesRequest listNodesRequest)	This is a variant of listNodes(software.amazon.awssdk.services.kafka.model.ListNodesRequest) operation.
default ListReplicatorsResponse	listReplicators(Consumer<ListReplicatorsRequest.Builder> listReplicatorsRequest)	Lists the replicators.
default ListReplicatorsResponse	listReplicators(ListReplicatorsRequest listReplicatorsRequest)	Lists the replicators.
default ListReplicatorsIterable	listReplicatorsPaginator(Consumer<ListReplicatorsRequest.Builder> listReplicatorsRequest)	This is a variant of listReplicators(software.amazon.awssdk.services.kafka.model.ListReplicatorsRequest) operation.
default ListReplicatorsIterable	listReplicatorsPaginator(ListReplicatorsRequest listReplicatorsRequest)	This is a variant of listReplicators(software.amazon.awssdk.services.kafka.model.ListReplicatorsRequest) operation.
default ListScramSecretsResponse	listScramSecrets(Consumer<ListScramSecretsRequest.Builder> listScramSecretsRequest)	Returns a list of the Scram Secrets associated with an Amazon MSK cluster.
default ListScramSecretsResponse	listScramSecrets(ListScramSecretsRequest listScramSecretsRequest)	Returns a list of the Scram Secrets associated with an Amazon MSK cluster.
default ListScramSecretsIterable	listScramSecretsPaginator(Consumer<ListScramSecretsRequest.Builder> listScramSecretsRequest)	This is a variant of listScramSecrets(software.amazon.awssdk.services.kafka.model.ListScramSecretsRequest) operation.
default ListScramSecretsIterable	listScramSecretsPaginator(ListScramSecretsRequest listScramSecretsRequest)	This is a variant of listScramSecrets(software.amazon.awssdk.services.kafka.model.ListScramSecretsRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Returns a list of the tags associated with the specified resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Returns a list of the tags associated with the specified resource.
default ListVpcConnectionsResponse	listVpcConnections(Consumer<ListVpcConnectionsRequest.Builder> listVpcConnectionsRequest)	Returns a list of all the VPC connections in this Region.
default ListVpcConnectionsResponse	listVpcConnections(ListVpcConnectionsRequest listVpcConnectionsRequest)	Returns a list of all the VPC connections in this Region.
default ListVpcConnectionsIterable	listVpcConnectionsPaginator(Consumer<ListVpcConnectionsRequest.Builder> listVpcConnectionsRequest)	This is a variant of listVpcConnections(software.amazon.awssdk.services.kafka.model.ListVpcConnectionsRequest) operation.
default ListVpcConnectionsIterable	listVpcConnectionsPaginator(ListVpcConnectionsRequest listVpcConnectionsRequest)	This is a variant of listVpcConnections(software.amazon.awssdk.services.kafka.model.ListVpcConnectionsRequest) operation.
default PutClusterPolicyResponse	putClusterPolicy(Consumer<PutClusterPolicyRequest.Builder> putClusterPolicyRequest)	Creates or updates the MSK cluster policy specified by the cluster Amazon Resource Name (ARN) in the request.
default PutClusterPolicyResponse	putClusterPolicy(PutClusterPolicyRequest putClusterPolicyRequest)	Creates or updates the MSK cluster policy specified by the cluster Amazon Resource Name (ARN) in the request.
default RebootBrokerResponse	rebootBroker(Consumer<RebootBrokerRequest.Builder> rebootBrokerRequest)	Reboots brokers.
default RebootBrokerResponse	rebootBroker(RebootBrokerRequest rebootBrokerRequest)	Reboots brokers.
default RejectClientVpcConnectionResponse	rejectClientVpcConnection(Consumer<RejectClientVpcConnectionRequest.Builder> rejectClientVpcConnectionRequest)	Returns empty response.
default RejectClientVpcConnectionResponse	rejectClientVpcConnection(RejectClientVpcConnectionRequest rejectClientVpcConnectionRequest)	Returns empty response.
default KafkaServiceClientConfiguration	serviceClientConfiguration()
static ServiceMetadata	serviceMetadata()
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Adds tags to the specified MSK resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Adds tags to the specified MSK resource.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes the tags associated with the keys that are provided in the query.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes the tags associated with the keys that are provided in the query.
default UpdateBrokerCountResponse	updateBrokerCount(Consumer<UpdateBrokerCountRequest.Builder> updateBrokerCountRequest)	Updates the number of broker nodes in the cluster.
default UpdateBrokerCountResponse	updateBrokerCount(UpdateBrokerCountRequest updateBrokerCountRequest)	Updates the number of broker nodes in the cluster.
default UpdateBrokerStorageResponse	updateBrokerStorage(Consumer<UpdateBrokerStorageRequest.Builder> updateBrokerStorageRequest)	Updates the EBS storage associated with MSK brokers.
default UpdateBrokerStorageResponse	updateBrokerStorage(UpdateBrokerStorageRequest updateBrokerStorageRequest)	Updates the EBS storage associated with MSK brokers.
default UpdateBrokerTypeResponse	updateBrokerType(Consumer<UpdateBrokerTypeRequest.Builder> updateBrokerTypeRequest)	Updates EC2 instance type.
default UpdateBrokerTypeResponse	updateBrokerType(UpdateBrokerTypeRequest updateBrokerTypeRequest)	Updates EC2 instance type.
default UpdateClusterConfigurationResponse	updateClusterConfiguration(Consumer<UpdateClusterConfigurationRequest.Builder> updateClusterConfigurationRequest)	Updates the cluster with the configuration that is specified in the request body.
default UpdateClusterConfigurationResponse	updateClusterConfiguration(UpdateClusterConfigurationRequest updateClusterConfigurationRequest)	Updates the cluster with the configuration that is specified in the request body.
default UpdateClusterKafkaVersionResponse	updateClusterKafkaVersion(Consumer<UpdateClusterKafkaVersionRequest.Builder> updateClusterKafkaVersionRequest)	Updates the Apache Kafka version for the cluster.
default UpdateClusterKafkaVersionResponse	updateClusterKafkaVersion(UpdateClusterKafkaVersionRequest updateClusterKafkaVersionRequest)	Updates the Apache Kafka version for the cluster.
default UpdateConfigurationResponse	updateConfiguration(Consumer<UpdateConfigurationRequest.Builder> updateConfigurationRequest)	Updates an MSK configuration.
default UpdateConfigurationResponse	updateConfiguration(UpdateConfigurationRequest updateConfigurationRequest)	Updates an MSK configuration.
default UpdateConnectivityResponse	updateConnectivity(Consumer<UpdateConnectivityRequest.Builder> updateConnectivityRequest)	Updates the cluster's connectivity configuration.
default UpdateConnectivityResponse	updateConnectivity(UpdateConnectivityRequest updateConnectivityRequest)	Updates the cluster's connectivity configuration.
default UpdateMonitoringResponse	updateMonitoring(Consumer<UpdateMonitoringRequest.Builder> updateMonitoringRequest)	Updates the monitoring settings for the cluster.
default UpdateMonitoringResponse	updateMonitoring(UpdateMonitoringRequest updateMonitoringRequest)	Updates the monitoring settings for the cluster.
default UpdateReplicationInfoResponse	updateReplicationInfo(Consumer<UpdateReplicationInfoRequest.Builder> updateReplicationInfoRequest)	Updates replication info of a replicator.
default UpdateReplicationInfoResponse	updateReplicationInfo(UpdateReplicationInfoRequest updateReplicationInfoRequest)	Updates replication info of a replicator.
default UpdateSecurityResponse	updateSecurity(Consumer<UpdateSecurityRequest.Builder> updateSecurityRequest)	Updates the security settings for the cluster.
default UpdateSecurityResponse	updateSecurity(UpdateSecurityRequest updateSecurityRequest)	Updates the security settings for the cluster.
default UpdateStorageResponse	updateStorage(Consumer<UpdateStorageRequest.Builder> updateStorageRequest)	Updates cluster broker volume size (or) sets cluster storage mode to TIERED.
default UpdateStorageResponse	updateStorage(UpdateStorageRequest updateStorageRequest)	Updates cluster broker volume size (or) sets cluster storage mode to TIERED.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

Constant Field Values

Method Detail

batchAssociateScramSecret

default BatchAssociateScramSecretResponse batchAssociateScramSecret(BatchAssociateScramSecretRequest batchAssociateScramSecretRequest)
                                                             throws BadRequestException,
                                                                    UnauthorizedException,
                                                                    InternalServerErrorException,
                                                                    ForbiddenException,
                                                                    NotFoundException,
                                                                    ServiceUnavailableException,
                                                                    TooManyRequestsException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    KafkaException

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

batchAssociateScramSecret

default BatchAssociateScramSecretResponse batchAssociateScramSecret(Consumer<BatchAssociateScramSecretRequest.Builder> batchAssociateScramSecretRequest)
                                                             throws BadRequestException,
                                                                    UnauthorizedException,
                                                                    InternalServerErrorException,
                                                                    ForbiddenException,
                                                                    NotFoundException,
                                                                    ServiceUnavailableException,
                                                                    TooManyRequestsException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    KafkaException

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

This is a convenience which creates an instance of the BatchAssociateScramSecretRequest.Builder avoiding the need to create one manually via BatchAssociateScramSecretRequest.builder()

Parameters:

batchAssociateScramSecretRequest - A Consumer that will call methods on BatchAssociateScramSecretRequest.Builder to create a request.

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

batchDisassociateScramSecret

default BatchDisassociateScramSecretResponse batchDisassociateScramSecret(BatchDisassociateScramSecretRequest batchDisassociateScramSecretRequest)
                                                                   throws BadRequestException,
                                                                          UnauthorizedException,
                                                                          InternalServerErrorException,
                                                                          ForbiddenException,
                                                                          NotFoundException,
                                                                          ServiceUnavailableException,
                                                                          TooManyRequestsException,
                                                                          AwsServiceException,
                                                                          SdkClientException,
                                                                          KafkaException

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

batchDisassociateScramSecret

default BatchDisassociateScramSecretResponse batchDisassociateScramSecret(Consumer<BatchDisassociateScramSecretRequest.Builder> batchDisassociateScramSecretRequest)
                                                                   throws BadRequestException,
                                                                          UnauthorizedException,
                                                                          InternalServerErrorException,
                                                                          ForbiddenException,
                                                                          NotFoundException,
                                                                          ServiceUnavailableException,
                                                                          TooManyRequestsException,
                                                                          AwsServiceException,
                                                                          SdkClientException,
                                                                          KafkaException

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

This is a convenience which creates an instance of the BatchDisassociateScramSecretRequest.Builder avoiding the need to create one manually via BatchDisassociateScramSecretRequest.builder()

Parameters:

batchDisassociateScramSecretRequest - A Consumer that will call methods on BatchDisassociateScramSecretRequest.Builder to create a request.

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createCluster

default CreateClusterResponse createCluster(CreateClusterRequest createClusterRequest)
                                     throws BadRequestException,
                                            InternalServerErrorException,
                                            UnauthorizedException,
                                            ForbiddenException,
                                            ServiceUnavailableException,
                                            TooManyRequestsException,
                                            ConflictException,
                                            AwsServiceException,
                                            SdkClientException,
                                            KafkaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createCluster

default CreateClusterResponse createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest)
                                     throws BadRequestException,
                                            InternalServerErrorException,
                                            UnauthorizedException,
                                            ForbiddenException,
                                            ServiceUnavailableException,
                                            TooManyRequestsException,
                                            ConflictException,
                                            AwsServiceException,
                                            SdkClientException,
                                            KafkaException

Creates a new MSK cluster.

This is a convenience which creates an instance of the CreateClusterRequest.Builder avoiding the need to create one manually via CreateClusterRequest.builder()

Parameters:

createClusterRequest - A Consumer that will call methods on CreateClusterRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createClusterV2

default CreateClusterV2Response createClusterV2(CreateClusterV2Request createClusterV2Request)
                                         throws BadRequestException,
                                                InternalServerErrorException,
                                                UnauthorizedException,
                                                ForbiddenException,
                                                ServiceUnavailableException,
                                                TooManyRequestsException,
                                                ConflictException,
                                                AwsServiceException,
                                                SdkClientException,
                                                KafkaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createClusterV2

default CreateClusterV2Response createClusterV2(Consumer<CreateClusterV2Request.Builder> createClusterV2Request)
                                         throws BadRequestException,
                                                InternalServerErrorException,
                                                UnauthorizedException,
                                                ForbiddenException,
                                                ServiceUnavailableException,
                                                TooManyRequestsException,
                                                ConflictException,
                                                AwsServiceException,
                                                SdkClientException,
                                                KafkaException

Creates a new MSK cluster.

This is a convenience which creates an instance of the CreateClusterV2Request.Builder avoiding the need to create one manually via CreateClusterV2Request.builder()

Parameters:

createClusterV2Request - A Consumer that will call methods on CreateClusterV2Request.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createConfiguration

default CreateConfigurationResponse createConfiguration(CreateConfigurationRequest createConfigurationRequest)
                                                 throws BadRequestException,
                                                        InternalServerErrorException,
                                                        UnauthorizedException,
                                                        ForbiddenException,
                                                        ServiceUnavailableException,
                                                        TooManyRequestsException,
                                                        ConflictException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        KafkaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createConfiguration

default CreateConfigurationResponse createConfiguration(Consumer<CreateConfigurationRequest.Builder> createConfigurationRequest)
                                                 throws BadRequestException,
                                                        InternalServerErrorException,
                                                        UnauthorizedException,
                                                        ForbiddenException,
                                                        ServiceUnavailableException,
                                                        TooManyRequestsException,
                                                        ConflictException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        KafkaException

Creates a new MSK configuration.

This is a convenience which creates an instance of the CreateConfigurationRequest.Builder avoiding the need to create one manually via CreateConfigurationRequest.builder()

Parameters:

createConfigurationRequest - A Consumer that will call methods on CreateConfigurationRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createReplicator

default CreateReplicatorResponse createReplicator(CreateReplicatorRequest createReplicatorRequest)
                                           throws BadRequestException,
                                                  UnauthorizedException,
                                                  InternalServerErrorException,
                                                  ForbiddenException,
                                                  NotFoundException,
                                                  ServiceUnavailableException,
                                                  TooManyRequestsException,
                                                  ConflictException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  KafkaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createReplicator

default CreateReplicatorResponse createReplicator(Consumer<CreateReplicatorRequest.Builder> createReplicatorRequest)
                                           throws BadRequestException,
                                                  UnauthorizedException,
                                                  InternalServerErrorException,
                                                  ForbiddenException,
                                                  NotFoundException,
                                                  ServiceUnavailableException,
                                                  TooManyRequestsException,
                                                  ConflictException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  KafkaException

Creates the replicator.

This is a convenience which creates an instance of the CreateReplicatorRequest.Builder avoiding the need to create one manually via CreateReplicatorRequest.builder()

Parameters:

createReplicatorRequest - A Consumer that will call methods on CreateReplicatorRequest.Builder to create a request. 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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createVpcConnection

default CreateVpcConnectionResponse createVpcConnection(CreateVpcConnectionRequest createVpcConnectionRequest)
                                                 throws BadRequestException,
                                                        InternalServerErrorException,
                                                        UnauthorizedException,
                                                        ForbiddenException,
                                                        ServiceUnavailableException,
                                                        TooManyRequestsException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        KafkaException

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createVpcConnection

default CreateVpcConnectionResponse createVpcConnection(Consumer<CreateVpcConnectionRequest.Builder> createVpcConnectionRequest)
                                                 throws BadRequestException,
                                                        InternalServerErrorException,
                                                        UnauthorizedException,
                                                        ForbiddenException,
                                                        ServiceUnavailableException,
                                                        TooManyRequestsException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        KafkaException

Creates a new MSK VPC connection.

This is a convenience which creates an instance of the CreateVpcConnectionRequest.Builder avoiding the need to create one manually via CreateVpcConnectionRequest.builder()

Parameters:

createVpcConnectionRequest - A Consumer that will call methods on CreateVpcConnectionRequest.Builder to create a request.

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteCluster

default DeleteClusterResponse deleteCluster(DeleteClusterRequest deleteClusterRequest)
                                     throws NotFoundException,
                                            BadRequestException,
                                            InternalServerErrorException,
                                            ForbiddenException,
                                            AwsServiceException,
                                            SdkClientException,
                                            KafkaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteCluster

default DeleteClusterResponse deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest)
                                     throws NotFoundException,
                                            BadRequestException,
                                            InternalServerErrorException,
                                            ForbiddenException,
                                            AwsServiceException,
                                            SdkClientException,
                                            KafkaException

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

This is a convenience which creates an instance of the DeleteClusterRequest.Builder avoiding the need to create one manually via DeleteClusterRequest.builder()

Parameters:

deleteClusterRequest - A Consumer that will call methods on DeleteClusterRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteClusterPolicy

default DeleteClusterPolicyResponse deleteClusterPolicy(DeleteClusterPolicyRequest deleteClusterPolicyRequest)
                                                 throws NotFoundException,
                                                        BadRequestException,
                                                        InternalServerErrorException,
                                                        ForbiddenException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        KafkaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteClusterPolicy

default DeleteClusterPolicyResponse deleteClusterPolicy(Consumer<DeleteClusterPolicyRequest.Builder> deleteClusterPolicyRequest)
                                                 throws NotFoundException,
                                                        BadRequestException,
                                                        InternalServerErrorException,
                                                        ForbiddenException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        KafkaException

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

This is a convenience which creates an instance of the DeleteClusterPolicyRequest.Builder avoiding the need to create one manually via DeleteClusterPolicyRequest.builder()

Parameters:

deleteClusterPolicyRequest - A Consumer that will call methods on DeleteClusterPolicyRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteConfiguration

default DeleteConfigurationResponse deleteConfiguration(DeleteConfigurationRequest deleteConfigurationRequest)
                                                 throws NotFoundException,
                                                        BadRequestException,
                                                        InternalServerErrorException,
                                                        ForbiddenException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        KafkaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteConfiguration

default DeleteConfigurationResponse deleteConfiguration(Consumer<DeleteConfigurationRequest.Builder> deleteConfigurationRequest)
                                                 throws NotFoundException,
                                                        BadRequestException,
                                                        InternalServerErrorException,
                                                        ForbiddenException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        KafkaException

Deletes an MSK Configuration.

This is a convenience which creates an instance of the DeleteConfigurationRequest.Builder avoiding the need to create one manually via DeleteConfigurationRequest.builder()

Parameters:

deleteConfigurationRequest - A Consumer that will call methods on DeleteConfigurationRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteReplicator

default DeleteReplicatorResponse deleteReplicator(DeleteReplicatorRequest deleteReplicatorRequest)
                                           throws BadRequestException,
                                                  UnauthorizedException,
                                                  InternalServerErrorException,
                                                  ForbiddenException,
                                                  NotFoundException,
                                                  ServiceUnavailableException,
                                                  TooManyRequestsException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  KafkaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteReplicator

default DeleteReplicatorResponse deleteReplicator(Consumer<DeleteReplicatorRequest.Builder> deleteReplicatorRequest)
                                           throws BadRequestException,
                                                  UnauthorizedException,
                                                  InternalServerErrorException,
                                                  ForbiddenException,
                                                  NotFoundException,
                                                  ServiceUnavailableException,
                                                  TooManyRequestsException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  KafkaException

Deletes a replicator.

This is a convenience which creates an instance of the DeleteReplicatorRequest.Builder avoiding the need to create one manually via DeleteReplicatorRequest.builder()

Parameters:

deleteReplicatorRequest - A Consumer that will call methods on DeleteReplicatorRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteVpcConnection

default DeleteVpcConnectionResponse deleteVpcConnection(DeleteVpcConnectionRequest deleteVpcConnectionRequest)
                                                 throws NotFoundException,
                                                        BadRequestException,
                                                        InternalServerErrorException,
                                                        ForbiddenException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        KafkaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteVpcConnection

default DeleteVpcConnectionResponse deleteVpcConnection(Consumer<DeleteVpcConnectionRequest.Builder> deleteVpcConnectionRequest)
                                                 throws NotFoundException,
                                                        BadRequestException,
                                                        InternalServerErrorException,
                                                        ForbiddenException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        KafkaException

Deletes a MSK VPC connection.

This is a convenience which creates an instance of the DeleteVpcConnectionRequest.Builder avoiding the need to create one manually via DeleteVpcConnectionRequest.builder()

Parameters:

deleteVpcConnectionRequest - A Consumer that will call methods on DeleteVpcConnectionRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeCluster

default DescribeClusterResponse describeCluster(DescribeClusterRequest describeClusterRequest)
                                         throws NotFoundException,
                                                BadRequestException,
                                                UnauthorizedException,
                                                InternalServerErrorException,
                                                ForbiddenException,
                                                AwsServiceException,
                                                SdkClientException,
                                                KafkaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeCluster

default DescribeClusterResponse describeCluster(Consumer<DescribeClusterRequest.Builder> describeClusterRequest)
                                         throws NotFoundException,
                                                BadRequestException,
                                                UnauthorizedException,
                                                InternalServerErrorException,
                                                ForbiddenException,
                                                AwsServiceException,
                                                SdkClientException,
                                                KafkaException

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

This is a convenience which creates an instance of the DescribeClusterRequest.Builder avoiding the need to create one manually via DescribeClusterRequest.builder()

Parameters:

describeClusterRequest - A Consumer that will call methods on DescribeClusterRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeClusterOperation

default DescribeClusterOperationResponse describeClusterOperation(DescribeClusterOperationRequest describeClusterOperationRequest)
                                                           throws NotFoundException,
                                                                  BadRequestException,
                                                                  UnauthorizedException,
                                                                  InternalServerErrorException,
                                                                  ForbiddenException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  KafkaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeClusterOperation

default DescribeClusterOperationResponse describeClusterOperation(Consumer<DescribeClusterOperationRequest.Builder> describeClusterOperationRequest)
                                                           throws NotFoundException,
                                                                  BadRequestException,
                                                                  UnauthorizedException,
                                                                  InternalServerErrorException,
                                                                  ForbiddenException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  KafkaException

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

This is a convenience which creates an instance of the DescribeClusterOperationRequest.Builder avoiding the need to create one manually via DescribeClusterOperationRequest.builder()

Parameters:

describeClusterOperationRequest - A Consumer that will call methods on DescribeClusterOperationRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeClusterOperationV2

default DescribeClusterOperationV2Response describeClusterOperationV2(DescribeClusterOperationV2Request describeClusterOperationV2Request)
                                                               throws BadRequestException,
                                                                      UnauthorizedException,
                                                                      InternalServerErrorException,
                                                                      ForbiddenException,
                                                                      NotFoundException,
                                                                      ServiceUnavailableException,
                                                                      TooManyRequestsException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      KafkaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeClusterOperationV2

default DescribeClusterOperationV2Response describeClusterOperationV2(Consumer<DescribeClusterOperationV2Request.Builder> describeClusterOperationV2Request)
                                                               throws BadRequestException,
                                                                      UnauthorizedException,
                                                                      InternalServerErrorException,
                                                                      ForbiddenException,
                                                                      NotFoundException,
                                                                      ServiceUnavailableException,
                                                                      TooManyRequestsException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      KafkaException

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

This is a convenience which creates an instance of the DescribeClusterOperationV2Request.Builder avoiding the need to create one manually via DescribeClusterOperationV2Request.builder()

Parameters:

describeClusterOperationV2Request - A Consumer that will call methods on DescribeClusterOperationV2Request.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeClusterV2

default DescribeClusterV2Response describeClusterV2(DescribeClusterV2Request describeClusterV2Request)
                                             throws NotFoundException,
                                                    BadRequestException,
                                                    UnauthorizedException,
                                                    InternalServerErrorException,
                                                    ForbiddenException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    KafkaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeClusterV2

default DescribeClusterV2Response describeClusterV2(Consumer<DescribeClusterV2Request.Builder> describeClusterV2Request)
                                             throws NotFoundException,
                                                    BadRequestException,
                                                    UnauthorizedException,
                                                    InternalServerErrorException,
                                                    ForbiddenException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    KafkaException

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

This is a convenience which creates an instance of the DescribeClusterV2Request.Builder avoiding the need to create one manually via DescribeClusterV2Request.builder()

Parameters:

describeClusterV2Request - A Consumer that will call methods on DescribeClusterV2Request.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeConfiguration

default DescribeConfigurationResponse describeConfiguration(DescribeConfigurationRequest describeConfigurationRequest)
                                                     throws BadRequestException,
                                                            UnauthorizedException,
                                                            InternalServerErrorException,
                                                            ForbiddenException,
                                                            NotFoundException,
                                                            ServiceUnavailableException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            KafkaException

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeConfiguration

default DescribeConfigurationResponse describeConfiguration(Consumer<DescribeConfigurationRequest.Builder> describeConfigurationRequest)
                                                     throws BadRequestException,
                                                            UnauthorizedException,
                                                            InternalServerErrorException,
                                                            ForbiddenException,
                                                            NotFoundException,
                                                            ServiceUnavailableException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            KafkaException

Returns a description of this MSK configuration.

This is a convenience which creates an instance of the DescribeConfigurationRequest.Builder avoiding the need to create one manually via DescribeConfigurationRequest.builder()

Parameters:

describeConfigurationRequest - A Consumer that will call methods on DescribeConfigurationRequest.Builder to create a request.

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeConfigurationRevision

default DescribeConfigurationRevisionResponse describeConfigurationRevision(DescribeConfigurationRevisionRequest describeConfigurationRevisionRequest)
                                                                     throws BadRequestException,
                                                                            UnauthorizedException,
                                                                            InternalServerErrorException,
                                                                            ForbiddenException,
                                                                            NotFoundException,
                                                                            ServiceUnavailableException,
                                                                            AwsServiceException,
                                                                            SdkClientException,
                                                                            KafkaException

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeConfigurationRevision

default DescribeConfigurationRevisionResponse describeConfigurationRevision(Consumer<DescribeConfigurationRevisionRequest.Builder> describeConfigurationRevisionRequest)
                                                                     throws BadRequestException,
                                                                            UnauthorizedException,
                                                                            InternalServerErrorException,
                                                                            ForbiddenException,
                                                                            NotFoundException,
                                                                            ServiceUnavailableException,
                                                                            AwsServiceException,
                                                                            SdkClientException,
                                                                            KafkaException

Returns a description of this revision of the configuration.

This is a convenience which creates an instance of the DescribeConfigurationRevisionRequest.Builder avoiding the need to create one manually via DescribeConfigurationRevisionRequest.builder()

Parameters:

describeConfigurationRevisionRequest - A Consumer that will call methods on DescribeConfigurationRevisionRequest.Builder to create a request.

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeReplicator

default DescribeReplicatorResponse describeReplicator(DescribeReplicatorRequest describeReplicatorRequest)
                                               throws BadRequestException,
                                                      UnauthorizedException,
                                                      InternalServerErrorException,
                                                      ForbiddenException,
                                                      NotFoundException,
                                                      ServiceUnavailableException,
                                                      TooManyRequestsException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      KafkaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeReplicator

default DescribeReplicatorResponse describeReplicator(Consumer<DescribeReplicatorRequest.Builder> describeReplicatorRequest)
                                               throws BadRequestException,
                                                      UnauthorizedException,
                                                      InternalServerErrorException,
                                                      ForbiddenException,
                                                      NotFoundException,
                                                      ServiceUnavailableException,
                                                      TooManyRequestsException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      KafkaException

Describes a replicator.

This is a convenience which creates an instance of the DescribeReplicatorRequest.Builder avoiding the need to create one manually via DescribeReplicatorRequest.builder()

Parameters:

describeReplicatorRequest - A Consumer that will call methods on DescribeReplicatorRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeVpcConnection

default DescribeVpcConnectionResponse describeVpcConnection(DescribeVpcConnectionRequest describeVpcConnectionRequest)
                                                     throws BadRequestException,
                                                            UnauthorizedException,
                                                            InternalServerErrorException,
                                                            ForbiddenException,
                                                            NotFoundException,
                                                            ServiceUnavailableException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            KafkaException

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeVpcConnection

default DescribeVpcConnectionResponse describeVpcConnection(Consumer<DescribeVpcConnectionRequest.Builder> describeVpcConnectionRequest)
                                                     throws BadRequestException,
                                                            UnauthorizedException,
                                                            InternalServerErrorException,
                                                            ForbiddenException,
                                                            NotFoundException,
                                                            ServiceUnavailableException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            KafkaException

Returns a description of this MSK VPC connection.

This is a convenience which creates an instance of the DescribeVpcConnectionRequest.Builder avoiding the need to create one manually via DescribeVpcConnectionRequest.builder()

Parameters:

describeVpcConnectionRequest - A Consumer that will call methods on DescribeVpcConnectionRequest.Builder to create a request.

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getBootstrapBrokers

default GetBootstrapBrokersResponse getBootstrapBrokers(GetBootstrapBrokersRequest getBootstrapBrokersRequest)
                                                 throws BadRequestException,
                                                        UnauthorizedException,
                                                        InternalServerErrorException,
                                                        ConflictException,
                                                        ForbiddenException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        KafkaException

A list of brokers that a client application can use to bootstrap. This list doesn't necessarily include all of the brokers in the cluster. The following Python 3.6 example shows how you can use the Amazon Resource Name (ARN) of a cluster to get its bootstrap brokers. If you don't know the ARN of your cluster, you can use the ListClusters operation to get the ARNs of all the clusters in this account and Region.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getBootstrapBrokers

default GetBootstrapBrokersResponse getBootstrapBrokers(Consumer<GetBootstrapBrokersRequest.Builder> getBootstrapBrokersRequest)
                                                 throws BadRequestException,
                                                        UnauthorizedException,
                                                        InternalServerErrorException,
                                                        ConflictException,
                                                        ForbiddenException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        KafkaException

A list of brokers that a client application can use to bootstrap. This list doesn't necessarily include all of the brokers in the cluster. The following Python 3.6 example shows how you can use the Amazon Resource Name (ARN) of a cluster to get its bootstrap brokers. If you don't know the ARN of your cluster, you can use the ListClusters operation to get the ARNs of all the clusters in this account and Region.

This is a convenience which creates an instance of the GetBootstrapBrokersRequest.Builder avoiding the need to create one manually via GetBootstrapBrokersRequest.builder()

Parameters:

getBootstrapBrokersRequest - A Consumer that will call methods on GetBootstrapBrokersRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getClusterPolicy

default GetClusterPolicyResponse getClusterPolicy(GetClusterPolicyRequest getClusterPolicyRequest)
                                           throws NotFoundException,
                                                  BadRequestException,
                                                  InternalServerErrorException,
                                                  ForbiddenException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  KafkaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getClusterPolicy

default GetClusterPolicyResponse getClusterPolicy(Consumer<GetClusterPolicyRequest.Builder> getClusterPolicyRequest)
                                           throws NotFoundException,
                                                  BadRequestException,
                                                  InternalServerErrorException,
                                                  ForbiddenException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  KafkaException

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

This is a convenience which creates an instance of the GetClusterPolicyRequest.Builder avoiding the need to create one manually via GetClusterPolicyRequest.builder()

Parameters:

getClusterPolicyRequest - A Consumer that will call methods on GetClusterPolicyRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getCompatibleKafkaVersions

default GetCompatibleKafkaVersionsResponse getCompatibleKafkaVersions(GetCompatibleKafkaVersionsRequest getCompatibleKafkaVersionsRequest)
                                                               throws BadRequestException,
                                                                      UnauthorizedException,
                                                                      InternalServerErrorException,
                                                                      ForbiddenException,
                                                                      NotFoundException,
                                                                      ServiceUnavailableException,
                                                                      TooManyRequestsException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      KafkaException

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getCompatibleKafkaVersions

default GetCompatibleKafkaVersionsResponse getCompatibleKafkaVersions(Consumer<GetCompatibleKafkaVersionsRequest.Builder> getCompatibleKafkaVersionsRequest)
                                                               throws BadRequestException,
                                                                      UnauthorizedException,
                                                                      InternalServerErrorException,
                                                                      ForbiddenException,
                                                                      NotFoundException,
                                                                      ServiceUnavailableException,
                                                                      TooManyRequestsException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      KafkaException

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

This is a convenience which creates an instance of the GetCompatibleKafkaVersionsRequest.Builder avoiding the need to create one manually via GetCompatibleKafkaVersionsRequest.builder()

Parameters:

getCompatibleKafkaVersionsRequest - A Consumer that will call methods on GetCompatibleKafkaVersionsRequest.Builder to create a request.

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listClientVpcConnections

default ListClientVpcConnectionsResponse listClientVpcConnections(ListClientVpcConnectionsRequest listClientVpcConnectionsRequest)
                                                           throws ServiceUnavailableException,
                                                                  BadRequestException,
                                                                  UnauthorizedException,
                                                                  InternalServerErrorException,
                                                                  ForbiddenException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  KafkaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listClientVpcConnections

default ListClientVpcConnectionsResponse listClientVpcConnections(Consumer<ListClientVpcConnectionsRequest.Builder> listClientVpcConnectionsRequest)
                                                           throws ServiceUnavailableException,
                                                                  BadRequestException,
                                                                  UnauthorizedException,
                                                                  InternalServerErrorException,
                                                                  ForbiddenException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  KafkaException

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

This is a convenience which creates an instance of the ListClientVpcConnectionsRequest.Builder avoiding the need to create one manually via ListClientVpcConnectionsRequest.builder()

Parameters:

listClientVpcConnectionsRequest - A Consumer that will call methods on ListClientVpcConnectionsRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listClientVpcConnectionsPaginator

default ListClientVpcConnectionsIterable listClientVpcConnectionsPaginator(ListClientVpcConnectionsRequest listClientVpcConnectionsRequest)
                                                                    throws ServiceUnavailableException,
                                                                           BadRequestException,
                                                                           UnauthorizedException,
                                                                           InternalServerErrorException,
                                                                           ForbiddenException,
                                                                           AwsServiceException,
                                                                           SdkClientException,
                                                                           KafkaException

This is a variant of listClientVpcConnections(software.amazon.awssdk.services.kafka.model.ListClientVpcConnectionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.kafka.paginators.ListClientVpcConnectionsIterable responses = client.listClientVpcConnectionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.kafka.paginators.ListClientVpcConnectionsIterable responses = client
             .listClientVpcConnectionsPaginator(request);
     for (software.amazon.awssdk.services.kafka.model.ListClientVpcConnectionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.kafka.paginators.ListClientVpcConnectionsIterable responses = client.listClientVpcConnectionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listClientVpcConnections(software.amazon.awssdk.services.kafka.model.ListClientVpcConnectionsRequest) operation.

Parameters:

listClientVpcConnectionsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listClientVpcConnectionsPaginator

default ListClientVpcConnectionsIterable listClientVpcConnectionsPaginator(Consumer<ListClientVpcConnectionsRequest.Builder> listClientVpcConnectionsRequest)
                                                                    throws ServiceUnavailableException,
                                                                           BadRequestException,
                                                                           UnauthorizedException,
                                                                           InternalServerErrorException,
                                                                           ForbiddenException,
                                                                           AwsServiceException,
                                                                           SdkClientException,
                                                                           KafkaException

This is a variant of listClientVpcConnections(software.amazon.awssdk.services.kafka.model.ListClientVpcConnectionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.kafka.paginators.ListClientVpcConnectionsIterable responses = client.listClientVpcConnectionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.kafka.paginators.ListClientVpcConnectionsIterable responses = client
             .listClientVpcConnectionsPaginator(request);
     for (software.amazon.awssdk.services.kafka.model.ListClientVpcConnectionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.kafka.paginators.ListClientVpcConnectionsIterable responses = client.listClientVpcConnectionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listClientVpcConnections(software.amazon.awssdk.services.kafka.model.ListClientVpcConnectionsRequest) operation.

This is a convenience which creates an instance of the ListClientVpcConnectionsRequest.Builder avoiding the need to create one manually via ListClientVpcConnectionsRequest.builder()

Parameters:

listClientVpcConnectionsRequest - A Consumer that will call methods on ListClientVpcConnectionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listClusterOperations

default ListClusterOperationsResponse listClusterOperations(ListClusterOperationsRequest listClusterOperationsRequest)
                                                     throws BadRequestException,
                                                            InternalServerErrorException,
                                                            UnauthorizedException,
                                                            ForbiddenException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            KafkaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listClusterOperations

default ListClusterOperationsResponse listClusterOperations(Consumer<ListClusterOperationsRequest.Builder> listClusterOperationsRequest)
                                                     throws BadRequestException,
                                                            InternalServerErrorException,
                                                            UnauthorizedException,
                                                            ForbiddenException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            KafkaException

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

This is a convenience which creates an instance of the ListClusterOperationsRequest.Builder avoiding the need to create one manually via ListClusterOperationsRequest.builder()

Parameters:

listClusterOperationsRequest - A Consumer that will call methods on ListClusterOperationsRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listClusterOperationsPaginator

default ListClusterOperationsIterable listClusterOperationsPaginator(ListClusterOperationsRequest listClusterOperationsRequest)
                                                              throws BadRequestException,
                                                                     InternalServerErrorException,
                                                                     UnauthorizedException,
                                                                     ForbiddenException,
                                                                     AwsServiceException,
                                                                     SdkClientException,
                                                                     KafkaException

This is a variant of listClusterOperations(software.amazon.awssdk.services.kafka.model.ListClusterOperationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.kafka.paginators.ListClusterOperationsIterable responses = client.listClusterOperationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.kafka.paginators.ListClusterOperationsIterable responses = client
             .listClusterOperationsPaginator(request);
     for (software.amazon.awssdk.services.kafka.model.ListClusterOperationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.kafka.paginators.ListClusterOperationsIterable responses = client.listClusterOperationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listClusterOperations(software.amazon.awssdk.services.kafka.model.ListClusterOperationsRequest) operation.

Parameters:

listClusterOperationsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listClusterOperationsPaginator

default ListClusterOperationsIterable listClusterOperationsPaginator(Consumer<ListClusterOperationsRequest.Builder> listClusterOperationsRequest)
                                                              throws BadRequestException,
                                                                     InternalServerErrorException,
                                                                     UnauthorizedException,
                                                                     ForbiddenException,
                                                                     AwsServiceException,
                                                                     SdkClientException,
                                                                     KafkaException

This is a variant of listClusterOperations(software.amazon.awssdk.services.kafka.model.ListClusterOperationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.kafka.paginators.ListClusterOperationsIterable responses = client.listClusterOperationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.kafka.paginators.ListClusterOperationsIterable responses = client
             .listClusterOperationsPaginator(request);
     for (software.amazon.awssdk.services.kafka.model.ListClusterOperationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.kafka.paginators.ListClusterOperationsIterable responses = client.listClusterOperationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listClusterOperations(software.amazon.awssdk.services.kafka.model.ListClusterOperationsRequest) operation.

This is a convenience which creates an instance of the ListClusterOperationsRequest.Builder avoiding the need to create one manually via ListClusterOperationsRequest.builder()

Parameters:

listClusterOperationsRequest - A Consumer that will call methods on ListClusterOperationsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listClusterOperationsV2

default ListClusterOperationsV2Response listClusterOperationsV2(ListClusterOperationsV2Request listClusterOperationsV2Request)
                                                         throws BadRequestException,
                                                                UnauthorizedException,
                                                                InternalServerErrorException,
                                                                ForbiddenException,
                                                                NotFoundException,
                                                                ServiceUnavailableException,
                                                                TooManyRequestsException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                KafkaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listClusterOperationsV2

default ListClusterOperationsV2Response listClusterOperationsV2(Consumer<ListClusterOperationsV2Request.Builder> listClusterOperationsV2Request)
                                                         throws BadRequestException,
                                                                UnauthorizedException,
                                                                InternalServerErrorException,
                                                                ForbiddenException,
                                                                NotFoundException,
                                                                ServiceUnavailableException,
                                                                TooManyRequestsException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                KafkaException

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

This is a convenience which creates an instance of the ListClusterOperationsV2Request.Builder avoiding the need to create one manually via ListClusterOperationsV2Request.builder()

Parameters:

listClusterOperationsV2Request - A Consumer that will call methods on ListClusterOperationsV2Request.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listClusterOperationsV2Paginator

default ListClusterOperationsV2Iterable listClusterOperationsV2Paginator(ListClusterOperationsV2Request listClusterOperationsV2Request)
                                                                  throws BadRequestException,
                                                                         UnauthorizedException,
                                                                         InternalServerErrorException,
                                                                         ForbiddenException,
                                                                         NotFoundException,
                                                                         ServiceUnavailableException,
                                                                         TooManyRequestsException,
                                                                         AwsServiceException,
                                                                         SdkClientException,
                                                                         KafkaException

This is a variant of listClusterOperationsV2(software.amazon.awssdk.services.kafka.model.ListClusterOperationsV2Request) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.kafka.paginators.ListClusterOperationsV2Iterable responses = client.listClusterOperationsV2Paginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.kafka.paginators.ListClusterOperationsV2Iterable responses = client
             .listClusterOperationsV2Paginator(request);
     for (software.amazon.awssdk.services.kafka.model.ListClusterOperationsV2Response response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.kafka.paginators.ListClusterOperationsV2Iterable responses = client.listClusterOperationsV2Paginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listClusterOperationsV2(software.amazon.awssdk.services.kafka.model.ListClusterOperationsV2Request) operation.

Parameters:

listClusterOperationsV2Request -

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listClusterOperationsV2Paginator

default ListClusterOperationsV2Iterable listClusterOperationsV2Paginator(Consumer<ListClusterOperationsV2Request.Builder> listClusterOperationsV2Request)
                                                                  throws BadRequestException,
                                                                         UnauthorizedException,
                                                                         InternalServerErrorException,
                                                                         ForbiddenException,
                                                                         NotFoundException,
                                                                         ServiceUnavailableException,
                                                                         TooManyRequestsException,
                                                                         AwsServiceException,
                                                                         SdkClientException,
                                                                         KafkaException

This is a variant of listClusterOperationsV2(software.amazon.awssdk.services.kafka.model.ListClusterOperationsV2Request) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.kafka.paginators.ListClusterOperationsV2Iterable responses = client.listClusterOperationsV2Paginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.kafka.paginators.ListClusterOperationsV2Iterable responses = client
             .listClusterOperationsV2Paginator(request);
     for (software.amazon.awssdk.services.kafka.model.ListClusterOperationsV2Response response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.kafka.paginators.ListClusterOperationsV2Iterable responses = client.listClusterOperationsV2Paginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listClusterOperationsV2(software.amazon.awssdk.services.kafka.model.ListClusterOperationsV2Request) operation.

This is a convenience which creates an instance of the ListClusterOperationsV2Request.Builder avoiding the need to create one manually via ListClusterOperationsV2Request.builder()

Parameters:

listClusterOperationsV2Request - A Consumer that will call methods on ListClusterOperationsV2Request.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listClusters

default ListClustersResponse listClusters(ListClustersRequest listClustersRequest)
                                   throws BadRequestException,
                                          InternalServerErrorException,
                                          UnauthorizedException,
                                          ForbiddenException,
                                          AwsServiceException,
                                          SdkClientException,
                                          KafkaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listClusters

default ListClustersResponse listClusters(Consumer<ListClustersRequest.Builder> listClustersRequest)
                                   throws BadRequestException,
                                          InternalServerErrorException,
                                          UnauthorizedException,
                                          ForbiddenException,
                                          AwsServiceException,
                                          SdkClientException,
                                          KafkaException

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

This is a convenience which creates an instance of the ListClustersRequest.Builder avoiding the need to create one manually via ListClustersRequest.builder()

Parameters:

listClustersRequest - A Consumer that will call methods on ListClustersRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listClusters

default ListClustersResponse listClusters()
                                   throws BadRequestException,
                                          InternalServerErrorException,
                                          UnauthorizedException,
                                          ForbiddenException,
                                          AwsServiceException,
                                          SdkClientException,
                                          KafkaException

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

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

listClusters(ListClustersRequest), AWS API Documentation

listClustersPaginator

default ListClustersIterable listClustersPaginator()
                                            throws BadRequestException,
                                                   InternalServerErrorException,
                                                   UnauthorizedException,
                                                   ForbiddenException,
                                                   AwsServiceException,
                                                   SdkClientException,
                                                   KafkaException

This is a variant of listClusters(software.amazon.awssdk.services.kafka.model.ListClustersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.kafka.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.kafka.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
     for (software.amazon.awssdk.services.kafka.model.ListClustersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.kafka.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listClusters(software.amazon.awssdk.services.kafka.model.ListClustersRequest) operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

listClustersPaginator(ListClustersRequest), AWS API Documentation

listClustersPaginator

default ListClustersIterable listClustersPaginator(ListClustersRequest listClustersRequest)
                                            throws BadRequestException,
                                                   InternalServerErrorException,
                                                   UnauthorizedException,
                                                   ForbiddenException,
                                                   AwsServiceException,
                                                   SdkClientException,
                                                   KafkaException

This is a variant of listClusters(software.amazon.awssdk.services.kafka.model.ListClustersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.kafka.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.kafka.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
     for (software.amazon.awssdk.services.kafka.model.ListClustersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.kafka.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listClusters(software.amazon.awssdk.services.kafka.model.ListClustersRequest) operation.

Parameters:

listClustersRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listClustersPaginator

default ListClustersIterable listClustersPaginator(Consumer<ListClustersRequest.Builder> listClustersRequest)
                                            throws BadRequestException,
                                                   InternalServerErrorException,
                                                   UnauthorizedException,
                                                   ForbiddenException,
                                                   AwsServiceException,
                                                   SdkClientException,
                                                   KafkaException

This is a variant of listClusters(software.amazon.awssdk.services.kafka.model.ListClustersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.kafka.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.kafka.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
     for (software.amazon.awssdk.services.kafka.model.ListClustersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.kafka.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listClusters(software.amazon.awssdk.services.kafka.model.ListClustersRequest) operation.

This is a convenience which creates an instance of the ListClustersRequest.Builder avoiding the need to create one manually via ListClustersRequest.builder()

Parameters:

listClustersRequest - A Consumer that will call methods on ListClustersRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listClustersV2

default ListClustersV2Response listClustersV2(ListClustersV2Request listClustersV2Request)
                                       throws BadRequestException,
                                              InternalServerErrorException,
                                              UnauthorizedException,
                                              ForbiddenException,
                                              AwsServiceException,
                                              SdkClientException,
                                              KafkaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listClustersV2

default ListClustersV2Response listClustersV2(Consumer<ListClustersV2Request.Builder> listClustersV2Request)
                                       throws BadRequestException,
                                              InternalServerErrorException,
                                              UnauthorizedException,
                                              ForbiddenException,
                                              AwsServiceException,
                                              SdkClientException,
                                              KafkaException

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

This is a convenience which creates an instance of the ListClustersV2Request.Builder avoiding the need to create one manually via ListClustersV2Request.builder()

Parameters:

listClustersV2Request - A Consumer that will call methods on ListClustersV2Request.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listClustersV2Paginator

default ListClustersV2Iterable listClustersV2Paginator(ListClustersV2Request listClustersV2Request)
                                                throws BadRequestException,
                                                       InternalServerErrorException,
                                                       UnauthorizedException,
                                                       ForbiddenException,
                                                       AwsServiceException,
                                                       SdkClientException,
                                                       KafkaException

This is a variant of listClustersV2(software.amazon.awssdk.services.kafka.model.ListClustersV2Request) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.kafka.paginators.ListClustersV2Iterable responses = client.listClustersV2Paginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.kafka.paginators.ListClustersV2Iterable responses = client.listClustersV2Paginator(request);
     for (software.amazon.awssdk.services.kafka.model.ListClustersV2Response response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.kafka.paginators.ListClustersV2Iterable responses = client.listClustersV2Paginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listClustersV2(software.amazon.awssdk.services.kafka.model.ListClustersV2Request) operation.

Parameters:

listClustersV2Request -

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listClustersV2Paginator

default ListClustersV2Iterable listClustersV2Paginator(Consumer<ListClustersV2Request.Builder> listClustersV2Request)
                                                throws BadRequestException,
                                                       InternalServerErrorException,
                                                       UnauthorizedException,
                                                       ForbiddenException,
                                                       AwsServiceException,
                                                       SdkClientException,
                                                       KafkaException

This is a variant of listClustersV2(software.amazon.awssdk.services.kafka.model.ListClustersV2Request) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.kafka.paginators.ListClustersV2Iterable responses = client.listClustersV2Paginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.kafka.paginators.ListClustersV2Iterable responses = client.listClustersV2Paginator(request);
     for (software.amazon.awssdk.services.kafka.model.ListClustersV2Response response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.kafka.paginators.ListClustersV2Iterable responses = client.listClustersV2Paginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listClustersV2(software.amazon.awssdk.services.kafka.model.ListClustersV2Request) operation.

This is a convenience which creates an instance of the ListClustersV2Request.Builder avoiding the need to create one manually via ListClustersV2Request.builder()

Parameters:

listClustersV2Request - A Consumer that will call methods on ListClustersV2Request.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listConfigurationRevisions

default ListConfigurationRevisionsResponse listConfigurationRevisions(ListConfigurationRevisionsRequest listConfigurationRevisionsRequest)
                                                               throws BadRequestException,
                                                                      UnauthorizedException,
                                                                      InternalServerErrorException,
                                                                      ForbiddenException,
                                                                      NotFoundException,
                                                                      ServiceUnavailableException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      KafkaException

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listConfigurationRevisions

default ListConfigurationRevisionsResponse listConfigurationRevisions(Consumer<ListConfigurationRevisionsRequest.Builder> listConfigurationRevisionsRequest)
                                                               throws BadRequestException,
                                                                      UnauthorizedException,
                                                                      InternalServerErrorException,
                                                                      ForbiddenException,
                                                                      NotFoundException,
                                                                      ServiceUnavailableException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      KafkaException

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

This is a convenience which creates an instance of the ListConfigurationRevisionsRequest.Builder avoiding the need to create one manually via ListConfigurationRevisionsRequest.builder()

Parameters:

listConfigurationRevisionsRequest - A Consumer that will call methods on ListConfigurationRevisionsRequest.Builder to create a request.

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listConfigurationRevisionsPaginator

default ListConfigurationRevisionsIterable listConfigurationRevisionsPaginator(ListConfigurationRevisionsRequest listConfigurationRevisionsRequest)
                                                                        throws BadRequestException,
                                                                               UnauthorizedException,
                                                                               InternalServerErrorException,
                                                                               ForbiddenException,
                                                                               NotFoundException,
                                                                               ServiceUnavailableException,
                                                                               AwsServiceException,
                                                                               SdkClientException,
                                                                               KafkaException

This is a variant of listConfigurationRevisions(software.amazon.awssdk.services.kafka.model.ListConfigurationRevisionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.kafka.paginators.ListConfigurationRevisionsIterable responses = client.listConfigurationRevisionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.kafka.paginators.ListConfigurationRevisionsIterable responses = client
             .listConfigurationRevisionsPaginator(request);
     for (software.amazon.awssdk.services.kafka.model.ListConfigurationRevisionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.kafka.paginators.ListConfigurationRevisionsIterable responses = client.listConfigurationRevisionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listConfigurationRevisions(software.amazon.awssdk.services.kafka.model.ListConfigurationRevisionsRequest) operation.

Parameters:

listConfigurationRevisionsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listConfigurationRevisionsPaginator

default ListConfigurationRevisionsIterable listConfigurationRevisionsPaginator(Consumer<ListConfigurationRevisionsRequest.Builder> listConfigurationRevisionsRequest)
                                                                        throws BadRequestException,
                                                                               UnauthorizedException,
                                                                               InternalServerErrorException,
                                                                               ForbiddenException,
                                                                               NotFoundException,
                                                                               ServiceUnavailableException,
                                                                               AwsServiceException,
                                                                               SdkClientException,
                                                                               KafkaException

This is a variant of listConfigurationRevisions(software.amazon.awssdk.services.kafka.model.ListConfigurationRevisionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.kafka.paginators.ListConfigurationRevisionsIterable responses = client.listConfigurationRevisionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.kafka.paginators.ListConfigurationRevisionsIterable responses = client
             .listConfigurationRevisionsPaginator(request);
     for (software.amazon.awssdk.services.kafka.model.ListConfigurationRevisionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.kafka.paginators.ListConfigurationRevisionsIterable responses = client.listConfigurationRevisionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listConfigurationRevisions(software.amazon.awssdk.services.kafka.model.ListConfigurationRevisionsRequest) operation.

This is a convenience which creates an instance of the ListConfigurationRevisionsRequest.Builder avoiding the need to create one manually via ListConfigurationRevisionsRequest.builder()

Parameters:

listConfigurationRevisionsRequest - A Consumer that will call methods on ListConfigurationRevisionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listConfigurations

default ListConfigurationsResponse listConfigurations(ListConfigurationsRequest listConfigurationsRequest)
                                               throws ServiceUnavailableException,
                                                      BadRequestException,
                                                      UnauthorizedException,
                                                      InternalServerErrorException,
                                                      ForbiddenException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      KafkaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listConfigurations

default ListConfigurationsResponse listConfigurations(Consumer<ListConfigurationsRequest.Builder> listConfigurationsRequest)
                                               throws ServiceUnavailableException,
                                                      BadRequestException,
                                                      UnauthorizedException,
                                                      InternalServerErrorException,
                                                      ForbiddenException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      KafkaException

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

This is a convenience which creates an instance of the ListConfigurationsRequest.Builder avoiding the need to create one manually via ListConfigurationsRequest.builder()

Parameters:

listConfigurationsRequest - A Consumer that will call methods on ListConfigurationsRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listConfigurationsPaginator

default ListConfigurationsIterable listConfigurationsPaginator(ListConfigurationsRequest listConfigurationsRequest)
                                                        throws ServiceUnavailableException,
                                                               BadRequestException,
                                                               UnauthorizedException,
                                                               InternalServerErrorException,
                                                               ForbiddenException,
                                                               AwsServiceException,
                                                               SdkClientException,
                                                               KafkaException

This is a variant of listConfigurations(software.amazon.awssdk.services.kafka.model.ListConfigurationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.kafka.paginators.ListConfigurationsIterable responses = client.listConfigurationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.kafka.paginators.ListConfigurationsIterable responses = client
             .listConfigurationsPaginator(request);
     for (software.amazon.awssdk.services.kafka.model.ListConfigurationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.kafka.paginators.ListConfigurationsIterable responses = client.listConfigurationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listConfigurations(software.amazon.awssdk.services.kafka.model.ListConfigurationsRequest) operation.

Parameters:

listConfigurationsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listConfigurationsPaginator

default ListConfigurationsIterable listConfigurationsPaginator(Consumer<ListConfigurationsRequest.Builder> listConfigurationsRequest)
                                                        throws ServiceUnavailableException,
                                                               BadRequestException,
                                                               UnauthorizedException,
                                                               InternalServerErrorException,
                                                               ForbiddenException,
                                                               AwsServiceException,
                                                               SdkClientException,
                                                               KafkaException

This is a variant of listConfigurations(software.amazon.awssdk.services.kafka.model.ListConfigurationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.kafka.paginators.ListConfigurationsIterable responses = client.listConfigurationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.kafka.paginators.ListConfigurationsIterable responses = client
             .listConfigurationsPaginator(request);
     for (software.amazon.awssdk.services.kafka.model.ListConfigurationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.kafka.paginators.ListConfigurationsIterable responses = client.listConfigurationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listConfigurations(software.amazon.awssdk.services.kafka.model.ListConfigurationsRequest) operation.

This is a convenience which creates an instance of the ListConfigurationsRequest.Builder avoiding the need to create one manually via ListConfigurationsRequest.builder()

Parameters:

listConfigurationsRequest - A Consumer that will call methods on ListConfigurationsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listKafkaVersions

default ListKafkaVersionsResponse listKafkaVersions(ListKafkaVersionsRequest listKafkaVersionsRequest)
                                             throws BadRequestException,
                                                    UnauthorizedException,
                                                    InternalServerErrorException,
                                                    ForbiddenException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    KafkaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listKafkaVersions

default ListKafkaVersionsResponse listKafkaVersions(Consumer<ListKafkaVersionsRequest.Builder> listKafkaVersionsRequest)
                                             throws BadRequestException,
                                                    UnauthorizedException,
                                                    InternalServerErrorException,
                                                    ForbiddenException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    KafkaException

Returns a list of Apache Kafka versions.

This is a convenience which creates an instance of the ListKafkaVersionsRequest.Builder avoiding the need to create one manually via ListKafkaVersionsRequest.builder()

Parameters:

listKafkaVersionsRequest - A Consumer that will call methods on ListKafkaVersionsRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listKafkaVersionsPaginator

default ListKafkaVersionsIterable listKafkaVersionsPaginator(ListKafkaVersionsRequest listKafkaVersionsRequest)
                                                      throws BadRequestException,
                                                             UnauthorizedException,
                                                             InternalServerErrorException,
                                                             ForbiddenException,
                                                             AwsServiceException,
                                                             SdkClientException,
                                                             KafkaException

This is a variant of listKafkaVersions(software.amazon.awssdk.services.kafka.model.ListKafkaVersionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.kafka.paginators.ListKafkaVersionsIterable responses = client.listKafkaVersionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.kafka.paginators.ListKafkaVersionsIterable responses = client
             .listKafkaVersionsPaginator(request);
     for (software.amazon.awssdk.services.kafka.model.ListKafkaVersionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.kafka.paginators.ListKafkaVersionsIterable responses = client.listKafkaVersionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listKafkaVersions(software.amazon.awssdk.services.kafka.model.ListKafkaVersionsRequest) operation.

Parameters:

listKafkaVersionsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listKafkaVersionsPaginator

default ListKafkaVersionsIterable listKafkaVersionsPaginator(Consumer<ListKafkaVersionsRequest.Builder> listKafkaVersionsRequest)
                                                      throws BadRequestException,
                                                             UnauthorizedException,
                                                             InternalServerErrorException,
                                                             ForbiddenException,
                                                             AwsServiceException,
                                                             SdkClientException,
                                                             KafkaException

This is a variant of listKafkaVersions(software.amazon.awssdk.services.kafka.model.ListKafkaVersionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.kafka.paginators.ListKafkaVersionsIterable responses = client.listKafkaVersionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.kafka.paginators.ListKafkaVersionsIterable responses = client
             .listKafkaVersionsPaginator(request);
     for (software.amazon.awssdk.services.kafka.model.ListKafkaVersionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.kafka.paginators.ListKafkaVersionsIterable responses = client.listKafkaVersionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listKafkaVersions(software.amazon.awssdk.services.kafka.model.ListKafkaVersionsRequest) operation.

This is a convenience which creates an instance of the ListKafkaVersionsRequest.Builder avoiding the need to create one manually via ListKafkaVersionsRequest.builder()

Parameters:

listKafkaVersionsRequest - A Consumer that will call methods on ListKafkaVersionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listNodes

default ListNodesResponse listNodes(ListNodesRequest listNodesRequest)
                             throws NotFoundException,
                                    BadRequestException,
                                    InternalServerErrorException,
                                    ForbiddenException,
                                    AwsServiceException,
                                    SdkClientException,
                                    KafkaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listNodes

default ListNodesResponse listNodes(Consumer<ListNodesRequest.Builder> listNodesRequest)
                             throws NotFoundException,
                                    BadRequestException,
                                    InternalServerErrorException,
                                    ForbiddenException,
                                    AwsServiceException,
                                    SdkClientException,
                                    KafkaException

Returns a list of the broker nodes in the cluster.

This is a convenience which creates an instance of the ListNodesRequest.Builder avoiding the need to create one manually via ListNodesRequest.builder()

Parameters:

listNodesRequest - A Consumer that will call methods on ListNodesRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listNodesPaginator

default ListNodesIterable listNodesPaginator(ListNodesRequest listNodesRequest)
                                      throws NotFoundException,
                                             BadRequestException,
                                             InternalServerErrorException,
                                             ForbiddenException,
                                             AwsServiceException,
                                             SdkClientException,
                                             KafkaException

This is a variant of listNodes(software.amazon.awssdk.services.kafka.model.ListNodesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.kafka.paginators.ListNodesIterable responses = client.listNodesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.kafka.paginators.ListNodesIterable responses = client.listNodesPaginator(request);
     for (software.amazon.awssdk.services.kafka.model.ListNodesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.kafka.paginators.ListNodesIterable responses = client.listNodesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listNodes(software.amazon.awssdk.services.kafka.model.ListNodesRequest) operation.

Parameters:

listNodesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listNodesPaginator

default ListNodesIterable listNodesPaginator(Consumer<ListNodesRequest.Builder> listNodesRequest)
                                      throws NotFoundException,
                                             BadRequestException,
                                             InternalServerErrorException,
                                             ForbiddenException,
                                             AwsServiceException,
                                             SdkClientException,
                                             KafkaException

This is a variant of listNodes(software.amazon.awssdk.services.kafka.model.ListNodesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.kafka.paginators.ListNodesIterable responses = client.listNodesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.kafka.paginators.ListNodesIterable responses = client.listNodesPaginator(request);
     for (software.amazon.awssdk.services.kafka.model.ListNodesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.kafka.paginators.ListNodesIterable responses = client.listNodesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listNodes(software.amazon.awssdk.services.kafka.model.ListNodesRequest) operation.

This is a convenience which creates an instance of the ListNodesRequest.Builder avoiding the need to create one manually via ListNodesRequest.builder()

Parameters:

listNodesRequest - A Consumer that will call methods on ListNodesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listReplicators

default ListReplicatorsResponse listReplicators(ListReplicatorsRequest listReplicatorsRequest)
                                         throws BadRequestException,
                                                UnauthorizedException,
                                                InternalServerErrorException,
                                                ForbiddenException,
                                                NotFoundException,
                                                ServiceUnavailableException,
                                                TooManyRequestsException,
                                                AwsServiceException,
                                                SdkClientException,
                                                KafkaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listReplicators

default ListReplicatorsResponse listReplicators(Consumer<ListReplicatorsRequest.Builder> listReplicatorsRequest)
                                         throws BadRequestException,
                                                UnauthorizedException,
                                                InternalServerErrorException,
                                                ForbiddenException,
                                                NotFoundException,
                                                ServiceUnavailableException,
                                                TooManyRequestsException,
                                                AwsServiceException,
                                                SdkClientException,
                                                KafkaException

Lists the replicators.

This is a convenience which creates an instance of the ListReplicatorsRequest.Builder avoiding the need to create one manually via ListReplicatorsRequest.builder()

Parameters:

listReplicatorsRequest - A Consumer that will call methods on ListReplicatorsRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listReplicatorsPaginator

default ListReplicatorsIterable listReplicatorsPaginator(ListReplicatorsRequest listReplicatorsRequest)
                                                  throws BadRequestException,
                                                         UnauthorizedException,
                                                         InternalServerErrorException,
                                                         ForbiddenException,
                                                         NotFoundException,
                                                         ServiceUnavailableException,
                                                         TooManyRequestsException,
                                                         AwsServiceException,
                                                         SdkClientException,
                                                         KafkaException

This is a variant of listReplicators(software.amazon.awssdk.services.kafka.model.ListReplicatorsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.kafka.paginators.ListReplicatorsIterable responses = client.listReplicatorsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.kafka.paginators.ListReplicatorsIterable responses = client.listReplicatorsPaginator(request);
     for (software.amazon.awssdk.services.kafka.model.ListReplicatorsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.kafka.paginators.ListReplicatorsIterable responses = client.listReplicatorsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listReplicators(software.amazon.awssdk.services.kafka.model.ListReplicatorsRequest) operation.

Parameters:

listReplicatorsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listReplicatorsPaginator

default ListReplicatorsIterable listReplicatorsPaginator(Consumer<ListReplicatorsRequest.Builder> listReplicatorsRequest)
                                                  throws BadRequestException,
                                                         UnauthorizedException,
                                                         InternalServerErrorException,
                                                         ForbiddenException,
                                                         NotFoundException,
                                                         ServiceUnavailableException,
                                                         TooManyRequestsException,
                                                         AwsServiceException,
                                                         SdkClientException,
                                                         KafkaException

This is a variant of listReplicators(software.amazon.awssdk.services.kafka.model.ListReplicatorsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.kafka.paginators.ListReplicatorsIterable responses = client.listReplicatorsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.kafka.paginators.ListReplicatorsIterable responses = client.listReplicatorsPaginator(request);
     for (software.amazon.awssdk.services.kafka.model.ListReplicatorsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.kafka.paginators.ListReplicatorsIterable responses = client.listReplicatorsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listReplicators(software.amazon.awssdk.services.kafka.model.ListReplicatorsRequest) operation.

This is a convenience which creates an instance of the ListReplicatorsRequest.Builder avoiding the need to create one manually via ListReplicatorsRequest.builder()

Parameters:

listReplicatorsRequest - A Consumer that will call methods on ListReplicatorsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listScramSecrets

default ListScramSecretsResponse listScramSecrets(ListScramSecretsRequest listScramSecretsRequest)
                                           throws BadRequestException,
                                                  UnauthorizedException,
                                                  InternalServerErrorException,
                                                  ForbiddenException,
                                                  NotFoundException,
                                                  ServiceUnavailableException,
                                                  TooManyRequestsException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  KafkaException

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listScramSecrets

default ListScramSecretsResponse listScramSecrets(Consumer<ListScramSecretsRequest.Builder> listScramSecretsRequest)
                                           throws BadRequestException,
                                                  UnauthorizedException,
                                                  InternalServerErrorException,
                                                  ForbiddenException,
                                                  NotFoundException,
                                                  ServiceUnavailableException,
                                                  TooManyRequestsException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  KafkaException

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

This is a convenience which creates an instance of the ListScramSecretsRequest.Builder avoiding the need to create one manually via ListScramSecretsRequest.builder()

Parameters:

listScramSecretsRequest - A Consumer that will call methods on ListScramSecretsRequest.Builder to create a request.

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listScramSecretsPaginator

default ListScramSecretsIterable listScramSecretsPaginator(ListScramSecretsRequest listScramSecretsRequest)
                                                    throws BadRequestException,
                                                           UnauthorizedException,
                                                           InternalServerErrorException,
                                                           ForbiddenException,
                                                           NotFoundException,
                                                           ServiceUnavailableException,
                                                           TooManyRequestsException,
                                                           AwsServiceException,
                                                           SdkClientException,
                                                           KafkaException

This is a variant of listScramSecrets(software.amazon.awssdk.services.kafka.model.ListScramSecretsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.kafka.paginators.ListScramSecretsIterable responses = client.listScramSecretsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.kafka.paginators.ListScramSecretsIterable responses = client
             .listScramSecretsPaginator(request);
     for (software.amazon.awssdk.services.kafka.model.ListScramSecretsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.kafka.paginators.ListScramSecretsIterable responses = client.listScramSecretsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listScramSecrets(software.amazon.awssdk.services.kafka.model.ListScramSecretsRequest) operation.

Parameters:

listScramSecretsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listScramSecretsPaginator

default ListScramSecretsIterable listScramSecretsPaginator(Consumer<ListScramSecretsRequest.Builder> listScramSecretsRequest)
                                                    throws BadRequestException,
                                                           UnauthorizedException,
                                                           InternalServerErrorException,
                                                           ForbiddenException,
                                                           NotFoundException,
                                                           ServiceUnavailableException,
                                                           TooManyRequestsException,
                                                           AwsServiceException,
                                                           SdkClientException,
                                                           KafkaException

This is a variant of listScramSecrets(software.amazon.awssdk.services.kafka.model.ListScramSecretsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.kafka.paginators.ListScramSecretsIterable responses = client.listScramSecretsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.kafka.paginators.ListScramSecretsIterable responses = client
             .listScramSecretsPaginator(request);
     for (software.amazon.awssdk.services.kafka.model.ListScramSecretsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.kafka.paginators.ListScramSecretsIterable responses = client.listScramSecretsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listScramSecrets(software.amazon.awssdk.services.kafka.model.ListScramSecretsRequest) operation.

This is a convenience which creates an instance of the ListScramSecretsRequest.Builder avoiding the need to create one manually via ListScramSecretsRequest.builder()

Parameters:

listScramSecretsRequest - A Consumer that will call methods on ListScramSecretsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws NotFoundException,
                                                        BadRequestException,
                                                        InternalServerErrorException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        KafkaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws NotFoundException,
                                                        BadRequestException,
                                                        InternalServerErrorException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        KafkaException

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

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listVpcConnections

default ListVpcConnectionsResponse listVpcConnections(ListVpcConnectionsRequest listVpcConnectionsRequest)
                                               throws ServiceUnavailableException,
                                                      BadRequestException,
                                                      UnauthorizedException,
                                                      InternalServerErrorException,
                                                      ForbiddenException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      KafkaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listVpcConnections

default ListVpcConnectionsResponse listVpcConnections(Consumer<ListVpcConnectionsRequest.Builder> listVpcConnectionsRequest)
                                               throws ServiceUnavailableException,
                                                      BadRequestException,
                                                      UnauthorizedException,
                                                      InternalServerErrorException,
                                                      ForbiddenException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      KafkaException

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

This is a convenience which creates an instance of the ListVpcConnectionsRequest.Builder avoiding the need to create one manually via ListVpcConnectionsRequest.builder()

Parameters:

listVpcConnectionsRequest - A Consumer that will call methods on ListVpcConnectionsRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listVpcConnectionsPaginator

default ListVpcConnectionsIterable listVpcConnectionsPaginator(ListVpcConnectionsRequest listVpcConnectionsRequest)
                                                        throws ServiceUnavailableException,
                                                               BadRequestException,
                                                               UnauthorizedException,
                                                               InternalServerErrorException,
                                                               ForbiddenException,
                                                               AwsServiceException,
                                                               SdkClientException,
                                                               KafkaException

This is a variant of listVpcConnections(software.amazon.awssdk.services.kafka.model.ListVpcConnectionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.kafka.paginators.ListVpcConnectionsIterable responses = client.listVpcConnectionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.kafka.paginators.ListVpcConnectionsIterable responses = client
             .listVpcConnectionsPaginator(request);
     for (software.amazon.awssdk.services.kafka.model.ListVpcConnectionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.kafka.paginators.ListVpcConnectionsIterable responses = client.listVpcConnectionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listVpcConnections(software.amazon.awssdk.services.kafka.model.ListVpcConnectionsRequest) operation.

Parameters:

listVpcConnectionsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listVpcConnectionsPaginator

default ListVpcConnectionsIterable listVpcConnectionsPaginator(Consumer<ListVpcConnectionsRequest.Builder> listVpcConnectionsRequest)
                                                        throws ServiceUnavailableException,
                                                               BadRequestException,
                                                               UnauthorizedException,
                                                               InternalServerErrorException,
                                                               ForbiddenException,
                                                               AwsServiceException,
                                                               SdkClientException,
                                                               KafkaException

This is a variant of listVpcConnections(software.amazon.awssdk.services.kafka.model.ListVpcConnectionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.kafka.paginators.ListVpcConnectionsIterable responses = client.listVpcConnectionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.kafka.paginators.ListVpcConnectionsIterable responses = client
             .listVpcConnectionsPaginator(request);
     for (software.amazon.awssdk.services.kafka.model.ListVpcConnectionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.kafka.paginators.ListVpcConnectionsIterable responses = client.listVpcConnectionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listVpcConnections(software.amazon.awssdk.services.kafka.model.ListVpcConnectionsRequest) operation.

This is a convenience which creates an instance of the ListVpcConnectionsRequest.Builder avoiding the need to create one manually via ListVpcConnectionsRequest.builder()

Parameters:

listVpcConnectionsRequest - A Consumer that will call methods on ListVpcConnectionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

putClusterPolicy

default PutClusterPolicyResponse putClusterPolicy(PutClusterPolicyRequest putClusterPolicyRequest)
                                           throws BadRequestException,
                                                  InternalServerErrorException,
                                                  ForbiddenException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  KafkaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

putClusterPolicy

default PutClusterPolicyResponse putClusterPolicy(Consumer<PutClusterPolicyRequest.Builder> putClusterPolicyRequest)
                                           throws BadRequestException,
                                                  InternalServerErrorException,
                                                  ForbiddenException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  KafkaException

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

This is a convenience which creates an instance of the PutClusterPolicyRequest.Builder avoiding the need to create one manually via PutClusterPolicyRequest.builder()

Parameters:

putClusterPolicyRequest - A Consumer that will call methods on PutClusterPolicyRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

rebootBroker

default RebootBrokerResponse rebootBroker(RebootBrokerRequest rebootBrokerRequest)
                                   throws BadRequestException,
                                          UnauthorizedException,
                                          InternalServerErrorException,
                                          ForbiddenException,
                                          NotFoundException,
                                          ServiceUnavailableException,
                                          TooManyRequestsException,
                                          AwsServiceException,
                                          SdkClientException,
                                          KafkaException

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

rebootBroker

default RebootBrokerResponse rebootBroker(Consumer<RebootBrokerRequest.Builder> rebootBrokerRequest)
                                   throws BadRequestException,
                                          UnauthorizedException,
                                          InternalServerErrorException,
                                          ForbiddenException,
                                          NotFoundException,
                                          ServiceUnavailableException,
                                          TooManyRequestsException,
                                          AwsServiceException,
                                          SdkClientException,
                                          KafkaException

Reboots brokers.

This is a convenience which creates an instance of the RebootBrokerRequest.Builder avoiding the need to create one manually via RebootBrokerRequest.builder()

Parameters:

rebootBrokerRequest - A Consumer that will call methods on RebootBrokerRequest.Builder to create a request. 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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

rejectClientVpcConnection

default RejectClientVpcConnectionResponse rejectClientVpcConnection(RejectClientVpcConnectionRequest rejectClientVpcConnectionRequest)
                                                             throws ServiceUnavailableException,
                                                                    BadRequestException,
                                                                    UnauthorizedException,
                                                                    InternalServerErrorException,
                                                                    ForbiddenException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    KafkaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

rejectClientVpcConnection

default RejectClientVpcConnectionResponse rejectClientVpcConnection(Consumer<RejectClientVpcConnectionRequest.Builder> rejectClientVpcConnectionRequest)
                                                             throws ServiceUnavailableException,
                                                                    BadRequestException,
                                                                    UnauthorizedException,
                                                                    InternalServerErrorException,
                                                                    ForbiddenException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    KafkaException

Returns empty response.

This is a convenience which creates an instance of the RejectClientVpcConnectionRequest.Builder avoiding the need to create one manually via RejectClientVpcConnectionRequest.builder()

Parameters:

rejectClientVpcConnectionRequest - A Consumer that will call methods on RejectClientVpcConnectionRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws NotFoundException,
                                        BadRequestException,
                                        InternalServerErrorException,
                                        AwsServiceException,
                                        SdkClientException,
                                        KafkaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws NotFoundException,
                                        BadRequestException,
                                        InternalServerErrorException,
                                        AwsServiceException,
                                        SdkClientException,
                                        KafkaException

Adds tags to the specified MSK resource.

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws NotFoundException,
                                            BadRequestException,
                                            InternalServerErrorException,
                                            AwsServiceException,
                                            SdkClientException,
                                            KafkaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws NotFoundException,
                                            BadRequestException,
                                            InternalServerErrorException,
                                            AwsServiceException,
                                            SdkClientException,
                                            KafkaException

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

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateBrokerCount

default UpdateBrokerCountResponse updateBrokerCount(UpdateBrokerCountRequest updateBrokerCountRequest)
                                             throws ServiceUnavailableException,
                                                    BadRequestException,
                                                    UnauthorizedException,
                                                    InternalServerErrorException,
                                                    ForbiddenException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    KafkaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateBrokerCount

default UpdateBrokerCountResponse updateBrokerCount(Consumer<UpdateBrokerCountRequest.Builder> updateBrokerCountRequest)
                                             throws ServiceUnavailableException,
                                                    BadRequestException,
                                                    UnauthorizedException,
                                                    InternalServerErrorException,
                                                    ForbiddenException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    KafkaException

Updates the number of broker nodes in the cluster.

This is a convenience which creates an instance of the UpdateBrokerCountRequest.Builder avoiding the need to create one manually via UpdateBrokerCountRequest.builder()

Parameters:

updateBrokerCountRequest - A Consumer that will call methods on UpdateBrokerCountRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateBrokerStorage

default UpdateBrokerStorageResponse updateBrokerStorage(UpdateBrokerStorageRequest updateBrokerStorageRequest)
                                                 throws ServiceUnavailableException,
                                                        BadRequestException,
                                                        UnauthorizedException,
                                                        InternalServerErrorException,
                                                        ForbiddenException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        KafkaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateBrokerStorage

default UpdateBrokerStorageResponse updateBrokerStorage(Consumer<UpdateBrokerStorageRequest.Builder> updateBrokerStorageRequest)
                                                 throws ServiceUnavailableException,
                                                        BadRequestException,
                                                        UnauthorizedException,
                                                        InternalServerErrorException,
                                                        ForbiddenException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        KafkaException

Updates the EBS storage associated with MSK brokers.

This is a convenience which creates an instance of the UpdateBrokerStorageRequest.Builder avoiding the need to create one manually via UpdateBrokerStorageRequest.builder()

Parameters:

updateBrokerStorageRequest - A Consumer that will call methods on UpdateBrokerStorageRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateBrokerType

default UpdateBrokerTypeResponse updateBrokerType(UpdateBrokerTypeRequest updateBrokerTypeRequest)
                                           throws BadRequestException,
                                                  UnauthorizedException,
                                                  InternalServerErrorException,
                                                  ForbiddenException,
                                                  NotFoundException,
                                                  ServiceUnavailableException,
                                                  TooManyRequestsException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  KafkaException

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateBrokerType

default UpdateBrokerTypeResponse updateBrokerType(Consumer<UpdateBrokerTypeRequest.Builder> updateBrokerTypeRequest)
                                           throws BadRequestException,
                                                  UnauthorizedException,
                                                  InternalServerErrorException,
                                                  ForbiddenException,
                                                  NotFoundException,
                                                  ServiceUnavailableException,
                                                  TooManyRequestsException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  KafkaException

Updates EC2 instance type.

This is a convenience which creates an instance of the UpdateBrokerTypeRequest.Builder avoiding the need to create one manually via UpdateBrokerTypeRequest.builder()

Parameters:

updateBrokerTypeRequest - A Consumer that will call methods on UpdateBrokerTypeRequest.Builder to create a request.

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateClusterConfiguration

default UpdateClusterConfigurationResponse updateClusterConfiguration(UpdateClusterConfigurationRequest updateClusterConfigurationRequest)
                                                               throws BadRequestException,
                                                                      UnauthorizedException,
                                                                      InternalServerErrorException,
                                                                      ForbiddenException,
                                                                      NotFoundException,
                                                                      ServiceUnavailableException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      KafkaException

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateClusterConfiguration

default UpdateClusterConfigurationResponse updateClusterConfiguration(Consumer<UpdateClusterConfigurationRequest.Builder> updateClusterConfigurationRequest)
                                                               throws BadRequestException,
                                                                      UnauthorizedException,
                                                                      InternalServerErrorException,
                                                                      ForbiddenException,
                                                                      NotFoundException,
                                                                      ServiceUnavailableException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      KafkaException

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

This is a convenience which creates an instance of the UpdateClusterConfigurationRequest.Builder avoiding the need to create one manually via UpdateClusterConfigurationRequest.builder()

Parameters:

updateClusterConfigurationRequest - A Consumer that will call methods on UpdateClusterConfigurationRequest.Builder to create a request.

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateClusterKafkaVersion

default UpdateClusterKafkaVersionResponse updateClusterKafkaVersion(UpdateClusterKafkaVersionRequest updateClusterKafkaVersionRequest)
                                                             throws BadRequestException,
                                                                    UnauthorizedException,
                                                                    InternalServerErrorException,
                                                                    ForbiddenException,
                                                                    NotFoundException,
                                                                    ServiceUnavailableException,
                                                                    TooManyRequestsException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    KafkaException

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateClusterKafkaVersion

default UpdateClusterKafkaVersionResponse updateClusterKafkaVersion(Consumer<UpdateClusterKafkaVersionRequest.Builder> updateClusterKafkaVersionRequest)
                                                             throws BadRequestException,
                                                                    UnauthorizedException,
                                                                    InternalServerErrorException,
                                                                    ForbiddenException,
                                                                    NotFoundException,
                                                                    ServiceUnavailableException,
                                                                    TooManyRequestsException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    KafkaException

Updates the Apache Kafka version for the cluster.

This is a convenience which creates an instance of the UpdateClusterKafkaVersionRequest.Builder avoiding the need to create one manually via UpdateClusterKafkaVersionRequest.builder()

Parameters:

updateClusterKafkaVersionRequest - A Consumer that will call methods on UpdateClusterKafkaVersionRequest.Builder to create a request.

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateConfiguration

default UpdateConfigurationResponse updateConfiguration(UpdateConfigurationRequest updateConfigurationRequest)
                                                 throws BadRequestException,
                                                        UnauthorizedException,
                                                        InternalServerErrorException,
                                                        ForbiddenException,
                                                        NotFoundException,
                                                        ServiceUnavailableException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        KafkaException

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateConfiguration

default UpdateConfigurationResponse updateConfiguration(Consumer<UpdateConfigurationRequest.Builder> updateConfigurationRequest)
                                                 throws BadRequestException,
                                                        UnauthorizedException,
                                                        InternalServerErrorException,
                                                        ForbiddenException,
                                                        NotFoundException,
                                                        ServiceUnavailableException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        KafkaException

Updates an MSK configuration.

This is a convenience which creates an instance of the UpdateConfigurationRequest.Builder avoiding the need to create one manually via UpdateConfigurationRequest.builder()

Parameters:

updateConfigurationRequest - A Consumer that will call methods on UpdateConfigurationRequest.Builder to create a request.

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateConnectivity

default UpdateConnectivityResponse updateConnectivity(UpdateConnectivityRequest updateConnectivityRequest)
                                               throws BadRequestException,
                                                      UnauthorizedException,
                                                      InternalServerErrorException,
                                                      ForbiddenException,
                                                      NotFoundException,
                                                      ServiceUnavailableException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      KafkaException

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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateConnectivity

default UpdateConnectivityResponse updateConnectivity(Consumer<UpdateConnectivityRequest.Builder> updateConnectivityRequest)
                                               throws BadRequestException,
                                                      UnauthorizedException,
                                                      InternalServerErrorException,
                                                      ForbiddenException,
                                                      NotFoundException,
                                                      ServiceUnavailableException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      KafkaException

Updates the cluster's connectivity configuration.

This is a convenience which creates an instance of the UpdateConnectivityRequest.Builder avoiding the need to create one manually via UpdateConnectivityRequest.builder()

Parameters:

updateConnectivityRequest - A Consumer that will call methods on UpdateConnectivityRequest.Builder to create a request. 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

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateMonitoring

default UpdateMonitoringResponse updateMonitoring(UpdateMonitoringRequest updateMonitoringRequest)
                                           throws ServiceUnavailableException,
                                                  BadRequestException,
                                                  UnauthorizedException,
                                                  InternalServerErrorException,
                                                  ForbiddenException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  KafkaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateMonitoring

default UpdateMonitoringResponse updateMonitoring(Consumer<UpdateMonitoringRequest.Builder> updateMonitoringRequest)
                                           throws ServiceUnavailableException,
                                                  BadRequestException,
                                                  UnauthorizedException,
                                                  InternalServerErrorException,
                                                  ForbiddenException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  KafkaException

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.

This is a convenience which creates an instance of the UpdateMonitoringRequest.Builder avoiding the need to create one manually via UpdateMonitoringRequest.builder()

Parameters:

updateMonitoringRequest - A Consumer that will call methods on UpdateMonitoringRequest.Builder to create a request. 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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateReplicationInfo

default UpdateReplicationInfoResponse updateReplicationInfo(UpdateReplicationInfoRequest updateReplicationInfoRequest)
                                                     throws BadRequestException,
                                                            UnauthorizedException,
                                                            InternalServerErrorException,
                                                            ForbiddenException,
                                                            NotFoundException,
                                                            ServiceUnavailableException,
                                                            TooManyRequestsException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            KafkaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateReplicationInfo

default UpdateReplicationInfoResponse updateReplicationInfo(Consumer<UpdateReplicationInfoRequest.Builder> updateReplicationInfoRequest)
                                                     throws BadRequestException,
                                                            UnauthorizedException,
                                                            InternalServerErrorException,
                                                            ForbiddenException,
                                                            NotFoundException,
                                                            ServiceUnavailableException,
                                                            TooManyRequestsException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            KafkaException

Updates replication info of a replicator.

This is a convenience which creates an instance of the UpdateReplicationInfoRequest.Builder avoiding the need to create one manually via UpdateReplicationInfoRequest.builder()

Parameters:

updateReplicationInfoRequest - A Consumer that will call methods on UpdateReplicationInfoRequest.Builder to create a request. 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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateSecurity

default UpdateSecurityResponse updateSecurity(UpdateSecurityRequest updateSecurityRequest)
                                       throws BadRequestException,
                                              UnauthorizedException,
                                              InternalServerErrorException,
                                              ForbiddenException,
                                              NotFoundException,
                                              ServiceUnavailableException,
                                              TooManyRequestsException,
                                              AwsServiceException,
                                              SdkClientException,
                                              KafkaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateSecurity

default UpdateSecurityResponse updateSecurity(Consumer<UpdateSecurityRequest.Builder> updateSecurityRequest)
                                       throws BadRequestException,
                                              UnauthorizedException,
                                              InternalServerErrorException,
                                              ForbiddenException,
                                              NotFoundException,
                                              ServiceUnavailableException,
                                              TooManyRequestsException,
                                              AwsServiceException,
                                              SdkClientException,
                                              KafkaException

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

This is a convenience which creates an instance of the UpdateSecurityRequest.Builder avoiding the need to create one manually via UpdateSecurityRequest.builder()

Parameters:

updateSecurityRequest - A Consumer that will call methods on UpdateSecurityRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateStorage

default UpdateStorageResponse updateStorage(UpdateStorageRequest updateStorageRequest)
                                     throws BadRequestException,
                                            UnauthorizedException,
                                            InternalServerErrorException,
                                            ForbiddenException,
                                            NotFoundException,
                                            ServiceUnavailableException,
                                            TooManyRequestsException,
                                            AwsServiceException,
                                            SdkClientException,
                                            KafkaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateStorage

default UpdateStorageResponse updateStorage(Consumer<UpdateStorageRequest.Builder> updateStorageRequest)
                                     throws BadRequestException,
                                            UnauthorizedException,
                                            InternalServerErrorException,
                                            ForbiddenException,
                                            NotFoundException,
                                            ServiceUnavailableException,
                                            TooManyRequestsException,
                                            AwsServiceException,
                                            SdkClientException,
                                            KafkaException

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

This is a convenience which creates an instance of the UpdateStorageRequest.Builder avoiding the need to create one manually via UpdateStorageRequest.builder()

Parameters:

updateStorageRequest - A Consumer that will call methods on UpdateStorageRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

KafkaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

create

static KafkaClient create()

Create a KafkaClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static KafkaClientBuilder builder()

Create a builder that can be used to configure and create a KafkaClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default KafkaServiceClientConfiguration serviceClientConfiguration()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient