/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.opensearch; import javax.annotation.Generated; import com.amazonaws.*; import com.amazonaws.regions.*; import com.amazonaws.services.opensearch.model.*; /** * Interface for accessing Amazon OpenSearch Service. *

* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.opensearch.AbstractAmazonOpenSearch} instead. *

*

*

* Use the Amazon OpenSearch Service configuration API to create, configure, and manage OpenSearch Service domains. *

*

* For sample code that uses the configuration API, see the * Amazon OpenSearch Service Developer Guide . The guide also contains sample code for * sending signed HTTP requests to the OpenSearch 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 Amazon * Web Services service endpoints. *

*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AmazonOpenSearch { /** * The region metadata service name for computing region endpoints. You can use this value to retrieve metadata * (such as supported regions) of the service. * * @see RegionUtils#getRegionsForService(String) */ String ENDPOINT_PREFIX = "es"; /** *

* Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search * connection request. For more information, see Cross-cluster search for Amazon OpenSearch Service. *

* * @param acceptInboundConnectionRequest * Container for the parameters to the AcceptInboundConnection operation. * @return Result of the AcceptInboundConnection operation returned by the service. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws LimitExceededException * An exception for trying to create more than the allowed number of resources or sub-resources. * @throws DisabledOperationException * An error occured because the client wanted to access an unsupported operation. * @sample AmazonOpenSearch.AcceptInboundConnection */ AcceptInboundConnectionResult acceptInboundConnection(AcceptInboundConnectionRequest acceptInboundConnectionRequest); /** *

* Attaches tags to an existing Amazon OpenSearch Service domain. Tags are a set of case-sensitive key-value pairs. * A domain can have up to 10 tags. For more information, see Tagging Amazon OpenSearch Service domains. *

* * @param addTagsRequest * Container for the parameters to the AddTags operation. Specifies the tags to attach to the * domain. * @return Result of the AddTags operation returned by the service. * @throws BaseException * An error occurred while processing the request. * @throws LimitExceededException * An exception for trying to create more than the allowed number of resources or sub-resources. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @sample AmazonOpenSearch.AddTags */ AddTagsResult addTags(AddTagsRequest addTagsRequest); /** *

* Associates a package with an Amazon OpenSearch Service domain. For more information, see Custom packages * for Amazon OpenSearch Service. *

* * @param associatePackageRequest * Container for the request parameters to the AssociatePackage operation. * @return Result of the AssociatePackage operation returned by the service. * @throws BaseException * An error occurred while processing the request. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws AccessDeniedException * An error occurred because you don't have permissions to access the resource. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @throws ConflictException * An error occurred because the client attempts to remove a resource that is currently in use. * @sample AmazonOpenSearch.AssociatePackage */ AssociatePackageResult associatePackage(AssociatePackageRequest associatePackageRequest); /** *

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

* * @param authorizeVpcEndpointAccessRequest * @return Result of the AuthorizeVpcEndpointAccess operation returned by the service. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws DisabledOperationException * An error occured because the client wanted to access an unsupported operation. * @throws LimitExceededException * An exception for trying to create more than the allowed number of resources or sub-resources. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @throws BaseException * An error occurred while processing the request. * @sample AmazonOpenSearch.AuthorizeVpcEndpointAccess */ AuthorizeVpcEndpointAccessResult authorizeVpcEndpointAccess(AuthorizeVpcEndpointAccessRequest authorizeVpcEndpointAccessRequest); /** *

* Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this * operation before the AutomatedUpdateDate and when the domain's UpdateStatus is * PENDING_UPDATE. For more information, see Service * software updates in Amazon OpenSearch Service. *

* * @param cancelServiceSoftwareUpdateRequest * Container for the request parameters to cancel a service software update. * @return Result of the CancelServiceSoftwareUpdate operation returned by the service. * @throws BaseException * An error occurred while processing the request. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @sample AmazonOpenSearch.CancelServiceSoftwareUpdate */ CancelServiceSoftwareUpdateResult cancelServiceSoftwareUpdate(CancelServiceSoftwareUpdateRequest cancelServiceSoftwareUpdateRequest); /** *

* Creates an Amazon OpenSearch Service domain. For more information, see Creating and * managing Amazon OpenSearch Service domains. *

* * @param createDomainRequest * @return Result of the CreateDomain operation returned by the service. * @throws BaseException * An error occurred while processing the request. * @throws DisabledOperationException * An error occured because the client wanted to access an unsupported operation. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @throws InvalidTypeException * An exception for trying to create or access a sub-resource that's either invalid or not supported. * @throws LimitExceededException * An exception for trying to create more than the allowed number of resources or sub-resources. * @throws ResourceAlreadyExistsException * An exception for creating a resource that already exists. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @sample AmazonOpenSearch.CreateDomain */ CreateDomainResult createDomain(CreateDomainRequest createDomainRequest); /** *

* Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination * domain. For more information, see Cross-cluster search for Amazon OpenSearch Service. *

* * @param createOutboundConnectionRequest * Container for the parameters to the CreateOutboundConnection operation. * @return Result of the CreateOutboundConnection operation returned by the service. * @throws LimitExceededException * An exception for trying to create more than the allowed number of resources or sub-resources. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @throws ResourceAlreadyExistsException * An exception for creating a resource that already exists. * @throws DisabledOperationException * An error occured because the client wanted to access an unsupported operation. * @sample AmazonOpenSearch.CreateOutboundConnection */ CreateOutboundConnectionResult createOutboundConnection(CreateOutboundConnectionRequest createOutboundConnectionRequest); /** *

* Creates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages * for Amazon OpenSearch Service. *

* * @param createPackageRequest * Container for request parameters to the CreatePackage operation. * @return Result of the CreatePackage operation returned by the service. * @throws BaseException * An error occurred while processing the request. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @throws LimitExceededException * An exception for trying to create more than the allowed number of resources or sub-resources. * @throws InvalidTypeException * An exception for trying to create or access a sub-resource that's either invalid or not supported. * @throws ResourceAlreadyExistsException * An exception for creating a resource that already exists. * @throws AccessDeniedException * An error occurred because you don't have permissions to access the resource. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @sample AmazonOpenSearch.CreatePackage */ CreatePackageResult createPackage(CreatePackageRequest createPackageRequest); /** *

* Creates an Amazon OpenSearch Service-managed VPC endpoint. *

* * @param createVpcEndpointRequest * @return 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. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @throws LimitExceededException * An exception for trying to create more than the allowed number of resources or sub-resources. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @throws DisabledOperationException * An error occured because the client wanted to access an unsupported operation. * @throws BaseException * An error occurred while processing the request. * @sample AmazonOpenSearch.CreateVpcEndpoint */ CreateVpcEndpointResult createVpcEndpoint(CreateVpcEndpointRequest createVpcEndpointRequest); /** *

* Deletes an Amazon OpenSearch Service domain and all of its data. You can't recover a domain after you delete it. *

* * @param deleteDomainRequest * Container for the parameters to the DeleteDomain operation. * @return Result of the DeleteDomain operation returned by the service. * @throws BaseException * An error occurred while processing the request. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @sample AmazonOpenSearch.DeleteDomain */ DeleteDomainResult deleteDomain(DeleteDomainRequest deleteDomainRequest); /** *

* Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search * connection. For more information, see Cross-cluster search for Amazon OpenSearch Service. *

* * @param deleteInboundConnectionRequest * Container for the parameters to the DeleteInboundConnection operation. * @return Result of the DeleteInboundConnection operation returned by the service. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws DisabledOperationException * An error occured because the client wanted to access an unsupported operation. * @sample AmazonOpenSearch.DeleteInboundConnection */ DeleteInboundConnectionResult deleteInboundConnection(DeleteInboundConnectionRequest deleteInboundConnectionRequest); /** *

* Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search * connection. For more information, see Cross-cluster search for Amazon OpenSearch Service. *

* * @param deleteOutboundConnectionRequest * Container for the parameters to the DeleteOutboundConnection operation. * @return Result of the DeleteOutboundConnection operation returned by the service. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws DisabledOperationException * An error occured because the client wanted to access an unsupported operation. * @sample AmazonOpenSearch.DeleteOutboundConnection */ DeleteOutboundConnectionResult deleteOutboundConnection(DeleteOutboundConnectionRequest deleteOutboundConnectionRequest); /** *

* Deletes an Amazon OpenSearch Service package. For more information, see Custom packages * for Amazon OpenSearch Service. *

* * @param deletePackageRequest * Deletes a package from OpenSearch Service. The package can't be associated with any OpenSearch Service * domain. * @return Result of the DeletePackage operation returned by the service. * @throws BaseException * An error occurred while processing the request. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws AccessDeniedException * An error occurred because you don't have permissions to access the resource. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @throws ConflictException * An error occurred because the client attempts to remove a resource that is currently in use. * @sample AmazonOpenSearch.DeletePackage */ DeletePackageResult deletePackage(DeletePackageRequest deletePackageRequest); /** *

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

* * @param deleteVpcEndpointRequest * @return Result of the DeleteVpcEndpoint operation returned by the service. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws DisabledOperationException * An error occured because the client wanted to access an unsupported operation. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @throws BaseException * An error occurred while processing the request. * @sample AmazonOpenSearch.DeleteVpcEndpoint */ DeleteVpcEndpointResult deleteVpcEndpoint(DeleteVpcEndpointRequest deleteVpcEndpointRequest); /** *

* Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, * domain service endpoint, and domain ARN. *

* * @param describeDomainRequest * Container for the parameters to the DescribeDomain operation. * @return Result of the DescribeDomain operation returned by the service. * @throws BaseException * An error occurred while processing the request. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @sample AmazonOpenSearch.DescribeDomain */ DescribeDomainResult describeDomain(DescribeDomainRequest describeDomainRequest); /** *

* Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain. For more * information, see Auto-Tune for Amazon * OpenSearch Service. *

* * @param describeDomainAutoTunesRequest * Container for the parameters to the DescribeDomainAutoTunes operation. * @return Result of the DescribeDomainAutoTunes operation returned by the service. * @throws BaseException * An error occurred while processing the request. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @sample AmazonOpenSearch.DescribeDomainAutoTunes */ DescribeDomainAutoTunesResult describeDomainAutoTunes(DescribeDomainAutoTunesRequest describeDomainAutoTunesRequest); /** *

* Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain. For * more information, see Making configuration changes in Amazon OpenSearch Service. *

* * @param describeDomainChangeProgressRequest * Container for the parameters to the DescribeDomainChangeProgress operation. * @return Result of the DescribeDomainChangeProgress operation returned by the service. * @throws BaseException * An error occurred while processing the request. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @sample AmazonOpenSearch.DescribeDomainChangeProgress */ DescribeDomainChangeProgressResult describeDomainChangeProgress(DescribeDomainChangeProgressRequest describeDomainChangeProgressRequest); /** *

* Returns the configuration of an Amazon OpenSearch Service domain. *

* * @param describeDomainConfigRequest * Container for the parameters to the DescribeDomainConfig operation. * @return Result of the DescribeDomainConfig operation returned by the service. * @throws BaseException * An error occurred while processing the request. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @sample AmazonOpenSearch.DescribeDomainConfig */ DescribeDomainConfigResult describeDomainConfig(DescribeDomainConfigRequest describeDomainConfigRequest); /** *

* Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability * Zone, and shard count per node. *

* * @param describeDomainHealthRequest * Container for the parameters to the DescribeDomainHealth operation. * @return Result of the DescribeDomainHealth operation returned by the service. * @throws BaseException * An error occurred while processing the request. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @throws DisabledOperationException * An error occured because the client wanted to access an unsupported operation. * @sample AmazonOpenSearch.DescribeDomainHealth */ DescribeDomainHealthResult describeDomainHealth(DescribeDomainHealthRequest describeDomainHealthRequest); /** *

* Returns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability * Zone(s), standby nodes, node configurations, and node states. *

* * @param describeDomainNodesRequest * Container for the parameters to the DescribeDomainNodes operation. * @return Result of the DescribeDomainNodes operation returned by the service. * @throws BaseException * An error occurred while processing the request. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @throws DisabledOperationException * An error occured because the client wanted to access an unsupported operation. * @throws DependencyFailureException * An exception for when a failure in one of the dependencies results in the service being unable to fetch * details about the resource. * @sample AmazonOpenSearch.DescribeDomainNodes */ DescribeDomainNodesResult describeDomainNodes(DescribeDomainNodesRequest describeDomainNodesRequest); /** *

* Returns domain configuration information about the specified Amazon OpenSearch Service domains. *

* * @param describeDomainsRequest * Container for the parameters to the DescribeDomains operation. * @return Result of the DescribeDomains operation returned by the service. * @throws BaseException * An error occurred while processing the request. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @sample AmazonOpenSearch.DescribeDomains */ DescribeDomainsResult describeDomains(DescribeDomainsRequest describeDomainsRequest); /** *

* Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain. For more * information, see Determining whether a change will cause a blue/green deployment. *

* * @param describeDryRunProgressRequest * @return Result of the DescribeDryRunProgress operation returned by the service. * @throws BaseException * An error occurred while processing the request. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @throws DisabledOperationException * An error occured because the client wanted to access an unsupported operation. * @sample AmazonOpenSearch.DescribeDryRunProgress */ DescribeDryRunProgressResult describeDryRunProgress(DescribeDryRunProgressRequest describeDryRunProgressRequest); /** *

* Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service * domain. For more information, see Cross-cluster search for Amazon OpenSearch Service. *

* * @param describeInboundConnectionsRequest * Container for the parameters to the DescribeInboundConnections operation. * @return Result of the DescribeInboundConnections operation returned by the service. * @throws InvalidPaginationTokenException * Request processing failed because you provided an invalid pagination token. * @throws DisabledOperationException * An error occured because the client wanted to access an unsupported operation. * @sample AmazonOpenSearch.DescribeInboundConnections */ DescribeInboundConnectionsResult describeInboundConnections(DescribeInboundConnectionsRequest describeInboundConnectionsRequest); /** *

* Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and * instance type. *

* * @param describeInstanceTypeLimitsRequest * Container for the parameters to the DescribeInstanceTypeLimits operation. * @return Result of the DescribeInstanceTypeLimits operation returned by the service. * @throws BaseException * An error occurred while processing the request. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @throws InvalidTypeException * An exception for trying to create or access a sub-resource that's either invalid or not supported. * @throws LimitExceededException * An exception for trying to create more than the allowed number of resources or sub-resources. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @sample AmazonOpenSearch.DescribeInstanceTypeLimits */ DescribeInstanceTypeLimitsResult describeInstanceTypeLimits(DescribeInstanceTypeLimitsRequest describeInstanceTypeLimitsRequest); /** *

* Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain. For more * information, see Cross-cluster search for Amazon OpenSearch Service. *

* * @param describeOutboundConnectionsRequest * Container for the parameters to the DescribeOutboundConnections operation. * @return Result of the DescribeOutboundConnections operation returned by the service. * @throws InvalidPaginationTokenException * Request processing failed because you provided an invalid pagination token. * @throws DisabledOperationException * An error occured because the client wanted to access an unsupported operation. * @sample AmazonOpenSearch.DescribeOutboundConnections */ DescribeOutboundConnectionsResult describeOutboundConnections(DescribeOutboundConnectionsRequest describeOutboundConnectionsRequest); /** *

* Describes all packages available to OpenSearch Service. For more information, see Custom packages * for Amazon OpenSearch Service. *

* * @param describePackagesRequest * Container for the request parameters to the DescribePackage operation. * @return Result of the DescribePackages operation returned by the service. * @throws BaseException * An error occurred while processing the request. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws AccessDeniedException * An error occurred because you don't have permissions to access the resource. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @sample AmazonOpenSearch.DescribePackages */ DescribePackagesResult describePackages(DescribePackagesRequest describePackagesRequest); /** *

* Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region. For more * information, see Reserved * Instances in Amazon OpenSearch Service. *

* * @param describeReservedInstanceOfferingsRequest * Container for the request parameters to a DescribeReservedInstanceOfferings operation. * @return Result of the DescribeReservedInstanceOfferings operation returned by the service. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @throws DisabledOperationException * An error occured because the client wanted to access an unsupported operation. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @sample AmazonOpenSearch.DescribeReservedInstanceOfferings */ DescribeReservedInstanceOfferingsResult describeReservedInstanceOfferings(DescribeReservedInstanceOfferingsRequest describeReservedInstanceOfferingsRequest); /** *

* Describes the Amazon OpenSearch Service instances that you have reserved in a given Region. For more information, * see Reserved Instances in * Amazon OpenSearch Service. *

* * @param describeReservedInstancesRequest * Container for the request parameters to the DescribeReservedInstances operation. * @return Result of the DescribeReservedInstances operation returned by the service. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @throws DisabledOperationException * An error occured because the client wanted to access an unsupported operation. * @sample AmazonOpenSearch.DescribeReservedInstances */ DescribeReservedInstancesResult describeReservedInstances(DescribeReservedInstancesRequest describeReservedInstancesRequest); /** *

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

* * @param describeVpcEndpointsRequest * @return Result of the DescribeVpcEndpoints operation returned by the service. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @throws DisabledOperationException * An error occured because the client wanted to access an unsupported operation. * @throws BaseException * An error occurred while processing the request. * @sample AmazonOpenSearch.DescribeVpcEndpoints */ DescribeVpcEndpointsResult describeVpcEndpoints(DescribeVpcEndpointsRequest describeVpcEndpointsRequest); /** *

* Removes a package from the specified Amazon OpenSearch Service domain. The package can't be in use with any * OpenSearch index for the dissociation to succeed. The package is still available in OpenSearch Service for * association later. For more information, see Custom packages * for Amazon OpenSearch Service. *

* * @param dissociatePackageRequest * Container for the request parameters to the DissociatePackage operation. * @return Result of the DissociatePackage operation returned by the service. * @throws BaseException * An error occurred while processing the request. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws AccessDeniedException * An error occurred because you don't have permissions to access the resource. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @throws ConflictException * An error occurred because the client attempts to remove a resource that is currently in use. * @sample AmazonOpenSearch.DissociatePackage */ DissociatePackageResult dissociatePackage(DissociatePackageRequest dissociatePackageRequest); /** *

* Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to. *

* * @param getCompatibleVersionsRequest * Container for the request parameters to GetCompatibleVersions operation. * @return Result of the GetCompatibleVersions operation returned by the service. * @throws BaseException * An error occurred while processing the request. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws DisabledOperationException * An error occured because the client wanted to access an unsupported operation. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @sample AmazonOpenSearch.GetCompatibleVersions */ GetCompatibleVersionsResult getCompatibleVersions(GetCompatibleVersionsRequest getCompatibleVersionsRequest); /** *

* Returns a list of Amazon OpenSearch Service package versions, along with their creation time, commit message, and * plugin properties (if the package is a zip plugin package). For more information, see Custom packages * for Amazon OpenSearch Service. *

* * @param getPackageVersionHistoryRequest * Container for the request parameters to the GetPackageVersionHistory operation. * @return Result of the GetPackageVersionHistory operation returned by the service. * @throws BaseException * An error occurred while processing the request. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws AccessDeniedException * An error occurred because you don't have permissions to access the resource. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @sample AmazonOpenSearch.GetPackageVersionHistory */ GetPackageVersionHistoryResult getPackageVersionHistory(GetPackageVersionHistoryRequest getPackageVersionHistoryRequest); /** *

* Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain. *

* * @param getUpgradeHistoryRequest * Container for the request parameters to the GetUpgradeHistory operation. * @return Result of the GetUpgradeHistory operation returned by the service. * @throws BaseException * An error occurred while processing the request. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws DisabledOperationException * An error occured because the client wanted to access an unsupported operation. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @sample AmazonOpenSearch.GetUpgradeHistory */ GetUpgradeHistoryResult getUpgradeHistory(GetUpgradeHistoryRequest getUpgradeHistoryRequest); /** *

* Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch * Service domain. *

* * @param getUpgradeStatusRequest * Container for the request parameters to the GetUpgradeStatus operation. * @return Result of the GetUpgradeStatus operation returned by the service. * @throws BaseException * An error occurred while processing the request. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws DisabledOperationException * An error occured because the client wanted to access an unsupported operation. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @sample AmazonOpenSearch.GetUpgradeStatus */ GetUpgradeStatusResult getUpgradeStatus(GetUpgradeStatusRequest getUpgradeStatusRequest); /** *

* Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region. *

* * @param listDomainNamesRequest * Container for the parameters to the ListDomainNames operation. * @return Result of the ListDomainNames operation returned by the service. * @throws BaseException * An error occurred while processing the request. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @sample AmazonOpenSearch.ListDomainNames */ ListDomainNamesResult listDomainNames(ListDomainNamesRequest listDomainNamesRequest); /** *

* Lists all Amazon OpenSearch Service domains associated with a given package. For more information, see Custom packages * for Amazon OpenSearch Service. *

* * @param listDomainsForPackageRequest * Container for the request parameters to the ListDomainsForPackage operation. * @return Result of the ListDomainsForPackage operation returned by the service. * @throws BaseException * An error occurred while processing the request. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws AccessDeniedException * An error occurred because you don't have permissions to access the resource. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @sample AmazonOpenSearch.ListDomainsForPackage */ ListDomainsForPackageResult listDomainsForPackage(ListDomainsForPackageRequest listDomainsForPackageRequest); /** *

* Lists all instance types and available features for a given OpenSearch or Elasticsearch version. *

* * @param listInstanceTypeDetailsRequest * @return Result of the ListInstanceTypeDetails operation returned by the service. * @throws BaseException * An error occurred while processing the request. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @sample AmazonOpenSearch.ListInstanceTypeDetails */ ListInstanceTypeDetailsResult listInstanceTypeDetails(ListInstanceTypeDetailsRequest listInstanceTypeDetailsRequest); /** *

* Lists all packages associated with an Amazon OpenSearch Service domain. For more information, see Custom packages * for Amazon OpenSearch Service. *

* * @param listPackagesForDomainRequest * Container for the request parameters to the ListPackagesForDomain operation. * @return Result of the ListPackagesForDomain operation returned by the service. * @throws BaseException * An error occurred while processing the request. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws AccessDeniedException * An error occurred because you don't have permissions to access the resource. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @sample AmazonOpenSearch.ListPackagesForDomain */ ListPackagesForDomainResult listPackagesForDomain(ListPackagesForDomainRequest listPackagesForDomainRequest); /** *

* Retrieves a list of configuration changes that are scheduled for a domain. These changes can be service * software updates or blue/green Auto-Tune enhancements. *

* * @param listScheduledActionsRequest * @return Result of the ListScheduledActions operation returned by the service. * @throws BaseException * An error occurred while processing the request. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws InvalidPaginationTokenException * Request processing failed because you provided an invalid pagination token. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @sample AmazonOpenSearch.ListScheduledActions */ ListScheduledActionsResult listScheduledActions(ListScheduledActionsRequest listScheduledActionsRequest); /** *

* Returns all resource tags for an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains. *

* * @param listTagsRequest * Container for the parameters to the ListTags operation. * @return Result of the ListTags operation returned by the service. * @throws BaseException * An error occurred while processing the request. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @sample AmazonOpenSearch.ListTags */ ListTagsResult listTags(ListTagsRequest listTagsRequest); /** *

* Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports. *

* * @param listVersionsRequest * Container for the request parameters to the ListVersions operation. * @return Result of the ListVersions operation returned by the service. * @throws BaseException * An error occurred while processing the request. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @sample AmazonOpenSearch.ListVersions */ ListVersionsResult listVersions(ListVersionsRequest listVersionsRequest); /** *

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

* * @param listVpcEndpointAccessRequest * @return Result of the ListVpcEndpointAccess operation returned by the service. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws DisabledOperationException * An error occured because the client wanted to access an unsupported operation. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @throws BaseException * An error occurred while processing the request. * @sample AmazonOpenSearch.ListVpcEndpointAccess */ ListVpcEndpointAccessResult listVpcEndpointAccess(ListVpcEndpointAccessRequest listVpcEndpointAccessRequest); /** *

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

* * @param listVpcEndpointsRequest * @return Result of the ListVpcEndpoints operation returned by the service. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @throws DisabledOperationException * An error occured because the client wanted to access an unsupported operation. * @throws BaseException * An error occurred while processing the request. * @sample AmazonOpenSearch.ListVpcEndpoints */ ListVpcEndpointsResult listVpcEndpoints(ListVpcEndpointsRequest listVpcEndpointsRequest); /** *

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

* * @param listVpcEndpointsForDomainRequest * @return Result of the ListVpcEndpointsForDomain operation returned by the service. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @throws DisabledOperationException * An error occured because the client wanted to access an unsupported operation. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws BaseException * An error occurred while processing the request. * @sample AmazonOpenSearch.ListVpcEndpointsForDomain */ ListVpcEndpointsForDomainResult listVpcEndpointsForDomain(ListVpcEndpointsForDomainRequest listVpcEndpointsForDomainRequest); /** *

* Allows you to purchase Amazon OpenSearch Service Reserved Instances. *

* * @param purchaseReservedInstanceOfferingRequest * Container for request parameters to the PurchaseReservedInstanceOffering operation. * @return Result of the PurchaseReservedInstanceOffering operation returned by the service. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws ResourceAlreadyExistsException * An exception for creating a resource that already exists. * @throws LimitExceededException * An exception for trying to create more than the allowed number of resources or sub-resources. * @throws DisabledOperationException * An error occured because the client wanted to access an unsupported operation. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @sample AmazonOpenSearch.PurchaseReservedInstanceOffering */ PurchaseReservedInstanceOfferingResult purchaseReservedInstanceOffering(PurchaseReservedInstanceOfferingRequest purchaseReservedInstanceOfferingRequest); /** *

* Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request. *

* * @param rejectInboundConnectionRequest * Container for the request parameters to the RejectInboundConnection operation. * @return Result of the RejectInboundConnection operation returned by the service. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws DisabledOperationException * An error occured because the client wanted to access an unsupported operation. * @sample AmazonOpenSearch.RejectInboundConnection */ RejectInboundConnectionResult rejectInboundConnection(RejectInboundConnectionRequest rejectInboundConnectionRequest); /** *

* Removes the specified set of tags from an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains. *

* * @param removeTagsRequest * Container for the request parameters to the RemoveTags operation. * @return Result of the RemoveTags operation returned by the service. * @throws BaseException * An error occurred while processing the request. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @sample AmazonOpenSearch.RemoveTags */ RemoveTagsResult removeTags(RemoveTagsRequest removeTagsRequest); /** *

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

* * @param revokeVpcEndpointAccessRequest * @return Result of the RevokeVpcEndpointAccess operation returned by the service. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @throws DisabledOperationException * An error occured because the client wanted to access an unsupported operation. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @throws BaseException * An error occurred while processing the request. * @sample AmazonOpenSearch.RevokeVpcEndpointAccess */ RevokeVpcEndpointAccessResult revokeVpcEndpointAccess(RevokeVpcEndpointAccessRequest revokeVpcEndpointAccessRequest); /** *

* Schedules a service software update for an Amazon OpenSearch Service domain. For more information, see Service * software updates in Amazon OpenSearch Service. *

* * @param startServiceSoftwareUpdateRequest * Container for the request parameters to the StartServiceSoftwareUpdate operation. * @return Result of the StartServiceSoftwareUpdate operation returned by the service. * @throws BaseException * An error occurred while processing the request. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @sample AmazonOpenSearch.StartServiceSoftwareUpdate */ StartServiceSoftwareUpdateResult startServiceSoftwareUpdate(StartServiceSoftwareUpdateRequest startServiceSoftwareUpdateRequest); /** *

* Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.sl *

* * @param updateDomainConfigRequest * Container for the request parameters to the UpdateDomain operation. * @return Result of the UpdateDomainConfig operation returned by the service. * @throws BaseException * An error occurred while processing the request. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @throws InvalidTypeException * An exception for trying to create or access a sub-resource that's either invalid or not supported. * @throws LimitExceededException * An exception for trying to create more than the allowed number of resources or sub-resources. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @sample AmazonOpenSearch.UpdateDomainConfig */ UpdateDomainConfigResult updateDomainConfig(UpdateDomainConfigRequest updateDomainConfigRequest); /** *

* Updates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages * for Amazon OpenSearch Service. *

* * @param updatePackageRequest * Container for request parameters to the UpdatePackage operation. * @return Result of the UpdatePackage operation returned by the service. * @throws BaseException * An error occurred while processing the request. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @throws LimitExceededException * An exception for trying to create more than the allowed number of resources or sub-resources. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws AccessDeniedException * An error occurred because you don't have permissions to access the resource. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @sample AmazonOpenSearch.UpdatePackage */ UpdatePackageResult updatePackage(UpdatePackageRequest updatePackageRequest); /** *

* Reschedules a planned domain configuration change for a later time. This change can be a scheduled service * software update or a blue/green Auto-Tune enhancement. *

* * @param updateScheduledActionRequest * @return Result of the UpdateScheduledAction operation returned by the service. * @throws BaseException * An error occurred while processing the request. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws SlotNotAvailableException * An exception for attempting to schedule a domain action during an unavailable time slot. * @throws ConflictException * An error occurred because the client attempts to remove a resource that is currently in use. * @throws LimitExceededException * An exception for trying to create more than the allowed number of resources or sub-resources. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @sample AmazonOpenSearch.UpdateScheduledAction */ UpdateScheduledActionResult updateScheduledAction(UpdateScheduledActionRequest updateScheduledActionRequest); /** *

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

* * @param updateVpcEndpointRequest * @return Result of the UpdateVpcEndpoint operation returned by the service. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws DisabledOperationException * An error occured because the client wanted to access an unsupported operation. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @throws ConflictException * An error occurred because the client attempts to remove a resource that is currently in use. * @throws BaseException * An error occurred while processing the request. * @sample AmazonOpenSearch.UpdateVpcEndpoint */ UpdateVpcEndpointResult updateVpcEndpoint(UpdateVpcEndpointRequest updateVpcEndpointRequest); /** *

* Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a * compatible version of OpenSearch or Elasticsearch. *

* * @param upgradeDomainRequest * Container for the request parameters to the UpgradeDomain operation. * @return Result of the UpgradeDomain operation returned by the service. * @throws BaseException * An error occurred while processing the request. * @throws ResourceNotFoundException * An exception for accessing or deleting a resource that doesn't exist. * @throws ResourceAlreadyExistsException * An exception for creating a resource that already exists. * @throws DisabledOperationException * An error occured because the client wanted to access an unsupported operation. * @throws ValidationException * An exception for accessing or deleting a resource that doesn't exist. * @throws InternalException * Request processing failed because of an unknown error, exception, or internal failure. * @sample AmazonOpenSearch.UpgradeDomain */ UpgradeDomainResult upgradeDomain(UpgradeDomainRequest upgradeDomainRequest); /** * Shuts down this client object, releasing any resources that might be held open. This is an optional method, and * callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client * has been shutdown, it should not be used to make any more requests. */ void shutdown(); /** * Returns additional metadata for a previously executed successful request, typically used for debugging issues * where a service isn't acting as expected. This data isn't considered part of the result data returned by an * operation, so it's available through this separate, diagnostic interface. *

* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic * information for an executed request, you should use this method to retrieve it as soon as possible after * executing a request. * * @param request * The originally executed request. * * @return The response metadata for the specified request, or null if none is available. */ ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); }