/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.kafka; import javax.annotation.Generated; import com.amazonaws.*; import com.amazonaws.regions.*; import com.amazonaws.services.kafka.model.*; /** * Interface for accessing Kafka. *
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.kafka.AbstractAWSKafka} instead. *
** *
* The operations for managing an Amazon MSK cluster. *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AWSKafka { /** * 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 RegionUtils#getRegionsForService(String) */ String ENDPOINT_PREFIX = "kafka"; /** ** Associates one or more Scram Secrets with an Amazon MSK cluster. *
* * @param batchAssociateScramSecretRequest ** Associates sasl scram secrets to cluster. *
* @return 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. *
* @throws UnauthorizedException ** The request is not authorized. The provided credentials couldn't be validated. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @throws ForbiddenException ** Access forbidden. Check your credentials and then retry your request. *
* @throws NotFoundException ** The resource could not be found due to incorrect input. Correct the input, then retry the request. *
* @throws ServiceUnavailableException ** 503 response *
* @throws TooManyRequestsException ** 429 response *
* @sample AWSKafka.BatchAssociateScramSecret * @see AWS API Documentation */ BatchAssociateScramSecretResult batchAssociateScramSecret(BatchAssociateScramSecretRequest batchAssociateScramSecretRequest); /** ** Disassociates one or more Scram Secrets from an Amazon MSK cluster. *
* * @param batchDisassociateScramSecretRequest ** Disassociates sasl scram secrets to cluster. *
* @return 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. *
* @throws UnauthorizedException ** The request is not authorized. The provided credentials couldn't be validated. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @throws ForbiddenException ** Access forbidden. Check your credentials and then retry your request. *
* @throws NotFoundException ** The resource could not be found due to incorrect input. Correct the input, then retry the request. *
* @throws ServiceUnavailableException ** 503 response *
* @throws TooManyRequestsException ** 429 response *
* @sample AWSKafka.BatchDisassociateScramSecret * @see AWS API Documentation */ BatchDisassociateScramSecretResult batchDisassociateScramSecret(BatchDisassociateScramSecretRequest batchDisassociateScramSecretRequest); /** ** Creates a new MSK cluster. *
* * @param createClusterRequest * @return 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. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @throws UnauthorizedException ** The request is not authorized. The provided credentials couldn't be validated. *
* @throws ForbiddenException ** Access forbidden. Check your credentials and then retry your request. *
* @throws ServiceUnavailableException ** 503 response *
* @throws TooManyRequestsException ** 429 response *
* @throws ConflictException ** This cluster name already exists. Retry your request using another name. *
* @sample AWSKafka.CreateCluster * @see AWS API * Documentation */ CreateClusterResult createCluster(CreateClusterRequest createClusterRequest); /** ** Creates a new MSK cluster. *
* * @param createClusterV2Request * @return 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. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @throws UnauthorizedException ** The request is not authorized. The provided credentials couldn't be validated. *
* @throws ForbiddenException ** Access forbidden. Check your credentials and then retry your request. *
* @throws ServiceUnavailableException ** 503 response *
* @throws TooManyRequestsException ** 429 response *
* @throws ConflictException ** This cluster name already exists. Retry your request using another name. *
* @sample AWSKafka.CreateClusterV2 * @see AWS API * Documentation */ CreateClusterV2Result createClusterV2(CreateClusterV2Request createClusterV2Request); /** ** Creates a new MSK configuration. *
* * @param createConfigurationRequest * @return 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. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @throws UnauthorizedException ** The request is not authorized. The provided credentials couldn't be validated. *
* @throws ForbiddenException ** Access forbidden. Check your credentials and then retry your request. *
* @throws ServiceUnavailableException ** 503 response *
* @throws TooManyRequestsException ** 429 response *
* @throws ConflictException ** This cluster name already exists. Retry your request using another name. *
* @sample AWSKafka.CreateConfiguration * @see AWS API * Documentation */ CreateConfigurationResult createConfiguration(CreateConfigurationRequest createConfigurationRequest); /** ** Creates a new MSK VPC connection. *
* * @param createVpcConnectionRequest * @return 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. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @throws UnauthorizedException ** The request is not authorized. The provided credentials couldn't be validated. *
* @throws ForbiddenException ** Access forbidden. Check your credentials and then retry your request. *
* @throws ServiceUnavailableException ** 503 response *
* @throws TooManyRequestsException ** 429 response *
* @sample AWSKafka.CreateVpcConnection * @see AWS API * Documentation */ CreateVpcConnectionResult createVpcConnection(CreateVpcConnectionRequest createVpcConnectionRequest); /** ** Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request. *
* * @param deleteClusterRequest * @return 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. *
* @throws BadRequestException ** The request isn't valid because the input is incorrect. Correct your input and then submit it again. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @throws ForbiddenException ** Access forbidden. Check your credentials and then retry your request. *
* @sample AWSKafka.DeleteCluster * @see AWS API * Documentation */ DeleteClusterResult deleteCluster(DeleteClusterRequest deleteClusterRequest); /** ** Deletes the MSK cluster policy specified by the Amazon Resource Name (ARN) in the request. *
* * @param deleteClusterPolicyRequest * @return 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. *
* @throws BadRequestException ** The request isn't valid because the input is incorrect. Correct your input and then submit it again. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @throws ForbiddenException ** Access forbidden. Check your credentials and then retry your request. *
* @sample AWSKafka.DeleteClusterPolicy * @see AWS API * Documentation */ DeleteClusterPolicyResult deleteClusterPolicy(DeleteClusterPolicyRequest deleteClusterPolicyRequest); /** ** Deletes an MSK Configuration. *
* * @param deleteConfigurationRequest * @return 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. *
* @throws BadRequestException ** The request isn't valid because the input is incorrect. Correct your input and then submit it again. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @throws ForbiddenException ** Access forbidden. Check your credentials and then retry your request. *
* @sample AWSKafka.DeleteConfiguration * @see AWS API * Documentation */ DeleteConfigurationResult deleteConfiguration(DeleteConfigurationRequest deleteConfigurationRequest); /** ** Deletes a MSK VPC connection. *
* * @param deleteVpcConnectionRequest * @return 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. *
* @throws BadRequestException ** The request isn't valid because the input is incorrect. Correct your input and then submit it again. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @throws ForbiddenException ** Access forbidden. Check your credentials and then retry your request. *
* @sample AWSKafka.DeleteVpcConnection * @see AWS API * Documentation */ DeleteVpcConnectionResult deleteVpcConnection(DeleteVpcConnectionRequest deleteVpcConnectionRequest); /** ** Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request. *
* * @param describeClusterRequest * @return 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. *
* @throws BadRequestException ** The request isn't valid because the input is incorrect. Correct your input and then submit it again. *
* @throws UnauthorizedException ** The request is not authorized. The provided credentials couldn't be validated. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @throws ForbiddenException ** Access forbidden. Check your credentials and then retry your request. *
* @sample AWSKafka.DescribeCluster * @see AWS API * Documentation */ DescribeClusterResult describeCluster(DescribeClusterRequest describeClusterRequest); /** ** Returns a description of the cluster operation specified by the ARN. *
* * @param describeClusterOperationRequest * @return 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. *
* @throws BadRequestException ** The request isn't valid because the input is incorrect. Correct your input and then submit it again. *
* @throws UnauthorizedException ** The request is not authorized. The provided credentials couldn't be validated. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @throws ForbiddenException ** Access forbidden. Check your credentials and then retry your request. *
* @sample AWSKafka.DescribeClusterOperation * @see AWS * API Documentation */ DescribeClusterOperationResult describeClusterOperation(DescribeClusterOperationRequest describeClusterOperationRequest); /** ** Returns a description of the cluster operation specified by the ARN. *
* * @param describeClusterOperationV2Request * @return 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. *
* @throws UnauthorizedException ** HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated. *
* @throws InternalServerErrorException ** HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue. *
* @throws ForbiddenException ** HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request. *
* @throws NotFoundException ** HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it. *
* @throws ServiceUnavailableException ** HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue. *
* @throws TooManyRequestsException ** HTTP Status Code 429: Limit exceeded. Resource limit reached. *
* @sample AWSKafka.DescribeClusterOperationV2 * @see AWS API Documentation */ DescribeClusterOperationV2Result describeClusterOperationV2(DescribeClusterOperationV2Request describeClusterOperationV2Request); /** ** Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request. *
* * @param describeClusterV2Request * @return 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. *
* @throws BadRequestException ** The request isn't valid because the input is incorrect. Correct your input and then submit it again. *
* @throws UnauthorizedException ** The request is not authorized. The provided credentials couldn't be validated. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @throws ForbiddenException ** Access forbidden. Check your credentials and then retry your request. *
* @sample AWSKafka.DescribeClusterV2 * @see AWS API * Documentation */ DescribeClusterV2Result describeClusterV2(DescribeClusterV2Request describeClusterV2Request); /** ** Returns a description of this MSK configuration. *
* * @param describeConfigurationRequest * @return 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. *
* @throws UnauthorizedException ** The request is not authorized. The provided credentials couldn't be validated. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @throws ForbiddenException ** Access forbidden. Check your credentials and then retry your request. *
* @throws NotFoundException ** The resource could not be found due to incorrect input. Correct the input, then retry the request. *
* @throws ServiceUnavailableException ** 503 response *
* @sample AWSKafka.DescribeConfiguration * @see AWS * API Documentation */ DescribeConfigurationResult describeConfiguration(DescribeConfigurationRequest describeConfigurationRequest); /** ** Returns a description of this revision of the configuration. *
* * @param describeConfigurationRevisionRequest * @return 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. *
* @throws UnauthorizedException ** The request is not authorized. The provided credentials couldn't be validated. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @throws ForbiddenException ** Access forbidden. Check your credentials and then retry your request. *
* @throws NotFoundException ** The resource could not be found due to incorrect input. Correct the input, then retry the request. *
* @throws ServiceUnavailableException ** 503 response *
* @sample AWSKafka.DescribeConfigurationRevision * @see AWS API Documentation */ DescribeConfigurationRevisionResult describeConfigurationRevision(DescribeConfigurationRevisionRequest describeConfigurationRevisionRequest); /** ** Returns a description of this MSK VPC connection. *
* * @param describeVpcConnectionRequest * @return 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. *
* @throws UnauthorizedException ** The request is not authorized. The provided credentials couldn't be validated. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @throws ForbiddenException ** Access forbidden. Check your credentials and then retry your request. *
* @throws NotFoundException ** The resource could not be found due to incorrect input. Correct the input, then retry the request. *
* @throws ServiceUnavailableException ** 503 response *
* @sample AWSKafka.DescribeVpcConnection * @see AWS * API Documentation */ DescribeVpcConnectionResult describeVpcConnection(DescribeVpcConnectionRequest describeVpcConnectionRequest); /** ** A list of brokers that a client application can use to bootstrap. *
* * @param getBootstrapBrokersRequest * @return 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. *
* @throws UnauthorizedException ** The request is not authorized. The provided credentials couldn't be validated. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @throws ConflictException ** This cluster name already exists. Retry your request using another name. *
* @throws ForbiddenException ** Access forbidden. Check your credentials and then retry your request. *
* @sample AWSKafka.GetBootstrapBrokers * @see AWS API * Documentation */ GetBootstrapBrokersResult getBootstrapBrokers(GetBootstrapBrokersRequest getBootstrapBrokersRequest); /** ** Get the MSK cluster policy specified by the Amazon Resource Name (ARN) in the request. *
* * @param getClusterPolicyRequest * @return 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. *
* @throws BadRequestException ** The request isn't valid because the input is incorrect. Correct your input and then submit it again. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @throws ForbiddenException ** Access forbidden. Check your credentials and then retry your request. *
* @sample AWSKafka.GetClusterPolicy * @see AWS API * Documentation */ GetClusterPolicyResult getClusterPolicy(GetClusterPolicyRequest getClusterPolicyRequest); /** ** Gets the Apache Kafka versions to which you can update the MSK cluster. *
* * @param getCompatibleKafkaVersionsRequest * @return 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 * @throws UnauthorizedException * n ** The request is not authorized. The provided credentials couldn't be validated. *
* n * @throws InternalServerErrorException * n ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* n * @throws ForbiddenException * n ** Access forbidden. Check your credentials and then retry your request. *
* n * @throws NotFoundException * n ** The resource could not be found due to incorrect input. Correct the input, then retry the request. *
* n * @throws ServiceUnavailableException * n ** 503 response *
* n * @throws TooManyRequestsException * n ** 429 response *
* n * @sample AWSKafka.GetCompatibleKafkaVersions * @see AWS API Documentation */ GetCompatibleKafkaVersionsResult getCompatibleKafkaVersions(GetCompatibleKafkaVersionsRequest getCompatibleKafkaVersionsRequest); /** ** Returns a list of all the VPC connections in this Region. *
* * @param listClientVpcConnectionsRequest * @return Result of the ListClientVpcConnections operation returned by the service. * @throws ServiceUnavailableException ** 503 response *
* @throws BadRequestException ** The request isn't valid because the input is incorrect. Correct your input and then submit it again. *
* @throws UnauthorizedException ** The request is not authorized. The provided credentials couldn't be validated. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @throws ForbiddenException ** Access forbidden. Check your credentials and then retry your request. *
* @sample AWSKafka.ListClientVpcConnections * @see AWS * API Documentation */ ListClientVpcConnectionsResult listClientVpcConnections(ListClientVpcConnectionsRequest listClientVpcConnectionsRequest); /** ** Returns a list of all the operations that have been performed on the specified MSK cluster. *
* * @param listClusterOperationsRequest * @return 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. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @throws UnauthorizedException ** The request is not authorized. The provided credentials couldn't be validated. *
* @throws ForbiddenException ** Access forbidden. Check your credentials and then retry your request. *
* @sample AWSKafka.ListClusterOperations * @see AWS * API Documentation */ ListClusterOperationsResult listClusterOperations(ListClusterOperationsRequest listClusterOperationsRequest); /** ** Returns a list of all the operations that have been performed on the specified MSK cluster. *
* * @param listClusterOperationsV2Request * @return 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. *
* @throws UnauthorizedException ** HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated. *
* @throws InternalServerErrorException ** HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue. *
* @throws ForbiddenException ** HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request. *
* @throws NotFoundException ** HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it. *
* @throws ServiceUnavailableException ** HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue. *
* @throws TooManyRequestsException ** HTTP Status Code 429: Limit exceeded. Resource limit reached. *
* @sample AWSKafka.ListClusterOperationsV2 * @see AWS * API Documentation */ ListClusterOperationsV2Result listClusterOperationsV2(ListClusterOperationsV2Request listClusterOperationsV2Request); /** ** Returns a list of all the MSK clusters in the current Region. *
* * @param listClustersRequest * @return 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. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @throws UnauthorizedException ** The request is not authorized. The provided credentials couldn't be validated. *
* @throws ForbiddenException ** Access forbidden. Check your credentials and then retry your request. *
* @sample AWSKafka.ListClusters * @see AWS API * Documentation */ ListClustersResult listClusters(ListClustersRequest listClustersRequest); /** ** Returns a list of all the MSK clusters in the current Region. *
* * @param listClustersV2Request * @return 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. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @throws UnauthorizedException ** The request is not authorized. The provided credentials couldn't be validated. *
* @throws ForbiddenException ** Access forbidden. Check your credentials and then retry your request. *
* @sample AWSKafka.ListClustersV2 * @see AWS API * Documentation */ ListClustersV2Result listClustersV2(ListClustersV2Request listClustersV2Request); /** ** Returns a list of all the MSK configurations in this Region. *
* * @param listConfigurationRevisionsRequest * @return 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. *
* @throws UnauthorizedException ** The request is not authorized. The provided credentials couldn't be validated. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @throws ForbiddenException ** Access forbidden. Check your credentials and then retry your request. *
* @throws NotFoundException ** The resource could not be found due to incorrect input. Correct the input, then retry the request. *
* @throws ServiceUnavailableException ** 503 response *
* @sample AWSKafka.ListConfigurationRevisions * @see AWS API Documentation */ ListConfigurationRevisionsResult listConfigurationRevisions(ListConfigurationRevisionsRequest listConfigurationRevisionsRequest); /** ** Returns a list of all the MSK configurations in this Region. *
* * @param listConfigurationsRequest * @return Result of the ListConfigurations operation returned by the service. * @throws ServiceUnavailableException ** 503 response *
* @throws BadRequestException ** The request isn't valid because the input is incorrect. Correct your input and then submit it again. *
* @throws UnauthorizedException ** The request is not authorized. The provided credentials couldn't be validated. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @throws ForbiddenException ** Access forbidden. Check your credentials and then retry your request. *
* @sample AWSKafka.ListConfigurations * @see AWS API * Documentation */ ListConfigurationsResult listConfigurations(ListConfigurationsRequest listConfigurationsRequest); /** ** Returns a list of Apache Kafka versions. *
* * @param listKafkaVersionsRequest * @return 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. *
* @throws UnauthorizedException ** The request is not authorized. The provided credentials couldn't be validated. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @throws ForbiddenException ** Access forbidden. Check your credentials and then retry your request. *
* @sample AWSKafka.ListKafkaVersions * @see AWS API * Documentation */ ListKafkaVersionsResult listKafkaVersions(ListKafkaVersionsRequest listKafkaVersionsRequest); /** ** Returns a list of the broker nodes in the cluster. *
* * @param listNodesRequest * @return 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. *
* @throws BadRequestException ** The request isn't valid because the input is incorrect. Correct your input and then submit it again. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @throws ForbiddenException ** Access forbidden. Check your credentials and then retry your request. *
* @sample AWSKafka.ListNodes * @see AWS API * Documentation */ ListNodesResult listNodes(ListNodesRequest listNodesRequest); /** ** Returns a list of the Scram Secrets associated with an Amazon MSK cluster. *
* * @param listScramSecretsRequest * @return 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. *
* @throws UnauthorizedException ** The request is not authorized. The provided credentials couldn't be validated. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @throws ForbiddenException ** Access forbidden. Check your credentials and then retry your request. *
* @throws NotFoundException ** The resource could not be found due to incorrect input. Correct the input, then retry the request. *
* @throws ServiceUnavailableException ** 503 response *
* @throws TooManyRequestsException ** 429 response *
* @sample AWSKafka.ListScramSecrets * @see AWS API * Documentation */ ListScramSecretsResult listScramSecrets(ListScramSecretsRequest listScramSecretsRequest); /** ** Returns a list of the tags associated with the specified resource. *
* * @param listTagsForResourceRequest * @return 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. *
* @throws BadRequestException ** The request isn't valid because the input is incorrect. Correct your input and then submit it again. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @sample AWSKafka.ListTagsForResource * @see AWS API * Documentation */ ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest); /** ** Returns a list of all the VPC connections in this Region. *
* * @param listVpcConnectionsRequest * @return Result of the ListVpcConnections operation returned by the service. * @throws ServiceUnavailableException ** 503 response *
* @throws BadRequestException ** The request isn't valid because the input is incorrect. Correct your input and then submit it again. *
* @throws UnauthorizedException ** The request is not authorized. The provided credentials couldn't be validated. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @throws ForbiddenException ** Access forbidden. Check your credentials and then retry your request. *
* @sample AWSKafka.ListVpcConnections * @see AWS API * Documentation */ ListVpcConnectionsResult listVpcConnections(ListVpcConnectionsRequest listVpcConnectionsRequest); /** ** Creates or updates the MSK cluster policy specified by the cluster Amazon Resource Name (ARN) in the request. *
* * @param putClusterPolicyRequest * @return 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. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @throws ForbiddenException ** Access forbidden. Check your credentials and then retry your request. *
* @sample AWSKafka.PutClusterPolicy * @see AWS API * Documentation */ PutClusterPolicyResult putClusterPolicy(PutClusterPolicyRequest putClusterPolicyRequest); /** * Reboots brokers. * * @param rebootBrokerRequest * Reboots a node. * @return 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. *
* @throws UnauthorizedException ** The request is not authorized. The provided credentials couldn't be validated. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @throws ForbiddenException ** Access forbidden. Check your credentials and then retry your request. *
* @throws NotFoundException ** The resource could not be found due to incorrect input. Correct the input, then retry the request. *
* @throws ServiceUnavailableException ** 503 response *
* @throws TooManyRequestsException ** 429 response *
* @sample AWSKafka.RebootBroker * @see AWS API * Documentation */ RebootBrokerResult rebootBroker(RebootBrokerRequest rebootBrokerRequest); /** ** Returns empty response. *
* * @param rejectClientVpcConnectionRequest * @return Result of the RejectClientVpcConnection operation returned by the service. * @throws ServiceUnavailableException ** 503 response *
* @throws BadRequestException ** The request isn't valid because the input is incorrect. Correct your input and then submit it again. *
* @throws UnauthorizedException ** The request is not authorized. The provided credentials couldn't be validated. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @throws ForbiddenException ** Access forbidden. Check your credentials and then retry your request. *
* @sample AWSKafka.RejectClientVpcConnection * @see AWS API Documentation */ RejectClientVpcConnectionResult rejectClientVpcConnection(RejectClientVpcConnectionRequest rejectClientVpcConnectionRequest); /** ** Adds tags to the specified MSK resource. *
* * @param tagResourceRequest * @return 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. *
* @throws BadRequestException ** The request isn't valid because the input is incorrect. Correct your input and then submit it again. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @sample AWSKafka.TagResource * @see AWS API * Documentation */ TagResourceResult tagResource(TagResourceRequest tagResourceRequest); /** ** Removes the tags associated with the keys that are provided in the query. *
* * @param untagResourceRequest * @return 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. *
* @throws BadRequestException ** The request isn't valid because the input is incorrect. Correct your input and then submit it again. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @sample AWSKafka.UntagResource * @see AWS API * Documentation */ UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest); /** ** Updates the number of broker nodes in the cluster. *
* * @param updateBrokerCountRequest * @return Result of the UpdateBrokerCount operation returned by the service. * @throws ServiceUnavailableException ** 503 response *
* @throws BadRequestException ** The request isn't valid because the input is incorrect. Correct your input and then submit it again. *
* @throws UnauthorizedException ** The request is not authorized. The provided credentials couldn't be validated. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @throws ForbiddenException ** Access forbidden. Check your credentials and then retry your request. *
* @sample AWSKafka.UpdateBrokerCount * @see AWS API * Documentation */ UpdateBrokerCountResult updateBrokerCount(UpdateBrokerCountRequest updateBrokerCountRequest); /** ** Updates the EBS storage associated with MSK brokers. *
* * @param updateBrokerStorageRequest * @return Result of the UpdateBrokerStorage operation returned by the service. * @throws ServiceUnavailableException ** 503 response *
* @throws BadRequestException ** The request isn't valid because the input is incorrect. Correct your input and then submit it again. *
* @throws UnauthorizedException ** The request is not authorized. The provided credentials couldn't be validated. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @throws ForbiddenException ** Access forbidden. Check your credentials and then retry your request. *
* @sample AWSKafka.UpdateBrokerStorage * @see AWS API * Documentation */ UpdateBrokerStorageResult updateBrokerStorage(UpdateBrokerStorageRequest updateBrokerStorageRequest); /** ** Updates EC2 instance type. *
* * @param updateBrokerTypeRequest * @return 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. *
* @throws UnauthorizedException ** The request is not authorized. The provided credentials couldn't be validated. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @throws ForbiddenException ** Access forbidden. Check your credentials and then retry your request. *
* @throws NotFoundException ** The resource could not be found due to incorrect input. Correct the input, then retry the request. *
* @throws ServiceUnavailableException ** 503 response *
* @throws TooManyRequestsException ** 429 response *
* @sample AWSKafka.UpdateBrokerType * @see AWS API * Documentation */ UpdateBrokerTypeResult updateBrokerType(UpdateBrokerTypeRequest updateBrokerTypeRequest); /** ** Updates the cluster with the configuration that is specified in the request body. *
* * @param updateClusterConfigurationRequest * @return 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. *
* @throws UnauthorizedException ** The request is not authorized. The provided credentials couldn't be validated. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @throws ForbiddenException ** Access forbidden. Check your credentials and then retry your request. *
* @throws NotFoundException ** The resource could not be found due to incorrect input. Correct the input, then retry the request. *
* @throws ServiceUnavailableException ** 503 response *
* @sample AWSKafka.UpdateClusterConfiguration * @see AWS API Documentation */ UpdateClusterConfigurationResult updateClusterConfiguration(UpdateClusterConfigurationRequest updateClusterConfigurationRequest); /** ** Updates the Apache Kafka version for the cluster. *
* * @param updateClusterKafkaVersionRequest * @return 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. *
* @throws UnauthorizedException ** The request is not authorized. The provided credentials couldn't be validated. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @throws ForbiddenException ** Access forbidden. Check your credentials and then retry your request. *
* @throws NotFoundException ** The resource could not be found due to incorrect input. Correct the input, then retry the request. *
* @throws ServiceUnavailableException ** 503 response *
* @throws TooManyRequestsException ** 429 response *
* @sample AWSKafka.UpdateClusterKafkaVersion * @see AWS API Documentation */ UpdateClusterKafkaVersionResult updateClusterKafkaVersion(UpdateClusterKafkaVersionRequest updateClusterKafkaVersionRequest); /** ** Updates an MSK configuration. *
* * @param updateConfigurationRequest * @return 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. *
* @throws UnauthorizedException ** The request is not authorized. The provided credentials couldn't be validated. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @throws ForbiddenException ** Access forbidden. Check your credentials and then retry your request. *
* @throws NotFoundException ** The resource could not be found due to incorrect input. Correct the input, then retry the request. *
* @throws ServiceUnavailableException ** 503 response *
* @sample AWSKafka.UpdateConfiguration * @see AWS API * Documentation */ UpdateConfigurationResult updateConfiguration(UpdateConfigurationRequest updateConfigurationRequest); /** ** Updates the cluster's connectivity configuration. *
* * @param updateConnectivityRequest * Request body for UpdateConnectivity. * @return 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. *
* @throws UnauthorizedException ** The request is not authorized. The provided credentials couldn't be validated. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @throws ForbiddenException ** Access forbidden. Check your credentials and then retry your request. *
* @throws NotFoundException ** The resource could not be found due to incorrect input. Correct the input, then retry the request. *
* @throws ServiceUnavailableException ** 503 response *
* @sample AWSKafka.UpdateConnectivity * @see AWS API * Documentation */ UpdateConnectivityResult updateConnectivity(UpdateConnectivityRequest updateConnectivityRequest); /** ** 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. *
* * @param updateMonitoringRequest * Request body for UpdateMonitoring. * @return Result of the UpdateMonitoring operation returned by the service. * @throws ServiceUnavailableException ** 503 response *
* @throws BadRequestException ** The request isn't valid because the input is incorrect. Correct your input and then submit it again. *
* @throws UnauthorizedException ** The request is not authorized. The provided credentials couldn't be validated. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @throws ForbiddenException ** Access forbidden. Check your credentials and then retry your request. *
* @sample AWSKafka.UpdateMonitoring * @see AWS API * Documentation */ UpdateMonitoringResult updateMonitoring(UpdateMonitoringRequest updateMonitoringRequest); /** ** Updates the security settings for the cluster. You can use this operation to specify encryption and * authentication on existing clusters. *
* * @param updateSecurityRequest * @return 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. *
* @throws UnauthorizedException ** The request is not authorized. The provided credentials couldn't be validated. *
* @throws InternalServerErrorException ** There was an unexpected internal server error. Retrying your request might resolve the issue. *
* @throws ForbiddenException ** Access forbidden. Check your credentials and then retry your request. *
* @throws NotFoundException ** The resource could not be found due to incorrect input. Correct the input, then retry the request. *
* @throws ServiceUnavailableException ** The service cannot complete the request. *
* @throws TooManyRequestsException ** The request throughput limit was exceeded. *
* @sample AWSKafka.UpdateSecurity * @see AWS API * Documentation */ UpdateSecurityResult updateSecurity(UpdateSecurityRequest updateSecurityRequest); /** * Updates cluster broker volume size (or) sets cluster storage mode to TIERED. * * @param updateStorageRequest ** Request object for UpdateStorage api. Its used to update the storage attributes for the cluster. *
* @return 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. * @throws UnauthorizedException * HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated. * @throws InternalServerErrorException * HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue. * @throws ForbiddenException * HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request. * @throws NotFoundException * HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it. * @throws ServiceUnavailableException * HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue. * @throws TooManyRequestsException * HTTP Status Code 429: Limit exceeded. Resource limit reached. * @sample AWSKafka.UpdateStorage * @see AWS API * Documentation */ UpdateStorageResult updateStorage(UpdateStorageRequest updateStorageRequest); /** * 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. */ void shutdown(); /** * 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. * * @param request * The originally executed request. * * @return The response metadata for the specified request, or null if none is available. */ ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); }