com.amazonaws.services.elasticsearch

Class AWSElasticsearchClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.elasticsearch.AWSElasticsearchClient

All Implemented Interfaces:

AWSElasticsearch

Direct Known Subclasses:

AWSElasticsearchAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSElasticsearchClient
extends AmazonWebServiceClient
implements AWSElasticsearch

Client for accessing Amazon Elasticsearch Service. All service calls made using this client are blocking, and will not return until the service call completes.

Amazon Elasticsearch Configuration Service

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

For sample code that uses the Configuration API, see the Amazon Elasticsearch Service Developer Guide. The guide also contains sample code for sending signed HTTP requests to the Elasticsearch APIs.

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.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.elasticsearch.AWSElasticsearch

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AWSElasticsearchClient() Deprecated. use AWSElasticsearchClientBuilder.defaultClient()
AWSElasticsearchClient(AWSCredentials awsCredentials) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AWSElasticsearchClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
AWSElasticsearchClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AWSElasticsearchClient(AWSCredentialsProvider awsCredentialsProvider) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
AWSElasticsearchClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AWSElasticsearchClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
AWSElasticsearchClient(ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Method Summary

Modifier and Type	Method and Description
AcceptInboundCrossClusterSearchConnectionResult	acceptInboundCrossClusterSearchConnection(AcceptInboundCrossClusterSearchConnectionRequest request) Allows the destination domain owner to accept an inbound cross-cluster search connection request.
AddTagsResult	addTags(AddTagsRequest request) Attaches tags to an existing Elasticsearch domain.
AssociatePackageResult	associatePackage(AssociatePackageRequest request) Associates a package with an Amazon ES domain.
AuthorizeVpcEndpointAccessResult	authorizeVpcEndpointAccess(AuthorizeVpcEndpointAccessRequest request) Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
static AWSElasticsearchClientBuilder	builder()
CancelElasticsearchServiceSoftwareUpdateResult	cancelElasticsearchServiceSoftwareUpdate(CancelElasticsearchServiceSoftwareUpdateRequest request) Cancels a scheduled service software update for an Amazon ES domain.
CreateElasticsearchDomainResult	createElasticsearchDomain(CreateElasticsearchDomainRequest request) Creates a new Elasticsearch domain.
CreateOutboundCrossClusterSearchConnectionResult	createOutboundCrossClusterSearchConnection(CreateOutboundCrossClusterSearchConnectionRequest request) Creates a new cross-cluster search connection from a source domain to a destination domain.
CreatePackageResult	createPackage(CreatePackageRequest request) Create a package for use with Amazon ES domains.
CreateVpcEndpointResult	createVpcEndpoint(CreateVpcEndpointRequest request) Creates an Amazon OpenSearch Service-managed VPC endpoint.
DeleteElasticsearchDomainResult	deleteElasticsearchDomain(DeleteElasticsearchDomainRequest request) Permanently deletes the specified Elasticsearch domain and all of its data.
DeleteElasticsearchServiceRoleResult	deleteElasticsearchServiceRole(DeleteElasticsearchServiceRoleRequest request) Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains.
DeleteInboundCrossClusterSearchConnectionResult	deleteInboundCrossClusterSearchConnection(DeleteInboundCrossClusterSearchConnectionRequest request) Allows the destination domain owner to delete an existing inbound cross-cluster search connection.
DeleteOutboundCrossClusterSearchConnectionResult	deleteOutboundCrossClusterSearchConnection(DeleteOutboundCrossClusterSearchConnectionRequest request) Allows the source domain owner to delete an existing outbound cross-cluster search connection.
DeletePackageResult	deletePackage(DeletePackageRequest request) Delete the package.
DeleteVpcEndpointResult	deleteVpcEndpoint(DeleteVpcEndpointRequest request) Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
DescribeDomainAutoTunesResult	describeDomainAutoTunes(DescribeDomainAutoTunesRequest request) Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date.
DescribeDomainChangeProgressResult	describeDomainChangeProgress(DescribeDomainChangeProgressRequest request) Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.
DescribeElasticsearchDomainResult	describeElasticsearchDomain(DescribeElasticsearchDomainRequest request) Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.
DescribeElasticsearchDomainConfigResult	describeElasticsearchDomainConfig(DescribeElasticsearchDomainConfigRequest request) Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.
DescribeElasticsearchDomainsResult	describeElasticsearchDomains(DescribeElasticsearchDomainsRequest request) Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.
DescribeElasticsearchInstanceTypeLimitsResult	describeElasticsearchInstanceTypeLimits(DescribeElasticsearchInstanceTypeLimitsRequest request) Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion.
DescribeInboundCrossClusterSearchConnectionsResult	describeInboundCrossClusterSearchConnections(DescribeInboundCrossClusterSearchConnectionsRequest request) Lists all the inbound cross-cluster search connections for a destination domain.
DescribeOutboundCrossClusterSearchConnectionsResult	describeOutboundCrossClusterSearchConnections(DescribeOutboundCrossClusterSearchConnectionsRequest request) Lists all the outbound cross-cluster search connections for a source domain.
DescribePackagesResult	describePackages(DescribePackagesRequest request) Describes all packages available to Amazon ES.
DescribeReservedElasticsearchInstanceOfferingsResult	describeReservedElasticsearchInstanceOfferings(DescribeReservedElasticsearchInstanceOfferingsRequest request) Lists available reserved Elasticsearch instance offerings.
DescribeReservedElasticsearchInstancesResult	describeReservedElasticsearchInstances(DescribeReservedElasticsearchInstancesRequest request) Returns information about reserved Elasticsearch instances for this account.
DescribeVpcEndpointsResult	describeVpcEndpoints(DescribeVpcEndpointsRequest request) Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
DissociatePackageResult	dissociatePackage(DissociatePackageRequest request) Dissociates a package from the Amazon ES domain.
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.
GetCompatibleElasticsearchVersionsResult	getCompatibleElasticsearchVersions(GetCompatibleElasticsearchVersionsRequest request) Returns a list of upgrade compatible Elastisearch versions.
GetPackageVersionHistoryResult	getPackageVersionHistory(GetPackageVersionHistoryRequest request) Returns a list of versions of the package, along with their creation time and commit message.
GetUpgradeHistoryResult	getUpgradeHistory(GetUpgradeHistoryRequest request) Retrieves the complete history of the last 10 upgrades that were performed on the domain.
GetUpgradeStatusResult	getUpgradeStatus(GetUpgradeStatusRequest request) Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.
ListDomainNamesResult	listDomainNames(ListDomainNamesRequest request) Returns the name of all Elasticsearch domains owned by the current user's account.
ListDomainsForPackageResult	listDomainsForPackage(ListDomainsForPackageRequest request) Lists all Amazon ES domains associated with the package.
ListElasticsearchInstanceTypesResult	listElasticsearchInstanceTypes(ListElasticsearchInstanceTypesRequest request) List all Elasticsearch instance types that are supported for given ElasticsearchVersion
ListElasticsearchVersionsResult	listElasticsearchVersions(ListElasticsearchVersionsRequest request) List all supported Elasticsearch versions
ListPackagesForDomainResult	listPackagesForDomain(ListPackagesForDomainRequest request) Lists all packages associated with the Amazon ES domain.
ListTagsResult	listTags(ListTagsRequest request) Returns all tags for the given Elasticsearch domain.
ListVpcEndpointAccessResult	listVpcEndpointAccess(ListVpcEndpointAccessRequest request) Retrieves information about each principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
ListVpcEndpointsResult	listVpcEndpoints(ListVpcEndpointsRequest request) Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current account and Region.
ListVpcEndpointsForDomainResult	listVpcEndpointsForDomain(ListVpcEndpointsForDomainRequest request) Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.
PurchaseReservedElasticsearchInstanceOfferingResult	purchaseReservedElasticsearchInstanceOffering(PurchaseReservedElasticsearchInstanceOfferingRequest request) Allows you to purchase reserved Elasticsearch instances.
RejectInboundCrossClusterSearchConnectionResult	rejectInboundCrossClusterSearchConnection(RejectInboundCrossClusterSearchConnectionRequest request) Allows the destination domain owner to reject an inbound cross-cluster search connection request.
RemoveTagsResult	removeTags(RemoveTagsRequest request) Removes the specified set of tags from the specified Elasticsearch domain.
RevokeVpcEndpointAccessResult	revokeVpcEndpointAccess(RevokeVpcEndpointAccessRequest request) Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartElasticsearchServiceSoftwareUpdateResult	startElasticsearchServiceSoftwareUpdate(StartElasticsearchServiceSoftwareUpdateRequest request) Schedules a service software update for an Amazon ES domain.
UpdateElasticsearchDomainConfigResult	updateElasticsearchDomainConfig(UpdateElasticsearchDomainConfigRequest request) Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.
UpdatePackageResult	updatePackage(UpdatePackageRequest request) Updates a package for use with Amazon ES domains.
UpdateVpcEndpointResult	updateVpcEndpoint(UpdateVpcEndpointRequest request) Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
UpgradeElasticsearchDomainResult	upgradeElasticsearchDomain(UpgradeElasticsearchDomainRequest request) Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.elasticsearch.AWSElasticsearch

setEndpoint, setRegion

Constructor Detail

AWSElasticsearchClient

@Deprecated
public AWSElasticsearchClient()

Deprecated. use AWSElasticsearchClientBuilder.defaultClient()

Constructs a new client to invoke service methods on Amazon Elasticsearch Service. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AWSElasticsearchClient

@Deprecated
public AWSElasticsearchClient(ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on Amazon Elasticsearch Service. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to Amazon Elasticsearch Service (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AWSElasticsearchClient

@Deprecated
public AWSElasticsearchClient(AWSCredentials awsCredentials)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AWSElasticsearchClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();

Constructs a new client to invoke service methods on Amazon Elasticsearch Service using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AWSElasticsearchClient

@Deprecated
public AWSElasticsearchClient(AWSCredentials awsCredentials,
                                          ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on Amazon Elasticsearch Service using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to Amazon Elasticsearch Service (ex: proxy settings, retry counts, etc.).

AWSElasticsearchClient

@Deprecated
public AWSElasticsearchClient(AWSCredentialsProvider awsCredentialsProvider)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)

Constructs a new client to invoke service methods on Amazon Elasticsearch Service using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AWSElasticsearchClient

@Deprecated
public AWSElasticsearchClient(AWSCredentialsProvider awsCredentialsProvider,
                                          ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on Amazon Elasticsearch Service using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to Amazon Elasticsearch Service (ex: proxy settings, retry counts, etc.).

AWSElasticsearchClient

@Deprecated
public AWSElasticsearchClient(AWSCredentialsProvider awsCredentialsProvider,
                                          ClientConfiguration clientConfiguration,
                                          RequestMetricCollector requestMetricCollector)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)

Constructs a new client to invoke service methods on Amazon Elasticsearch Service using the specified AWS account credentials provider, client configuration options, and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to Amazon Elasticsearch Service (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

builder

public static AWSElasticsearchClientBuilder builder()

acceptInboundCrossClusterSearchConnection

public AcceptInboundCrossClusterSearchConnectionResult acceptInboundCrossClusterSearchConnection(AcceptInboundCrossClusterSearchConnectionRequest request)

Allows the destination domain owner to accept an inbound cross-cluster search connection request.

Specified by:

acceptInboundCrossClusterSearchConnection in interface AWSElasticsearch

Parameters:

acceptInboundCrossClusterSearchConnectionRequest - Container for the parameters to the AcceptInboundCrossClusterSearchConnection operation.

Returns:

Result of the AcceptInboundCrossClusterSearchConnection operation returned by the service.

Throws:

ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.

DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

addTags

public AddTagsResult addTags(AddTagsRequest request)

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.

Specified by:

addTags in interface AWSElasticsearch

Parameters:

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

Returns:

Result of the AddTags operation returned by the service.

Throws:

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.

associatePackage

public AssociatePackageResult associatePackage(AssociatePackageRequest request)

Associates a package with an Amazon ES domain.

Specified by:

associatePackage in interface AWSElasticsearch

Parameters:

associatePackageRequest - Container for request parameters to AssociatePackage operation.

Returns:

Result of the AssociatePackage operation returned by the service.

Throws:

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.

AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.

ConflictException - An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.

authorizeVpcEndpointAccess

public AuthorizeVpcEndpointAccessResult authorizeVpcEndpointAccess(AuthorizeVpcEndpointAccessRequest request)

Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

Specified by:

authorizeVpcEndpointAccess in interface AWSElasticsearch

Parameters:

authorizeVpcEndpointAccessRequest - Container for request parameters to the AuthorizeVpcEndpointAccess operation. Specifies the account to be permitted to manage VPC endpoints against the domain.

Returns:

Result of the AuthorizeVpcEndpointAccess operation returned by the service.

Throws:

ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

DisabledOperationException - An error occured because the client wanted to access a not supported operation. 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.

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.

BaseException - An error occurred while processing the request.

cancelElasticsearchServiceSoftwareUpdate

public CancelElasticsearchServiceSoftwareUpdateResult cancelElasticsearchServiceSoftwareUpdate(CancelElasticsearchServiceSoftwareUpdateRequest request)

Cancels a scheduled service software update for an Amazon ES domain. You can only perform this operation before the AutomatedUpdateDate and when the UpdateStatus is in the PENDING_UPDATE state.

Specified by:

cancelElasticsearchServiceSoftwareUpdate in interface AWSElasticsearch

Parameters:

cancelElasticsearchServiceSoftwareUpdateRequest - Container for the parameters to the CancelElasticsearchServiceSoftwareUpdate operation. Specifies the name of the Elasticsearch domain that you wish to cancel a service software update on.

Returns:

Result of the CancelElasticsearchServiceSoftwareUpdate operation returned by the service.

Throws:

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.

createElasticsearchDomain

public CreateElasticsearchDomainResult createElasticsearchDomain(CreateElasticsearchDomainRequest request)

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

Specified by:

createElasticsearchDomain in interface AWSElasticsearch

Parameters:

createElasticsearchDomainRequest -

Returns:

Result of the CreateElasticsearchDomain operation returned by the service.

Throws:

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.

createOutboundCrossClusterSearchConnection

public CreateOutboundCrossClusterSearchConnectionResult createOutboundCrossClusterSearchConnection(CreateOutboundCrossClusterSearchConnectionRequest request)

Creates a new cross-cluster search connection from a source domain to a destination domain.

Specified by:

createOutboundCrossClusterSearchConnection in interface AWSElasticsearch

Parameters:

createOutboundCrossClusterSearchConnectionRequest - Container for the parameters to the CreateOutboundCrossClusterSearchConnection operation.

Returns:

Result of the CreateOutboundCrossClusterSearchConnection operation returned by the service.

Throws:

LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. 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.

ResourceAlreadyExistsException - An exception for creating a resource that already exists. Gives http status code of 400.

DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

createPackage

public CreatePackageResult createPackage(CreatePackageRequest request)

Create a package for use with Amazon ES domains.

Specified by:

createPackage in interface AWSElasticsearch

Parameters:

createPackageRequest - Container for request parameters to CreatePackage operation.

Returns:

Result of the CreatePackage operation returned by the service.

Throws:

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.

LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.

InvalidTypeException - An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.

ResourceAlreadyExistsException - An exception for creating a resource that already exists. Gives http status code of 400.

AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.

createVpcEndpoint

public CreateVpcEndpointResult createVpcEndpoint(CreateVpcEndpointRequest request)

Creates an Amazon OpenSearch Service-managed VPC endpoint.

Specified by:

createVpcEndpoint in interface AWSElasticsearch

Parameters:

createVpcEndpointRequest - Container for the parameters to the CreateVpcEndpointRequest operation.

Returns:

Result of the CreateVpcEndpoint operation returned by the service.

Throws:

ConflictException - An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.

ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.

LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. 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.

DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

BaseException - An error occurred while processing the request.

deleteElasticsearchDomain

public DeleteElasticsearchDomainResult deleteElasticsearchDomain(DeleteElasticsearchDomainRequest request)

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

Specified by:

deleteElasticsearchDomain in interface AWSElasticsearch

Parameters:

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

Returns:

Result of the DeleteElasticsearchDomain operation returned by the service.

Throws:

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.

deleteElasticsearchServiceRole

public DeleteElasticsearchServiceRoleResult deleteElasticsearchServiceRole(DeleteElasticsearchServiceRoleRequest request)

Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains. Role deletion will fail if any existing VPC domains use the role. You must delete any such Elasticsearch domains before deleting the role. See Deleting Elasticsearch Service Role in VPC Endpoints for Amazon Elasticsearch Service Domains.

Specified by:

deleteElasticsearchServiceRole in interface AWSElasticsearch

Parameters:

deleteElasticsearchServiceRoleRequest -

Returns:

Result of the DeleteElasticsearchServiceRole operation returned by the service.

Throws:

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.

deleteInboundCrossClusterSearchConnection

public DeleteInboundCrossClusterSearchConnectionResult deleteInboundCrossClusterSearchConnection(DeleteInboundCrossClusterSearchConnectionRequest request)

Allows the destination domain owner to delete an existing inbound cross-cluster search connection.

Specified by:

deleteInboundCrossClusterSearchConnection in interface AWSElasticsearch

Parameters:

deleteInboundCrossClusterSearchConnectionRequest - Container for the parameters to the DeleteInboundCrossClusterSearchConnection operation.

Returns:

Result of the DeleteInboundCrossClusterSearchConnection operation returned by the service.

Throws:

ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

deleteOutboundCrossClusterSearchConnection

public DeleteOutboundCrossClusterSearchConnectionResult deleteOutboundCrossClusterSearchConnection(DeleteOutboundCrossClusterSearchConnectionRequest request)

Allows the source domain owner to delete an existing outbound cross-cluster search connection.

Specified by:

deleteOutboundCrossClusterSearchConnection in interface AWSElasticsearch

Parameters:

deleteOutboundCrossClusterSearchConnectionRequest - Container for the parameters to the DeleteOutboundCrossClusterSearchConnection operation.

Returns:

Result of the DeleteOutboundCrossClusterSearchConnection operation returned by the service.

Throws:

ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

deletePackage

public DeletePackageResult deletePackage(DeletePackageRequest request)

Delete the package.

Specified by:

deletePackage in interface AWSElasticsearch

Parameters:

deletePackageRequest - Container for request parameters to DeletePackage operation.

Returns:

Result of the DeletePackage operation returned by the service.

Throws:

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.

AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.

ConflictException - An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.

deleteVpcEndpoint

public DeleteVpcEndpointResult deleteVpcEndpoint(DeleteVpcEndpointRequest request)

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

Specified by:

deleteVpcEndpoint in interface AWSElasticsearch

Parameters:

deleteVpcEndpointRequest - Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

Returns:

Result of the DeleteVpcEndpoint operation returned by the service.

Throws:

ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

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.

BaseException - An error occurred while processing the request.

describeDomainAutoTunes

public DescribeDomainAutoTunesResult describeDomainAutoTunes(DescribeDomainAutoTunesRequest request)

Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date.

Specified by:

describeDomainAutoTunes in interface AWSElasticsearch

Parameters:

describeDomainAutoTunesRequest - Container for the parameters to the DescribeDomainAutoTunes operation.

Returns:

Result of the DescribeDomainAutoTunes operation returned by the service.

Throws:

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.

describeDomainChangeProgress

public DescribeDomainChangeProgressResult describeDomainChangeProgress(DescribeDomainChangeProgressRequest request)

Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.

Specified by:

describeDomainChangeProgress in interface AWSElasticsearch

Parameters:

describeDomainChangeProgressRequest - Container for the parameters to the DescribeDomainChangeProgress operation. Specifies the domain name and optional change specific identity for which you want progress information.

Returns:

Result of the DescribeDomainChangeProgress operation returned by the service.

Throws:

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.

describeElasticsearchDomain

public DescribeElasticsearchDomainResult describeElasticsearchDomain(DescribeElasticsearchDomainRequest request)

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

Specified by:

describeElasticsearchDomain in interface AWSElasticsearch

Parameters:

describeElasticsearchDomainRequest - Container for the parameters to the DescribeElasticsearchDomain operation.

Returns:

Result of the DescribeElasticsearchDomain operation returned by the service.

Throws:

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.

describeElasticsearchDomainConfig

public DescribeElasticsearchDomainConfigResult describeElasticsearchDomainConfig(DescribeElasticsearchDomainConfigRequest request)

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

Specified by:

describeElasticsearchDomainConfig in interface AWSElasticsearch

Parameters:

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

Returns:

Result of the DescribeElasticsearchDomainConfig operation returned by the service.

Throws:

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.

describeElasticsearchDomains

public DescribeElasticsearchDomainsResult describeElasticsearchDomains(DescribeElasticsearchDomainsRequest request)

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

Specified by:

describeElasticsearchDomains in interface AWSElasticsearch

Parameters:

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

Returns:

Result of the DescribeElasticsearchDomains operation returned by the service.

Throws:

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.

describeElasticsearchInstanceTypeLimits

public DescribeElasticsearchInstanceTypeLimitsResult describeElasticsearchInstanceTypeLimits(DescribeElasticsearchInstanceTypeLimitsRequest request)

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

Specified by:

describeElasticsearchInstanceTypeLimits in interface AWSElasticsearch

Parameters:

describeElasticsearchInstanceTypeLimitsRequest - Container for the parameters to DescribeElasticsearchInstanceTypeLimits operation.

Returns:

Result of the DescribeElasticsearchInstanceTypeLimits operation returned by the service.

Throws:

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.

describeInboundCrossClusterSearchConnections

public DescribeInboundCrossClusterSearchConnectionsResult describeInboundCrossClusterSearchConnections(DescribeInboundCrossClusterSearchConnectionsRequest request)

Lists all the inbound cross-cluster search connections for a destination domain.

Specified by:

describeInboundCrossClusterSearchConnections in interface AWSElasticsearch

Parameters:

describeInboundCrossClusterSearchConnectionsRequest - Container for the parameters to the DescribeInboundCrossClusterSearchConnections operation.

Returns:

Result of the DescribeInboundCrossClusterSearchConnections operation returned by the service.

Throws:

InvalidPaginationTokenException - The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400.

DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

describeOutboundCrossClusterSearchConnections

public DescribeOutboundCrossClusterSearchConnectionsResult describeOutboundCrossClusterSearchConnections(DescribeOutboundCrossClusterSearchConnectionsRequest request)

Lists all the outbound cross-cluster search connections for a source domain.

Specified by:

describeOutboundCrossClusterSearchConnections in interface AWSElasticsearch

Parameters:

describeOutboundCrossClusterSearchConnectionsRequest - Container for the parameters to the DescribeOutboundCrossClusterSearchConnections operation.

Returns:

Result of the DescribeOutboundCrossClusterSearchConnections operation returned by the service.

Throws:

InvalidPaginationTokenException - The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400.

DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

describePackages

public DescribePackagesResult describePackages(DescribePackagesRequest request)

Describes all packages available to Amazon ES. Includes options for filtering, limiting the number of results, and pagination.

Specified by:

describePackages in interface AWSElasticsearch

Parameters:

describePackagesRequest - Container for request parameters to DescribePackage operation.

Returns:

Result of the DescribePackages operation returned by the service.

Throws:

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.

AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.

describeReservedElasticsearchInstanceOfferings

public DescribeReservedElasticsearchInstanceOfferingsResult describeReservedElasticsearchInstanceOfferings(DescribeReservedElasticsearchInstanceOfferingsRequest request)

Lists available reserved Elasticsearch instance offerings.

Specified by:

describeReservedElasticsearchInstanceOfferings in interface AWSElasticsearch

Parameters:

describeReservedElasticsearchInstanceOfferingsRequest - Container for parameters to DescribeReservedElasticsearchInstanceOfferings

Returns:

Result of the DescribeReservedElasticsearchInstanceOfferings operation returned by the service.

Throws:

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.

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.

describeReservedElasticsearchInstances

public DescribeReservedElasticsearchInstancesResult describeReservedElasticsearchInstances(DescribeReservedElasticsearchInstancesRequest request)

Returns information about reserved Elasticsearch instances for this account.

Specified by:

describeReservedElasticsearchInstances in interface AWSElasticsearch

Parameters:

describeReservedElasticsearchInstancesRequest - Container for parameters to DescribeReservedElasticsearchInstances

Returns:

Result of the DescribeReservedElasticsearchInstances operation returned by the service.

Throws:

ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. 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.

ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.

DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

describeVpcEndpoints

public DescribeVpcEndpointsResult describeVpcEndpoints(DescribeVpcEndpointsRequest request)

Describes one or more Amazon OpenSearch Service-managed VPC endpoints.

Specified by:

describeVpcEndpoints in interface AWSElasticsearch

Parameters:

describeVpcEndpointsRequest - Container for request parameters to the DescribeVpcEndpoints operation. Specifies the list of VPC endpoints to be described.

Returns:

Result of the DescribeVpcEndpoints operation returned by the service.

Throws:

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.

DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

BaseException - An error occurred while processing the request.

dissociatePackage

public DissociatePackageResult dissociatePackage(DissociatePackageRequest request)

Dissociates a package from the Amazon ES domain.

Specified by:

dissociatePackage in interface AWSElasticsearch

Parameters:

dissociatePackageRequest - Container for request parameters to DissociatePackage operation.

Returns:

Result of the DissociatePackage operation returned by the service.

Throws:

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.

AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.

ConflictException - An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.

getCompatibleElasticsearchVersions

public GetCompatibleElasticsearchVersionsResult getCompatibleElasticsearchVersions(GetCompatibleElasticsearchVersionsRequest request)

Returns a list of upgrade compatible Elastisearch versions. You can optionally pass a DomainName to get all upgrade compatible Elasticsearch versions for that specific domain.

Specified by:

getCompatibleElasticsearchVersions in interface AWSElasticsearch

Parameters:

getCompatibleElasticsearchVersionsRequest - Container for request parameters to GetCompatibleElasticsearchVersions operation.

Returns:

Result of the GetCompatibleElasticsearchVersions operation returned by the service.

Throws:

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.

DisabledOperationException - An error occured because the client wanted to access a not supported operation. 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.

getPackageVersionHistory

public GetPackageVersionHistoryResult getPackageVersionHistory(GetPackageVersionHistoryRequest request)

Returns a list of versions of the package, along with their creation time and commit message.

Specified by:

getPackageVersionHistory in interface AWSElasticsearch

Parameters:

getPackageVersionHistoryRequest - Container for request parameters to GetPackageVersionHistory operation.

Returns:

Result of the GetPackageVersionHistory operation returned by the service.

Throws:

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.

AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.

getUpgradeHistory

public GetUpgradeHistoryResult getUpgradeHistory(GetUpgradeHistoryRequest request)

Retrieves the complete history of the last 10 upgrades that were performed on the domain.

Specified by:

getUpgradeHistory in interface AWSElasticsearch

Parameters:

getUpgradeHistoryRequest - Container for request parameters to GetUpgradeHistory operation.

Returns:

Result of the GetUpgradeHistory operation returned by the service.

Throws:

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.

DisabledOperationException - An error occured because the client wanted to access a not supported operation. 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.

getUpgradeStatus

public GetUpgradeStatusResult getUpgradeStatus(GetUpgradeStatusRequest request)

Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.

Specified by:

getUpgradeStatus in interface AWSElasticsearch

Parameters:

getUpgradeStatusRequest - Container for request parameters to GetUpgradeStatus operation.

Returns:

Result of the GetUpgradeStatus operation returned by the service.

Throws:

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.

DisabledOperationException - An error occured because the client wanted to access a not supported operation. 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.

listDomainNames

public ListDomainNamesResult listDomainNames(ListDomainNamesRequest request)

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

Specified by:

listDomainNames in interface AWSElasticsearch

Parameters:

listDomainNamesRequest - Container for the parameters to the ListDomainNames operation.

Returns:

Result of the ListDomainNames operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.

listDomainsForPackage

public ListDomainsForPackageResult listDomainsForPackage(ListDomainsForPackageRequest request)

Lists all Amazon ES domains associated with the package.

Specified by:

listDomainsForPackage in interface AWSElasticsearch

Parameters:

listDomainsForPackageRequest - Container for request parameters to ListDomainsForPackage operation.

Returns:

Result of the ListDomainsForPackage operation returned by the service.

Throws:

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.

AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.

listElasticsearchInstanceTypes

public ListElasticsearchInstanceTypesResult listElasticsearchInstanceTypes(ListElasticsearchInstanceTypesRequest request)

List all Elasticsearch instance types that are supported for given ElasticsearchVersion

Specified by:

listElasticsearchInstanceTypes in interface AWSElasticsearch

Parameters:

listElasticsearchInstanceTypesRequest - Container for the parameters to the ListElasticsearchInstanceTypes operation.

Returns:

Result of the ListElasticsearchInstanceTypes operation returned by the service.

Throws:

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.

listElasticsearchVersions

public ListElasticsearchVersionsResult listElasticsearchVersions(ListElasticsearchVersionsRequest request)

List all supported Elasticsearch versions

Specified by:

listElasticsearchVersions in interface AWSElasticsearch

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:

Result of the ListElasticsearchVersions operation returned by the service.

Throws:

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.

listPackagesForDomain

public ListPackagesForDomainResult listPackagesForDomain(ListPackagesForDomainRequest request)

Lists all packages associated with the Amazon ES domain.

Specified by:

listPackagesForDomain in interface AWSElasticsearch

Parameters:

listPackagesForDomainRequest - Container for request parameters to ListPackagesForDomain operation.

Returns:

Result of the ListPackagesForDomain operation returned by the service.

Throws:

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.

AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.

listTags

public ListTagsResult listTags(ListTagsRequest request)

Returns all tags for the given Elasticsearch domain.

Specified by:

listTags in interface AWSElasticsearch

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:

Result of the ListTags operation returned by the service.

Throws:

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.

listVpcEndpointAccess

public ListVpcEndpointAccessResult listVpcEndpointAccess(ListVpcEndpointAccessRequest request)

Retrieves information about each principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

Specified by:

listVpcEndpointAccess in interface AWSElasticsearch

Parameters:

listVpcEndpointAccessRequest - Retrieves information about each principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint

Returns:

Result of the ListVpcEndpointAccess operation returned by the service.

Throws:

ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

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.

BaseException - An error occurred while processing the request.

listVpcEndpoints

public ListVpcEndpointsResult listVpcEndpoints(ListVpcEndpointsRequest request)

Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current account and Region.

Specified by:

listVpcEndpoints in interface AWSElasticsearch

Parameters:

listVpcEndpointsRequest - Container for request parameters to the ListVpcEndpoints operation.

Returns:

Result of the ListVpcEndpoints operation returned by the service.

Throws:

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.

DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

BaseException - An error occurred while processing the request.

listVpcEndpointsForDomain

public ListVpcEndpointsForDomainResult listVpcEndpointsForDomain(ListVpcEndpointsForDomainRequest request)

Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.

Specified by:

listVpcEndpointsForDomain in interface AWSElasticsearch

Parameters:

listVpcEndpointsForDomainRequest - Container for request parameters to the ListVpcEndpointsForDomain operation. Specifies the domain whose VPC endpoints will be listed.

Returns:

Result of the ListVpcEndpointsForDomain operation returned by the service.

Throws:

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.

DisabledOperationException - An error occured because the client wanted to access a not supported operation. 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.

BaseException - An error occurred while processing the request.

purchaseReservedElasticsearchInstanceOffering

public PurchaseReservedElasticsearchInstanceOfferingResult purchaseReservedElasticsearchInstanceOffering(PurchaseReservedElasticsearchInstanceOfferingRequest request)

Allows you to purchase reserved Elasticsearch instances.

Specified by:

purchaseReservedElasticsearchInstanceOffering in interface AWSElasticsearch

Parameters:

purchaseReservedElasticsearchInstanceOfferingRequest - Container for parameters to PurchaseReservedElasticsearchInstanceOffering

Returns:

Result of the PurchaseReservedElasticsearchInstanceOffering operation returned by the service.

Throws:

ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

ResourceAlreadyExistsException - An exception for creating a resource that already exists. Gives http status code of 400.

LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.

DisabledOperationException - An error occured because the client wanted to access a not supported operation. 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.

rejectInboundCrossClusterSearchConnection

public RejectInboundCrossClusterSearchConnectionResult rejectInboundCrossClusterSearchConnection(RejectInboundCrossClusterSearchConnectionRequest request)

Allows the destination domain owner to reject an inbound cross-cluster search connection request.

Specified by:

rejectInboundCrossClusterSearchConnection in interface AWSElasticsearch

Parameters:

rejectInboundCrossClusterSearchConnectionRequest - Container for the parameters to the RejectInboundCrossClusterSearchConnection operation.

Returns:

Result of the RejectInboundCrossClusterSearchConnection operation returned by the service.

Throws:

ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

removeTags

public RemoveTagsResult removeTags(RemoveTagsRequest request)

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

Specified by:

removeTags in interface AWSElasticsearch

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:

Result of the RemoveTags operation returned by the service.

Throws:

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.

revokeVpcEndpointAccess

public RevokeVpcEndpointAccessResult revokeVpcEndpointAccess(RevokeVpcEndpointAccessRequest request)

Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.

Specified by:

revokeVpcEndpointAccess in interface AWSElasticsearch

Parameters:

revokeVpcEndpointAccessRequest - Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.

Returns:

Result of the RevokeVpcEndpointAccess operation returned by the service.

Throws:

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.

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.

BaseException - An error occurred while processing the request.

startElasticsearchServiceSoftwareUpdate

public StartElasticsearchServiceSoftwareUpdateResult startElasticsearchServiceSoftwareUpdate(StartElasticsearchServiceSoftwareUpdateRequest request)

Schedules a service software update for an Amazon ES domain.

Specified by:

startElasticsearchServiceSoftwareUpdate in interface AWSElasticsearch

Parameters:

startElasticsearchServiceSoftwareUpdateRequest - Container for the parameters to the StartElasticsearchServiceSoftwareUpdate operation. Specifies the name of the Elasticsearch domain that you wish to schedule a service software update on.

Returns:

Result of the StartElasticsearchServiceSoftwareUpdate operation returned by the service.

Throws:

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.

updateElasticsearchDomainConfig

public UpdateElasticsearchDomainConfigResult updateElasticsearchDomainConfig(UpdateElasticsearchDomainConfigRequest request)

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

Specified by:

updateElasticsearchDomainConfig in interface AWSElasticsearch

Parameters:

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

Returns:

Result of the UpdateElasticsearchDomainConfig operation returned by the service.

Throws:

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.

updatePackage

public UpdatePackageResult updatePackage(UpdatePackageRequest request)

Updates a package for use with Amazon ES domains.

Specified by:

updatePackage in interface AWSElasticsearch

Parameters:

updatePackageRequest - Container for request parameters to UpdatePackage operation.

Returns:

Result of the UpdatePackage operation returned by the service.

Throws:

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.

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.

AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.

updateVpcEndpoint

public UpdateVpcEndpointResult updateVpcEndpoint(UpdateVpcEndpointRequest request)

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

Specified by:

updateVpcEndpoint in interface AWSElasticsearch

Parameters:

updateVpcEndpointRequest - Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

Returns:

Result of the UpdateVpcEndpoint operation returned by the service.

Throws:

ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

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.

ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.

ConflictException - An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.

BaseException - An error occurred while processing the request.

upgradeElasticsearchDomain

public UpgradeElasticsearchDomainResult upgradeElasticsearchDomain(UpgradeElasticsearchDomainRequest request)

Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.

Specified by:

upgradeElasticsearchDomain in interface AWSElasticsearch

Parameters:

upgradeElasticsearchDomainRequest - Container for request parameters to UpgradeElasticsearchDomain operation.

Returns:

Result of the UpgradeElasticsearchDomain operation returned by the service.

Throws:

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.

ResourceAlreadyExistsException - An exception for creating a resource that already exists. Gives http status code of 400.

DisabledOperationException - An error occured because the client wanted to access a not supported operation. 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.

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSElasticsearch

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSElasticsearch

Overrides:

shutdown in class AmazonWebServiceClient