com.amazonaws.services.opensearch

Class AmazonOpenSearchClient

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.

Amazon OpenSearch Configuration Service

Use the Amazon OpenSearch configuration API to create, configure, and manage Amazon 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 Regions and 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

Modifier and Type	Method and Description
AcceptInboundConnectionResult	acceptInboundConnection(AcceptInboundConnectionRequest request) Allows the remote domain owner to accept an inbound cross-cluster connection request.
AddTagsResult	addTags(AddTagsRequest request) Attaches tags to an existing domain.
AssociatePackageResult	associatePackage(AssociatePackageRequest request) Associates a package with an Amazon OpenSearch Service domain.
static AmazonOpenSearchClientBuilder	builder()
CancelServiceSoftwareUpdateResult	cancelServiceSoftwareUpdate(CancelServiceSoftwareUpdateRequest request) Cancels a scheduled service software update for an Amazon OpenSearch Service domain.
CreateDomainResult	createDomain(CreateDomainRequest request) Creates a new Amazon OpenSearch Service domain.
CreateOutboundConnectionResult	createOutboundConnection(CreateOutboundConnectionRequest request) Creates a new cross-cluster connection from a local OpenSearch domain to a remote OpenSearch domain.
CreatePackageResult	createPackage(CreatePackageRequest request) Create a package for use with Amazon OpenSearch Service domains.
DeleteDomainResult	deleteDomain(DeleteDomainRequest request) Permanently deletes the specified domain and all of its data.
DeleteInboundConnectionResult	deleteInboundConnection(DeleteInboundConnectionRequest request) Allows the remote domain owner to delete an existing inbound cross-cluster connection.
DeleteOutboundConnectionResult	deleteOutboundConnection(DeleteOutboundConnectionRequest request) Allows the local domain owner to delete an existing outbound cross-cluster connection.
DeletePackageResult	deletePackage(DeletePackageRequest request) Deletes the package.
DescribeDomainResult	describeDomain(DescribeDomainRequest request) Returns domain configuration information about the specified domain, including the domain ID, domain endpoint, and domain ARN.
DescribeDomainAutoTunesResult	describeDomainAutoTunes(DescribeDomainAutoTunesRequest request) Provides scheduled Auto-Tune action details for the domain, such as Auto-Tune action type, description, severity, and scheduled date.
DescribeDomainConfigResult	describeDomainConfig(DescribeDomainConfigRequest request) Provides cluster configuration information about the specified domain, such as the state, creation date, update version, and update date for cluster options.
DescribeDomainsResult	describeDomains(DescribeDomainsRequest request) Returns domain configuration information about the specified domains, including the domain ID, domain endpoint, and domain ARN.
DescribeInboundConnectionsResult	describeInboundConnections(DescribeInboundConnectionsRequest request) Lists all the inbound cross-cluster connections for a remote domain.
DescribeInstanceTypeLimitsResult	describeInstanceTypeLimits(DescribeInstanceTypeLimitsRequest request) Describe the limits for a given instance type and OpenSearch or Elasticsearch version.
DescribeOutboundConnectionsResult	describeOutboundConnections(DescribeOutboundConnectionsRequest request) Lists all the outbound cross-cluster connections for a local domain.
DescribePackagesResult	describePackages(DescribePackagesRequest request) Describes all packages available to Amazon OpenSearch Service domains.
DescribeReservedInstanceOfferingsResult	describeReservedInstanceOfferings(DescribeReservedInstanceOfferingsRequest request) Lists available reserved OpenSearch instance offerings.
DescribeReservedInstancesResult	describeReservedInstances(DescribeReservedInstancesRequest request) Returns information about reserved OpenSearch instances for this account.
DissociatePackageResult	dissociatePackage(DissociatePackageRequest request) Dissociates a package from the 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 list of upgrade-compatible versions of OpenSearch/Elasticsearch.
GetPackageVersionHistoryResult	getPackageVersionHistory(GetPackageVersionHistoryRequest request) Returns a list of package versions, along with their creation time and commit message.
GetUpgradeHistoryResult	getUpgradeHistory(GetUpgradeHistoryRequest request) Retrieves the complete history of the last 10 upgrades performed on the domain.
GetUpgradeStatusResult	getUpgradeStatus(GetUpgradeStatusRequest request) Retrieves the latest status of the last upgrade or upgrade eligibility check performed on the domain.
ListDomainNamesResult	listDomainNames(ListDomainNamesRequest request) Returns the names of all domains owned by the current user's account.
ListDomainsForPackageResult	listDomainsForPackage(ListDomainsForPackageRequest request) Lists all Amazon OpenSearch Service domains associated with the package.
ListInstanceTypeDetailsResult	listInstanceTypeDetails(ListInstanceTypeDetailsRequest request)
ListPackagesForDomainResult	listPackagesForDomain(ListPackagesForDomainRequest request) Lists all packages associated with the Amazon OpenSearch Service domain.
ListTagsResult	listTags(ListTagsRequest request) Returns all tags for the given domain.
ListVersionsResult	listVersions(ListVersionsRequest request) List all supported versions of OpenSearch and Elasticsearch.
PurchaseReservedInstanceOfferingResult	purchaseReservedInstanceOffering(PurchaseReservedInstanceOfferingRequest request) Allows you to purchase reserved OpenSearch instances.
RejectInboundConnectionResult	rejectInboundConnection(RejectInboundConnectionRequest request) Allows the remote domain owner to reject an inbound cross-cluster connection request.
RemoveTagsResult	removeTags(RemoveTagsRequest request) Removes the specified set of tags from the given domain.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartServiceSoftwareUpdateResult	startServiceSoftwareUpdate(StartServiceSoftwareUpdateRequest request) Schedules a service software update for an Amazon OpenSearch Service domain.
UpdateDomainConfigResult	updateDomainConfig(UpdateDomainConfigRequest request) Modifies the cluster configuration of the specified domain, such as setting the instance type and the number of instances.
UpdatePackageResult	updatePackage(UpdatePackageRequest request) Updates a package for use with Amazon OpenSearch Service domains.
UpgradeDomainResult	upgradeDomain(UpgradeDomainRequest request) Allows you to either upgrade your domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

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

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static AmazonOpenSearchClientBuilder builder()

acceptInboundConnection

public AcceptInboundConnectionResult acceptInboundConnection(AcceptInboundConnectionRequest request)

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

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 does not exist. Gives http status code of 400.

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

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

addTags

public AddTagsResult addTags(AddTagsRequest request)

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

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 allowed resources or sub-resources. Gives http status code of 409.

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

InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

associatePackage

public AssociatePackageResult associatePackage(AssociatePackageRequest request)

Associates a package with an Amazon OpenSearch Service domain.

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 - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

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

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

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

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

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 UpdateStatus is in the PENDING_UPDATE state.

Specified by:

cancelServiceSoftwareUpdate in interface AmazonOpenSearch

Parameters:

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

Returns:

Result of the CancelServiceSoftwareUpdate operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

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

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

createDomain

public CreateDomainResult createDomain(CreateDomainRequest request)

Creates a new Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains in the Amazon OpenSearch Service Developer Guide.

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 a not supported operation. Gives http status code of 409.

InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

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

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

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

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

createOutboundConnection

public CreateOutboundConnectionResult createOutboundConnection(CreateOutboundConnectionRequest request)

Creates a new cross-cluster connection from a local OpenSearch domain to a remote OpenSearch domain.

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 allowed resources or sub-resources. Gives http status code of 409.

InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

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

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

createPackage

public CreatePackageResult createPackage(CreatePackageRequest request)

Create a package for use with Amazon OpenSearch Service domains.

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 - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

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

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

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

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

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

deleteDomain

public DeleteDomainResult deleteDomain(DeleteDomainRequest request)

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

Specified by:

deleteDomain in interface AmazonOpenSearch

Parameters:

deleteDomainRequest - Container for the parameters to the DeleteDomain operation. Specifies the name of the domain you want to delete.

Returns:

Result of the DeleteDomain operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

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

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

deleteInboundConnection

public DeleteInboundConnectionResult deleteInboundConnection(DeleteInboundConnectionRequest request)

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

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 does not exist. Gives http status code of 400.

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

deleteOutboundConnection

public DeleteOutboundConnectionResult deleteOutboundConnection(DeleteOutboundConnectionRequest request)

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

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 does not exist. Gives http status code of 400.

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

deletePackage

public DeletePackageResult deletePackage(DeletePackageRequest request)

Deletes the package.

Specified by:

deletePackage in interface AmazonOpenSearch

Parameters:

deletePackageRequest - Container for the request parameters to the DeletePackage operation.

Returns:

Result of the DeletePackage operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

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

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

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

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

describeDomain

public DescribeDomainResult describeDomain(DescribeDomainRequest request)

Returns domain configuration information about the specified domain, including the domain ID, domain 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 - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

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

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

describeDomainAutoTunes

public DescribeDomainAutoTunesResult describeDomainAutoTunes(DescribeDomainAutoTunesRequest request)

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

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 - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

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

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

describeDomainConfig

public DescribeDomainConfigResult describeDomainConfig(DescribeDomainConfigRequest request)

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

Specified by:

describeDomainConfig in interface AmazonOpenSearch

Parameters:

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

Returns:

Result of the DescribeDomainConfig operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

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

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

describeDomains

public DescribeDomainsResult describeDomains(DescribeDomainsRequest request)

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

Specified by:

describeDomains in interface AmazonOpenSearch

Parameters:

describeDomainsRequest - Container for the parameters to the DescribeDomains operation. By default, the API returns the status of all domains.

Returns:

Result of the DescribeDomains operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

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

describeInboundConnections

public DescribeInboundConnectionsResult describeInboundConnections(DescribeInboundConnectionsRequest request)

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

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 - The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400.

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

describeInstanceTypeLimits

public DescribeInstanceTypeLimitsResult describeInstanceTypeLimits(DescribeInstanceTypeLimitsRequest request)

Describe the limits for a given instance type and OpenSearch or Elasticsearch version. When modifying an existing domain, specify the DomainName to see which limits you can modify.

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 - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

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

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

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

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

describeOutboundConnections

public DescribeOutboundConnectionsResult describeOutboundConnections(DescribeOutboundConnectionsRequest request)

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

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 - The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400.

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

describePackages

public DescribePackagesResult describePackages(DescribePackagesRequest request)

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

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 - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

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

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

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

describeReservedInstanceOfferings

public DescribeReservedInstanceOfferingsResult describeReservedInstanceOfferings(DescribeReservedInstanceOfferingsRequest request)

Lists available reserved OpenSearch instance offerings.

Specified by:

describeReservedInstanceOfferings in interface AmazonOpenSearch

Parameters:

describeReservedInstanceOfferingsRequest - Container for parameters to DescribeReservedInstanceOfferings

Returns:

Result of the DescribeReservedInstanceOfferings operation returned by the service.

Throws:

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

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

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

InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

describeReservedInstances

public DescribeReservedInstancesResult describeReservedInstances(DescribeReservedInstancesRequest request)

Returns information about reserved OpenSearch instances for this account.

Specified by:

describeReservedInstances in interface AmazonOpenSearch

Parameters:

describeReservedInstancesRequest - Container for parameters to DescribeReservedInstances

Returns:

Result of the DescribeReservedInstances operation returned by the service.

Throws:

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

InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

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

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

dissociatePackage

public DissociatePackageResult dissociatePackage(DissociatePackageRequest request)

Dissociates a package from the Amazon OpenSearch Service domain.

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 - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

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

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

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

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

getCompatibleVersions

public GetCompatibleVersionsResult getCompatibleVersions(GetCompatibleVersionsRequest request)

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

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 does not exist. Gives http status code of 400.

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

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

InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

getPackageVersionHistory

public GetPackageVersionHistoryResult getPackageVersionHistory(GetPackageVersionHistoryRequest request)

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

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 - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

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

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

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

getUpgradeHistory

public GetUpgradeHistoryResult getUpgradeHistory(GetUpgradeHistoryRequest request)

Retrieves the complete history of the last 10 upgrades performed on the 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 does not exist. Gives http status code of 400.

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

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

InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

getUpgradeStatus

public GetUpgradeStatusResult getUpgradeStatus(GetUpgradeStatusRequest request)

Retrieves the latest status of the last upgrade or upgrade eligibility check performed on the 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 does not exist. Gives http status code of 400.

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

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

InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

listDomainNames

public ListDomainNamesResult listDomainNames(ListDomainNamesRequest request)

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

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 missing / invalid input fields. Gives http status code of 400.

listDomainsForPackage

public ListDomainsForPackageResult listDomainsForPackage(ListDomainsForPackageRequest request)

Lists all Amazon OpenSearch Service domains associated with the package.

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 - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

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

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

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

listInstanceTypeDetails

public ListInstanceTypeDetailsResult listInstanceTypeDetails(ListInstanceTypeDetailsRequest request)

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 - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

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

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

listPackagesForDomain

public ListPackagesForDomainResult listPackagesForDomain(ListPackagesForDomainRequest request)

Lists all packages associated with the Amazon OpenSearch Service domain.

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 - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

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

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

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

listTags

public ListTagsResult listTags(ListTagsRequest request)

Returns all tags for the given domain.

Specified by:

listTags in interface AmazonOpenSearch

Parameters:

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

Returns:

Result of the ListTags operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

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

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

InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

listVersions

public ListVersionsResult listVersions(ListVersionsRequest request)

List all supported versions of OpenSearch and Elasticsearch.

Specified by:

listVersions in interface AmazonOpenSearch

Parameters:

listVersionsRequest - Container for the parameters to the ListVersions operation.

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

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

Returns:

Result of the ListVersions operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

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

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

purchaseReservedInstanceOffering

public PurchaseReservedInstanceOfferingResult purchaseReservedInstanceOffering(PurchaseReservedInstanceOfferingRequest request)

Allows you to purchase reserved OpenSearch instances.

Specified by:

purchaseReservedInstanceOffering in interface AmazonOpenSearch

Parameters:

purchaseReservedInstanceOfferingRequest - Container for parameters to PurchaseReservedInstanceOffering

Returns:

Result of the PurchaseReservedInstanceOffering operation returned by the service.

Throws:

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

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

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

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

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

InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

rejectInboundConnection

public RejectInboundConnectionResult rejectInboundConnection(RejectInboundConnectionRequest request)

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

Specified by:

rejectInboundConnection in interface AmazonOpenSearch

Parameters:

rejectInboundConnectionRequest - Container for the 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 does not exist. Gives http status code of 400.

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

removeTags

public RemoveTagsResult removeTags(RemoveTagsRequest request)

Removes the specified set of tags from the given domain.

Specified by:

removeTags in interface AmazonOpenSearch

Parameters:

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

Returns:

Result of the RemoveTags operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

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

InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

startServiceSoftwareUpdate

public StartServiceSoftwareUpdateResult startServiceSoftwareUpdate(StartServiceSoftwareUpdateRequest request)

Schedules a service software update for an Amazon OpenSearch Service domain.

Specified by:

startServiceSoftwareUpdate in interface AmazonOpenSearch

Parameters:

startServiceSoftwareUpdateRequest - Container for the parameters to the StartServiceSoftwareUpdate operation. Specifies the name of the domain to schedule a service software update for.

Returns:

Result of the StartServiceSoftwareUpdate operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

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

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

updateDomainConfig

public UpdateDomainConfigResult updateDomainConfig(UpdateDomainConfigRequest request)

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

Specified by:

updateDomainConfig in interface AmazonOpenSearch

Parameters:

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

Returns:

Result of the UpdateDomainConfig operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

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

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

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

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

updatePackage

public UpdatePackageResult updatePackage(UpdatePackageRequest request)

Updates a package for use with Amazon OpenSearch Service domains.

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 - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

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

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

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

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

upgradeDomain

public UpgradeDomainResult upgradeDomain(UpgradeDomainRequest request)

Allows you to either upgrade your 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 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 does not exist. Gives http status code of 400.

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

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

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

InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

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

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

Specified by:

getCachedResponseMetadata in interface 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