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
`CreateClusterResult`	`createCluster(CreateClusterRequest createClusterRequest)` 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.
`DescribeClusterResult`	`describeCluster(DescribeClusterRequest describeClusterRequest)` 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.
`ListClustersResult`	`listClusters(ListClustersRequest listClustersRequest)` Returns a list of clusters in an account.
`ListConfigurationsResult`	`listConfigurations(ListConfigurationsRequest listConfigurationsRequest)` Returns a list of all the MSK configurations in this Region for this account.
`ListNodesResult`	`listNodes(ListNodesRequest listNodesRequest)` Returns a list of the broker nodes in the cluster.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` Returns a list of tags attached to a resource.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource(TagResourceRequest tagResourceRequest)` Tag a resource with given tags.
`UntagResourceResult`	`untagResource(UntagResourceRequest untagResourceRequest)` Remove tags of a resource by given tag keys.

- 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
  - createCluster
```
CreateClusterResult createCluster(CreateClusterRequest createClusterRequest)
```
    Creates a new MSK cluster.
    
    Parameters:
    
    createClusterRequest -
    
    Returns:
    
    Result of the CreateCluster operation returned by the service.
    
    Throws:
    
    BadRequestException - Bad request due to incorrect input. Correct your request and then retry it.
    
    InternalServerErrorException - There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    UnauthorizedException - The request is not authorized. The provided credentials couldn't be validated.
    
    ForbiddenException - Access forbidden. Check your credentials and then retry your request.
    
    ServiceUnavailableException - 503 response
    
    TooManyRequestsException - 429 response
    
    ConflictException - This cluster name already exists. Retry your request using another name.
    
    See Also:
    
    AWS API Documentation
  - createConfiguration
```
CreateConfigurationResult createConfiguration(CreateConfigurationRequest createConfigurationRequest)
```
    Creates a new MSK configuration.
    
    Parameters:
    
    createConfigurationRequest -
    
    Returns:
    
    Result of the CreateConfiguration operation returned by the service.
    
    Throws:
    
    BadRequestException - Because of incorrect input, the request isn't valid. Correct the input, then retry the request.
    
    InternalServerErrorException - There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    UnauthorizedException - The request is not authorized. The provided credentials couldn't be validated.
    
    ForbiddenException - Access forbidden. Check your credentials and then retry your request.
    
    ServiceUnavailableException - 503 response
    
    TooManyRequestsException - 429 response
    
    ConflictException - This configuration name already exists. Retry your request using another name.
    
    See Also:
    
    AWS API Documentation
  - deleteCluster
```
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 your request and then retry it.
    
    BadRequestException - Bad request due to incorrect input. Correct your request and then retry it.
    
    InternalServerErrorException - There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException - Access forbidden. Check your credentials and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - describeCluster
```
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 your request and then retry it.
    
    BadRequestException - Bad request due to incorrect input. Correct your request and then retry it.
    
    UnauthorizedException - The request is not authorized. The provided credentials couldn't be validated.
    
    InternalServerErrorException - There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException - Access forbidden. Check your credentials and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - describeConfiguration
```
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 - Because of incorrect input, the request isn't valid. Correct the input, then retry the request.
    
    UnauthorizedException - The request is not authorized. The provided credentials couldn't be validated.
    
    InternalServerErrorException - There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException - Access forbidden. Check your credentials and then retry your request.
    
    NotFoundException - The resource could not be found due to incorrect input. Correct the input, then retry the request.
    
    ServiceUnavailableException - 503 response
    
    See Also:
    
    AWS API Documentation
  - describeConfigurationRevision
```
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 - Because of incorrect input, the request isn't valid. Correct the input, then retry the request.
    
    UnauthorizedException - The request is not authorized. The provided credentials couldn't be validated.
    
    InternalServerErrorException - There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException - Access forbidden. Check your credentials and then retry your request.
    
    NotFoundException - The resource could not be found due to incorrect input. Correct the input, then retry the request.
    
    ServiceUnavailableException - 503 response
    
    See Also:
    
    AWS API Documentation
  - getBootstrapBrokers
```
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 - Bad request due to incorrect input. Correct your request and then retry it.
    
    UnauthorizedException - The request is not authorized. The provided credentials couldn't be validated.
    
    InternalServerErrorException - There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    ConflictException - This cluster name already exists. Retry your request using another name.
    
    ForbiddenException - Access forbidden. Check your credentials and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - listClusters
```
ListClustersResult listClusters(ListClustersRequest listClustersRequest)
```
    Returns a list of clusters in an account.
    
    Parameters:
    
    listClustersRequest -
    
    Returns:
    
    Result of the ListClusters operation returned by the service.
    
    Throws:
    
    BadRequestException - Bad request due to incorrect input. Correct your request and then retry it.
    
    InternalServerErrorException - There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    UnauthorizedException - The request is not authorized. The provided credentials couldn't be validated.
    
    ForbiddenException - Access forbidden. Check your credentials and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - listConfigurations
```
ListConfigurationsResult listConfigurations(ListConfigurationsRequest listConfigurationsRequest)
```
    Returns a list of all the MSK configurations in this Region for this account.
    
    Parameters:
    
    listConfigurationsRequest -
    
    Returns:
    
    Result of the ListConfigurations operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - 503 response
    
    BadRequestException - Because of incorrect input, the request isn't valid. Correct the input, then retry the request.
    
    UnauthorizedException - The request is not authorized. The provided credentials couldn't be validated.
    
    InternalServerErrorException - There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException - Access forbidden. Check your credentials and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - listNodes
```
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 your request and then retry it.
    
    BadRequestException - Bad request due to incorrect input. Correct your request and then retry it.
    
    InternalServerErrorException - There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException - Access forbidden. Check your credentials and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Returns a list of tags attached to a 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 your request and then retry it.
    
    BadRequestException - Bad request due to incorrect input. Correct your request and then retry it.
    
    InternalServerErrorException - There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
```
    Tag a resource with given tags.
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource could not be found due to incorrect input. Correct your request and then retry it.
    
    BadRequestException - Bad request due to incorrect input. Correct your request and then retry it.
    
    InternalServerErrorException - There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    Remove tags of a resource by given tag keys.
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource could not be found due to incorrect input. Correct your request and then retry it.
    
    BadRequestException - Bad request due to incorrect input. Correct your request and then retry it.
    
    InternalServerErrorException - There was an unexpected internal server error. Retrying your request might resolve the issue.
    
    See Also:
    
    AWS API Documentation
  - 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

createCluster

createConfiguration

deleteCluster

describeCluster

describeConfiguration

describeConfigurationRevision

getBootstrapBrokers

listClusters

listConfigurations

listNodes

listTagsForResource

tagResource

untagResource

shutdown

getCachedResponseMetadata