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.

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

Field Summary

Fields

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 destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request.
AddDataSourceResult	addDataSource(AddDataSourceRequest addDataSourceRequest) Creates a new direct-query data source to the specified domain.
AddTagsResult	addTags(AddTagsRequest addTagsRequest) Attaches tags to an existing Amazon OpenSearch Service domain.
AssociatePackageResult	associatePackage(AssociatePackageRequest associatePackageRequest) Associates a package with an Amazon OpenSearch Service domain.
AuthorizeVpcEndpointAccessResult	authorizeVpcEndpointAccess(AuthorizeVpcEndpointAccessRequest authorizeVpcEndpointAccessRequest) Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
CancelDomainConfigChangeResult	cancelDomainConfigChange(CancelDomainConfigChangeRequest cancelDomainConfigChangeRequest) Cancels a pending configuration change on an Amazon OpenSearch Service domain.
CancelServiceSoftwareUpdateResult	cancelServiceSoftwareUpdate(CancelServiceSoftwareUpdateRequest cancelServiceSoftwareUpdateRequest) Cancels a scheduled service software update for an Amazon OpenSearch Service domain.
CreateDomainResult	createDomain(CreateDomainRequest createDomainRequest) Creates an Amazon OpenSearch Service domain.
CreateOutboundConnectionResult	createOutboundConnection(CreateOutboundConnectionRequest createOutboundConnectionRequest) Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain.
CreatePackageResult	createPackage(CreatePackageRequest createPackageRequest) Creates a package for use with Amazon OpenSearch Service domains.
CreateVpcEndpointResult	createVpcEndpoint(CreateVpcEndpointRequest createVpcEndpointRequest) Creates an Amazon OpenSearch Service-managed VPC endpoint.
DeleteDataSourceResult	deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest) Deletes a direct-query data source.
DeleteDomainResult	deleteDomain(DeleteDomainRequest deleteDomainRequest) Deletes an Amazon OpenSearch Service domain and all of its data.
DeleteInboundConnectionResult	deleteInboundConnection(DeleteInboundConnectionRequest deleteInboundConnectionRequest) Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection.
DeleteOutboundConnectionResult	deleteOutboundConnection(DeleteOutboundConnectionRequest deleteOutboundConnectionRequest) Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection.
DeletePackageResult	deletePackage(DeletePackageRequest deletePackageRequest) Deletes an Amazon OpenSearch Service package.
DeleteVpcEndpointResult	deleteVpcEndpoint(DeleteVpcEndpointRequest deleteVpcEndpointRequest) Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
DescribeDomainResult	describeDomain(DescribeDomainRequest describeDomainRequest) Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.
DescribeDomainAutoTunesResult	describeDomainAutoTunes(DescribeDomainAutoTunesRequest describeDomainAutoTunesRequest) Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain.
DescribeDomainChangeProgressResult	describeDomainChangeProgress(DescribeDomainChangeProgressRequest describeDomainChangeProgressRequest) Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain.
DescribeDomainConfigResult	describeDomainConfig(DescribeDomainConfigRequest describeDomainConfigRequest) Returns the configuration of an Amazon OpenSearch Service domain.
DescribeDomainHealthResult	describeDomainHealth(DescribeDomainHealthRequest describeDomainHealthRequest) Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node.
DescribeDomainNodesResult	describeDomainNodes(DescribeDomainNodesRequest describeDomainNodesRequest) Returns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node states.
DescribeDomainsResult	describeDomains(DescribeDomainsRequest describeDomainsRequest) Returns domain configuration information about the specified Amazon OpenSearch Service domains.
DescribeDryRunProgressResult	describeDryRunProgress(DescribeDryRunProgressRequest describeDryRunProgressRequest) Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain.
DescribeInboundConnectionsResult	describeInboundConnections(DescribeInboundConnectionsRequest describeInboundConnectionsRequest) Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain.
DescribeInstanceTypeLimitsResult	describeInstanceTypeLimits(DescribeInstanceTypeLimitsRequest describeInstanceTypeLimitsRequest) Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.
DescribeOutboundConnectionsResult	describeOutboundConnections(DescribeOutboundConnectionsRequest describeOutboundConnectionsRequest) Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain.
DescribePackagesResult	describePackages(DescribePackagesRequest describePackagesRequest) Describes all packages available to OpenSearch Service.
DescribeReservedInstanceOfferingsResult	describeReservedInstanceOfferings(DescribeReservedInstanceOfferingsRequest describeReservedInstanceOfferingsRequest) Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region.
DescribeReservedInstancesResult	describeReservedInstances(DescribeReservedInstancesRequest describeReservedInstancesRequest) Describes the Amazon OpenSearch Service instances that you have reserved in a given Region.
DescribeVpcEndpointsResult	describeVpcEndpoints(DescribeVpcEndpointsRequest describeVpcEndpointsRequest) Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
DissociatePackageResult	dissociatePackage(DissociatePackageRequest dissociatePackageRequest) Removes a package from the specified Amazon OpenSearch Service domain.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetCompatibleVersionsResult	getCompatibleVersions(GetCompatibleVersionsRequest getCompatibleVersionsRequest) Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
GetDataSourceResult	getDataSource(GetDataSourceRequest getDataSourceRequest) Retrieves information about a direct query data source.
GetDomainMaintenanceStatusResult	getDomainMaintenanceStatus(GetDomainMaintenanceStatusRequest getDomainMaintenanceStatusRequest) The status of the maintenance action.
GetPackageVersionHistoryResult	getPackageVersionHistory(GetPackageVersionHistoryRequest getPackageVersionHistoryRequest) Returns a list of Amazon OpenSearch Service package versions, along with their creation time, commit message, and plugin properties (if the package is a zip plugin package).
GetUpgradeHistoryResult	getUpgradeHistory(GetUpgradeHistoryRequest getUpgradeHistoryRequest) Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.
GetUpgradeStatusResult	getUpgradeStatus(GetUpgradeStatusRequest getUpgradeStatusRequest) Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.
ListDataSourcesResult	listDataSources(ListDataSourcesRequest listDataSourcesRequest) Lists direct-query data sources for a specific domain.
ListDomainMaintenancesResult	listDomainMaintenances(ListDomainMaintenancesRequest listDomainMaintenancesRequest) A list of maintenance actions for the domain.
ListDomainNamesResult	listDomainNames(ListDomainNamesRequest listDomainNamesRequest) Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.
ListDomainsForPackageResult	listDomainsForPackage(ListDomainsForPackageRequest listDomainsForPackageRequest) Lists all Amazon OpenSearch Service domains associated with a given package.
ListInstanceTypeDetailsResult	listInstanceTypeDetails(ListInstanceTypeDetailsRequest listInstanceTypeDetailsRequest) Lists all instance types and available features for a given OpenSearch or Elasticsearch version.
ListPackagesForDomainResult	listPackagesForDomain(ListPackagesForDomainRequest listPackagesForDomainRequest) Lists all packages associated with an Amazon OpenSearch Service domain.
ListScheduledActionsResult	listScheduledActions(ListScheduledActionsRequest listScheduledActionsRequest) Retrieves a list of configuration changes that are scheduled for a domain.
ListTagsResult	listTags(ListTagsRequest listTagsRequest) Returns all resource tags for an Amazon OpenSearch Service domain.
ListVersionsResult	listVersions(ListVersionsRequest listVersionsRequest) Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.
ListVpcEndpointAccessResult	listVpcEndpointAccess(ListVpcEndpointAccessRequest listVpcEndpointAccessRequest) Retrieves information about each Amazon Web Services principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
ListVpcEndpointsResult	listVpcEndpoints(ListVpcEndpointsRequest listVpcEndpointsRequest) Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.
ListVpcEndpointsForDomainResult	listVpcEndpointsForDomain(ListVpcEndpointsForDomainRequest listVpcEndpointsForDomainRequest) Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.
PurchaseReservedInstanceOfferingResult	purchaseReservedInstanceOffering(PurchaseReservedInstanceOfferingRequest purchaseReservedInstanceOfferingRequest) Allows you to purchase Amazon OpenSearch Service Reserved Instances.
RejectInboundConnectionResult	rejectInboundConnection(RejectInboundConnectionRequest rejectInboundConnectionRequest) Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.
RemoveTagsResult	removeTags(RemoveTagsRequest removeTagsRequest) Removes the specified set of tags from an Amazon OpenSearch Service domain.
RevokeVpcEndpointAccessResult	revokeVpcEndpointAccess(RevokeVpcEndpointAccessRequest revokeVpcEndpointAccessRequest) Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartDomainMaintenanceResult	startDomainMaintenance(StartDomainMaintenanceRequest startDomainMaintenanceRequest) Starts the node maintenance process on the data node.
StartServiceSoftwareUpdateResult	startServiceSoftwareUpdate(StartServiceSoftwareUpdateRequest startServiceSoftwareUpdateRequest) Schedules a service software update for an Amazon OpenSearch Service domain.
UpdateDataSourceResult	updateDataSource(UpdateDataSourceRequest updateDataSourceRequest) Updates a direct-query data source.
UpdateDomainConfigResult	updateDomainConfig(UpdateDomainConfigRequest updateDomainConfigRequest) Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.
UpdatePackageResult	updatePackage(UpdatePackageRequest updatePackageRequest) Updates a package for use with Amazon OpenSearch Service domains.
UpdateScheduledActionResult	updateScheduledAction(UpdateScheduledActionRequest updateScheduledActionRequest) Reschedules a planned domain configuration change for a later time.
UpdateVpcEndpointResult	updateVpcEndpoint(UpdateVpcEndpointRequest updateVpcEndpointRequest) Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
UpgradeDomainResult	upgradeDomain(UpgradeDomainRequest upgradeDomainRequest) Allows you to either upgrade your Amazon OpenSearch Service 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 destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request. For more information, see Cross-cluster search for Amazon OpenSearch Service.

Parameters:

acceptInboundConnectionRequest - Container for the parameters to the AcceptInboundConnection operation.

Returns:

Result of the AcceptInboundConnection operation returned by the service.

Throws:

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.

DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

addDataSource

AddDataSourceResult addDataSource(AddDataSourceRequest addDataSourceRequest)

Creates a new direct-query data source to the specified domain. For more information, see Creating Amazon OpenSearch Service data source integrations with Amazon S3.

Parameters:

addDataSourceRequest - Container for the parameters to the AddDataSource operation.

Returns:

Result of the AddDataSource operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

DependencyFailureException - An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.

LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.

addTags

AddTagsResult addTags(AddTagsRequest addTagsRequest)

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

Parameters:

addTagsRequest - Container for the parameters to the AddTags operation. Specifies the tags to attach to the domain.

Returns:

Result of the AddTags operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

associatePackage

AssociatePackageResult associatePackage(AssociatePackageRequest associatePackageRequest)

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

Parameters:

associatePackageRequest - Container for the request parameters to the AssociatePackage operation.

Returns:

Result of the AssociatePackage operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

AccessDeniedException - An error occurred because you don't have permissions to access the resource.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

ConflictException - An error occurred because the client attempts to remove a resource that is currently in use.

authorizeVpcEndpointAccess

AuthorizeVpcEndpointAccessResult authorizeVpcEndpointAccess(AuthorizeVpcEndpointAccessRequest authorizeVpcEndpointAccessRequest)

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

Parameters:

authorizeVpcEndpointAccessRequest -

Returns:

Result of the AuthorizeVpcEndpointAccess operation returned by the service.

Throws:

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

BaseException - An error occurred while processing the request.

cancelDomainConfigChange

CancelDomainConfigChangeResult cancelDomainConfigChange(CancelDomainConfigChangeRequest cancelDomainConfigChangeRequest)

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

Parameters:

cancelDomainConfigChangeRequest -

Returns:

Result of the CancelDomainConfigChange operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

cancelServiceSoftwareUpdate

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 domain's UpdateStatus is PENDING_UPDATE. For more information, see Service software updates in Amazon OpenSearch Service.

Parameters:

cancelServiceSoftwareUpdateRequest - Container for the request parameters to cancel a service software update.

Returns:

Result of the CancelServiceSoftwareUpdate operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

createDomain

CreateDomainResult createDomain(CreateDomainRequest createDomainRequest)

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

Parameters:

createDomainRequest -

Returns:

Result of the CreateDomain operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

InvalidTypeException - An exception for trying to create or access a sub-resource that's either invalid or not supported.

LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.

ResourceAlreadyExistsException - An exception for creating a resource that already exists.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

createOutboundConnection

CreateOutboundConnectionResult createOutboundConnection(CreateOutboundConnectionRequest createOutboundConnectionRequest)

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

Parameters:

createOutboundConnectionRequest - Container for the parameters to the CreateOutboundConnection operation.

Returns:

Result of the CreateOutboundConnection operation returned by the service.

Throws:

LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

ResourceAlreadyExistsException - An exception for creating a resource that already exists.

DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

createPackage

CreatePackageResult createPackage(CreatePackageRequest createPackageRequest)

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

Parameters:

createPackageRequest - Container for request parameters to the CreatePackage operation.

Returns:

Result of the CreatePackage operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.

InvalidTypeException - An exception for trying to create or access a sub-resource that's either invalid or not supported.

ResourceAlreadyExistsException - An exception for creating a resource that already exists.

AccessDeniedException - An error occurred because you don't have permissions to access the resource.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

createVpcEndpoint

CreateVpcEndpointResult createVpcEndpoint(CreateVpcEndpointRequest createVpcEndpointRequest)

Creates an Amazon OpenSearch Service-managed VPC endpoint.

Parameters:

createVpcEndpointRequest -

Returns:

Result of the CreateVpcEndpoint operation returned by the service.

Throws:

ConflictException - An error occurred because the client attempts to remove a resource that is currently in use.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

BaseException - An error occurred while processing the request.

deleteDataSource

DeleteDataSourceResult deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest)

Deletes a direct-query data source. For more information, see Deleting an Amazon OpenSearch Service data source with Amazon S3.

Parameters:

deleteDataSourceRequest - Container for the parameters to the DeleteDataSource operation.

Returns:

Result of the DeleteDataSource operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

DependencyFailureException - An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.

deleteDomain

DeleteDomainResult deleteDomain(DeleteDomainRequest deleteDomainRequest)

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

Parameters:

deleteDomainRequest - Container for the parameters to the DeleteDomain operation.

Returns:

Result of the DeleteDomain operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

deleteInboundConnection

DeleteInboundConnectionResult deleteInboundConnection(DeleteInboundConnectionRequest deleteInboundConnectionRequest)

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

Parameters:

deleteInboundConnectionRequest - Container for the parameters to the DeleteInboundConnection operation.

Returns:

Result of the DeleteInboundConnection operation returned by the service.

Throws:

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

deleteOutboundConnection

DeleteOutboundConnectionResult deleteOutboundConnection(DeleteOutboundConnectionRequest deleteOutboundConnectionRequest)

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

Parameters:

deleteOutboundConnectionRequest - Container for the parameters to the DeleteOutboundConnection operation.

Returns:

Result of the DeleteOutboundConnection operation returned by the service.

Throws:

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

deletePackage

DeletePackageResult deletePackage(DeletePackageRequest deletePackageRequest)

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

Parameters:

deletePackageRequest - Deletes a package from OpenSearch Service. The package can't be associated with any OpenSearch Service domain.

Returns:

Result of the DeletePackage operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

AccessDeniedException - An error occurred because you don't have permissions to access the resource.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

ConflictException - An error occurred because the client attempts to remove a resource that is currently in use.

deleteVpcEndpoint

DeleteVpcEndpointResult deleteVpcEndpoint(DeleteVpcEndpointRequest deleteVpcEndpointRequest)

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

Parameters:

deleteVpcEndpointRequest -

Returns:

Result of the DeleteVpcEndpoint operation returned by the service.

Throws:

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

BaseException - An error occurred while processing the request.

describeDomain

DescribeDomainResult describeDomain(DescribeDomainRequest describeDomainRequest)

Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service 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 - Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

describeDomainAutoTunes

DescribeDomainAutoTunesResult describeDomainAutoTunes(DescribeDomainAutoTunesRequest describeDomainAutoTunesRequest)

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

Parameters:

describeDomainAutoTunesRequest - Container for the parameters to the DescribeDomainAutoTunes operation.

Returns:

Result of the DescribeDomainAutoTunes operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

describeDomainChangeProgress

DescribeDomainChangeProgressResult describeDomainChangeProgress(DescribeDomainChangeProgressRequest describeDomainChangeProgressRequest)

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

Parameters:

describeDomainChangeProgressRequest - Container for the parameters to the DescribeDomainChangeProgress operation.

Returns:

Result of the DescribeDomainChangeProgress operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

describeDomainConfig

DescribeDomainConfigResult describeDomainConfig(DescribeDomainConfigRequest describeDomainConfigRequest)

Returns the configuration of an Amazon OpenSearch Service domain.

Parameters:

describeDomainConfigRequest - Container for the parameters to the DescribeDomainConfig operation.

Returns:

Result of the DescribeDomainConfig operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

describeDomainHealth

DescribeDomainHealthResult describeDomainHealth(DescribeDomainHealthRequest describeDomainHealthRequest)

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

Parameters:

describeDomainHealthRequest - Container for the parameters to the DescribeDomainHealth operation.

Returns:

Result of the DescribeDomainHealth operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

describeDomainNodes

DescribeDomainNodesResult describeDomainNodes(DescribeDomainNodesRequest describeDomainNodesRequest)

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

Parameters:

describeDomainNodesRequest - Container for the parameters to the DescribeDomainNodes operation.

Returns:

Result of the DescribeDomainNodes operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

DependencyFailureException - An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.

describeDomains

DescribeDomainsResult describeDomains(DescribeDomainsRequest describeDomainsRequest)

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

Parameters:

describeDomainsRequest - Container for the parameters to the DescribeDomains operation.

Returns:

Result of the DescribeDomains operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

describeDryRunProgress

DescribeDryRunProgressResult describeDryRunProgress(DescribeDryRunProgressRequest describeDryRunProgressRequest)

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

Parameters:

describeDryRunProgressRequest -

Returns:

Result of the DescribeDryRunProgress operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

describeInboundConnections

DescribeInboundConnectionsResult describeInboundConnections(DescribeInboundConnectionsRequest describeInboundConnectionsRequest)

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

Parameters:

describeInboundConnectionsRequest - Container for the parameters to the DescribeInboundConnections operation.

Returns:

Result of the DescribeInboundConnections operation returned by the service.

Throws:

InvalidPaginationTokenException - Request processing failed because you provided an invalid pagination token.

DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

describeInstanceTypeLimits

DescribeInstanceTypeLimitsResult describeInstanceTypeLimits(DescribeInstanceTypeLimitsRequest describeInstanceTypeLimitsRequest)

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

Parameters:

describeInstanceTypeLimitsRequest - Container for the parameters to the DescribeInstanceTypeLimits operation.

Returns:

Result of the DescribeInstanceTypeLimits operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

InvalidTypeException - An exception for trying to create or access a sub-resource that's either invalid or not supported.

LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

describeOutboundConnections

DescribeOutboundConnectionsResult describeOutboundConnections(DescribeOutboundConnectionsRequest describeOutboundConnectionsRequest)

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

Parameters:

describeOutboundConnectionsRequest - Container for the parameters to the DescribeOutboundConnections operation.

Returns:

Result of the DescribeOutboundConnections operation returned by the service.

Throws:

InvalidPaginationTokenException - Request processing failed because you provided an invalid pagination token.

DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

describePackages

DescribePackagesResult describePackages(DescribePackagesRequest describePackagesRequest)

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

Parameters:

describePackagesRequest - Container for the request parameters to the DescribePackage operation.

Returns:

Result of the DescribePackages operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

AccessDeniedException - An error occurred because you don't have permissions to access the resource.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

describeReservedInstanceOfferings

DescribeReservedInstanceOfferingsResult describeReservedInstanceOfferings(DescribeReservedInstanceOfferingsRequest describeReservedInstanceOfferingsRequest)

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

Parameters:

describeReservedInstanceOfferingsRequest - Container for the request parameters to a DescribeReservedInstanceOfferings operation.

Returns:

Result of the DescribeReservedInstanceOfferings operation returned by the service.

Throws:

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

describeReservedInstances

DescribeReservedInstancesResult describeReservedInstances(DescribeReservedInstancesRequest describeReservedInstancesRequest)

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

Parameters:

describeReservedInstancesRequest - Container for the request parameters to the DescribeReservedInstances operation.

Returns:

Result of the DescribeReservedInstances operation returned by the service.

Throws:

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

describeVpcEndpoints

DescribeVpcEndpointsResult describeVpcEndpoints(DescribeVpcEndpointsRequest describeVpcEndpointsRequest)

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

Parameters:

describeVpcEndpointsRequest -

Returns:

Result of the DescribeVpcEndpoints operation returned by the service.

Throws:

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

BaseException - An error occurred while processing the request.

dissociatePackage

DissociatePackageResult dissociatePackage(DissociatePackageRequest dissociatePackageRequest)

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

Parameters:

dissociatePackageRequest - Container for the request parameters to the DissociatePackage operation.

Returns:

Result of the DissociatePackage operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

AccessDeniedException - An error occurred because you don't have permissions to access the resource.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

ConflictException - An error occurred because the client attempts to remove a resource that is currently in use.

getCompatibleVersions

GetCompatibleVersionsResult getCompatibleVersions(GetCompatibleVersionsRequest getCompatibleVersionsRequest)

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

Parameters:

getCompatibleVersionsRequest - Container for the request parameters to GetCompatibleVersions operation.

Returns:

Result of the GetCompatibleVersions operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

getDataSource

GetDataSourceResult getDataSource(GetDataSourceRequest getDataSourceRequest)

Retrieves information about a direct query data source.

Parameters:

getDataSourceRequest - Container for the parameters to the GetDataSource operation.

Returns:

Result of the GetDataSource operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

DependencyFailureException - An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.

getDomainMaintenanceStatus

GetDomainMaintenanceStatusResult getDomainMaintenanceStatus(GetDomainMaintenanceStatusRequest getDomainMaintenanceStatusRequest)

The status of the maintenance action.

Parameters:

getDomainMaintenanceStatusRequest - Container for the parameters to the GetDomainMaintenanceStatus operation.

Returns:

Result of the GetDomainMaintenanceStatus operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

getPackageVersionHistory

GetPackageVersionHistoryResult getPackageVersionHistory(GetPackageVersionHistoryRequest getPackageVersionHistoryRequest)

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

Parameters:

getPackageVersionHistoryRequest - Container for the request parameters to the GetPackageVersionHistory operation.

Returns:

Result of the GetPackageVersionHistory operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

AccessDeniedException - An error occurred because you don't have permissions to access the resource.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

getUpgradeHistory

GetUpgradeHistoryResult getUpgradeHistory(GetUpgradeHistoryRequest getUpgradeHistoryRequest)

Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service 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 doesn't exist.

DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

getUpgradeStatus

GetUpgradeStatusResult getUpgradeStatus(GetUpgradeStatusRequest getUpgradeStatusRequest)

Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service 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 doesn't exist.

DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

listDataSources

ListDataSourcesResult listDataSources(ListDataSourcesRequest listDataSourcesRequest)

Lists direct-query data sources for a specific domain. For more information, see For more information, see Working with Amazon OpenSearch Service direct queries with Amazon S3.

Parameters:

listDataSourcesRequest - Container for the parameters to the ListDataSources operation.

Returns:

Result of the ListDataSources operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

DependencyFailureException - An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.

listDomainMaintenances

ListDomainMaintenancesResult listDomainMaintenances(ListDomainMaintenancesRequest listDomainMaintenancesRequest)

A list of maintenance actions for the domain.

Parameters:

listDomainMaintenancesRequest - Container for the parameters to the ListDomainMaintenances operation.

Returns:

Result of the ListDomainMaintenances operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

listDomainNames

ListDomainNamesResult listDomainNames(ListDomainNamesRequest listDomainNamesRequest)

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

Parameters:

listDomainNamesRequest - Container for the parameters to the ListDomainNames operation.

Returns:

Result of the ListDomainNames operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

listDomainsForPackage

ListDomainsForPackageResult listDomainsForPackage(ListDomainsForPackageRequest listDomainsForPackageRequest)

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

Parameters:

listDomainsForPackageRequest - Container for the request parameters to the ListDomainsForPackage operation.

Returns:

Result of the ListDomainsForPackage operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

AccessDeniedException - An error occurred because you don't have permissions to access the resource.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

listInstanceTypeDetails

ListInstanceTypeDetailsResult listInstanceTypeDetails(ListInstanceTypeDetailsRequest listInstanceTypeDetailsRequest)

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

Parameters:

listInstanceTypeDetailsRequest -

Returns:

Result of the ListInstanceTypeDetails operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

listPackagesForDomain

ListPackagesForDomainResult listPackagesForDomain(ListPackagesForDomainRequest listPackagesForDomainRequest)

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

Parameters:

listPackagesForDomainRequest - Container for the request parameters to the ListPackagesForDomain operation.

Returns:

Result of the ListPackagesForDomain operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

AccessDeniedException - An error occurred because you don't have permissions to access the resource.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

listScheduledActions

ListScheduledActionsResult listScheduledActions(ListScheduledActionsRequest listScheduledActionsRequest)

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

Parameters:

listScheduledActionsRequest -

Returns:

Result of the ListScheduledActions operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

InvalidPaginationTokenException - Request processing failed because you provided an invalid pagination token.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

listTags

ListTagsResult listTags(ListTagsRequest listTagsRequest)

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

Parameters:

listTagsRequest - Container for the parameters to the ListTags operation.

Returns:

Result of the ListTags operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

listVersions

ListVersionsResult listVersions(ListVersionsRequest listVersionsRequest)

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

Parameters:

listVersionsRequest - Container for the request parameters to the ListVersions operation.

Returns:

Result of the ListVersions operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

listVpcEndpointAccess

ListVpcEndpointAccessResult listVpcEndpointAccess(ListVpcEndpointAccessRequest listVpcEndpointAccessRequest)

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

Parameters:

listVpcEndpointAccessRequest -

Returns:

Result of the ListVpcEndpointAccess operation returned by the service.

Throws:

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

BaseException - An error occurred while processing the request.

listVpcEndpoints

ListVpcEndpointsResult listVpcEndpoints(ListVpcEndpointsRequest listVpcEndpointsRequest)

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

Parameters:

listVpcEndpointsRequest -

Returns:

Result of the ListVpcEndpoints operation returned by the service.

Throws:

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

BaseException - An error occurred while processing the request.

listVpcEndpointsForDomain

ListVpcEndpointsForDomainResult listVpcEndpointsForDomain(ListVpcEndpointsForDomainRequest listVpcEndpointsForDomainRequest)

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

Parameters:

listVpcEndpointsForDomainRequest -

Returns:

Result of the ListVpcEndpointsForDomain operation returned by the service.

Throws:

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

BaseException - An error occurred while processing the request.

purchaseReservedInstanceOffering

PurchaseReservedInstanceOfferingResult purchaseReservedInstanceOffering(PurchaseReservedInstanceOfferingRequest purchaseReservedInstanceOfferingRequest)

Allows you to purchase Amazon OpenSearch Service Reserved Instances.

Parameters:

purchaseReservedInstanceOfferingRequest - Container for request parameters to the PurchaseReservedInstanceOffering operation.

Returns:

Result of the PurchaseReservedInstanceOffering operation returned by the service.

Throws:

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

ResourceAlreadyExistsException - An exception for creating a resource that already exists.

LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.

DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

rejectInboundConnection

RejectInboundConnectionResult rejectInboundConnection(RejectInboundConnectionRequest rejectInboundConnectionRequest)

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

Parameters:

rejectInboundConnectionRequest - Container for the request parameters to the RejectInboundConnection operation.

Returns:

Result of the RejectInboundConnection operation returned by the service.

Throws:

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

removeTags

RemoveTagsResult removeTags(RemoveTagsRequest removeTagsRequest)

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

Parameters:

removeTagsRequest - Container for the request parameters to the RemoveTags operation.

Returns:

Result of the RemoveTags operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

revokeVpcEndpointAccess

RevokeVpcEndpointAccessResult revokeVpcEndpointAccess(RevokeVpcEndpointAccessRequest revokeVpcEndpointAccessRequest)

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

Parameters:

revokeVpcEndpointAccessRequest -

Returns:

Result of the RevokeVpcEndpointAccess operation returned by the service.

Throws:

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

BaseException - An error occurred while processing the request.

startDomainMaintenance

StartDomainMaintenanceResult startDomainMaintenance(StartDomainMaintenanceRequest startDomainMaintenanceRequest)

Starts the node maintenance process on the data node. These processes can include a node reboot, an Opensearch or Elasticsearch process restart, or a Dashboard or Kibana restart.

Parameters:

startDomainMaintenanceRequest - Container for the parameters to the StartDomainMaintenance operation.

Returns:

Result of the StartDomainMaintenance operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

startServiceSoftwareUpdate

StartServiceSoftwareUpdateResult startServiceSoftwareUpdate(StartServiceSoftwareUpdateRequest startServiceSoftwareUpdateRequest)

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

Parameters:

startServiceSoftwareUpdateRequest - Container for the request parameters to the StartServiceSoftwareUpdate operation.

Returns:

Result of the StartServiceSoftwareUpdate operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

updateDataSource

UpdateDataSourceResult updateDataSource(UpdateDataSourceRequest updateDataSourceRequest)

Updates a direct-query data source. For more information, see Working with Amazon OpenSearch Service data source integrations with Amazon S3.

Parameters:

updateDataSourceRequest - Container for the parameters to the UpdateDataSource operation.

Returns:

Result of the UpdateDataSource operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

DependencyFailureException - An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.

updateDomainConfig

UpdateDomainConfigResult updateDomainConfig(UpdateDomainConfigRequest updateDomainConfigRequest)

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

Parameters:

updateDomainConfigRequest - Container for the request parameters to the UpdateDomain operation.

Returns:

Result of the UpdateDomainConfig operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

InvalidTypeException - An exception for trying to create or access a sub-resource that's either invalid or not supported.

LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

updatePackage

UpdatePackageResult updatePackage(UpdatePackageRequest updatePackageRequest)

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

Parameters:

updatePackageRequest - Container for request parameters to the UpdatePackage operation.

Returns:

Result of the UpdatePackage operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

AccessDeniedException - An error occurred because you don't have permissions to access the resource.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

updateScheduledAction

UpdateScheduledActionResult updateScheduledAction(UpdateScheduledActionRequest updateScheduledActionRequest)

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

Parameters:

updateScheduledActionRequest -

Returns:

Result of the UpdateScheduledAction operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

SlotNotAvailableException - An exception for attempting to schedule a domain action during an unavailable time slot.

ConflictException - An error occurred because the client attempts to remove a resource that is currently in use.

LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

updateVpcEndpoint

UpdateVpcEndpointResult updateVpcEndpoint(UpdateVpcEndpointRequest updateVpcEndpointRequest)

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

Parameters:

updateVpcEndpointRequest -

Returns:

Result of the UpdateVpcEndpoint operation returned by the service.

Throws:

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

ConflictException - An error occurred because the client attempts to remove a resource that is currently in use.

BaseException - An error occurred while processing the request.

upgradeDomain

UpgradeDomainResult upgradeDomain(UpgradeDomainRequest upgradeDomainRequest)

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

Parameters:

upgradeDomainRequest - Container for the request parameters to the UpgradeDomain operation.

Returns:

Result of the UpgradeDomain operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.

ResourceAlreadyExistsException - An exception for creating a resource that already exists.

DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

ValidationException - An exception for accessing or deleting a resource that doesn't exist.

InternalException - Request processing failed because of an unknown error, exception, or internal failure.

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.