AWS.CloudSearch (2011-02-01) — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

You use the configuration service to create, configure, and manage search domains. Configuration service requests are submitted using the AWS Query protocol. AWS Query requests are HTTP or HTTPS requests submitted via HTTP GET or POST with a query parameter named Action.

The endpoint for configuration service requests is region-specific: cloudsearch.region.amazonaws.com. For example, cloudsearch.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and Endpoints.

Sending a Request Using CloudSearch

var cloudsearch = new AWS.CloudSearch();
cloudsearch.createDomain(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the CloudSearch object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var cloudsearch = new AWS.CloudSearch({apiVersion: '2011-02-01'});

You can also set the API version globally in AWS.config.apiVersions using the cloudsearch service identifier:

AWS.config.apiVersions = {
  cloudsearch: '2011-02-01',
  // other service API versions
};

var cloudsearch = new AWS.CloudSearch();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.CloudSearch(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

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

Method Details

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

Creates a new search domain.

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

Configures an IndexField for the search domain. Used to create new fields and modify existing ones. If the field exists, the new configuration replaces the old one. You can configure a maximum of 200 index fields.

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

Configures a RankExpression for the search domain. Used to create new rank expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. You can configure a maximum of 50 rank expressions.

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

Permanently deletes a search domain and all of its data.

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

Removes an IndexField from the search domain.

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

Removes a RankExpression from the search domain.

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

Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.

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

Gets the default search field configured for the search domain.

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

Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default.

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

Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. Shows all fields by default.

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

Gets the rank expressions configured for the search domain. Can be limited to specific rank expressions by name. Shows all rank expressions by default.

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

Gets information about the resource-based policies that control access to the domain's document and search services.

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

Gets the stemming dictionary configured for the search domain.

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

Gets the stopwords configured for the search domain.

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

Gets the synonym dictionary configured for the search domain.

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

Tells the search domain to start indexing its documents using the latest text processing options and IndexFields. This operation must be invoked to make options whose OptionStatus has OptionState of RequiresIndexDocuments visible in search results.

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

Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.

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

Configures the default search field for the search domain. The default search field is the text field that is searched when a search request does not specify which fields to search. By default, it is configured to include the contents of all of the domain's text fields.

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

Configures the policies that control access to the domain's document and search services. The maximum size of an access policy document is 100 KB.

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

Configures a stemming dictionary for the search domain. The stemming dictionary is used during indexing and when processing search requests. The maximum size of the stemming dictionary is 500 KB.

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

Configures stopwords for the search domain. Stopwords are used during indexing and when processing search requests. The maximum size of the stopwords dictionary is 10 KB.

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

Configures a synonym dictionary for the search domain. The synonym dictionary is used during indexing to configure mappings for terms that occur in text fields. The maximum size of the synonym dictionary is 100 KB.