com.amazonaws.services.opensearch

Interface AmazonOpenSearch

All Known Subinterfaces:

AmazonOpenSearchAsync

All Known Implementing Classes:

AbstractAmazonOpenSearch, AbstractAmazonOpenSearchAsync, AmazonOpenSearchAsyncClient, AmazonOpenSearchClient

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

Interface for accessing Amazon OpenSearch Service.

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

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

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

Method Summary

Modifier and Type	Method and Description
AcceptInboundConnectionResult	acceptInboundConnection(AcceptInboundConnectionRequest acceptInboundConnectionRequest) Allows the remote domain owner to accept an inbound cross-cluster connection request.
AddTagsResult	addTags(AddTagsRequest addTagsRequest) Attaches tags to an existing domain.
AssociatePackageResult	associatePackage(AssociatePackageRequest associatePackageRequest) Associates a package with an Amazon OpenSearch Service domain.
CancelServiceSoftwareUpdateResult	cancelServiceSoftwareUpdate(CancelServiceSoftwareUpdateRequest cancelServiceSoftwareUpdateRequest) Cancels a scheduled service software update for an Amazon OpenSearch Service domain.
CreateDomainResult	createDomain(CreateDomainRequest createDomainRequest) Creates a new Amazon OpenSearch Service domain.
CreateOutboundConnectionResult	createOutboundConnection(CreateOutboundConnectionRequest createOutboundConnectionRequest) Creates a new cross-cluster connection from a local OpenSearch domain to a remote OpenSearch domain.
CreatePackageResult	createPackage(CreatePackageRequest createPackageRequest) Create a package for use with Amazon OpenSearch Service domains.
DeleteDomainResult	deleteDomain(DeleteDomainRequest deleteDomainRequest) Permanently deletes the specified domain and all of its data.
DeleteInboundConnectionResult	deleteInboundConnection(DeleteInboundConnectionRequest deleteInboundConnectionRequest) Allows the remote domain owner to delete an existing inbound cross-cluster connection.
DeleteOutboundConnectionResult	deleteOutboundConnection(DeleteOutboundConnectionRequest deleteOutboundConnectionRequest) Allows the local domain owner to delete an existing outbound cross-cluster connection.
DeletePackageResult	deletePackage(DeletePackageRequest deletePackageRequest) Deletes the package.
DescribeDomainResult	describeDomain(DescribeDomainRequest describeDomainRequest) Returns domain configuration information about the specified domain, including the domain ID, domain endpoint, and domain ARN.
DescribeDomainAutoTunesResult	describeDomainAutoTunes(DescribeDomainAutoTunesRequest describeDomainAutoTunesRequest) Provides scheduled Auto-Tune action details for the domain, such as Auto-Tune action type, description, severity, and scheduled date.
DescribeDomainChangeProgressResult	describeDomainChangeProgress(DescribeDomainChangeProgressRequest describeDomainChangeProgressRequest) Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.
DescribeDomainConfigResult	describeDomainConfig(DescribeDomainConfigRequest describeDomainConfigRequest) 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 describeDomainsRequest) Returns domain configuration information about the specified domains, including the domain ID, domain endpoint, and domain ARN.
DescribeInboundConnectionsResult	describeInboundConnections(DescribeInboundConnectionsRequest describeInboundConnectionsRequest) Lists all the inbound cross-cluster connections for a remote domain.
DescribeInstanceTypeLimitsResult	describeInstanceTypeLimits(DescribeInstanceTypeLimitsRequest describeInstanceTypeLimitsRequest) Describe the limits for a given instance type and OpenSearch or Elasticsearch version.
DescribeOutboundConnectionsResult	describeOutboundConnections(DescribeOutboundConnectionsRequest describeOutboundConnectionsRequest) Lists all the outbound cross-cluster connections for a local domain.
DescribePackagesResult	describePackages(DescribePackagesRequest describePackagesRequest) Describes all packages available to Amazon OpenSearch Service domains.
DescribeReservedInstanceOfferingsResult	describeReservedInstanceOfferings(DescribeReservedInstanceOfferingsRequest describeReservedInstanceOfferingsRequest) Lists available reserved OpenSearch instance offerings.
DescribeReservedInstancesResult	describeReservedInstances(DescribeReservedInstancesRequest describeReservedInstancesRequest) Returns information about reserved OpenSearch instances for this account.
DissociatePackageResult	dissociatePackage(DissociatePackageRequest dissociatePackageRequest) 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 getCompatibleVersionsRequest) Returns a list of upgrade-compatible versions of OpenSearch/Elasticsearch.
GetPackageVersionHistoryResult	getPackageVersionHistory(GetPackageVersionHistoryRequest getPackageVersionHistoryRequest) Returns a list of package versions, along with their creation time and commit message.
GetUpgradeHistoryResult	getUpgradeHistory(GetUpgradeHistoryRequest getUpgradeHistoryRequest) Retrieves the complete history of the last 10 upgrades performed on the domain.
GetUpgradeStatusResult	getUpgradeStatus(GetUpgradeStatusRequest getUpgradeStatusRequest) Retrieves the latest status of the last upgrade or upgrade eligibility check performed on the domain.
ListDomainNamesResult	listDomainNames(ListDomainNamesRequest listDomainNamesRequest) Returns the names of all domains owned by the current user's account.
ListDomainsForPackageResult	listDomainsForPackage(ListDomainsForPackageRequest listDomainsForPackageRequest) Lists all Amazon OpenSearch Service domains associated with the package.
ListInstanceTypeDetailsResult	listInstanceTypeDetails(ListInstanceTypeDetailsRequest listInstanceTypeDetailsRequest)
ListPackagesForDomainResult	listPackagesForDomain(ListPackagesForDomainRequest listPackagesForDomainRequest) Lists all packages associated with the Amazon OpenSearch Service domain.
ListTagsResult	listTags(ListTagsRequest listTagsRequest) Returns all tags for the given domain.
ListVersionsResult	listVersions(ListVersionsRequest listVersionsRequest) List all supported versions of OpenSearch and Elasticsearch.
PurchaseReservedInstanceOfferingResult	purchaseReservedInstanceOffering(PurchaseReservedInstanceOfferingRequest purchaseReservedInstanceOfferingRequest) Allows you to purchase reserved OpenSearch instances.
RejectInboundConnectionResult	rejectInboundConnection(RejectInboundConnectionRequest rejectInboundConnectionRequest) Allows the remote domain owner to reject an inbound cross-cluster connection request.
RemoveTagsResult	removeTags(RemoveTagsRequest removeTagsRequest) 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 startServiceSoftwareUpdateRequest) Schedules a service software update for an Amazon OpenSearch Service domain.
UpdateDomainConfigResult	updateDomainConfig(UpdateDomainConfigRequest updateDomainConfigRequest) Modifies the cluster configuration of the specified domain, such as setting the instance type and the number of instances.
UpdatePackageResult	updatePackage(UpdatePackageRequest updatePackageRequest) Updates a package for use with Amazon OpenSearch Service domains.
UpgradeDomainResult	upgradeDomain(UpgradeDomainRequest upgradeDomainRequest) Allows you to either upgrade your domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

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

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

acceptInboundConnection

AcceptInboundConnectionResult acceptInboundConnection(AcceptInboundConnectionRequest acceptInboundConnectionRequest)

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

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

AddTagsResult addTags(AddTagsRequest addTagsRequest)

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.

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

AssociatePackageResult associatePackage(AssociatePackageRequest associatePackageRequest)

Associates a package with an Amazon OpenSearch Service domain.

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

CancelServiceSoftwareUpdateResult cancelServiceSoftwareUpdate(CancelServiceSoftwareUpdateRequest cancelServiceSoftwareUpdateRequest)

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.

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

CreateDomainResult createDomain(CreateDomainRequest createDomainRequest)

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.

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

CreateOutboundConnectionResult createOutboundConnection(CreateOutboundConnectionRequest createOutboundConnectionRequest)

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

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

CreatePackageResult createPackage(CreatePackageRequest createPackageRequest)

Create a package for use with Amazon OpenSearch Service domains.

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

DeleteDomainResult deleteDomain(DeleteDomainRequest deleteDomainRequest)

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

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

DeleteInboundConnectionResult deleteInboundConnection(DeleteInboundConnectionRequest deleteInboundConnectionRequest)

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

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

DeleteOutboundConnectionResult deleteOutboundConnection(DeleteOutboundConnectionRequest deleteOutboundConnectionRequest)

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

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

DeletePackageResult deletePackage(DeletePackageRequest deletePackageRequest)

Deletes the package.

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

DescribeDomainResult describeDomain(DescribeDomainRequest describeDomainRequest)

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

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

DescribeDomainAutoTunesResult describeDomainAutoTunes(DescribeDomainAutoTunesRequest describeDomainAutoTunesRequest)

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

Parameters:

describeDomainAutoTunesRequest - Container for the parameters to the DescribeDomainAutoTunes operation.

Returns:

Result of the DescribeDomainAutoTunes operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

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

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

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

describeDomainChangeProgress

DescribeDomainChangeProgressResult describeDomainChangeProgress(DescribeDomainChangeProgressRequest describeDomainChangeProgressRequest)

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

Parameters:

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

Returns:

Result of the DescribeDomainChangeProgress operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

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

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

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

describeDomainConfig

DescribeDomainConfigResult describeDomainConfig(DescribeDomainConfigRequest describeDomainConfigRequest)

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

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

DescribeDomainsResult describeDomains(DescribeDomainsRequest describeDomainsRequest)

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

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

DescribeInboundConnectionsResult describeInboundConnections(DescribeInboundConnectionsRequest describeInboundConnectionsRequest)

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

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

DescribeInstanceTypeLimitsResult describeInstanceTypeLimits(DescribeInstanceTypeLimitsRequest describeInstanceTypeLimitsRequest)

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.

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

DescribeOutboundConnectionsResult describeOutboundConnections(DescribeOutboundConnectionsRequest describeOutboundConnectionsRequest)

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

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

DescribePackagesResult describePackages(DescribePackagesRequest describePackagesRequest)

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

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

DescribeReservedInstanceOfferingsResult describeReservedInstanceOfferings(DescribeReservedInstanceOfferingsRequest describeReservedInstanceOfferingsRequest)

Lists available reserved OpenSearch instance offerings.

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

DescribeReservedInstancesResult describeReservedInstances(DescribeReservedInstancesRequest describeReservedInstancesRequest)

Returns information about reserved OpenSearch instances for this account.

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

DissociatePackageResult dissociatePackage(DissociatePackageRequest dissociatePackageRequest)

Dissociates a package from the Amazon OpenSearch Service domain.

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

GetCompatibleVersionsResult getCompatibleVersions(GetCompatibleVersionsRequest getCompatibleVersionsRequest)

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.

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

GetPackageVersionHistoryResult getPackageVersionHistory(GetPackageVersionHistoryRequest getPackageVersionHistoryRequest)

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

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

GetUpgradeHistoryResult getUpgradeHistory(GetUpgradeHistoryRequest getUpgradeHistoryRequest)

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

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

GetUpgradeStatusResult getUpgradeStatus(GetUpgradeStatusRequest getUpgradeStatusRequest)

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

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

ListDomainNamesResult listDomainNames(ListDomainNamesRequest listDomainNamesRequest)

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

Parameters:

listDomainNamesRequest - Container for the parameters to the ListDomainNames operation.

Returns:

Result of the ListDomainNames operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

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

listDomainsForPackage

ListDomainsForPackageResult listDomainsForPackage(ListDomainsForPackageRequest listDomainsForPackageRequest)

Lists all Amazon OpenSearch Service domains associated with the package.

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

ListInstanceTypeDetailsResult listInstanceTypeDetails(ListInstanceTypeDetailsRequest listInstanceTypeDetailsRequest)

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

ListPackagesForDomainResult listPackagesForDomain(ListPackagesForDomainRequest listPackagesForDomainRequest)

Lists all packages associated with the Amazon OpenSearch Service domain.

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

ListTagsResult listTags(ListTagsRequest listTagsRequest)

Returns all tags for the given domain.

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

ListVersionsResult listVersions(ListVersionsRequest listVersionsRequest)

List all supported versions of OpenSearch and Elasticsearch.

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

PurchaseReservedInstanceOfferingResult purchaseReservedInstanceOffering(PurchaseReservedInstanceOfferingRequest purchaseReservedInstanceOfferingRequest)

Allows you to purchase reserved OpenSearch instances.

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

RejectInboundConnectionResult rejectInboundConnection(RejectInboundConnectionRequest rejectInboundConnectionRequest)

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

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

RemoveTagsResult removeTags(RemoveTagsRequest removeTagsRequest)

Removes the specified set of tags from the given domain.

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

StartServiceSoftwareUpdateResult startServiceSoftwareUpdate(StartServiceSoftwareUpdateRequest startServiceSoftwareUpdateRequest)

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

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

UpdateDomainConfigResult updateDomainConfig(UpdateDomainConfigRequest updateDomainConfigRequest)

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

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

UpdatePackageResult updatePackage(UpdatePackageRequest updatePackageRequest)

Updates a package for use with Amazon OpenSearch Service domains.

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

UpgradeDomainResult upgradeDomain(UpgradeDomainRequest upgradeDomainRequest)

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

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.

shutdown

void shutdown()

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

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

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

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

Parameters:

request - The originally executed request.

Returns:

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