Class: AWS.CloudSearch (2011-02-01)

Inherits:
AWS.Service show all
Identifier:
cloudsearch
API Version:
2011-02-01
Defined in:
(unknown)

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();

Version:

  • 2011-02-01

Constructor Summary

Property Summary

Properties inherited from AWS.Service

apiVersions

Method Summary

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.

Examples:

Constructing a CloudSearch object

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

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.CloudSearch_20110201.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.CloudSearch_20110201.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.CloudSearch_20110201.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean) —

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Creates a new search domain.

Examples:

Calling the createDomain operation

var params = {
  DomainName: 'STRING_VALUE' /* required */
};
cloudsearch.createDomain(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DomainName — (String)

      A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DomainStatus — (map)

        The current status of the search domain.

        • DomainId — required — (String)

          An internally generated unique identifier for a domain.

        • DomainName — required — (String)

          A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

        • Created — (Boolean)

          True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete.

        • Deleted — (Boolean)

          True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true value for IsDeleted for several minutes until resource cleanup is complete.

        • NumSearchableDocs — (Integer)

          The number of documents that have been submitted to the domain and indexed.

        • DocService — (map)

          The service endpoint for updating documents in a search domain.

          • Arn — (String)

            An Amazon Resource Name (ARN). See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

          • Endpoint — (String)

            The URL (including /version/pathPrefix) to which service requests can be submitted.

        • SearchService — (map)

          The service endpoint for requesting search results from a search domain.

          • Arn — (String)

            An Amazon Resource Name (ARN). See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

          • Endpoint — (String)

            The URL (including /version/pathPrefix) to which service requests can be submitted.

        • RequiresIndexDocuments — required — (Boolean)

          True if IndexDocuments needs to be called to activate the current domain configuration.

        • Processing — (Boolean)

          True if processing is being done to activate the current domain configuration.

        • SearchInstanceType — (String)

          The instance type (such as search.m1.small) that is being used to process search requests.

        • SearchPartitionCount — (Integer)

          The number of partitions across which the search index is spread.

        • SearchInstanceCount — (Integer)

          The number of search instances that are available to process search requests.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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.

Examples:

Calling the defineIndexField operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  IndexField: { /* required */
    IndexFieldName: 'STRING_VALUE', /* required */
    IndexFieldType: uint | literal | text, /* required */
    LiteralOptions: {
      DefaultValue: 'STRING_VALUE',
      FacetEnabled: true || false,
      ResultEnabled: true || false,
      SearchEnabled: true || false
    },
    SourceAttributes: [
      {
        SourceDataFunction: Copy | TrimTitle | Map, /* required */
        SourceDataCopy: {
          SourceName: 'STRING_VALUE', /* required */
          DefaultValue: 'STRING_VALUE'
        },
        SourceDataMap: {
          SourceName: 'STRING_VALUE', /* required */
          Cases: {
            '<FieldValue>': 'STRING_VALUE',
            /* '<FieldValue>': ... */
          },
          DefaultValue: 'STRING_VALUE'
        },
        SourceDataTrimTitle: {
          SourceName: 'STRING_VALUE', /* required */
          DefaultValue: 'STRING_VALUE',
          Language: 'STRING_VALUE',
          Separator: 'STRING_VALUE'
        }
      },
      /* more items */
    ],
    TextOptions: {
      DefaultValue: 'STRING_VALUE',
      FacetEnabled: true || false,
      ResultEnabled: true || false,
      TextProcessor: 'STRING_VALUE'
    },
    UIntOptions: {
      DefaultValue: 'NUMBER_VALUE'
    }
  }
};
cloudsearch.defineIndexField(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DomainName — (String)

      A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

    • IndexField — (map)

      Defines a field in the index, including its name, type, and the source of its data. The IndexFieldType indicates which of the options will be present. It is invalid to specify options for a type other than the IndexFieldType.

      • IndexFieldName — required — (String)

        The name of a field in the search index. Field names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names "body", "docid", and "text_relevance" are reserved and cannot be specified as field or rank expression names.

      • IndexFieldType — required — (String)

        The type of field. Based on this type, exactly one of the UIntOptions, LiteralOptions or TextOptions must be present.

        Possible values include:
        • "uint"
        • "literal"
        • "text"
      • UIntOptions — (map)

        Options for an unsigned integer field. Present if IndexFieldType specifies the field is of type unsigned integer.

        • DefaultValue — (Integer)

          The default value for an unsigned integer field. Optional.

      • LiteralOptions — (map)

        Options for literal field. Present if IndexFieldType specifies the field is of type literal.

        • DefaultValue — (String)

          The default value for a literal field. Optional.

        • SearchEnabled — (Boolean)

          Specifies whether search is enabled for this field. Default: False.

        • FacetEnabled — (Boolean)

          Specifies whether facets are enabled for this field. Default: False.

        • ResultEnabled — (Boolean)

          Specifies whether values of this field can be returned in search results and used for ranking. Default: False.

      • TextOptions — (map)

        Options for text field. Present if IndexFieldType specifies the field is of type text.

        • DefaultValue — (String)

          The default value for a text field. Optional.

        • FacetEnabled — (Boolean)

          Specifies whether facets are enabled for this field. Default: False.

        • ResultEnabled — (Boolean)

          Specifies whether values of this field can be returned in search results and used for ranking. Default: False.

        • TextProcessor — (String)

          The text processor to apply to this field. Optional. Possible values:

          • cs_text_no_stemming: turns off stemming for the field.

          Default: none

      • SourceAttributes — (Array<map>)

        An optional list of source attributes that provide data for this index field. If not specified, the data is pulled from a source attribute with the same name as this IndexField. When one or more source attributes are specified, an optional data transformation can be applied to the source data when populating the index field. You can configure a maximum of 20 sources for an IndexField.

        • SourceDataFunction — required — (String)

          Identifies the transformation to apply when copying data from a source attribute.

          Possible values include:
          • "Copy"
          • "TrimTitle"
          • "Map"
        • SourceDataCopy — (map)

          Copies data from a source document attribute to an IndexField.

          • SourceName — required — (String)

            The name of the document source field to add to this IndexField.

          • DefaultValue — (String)

            The default value to use if the source attribute is not specified in a document. Optional.

        • SourceDataTrimTitle — (map)

          Trims common title words from a source document attribute when populating an IndexField. This can be used to create an IndexField you can use for sorting.

          • SourceName — required — (String)

            The name of the document source field to add to this IndexField.

          • DefaultValue — (String)

            The default value to use if the source attribute is not specified in a document. Optional.

          • Separator — (String)

            The separator that follows the text to trim.

          • Language — (String)

            An IETF RFC 4646 language code. Only the primary language is considered. English (en) is currently the only supported language.

        • SourceDataMap — (map)

          Maps source document attribute values to new values when populating the IndexField.

          • SourceName — required — (String)

            The name of the document source field to add to this IndexField.

          • DefaultValue — (String)

            The default value to use if the source attribute is not specified in a document. Optional.

          • Cases — (map<String>)

            A map that translates source field values to custom values.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • IndexField — (map)

        The value of an IndexField and its current status.

        • Options — required — (map)

          Defines a field in the index, including its name, type, and the source of its data. The IndexFieldType indicates which of the options will be present. It is invalid to specify options for a type other than the IndexFieldType.

          • IndexFieldName — required — (String)

            The name of a field in the search index. Field names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names "body", "docid", and "text_relevance" are reserved and cannot be specified as field or rank expression names.

          • IndexFieldType — required — (String)

            The type of field. Based on this type, exactly one of the UIntOptions, LiteralOptions or TextOptions must be present.

            Possible values include:
            • "uint"
            • "literal"
            • "text"
          • UIntOptions — (map)

            Options for an unsigned integer field. Present if IndexFieldType specifies the field is of type unsigned integer.

            • DefaultValue — (Integer)

              The default value for an unsigned integer field. Optional.

          • LiteralOptions — (map)

            Options for literal field. Present if IndexFieldType specifies the field is of type literal.

            • DefaultValue — (String)

              The default value for a literal field. Optional.

            • SearchEnabled — (Boolean)

              Specifies whether search is enabled for this field. Default: False.

            • FacetEnabled — (Boolean)

              Specifies whether facets are enabled for this field. Default: False.

            • ResultEnabled — (Boolean)

              Specifies whether values of this field can be returned in search results and used for ranking. Default: False.

          • TextOptions — (map)

            Options for text field. Present if IndexFieldType specifies the field is of type text.

            • DefaultValue — (String)

              The default value for a text field. Optional.

            • FacetEnabled — (Boolean)

              Specifies whether facets are enabled for this field. Default: False.

            • ResultEnabled — (Boolean)

              Specifies whether values of this field can be returned in search results and used for ranking. Default: False.

            • TextProcessor — (String)

              The text processor to apply to this field. Optional. Possible values:

              • cs_text_no_stemming: turns off stemming for the field.

              Default: none

          • SourceAttributes — (Array<map>)

            An optional list of source attributes that provide data for this index field. If not specified, the data is pulled from a source attribute with the same name as this IndexField. When one or more source attributes are specified, an optional data transformation can be applied to the source data when populating the index field. You can configure a maximum of 20 sources for an IndexField.

            • SourceDataFunction — required — (String)

              Identifies the transformation to apply when copying data from a source attribute.

              Possible values include:
              • "Copy"
              • "TrimTitle"
              • "Map"
            • SourceDataCopy — (map)

              Copies data from a source document attribute to an IndexField.

              • SourceName — required — (String)

                The name of the document source field to add to this IndexField.

              • DefaultValue — (String)

                The default value to use if the source attribute is not specified in a document. Optional.

            • SourceDataTrimTitle — (map)

              Trims common title words from a source document attribute when populating an IndexField. This can be used to create an IndexField you can use for sorting.

              • SourceName — required — (String)

                The name of the document source field to add to this IndexField.

              • DefaultValue — (String)

                The default value to use if the source attribute is not specified in a document. Optional.

              • Separator — (String)

                The separator that follows the text to trim.

              • Language — (String)

                An IETF RFC 4646 language code. Only the primary language is considered. English (en) is currently the only supported language.

            • SourceDataMap — (map)

              Maps source document attribute values to new values when populating the IndexField.

              • SourceName — required — (String)

                The name of the document source field to add to this IndexField.

              • DefaultValue — (String)

                The default value to use if the source attribute is not specified in a document. Optional.

              • Cases — (map<String>)

                A map that translates source field values to custom values.

        • Status — required — (map)

          The status of an option, including when it was last updated and whether it is actively in use for searches.

          • CreationDate — required — (Date)

            A timestamp for when this option was created.

          • UpdateDate — required — (Date)

            A timestamp for when this option was last updated.

          • UpdateVersion — (Integer)

            A unique integer that indicates when this option was last updated.

          • State — required — (String)

            The state of processing a change to an option. Possible values:

            • RequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.
            • Processing: the option's latest value is not yet visible in all searches but is in the process of being activated.
            • Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.
            Possible values include:
            • "RequiresIndexDocuments"
            • "Processing"
            • "Active"
          • PendingDeletion — (Boolean)

            Indicates that the option will be deleted once processing is complete.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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.

Examples:

Calling the defineRankExpression operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  RankExpression: { /* required */
    RankExpression: 'STRING_VALUE', /* required */
    RankName: 'STRING_VALUE' /* required */
  }
};
cloudsearch.defineRankExpression(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DomainName — (String)

      A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

    • RankExpression — (map)

      A named expression that can be evaluated at search time and used for ranking or thresholding in a search query.

      • RankName — required — (String)

        The name of a rank expression. Rank expression names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names "body", "docid", and "text_relevance" are reserved and cannot be specified as field or rank expression names.

      • RankExpression — required — (String)

        The expression to evaluate for ranking or thresholding while processing a search request. The RankExpression syntax is based on JavaScript expressions and supports:

        • Integer, floating point, hex and octal literals
        • Shortcut evaluation of logical operators such that an expression a || b evaluates to the value a, if a is true, without evaluating b at all
        • JavaScript order of precedence for operators
        • Arithmetic operators: + - * / %
        • Boolean operators (including the ternary operator)
        • Bitwise operators
        • Comparison operators
        • Common mathematic functions: abs ceil erf exp floor lgamma ln log2 log10 max min sqrt pow
        • Trigonometric library functions: acosh acos asinh asin atanh atan cosh cos sinh sin tanh tan
        • Random generation of a number between 0 and 1: rand
        • Current time in epoch: time
        • The min max functions that operate on a variable argument list

        Intermediate results are calculated as double precision floating point values. The final return value of a RankExpression is automatically converted from floating point to a 32-bit unsigned integer by rounding to the nearest integer, with a natural floor of 0 and a ceiling of max(uint32_t), 4294967295. Mathematical errors such as dividing by 0 will fail during evaluation and return a value of 0.

        The source data for a RankExpression can be the name of an IndexField of type uint, another RankExpression or the reserved name text_relevance. The text_relevance source is defined to return an integer from 0 to 1000 (inclusive) to indicate how relevant a document is to the search request, taking into account repetition of search terms in the document and proximity of search terms to each other in each matching IndexField in the document.

        For more information about using rank expressions to customize ranking, see the Amazon CloudSearch Developer Guide.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RankExpression — (map)

        The value of a RankExpression and its current status.

        • Options — required — (map)

          The expression that is evaluated for ranking or thresholding while processing a search request.

          • RankName — required — (String)

            The name of a rank expression. Rank expression names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names "body", "docid", and "text_relevance" are reserved and cannot be specified as field or rank expression names.

          • RankExpression — required — (String)

            The expression to evaluate for ranking or thresholding while processing a search request. The RankExpression syntax is based on JavaScript expressions and supports:

            • Integer, floating point, hex and octal literals
            • Shortcut evaluation of logical operators such that an expression a || b evaluates to the value a, if a is true, without evaluating b at all
            • JavaScript order of precedence for operators
            • Arithmetic operators: + - * / %
            • Boolean operators (including the ternary operator)
            • Bitwise operators
            • Comparison operators
            • Common mathematic functions: abs ceil erf exp floor lgamma ln log2 log10 max min sqrt pow
            • Trigonometric library functions: acosh acos asinh asin atanh atan cosh cos sinh sin tanh tan
            • Random generation of a number between 0 and 1: rand
            • Current time in epoch: time
            • The min max functions that operate on a variable argument list

            Intermediate results are calculated as double precision floating point values. The final return value of a RankExpression is automatically converted from floating point to a 32-bit unsigned integer by rounding to the nearest integer, with a natural floor of 0 and a ceiling of max(uint32_t), 4294967295. Mathematical errors such as dividing by 0 will fail during evaluation and return a value of 0.

            The source data for a RankExpression can be the name of an IndexField of type uint, another RankExpression or the reserved name text_relevance. The text_relevance source is defined to return an integer from 0 to 1000 (inclusive) to indicate how relevant a document is to the search request, taking into account repetition of search terms in the document and proximity of search terms to each other in each matching IndexField in the document.

            For more information about using rank expressions to customize ranking, see the Amazon CloudSearch Developer Guide.

        • Status — required — (map)

          The status of an option, including when it was last updated and whether it is actively in use for searches.

          • CreationDate — required — (Date)

            A timestamp for when this option was created.

          • UpdateDate — required — (Date)

            A timestamp for when this option was last updated.

          • UpdateVersion — (Integer)

            A unique integer that indicates when this option was last updated.

          • State — required — (String)

            The state of processing a change to an option. Possible values:

            • RequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.
            • Processing: the option's latest value is not yet visible in all searches but is in the process of being activated.
            • Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.
            Possible values include:
            • "RequiresIndexDocuments"
            • "Processing"
            • "Active"
          • PendingDeletion — (Boolean)

            Indicates that the option will be deleted once processing is complete.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Permanently deletes a search domain and all of its data.

Examples:

Calling the deleteDomain operation

var params = {
  DomainName: 'STRING_VALUE' /* required */
};
cloudsearch.deleteDomain(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DomainName — (String)

      A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DomainStatus — (map)

        The current status of the search domain.

        • DomainId — required — (String)

          An internally generated unique identifier for a domain.

        • DomainName — required — (String)

          A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

        • Created — (Boolean)

          True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete.

        • Deleted — (Boolean)

          True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true value for IsDeleted for several minutes until resource cleanup is complete.

        • NumSearchableDocs — (Integer)

          The number of documents that have been submitted to the domain and indexed.

        • DocService — (map)

          The service endpoint for updating documents in a search domain.

          • Arn — (String)

            An Amazon Resource Name (ARN). See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

          • Endpoint — (String)

            The URL (including /version/pathPrefix) to which service requests can be submitted.

        • SearchService — (map)

          The service endpoint for requesting search results from a search domain.

          • Arn — (String)

            An Amazon Resource Name (ARN). See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

          • Endpoint — (String)

            The URL (including /version/pathPrefix) to which service requests can be submitted.

        • RequiresIndexDocuments — required — (Boolean)

          True if IndexDocuments needs to be called to activate the current domain configuration.

        • Processing — (Boolean)

          True if processing is being done to activate the current domain configuration.

        • SearchInstanceType — (String)

          The instance type (such as search.m1.small) that is being used to process search requests.

        • SearchPartitionCount — (Integer)

          The number of partitions across which the search index is spread.

        • SearchInstanceCount — (Integer)

          The number of search instances that are available to process search requests.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Removes an IndexField from the search domain.

Examples:

Calling the deleteIndexField operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  IndexFieldName: 'STRING_VALUE' /* required */
};
cloudsearch.deleteIndexField(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DomainName — (String)

      A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

    • IndexFieldName — (String)

      A string that represents the name of an index field. Field names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names "body", "docid", and "text_relevance" are reserved and cannot be specified as field or rank expression names.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • IndexField — (map)

        The value of an IndexField and its current status.

        • Options — required — (map)

          Defines a field in the index, including its name, type, and the source of its data. The IndexFieldType indicates which of the options will be present. It is invalid to specify options for a type other than the IndexFieldType.

          • IndexFieldName — required — (String)

            The name of a field in the search index. Field names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names "body", "docid", and "text_relevance" are reserved and cannot be specified as field or rank expression names.

          • IndexFieldType — required — (String)

            The type of field. Based on this type, exactly one of the UIntOptions, LiteralOptions or TextOptions must be present.

            Possible values include:
            • "uint"
            • "literal"
            • "text"
          • UIntOptions — (map)

            Options for an unsigned integer field. Present if IndexFieldType specifies the field is of type unsigned integer.

            • DefaultValue — (Integer)

              The default value for an unsigned integer field. Optional.

          • LiteralOptions — (map)

            Options for literal field. Present if IndexFieldType specifies the field is of type literal.

            • DefaultValue — (String)

              The default value for a literal field. Optional.

            • SearchEnabled — (Boolean)

              Specifies whether search is enabled for this field. Default: False.

            • FacetEnabled — (Boolean)

              Specifies whether facets are enabled for this field. Default: False.

            • ResultEnabled — (Boolean)

              Specifies whether values of this field can be returned in search results and used for ranking. Default: False.

          • TextOptions — (map)

            Options for text field. Present if IndexFieldType specifies the field is of type text.

            • DefaultValue — (String)

              The default value for a text field. Optional.

            • FacetEnabled — (Boolean)

              Specifies whether facets are enabled for this field. Default: False.

            • ResultEnabled — (Boolean)

              Specifies whether values of this field can be returned in search results and used for ranking. Default: False.

            • TextProcessor — (String)

              The text processor to apply to this field. Optional. Possible values:

              • cs_text_no_stemming: turns off stemming for the field.

              Default: none

          • SourceAttributes — (Array<map>)

            An optional list of source attributes that provide data for this index field. If not specified, the data is pulled from a source attribute with the same name as this IndexField. When one or more source attributes are specified, an optional data transformation can be applied to the source data when populating the index field. You can configure a maximum of 20 sources for an IndexField.

            • SourceDataFunction — required — (String)

              Identifies the transformation to apply when copying data from a source attribute.

              Possible values include:
              • "Copy"
              • "TrimTitle"
              • "Map"
            • SourceDataCopy — (map)

              Copies data from a source document attribute to an IndexField.

              • SourceName — required — (String)

                The name of the document source field to add to this IndexField.

              • DefaultValue — (String)

                The default value to use if the source attribute is not specified in a document. Optional.

            • SourceDataTrimTitle — (map)

              Trims common title words from a source document attribute when populating an IndexField. This can be used to create an IndexField you can use for sorting.

              • SourceName — required — (String)

                The name of the document source field to add to this IndexField.

              • DefaultValue — (String)

                The default value to use if the source attribute is not specified in a document. Optional.

              • Separator — (String)

                The separator that follows the text to trim.

              • Language — (String)

                An IETF RFC 4646 language code. Only the primary language is considered. English (en) is currently the only supported language.

            • SourceDataMap — (map)

              Maps source document attribute values to new values when populating the IndexField.

              • SourceName — required — (String)

                The name of the document source field to add to this IndexField.

              • DefaultValue — (String)

                The default value to use if the source attribute is not specified in a document. Optional.

              • Cases — (map<String>)

                A map that translates source field values to custom values.

        • Status — required — (map)

          The status of an option, including when it was last updated and whether it is actively in use for searches.

          • CreationDate — required — (Date)

            A timestamp for when this option was created.

          • UpdateDate — required — (Date)

            A timestamp for when this option was last updated.

          • UpdateVersion — (Integer)

            A unique integer that indicates when this option was last updated.

          • State — required — (String)

            The state of processing a change to an option. Possible values:

            • RequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.
            • Processing: the option's latest value is not yet visible in all searches but is in the process of being activated.
            • Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.
            Possible values include:
            • "RequiresIndexDocuments"
            • "Processing"
            • "Active"
          • PendingDeletion — (Boolean)

            Indicates that the option will be deleted once processing is complete.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Removes a RankExpression from the search domain.

Examples:

Calling the deleteRankExpression operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  RankName: 'STRING_VALUE' /* required */
};
cloudsearch.deleteRankExpression(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DomainName — (String)

      A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

    • RankName — (String)

      The name of the RankExpression to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RankExpression — (map)

        The value of a RankExpression and its current status.

        • Options — required — (map)

          The expression that is evaluated for ranking or thresholding while processing a search request.

          • RankName — required — (String)

            The name of a rank expression. Rank expression names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names "body", "docid", and "text_relevance" are reserved and cannot be specified as field or rank expression names.

          • RankExpression — required — (String)

            The expression to evaluate for ranking or thresholding while processing a search request. The RankExpression syntax is based on JavaScript expressions and supports:

            • Integer, floating point, hex and octal literals
            • Shortcut evaluation of logical operators such that an expression a || b evaluates to the value a, if a is true, without evaluating b at all
            • JavaScript order of precedence for operators
            • Arithmetic operators: + - * / %
            • Boolean operators (including the ternary operator)
            • Bitwise operators
            • Comparison operators
            • Common mathematic functions: abs ceil erf exp floor lgamma ln log2 log10 max min sqrt pow
            • Trigonometric library functions: acosh acos asinh asin atanh atan cosh cos sinh sin tanh tan
            • Random generation of a number between 0 and 1: rand
            • Current time in epoch: time
            • The min max functions that operate on a variable argument list

            Intermediate results are calculated as double precision floating point values. The final return value of a RankExpression is automatically converted from floating point to a 32-bit unsigned integer by rounding to the nearest integer, with a natural floor of 0 and a ceiling of max(uint32_t), 4294967295. Mathematical errors such as dividing by 0 will fail during evaluation and return a value of 0.

            The source data for a RankExpression can be the name of an IndexField of type uint, another RankExpression or the reserved name text_relevance. The text_relevance source is defined to return an integer from 0 to 1000 (inclusive) to indicate how relevant a document is to the search request, taking into account repetition of search terms in the document and proximity of search terms to each other in each matching IndexField in the document.

            For more information about using rank expressions to customize ranking, see the Amazon CloudSearch Developer Guide.

        • Status — required — (map)

          The status of an option, including when it was last updated and whether it is actively in use for searches.

          • CreationDate — required — (Date)

            A timestamp for when this option was created.

          • UpdateDate — required — (Date)

            A timestamp for when this option was last updated.

          • UpdateVersion — (Integer)

            A unique integer that indicates when this option was last updated.

          • State — required — (String)

            The state of processing a change to an option. Possible values:

            • RequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.
            • Processing: the option's latest value is not yet visible in all searches but is in the process of being activated.
            • Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.
            Possible values include:
            • "RequiresIndexDocuments"
            • "Processing"
            • "Active"
          • PendingDeletion — (Boolean)

            Indicates that the option will be deleted once processing is complete.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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.

Examples:

Calling the describeAvailabilityOptions operation

var params = {
  DomainName: 'STRING_VALUE' /* required */
};
cloudsearch.describeAvailabilityOptions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DomainName — (String)

      The name of the domain you want to describe.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AvailabilityOptions — (map)

        The availability options configured for the domain. Indicates whether Multi-AZ is enabled for the domain.

        • Options — required — (Boolean)

          The availability options configured for the domain.

        • Status — required — (map)

          The status of an option, including when it was last updated and whether it is actively in use for searches.

          • CreationDate — required — (Date)

            A timestamp for when this option was created.

          • UpdateDate — required — (Date)

            A timestamp for when this option was last updated.

          • UpdateVersion — (Integer)

            A unique integer that indicates when this option was last updated.

          • State — required — (String)

            The state of processing a change to an option. Possible values:

            • RequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.
            • Processing: the option's latest value is not yet visible in all searches but is in the process of being activated.
            • Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.
            Possible values include:
            • "RequiresIndexDocuments"
            • "Processing"
            • "Active"
          • PendingDeletion — (Boolean)

            Indicates that the option will be deleted once processing is complete.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Gets the default search field configured for the search domain.

Examples:

Calling the describeDefaultSearchField operation

var params = {
  DomainName: 'STRING_VALUE' /* required */
};
cloudsearch.describeDefaultSearchField(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DomainName — (String)

      A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DefaultSearchField — (map)

        The name of the IndexField to use for search requests issued with the q parameter. The default is the empty string, which automatically searches all text fields.

        • Options — required — (String)

          The name of the IndexField to use as the default search field. The default is an empty string, which automatically searches all text fields.

        • Status — required — (map)

          The status of an option, including when it was last updated and whether it is actively in use for searches.

          • CreationDate — required — (Date)

            A timestamp for when this option was created.

          • UpdateDate — required — (Date)

            A timestamp for when this option was last updated.

          • UpdateVersion — (Integer)

            A unique integer that indicates when this option was last updated.

          • State — required — (String)

            The state of processing a change to an option. Possible values:

            • RequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.
            • Processing: the option's latest value is not yet visible in all searches but is in the process of being activated.
            • Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.
            Possible values include:
            • "RequiresIndexDocuments"
            • "Processing"
            • "Active"
          • PendingDeletion — (Boolean)

            Indicates that the option will be deleted once processing is complete.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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.

Examples:

Calling the describeDomains operation

var params = {
  DomainNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
cloudsearch.describeDomains(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DomainNames — (Array<String>)

      Limits the DescribeDomains response to the specified search domains.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DomainStatusList — (Array<map>)

        The current status of all of your search domains.

        • DomainId — required — (String)

          An internally generated unique identifier for a domain.

        • DomainName — required — (String)

          A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

        • Created — (Boolean)

          True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete.

        • Deleted — (Boolean)

          True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true value for IsDeleted for several minutes until resource cleanup is complete.

        • NumSearchableDocs — (Integer)

          The number of documents that have been submitted to the domain and indexed.

        • DocService — (map)

          The service endpoint for updating documents in a search domain.

          • Arn — (String)

            An Amazon Resource Name (ARN). See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

          • Endpoint — (String)

            The URL (including /version/pathPrefix) to which service requests can be submitted.

        • SearchService — (map)

          The service endpoint for requesting search results from a search domain.

          • Arn — (String)

            An Amazon Resource Name (ARN). See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

          • Endpoint — (String)

            The URL (including /version/pathPrefix) to which service requests can be submitted.

        • RequiresIndexDocuments — required — (Boolean)

          True if IndexDocuments needs to be called to activate the current domain configuration.

        • Processing — (Boolean)

          True if processing is being done to activate the current domain configuration.

        • SearchInstanceType — (String)

          The instance type (such as search.m1.small) that is being used to process search requests.

        • SearchPartitionCount — (Integer)

          The number of partitions across which the search index is spread.

        • SearchInstanceCount — (Integer)

          The number of search instances that are available to process search requests.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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.

Examples:

Calling the describeIndexFields operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  FieldNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
cloudsearch.describeIndexFields(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DomainName — (String)

      A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

    • FieldNames — (Array<String>)

      Limits the DescribeIndexFields response to the specified fields.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • IndexFields — (Array<map>)

        The index fields configured for the domain.

        • Options — required — (map)

          Defines a field in the index, including its name, type, and the source of its data. The IndexFieldType indicates which of the options will be present. It is invalid to specify options for a type other than the IndexFieldType.

          • IndexFieldName — required — (String)

            The name of a field in the search index. Field names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names "body", "docid", and "text_relevance" are reserved and cannot be specified as field or rank expression names.

          • IndexFieldType — required — (String)

            The type of field. Based on this type, exactly one of the UIntOptions, LiteralOptions or TextOptions must be present.

            Possible values include:
            • "uint"
            • "literal"
            • "text"
          • UIntOptions — (map)

            Options for an unsigned integer field. Present if IndexFieldType specifies the field is of type unsigned integer.

            • DefaultValue — (Integer)

              The default value for an unsigned integer field. Optional.

          • LiteralOptions — (map)

            Options for literal field. Present if IndexFieldType specifies the field is of type literal.

            • DefaultValue — (String)

              The default value for a literal field. Optional.

            • SearchEnabled — (Boolean)

              Specifies whether search is enabled for this field. Default: False.

            • FacetEnabled — (Boolean)

              Specifies whether facets are enabled for this field. Default: False.

            • ResultEnabled — (Boolean)

              Specifies whether values of this field can be returned in search results and used for ranking. Default: False.

          • TextOptions — (map)

            Options for text field. Present if IndexFieldType specifies the field is of type text.

            • DefaultValue — (String)

              The default value for a text field. Optional.

            • FacetEnabled — (Boolean)

              Specifies whether facets are enabled for this field. Default: False.

            • ResultEnabled — (Boolean)

              Specifies whether values of this field can be returned in search results and used for ranking. Default: False.

            • TextProcessor — (String)

              The text processor to apply to this field. Optional. Possible values:

              • cs_text_no_stemming: turns off stemming for the field.

              Default: none

          • SourceAttributes — (Array<map>)

            An optional list of source attributes that provide data for this index field. If not specified, the data is pulled from a source attribute with the same name as this IndexField. When one or more source attributes are specified, an optional data transformation can be applied to the source data when populating the index field. You can configure a maximum of 20 sources for an IndexField.

            • SourceDataFunction — required — (String)

              Identifies the transformation to apply when copying data from a source attribute.

              Possible values include:
              • "Copy"
              • "TrimTitle"
              • "Map"
            • SourceDataCopy — (map)

              Copies data from a source document attribute to an IndexField.

              • SourceName — required — (String)

                The name of the document source field to add to this IndexField.

              • DefaultValue — (String)

                The default value to use if the source attribute is not specified in a document. Optional.

            • SourceDataTrimTitle — (map)

              Trims common title words from a source document attribute when populating an IndexField. This can be used to create an IndexField you can use for sorting.

              • SourceName — required — (String)

                The name of the document source field to add to this IndexField.

              • DefaultValue — (String)

                The default value to use if the source attribute is not specified in a document. Optional.

              • Separator — (String)

                The separator that follows the text to trim.

              • Language — (String)

                An IETF RFC 4646 language code. Only the primary language is considered. English (en) is currently the only supported language.

            • SourceDataMap — (map)

              Maps source document attribute values to new values when populating the IndexField.

              • SourceName — required — (String)

                The name of the document source field to add to this IndexField.

              • DefaultValue — (String)

                The default value to use if the source attribute is not specified in a document. Optional.

              • Cases — (map<String>)

                A map that translates source field values to custom values.

        • Status — required — (map)

          The status of an option, including when it was last updated and whether it is actively in use for searches.

          • CreationDate — required — (Date)

            A timestamp for when this option was created.

          • UpdateDate — required — (Date)

            A timestamp for when this option was last updated.

          • UpdateVersion — (Integer)

            A unique integer that indicates when this option was last updated.

          • State — required — (String)

            The state of processing a change to an option. Possible values:

            • RequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.
            • Processing: the option's latest value is not yet visible in all searches but is in the process of being activated.
            • Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.
            Possible values include:
            • "RequiresIndexDocuments"
            • "Processing"
            • "Active"
          • PendingDeletion — (Boolean)

            Indicates that the option will be deleted once processing is complete.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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.

Examples:

Calling the describeRankExpressions operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  RankNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
cloudsearch.describeRankExpressions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DomainName — (String)

      A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

    • RankNames — (Array<String>)

      Limits the DescribeRankExpressions response to the specified fields.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RankExpressions — (Array<map>)

        The rank expressions configured for the domain.

        • Options — required — (map)

          The expression that is evaluated for ranking or thresholding while processing a search request.

          • RankName — required — (String)

            The name of a rank expression. Rank expression names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names "body", "docid", and "text_relevance" are reserved and cannot be specified as field or rank expression names.

          • RankExpression — required — (String)

            The expression to evaluate for ranking or thresholding while processing a search request. The RankExpression syntax is based on JavaScript expressions and supports:

            • Integer, floating point, hex and octal literals
            • Shortcut evaluation of logical operators such that an expression a || b evaluates to the value a, if a is true, without evaluating b at all
            • JavaScript order of precedence for operators
            • Arithmetic operators: + - * / %
            • Boolean operators (including the ternary operator)
            • Bitwise operators
            • Comparison operators
            • Common mathematic functions: abs ceil erf exp floor lgamma ln log2 log10 max min sqrt pow
            • Trigonometric library functions: acosh acos asinh asin atanh atan cosh cos sinh sin tanh tan
            • Random generation of a number between 0 and 1: rand
            • Current time in epoch: time
            • The min max functions that operate on a variable argument list

            Intermediate results are calculated as double precision floating point values. The final return value of a RankExpression is automatically converted from floating point to a 32-bit unsigned integer by rounding to the nearest integer, with a natural floor of 0 and a ceiling of max(uint32_t), 4294967295. Mathematical errors such as dividing by 0 will fail during evaluation and return a value of 0.

            The source data for a RankExpression can be the name of an IndexField of type uint, another RankExpression or the reserved name text_relevance. The text_relevance source is defined to return an integer from 0 to 1000 (inclusive) to indicate how relevant a document is to the search request, taking into account repetition of search terms in the document and proximity of search terms to each other in each matching IndexField in the document.

            For more information about using rank expressions to customize ranking, see the Amazon CloudSearch Developer Guide.

        • Status — required — (map)

          The status of an option, including when it was last updated and whether it is actively in use for searches.

          • CreationDate — required — (Date)

            A timestamp for when this option was created.

          • UpdateDate — required — (Date)

            A timestamp for when this option was last updated.

          • UpdateVersion — (Integer)

            A unique integer that indicates when this option was last updated.

          • State — required — (String)

            The state of processing a change to an option. Possible values:

            • RequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.
            • Processing: the option's latest value is not yet visible in all searches but is in the process of being activated.
            • Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.
            Possible values include:
            • "RequiresIndexDocuments"
            • "Processing"
            • "Active"
          • PendingDeletion — (Boolean)

            Indicates that the option will be deleted once processing is complete.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

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

Examples:

Calling the describeServiceAccessPolicies operation

var params = {
  DomainName: 'STRING_VALUE' /* required */
};
cloudsearch.describeServiceAccessPolicies(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DomainName — (String)

      A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AccessPolicies — (map)

        A PolicyDocument that specifies access policies for the search domain's services, and the current status of those policies.

        • Options — required — (String)

          An IAM access policy as described in The Access Policy Language in Using AWS Identity and Access Management. The maximum size of an access policy document is 100 KB.

          Example: {"Statement": [{"Effect":"Allow", "Action": "*", "Resource": "arn:aws:cs:us-east-1:1234567890:search/movies", "Condition": { "IpAddress": { "aws:SourceIp": ["203.0.113.1/32"] } }}, {"Effect":"Allow", "Action": "*", "Resource": "arn:aws:cs:us-east-1:1234567890:documents/movies", "Condition": { "IpAddress": { "aws:SourceIp": ["203.0.113.1/32"] } }} ] }

        • Status — required — (map)

          The status of an option, including when it was last updated and whether it is actively in use for searches.

          • CreationDate — required — (Date)

            A timestamp for when this option was created.

          • UpdateDate — required — (Date)

            A timestamp for when this option was last updated.

          • UpdateVersion — (Integer)

            A unique integer that indicates when this option was last updated.

          • State — required — (String)

            The state of processing a change to an option. Possible values:

            • RequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.
            • Processing: the option's latest value is not yet visible in all searches but is in the process of being activated.
            • Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.
            Possible values include:
            • "RequiresIndexDocuments"
            • "Processing"
            • "Active"
          • PendingDeletion — (Boolean)

            Indicates that the option will be deleted once processing is complete.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Gets the stemming dictionary configured for the search domain.

Examples:

Calling the describeStemmingOptions operation

var params = {
  DomainName: 'STRING_VALUE' /* required */
};
cloudsearch.describeStemmingOptions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DomainName — (String)

      A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Stems — (map)

        The stemming options configured for this search domain and the current status of those options.

        • Options — required — (String)

          Maps terms to their stems, serialized as a JSON document. The document has a single object with one property "stems" whose value is an object mapping terms to their stems. The maximum size of a stemming document is 500 KB. Example: { "stems": {"people": "person", "walking": "walk"} }

        • Status — required — (map)

          The status of an option, including when it was last updated and whether it is actively in use for searches.

          • CreationDate — required — (Date)

            A timestamp for when this option was created.

          • UpdateDate — required — (Date)

            A timestamp for when this option was last updated.

          • UpdateVersion — (Integer)

            A unique integer that indicates when this option was last updated.

          • State — required — (String)

            The state of processing a change to an option. Possible values:

            • RequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.
            • Processing: the option's latest value is not yet visible in all searches but is in the process of being activated.
            • Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.
            Possible values include:
            • "RequiresIndexDocuments"
            • "Processing"
            • "Active"
          • PendingDeletion — (Boolean)

            Indicates that the option will be deleted once processing is complete.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Gets the stopwords configured for the search domain.

Examples:

Calling the describeStopwordOptions operation

var params = {
  DomainName: 'STRING_VALUE' /* required */
};
cloudsearch.describeStopwordOptions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DomainName — (String)

      A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Stopwords — (map)

        The stopword options configured for this search domain and the current status of those options.

        • Options — required — (String)

          Lists stopwords serialized as a JSON document. The document has a single object with one property "stopwords" whose value is an array of strings. The maximum size of a stopwords document is 10 KB. Example: { "stopwords": ["a", "an", "the", "of"] }

        • Status — required — (map)

          The status of an option, including when it was last updated and whether it is actively in use for searches.

          • CreationDate — required — (Date)

            A timestamp for when this option was created.

          • UpdateDate — required — (Date)

            A timestamp for when this option was last updated.

          • UpdateVersion — (Integer)

            A unique integer that indicates when this option was last updated.

          • State — required — (String)

            The state of processing a change to an option. Possible values:

            • RequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.
            • Processing: the option's latest value is not yet visible in all searches but is in the process of being activated.
            • Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.
            Possible values include:
            • "RequiresIndexDocuments"
            • "Processing"
            • "Active"
          • PendingDeletion — (Boolean)

            Indicates that the option will be deleted once processing is complete.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Gets the synonym dictionary configured for the search domain.

Examples:

Calling the describeSynonymOptions operation

var params = {
  DomainName: 'STRING_VALUE' /* required */
};
cloudsearch.describeSynonymOptions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DomainName — (String)

      A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Synonyms — (map)

        The synonym options configured for this search domain and the current status of those options.

        • Options — required — (String)

          Maps terms to their synonyms, serialized as a JSON document. The document has a single object with one property "synonyms" whose value is an object mapping terms to their synonyms. Each synonym is a simple string or an array of strings. The maximum size of a stopwords document is 100 KB. Example: { "synonyms": {"cat": ["feline", "kitten"], "puppy": "dog"} }

        • Status — required — (map)

          The status of an option, including when it was last updated and whether it is actively in use for searches.

          • CreationDate — required — (Date)

            A timestamp for when this option was created.

          • UpdateDate — required — (Date)

            A timestamp for when this option was last updated.

          • UpdateVersion — (Integer)

            A unique integer that indicates when this option was last updated.

          • State — required — (String)

            The state of processing a change to an option. Possible values:

            • RequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.
            • Processing: the option's latest value is not yet visible in all searches but is in the process of being activated.
            • Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.
            Possible values include:
            • "RequiresIndexDocuments"
            • "Processing"
            • "Active"
          • PendingDeletion — (Boolean)

            Indicates that the option will be deleted once processing is complete.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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.

Examples:

Calling the indexDocuments operation

var params = {
  DomainName: 'STRING_VALUE' /* required */
};
cloudsearch.indexDocuments(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DomainName — (String)

      A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FieldNames — (Array<String>)

        The names of the fields that are currently being processed due to an IndexDocuments action.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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.

Examples:

Calling the updateAvailabilityOptions operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  MultiAZ: true || false /* required */
};
cloudsearch.updateAvailabilityOptions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DomainName — (String)

      A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

    • MultiAZ — (Boolean)

      You expand an existing search domain to a second Availability Zone by setting the Multi-AZ option to true. Similarly, you can turn off the Multi-AZ option to downgrade the domain to a single Availability Zone by setting the Multi-AZ option to false.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AvailabilityOptions — (map)

        The newly-configured availability options. Indicates whether Multi-AZ is enabled for the domain.

        • Options — required — (Boolean)

          The availability options configured for the domain.

        • Status — required — (map)

          The status of an option, including when it was last updated and whether it is actively in use for searches.

          • CreationDate — required — (Date)

            A timestamp for when this option was created.

          • UpdateDate — required — (Date)

            A timestamp for when this option was last updated.

          • UpdateVersion — (Integer)

            A unique integer that indicates when this option was last updated.

          • State — required — (String)

            The state of processing a change to an option. Possible values:

            • RequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.
            • Processing: the option's latest value is not yet visible in all searches but is in the process of being activated.
            • Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.
            Possible values include:
            • "RequiresIndexDocuments"
            • "Processing"
            • "Active"
          • PendingDeletion — (Boolean)

            Indicates that the option will be deleted once processing is complete.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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.

Examples:

Calling the updateDefaultSearchField operation

var params = {
  DefaultSearchField: 'STRING_VALUE', /* required */
  DomainName: 'STRING_VALUE' /* required */
};
cloudsearch.updateDefaultSearchField(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DomainName — (String)

      A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

    • DefaultSearchField — (String)

      The text field to search if the search request does not specify which field to search. The default search field is used when search terms are specified with the q parameter, or if a match expression specified with the bq parameter does not constrain the search to a particular field. The default is an empty string, which automatically searches all text fields.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DefaultSearchField — (map)

        The value of the DefaultSearchField configured for this search domain and its current status.

        • Options — required — (String)

          The name of the IndexField to use as the default search field. The default is an empty string, which automatically searches all text fields.

        • Status — required — (map)

          The status of an option, including when it was last updated and whether it is actively in use for searches.

          • CreationDate — required — (Date)

            A timestamp for when this option was created.

          • UpdateDate — required — (Date)

            A timestamp for when this option was last updated.

          • UpdateVersion — (Integer)

            A unique integer that indicates when this option was last updated.

          • State — required — (String)

            The state of processing a change to an option. Possible values:

            • RequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.
            • Processing: the option's latest value is not yet visible in all searches but is in the process of being activated.
            • Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.
            Possible values include:
            • "RequiresIndexDocuments"
            • "Processing"
            • "Active"
          • PendingDeletion — (Boolean)

            Indicates that the option will be deleted once processing is complete.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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.

Examples:

Calling the updateServiceAccessPolicies operation

var params = {
  AccessPolicies: 'STRING_VALUE', /* required */
  DomainName: 'STRING_VALUE' /* required */
};
cloudsearch.updateServiceAccessPolicies(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DomainName — (String)

      A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

    • AccessPolicies — (String)

      An IAM access policy as described in The Access Policy Language in Using AWS Identity and Access Management. The maximum size of an access policy document is 100 KB.

      Example: {"Statement": [{"Effect":"Allow", "Action": "*", "Resource": "arn:aws:cs:us-east-1:1234567890:search/movies", "Condition": { "IpAddress": { "aws:SourceIp": ["203.0.113.1/32"] } }}, {"Effect":"Allow", "Action": "*", "Resource": "arn:aws:cs:us-east-1:1234567890:documents/movies", "Condition": { "IpAddress": { "aws:SourceIp": ["203.0.113.1/32"] } }} ] }

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AccessPolicies — (map)

        A PolicyDocument that specifies access policies for the search domain's services, and the current status of those policies.

        • Options — required — (String)

          An IAM access policy as described in The Access Policy Language in Using AWS Identity and Access Management. The maximum size of an access policy document is 100 KB.

          Example: {"Statement": [{"Effect":"Allow", "Action": "*", "Resource": "arn:aws:cs:us-east-1:1234567890:search/movies", "Condition": { "IpAddress": { "aws:SourceIp": ["203.0.113.1/32"] } }}, {"Effect":"Allow", "Action": "*", "Resource": "arn:aws:cs:us-east-1:1234567890:documents/movies", "Condition": { "IpAddress": { "aws:SourceIp": ["203.0.113.1/32"] } }} ] }

        • Status — required — (map)

          The status of an option, including when it was last updated and whether it is actively in use for searches.

          • CreationDate — required — (Date)

            A timestamp for when this option was created.

          • UpdateDate — required — (Date)

            A timestamp for when this option was last updated.

          • UpdateVersion — (Integer)

            A unique integer that indicates when this option was last updated.

          • State — required — (String)

            The state of processing a change to an option. Possible values:

            • RequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.
            • Processing: the option's latest value is not yet visible in all searches but is in the process of being activated.
            • Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.
            Possible values include:
            • "RequiresIndexDocuments"
            • "Processing"
            • "Active"
          • PendingDeletion — (Boolean)

            Indicates that the option will be deleted once processing is complete.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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.

Examples:

Calling the updateStemmingOptions operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  Stems: 'STRING_VALUE' /* required */
};
cloudsearch.updateStemmingOptions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DomainName — (String)

      A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

    • Stems — (String)

      Maps terms to their stems, serialized as a JSON document. The document has a single object with one property "stems" whose value is an object mapping terms to their stems. The maximum size of a stemming document is 500 KB. Example: { "stems": {"people": "person", "walking": "walk"} }

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Stems — (map)

        The stemming options configured for this search domain and the current status of those options.

        • Options — required — (String)

          Maps terms to their stems, serialized as a JSON document. The document has a single object with one property "stems" whose value is an object mapping terms to their stems. The maximum size of a stemming document is 500 KB. Example: { "stems": {"people": "person", "walking": "walk"} }

        • Status — required — (map)

          The status of an option, including when it was last updated and whether it is actively in use for searches.

          • CreationDate — required — (Date)

            A timestamp for when this option was created.

          • UpdateDate — required — (Date)

            A timestamp for when this option was last updated.

          • UpdateVersion — (Integer)

            A unique integer that indicates when this option was last updated.

          • State — required — (String)

            The state of processing a change to an option. Possible values:

            • RequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.
            • Processing: the option's latest value is not yet visible in all searches but is in the process of being activated.
            • Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.
            Possible values include:
            • "RequiresIndexDocuments"
            • "Processing"
            • "Active"
          • PendingDeletion — (Boolean)

            Indicates that the option will be deleted once processing is complete.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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.

Examples:

Calling the updateStopwordOptions operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  Stopwords: 'STRING_VALUE' /* required */
};
cloudsearch.updateStopwordOptions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DomainName — (String)

      A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

    • Stopwords — (String)

      Lists stopwords serialized as a JSON document. The document has a single object with one property "stopwords" whose value is an array of strings. The maximum size of a stopwords document is 10 KB. Example: { "stopwords": ["a", "an", "the", "of"] }

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Stopwords — (map)

        The stopword options configured for this search domain and the current status of those options.

        • Options — required — (String)

          Lists stopwords serialized as a JSON document. The document has a single object with one property "stopwords" whose value is an array of strings. The maximum size of a stopwords document is 10 KB. Example: { "stopwords": ["a", "an", "the", "of"] }

        • Status — required — (map)

          The status of an option, including when it was last updated and whether it is actively in use for searches.

          • CreationDate — required — (Date)

            A timestamp for when this option was created.

          • UpdateDate — required — (Date)

            A timestamp for when this option was last updated.

          • UpdateVersion — (Integer)

            A unique integer that indicates when this option was last updated.

          • State — required — (String)

            The state of processing a change to an option. Possible values:

            • RequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.
            • Processing: the option's latest value is not yet visible in all searches but is in the process of being activated.
            • Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.
            Possible values include:
            • "RequiresIndexDocuments"
            • "Processing"
            • "Active"
          • PendingDeletion — (Boolean)

            Indicates that the option will be deleted once processing is complete.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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.

Examples:

Calling the updateSynonymOptions operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  Synonyms: 'STRING_VALUE' /* required */
};
cloudsearch.updateSynonymOptions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DomainName — (String)

      A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

    • Synonyms — (String)

      Maps terms to their synonyms, serialized as a JSON document. The document has a single object with one property "synonyms" whose value is an object mapping terms to their synonyms. Each synonym is a simple string or an array of strings. The maximum size of a stopwords document is 100 KB. Example: { "synonyms": {"cat": ["feline", "kitten"], "puppy": "dog"} }

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Synonyms — (map)

        The synonym options configured for this search domain and the current status of those options.

        • Options — required — (String)

          Maps terms to their synonyms, serialized as a JSON document. The document has a single object with one property "synonyms" whose value is an object mapping terms to their synonyms. Each synonym is a simple string or an array of strings. The maximum size of a stopwords document is 100 KB. Example: { "synonyms": {"cat": ["feline", "kitten"], "puppy": "dog"} }

        • Status — required — (map)

          The status of an option, including when it was last updated and whether it is actively in use for searches.

          • CreationDate — required — (Date)

            A timestamp for when this option was created.

          • UpdateDate — required — (Date)

            A timestamp for when this option was last updated.

          • UpdateVersion — (Integer)

            A unique integer that indicates when this option was last updated.

          • State — required — (String)

            The state of processing a change to an option. Possible values:

            • RequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.
            • Processing: the option's latest value is not yet visible in all searches but is in the process of being activated.
            • Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.
            Possible values include:
            • "RequiresIndexDocuments"
            • "Processing"
            • "Active"
          • PendingDeletion — (Boolean)

            Indicates that the option will be deleted once processing is complete.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.