AWS.OpenSearch — AWS SDK for JavaScript (original) (raw)

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

acceptInboundConnection(params = {}, callback) ⇒ AWS.Request

addDataSource(params = {}, callback) ⇒ AWS.Request

addTags(params = {}, callback) ⇒ AWS.Request

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

associatePackage(params = {}, callback) ⇒ AWS.Request

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

cancelDomainConfigChange(params = {}, callback) ⇒ AWS.Request

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

cancelServiceSoftwareUpdate(params = {}, callback) ⇒ AWS.Request

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

createOutboundConnection(params = {}, callback) ⇒ AWS.Request

createPackage(params = {}, callback) ⇒ AWS.Request

createVpcEndpoint(params = {}, callback) ⇒ AWS.Request

Creates an Amazon OpenSearch Service-managed VPC endpoint.

deleteDataSource(params = {}, callback) ⇒ AWS.Request

deleteDomain(params = {}, callback) ⇒ AWS.Request

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

deleteInboundConnection(params = {}, callback) ⇒ AWS.Request

deleteOutboundConnection(params = {}, callback) ⇒ AWS.Request

deletePackage(params = {}, callback) ⇒ AWS.Request

deleteVpcEndpoint(params = {}, callback) ⇒ AWS.Request

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

describeDomain(params = {}, callback) ⇒ AWS.Request

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

describeDomainAutoTunes(params = {}, callback) ⇒ AWS.Request

describeDomainChangeProgress(params = {}, callback) ⇒ AWS.Request

describeDomainConfig(params = {}, callback) ⇒ AWS.Request

Returns the configuration of an Amazon OpenSearch Service domain.

describeDomainHealth(params = {}, callback) ⇒ AWS.Request

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

describeDomainNodes(params = {}, callback) ⇒ AWS.Request

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

describeDomains(params = {}, callback) ⇒ AWS.Request

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

describeDryRunProgress(params = {}, callback) ⇒ AWS.Request

describeInboundConnections(params = {}, callback) ⇒ AWS.Request

describeInstanceTypeLimits(params = {}, callback) ⇒ AWS.Request

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

describeOutboundConnections(params = {}, callback) ⇒ AWS.Request

describePackages(params = {}, callback) ⇒ AWS.Request

describeReservedInstanceOfferings(params = {}, callback) ⇒ AWS.Request

describeReservedInstances(params = {}, callback) ⇒ AWS.Request

describeVpcEndpoints(params = {}, callback) ⇒ AWS.Request

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

dissociatePackage(params = {}, callback) ⇒ AWS.Request

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

getCompatibleVersions(params = {}, callback) ⇒ AWS.Request

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

getDataSource(params = {}, callback) ⇒ AWS.Request

Retrieves information about a direct query data source.

getDomainMaintenanceStatus(params = {}, callback) ⇒ AWS.Request

The status of the maintenance action.

getPackageVersionHistory(params = {}, callback) ⇒ AWS.Request

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

getUpgradeHistory(params = {}, callback) ⇒ AWS.Request

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

getUpgradeStatus(params = {}, callback) ⇒ AWS.Request

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

listDataSources(params = {}, callback) ⇒ AWS.Request

listDomainMaintenances(params = {}, callback) ⇒ AWS.Request

A list of maintenance actions for the domain.

listDomainNames(params = {}, callback) ⇒ AWS.Request

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

listDomainsForPackage(params = {}, callback) ⇒ AWS.Request

listInstanceTypeDetails(params = {}, callback) ⇒ AWS.Request

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

listPackagesForDomain(params = {}, callback) ⇒ AWS.Request

listScheduledActions(params = {}, callback) ⇒ AWS.Request

listVersions(params = {}, callback) ⇒ AWS.Request

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

listVpcEndpointAccess(params = {}, callback) ⇒ AWS.Request

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

listVpcEndpoints(params = {}, callback) ⇒ AWS.Request

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

listVpcEndpointsForDomain(params = {}, callback) ⇒ AWS.Request

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

purchaseReservedInstanceOffering(params = {}, callback) ⇒ AWS.Request

Allows you to purchase Amazon OpenSearch Service Reserved Instances.

rejectInboundConnection(params = {}, callback) ⇒ AWS.Request

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

revokeVpcEndpointAccess(params = {}, callback) ⇒ AWS.Request

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

startDomainMaintenance(params = {}, callback) ⇒ AWS.Request

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

startServiceSoftwareUpdate(params = {}, callback) ⇒ AWS.Request

updateDataSource(params = {}, callback) ⇒ AWS.Request

updateDomainConfig(params = {}, callback) ⇒ AWS.Request

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

updatePackage(params = {}, callback) ⇒ AWS.Request

updateScheduledAction(params = {}, callback) ⇒ AWS.Request

updateVpcEndpoint(params = {}, callback) ⇒ AWS.Request

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

upgradeDomain(params = {}, callback) ⇒ AWS.Request

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