AWSKafka (AWS SDK for Java

All Known Subinterfaces:

AWSKafkaAsync

All Known Implementing Classes:

AbstractAWSKafka, AbstractAWSKafkaAsync, AWSKafkaAsyncClient, AWSKafkaClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSKafka
```
Interface for accessing Kafka.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSKafka instead.

The operations for managing an Amazon MSK cluster.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`BatchAssociateScramSecretResult`	`batchAssociateScramSecret(BatchAssociateScramSecretRequest batchAssociateScramSecretRequest)` Associates one or more Scram Secrets with an Amazon MSK cluster.
`BatchDisassociateScramSecretResult`	`batchDisassociateScramSecret(BatchDisassociateScramSecretRequest batchDisassociateScramSecretRequest)` Disassociates one or more Scram Secrets from an Amazon MSK cluster.
`CreateClusterResult`	`createCluster(CreateClusterRequest createClusterRequest)` Creates a new MSK cluster.
`CreateClusterV2Result`	`createClusterV2(CreateClusterV2Request createClusterV2Request)` Creates a new MSK cluster.
`CreateConfigurationResult`	`createConfiguration(CreateConfigurationRequest createConfigurationRequest)` Creates a new MSK configuration.
`DeleteClusterResult`	`deleteCluster(DeleteClusterRequest deleteClusterRequest)` Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.
`DeleteConfigurationResult`	`deleteConfiguration(DeleteConfigurationRequest deleteConfigurationRequest)` Deletes an MSK Configuration.
`DescribeClusterResult`	`describeCluster(DescribeClusterRequest describeClusterRequest)` Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
`DescribeClusterOperationResult`	`describeClusterOperation(DescribeClusterOperationRequest describeClusterOperationRequest)` Returns a description of the cluster operation specified by the ARN.
`DescribeClusterV2Result`	`describeClusterV2(DescribeClusterV2Request describeClusterV2Request)` Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
`DescribeConfigurationResult`	`describeConfiguration(DescribeConfigurationRequest describeConfigurationRequest)` Returns a description of this MSK configuration.
`DescribeConfigurationRevisionResult`	`describeConfigurationRevision(DescribeConfigurationRevisionRequest describeConfigurationRevisionRequest)` Returns a description of this revision of the configuration.
`GetBootstrapBrokersResult`	`getBootstrapBrokers(GetBootstrapBrokersRequest getBootstrapBrokersRequest)` A list of brokers that a client application can use to bootstrap.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetCompatibleKafkaVersionsResult`	`getCompatibleKafkaVersions(GetCompatibleKafkaVersionsRequest getCompatibleKafkaVersionsRequest)` Gets the Apache Kafka versions to which you can update the MSK cluster.
`ListClusterOperationsResult`	`listClusterOperations(ListClusterOperationsRequest listClusterOperationsRequest)` Returns a list of all the operations that have been performed on the specified MSK cluster.
`ListClustersResult`	`listClusters(ListClustersRequest listClustersRequest)` Returns a list of all the MSK clusters in the current Region.
`ListClustersV2Result`	`listClustersV2(ListClustersV2Request listClustersV2Request)` Returns a list of all the MSK clusters in the current Region.
`ListConfigurationRevisionsResult`	`listConfigurationRevisions(ListConfigurationRevisionsRequest listConfigurationRevisionsRequest)` Returns a list of all the MSK configurations in this Region.
`ListConfigurationsResult`	`listConfigurations(ListConfigurationsRequest listConfigurationsRequest)` Returns a list of all the MSK configurations in this Region.
`ListKafkaVersionsResult`	`listKafkaVersions(ListKafkaVersionsRequest listKafkaVersionsRequest)` Returns a list of Apache Kafka versions.
`ListNodesResult`	`listNodes(ListNodesRequest listNodesRequest)` Returns a list of the broker nodes in the cluster.
`ListScramSecretsResult`	`listScramSecrets(ListScramSecretsRequest listScramSecretsRequest)` Returns a list of the Scram Secrets associated with an Amazon MSK cluster.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` Returns a list of the tags associated with the specified resource.
`RebootBrokerResult`	`rebootBroker(RebootBrokerRequest rebootBrokerRequest)` Reboots brokers.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource(TagResourceRequest tagResourceRequest)` Adds tags to the specified MSK resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest untagResourceRequest)` Removes the tags associated with the keys that are provided in the query.
`UpdateBrokerCountResult`	`updateBrokerCount(UpdateBrokerCountRequest updateBrokerCountRequest)` Updates the number of broker nodes in the cluster.
`UpdateBrokerStorageResult`	`updateBrokerStorage(UpdateBrokerStorageRequest updateBrokerStorageRequest)` Updates the EBS storage associated with MSK brokers.
`UpdateBrokerTypeResult`	`updateBrokerType(UpdateBrokerTypeRequest updateBrokerTypeRequest)` Updates EC2 instance type.
`UpdateClusterConfigurationResult`	`updateClusterConfiguration(UpdateClusterConfigurationRequest updateClusterConfigurationRequest)` Updates the cluster with the configuration that is specified in the request body.
`UpdateClusterKafkaVersionResult`	`updateClusterKafkaVersion(UpdateClusterKafkaVersionRequest updateClusterKafkaVersionRequest)` Updates the Apache Kafka version for the cluster.
`UpdateConfigurationResult`	`updateConfiguration(UpdateConfigurationRequest updateConfigurationRequest)` Updates an MSK configuration.
`UpdateConnectivityResult`	`updateConnectivity(UpdateConnectivityRequest updateConnectivityRequest)` Updates the cluster's connectivity configuration.
`UpdateMonitoringResult`	`updateMonitoring(UpdateMonitoringRequest updateMonitoringRequest)` Updates the monitoring settings for the cluster.
`UpdateSecurityResult`	`updateSecurity(UpdateSecurityRequest updateSecurityRequest)` Updates the security settings for the cluster.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - batchAssociateScramSecret
```
BatchAssociateScramSecretResult batchAssociateScramSecret(BatchAssociateScramSecretRequest batchAssociateScramSecretRequest)
```
    Associates one or more Scram Secrets with an Amazon MSK cluster.
    
    Parameters:
    
    batchAssociateScramSecretRequest -
    Associates sasl scram secrets to cluster.
    
    Returns:
    
    Result of the BatchAssociateScramSecret operation returned by the service.
    
    Throws:
    
    BadRequestException -
    The request isn't valid because the input is incorrect. Correct your input and then submit it again.
    
    UnauthorizedException -
    The request is not authorized. The provided credentials couldn't be validated.
    
    InternalServerErrorException -
    There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException -
    Access forbidden. Check your credentials and then retry your request.
    
    NotFoundException -
    The resource could not be found due to incorrect input. Correct the input, then retry the request.
    
    ServiceUnavailableException -
    503 response
    
    TooManyRequestsException -
    429 response
    
    See Also:
    
    AWS API Documentation
  - batchDisassociateScramSecret
```
BatchDisassociateScramSecretResult batchDisassociateScramSecret(BatchDisassociateScramSecretRequest batchDisassociateScramSecretRequest)
```
    Disassociates one or more Scram Secrets from an Amazon MSK cluster.
    
    Parameters:
    
    batchDisassociateScramSecretRequest -
    Disassociates sasl scram secrets to cluster.
    
    Returns:
    
    Result of the BatchDisassociateScramSecret operation returned by the service.
    
    Throws:
    
    BadRequestException -
    The request isn't valid because the input is incorrect. Correct your input and then submit it again.
    
    UnauthorizedException -
    The request is not authorized. The provided credentials couldn't be validated.
    
    InternalServerErrorException -
    There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException -
    Access forbidden. Check your credentials and then retry your request.
    
    NotFoundException -
    The resource could not be found due to incorrect input. Correct the input, then retry the request.
    
    ServiceUnavailableException -
    503 response
    
    TooManyRequestsException -
    429 response
    
    See Also:
    
    AWS API Documentation
  - createCluster
```
CreateClusterResult createCluster(CreateClusterRequest createClusterRequest)
```
    Creates a new MSK cluster.
    
    Parameters:
    
    createClusterRequest -
    
    Returns:
    
    Result of the CreateCluster operation returned by the service.
    
    Throws:
    
    BadRequestException -
    The request isn't valid because the input is incorrect. Correct your input and then submit it again.
    
    InternalServerErrorException -
    There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    UnauthorizedException -
    The request is not authorized. The provided credentials couldn't be validated.
    
    ForbiddenException -
    Access forbidden. Check your credentials and then retry your request.
    
    ServiceUnavailableException -
    503 response
    
    TooManyRequestsException -
    429 response
    
    ConflictException -
    This cluster name already exists. Retry your request using another name.
    
    See Also:
    
    AWS API Documentation
  - createClusterV2
```
CreateClusterV2Result createClusterV2(CreateClusterV2Request createClusterV2Request)
```
    Creates a new MSK cluster.
    
    Parameters:
    
    createClusterV2Request -
    
    Returns:
    
    Result of the CreateClusterV2 operation returned by the service.
    
    Throws:
    
    BadRequestException -
    The request isn't valid because the input is incorrect. Correct your input and then submit it again.
    
    InternalServerErrorException -
    There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    UnauthorizedException -
    The request is not authorized. The provided credentials couldn't be validated.
    
    ForbiddenException -
    Access forbidden. Check your credentials and then retry your request.
    
    ServiceUnavailableException -
    503 response
    
    TooManyRequestsException -
    429 response
    
    ConflictException -
    This cluster name already exists. Retry your request using another name.
    
    See Also:
    
    AWS API Documentation
  - createConfiguration
```
CreateConfigurationResult createConfiguration(CreateConfigurationRequest createConfigurationRequest)
```
    Creates a new MSK configuration.
    
    Parameters:
    
    createConfigurationRequest -
    
    Returns:
    
    Result of the CreateConfiguration operation returned by the service.
    
    Throws:
    
    BadRequestException -
    The request isn't valid because the input is incorrect. Correct your input and then submit it again.
    
    InternalServerErrorException -
    There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    UnauthorizedException -
    The request is not authorized. The provided credentials couldn't be validated.
    
    ForbiddenException -
    Access forbidden. Check your credentials and then retry your request.
    
    ServiceUnavailableException -
    503 response
    
    TooManyRequestsException -
    429 response
    
    ConflictException -
    This cluster name already exists. Retry your request using another name.
    
    See Also:
    
    AWS API Documentation
  - deleteCluster
```
DeleteClusterResult deleteCluster(DeleteClusterRequest deleteClusterRequest)
```
    Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.
    
    Parameters:
    
    deleteClusterRequest -
    
    Returns:
    
    Result of the DeleteCluster operation returned by the service.
    
    Throws:
    
    NotFoundException -
    The resource could not be found due to incorrect input. Correct the input, then retry the request.
    
    BadRequestException -
    The request isn't valid because the input is incorrect. Correct your input and then submit it again.
    
    InternalServerErrorException -
    There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException -
    Access forbidden. Check your credentials and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - deleteConfiguration
```
DeleteConfigurationResult deleteConfiguration(DeleteConfigurationRequest deleteConfigurationRequest)
```
    Deletes an MSK Configuration.
    
    Parameters:
    
    deleteConfigurationRequest -
    
    Returns:
    
    Result of the DeleteConfiguration operation returned by the service.
    
    Throws:
    
    NotFoundException -
    The resource could not be found due to incorrect input. Correct the input, then retry the request.
    
    BadRequestException -
    The request isn't valid because the input is incorrect. Correct your input and then submit it again.
    
    InternalServerErrorException -
    There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException -
    Access forbidden. Check your credentials and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - describeCluster
```
DescribeClusterResult describeCluster(DescribeClusterRequest describeClusterRequest)
```
    Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
    
    Parameters:
    
    describeClusterRequest -
    
    Returns:
    
    Result of the DescribeCluster operation returned by the service.
    
    Throws:
    
    NotFoundException -
    The resource could not be found due to incorrect input. Correct the input, then retry the request.
    
    BadRequestException -
    The request isn't valid because the input is incorrect. Correct your input and then submit it again.
    
    UnauthorizedException -
    The request is not authorized. The provided credentials couldn't be validated.
    
    InternalServerErrorException -
    There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException -
    Access forbidden. Check your credentials and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - describeClusterOperation
```
DescribeClusterOperationResult describeClusterOperation(DescribeClusterOperationRequest describeClusterOperationRequest)
```
    Returns a description of the cluster operation specified by the ARN.
    
    Parameters:
    
    describeClusterOperationRequest -
    
    Returns:
    
    Result of the DescribeClusterOperation operation returned by the service.
    
    Throws:
    
    NotFoundException -
    The resource could not be found due to incorrect input. Correct the input, then retry the request.
    
    BadRequestException -
    The request isn't valid because the input is incorrect. Correct your input and then submit it again.
    
    UnauthorizedException -
    The request is not authorized. The provided credentials couldn't be validated.
    
    InternalServerErrorException -
    There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException -
    Access forbidden. Check your credentials and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - describeClusterV2
```
DescribeClusterV2Result describeClusterV2(DescribeClusterV2Request describeClusterV2Request)
```
    Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
    
    Parameters:
    
    describeClusterV2Request -
    
    Returns:
    
    Result of the DescribeClusterV2 operation returned by the service.
    
    Throws:
    
    NotFoundException -
    The resource could not be found due to incorrect input. Correct the input, then retry the request.
    
    BadRequestException -
    The request isn't valid because the input is incorrect. Correct your input and then submit it again.
    
    UnauthorizedException -
    The request is not authorized. The provided credentials couldn't be validated.
    
    InternalServerErrorException -
    There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException -
    Access forbidden. Check your credentials and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - describeConfiguration
```
DescribeConfigurationResult describeConfiguration(DescribeConfigurationRequest describeConfigurationRequest)
```
    Returns a description of this MSK configuration.
    
    Parameters:
    
    describeConfigurationRequest -
    
    Returns:
    
    Result of the DescribeConfiguration operation returned by the service.
    
    Throws:
    
    BadRequestException -
    The request isn't valid because the input is incorrect. Correct your input and then submit it again.
    
    UnauthorizedException -
    The request is not authorized. The provided credentials couldn't be validated.
    
    InternalServerErrorException -
    There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException -
    Access forbidden. Check your credentials and then retry your request.
    
    NotFoundException -
    The resource could not be found due to incorrect input. Correct the input, then retry the request.
    
    ServiceUnavailableException -
    503 response
    
    See Also:
    
    AWS API Documentation
  - describeConfigurationRevision
```
DescribeConfigurationRevisionResult describeConfigurationRevision(DescribeConfigurationRevisionRequest describeConfigurationRevisionRequest)
```
    Returns a description of this revision of the configuration.
    
    Parameters:
    
    describeConfigurationRevisionRequest -
    
    Returns:
    
    Result of the DescribeConfigurationRevision operation returned by the service.
    
    Throws:
    
    BadRequestException -
    The request isn't valid because the input is incorrect. Correct your input and then submit it again.
    
    UnauthorizedException -
    The request is not authorized. The provided credentials couldn't be validated.
    
    InternalServerErrorException -
    There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException -
    Access forbidden. Check your credentials and then retry your request.
    
    NotFoundException -
    The resource could not be found due to incorrect input. Correct the input, then retry the request.
    
    ServiceUnavailableException -
    503 response
    
    See Also:
    
    AWS API Documentation
  - getBootstrapBrokers
```
GetBootstrapBrokersResult getBootstrapBrokers(GetBootstrapBrokersRequest getBootstrapBrokersRequest)
```
    A list of brokers that a client application can use to bootstrap.
    
    Parameters:
    
    getBootstrapBrokersRequest -
    
    Returns:
    
    Result of the GetBootstrapBrokers operation returned by the service.
    
    Throws:
    
    BadRequestException -
    The request isn't valid because the input is incorrect. Correct your input and then submit it again.
    
    UnauthorizedException -
    The request is not authorized. The provided credentials couldn't be validated.
    
    InternalServerErrorException -
    There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    ConflictException -
    This cluster name already exists. Retry your request using another name.
    
    ForbiddenException -
    Access forbidden. Check your credentials and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - getCompatibleKafkaVersions
```
GetCompatibleKafkaVersionsResult getCompatibleKafkaVersions(GetCompatibleKafkaVersionsRequest getCompatibleKafkaVersionsRequest)
```
    Gets the Apache Kafka versions to which you can update the MSK cluster.
    
    Parameters:
    
    getCompatibleKafkaVersionsRequest -
    
    Returns:
    
    Result of the GetCompatibleKafkaVersions operation returned by the service.
    
    Throws:
    
    BadRequestException - n
    The request isn't valid because the input is incorrect. Correct your input and then submit it again.
    n
    
    UnauthorizedException - n
    The request is not authorized. The provided credentials couldn't be validated.
    n
    
    InternalServerErrorException - n
    There was an unexpected internal server error. Retrying your request might resolve the issue.
    n
    
    ForbiddenException - n
    Access forbidden. Check your credentials and then retry your request.
    n
    
    NotFoundException - n
    The resource could not be found due to incorrect input. Correct the input, then retry the request.
    n
    
    ServiceUnavailableException - n
    503 response
    n
    
    TooManyRequestsException - n
    429 response
    n
    
    See Also:
    
    AWS API Documentation
  - listClusterOperations
```
ListClusterOperationsResult listClusterOperations(ListClusterOperationsRequest listClusterOperationsRequest)
```
    Returns a list of all the operations that have been performed on the specified MSK cluster.
    
    Parameters:
    
    listClusterOperationsRequest -
    
    Returns:
    
    Result of the ListClusterOperations operation returned by the service.
    
    Throws:
    
    BadRequestException -
    The request isn't valid because the input is incorrect. Correct your input and then submit it again.
    
    InternalServerErrorException -
    There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    UnauthorizedException -
    The request is not authorized. The provided credentials couldn't be validated.
    
    ForbiddenException -
    Access forbidden. Check your credentials and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - listClusters
```
ListClustersResult listClusters(ListClustersRequest listClustersRequest)
```
    Returns a list of all the MSK clusters in the current Region.
    
    Parameters:
    
    listClustersRequest -
    
    Returns:
    
    Result of the ListClusters operation returned by the service.
    
    Throws:
    
    BadRequestException -
    The request isn't valid because the input is incorrect. Correct your input and then submit it again.
    
    InternalServerErrorException -
    There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    UnauthorizedException -
    The request is not authorized. The provided credentials couldn't be validated.
    
    ForbiddenException -
    Access forbidden. Check your credentials and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - listClustersV2
```
ListClustersV2Result listClustersV2(ListClustersV2Request listClustersV2Request)
```
    Returns a list of all the MSK clusters in the current Region.
    
    Parameters:
    
    listClustersV2Request -
    
    Returns:
    
    Result of the ListClustersV2 operation returned by the service.
    
    Throws:
    
    BadRequestException -
    The request isn't valid because the input is incorrect. Correct your input and then submit it again.
    
    InternalServerErrorException -
    There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    UnauthorizedException -
    The request is not authorized. The provided credentials couldn't be validated.
    
    ForbiddenException -
    Access forbidden. Check your credentials and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - listConfigurationRevisions
```
ListConfigurationRevisionsResult listConfigurationRevisions(ListConfigurationRevisionsRequest listConfigurationRevisionsRequest)
```
    Returns a list of all the MSK configurations in this Region.
    
    Parameters:
    
    listConfigurationRevisionsRequest -
    
    Returns:
    
    Result of the ListConfigurationRevisions operation returned by the service.
    
    Throws:
    
    BadRequestException -
    The request isn't valid because the input is incorrect. Correct your input and then submit it again.
    
    UnauthorizedException -
    The request is not authorized. The provided credentials couldn't be validated.
    
    InternalServerErrorException -
    There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException -
    Access forbidden. Check your credentials and then retry your request.
    
    NotFoundException -
    The resource could not be found due to incorrect input. Correct the input, then retry the request.
    
    ServiceUnavailableException -
    503 response
    
    See Also:
    
    AWS API Documentation
  - listConfigurations
```
ListConfigurationsResult listConfigurations(ListConfigurationsRequest listConfigurationsRequest)
```
    Returns a list of all the MSK configurations in this Region.
    
    Parameters:
    
    listConfigurationsRequest -
    
    Returns:
    
    Result of the ListConfigurations operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException -
    503 response
    
    BadRequestException -
    The request isn't valid because the input is incorrect. Correct your input and then submit it again.
    
    UnauthorizedException -
    The request is not authorized. The provided credentials couldn't be validated.
    
    InternalServerErrorException -
    There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException -
    Access forbidden. Check your credentials and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - listKafkaVersions
```
ListKafkaVersionsResult listKafkaVersions(ListKafkaVersionsRequest listKafkaVersionsRequest)
```
    Returns a list of Apache Kafka versions.
    
    Parameters:
    
    listKafkaVersionsRequest -
    
    Returns:
    
    Result of the ListKafkaVersions operation returned by the service.
    
    Throws:
    
    BadRequestException -
    The request isn't valid because the input is incorrect. Correct your input and then submit it again.
    
    UnauthorizedException -
    The request is not authorized. The provided credentials couldn't be validated.
    
    InternalServerErrorException -
    There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException -
    Access forbidden. Check your credentials and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - listNodes
```
ListNodesResult listNodes(ListNodesRequest listNodesRequest)
```
    Returns a list of the broker nodes in the cluster.
    
    Parameters:
    
    listNodesRequest -
    
    Returns:
    
    Result of the ListNodes operation returned by the service.
    
    Throws:
    
    NotFoundException -
    The resource could not be found due to incorrect input. Correct the input, then retry the request.
    
    BadRequestException -
    The request isn't valid because the input is incorrect. Correct your input and then submit it again.
    
    InternalServerErrorException -
    There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException -
    Access forbidden. Check your credentials and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - listScramSecrets
```
ListScramSecretsResult listScramSecrets(ListScramSecretsRequest listScramSecretsRequest)
```
    Returns a list of the Scram Secrets associated with an Amazon MSK cluster.
    
    Parameters:
    
    listScramSecretsRequest -
    
    Returns:
    
    Result of the ListScramSecrets operation returned by the service.
    
    Throws:
    
    BadRequestException -
    The request isn't valid because the input is incorrect. Correct your input and then submit it again.
    
    UnauthorizedException -
    The request is not authorized. The provided credentials couldn't be validated.
    
    InternalServerErrorException -
    There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException -
    Access forbidden. Check your credentials and then retry your request.
    
    NotFoundException -
    The resource could not be found due to incorrect input. Correct the input, then retry the request.
    
    ServiceUnavailableException -
    503 response
    
    TooManyRequestsException -
    429 response
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Returns a list of the tags associated with the specified resource.
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    NotFoundException -
    The resource could not be found due to incorrect input. Correct the input, then retry the request.
    
    BadRequestException -
    The request isn't valid because the input is incorrect. Correct your input and then submit it again.
    
    InternalServerErrorException -
    There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    See Also:
    
    AWS API Documentation
  - rebootBroker
```
RebootBrokerResult rebootBroker(RebootBrokerRequest rebootBrokerRequest)
```
    Reboots brokers.
    
    Parameters:
    
    rebootBrokerRequest - Reboots a node.
    
    Returns:
    
    Result of the RebootBroker operation returned by the service.
    
    Throws:
    
    BadRequestException -
    The request isn't valid because the input is incorrect. Correct your input and then submit it again.
    
    UnauthorizedException -
    The request is not authorized. The provided credentials couldn't be validated.
    
    InternalServerErrorException -
    There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException -
    Access forbidden. Check your credentials and then retry your request.
    
    NotFoundException -
    The resource could not be found due to incorrect input. Correct the input, then retry the request.
    
    ServiceUnavailableException -
    503 response
    
    TooManyRequestsException -
    429 response
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
```
    Adds tags to the specified MSK resource.
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    NotFoundException -
    The resource could not be found due to incorrect input. Correct the input, then retry the request.
    
    BadRequestException -
    The request isn't valid because the input is incorrect. Correct your input and then submit it again.
    
    InternalServerErrorException -
    There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    Removes the tags associated with the keys that are provided in the query.
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    NotFoundException -
    The resource could not be found due to incorrect input. Correct the input, then retry the request.
    
    BadRequestException -
    The request isn't valid because the input is incorrect. Correct your input and then submit it again.
    
    InternalServerErrorException -
    There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    See Also:
    
    AWS API Documentation
  - updateBrokerCount
```
UpdateBrokerCountResult updateBrokerCount(UpdateBrokerCountRequest updateBrokerCountRequest)
```
    Updates the number of broker nodes in the cluster.
    
    Parameters:
    
    updateBrokerCountRequest -
    
    Returns:
    
    Result of the UpdateBrokerCount operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException -
    503 response
    
    BadRequestException -
    The request isn't valid because the input is incorrect. Correct your input and then submit it again.
    
    UnauthorizedException -
    The request is not authorized. The provided credentials couldn't be validated.
    
    InternalServerErrorException -
    There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException -
    Access forbidden. Check your credentials and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - updateBrokerStorage
```
UpdateBrokerStorageResult updateBrokerStorage(UpdateBrokerStorageRequest updateBrokerStorageRequest)
```
    Updates the EBS storage associated with MSK brokers.
    
    Parameters:
    
    updateBrokerStorageRequest -
    
    Returns:
    
    Result of the UpdateBrokerStorage operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException -
    503 response
    
    BadRequestException -
    The request isn't valid because the input is incorrect. Correct your input and then submit it again.
    
    UnauthorizedException -
    The request is not authorized. The provided credentials couldn't be validated.
    
    InternalServerErrorException -
    There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException -
    Access forbidden. Check your credentials and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - updateBrokerType
```
UpdateBrokerTypeResult updateBrokerType(UpdateBrokerTypeRequest updateBrokerTypeRequest)
```
    Updates EC2 instance type.
    
    Parameters:
    
    updateBrokerTypeRequest -
    
    Returns:
    
    Result of the UpdateBrokerType operation returned by the service.
    
    Throws:
    
    BadRequestException -
    The request isn't valid because the input is incorrect. Correct your input and then submit it again.
    
    UnauthorizedException -
    The request is not authorized. The provided credentials couldn't be validated.
    
    InternalServerErrorException -
    There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException -
    Access forbidden. Check your credentials and then retry your request.
    
    NotFoundException -
    The resource could not be found due to incorrect input. Correct the input, then retry the request.
    
    ServiceUnavailableException -
    503 response
    
    TooManyRequestsException -
    429 response
    
    See Also:
    
    AWS API Documentation
  - updateClusterConfiguration
```
UpdateClusterConfigurationResult updateClusterConfiguration(UpdateClusterConfigurationRequest updateClusterConfigurationRequest)
```
    Updates the cluster with the configuration that is specified in the request body.
    
    Parameters:
    
    updateClusterConfigurationRequest -
    
    Returns:
    
    Result of the UpdateClusterConfiguration operation returned by the service.
    
    Throws:
    
    BadRequestException -
    The request isn't valid because the input is incorrect. Correct your input and then submit it again.
    
    UnauthorizedException -
    The request is not authorized. The provided credentials couldn't be validated.
    
    InternalServerErrorException -
    There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException -
    Access forbidden. Check your credentials and then retry your request.
    
    NotFoundException -
    The resource could not be found due to incorrect input. Correct the input, then retry the request.
    
    ServiceUnavailableException -
    503 response
    
    See Also:
    
    AWS API Documentation
  - updateClusterKafkaVersion
```
UpdateClusterKafkaVersionResult updateClusterKafkaVersion(UpdateClusterKafkaVersionRequest updateClusterKafkaVersionRequest)
```
    Updates the Apache Kafka version for the cluster.
    
    Parameters:
    
    updateClusterKafkaVersionRequest -
    
    Returns:
    
    Result of the UpdateClusterKafkaVersion operation returned by the service.
    
    Throws:
    
    BadRequestException -
    The request isn't valid because the input is incorrect. Correct your input and then submit it again.
    
    UnauthorizedException -
    The request is not authorized. The provided credentials couldn't be validated.
    
    InternalServerErrorException -
    There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException -
    Access forbidden. Check your credentials and then retry your request.
    
    NotFoundException -
    The resource could not be found due to incorrect input. Correct the input, then retry the request.
    
    ServiceUnavailableException -
    503 response
    
    TooManyRequestsException -
    429 response
    
    See Also:
    
    AWS API Documentation
  - updateConfiguration
```
UpdateConfigurationResult updateConfiguration(UpdateConfigurationRequest updateConfigurationRequest)
```
    Updates an MSK configuration.
    
    Parameters:
    
    updateConfigurationRequest -
    
    Returns:
    
    Result of the UpdateConfiguration operation returned by the service.
    
    Throws:
    
    BadRequestException -
    The request isn't valid because the input is incorrect. Correct your input and then submit it again.
    
    UnauthorizedException -
    The request is not authorized. The provided credentials couldn't be validated.
    
    InternalServerErrorException -
    There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException -
    Access forbidden. Check your credentials and then retry your request.
    
    NotFoundException -
    The resource could not be found due to incorrect input. Correct the input, then retry the request.
    
    ServiceUnavailableException -
    503 response
    
    See Also:
    
    AWS API Documentation
  - updateConnectivity
```
UpdateConnectivityResult updateConnectivity(UpdateConnectivityRequest updateConnectivityRequest)
```
    Updates the cluster's connectivity configuration.
    
    Parameters:
    
    updateConnectivityRequest - Request body for UpdateConnectivity.
    
    Returns:
    
    Result of the UpdateConnectivity operation returned by the service.
    
    Throws:
    
    BadRequestException -
    The request isn't valid because the input is incorrect. Correct your input and then submit it again.
    
    UnauthorizedException -
    The request is not authorized. The provided credentials couldn't be validated.
    
    InternalServerErrorException -
    There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException -
    Access forbidden. Check your credentials and then retry your request.
    
    NotFoundException -
    The resource could not be found due to incorrect input. Correct the input, then retry the request.
    
    ServiceUnavailableException -
    503 response
    
    See Also:
    
    AWS API Documentation
  - updateMonitoring
```
UpdateMonitoringResult updateMonitoring(UpdateMonitoringRequest updateMonitoringRequest)
```
    Updates the monitoring settings for the cluster. You can use this operation to specify which Apache Kafka metrics you want Amazon MSK to send to Amazon CloudWatch. You can also specify settings for open monitoring with Prometheus.
    
    Parameters:
    
    updateMonitoringRequest - Request body for UpdateMonitoring.
    
    Returns:
    
    Result of the UpdateMonitoring operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException -
    503 response
    
    BadRequestException -
    The request isn't valid because the input is incorrect. Correct your input and then submit it again.
    
    UnauthorizedException -
    The request is not authorized. The provided credentials couldn't be validated.
    
    InternalServerErrorException -
    There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException -
    Access forbidden. Check your credentials and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - updateSecurity
```
UpdateSecurityResult updateSecurity(UpdateSecurityRequest updateSecurityRequest)
```
    Updates the security settings for the cluster. You can use this operation to specify encryption and authentication on existing clusters.
    
    Parameters:
    
    updateSecurityRequest -
    
    Returns:
    
    Result of the UpdateSecurity operation returned by the service.
    
    Throws:
    
    BadRequestException -
    The request isn't valid because the input is incorrect. Correct your input and then submit it again.
    
    UnauthorizedException -
    The request is not authorized. The provided credentials couldn't be validated.
    
    InternalServerErrorException -
    There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException -
    Access forbidden. Check your credentials and then retry your request.
    
    NotFoundException -
    The resource could not be found due to incorrect input. Correct the input, then retry the request.
    
    ServiceUnavailableException -
    The service cannot complete the request.
    
    TooManyRequestsException -
    The request throughput limit was exceeded.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Interface AWSKafka

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

batchAssociateScramSecret

batchDisassociateScramSecret

createCluster

createClusterV2

createConfiguration

deleteCluster

deleteConfiguration

describeCluster

describeClusterOperation

describeClusterV2

describeConfiguration

describeConfigurationRevision

getBootstrapBrokers

getCompatibleKafkaVersions

listClusterOperations

listClusters

listClustersV2

listConfigurationRevisions

listConfigurations

listKafkaVersions

listNodes

listScramSecrets

listTagsForResource

rebootBroker

tagResource

untagResource

updateBrokerCount

updateBrokerStorage

updateBrokerType

updateClusterConfiguration

updateClusterKafkaVersion

updateConfiguration

updateConnectivity

updateMonitoring

updateSecurity

shutdown

getCachedResponseMetadata