AmazonOpenSearchClient (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.opensearch.AmazonOpenSearchClient

All Implemented Interfaces:

AmazonOpenSearch

Direct Known Subclasses:

AmazonOpenSearchAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonOpenSearchClient
extends AmazonWebServiceClient
implements AmazonOpenSearch
```
Client for accessing Amazon OpenSearch Service. All service calls made using this client are blocking, and will not return until the service call completes.

Use the Amazon OpenSearch Service configuration API to create, configure, and manage OpenSearch Service domains. The endpoint for configuration service requests is Region specific: es.region.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported Regions and endpoints, see Amazon Web Services service endpoints.

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  LOGGING_AWS_REQUEST_METRIC
- Fields inherited from interface com.amazonaws.services.opensearch.AmazonOpenSearch
  ENDPOINT_PREFIX

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AcceptInboundConnectionResult`	`acceptInboundConnection(AcceptInboundConnectionRequest request)` Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request.
`AddDataSourceResult`	`addDataSource(AddDataSourceRequest request)` Creates a new direct-query data source to the specified domain.
`AddTagsResult`	`addTags(AddTagsRequest request)` Attaches tags to an existing Amazon OpenSearch Service domain.
`AssociatePackageResult`	`associatePackage(AssociatePackageRequest request)` Associates a package with an Amazon OpenSearch Service domain.
`AuthorizeVpcEndpointAccessResult`	`authorizeVpcEndpointAccess(AuthorizeVpcEndpointAccessRequest request)` Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
`static AmazonOpenSearchClientBuilder`	`builder()`
`CancelDomainConfigChangeResult`	`cancelDomainConfigChange(CancelDomainConfigChangeRequest request)` Cancels a pending configuration change on an Amazon OpenSearch Service domain.
`CancelServiceSoftwareUpdateResult`	`cancelServiceSoftwareUpdate(CancelServiceSoftwareUpdateRequest request)` Cancels a scheduled service software update for an Amazon OpenSearch Service domain.
`CreateDomainResult`	`createDomain(CreateDomainRequest request)` Creates an Amazon OpenSearch Service domain.
`CreateOutboundConnectionResult`	`createOutboundConnection(CreateOutboundConnectionRequest request)` Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain.
`CreatePackageResult`	`createPackage(CreatePackageRequest request)` Creates a package for use with Amazon OpenSearch Service domains.
`CreateVpcEndpointResult`	`createVpcEndpoint(CreateVpcEndpointRequest request)` Creates an Amazon OpenSearch Service-managed VPC endpoint.
`DeleteDataSourceResult`	`deleteDataSource(DeleteDataSourceRequest request)` Deletes a direct-query data source.
`DeleteDomainResult`	`deleteDomain(DeleteDomainRequest request)` Deletes an Amazon OpenSearch Service domain and all of its data.
`DeleteInboundConnectionResult`	`deleteInboundConnection(DeleteInboundConnectionRequest request)` Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection.
`DeleteOutboundConnectionResult`	`deleteOutboundConnection(DeleteOutboundConnectionRequest request)` Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection.
`DeletePackageResult`	`deletePackage(DeletePackageRequest request)` Deletes an Amazon OpenSearch Service package.
`DeleteVpcEndpointResult`	`deleteVpcEndpoint(DeleteVpcEndpointRequest request)` Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
`DescribeDomainResult`	`describeDomain(DescribeDomainRequest request)` Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.
`DescribeDomainAutoTunesResult`	`describeDomainAutoTunes(DescribeDomainAutoTunesRequest request)` Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain.
`DescribeDomainChangeProgressResult`	`describeDomainChangeProgress(DescribeDomainChangeProgressRequest request)` Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain.
`DescribeDomainConfigResult`	`describeDomainConfig(DescribeDomainConfigRequest request)` Returns the configuration of an Amazon OpenSearch Service domain.
`DescribeDomainHealthResult`	`describeDomainHealth(DescribeDomainHealthRequest request)` Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node.
`DescribeDomainNodesResult`	`describeDomainNodes(DescribeDomainNodesRequest request)` Returns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node states.
`DescribeDomainsResult`	`describeDomains(DescribeDomainsRequest request)` Returns domain configuration information about the specified Amazon OpenSearch Service domains.
`DescribeDryRunProgressResult`	`describeDryRunProgress(DescribeDryRunProgressRequest request)` Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain.
`DescribeInboundConnectionsResult`	`describeInboundConnections(DescribeInboundConnectionsRequest request)` Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain.
`DescribeInstanceTypeLimitsResult`	`describeInstanceTypeLimits(DescribeInstanceTypeLimitsRequest request)` Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.
`DescribeOutboundConnectionsResult`	`describeOutboundConnections(DescribeOutboundConnectionsRequest request)` Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain.
`DescribePackagesResult`	`describePackages(DescribePackagesRequest request)` Describes all packages available to OpenSearch Service.
`DescribeReservedInstanceOfferingsResult`	`describeReservedInstanceOfferings(DescribeReservedInstanceOfferingsRequest request)` Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region.
`DescribeReservedInstancesResult`	`describeReservedInstances(DescribeReservedInstancesRequest request)` Describes the Amazon OpenSearch Service instances that you have reserved in a given Region.
`DescribeVpcEndpointsResult`	`describeVpcEndpoints(DescribeVpcEndpointsRequest request)` Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
`DissociatePackageResult`	`dissociatePackage(DissociatePackageRequest request)` Removes a package from the specified Amazon OpenSearch Service 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.
`GetCompatibleVersionsResult`	`getCompatibleVersions(GetCompatibleVersionsRequest request)` Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
`GetDataSourceResult`	`getDataSource(GetDataSourceRequest request)` Retrieves information about a direct query data source.
`GetDomainMaintenanceStatusResult`	`getDomainMaintenanceStatus(GetDomainMaintenanceStatusRequest request)` The status of the maintenance action.
`GetPackageVersionHistoryResult`	`getPackageVersionHistory(GetPackageVersionHistoryRequest request)` 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).
`GetUpgradeHistoryResult`	`getUpgradeHistory(GetUpgradeHistoryRequest request)` Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.
`GetUpgradeStatusResult`	`getUpgradeStatus(GetUpgradeStatusRequest request)` Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.
`ListDataSourcesResult`	`listDataSources(ListDataSourcesRequest request)` Lists direct-query data sources for a specific domain.
`ListDomainMaintenancesResult`	`listDomainMaintenances(ListDomainMaintenancesRequest request)` A list of maintenance actions for the domain.
`ListDomainNamesResult`	`listDomainNames(ListDomainNamesRequest request)` Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.
`ListDomainsForPackageResult`	`listDomainsForPackage(ListDomainsForPackageRequest request)` Lists all Amazon OpenSearch Service domains associated with a given package.
`ListInstanceTypeDetailsResult`	`listInstanceTypeDetails(ListInstanceTypeDetailsRequest request)` Lists all instance types and available features for a given OpenSearch or Elasticsearch version.
`ListPackagesForDomainResult`	`listPackagesForDomain(ListPackagesForDomainRequest request)` Lists all packages associated with an Amazon OpenSearch Service domain.
`ListScheduledActionsResult`	`listScheduledActions(ListScheduledActionsRequest request)` Retrieves a list of configuration changes that are scheduled for a domain.
`ListTagsResult`	`listTags(ListTagsRequest request)` Returns all resource tags for an Amazon OpenSearch Service domain.
`ListVersionsResult`	`listVersions(ListVersionsRequest request)` Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.
`ListVpcEndpointAccessResult`	`listVpcEndpointAccess(ListVpcEndpointAccessRequest request)` 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.
`ListVpcEndpointsResult`	`listVpcEndpoints(ListVpcEndpointsRequest request)` Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.
`ListVpcEndpointsForDomainResult`	`listVpcEndpointsForDomain(ListVpcEndpointsForDomainRequest request)` Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.
`PurchaseReservedInstanceOfferingResult`	`purchaseReservedInstanceOffering(PurchaseReservedInstanceOfferingRequest request)` Allows you to purchase Amazon OpenSearch Service Reserved Instances.
`RejectInboundConnectionResult`	`rejectInboundConnection(RejectInboundConnectionRequest request)` Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.
`RemoveTagsResult`	`removeTags(RemoveTagsRequest request)` Removes the specified set of tags from an Amazon OpenSearch Service domain.
`RevokeVpcEndpointAccessResult`	`revokeVpcEndpointAccess(RevokeVpcEndpointAccessRequest request)` Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartDomainMaintenanceResult`	`startDomainMaintenance(StartDomainMaintenanceRequest request)` Starts the node maintenance process on the data node.
`StartServiceSoftwareUpdateResult`	`startServiceSoftwareUpdate(StartServiceSoftwareUpdateRequest request)` Schedules a service software update for an Amazon OpenSearch Service domain.
`UpdateDataSourceResult`	`updateDataSource(UpdateDataSourceRequest request)` Updates a direct-query data source.
`UpdateDomainConfigResult`	`updateDomainConfig(UpdateDomainConfigRequest request)` Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.
`UpdatePackageResult`	`updatePackage(UpdatePackageRequest request)` Updates a package for use with Amazon OpenSearch Service domains.
`UpdateScheduledActionResult`	`updateScheduledAction(UpdateScheduledActionRequest request)` Reschedules a planned domain configuration change for a later time.
`UpdateVpcEndpointResult`	`updateVpcEndpoint(UpdateVpcEndpointRequest request)` Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
`UpgradeDomainResult`	`upgradeDomain(UpgradeDomainRequest request)` Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - builder
```
public static AmazonOpenSearchClientBuilder builder()
```
  - acceptInboundConnection
```
public AcceptInboundConnectionResult acceptInboundConnection(AcceptInboundConnectionRequest request)
```
    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.
    
    Specified by:
    
    acceptInboundConnection in interface AmazonOpenSearch
    
    Parameters:
    
    acceptInboundConnectionRequest - Container for the parameters to the AcceptInboundConnection operation.
    
    Returns:
    
    Result of the AcceptInboundConnection operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.
    
    DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
  - addDataSource
```
public AddDataSourceResult addDataSource(AddDataSourceRequest request)
```
    Creates a new direct-query data source to the specified domain. For more information, see Creating Amazon OpenSearch Service data source integrations with Amazon S3.
    
    Specified by:
    
    addDataSource in interface AmazonOpenSearch
    
    Parameters:
    
    addDataSourceRequest - Container for the parameters to the AddDataSource operation.
    
    Returns:
    
    Result of the AddDataSource operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
    
    DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
    
    DependencyFailureException - An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.
    
    LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.
  - addTags
```
public AddTagsResult addTags(AddTagsRequest request)
```
    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.
    
    Specified by:
    
    addTags in interface AmazonOpenSearch
    
    Parameters:
    
    addTagsRequest - Container for the parameters to the AddTags operation. Specifies the tags to attach to the 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 the allowed number of resources or sub-resources.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
  - associatePackage
```
public AssociatePackageResult associatePackage(AssociatePackageRequest request)
```
    Associates a package with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.
    
    Specified by:
    
    associatePackage in interface AmazonOpenSearch
    
    Parameters:
    
    associatePackageRequest - Container for the request parameters to the AssociatePackage operation.
    
    Returns:
    
    Result of the AssociatePackage operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    AccessDeniedException - An error occurred because you don't have permissions to access the resource.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
    
    ConflictException - An error occurred because the client attempts to remove a resource that is currently in use.
  - authorizeVpcEndpointAccess
```
public AuthorizeVpcEndpointAccessResult authorizeVpcEndpointAccess(AuthorizeVpcEndpointAccessRequest request)
```
    Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
    
    Specified by:
    
    authorizeVpcEndpointAccess in interface AmazonOpenSearch
    
    Parameters:
    
    authorizeVpcEndpointAccessRequest -
    
    Returns:
    
    Result of the AuthorizeVpcEndpointAccess operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
    
    LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    BaseException - An error occurred while processing the request.
  - cancelDomainConfigChange
```
public CancelDomainConfigChangeResult cancelDomainConfigChange(CancelDomainConfigChangeRequest request)
```
    Cancels a pending configuration change on an Amazon OpenSearch Service domain.
    
    Specified by:
    
    cancelDomainConfigChange in interface AmazonOpenSearch
    
    Parameters:
    
    cancelDomainConfigChangeRequest -
    
    Returns:
    
    Result of the CancelDomainConfigChange operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
    
    DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
  - cancelServiceSoftwareUpdate
```
public CancelServiceSoftwareUpdateResult cancelServiceSoftwareUpdate(CancelServiceSoftwareUpdateRequest request)
```
    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.
    
    Specified by:
    
    cancelServiceSoftwareUpdate in interface AmazonOpenSearch
    
    Parameters:
    
    cancelServiceSoftwareUpdateRequest - Container for the request parameters to cancel a service software update.
    
    Returns:
    
    Result of the CancelServiceSoftwareUpdate operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
  - createDomain
```
public CreateDomainResult createDomain(CreateDomainRequest request)
```
    Creates an Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.
    
    Specified by:
    
    createDomain in interface AmazonOpenSearch
    
    Parameters:
    
    createDomainRequest -
    
    Returns:
    
    Result of the CreateDomain operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    InvalidTypeException - An exception for trying to create or access a sub-resource that's either invalid or not supported.
    
    LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.
    
    ResourceAlreadyExistsException - An exception for creating a resource that already exists.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
  - createOutboundConnection
```
public CreateOutboundConnectionResult createOutboundConnection(CreateOutboundConnectionRequest request)
```
    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.
    
    Specified by:
    
    createOutboundConnection in interface AmazonOpenSearch
    
    Parameters:
    
    createOutboundConnectionRequest - Container for the parameters to the CreateOutboundConnection operation.
    
    Returns:
    
    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.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    ResourceAlreadyExistsException - An exception for creating a resource that already exists.
    
    DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
  - createPackage
```
public CreatePackageResult createPackage(CreatePackageRequest request)
```
    Creates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.
    
    Specified by:
    
    createPackage in interface AmazonOpenSearch
    
    Parameters:
    
    createPackageRequest - Container for request parameters to the CreatePackage operation.
    
    Returns:
    
    Result of the CreatePackage operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.
    
    InvalidTypeException - An exception for trying to create or access a sub-resource that's either invalid or not supported.
    
    ResourceAlreadyExistsException - An exception for creating a resource that already exists.
    
    AccessDeniedException - An error occurred because you don't have permissions to access the resource.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
  - createVpcEndpoint
```
public CreateVpcEndpointResult createVpcEndpoint(CreateVpcEndpointRequest request)
```
    Creates an Amazon OpenSearch Service-managed VPC endpoint.
    
    Specified by:
    
    createVpcEndpoint in interface AmazonOpenSearch
    
    Parameters:
    
    createVpcEndpointRequest -
    
    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.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
    
    LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
    
    BaseException - An error occurred while processing the request.
  - deleteDataSource
```
public DeleteDataSourceResult deleteDataSource(DeleteDataSourceRequest request)
```
    Deletes a direct-query data source. For more information, see Deleting an Amazon OpenSearch Service data source with Amazon S3.
    
    Specified by:
    
    deleteDataSource in interface AmazonOpenSearch
    
    Parameters:
    
    deleteDataSourceRequest - Container for the parameters to the DeleteDataSource operation.
    
    Returns:
    
    Result of the DeleteDataSource operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
    
    DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
    
    DependencyFailureException - An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.
  - deleteDomain
```
public DeleteDomainResult deleteDomain(DeleteDomainRequest request)
```
    Deletes an Amazon OpenSearch Service domain and all of its data. You can't recover a domain after you delete it.
    
    Specified by:
    
    deleteDomain in interface AmazonOpenSearch
    
    Parameters:
    
    deleteDomainRequest - Container for the parameters to the DeleteDomain operation.
    
    Returns:
    
    Result of the DeleteDomain operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
  - deleteInboundConnection
```
public DeleteInboundConnectionResult deleteInboundConnection(DeleteInboundConnectionRequest request)
```
    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.
    
    Specified by:
    
    deleteInboundConnection in interface AmazonOpenSearch
    
    Parameters:
    
    deleteInboundConnectionRequest - Container for the parameters to the DeleteInboundConnection operation.
    
    Returns:
    
    Result of the DeleteInboundConnection operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
  - deleteOutboundConnection
```
public DeleteOutboundConnectionResult deleteOutboundConnection(DeleteOutboundConnectionRequest request)
```
    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.
    
    Specified by:
    
    deleteOutboundConnection in interface AmazonOpenSearch
    
    Parameters:
    
    deleteOutboundConnectionRequest - Container for the parameters to the DeleteOutboundConnection operation.
    
    Returns:
    
    Result of the DeleteOutboundConnection operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
  - deletePackage
```
public DeletePackageResult deletePackage(DeletePackageRequest request)
```
    Deletes an Amazon OpenSearch Service package. For more information, see Custom packages for Amazon OpenSearch Service.
    
    Specified by:
    
    deletePackage in interface AmazonOpenSearch
    
    Parameters:
    
    deletePackageRequest - Deletes a package from OpenSearch Service. The package can't be associated with any OpenSearch Service domain.
    
    Returns:
    
    Result of the DeletePackage operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    AccessDeniedException - An error occurred because you don't have permissions to access the resource.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
    
    ConflictException - An error occurred because the client attempts to remove a resource that is currently in use.
  - deleteVpcEndpoint
```
public DeleteVpcEndpointResult deleteVpcEndpoint(DeleteVpcEndpointRequest request)
```
    Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
    
    Specified by:
    
    deleteVpcEndpoint in interface AmazonOpenSearch
    
    Parameters:
    
    deleteVpcEndpointRequest -
    
    Returns:
    
    Result of the DeleteVpcEndpoint operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    BaseException - An error occurred while processing the request.
  - describeDomain
```
public DescribeDomainResult describeDomain(DescribeDomainRequest request)
```
    Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.
    
    Specified by:
    
    describeDomain in interface AmazonOpenSearch
    
    Parameters:
    
    describeDomainRequest - Container for the parameters to the DescribeDomain operation.
    
    Returns:
    
    Result of the DescribeDomain operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
  - describeDomainAutoTunes
```
public DescribeDomainAutoTunesResult describeDomainAutoTunes(DescribeDomainAutoTunesRequest request)
```
    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.
    
    Specified by:
    
    describeDomainAutoTunes in interface AmazonOpenSearch
    
    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 - Request processing failed because of an unknown error, exception, or internal failure.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
  - describeDomainChangeProgress
```
public DescribeDomainChangeProgressResult describeDomainChangeProgress(DescribeDomainChangeProgressRequest request)
```
    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.
    
    Specified by:
    
    describeDomainChangeProgress in interface AmazonOpenSearch
    
    Parameters:
    
    describeDomainChangeProgressRequest - Container for the parameters to the DescribeDomainChangeProgress operation.
    
    Returns:
    
    Result of the DescribeDomainChangeProgress operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
  - describeDomainConfig
```
public DescribeDomainConfigResult describeDomainConfig(DescribeDomainConfigRequest request)
```
    Returns the configuration of an Amazon OpenSearch Service domain.
    
    Specified by:
    
    describeDomainConfig in interface AmazonOpenSearch
    
    Parameters:
    
    describeDomainConfigRequest - Container for the parameters to the DescribeDomainConfig operation.
    
    Returns:
    
    Result of the DescribeDomainConfig operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
  - describeDomainHealth
```
public DescribeDomainHealthResult describeDomainHealth(DescribeDomainHealthRequest request)
```
    Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node.
    
    Specified by:
    
    describeDomainHealth in interface AmazonOpenSearch
    
    Parameters:
    
    describeDomainHealthRequest - Container for the parameters to the DescribeDomainHealth operation.
    
    Returns:
    
    Result of the DescribeDomainHealth operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
    
    DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
  - describeDomainNodes
```
public DescribeDomainNodesResult describeDomainNodes(DescribeDomainNodesRequest request)
```
    Returns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node states.
    
    Specified by:
    
    describeDomainNodes in interface AmazonOpenSearch
    
    Parameters:
    
    describeDomainNodesRequest - Container for the parameters to the DescribeDomainNodes operation.
    
    Returns:
    
    Result of the DescribeDomainNodes operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
    
    DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
    
    DependencyFailureException - An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.
  - describeDomains
```
public DescribeDomainsResult describeDomains(DescribeDomainsRequest request)
```
    Returns domain configuration information about the specified Amazon OpenSearch Service domains.
    
    Specified by:
    
    describeDomains in interface AmazonOpenSearch
    
    Parameters:
    
    describeDomainsRequest - Container for the parameters to the DescribeDomains operation.
    
    Returns:
    
    Result of the DescribeDomains operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
  - describeDryRunProgress
```
public DescribeDryRunProgressResult describeDryRunProgress(DescribeDryRunProgressRequest request)
```
    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.
    
    Specified by:
    
    describeDryRunProgress in interface AmazonOpenSearch
    
    Parameters:
    
    describeDryRunProgressRequest -
    
    Returns:
    
    Result of the DescribeDryRunProgress operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
    
    DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
  - describeInboundConnections
```
public DescribeInboundConnectionsResult describeInboundConnections(DescribeInboundConnectionsRequest request)
```
    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.
    
    Specified by:
    
    describeInboundConnections in interface AmazonOpenSearch
    
    Parameters:
    
    describeInboundConnectionsRequest - Container for the parameters to the DescribeInboundConnections operation.
    
    Returns:
    
    Result of the DescribeInboundConnections operation returned by the service.
    
    Throws:
    
    InvalidPaginationTokenException - Request processing failed because you provided an invalid pagination token.
    
    DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
  - describeInstanceTypeLimits
```
public DescribeInstanceTypeLimitsResult describeInstanceTypeLimits(DescribeInstanceTypeLimitsRequest request)
```
    Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.
    
    Specified by:
    
    describeInstanceTypeLimits in interface AmazonOpenSearch
    
    Parameters:
    
    describeInstanceTypeLimitsRequest - Container for the parameters to the DescribeInstanceTypeLimits operation.
    
    Returns:
    
    Result of the DescribeInstanceTypeLimits operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    InvalidTypeException - An exception for trying to create or access a sub-resource that's either invalid or not supported.
    
    LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
  - describeOutboundConnections
```
public DescribeOutboundConnectionsResult describeOutboundConnections(DescribeOutboundConnectionsRequest request)
```
    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.
    
    Specified by:
    
    describeOutboundConnections in interface AmazonOpenSearch
    
    Parameters:
    
    describeOutboundConnectionsRequest - Container for the parameters to the DescribeOutboundConnections operation.
    
    Returns:
    
    Result of the DescribeOutboundConnections operation returned by the service.
    
    Throws:
    
    InvalidPaginationTokenException - Request processing failed because you provided an invalid pagination token.
    
    DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
  - describePackages
```
public DescribePackagesResult describePackages(DescribePackagesRequest request)
```
    Describes all packages available to OpenSearch Service. For more information, see Custom packages for Amazon OpenSearch Service.
    
    Specified by:
    
    describePackages in interface AmazonOpenSearch
    
    Parameters:
    
    describePackagesRequest - Container for the request parameters to the DescribePackage operation.
    
    Returns:
    
    Result of the DescribePackages operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    AccessDeniedException - An error occurred because you don't have permissions to access the resource.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
  - describeReservedInstanceOfferings
```
public DescribeReservedInstanceOfferingsResult describeReservedInstanceOfferings(DescribeReservedInstanceOfferingsRequest request)
```
    Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.
    
    Specified by:
    
    describeReservedInstanceOfferings in interface AmazonOpenSearch
    
    Parameters:
    
    describeReservedInstanceOfferingsRequest - Container for the request parameters to a DescribeReservedInstanceOfferings operation.
    
    Returns:
    
    Result of the DescribeReservedInstanceOfferings operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
    
    DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
  - describeReservedInstances
```
public DescribeReservedInstancesResult describeReservedInstances(DescribeReservedInstancesRequest request)
```
    Describes the Amazon OpenSearch Service instances that you have reserved in a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.
    
    Specified by:
    
    describeReservedInstances in interface AmazonOpenSearch
    
    Parameters:
    
    describeReservedInstancesRequest - Container for the request parameters to the DescribeReservedInstances operation.
    
    Returns:
    
    Result of the DescribeReservedInstances operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
    
    DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
  - describeVpcEndpoints
```
public DescribeVpcEndpointsResult describeVpcEndpoints(DescribeVpcEndpointsRequest request)
```
    Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
    
    Specified by:
    
    describeVpcEndpoints in interface AmazonOpenSearch
    
    Parameters:
    
    describeVpcEndpointsRequest -
    
    Returns:
    
    Result of the DescribeVpcEndpoints operation returned by the service.
    
    Throws:
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
    
    BaseException - An error occurred while processing the request.
  - dissociatePackage
```
public DissociatePackageResult dissociatePackage(DissociatePackageRequest request)
```
    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.
    
    Specified by:
    
    dissociatePackage in interface AmazonOpenSearch
    
    Parameters:
    
    dissociatePackageRequest - Container for the request parameters to the DissociatePackage operation.
    
    Returns:
    
    Result of the DissociatePackage operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    AccessDeniedException - An error occurred because you don't have permissions to access the resource.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
    
    ConflictException - An error occurred because the client attempts to remove a resource that is currently in use.
  - getCompatibleVersions
```
public GetCompatibleVersionsResult getCompatibleVersions(GetCompatibleVersionsRequest request)
```
    Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
    
    Specified by:
    
    getCompatibleVersions in interface AmazonOpenSearch
    
    Parameters:
    
    getCompatibleVersionsRequest - Container for the request parameters to GetCompatibleVersions operation.
    
    Returns:
    
    Result of the GetCompatibleVersions operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
  - getDataSource
```
public GetDataSourceResult getDataSource(GetDataSourceRequest request)
```
    Retrieves information about a direct query data source.
    
    Specified by:
    
    getDataSource in interface AmazonOpenSearch
    
    Parameters:
    
    getDataSourceRequest - Container for the parameters to the GetDataSource operation.
    
    Returns:
    
    Result of the GetDataSource operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
    
    DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
    
    DependencyFailureException - An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.
  - getDomainMaintenanceStatus
```
public GetDomainMaintenanceStatusResult getDomainMaintenanceStatus(GetDomainMaintenanceStatusRequest request)
```
    The status of the maintenance action.
    
    Specified by:
    
    getDomainMaintenanceStatus in interface AmazonOpenSearch
    
    Parameters:
    
    getDomainMaintenanceStatusRequest - Container for the parameters to the GetDomainMaintenanceStatus operation.
    
    Returns:
    
    Result of the GetDomainMaintenanceStatus operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
    
    DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
  - getPackageVersionHistory
```
public GetPackageVersionHistoryResult getPackageVersionHistory(GetPackageVersionHistoryRequest request)
```
    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.
    
    Specified by:
    
    getPackageVersionHistory in interface AmazonOpenSearch
    
    Parameters:
    
    getPackageVersionHistoryRequest - Container for the request parameters to the GetPackageVersionHistory operation.
    
    Returns:
    
    Result of the GetPackageVersionHistory operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    AccessDeniedException - An error occurred because you don't have permissions to access the resource.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
  - getUpgradeHistory
```
public GetUpgradeHistoryResult getUpgradeHistory(GetUpgradeHistoryRequest request)
```
    Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.
    
    Specified by:
    
    getUpgradeHistory in interface AmazonOpenSearch
    
    Parameters:
    
    getUpgradeHistoryRequest - Container for the request parameters to the 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 doesn't exist.
    
    DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
  - getUpgradeStatus
```
public GetUpgradeStatusResult getUpgradeStatus(GetUpgradeStatusRequest request)
```
    Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.
    
    Specified by:
    
    getUpgradeStatus in interface AmazonOpenSearch
    
    Parameters:
    
    getUpgradeStatusRequest - Container for the request parameters to the 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 doesn't exist.
    
    DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
  - listDataSources
```
public ListDataSourcesResult listDataSources(ListDataSourcesRequest request)
```
    Lists direct-query data sources for a specific domain. For more information, see For more information, see Working with Amazon OpenSearch Service direct queries with Amazon S3.
    
    Specified by:
    
    listDataSources in interface AmazonOpenSearch
    
    Parameters:
    
    listDataSourcesRequest - Container for the parameters to the ListDataSources operation.
    
    Returns:
    
    Result of the ListDataSources operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
    
    DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
    
    DependencyFailureException - An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.
  - listDomainMaintenances
```
public ListDomainMaintenancesResult listDomainMaintenances(ListDomainMaintenancesRequest request)
```
    A list of maintenance actions for the domain.
    
    Specified by:
    
    listDomainMaintenances in interface AmazonOpenSearch
    
    Parameters:
    
    listDomainMaintenancesRequest - Container for the parameters to the ListDomainMaintenances operation.
    
    Returns:
    
    Result of the ListDomainMaintenances operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
    
    DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
  - listDomainNames
```
public ListDomainNamesResult listDomainNames(ListDomainNamesRequest request)
```
    Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.
    
    Specified by:
    
    listDomainNames in interface AmazonOpenSearch
    
    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 accessing or deleting a resource that doesn't exist.
  - listDomainsForPackage
```
public ListDomainsForPackageResult listDomainsForPackage(ListDomainsForPackageRequest request)
```
    Lists all Amazon OpenSearch Service domains associated with a given package. For more information, see Custom packages for Amazon OpenSearch Service.
    
    Specified by:
    
    listDomainsForPackage in interface AmazonOpenSearch
    
    Parameters:
    
    listDomainsForPackageRequest - Container for the request parameters to the ListDomainsForPackage operation.
    
    Returns:
    
    Result of the ListDomainsForPackage operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    AccessDeniedException - An error occurred because you don't have permissions to access the resource.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
  - listInstanceTypeDetails
```
public ListInstanceTypeDetailsResult listInstanceTypeDetails(ListInstanceTypeDetailsRequest request)
```
    Lists all instance types and available features for a given OpenSearch or Elasticsearch version.
    
    Specified by:
    
    listInstanceTypeDetails in interface AmazonOpenSearch
    
    Parameters:
    
    listInstanceTypeDetailsRequest -
    
    Returns:
    
    Result of the ListInstanceTypeDetails operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
  - listPackagesForDomain
```
public ListPackagesForDomainResult listPackagesForDomain(ListPackagesForDomainRequest request)
```
    Lists all packages associated with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.
    
    Specified by:
    
    listPackagesForDomain in interface AmazonOpenSearch
    
    Parameters:
    
    listPackagesForDomainRequest - Container for the request parameters to the ListPackagesForDomain operation.
    
    Returns:
    
    Result of the ListPackagesForDomain operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    AccessDeniedException - An error occurred because you don't have permissions to access the resource.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
  - listScheduledActions
```
public ListScheduledActionsResult listScheduledActions(ListScheduledActionsRequest request)
```
    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.
    
    Specified by:
    
    listScheduledActions in interface AmazonOpenSearch
    
    Parameters:
    
    listScheduledActionsRequest -
    
    Returns:
    
    Result of the ListScheduledActions operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    InvalidPaginationTokenException - Request processing failed because you provided an invalid pagination token.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
  - listTags
```
public ListTagsResult listTags(ListTagsRequest request)
```
    Returns all resource tags for an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.
    
    Specified by:
    
    listTags in interface AmazonOpenSearch
    
    Parameters:
    
    listTagsRequest - Container for the parameters to the ListTags operation.
    
    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 doesn't exist.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
  - listVersions
```
public ListVersionsResult listVersions(ListVersionsRequest request)
```
    Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.
    
    Specified by:
    
    listVersions in interface AmazonOpenSearch
    
    Parameters:
    
    listVersionsRequest - Container for the request parameters to the ListVersions operation.
    
    Returns:
    
    Result of the ListVersions operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
  - listVpcEndpointAccess
```
public ListVpcEndpointAccessResult listVpcEndpointAccess(ListVpcEndpointAccessRequest request)
```
    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.
    
    Specified by:
    
    listVpcEndpointAccess in interface AmazonOpenSearch
    
    Parameters:
    
    listVpcEndpointAccessRequest -
    
    Returns:
    
    Result of the ListVpcEndpointAccess operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    BaseException - An error occurred while processing the request.
  - listVpcEndpoints
```
public ListVpcEndpointsResult listVpcEndpoints(ListVpcEndpointsRequest request)
```
    Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.
    
    Specified by:
    
    listVpcEndpoints in interface AmazonOpenSearch
    
    Parameters:
    
    listVpcEndpointsRequest -
    
    Returns:
    
    Result of the ListVpcEndpoints operation returned by the service.
    
    Throws:
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
    
    BaseException - An error occurred while processing the request.
  - listVpcEndpointsForDomain
```
public ListVpcEndpointsForDomainResult listVpcEndpointsForDomain(ListVpcEndpointsForDomainRequest request)
```
    Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.
    
    Specified by:
    
    listVpcEndpointsForDomain in interface AmazonOpenSearch
    
    Parameters:
    
    listVpcEndpointsForDomainRequest -
    
    Returns:
    
    Result of the ListVpcEndpointsForDomain operation returned by the service.
    
    Throws:
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    BaseException - An error occurred while processing the request.
  - purchaseReservedInstanceOffering
```
public PurchaseReservedInstanceOfferingResult purchaseReservedInstanceOffering(PurchaseReservedInstanceOfferingRequest request)
```
    Allows you to purchase Amazon OpenSearch Service Reserved Instances.
    
    Specified by:
    
    purchaseReservedInstanceOffering in interface AmazonOpenSearch
    
    Parameters:
    
    purchaseReservedInstanceOfferingRequest - Container for request parameters to the PurchaseReservedInstanceOffering operation.
    
    Returns:
    
    Result of the PurchaseReservedInstanceOffering operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    ResourceAlreadyExistsException - An exception for creating a resource that already exists.
    
    LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.
    
    DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
  - rejectInboundConnection
```
public RejectInboundConnectionResult rejectInboundConnection(RejectInboundConnectionRequest request)
```
    Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.
    
    Specified by:
    
    rejectInboundConnection in interface AmazonOpenSearch
    
    Parameters:
    
    rejectInboundConnectionRequest - Container for the request parameters to the RejectInboundConnection operation.
    
    Returns:
    
    Result of the RejectInboundConnection operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
  - removeTags
```
public RemoveTagsResult removeTags(RemoveTagsRequest request)
```
    Removes the specified set of tags from an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.
    
    Specified by:
    
    removeTags in interface AmazonOpenSearch
    
    Parameters:
    
    removeTagsRequest - Container for the request parameters to the RemoveTags operation.
    
    Returns:
    
    Result of the RemoveTags operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
  - revokeVpcEndpointAccess
```
public RevokeVpcEndpointAccessResult revokeVpcEndpointAccess(RevokeVpcEndpointAccessRequest request)
```
    Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.
    
    Specified by:
    
    revokeVpcEndpointAccess in interface AmazonOpenSearch
    
    Parameters:
    
    revokeVpcEndpointAccessRequest -
    
    Returns:
    
    Result of the RevokeVpcEndpointAccess operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
    
    DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    BaseException - An error occurred while processing the request.
  - startDomainMaintenance
```
public StartDomainMaintenanceResult startDomainMaintenance(StartDomainMaintenanceRequest request)
```
    Starts the node maintenance process on the data node. These processes can include a node reboot, an Opensearch or Elasticsearch process restart, or a Dashboard or Kibana restart.
    
    Specified by:
    
    startDomainMaintenance in interface AmazonOpenSearch
    
    Parameters:
    
    startDomainMaintenanceRequest - Container for the parameters to the StartDomainMaintenance operation.
    
    Returns:
    
    Result of the StartDomainMaintenance operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
    
    DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
  - startServiceSoftwareUpdate
```
public StartServiceSoftwareUpdateResult startServiceSoftwareUpdate(StartServiceSoftwareUpdateRequest request)
```
    Schedules a service software update for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.
    
    Specified by:
    
    startServiceSoftwareUpdate in interface AmazonOpenSearch
    
    Parameters:
    
    startServiceSoftwareUpdateRequest - Container for the request parameters to the StartServiceSoftwareUpdate operation.
    
    Returns:
    
    Result of the StartServiceSoftwareUpdate operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
  - updateDataSource
```
public UpdateDataSourceResult updateDataSource(UpdateDataSourceRequest request)
```
    Updates a direct-query data source. For more information, see Working with Amazon OpenSearch Service data source integrations with Amazon S3.
    
    Specified by:
    
    updateDataSource in interface AmazonOpenSearch
    
    Parameters:
    
    updateDataSourceRequest - Container for the parameters to the UpdateDataSource operation.
    
    Returns:
    
    Result of the UpdateDataSource operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
    
    DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
    
    DependencyFailureException - An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.
  - updateDomainConfig
```
public UpdateDomainConfigResult updateDomainConfig(UpdateDomainConfigRequest request)
```
    Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.
    
    Specified by:
    
    updateDomainConfig in interface AmazonOpenSearch
    
    Parameters:
    
    updateDomainConfigRequest - Container for the request parameters to the UpdateDomain operation.
    
    Returns:
    
    Result of the UpdateDomainConfig operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    InvalidTypeException - An exception for trying to create or access a sub-resource that's either invalid or not supported.
    
    LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
  - updatePackage
```
public UpdatePackageResult updatePackage(UpdatePackageRequest request)
```
    Updates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.
    
    Specified by:
    
    updatePackage in interface AmazonOpenSearch
    
    Parameters:
    
    updatePackageRequest - Container for request parameters to the UpdatePackage operation.
    
    Returns:
    
    Result of the UpdatePackage operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    AccessDeniedException - An error occurred because you don't have permissions to access the resource.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
  - updateScheduledAction
```
public UpdateScheduledActionResult updateScheduledAction(UpdateScheduledActionRequest request)
```
    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.
    
    Specified by:
    
    updateScheduledAction in interface AmazonOpenSearch
    
    Parameters:
    
    updateScheduledActionRequest -
    
    Returns:
    
    Result of the UpdateScheduledAction operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    SlotNotAvailableException - An exception for attempting to schedule a domain action during an unavailable time slot.
    
    ConflictException - An error occurred because the client attempts to remove a resource that is currently in use.
    
    LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
  - updateVpcEndpoint
```
public UpdateVpcEndpointResult updateVpcEndpoint(UpdateVpcEndpointRequest request)
```
    Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
    
    Specified by:
    
    updateVpcEndpoint in interface AmazonOpenSearch
    
    Parameters:
    
    updateVpcEndpointRequest -
    
    Returns:
    
    Result of the UpdateVpcEndpoint operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
    
    ConflictException - An error occurred because the client attempts to remove a resource that is currently in use.
    
    BaseException - An error occurred while processing the request.
  - upgradeDomain
```
public UpgradeDomainResult upgradeDomain(UpgradeDomainRequest request)
```
    Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.
    
    Specified by:
    
    upgradeDomain in interface AmazonOpenSearch
    
    Parameters:
    
    upgradeDomainRequest - Container for the request parameters to the UpgradeDomain operation.
    
    Returns:
    
    Result of the UpgradeDomain operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
    
    ResourceAlreadyExistsException - An exception for creating a resource that already exists.
    
    DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
    
    ValidationException - An exception for accessing or deleting a resource that doesn't exist.
    
    InternalException - Request processing failed because of an unknown error, exception, or internal failure.
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonOpenSearch
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - shutdown
```
public void shutdown()
```
    Description copied from class: AmazonWebServiceClient
    
    Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonOpenSearch
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

AWS SDK for Java 1.x API Reference - 1.12.777

Class AmazonOpenSearchClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.opensearch.AmazonOpenSearch

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Method Detail

builder

acceptInboundConnection

addDataSource

addTags

associatePackage

authorizeVpcEndpointAccess

cancelDomainConfigChange

cancelServiceSoftwareUpdate

createDomain

createOutboundConnection

createPackage

createVpcEndpoint

deleteDataSource

deleteDomain

deleteInboundConnection

deleteOutboundConnection

deletePackage

deleteVpcEndpoint

describeDomain

describeDomainAutoTunes

describeDomainChangeProgress

describeDomainConfig

describeDomainHealth

describeDomainNodes

describeDomains

describeDryRunProgress

describeInboundConnections

describeInstanceTypeLimits

describeOutboundConnections

describePackages

describeReservedInstanceOfferings

describeReservedInstances

describeVpcEndpoints

dissociatePackage

getCompatibleVersions

getDataSource

getDomainMaintenanceStatus

getPackageVersionHistory

getUpgradeHistory

getUpgradeStatus

listDataSources

listDomainMaintenances

listDomainNames

listDomainsForPackage

listInstanceTypeDetails

listPackagesForDomain

listScheduledActions

listTags

listVersions

listVpcEndpointAccess

listVpcEndpoints

listVpcEndpointsForDomain

purchaseReservedInstanceOffering

rejectInboundConnection

removeTags

revokeVpcEndpointAccess

startDomainMaintenance

startServiceSoftwareUpdate

updateDataSource

updateDomainConfig

updatePackage

updateScheduledAction

updateVpcEndpoint

upgradeDomain

getCachedResponseMetadata

shutdown