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

Property Details

endpoint ⇒ AWS.Endpoint

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

Method Details

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

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

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

Associates a package with an Amazon ES domain.

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.

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

Cancels a scheduled service software update for an Amazon ES domain. You can only perform this operation before the AutomatedUpdateDate and when the UpdateStatus is in the PENDING_UPDATE state.

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

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

Creates a new cross-cluster search connection from a source domain to a destination domain.

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

Create a package for use with Amazon ES domains.

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

Creates an Amazon OpenSearch Service-managed VPC endpoint.

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

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

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

Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains. Role deletion will fail if any existing VPC domains use the role. You must delete any such Elasticsearch domains before deleting the role. See Deleting Elasticsearch Service Role in VPC Endpoints for Amazon Elasticsearch Service Domains.

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

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

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

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

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

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

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

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

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

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

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

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

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

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

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

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

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

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

Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the DomainName to know what Limits are supported for modifying.

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

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

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

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

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

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

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

Lists available reserved Elasticsearch instance offerings.

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

Returns information about reserved Elasticsearch instances for this account.

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

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

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

Dissociates a package from the Amazon ES domain.

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

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

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

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

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

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

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

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

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

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

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

Lists all Amazon ES domains associated with the package.

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

List all Elasticsearch instance types that are supported for given ElasticsearchVersion

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

List all supported Elasticsearch versions

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

Lists all packages associated with the Amazon ES domain.

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

Returns all tags for the given Elasticsearch domain.

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

Retrieves information about each 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 account and Region.

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

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

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

Allows you to purchase reserved Elasticsearch instances.

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

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

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

Removes the specified set of tags from the specified Elasticsearch domain.

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

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

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

Schedules a service software update for an Amazon ES domain.

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

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

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

Updates a package for use with Amazon ES domains.

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

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

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

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