com.amazonaws.services.elasticsearch

Interface AWSElasticsearch

All Known Subinterfaces:

AWSElasticsearchAsync

All Known Implementing Classes:

AbstractAWSElasticsearch, AbstractAWSElasticsearchAsync, AWSElasticsearchAsyncClient, AWSElasticsearchClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSElasticsearch

Interface for accessing Amazon Elasticsearch Service.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSElasticsearch instead.

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

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

Method Summary

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

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

setEndpoint

@Deprecated
void setEndpoint(String endpoint)

Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));

Overrides the default endpoint for this client ("https://es.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "es.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://es.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "es.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://es.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

setRegion

@Deprecated
void setRegion(Region region)

Deprecated. use AwsClientBuilder#setRegion(String)

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)

acceptInboundCrossClusterSearchConnection

AcceptInboundCrossClusterSearchConnectionResult acceptInboundCrossClusterSearchConnection(AcceptInboundCrossClusterSearchConnectionRequest acceptInboundCrossClusterSearchConnectionRequest)

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

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

AddTagsResult 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:

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

AssociatePackageResult associatePackage(AssociatePackageRequest associatePackageRequest)

Associates a package with an Amazon ES domain.

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

AuthorizeVpcEndpointAccessResult authorizeVpcEndpointAccess(AuthorizeVpcEndpointAccessRequest authorizeVpcEndpointAccessRequest)

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

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.

cancelDomainConfigChange

CancelDomainConfigChangeResult cancelDomainConfigChange(CancelDomainConfigChangeRequest cancelDomainConfigChangeRequest)

Cancels a pending configuration change on an Amazon OpenSearch Service domain.

Parameters:

cancelDomainConfigChangeRequest - Container for parameters of the CancelDomainConfigChange operation.

Returns:

Result of the CancelDomainConfigChange 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.

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

cancelElasticsearchServiceSoftwareUpdate

CancelElasticsearchServiceSoftwareUpdateResult cancelElasticsearchServiceSoftwareUpdate(CancelElasticsearchServiceSoftwareUpdateRequest cancelElasticsearchServiceSoftwareUpdateRequest)

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.

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

CreateElasticsearchDomainResult 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:

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

CreateOutboundCrossClusterSearchConnectionResult createOutboundCrossClusterSearchConnection(CreateOutboundCrossClusterSearchConnectionRequest createOutboundCrossClusterSearchConnectionRequest)

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

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

CreatePackageResult createPackage(CreatePackageRequest createPackageRequest)

Create a package for use with Amazon ES domains.

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

CreateVpcEndpointResult createVpcEndpoint(CreateVpcEndpointRequest createVpcEndpointRequest)

Creates an Amazon OpenSearch Service-managed VPC endpoint.

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

DeleteElasticsearchDomainResult 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:

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

DeleteElasticsearchServiceRoleResult deleteElasticsearchServiceRole(DeleteElasticsearchServiceRoleRequest deleteElasticsearchServiceRoleRequest)

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.

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

DeleteInboundCrossClusterSearchConnectionResult deleteInboundCrossClusterSearchConnection(DeleteInboundCrossClusterSearchConnectionRequest deleteInboundCrossClusterSearchConnectionRequest)

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

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

DeleteOutboundCrossClusterSearchConnectionResult deleteOutboundCrossClusterSearchConnection(DeleteOutboundCrossClusterSearchConnectionRequest deleteOutboundCrossClusterSearchConnectionRequest)

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

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

DeletePackageResult deletePackage(DeletePackageRequest deletePackageRequest)

Delete the package.

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

DeleteVpcEndpointResult deleteVpcEndpoint(DeleteVpcEndpointRequest deleteVpcEndpointRequest)

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

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

DescribeDomainAutoTunesResult describeDomainAutoTunes(DescribeDomainAutoTunesRequest describeDomainAutoTunesRequest)

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

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

DescribeDomainChangeProgressResult describeDomainChangeProgress(DescribeDomainChangeProgressRequest describeDomainChangeProgressRequest)

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

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

DescribeElasticsearchDomainResult 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:

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

DescribeElasticsearchDomainConfigResult 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:

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

DescribeElasticsearchDomainsResult 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:

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

DescribeElasticsearchInstanceTypeLimitsResult 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:

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

DescribeInboundCrossClusterSearchConnectionsResult describeInboundCrossClusterSearchConnections(DescribeInboundCrossClusterSearchConnectionsRequest describeInboundCrossClusterSearchConnectionsRequest)

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

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

DescribeOutboundCrossClusterSearchConnectionsResult describeOutboundCrossClusterSearchConnections(DescribeOutboundCrossClusterSearchConnectionsRequest describeOutboundCrossClusterSearchConnectionsRequest)

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

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

DescribePackagesResult describePackages(DescribePackagesRequest describePackagesRequest)

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

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

DescribeReservedElasticsearchInstanceOfferingsResult describeReservedElasticsearchInstanceOfferings(DescribeReservedElasticsearchInstanceOfferingsRequest describeReservedElasticsearchInstanceOfferingsRequest)

Lists available reserved Elasticsearch instance offerings.

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

DescribeReservedElasticsearchInstancesResult describeReservedElasticsearchInstances(DescribeReservedElasticsearchInstancesRequest describeReservedElasticsearchInstancesRequest)

Returns information about reserved Elasticsearch instances for this account.

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

DescribeVpcEndpointsResult describeVpcEndpoints(DescribeVpcEndpointsRequest describeVpcEndpointsRequest)

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

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

DissociatePackageResult dissociatePackage(DissociatePackageRequest dissociatePackageRequest)

Dissociates a package from the Amazon ES domain.

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

GetCompatibleElasticsearchVersionsResult getCompatibleElasticsearchVersions(GetCompatibleElasticsearchVersionsRequest getCompatibleElasticsearchVersionsRequest)

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.

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

GetPackageVersionHistoryResult getPackageVersionHistory(GetPackageVersionHistoryRequest getPackageVersionHistoryRequest)

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

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

GetUpgradeHistoryResult getUpgradeHistory(GetUpgradeHistoryRequest getUpgradeHistoryRequest)

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

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

GetUpgradeStatusResult getUpgradeStatus(GetUpgradeStatusRequest getUpgradeStatusRequest)

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

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

ListDomainNamesResult listDomainNames(ListDomainNamesRequest listDomainNamesRequest)

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

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

ListDomainsForPackageResult listDomainsForPackage(ListDomainsForPackageRequest listDomainsForPackageRequest)

Lists all Amazon ES domains associated with the package.

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

ListElasticsearchInstanceTypesResult 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:

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

ListElasticsearchVersionsResult 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:

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

ListPackagesForDomainResult listPackagesForDomain(ListPackagesForDomainRequest listPackagesForDomainRequest)

Lists all packages associated with the Amazon ES domain.

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

ListTagsResult 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:

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

ListVpcEndpointAccessResult listVpcEndpointAccess(ListVpcEndpointAccessRequest 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.

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

ListVpcEndpointsResult listVpcEndpoints(ListVpcEndpointsRequest listVpcEndpointsRequest)

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

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

ListVpcEndpointsForDomainResult listVpcEndpointsForDomain(ListVpcEndpointsForDomainRequest listVpcEndpointsForDomainRequest)

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

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

PurchaseReservedElasticsearchInstanceOfferingResult purchaseReservedElasticsearchInstanceOffering(PurchaseReservedElasticsearchInstanceOfferingRequest purchaseReservedElasticsearchInstanceOfferingRequest)

Allows you to purchase reserved Elasticsearch instances.

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

RejectInboundCrossClusterSearchConnectionResult rejectInboundCrossClusterSearchConnection(RejectInboundCrossClusterSearchConnectionRequest rejectInboundCrossClusterSearchConnectionRequest)

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

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

RemoveTagsResult 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:

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

RevokeVpcEndpointAccessResult revokeVpcEndpointAccess(RevokeVpcEndpointAccessRequest revokeVpcEndpointAccessRequest)

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

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

StartElasticsearchServiceSoftwareUpdateResult startElasticsearchServiceSoftwareUpdate(StartElasticsearchServiceSoftwareUpdateRequest startElasticsearchServiceSoftwareUpdateRequest)

Schedules a service software update for an Amazon ES domain.

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

UpdateElasticsearchDomainConfigResult 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:

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

UpdatePackageResult updatePackage(UpdatePackageRequest updatePackageRequest)

Updates a package for use with Amazon ES domains.

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

UpdateVpcEndpointResult updateVpcEndpoint(UpdateVpcEndpointRequest updateVpcEndpointRequest)

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

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

UpgradeElasticsearchDomainResult upgradeElasticsearchDomain(UpgradeElasticsearchDomainRequest upgradeElasticsearchDomainRequest)

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

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.

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

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