Package software.amazon.awssdk.services.elasticsearch

Interface ElasticsearchAsyncClient

All Superinterfaces:

AutoCloseable

@Generated("software.amazon.awssdk:codegen")
public interface ElasticsearchAsyncClient
extends AutoCloseable

Service client for accessing null asynchronously. This can be created using the static builder() method. Amazon Elasticsearch Configuration Service

Use the Amazon Elasticsearch configuration API to create, configure, and manage Elasticsearch domains.

The endpoint for configuration service requests is region-specific: es.region.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and Endpoints.

Method Summary

Modifier and Type	Method	Description
default CompletableFuture<AddTagsResponse>	addTags(AddTagsRequest addTagsRequest)	Attaches tags to an existing Elasticsearch domain.
static ElasticsearchAsyncClientBuilder	builder()	Create a builder that can be used to configure and create a ElasticsearchAsyncClient.
static ElasticsearchAsyncClient	create()	Create a ElasticsearchAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<CreateElasticsearchDomainResponse>	createElasticsearchDomain(CreateElasticsearchDomainRequest createElasticsearchDomainRequest)	Creates a new Elasticsearch domain.
default CompletableFuture<DeleteElasticsearchDomainResponse>	deleteElasticsearchDomain(DeleteElasticsearchDomainRequest deleteElasticsearchDomainRequest)	Permanently deletes the specified Elasticsearch domain and all of its data.
default CompletableFuture<DescribeElasticsearchDomainResponse>	describeElasticsearchDomain(DescribeElasticsearchDomainRequest describeElasticsearchDomainRequest)	Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.
default CompletableFuture<DescribeElasticsearchDomainConfigResponse>	describeElasticsearchDomainConfig(DescribeElasticsearchDomainConfigRequest describeElasticsearchDomainConfigRequest)	Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.
default CompletableFuture<DescribeElasticsearchDomainsResponse>	describeElasticsearchDomains(DescribeElasticsearchDomainsRequest describeElasticsearchDomainsRequest)	Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.
default CompletableFuture<DescribeElasticsearchInstanceTypeLimitsResponse>	describeElasticsearchInstanceTypeLimits(DescribeElasticsearchInstanceTypeLimitsRequest describeElasticsearchInstanceTypeLimitsRequest)	Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion.
default CompletableFuture<ListDomainNamesResponse>	listDomainNames(ListDomainNamesRequest listDomainNamesRequest)	Returns the name of all Elasticsearch domains owned by the current user's account.
default CompletableFuture<ListElasticsearchInstanceTypesResponse>	listElasticsearchInstanceTypes(ListElasticsearchInstanceTypesRequest listElasticsearchInstanceTypesRequest)	List all Elasticsearch instance types that are supported for given ElasticsearchVersion
default CompletableFuture<ListElasticsearchVersionsResponse>	listElasticsearchVersions(ListElasticsearchVersionsRequest listElasticsearchVersionsRequest)	List all supported Elasticsearch versions
default CompletableFuture<ListTagsResponse>	listTags(ListTagsRequest listTagsRequest)	Returns all tags for the given Elasticsearch domain.
default CompletableFuture<RemoveTagsResponse>	removeTags(RemoveTagsRequest removeTagsRequest)	Removes the specified set of tags from the specified Elasticsearch domain.
default CompletableFuture<UpdateElasticsearchDomainConfigResponse>	updateElasticsearchDomainConfig(UpdateElasticsearchDomainConfigRequest updateElasticsearchDomainConfigRequest)	Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

create

static ElasticsearchAsyncClient create()

Create a ElasticsearchAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static ElasticsearchAsyncClientBuilder builder()

Create a builder that can be used to configure and create a ElasticsearchAsyncClient.

addTags

default CompletableFuture<AddTagsResponse> addTags(AddTagsRequest addTagsRequest)

Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See Tagging Amazon Elasticsearch Service Domains for more information.

Parameters:

addTagsRequest - Container for the parameters to the AddTags operation. Specify the tags that you want to attach to the Elasticsearch domain.

Returns:

A Java Future containing the result of the AddTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BaseException An error occurred while processing the request.
• LimitExceededException An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
• ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
• InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

createElasticsearchDomain

default CompletableFuture<CreateElasticsearchDomainResponse> createElasticsearchDomain(CreateElasticsearchDomainRequest createElasticsearchDomainRequest)

Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.

Parameters:

createElasticsearchDomainRequest -

Returns:

A Java Future containing the result of the CreateElasticsearchDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BaseException An error occurred while processing the request.
• DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
• InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
• InvalidTypeException An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.
• LimitExceededException An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
• ResourceAlreadyExistsException An exception for creating a resource that already exists. Gives http status code of 400.
• ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

deleteElasticsearchDomain

default CompletableFuture<DeleteElasticsearchDomainResponse> deleteElasticsearchDomain(DeleteElasticsearchDomainRequest deleteElasticsearchDomainRequest)

Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.

Parameters:

deleteElasticsearchDomainRequest - Container for the parameters to the DeleteElasticsearchDomain operation. Specifies the name of the Elasticsearch domain that you want to delete.

Returns:

A Java Future containing the result of the DeleteElasticsearchDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BaseException An error occurred while processing the request.
• InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
• ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
• ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

describeElasticsearchDomain

default CompletableFuture<DescribeElasticsearchDomainResponse> describeElasticsearchDomain(DescribeElasticsearchDomainRequest describeElasticsearchDomainRequest)

Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.

Parameters:

describeElasticsearchDomainRequest - Container for the parameters to the DescribeElasticsearchDomain operation.

Returns:

A Java Future containing the result of the DescribeElasticsearchDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BaseException An error occurred while processing the request.
• InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
• ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
• ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

describeElasticsearchDomainConfig

default CompletableFuture<DescribeElasticsearchDomainConfigResponse> describeElasticsearchDomainConfig(DescribeElasticsearchDomainConfigRequest describeElasticsearchDomainConfigRequest)

Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.

Parameters:

describeElasticsearchDomainConfigRequest - Container for the parameters to the DescribeElasticsearchDomainConfig operation. Specifies the domain name for which you want configuration information.

Returns:

A Java Future containing the result of the DescribeElasticsearchDomainConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BaseException An error occurred while processing the request.
• InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
• ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
• ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

describeElasticsearchDomains

default CompletableFuture<DescribeElasticsearchDomainsResponse> describeElasticsearchDomains(DescribeElasticsearchDomainsRequest describeElasticsearchDomainsRequest)

Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.

Parameters:

describeElasticsearchDomainsRequest - Container for the parameters to the DescribeElasticsearchDomains operation. By default, the API returns the status of all Elasticsearch domains.

Returns:

A Java Future containing the result of the DescribeElasticsearchDomains operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BaseException An error occurred while processing the request.
• InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
• ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

describeElasticsearchInstanceTypeLimits

default CompletableFuture<DescribeElasticsearchInstanceTypeLimitsResponse> describeElasticsearchInstanceTypeLimits(DescribeElasticsearchInstanceTypeLimitsRequest describeElasticsearchInstanceTypeLimitsRequest)

Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the DomainName to know what Limits are supported for modifying.

Parameters:

describeElasticsearchInstanceTypeLimitsRequest - Container for the parameters to DescribeElasticsearchInstanceTypeLimits operation.

Returns:

A Java Future containing the result of the DescribeElasticsearchInstanceTypeLimits operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BaseException An error occurred while processing the request.
• InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
• InvalidTypeException An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.
• LimitExceededException An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
• ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
• ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

listDomainNames

default CompletableFuture<ListDomainNamesResponse> listDomainNames(ListDomainNamesRequest listDomainNamesRequest)

Returns the name of all Elasticsearch domains owned by the current user's account.

Parameters:

listDomainNamesRequest -

Returns:

A Java Future containing the result of the ListDomainNames operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BaseException An error occurred while processing the request.
• ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

listElasticsearchInstanceTypes

default CompletableFuture<ListElasticsearchInstanceTypesResponse> listElasticsearchInstanceTypes(ListElasticsearchInstanceTypesRequest listElasticsearchInstanceTypesRequest)

List all Elasticsearch instance types that are supported for given ElasticsearchVersion

Parameters:

listElasticsearchInstanceTypesRequest - Container for the parameters to the ListElasticsearchInstanceTypes operation.

Returns:

A Java Future containing the result of the ListElasticsearchInstanceTypes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BaseException An error occurred while processing the request.
• InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
• ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
• ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

listElasticsearchVersions

default CompletableFuture<ListElasticsearchVersionsResponse> listElasticsearchVersions(ListElasticsearchVersionsRequest listElasticsearchVersionsRequest)

List all supported Elasticsearch versions

Parameters:

listElasticsearchVersionsRequest - Container for the parameters to the ListElasticsearchVersions operation.

Use MaxResults to control the maximum number of results to retrieve in a single call.

Use NextToken in response to retrieve more results. If the received response does not contain a NextToken, then there are no more results to retrieve.

Returns:

A Java Future containing the result of the ListElasticsearchVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BaseException An error occurred while processing the request.
• InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
• ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
• ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

listTags

default CompletableFuture<ListTagsResponse> listTags(ListTagsRequest listTagsRequest)

Returns all tags for the given Elasticsearch domain.

Parameters:

listTagsRequest - Container for the parameters to the ListTags operation. Specify the ARN for the Elasticsearch domain to which the tags are attached that you want to view are attached.

Returns:

A Java Future containing the result of the ListTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BaseException An error occurred while processing the request.
• ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
• ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
• InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

removeTags

default CompletableFuture<RemoveTagsResponse> removeTags(RemoveTagsRequest removeTagsRequest)

Removes the specified set of tags from the specified Elasticsearch domain.

Parameters:

removeTagsRequest - Container for the parameters to the RemoveTags operation. Specify the ARN for the Elasticsearch domain from which you want to remove the specified TagKey.

Returns:

A Java Future containing the result of the RemoveTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BaseException An error occurred while processing the request.
• ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
• InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

updateElasticsearchDomainConfig

default CompletableFuture<UpdateElasticsearchDomainConfigResponse> updateElasticsearchDomainConfig(UpdateElasticsearchDomainConfigRequest updateElasticsearchDomainConfigRequest)

Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.

Parameters:

updateElasticsearchDomainConfigRequest - Container for the parameters to the UpdateElasticsearchDomain operation. Specifies the type and number of instances in the domain cluster.

Returns:

A Java Future containing the result of the UpdateElasticsearchDomainConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BaseException An error occurred while processing the request.
• InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
• InvalidTypeException An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.
• LimitExceededException An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
• ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
• ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this