Class: AWS.CloudSearch

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

Overview

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

Sending a Request Using CloudSearch

var cloudsearch = new AWS.CloudSearch();
cloudsearch.buildSuggesters(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: '2013-01-01'});

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

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

var cloudsearch = new AWS.CloudSearch();

Version:

  • 2013-01-01

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

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: '2013-01-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.region for more information.

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.CloudSearch.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.

Property Details

endpointAWS.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

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

Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide.

Service Reference:

Examples:

Calling the buildSuggesters operation

var params = {
  DomainName: 'STRING_VALUE' /* required */
};
cloudsearch.buildSuggesters(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 are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

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

        A list of field names.

Returns:

  • (AWS.Request)

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

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

Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide.

Service Reference:

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 name for the domain you are creating. Allowed characters are a-z (lower-case letters), 0-9, and hyphen (-). Domain names must start with a letter or number and be at least 3 and no more than 28 characters long.

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.

        • DomainIdrequired — (String)

          An internally generated unique identifier for a domain.

        • DomainNamerequired — (String)

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

        • ARN — (String)

          The Amazon Resource Name (ARN) of the search domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

        • 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.

        • DocService — (map)

          The service endpoint for updating documents in a search domain.

          • Endpoint — (String)

            The endpoint to which service requests can be submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com.

        • SearchService — (map)

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

          • Endpoint — (String)

            The endpoint to which service requests can be submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com.

        • RequiresIndexDocumentsrequired — (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 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.

        • Limits — (map)
          • MaximumReplicationCountrequired — (Integer)
          • MaximumPartitionCountrequired — (Integer)

Returns:

  • (AWS.Request)

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

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

Configures an analysis scheme that can be applied to a text or text-array field to define language-specific text processing options. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.

Service Reference:

Examples:

Calling the defineAnalysisScheme operation

var params = {
  AnalysisScheme: { /* required */
    AnalysisSchemeLanguage: ar | bg | ca | cs | da | de | el | en | es | eu | fa | fi | fr | ga | gl | he | hi | hu | hy | id | it | ja | ko | lv | mul | nl | no | pt | ro | ru | sv | th | tr | zh-Hans | zh-Hant, /* required */
    AnalysisSchemeName: 'STRING_VALUE', /* required */
    AnalysisOptions: {
      AlgorithmicStemming: none | minimal | light | full,
      JapaneseTokenizationDictionary: 'STRING_VALUE',
      StemmingDictionary: 'STRING_VALUE',
      Stopwords: 'STRING_VALUE',
      Synonyms: 'STRING_VALUE'
    }
  },
  DomainName: 'STRING_VALUE' /* required */
};
cloudsearch.defineAnalysisScheme(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 are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

    • AnalysisScheme — (map)

      Configuration information for an analysis scheme. Each analysis scheme has a unique name and specifies the language of the text to be processed. The following options can be configured for an analysis scheme: Synonyms, Stopwords, StemmingDictionary, JapaneseTokenizationDictionary and AlgorithmicStemming.

      • AnalysisSchemeNamerequired — (String)

        Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).

      • AnalysisSchemeLanguagerequired — (String)

        An IETF RFC 4646 language code or mul for multiple languages.

        Possible values include:
        • "ar"
        • "bg"
        • "ca"
        • "cs"
        • "da"
        • "de"
        • "el"
        • "en"
        • "es"
        • "eu"
        • "fa"
        • "fi"
        • "fr"
        • "ga"
        • "gl"
        • "he"
        • "hi"
        • "hu"
        • "hy"
        • "id"
        • "it"
        • "ja"
        • "ko"
        • "lv"
        • "mul"
        • "nl"
        • "no"
        • "pt"
        • "ro"
        • "ru"
        • "sv"
        • "th"
        • "tr"
        • "zh-Hans"
        • "zh-Hant"
      • AnalysisOptions — (map)

        Synonyms, stopwords, and stemming options for an analysis scheme. Includes tokenization dictionary for Japanese.

        • Synonyms — (String)

          A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see Synonyms in the Amazon CloudSearch Developer Guide.

        • Stopwords — (String)

          A JSON array of terms to ignore during indexing and searching. For example, ["a", "an", "the", "of"]. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported.

        • StemmingDictionary — (String)

          A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, {"term1": "stem1", "term2": "stem2", "term3": "stem3"}. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.

        • JapaneseTokenizationDictionary — (String)

          A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton. The Japanese tokenization dictionary enables you to override the default tokenization for selected terms. This is only valid for Japanese language fields.

        • AlgorithmicStemming — (String)

          The level of algorithmic stemming to perform: none, minimal, light, or full. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide

          Possible values include:
          • "none"
          • "minimal"
          • "light"
          • "full"

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:

      • AnalysisScheme — (map)

        The status and configuration of an AnalysisScheme.

        • Optionsrequired — (map)

          Configuration information for an analysis scheme. Each analysis scheme has a unique name and specifies the language of the text to be processed. The following options can be configured for an analysis scheme: Synonyms, Stopwords, StemmingDictionary, JapaneseTokenizationDictionary and AlgorithmicStemming.

          • AnalysisSchemeNamerequired — (String)

            Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).

          • AnalysisSchemeLanguagerequired — (String)

            An IETF RFC 4646 language code or mul for multiple languages.

            Possible values include:
            • "ar"
            • "bg"
            • "ca"
            • "cs"
            • "da"
            • "de"
            • "el"
            • "en"
            • "es"
            • "eu"
            • "fa"
            • "fi"
            • "fr"
            • "ga"
            • "gl"
            • "he"
            • "hi"
            • "hu"
            • "hy"
            • "id"
            • "it"
            • "ja"
            • "ko"
            • "lv"
            • "mul"
            • "nl"
            • "no"
            • "pt"
            • "ro"
            • "ru"
            • "sv"
            • "th"
            • "tr"
            • "zh-Hans"
            • "zh-Hant"
          • AnalysisOptions — (map)

            Synonyms, stopwords, and stemming options for an analysis scheme. Includes tokenization dictionary for Japanese.

            • Synonyms — (String)

              A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see Synonyms in the Amazon CloudSearch Developer Guide.

            • Stopwords — (String)

              A JSON array of terms to ignore during indexing and searching. For example, ["a", "an", "the", "of"]. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported.

            • StemmingDictionary — (String)

              A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, {"term1": "stem1", "term2": "stem2", "term3": "stem3"}. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.

            • JapaneseTokenizationDictionary — (String)

              A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton. The Japanese tokenization dictionary enables you to override the default tokenization for selected terms. This is only valid for Japanese language fields.

            • AlgorithmicStemming — (String)

              The level of algorithmic stemming to perform: none, minimal, light, or full. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide

              Possible values include:
              • "none"
              • "minimal"
              • "light"
              • "full"
        • Statusrequired — (map)

          The status of domain configuration option.

          • CreationDaterequired — (Date)

            A timestamp for when this option was created.

          • UpdateDaterequired — (Date)

            A timestamp for when this option was last updated.

          • UpdateVersion — (Integer)

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

          • Staterequired — (String)

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

            • RequiresIndexDocuments: the option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
            • Processing: the option's latest value is in the process of being activated.
            • Active: the option's latest value is completely deployed.
            • FailedToValidate: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
            Possible values include:
            • "RequiresIndexDocuments"
            • "Processing"
            • "Active"
            • "FailedToValidate"
          • 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.

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

Configures an Expression for the search domain. Used to create new expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

Service Reference:

Examples:

Calling the defineExpression operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  Expression: { /* required */
    ExpressionName: 'STRING_VALUE', /* required */
    ExpressionValue: 'STRING_VALUE' /* required */
  }
};
cloudsearch.defineExpression(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 are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

    • Expression — (map)

      A named expression that can be evaluated at search time. Can be used to sort the search results, define other expressions, or return computed information in the search results.

      • ExpressionNamerequired — (String)

        Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).

      • ExpressionValuerequired — (String)

        The expression to evaluate for sorting while processing a search request. The Expression syntax is based on JavaScript expressions. For more information, see Configuring Expressions in 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:

      • Expression — (map)

        The value of an Expression and its current status.

        • Optionsrequired — (map)

          The expression that is evaluated for sorting while processing a search request.

          • ExpressionNamerequired — (String)

            Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).

          • ExpressionValuerequired — (String)

            The expression to evaluate for sorting while processing a search request. The Expression syntax is based on JavaScript expressions. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

        • Statusrequired — (map)

          The status of domain configuration option.

          • CreationDaterequired — (Date)

            A timestamp for when this option was created.

          • UpdateDaterequired — (Date)

            A timestamp for when this option was last updated.

          • UpdateVersion — (Integer)

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

          • Staterequired — (String)

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

            • RequiresIndexDocuments: the option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
            • Processing: the option's latest value is in the process of being activated.
            • Active: the option's latest value is completely deployed.
            • FailedToValidate: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
            Possible values include:
            • "RequiresIndexDocuments"
            • "Processing"
            • "Active"
            • "FailedToValidate"
          • 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.

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

Configures an IndexField for the search domain. Used to create new fields and modify existing ones. You must specify the name of the domain you are configuring and an index field configuration. The index field configuration specifies a unique name, the index field type, and the options you want to configure for the field. The options you can specify depend on the IndexFieldType. If the field exists, the new configuration replaces the old one. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

Service Reference:

Examples:

Calling the defineIndexField operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  IndexField: { /* required */
    IndexFieldName: 'STRING_VALUE', /* required */
    IndexFieldType: int | double | literal | text | date | latlon | int-array | double-array | literal-array | text-array | date-array, /* required */
    DateArrayOptions: {
      DefaultValue: 'STRING_VALUE',
      FacetEnabled: true || false,
      ReturnEnabled: true || false,
      SearchEnabled: true || false,
      SourceFields: 'STRING_VALUE'
    },
    DateOptions: {
      DefaultValue: 'STRING_VALUE',
      FacetEnabled: true || false,
      ReturnEnabled: true || false,
      SearchEnabled: true || false,
      SortEnabled: true || false,
      SourceField: 'STRING_VALUE'
    },
    DoubleArrayOptions: {
      DefaultValue: 0.0,
      FacetEnabled: true || false,
      ReturnEnabled: true || false,
      SearchEnabled: true || false,
      SourceFields: 'STRING_VALUE'
    },
    DoubleOptions: {
      DefaultValue: 0.0,
      FacetEnabled: true || false,
      ReturnEnabled: true || false,
      SearchEnabled: true || false,
      SortEnabled: true || false,
      SourceField: 'STRING_VALUE'
    },
    IntArrayOptions: {
      DefaultValue: 0,
      FacetEnabled: true || false,
      ReturnEnabled: true || false,
      SearchEnabled: true || false,
      SourceFields: 'STRING_VALUE'
    },
    IntOptions: {
      DefaultValue: 0,
      FacetEnabled: true || false,
      ReturnEnabled: true || false,
      SearchEnabled: true || false,
      SortEnabled: true || false,
      SourceField: 'STRING_VALUE'
    },
    LatLonOptions: {
      DefaultValue: 'STRING_VALUE',
      FacetEnabled: true || false,
      ReturnEnabled: true || false,
      SearchEnabled: true || false,
      SortEnabled: true || false,
      SourceField: 'STRING_VALUE'
    },
    LiteralArrayOptions: {
      DefaultValue: 'STRING_VALUE',
      FacetEnabled: true || false,
      ReturnEnabled: true || false,
      SearchEnabled: true || false,
      SourceFields: 'STRING_VALUE'
    },
    LiteralOptions: {
      DefaultValue: 'STRING_VALUE',
      FacetEnabled: true || false,
      ReturnEnabled: true || false,
      SearchEnabled: true || false,
      SortEnabled: true || false,
      SourceField: 'STRING_VALUE'
    },
    TextArrayOptions: {
      AnalysisScheme: 'STRING_VALUE',
      DefaultValue: 'STRING_VALUE',
      HighlightEnabled: true || false,
      ReturnEnabled: true || false,
      SourceFields: 'STRING_VALUE'
    },
    TextOptions: {
      AnalysisScheme: 'STRING_VALUE',
      DefaultValue: 'STRING_VALUE',
      HighlightEnabled: true || false,
      ReturnEnabled: true || false,
      SortEnabled: true || false,
      SourceField: 'STRING_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 are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

    • IndexField — (map)

      The index field and field options you want to configure.

      • IndexFieldNamerequired — (String)

        A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

        Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

        The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

      • IndexFieldTyperequired — (String)

        The type of field. The valid options for a field depend on the field type. For more information about the supported field types, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

        Possible values include:
        • "int"
        • "double"
        • "literal"
        • "text"
        • "date"
        • "latlon"
        • "int-array"
        • "double-array"
        • "literal-array"
        • "text-array"
        • "date-array"
      • IntOptions — (map)

        Options for a 64-bit signed integer field. Present if IndexFieldType specifies the field is of type int. All options are enabled by default.

        • DefaultValue — (Integer) A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.
        • SourceField — (String)

          The name of the source field to map to the field.

        • FacetEnabled — (Boolean)

          Whether facet information can be returned for the field.

        • SearchEnabled — (Boolean)

          Whether the contents of the field are searchable.

        • ReturnEnabled — (Boolean)

          Whether the contents of the field can be returned in the search results.

        • SortEnabled — (Boolean)

          Whether the field can be used to sort the search results.

      • DoubleOptions — (map)

        Options for a double-precision 64-bit floating point field. Present if IndexFieldType specifies the field is of type double. All options are enabled by default.

        • DefaultValue — (Float)

          A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.

        • SourceField — (String)

          The name of the source field to map to the field.

        • FacetEnabled — (Boolean)

          Whether facet information can be returned for the field.

        • SearchEnabled — (Boolean)

          Whether the contents of the field are searchable.

        • ReturnEnabled — (Boolean)

          Whether the contents of the field can be returned in the search results.

        • SortEnabled — (Boolean)

          Whether the field can be used to sort the search results.

      • LiteralOptions — (map)

        Options for literal field. Present if IndexFieldType specifies the field is of type literal. All options are enabled by default.

        • DefaultValue — (String) A value to use for the field if the field isn't specified for a document.
        • SourceField — (String)

          A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

          Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

          The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

        • FacetEnabled — (Boolean)

          Whether facet information can be returned for the field.

        • SearchEnabled — (Boolean)

          Whether the contents of the field are searchable.

        • ReturnEnabled — (Boolean)

          Whether the contents of the field can be returned in the search results.

        • SortEnabled — (Boolean)

          Whether the field can be used to sort the search results.

      • TextOptions — (map)

        Options for text field. Present if IndexFieldType specifies the field is of type text. A text field is always searchable. All options are enabled by default.

        • DefaultValue — (String) A value to use for the field if the field isn't specified for a document.
        • SourceField — (String)

          A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

          Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

          The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

        • ReturnEnabled — (Boolean)

          Whether the contents of the field can be returned in the search results.

        • SortEnabled — (Boolean)

          Whether the field can be used to sort the search results.

        • HighlightEnabled — (Boolean)

          Whether highlights can be returned for the field.

        • AnalysisScheme — (String)

          The name of an analysis scheme for a text field.

      • DateOptions — (map)

        Options for a date field. Dates and times are specified in UTC (Coordinated Universal Time) according to IETF RFC3339: yyyy-mm-ddT00:00:00Z. Present if IndexFieldType specifies the field is of type date. All options are enabled by default.

        • DefaultValue — (String) A value to use for the field if the field isn't specified for a document.
        • SourceField — (String)

          A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

          Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

          The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

        • FacetEnabled — (Boolean)

          Whether facet information can be returned for the field.

        • SearchEnabled — (Boolean)

          Whether the contents of the field are searchable.

        • ReturnEnabled — (Boolean)

          Whether the contents of the field can be returned in the search results.

        • SortEnabled — (Boolean)

          Whether the field can be used to sort the search results.

      • LatLonOptions — (map)

        Options for a latlon field. A latlon field contains a location stored as a latitude and longitude value pair. Present if IndexFieldType specifies the field is of type latlon. All options are enabled by default.

        • DefaultValue — (String) A value to use for the field if the field isn't specified for a document.
        • SourceField — (String)

          A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

          Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

          The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

        • FacetEnabled — (Boolean)

          Whether facet information can be returned for the field.

        • SearchEnabled — (Boolean)

          Whether the contents of the field are searchable.

        • ReturnEnabled — (Boolean)

          Whether the contents of the field can be returned in the search results.

        • SortEnabled — (Boolean)

          Whether the field can be used to sort the search results.

      • IntArrayOptions — (map)

        Options for a field that contains an array of 64-bit signed integers. Present if IndexFieldType specifies the field is of type int-array. All options are enabled by default.

        • DefaultValue — (Integer) A value to use for the field if the field isn't specified for a document.
        • SourceFields — (String)

          A list of source fields to map to the field.

        • FacetEnabled — (Boolean)

          Whether facet information can be returned for the field.

        • SearchEnabled — (Boolean)

          Whether the contents of the field are searchable.

        • ReturnEnabled — (Boolean)

          Whether the contents of the field can be returned in the search results.

      • DoubleArrayOptions — (map)

        Options for a field that contains an array of double-precision 64-bit floating point values. Present if IndexFieldType specifies the field is of type double-array. All options are enabled by default.

        • DefaultValue — (Float) A value to use for the field if the field isn't specified for a document.
        • SourceFields — (String)

          A list of source fields to map to the field.

        • FacetEnabled — (Boolean)

          Whether facet information can be returned for the field.

        • SearchEnabled — (Boolean)

          Whether the contents of the field are searchable.

        • ReturnEnabled — (Boolean)

          Whether the contents of the field can be returned in the search results.

      • LiteralArrayOptions — (map)

        Options for a field that contains an array of literal strings. Present if IndexFieldType specifies the field is of type literal-array. All options are enabled by default.

        • DefaultValue — (String) A value to use for the field if the field isn't specified for a document.
        • SourceFields — (String)

          A list of source fields to map to the field.

        • FacetEnabled — (Boolean)

          Whether facet information can be returned for the field.

        • SearchEnabled — (Boolean)

          Whether the contents of the field are searchable.

        • ReturnEnabled — (Boolean)

          Whether the contents of the field can be returned in the search results.

      • TextArrayOptions — (map)

        Options for a field that contains an array of text strings. Present if IndexFieldType specifies the field is of type text-array. A text-array field is always searchable. All options are enabled by default.

        • DefaultValue — (String) A value to use for the field if the field isn't specified for a document.
        • SourceFields — (String)

          A list of source fields to map to the field.

        • ReturnEnabled — (Boolean)

          Whether the contents of the field can be returned in the search results.

        • HighlightEnabled — (Boolean)

          Whether highlights can be returned for the field.

        • AnalysisScheme — (String)

          The name of an analysis scheme for a text-array field.

      • DateArrayOptions — (map)

        Options for a field that contains an array of dates. Present if IndexFieldType specifies the field is of type date-array. All options are enabled by default.

        • DefaultValue — (String) A value to use for the field if the field isn't specified for a document.
        • SourceFields — (String)

          A list of source fields to map to the field.

        • FacetEnabled — (Boolean)

          Whether facet information can be returned for the field.

        • SearchEnabled — (Boolean)

          Whether the contents of the field are searchable.

        • ReturnEnabled — (Boolean)

          Whether the contents of the field can be returned in the search results.

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.

        • Optionsrequired — (map)

          Configuration information for a field in the index, including its name, type, and options. The supported options depend on the IndexFieldType.

          • IndexFieldNamerequired — (String)

            A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

            Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

            The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

          • IndexFieldTyperequired — (String)

            The type of field. The valid options for a field depend on the field type. For more information about the supported field types, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

            Possible values include:
            • "int"
            • "double"
            • "literal"
            • "text"
            • "date"
            • "latlon"
            • "int-array"
            • "double-array"
            • "literal-array"
            • "text-array"
            • "date-array"
          • IntOptions — (map)

            Options for a 64-bit signed integer field. Present if IndexFieldType specifies the field is of type int. All options are enabled by default.

            • DefaultValue — (Integer) A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.
            • SourceField — (String)

              The name of the source field to map to the field.

            • FacetEnabled — (Boolean)

              Whether facet information can be returned for the field.

            • SearchEnabled — (Boolean)

              Whether the contents of the field are searchable.

            • ReturnEnabled — (Boolean)

              Whether the contents of the field can be returned in the search results.

            • SortEnabled — (Boolean)

              Whether the field can be used to sort the search results.

          • DoubleOptions — (map)

            Options for a double-precision 64-bit floating point field. Present if IndexFieldType specifies the field is of type double. All options are enabled by default.

            • DefaultValue — (Float)

              A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.

            • SourceField — (String)

              The name of the source field to map to the field.

            • FacetEnabled — (Boolean)

              Whether facet information can be returned for the field.

            • SearchEnabled — (Boolean)

              Whether the contents of the field are searchable.

            • ReturnEnabled — (Boolean)

              Whether the contents of the field can be returned in the search results.

            • SortEnabled — (Boolean)

              Whether the field can be used to sort the search results.

          • LiteralOptions — (map)

            Options for literal field. Present if IndexFieldType specifies the field is of type literal. All options are enabled by default.

            • DefaultValue — (String) A value to use for the field if the field isn't specified for a document.
            • SourceField — (String)

              A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

              Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

              The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

            • FacetEnabled — (Boolean)

              Whether facet information can be returned for the field.

            • SearchEnabled — (Boolean)

              Whether the contents of the field are searchable.

            • ReturnEnabled — (Boolean)

              Whether the contents of the field can be returned in the search results.

            • SortEnabled — (Boolean)

              Whether the field can be used to sort the search results.

          • TextOptions — (map)

            Options for text field. Present if IndexFieldType specifies the field is of type text. A text field is always searchable. All options are enabled by default.

            • DefaultValue — (String) A value to use for the field if the field isn't specified for a document.
            • SourceField — (String)

              A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

              Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

              The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

            • ReturnEnabled — (Boolean)

              Whether the contents of the field can be returned in the search results.

            • SortEnabled — (Boolean)

              Whether the field can be used to sort the search results.

            • HighlightEnabled — (Boolean)

              Whether highlights can be returned for the field.

            • AnalysisScheme — (String)

              The name of an analysis scheme for a text field.

          • DateOptions — (map)

            Options for a date field. Dates and times are specified in UTC (Coordinated Universal Time) according to IETF RFC3339: yyyy-mm-ddT00:00:00Z. Present if IndexFieldType specifies the field is of type date. All options are enabled by default.

            • DefaultValue — (String) A value to use for the field if the field isn't specified for a document.
            • SourceField — (String)

              A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

              Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

              The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

            • FacetEnabled — (Boolean)

              Whether facet information can be returned for the field.

            • SearchEnabled — (Boolean)

              Whether the contents of the field are searchable.

            • ReturnEnabled — (Boolean)

              Whether the contents of the field can be returned in the search results.

            • SortEnabled — (Boolean)

              Whether the field can be used to sort the search results.

          • LatLonOptions — (map)

            Options for a latlon field. A latlon field contains a location stored as a latitude and longitude value pair. Present if IndexFieldType specifies the field is of type latlon. All options are enabled by default.

            • DefaultValue — (String) A value to use for the field if the field isn't specified for a document.
            • SourceField — (String)

              A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

              Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

              The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

            • FacetEnabled — (Boolean)

              Whether facet information can be returned for the field.

            • SearchEnabled — (Boolean)

              Whether the contents of the field are searchable.

            • ReturnEnabled — (Boolean)

              Whether the contents of the field can be returned in the search results.

            • SortEnabled — (Boolean)

              Whether the field can be used to sort the search results.

          • IntArrayOptions — (map)

            Options for a field that contains an array of 64-bit signed integers. Present if IndexFieldType specifies the field is of type int-array. All options are enabled by default.

            • DefaultValue — (Integer) A value to use for the field if the field isn't specified for a document.
            • SourceFields — (String)

              A list of source fields to map to the field.

            • FacetEnabled — (Boolean)

              Whether facet information can be returned for the field.

            • SearchEnabled — (Boolean)

              Whether the contents of the field are searchable.

            • ReturnEnabled — (Boolean)

              Whether the contents of the field can be returned in the search results.

          • DoubleArrayOptions — (map)

            Options for a field that contains an array of double-precision 64-bit floating point values. Present if IndexFieldType specifies the field is of type double-array. All options are enabled by default.

            • DefaultValue — (Float) A value to use for the field if the field isn't specified for a document.
            • SourceFields — (String)

              A list of source fields to map to the field.

            • FacetEnabled — (Boolean)

              Whether facet information can be returned for the field.

            • SearchEnabled — (Boolean)

              Whether the contents of the field are searchable.

            • ReturnEnabled — (Boolean)

              Whether the contents of the field can be returned in the search results.

          • LiteralArrayOptions — (map)

            Options for a field that contains an array of literal strings. Present if IndexFieldType specifies the field is of type literal-array. All options are enabled by default.

            • DefaultValue — (String) A value to use for the field if the field isn't specified for a document.
            • SourceFields — (String)

              A list of source fields to map to the field.

            • FacetEnabled — (Boolean)

              Whether facet information can be returned for the field.

            • SearchEnabled — (Boolean)

              Whether the contents of the field are searchable.

            • ReturnEnabled — (Boolean)

              Whether the contents of the field can be returned in the search results.

          • TextArrayOptions — (map)

            Options for a field that contains an array of text strings. Present if IndexFieldType specifies the field is of type text-array. A text-array field is always searchable. All options are enabled by default.

            • DefaultValue — (String) A value to use for the field if the field isn't specified for a document.
            • SourceFields — (String)

              A list of source fields to map to the field.

            • ReturnEnabled — (Boolean)

              Whether the contents of the field can be returned in the search results.

            • HighlightEnabled — (Boolean)

              Whether highlights can be returned for the field.

            • AnalysisScheme — (String)

              The name of an analysis scheme for a text-array field.

          • DateArrayOptions — (map)

            Options for a field that contains an array of dates. Present if IndexFieldType specifies the field is of type date-array. All options are enabled by default.

            • DefaultValue — (String) A value to use for the field if the field isn't specified for a document.
            • SourceFields — (String)

              A list of source fields to map to the field.

            • FacetEnabled — (Boolean)

              Whether facet information can be returned for the field.

            • SearchEnabled — (Boolean)

              Whether the contents of the field are searchable.

            • ReturnEnabled — (Boolean)

              Whether the contents of the field can be returned in the search results.

        • Statusrequired — (map)

          The status of domain configuration option.

          • CreationDaterequired — (Date)

            A timestamp for when this option was created.

          • UpdateDaterequired — (Date)

            A timestamp for when this option was last updated.

          • UpdateVersion — (Integer)

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

          • Staterequired — (String)

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

            • RequiresIndexDocuments: the option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
            • Processing: the option's latest value is in the process of being activated.
            • Active: the option's latest value is completely deployed.
            • FailedToValidate: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
            Possible values include:
            • "RequiresIndexDocuments"
            • "Processing"
            • "Active"
            • "FailedToValidate"
          • 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.

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

Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.

Service Reference:

Examples:

Calling the defineSuggester operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  Suggester: { /* required */
    DocumentSuggesterOptions: { /* required */
      SourceField: 'STRING_VALUE', /* required */
      FuzzyMatching: none | low | high,
      SortExpression: 'STRING_VALUE'
    },
    SuggesterName: 'STRING_VALUE' /* required */
  }
};
cloudsearch.defineSuggester(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 are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

    • Suggester — (map)

      Configuration information for a search suggester. Each suggester has a unique name and specifies the text field you want to use for suggestions. The following options can be configured for a suggester: FuzzyMatching, SortExpression.

      • SuggesterNamerequired — (String)

        Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).

      • DocumentSuggesterOptionsrequired — (map)

        Options for a search suggester.

        • SourceFieldrequired — (String)

          The name of the index field you want to use for suggestions.

        • FuzzyMatching — (String)

          The level of fuzziness allowed when suggesting matches for a string: none, low, or high. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.

          Possible values include:
          • "none"
          • "low"
          • "high"
        • SortExpression — (String)

          An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 231-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the _score value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.

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:

      • Suggester — (map)

        The value of a Suggester and its current status.

        • Optionsrequired — (map)

          Configuration information for a search suggester. Each suggester has a unique name and specifies the text field you want to use for suggestions. The following options can be configured for a suggester: FuzzyMatching, SortExpression.

          • SuggesterNamerequired — (String)

            Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).

          • DocumentSuggesterOptionsrequired — (map)

            Options for a search suggester.

            • SourceFieldrequired — (String)

              The name of the index field you want to use for suggestions.

            • FuzzyMatching — (String)

              The level of fuzziness allowed when suggesting matches for a string: none, low, or high. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.

              Possible values include:
              • "none"
              • "low"
              • "high"
            • SortExpression — (String)

              An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 231-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the _score value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.

        • Statusrequired — (map)

          The status of domain configuration option.

          • CreationDaterequired — (Date)

            A timestamp for when this option was created.

          • UpdateDaterequired — (Date)

            A timestamp for when this option was last updated.

          • UpdateVersion — (Integer)

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

          • Staterequired — (String)

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

            • RequiresIndexDocuments: the option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
            • Processing: the option's latest value is in the process of being activated.
            • Active: the option's latest value is completely deployed.
            • FailedToValidate: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
            Possible values include:
            • "RequiresIndexDocuments"
            • "Processing"
            • "Active"
            • "FailedToValidate"
          • 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.

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

Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.

Service Reference:

Examples:

Calling the deleteAnalysisScheme operation

var params = {
  AnalysisSchemeName: 'STRING_VALUE', /* required */
  DomainName: 'STRING_VALUE' /* required */
};
cloudsearch.deleteAnalysisScheme(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 are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

    • AnalysisSchemeName — (String)

      The name of the analysis scheme you want 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:

      • AnalysisScheme — (map)

        The status of the analysis scheme being deleted.

        • Optionsrequired — (map)

          Configuration information for an analysis scheme. Each analysis scheme has a unique name and specifies the language of the text to be processed. The following options can be configured for an analysis scheme: Synonyms, Stopwords, StemmingDictionary, JapaneseTokenizationDictionary and AlgorithmicStemming.

          • AnalysisSchemeNamerequired — (String)

            Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).

          • AnalysisSchemeLanguagerequired — (String)

            An IETF RFC 4646 language code or mul for multiple languages.

            Possible values include:
            • "ar"
            • "bg"
            • "ca"
            • "cs"
            • "da"
            • "de"
            • "el"
            • "en"
            • "es"
            • "eu"
            • "fa"
            • "fi"
            • "fr"
            • "ga"
            • "gl"
            • "he"
            • "hi"
            • "hu"
            • "hy"
            • "id"
            • "it"
            • "ja"
            • "ko"
            • "lv"
            • "mul"
            • "nl"
            • "no"
            • "pt"
            • "ro"
            • "ru"
            • "sv"
            • "th"
            • "tr"
            • "zh-Hans"
            • "zh-Hant"
          • AnalysisOptions — (map)

            Synonyms, stopwords, and stemming options for an analysis scheme. Includes tokenization dictionary for Japanese.

            • Synonyms — (String)

              A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see Synonyms in the Amazon CloudSearch Developer Guide.

            • Stopwords — (String)

              A JSON array of terms to ignore during indexing and searching. For example, ["a", "an", "the", "of"]. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported.

            • StemmingDictionary — (String)

              A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, {"term1": "stem1", "term2": "stem2", "term3": "stem3"}. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.

            • JapaneseTokenizationDictionary — (String)

              A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton. The Japanese tokenization dictionary enables you to override the default tokenization for selected terms. This is only valid for Japanese language fields.

            • AlgorithmicStemming — (String)

              The level of algorithmic stemming to perform: none, minimal, light, or full. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide

              Possible values include:
              • "none"
              • "minimal"
              • "light"
              • "full"
        • Statusrequired — (map)

          The status of domain configuration option.

          • CreationDaterequired — (Date)

            A timestamp for when this option was created.

          • UpdateDaterequired — (Date)

            A timestamp for when this option was last updated.

          • UpdateVersion — (Integer)

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

          • Staterequired — (String)

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

            • RequiresIndexDocuments: the option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
            • Processing: the option's latest value is in the process of being activated.
            • Active: the option's latest value is completely deployed.
            • FailedToValidate: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
            Possible values include:
            • "RequiresIndexDocuments"
            • "Processing"
            • "Active"
            • "FailedToValidate"
          • 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. Once a domain has been deleted, it cannot be recovered. For more information, see Deleting a Search Domain in the Amazon CloudSearch Developer Guide.

Service Reference:

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)

      The name of the domain you want to permanently 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:

      • DomainStatus — (map)

        The current status of the search domain.

        • DomainIdrequired — (String)

          An internally generated unique identifier for a domain.

        • DomainNamerequired — (String)

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

        • ARN — (String)

          The Amazon Resource Name (ARN) of the search domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

        • 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.

        • DocService — (map)

          The service endpoint for updating documents in a search domain.

          • Endpoint — (String)

            The endpoint to which service requests can be submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com.

        • SearchService — (map)

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

          • Endpoint — (String)

            The endpoint to which service requests can be submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com.

        • RequiresIndexDocumentsrequired — (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 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.

        • Limits — (map)
          • MaximumReplicationCountrequired — (Integer)
          • MaximumPartitionCountrequired — (Integer)

Returns:

  • (AWS.Request)

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

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

Removes an Expression from the search domain. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

Service Reference:

Examples:

Calling the deleteExpression operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  ExpressionName: 'STRING_VALUE' /* required */
};
cloudsearch.deleteExpression(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 are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

    • ExpressionName — (String)

      The name of the Expression 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:

      • Expression — (map)

        The status of the expression being deleted.

        • Optionsrequired — (map)

          The expression that is evaluated for sorting while processing a search request.

          • ExpressionNamerequired — (String)

            Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).

          • ExpressionValuerequired — (String)

            The expression to evaluate for sorting while processing a search request. The Expression syntax is based on JavaScript expressions. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

        • Statusrequired — (map)

          The status of domain configuration option.

          • CreationDaterequired — (Date)

            A timestamp for when this option was created.

          • UpdateDaterequired — (Date)

            A timestamp for when this option was last updated.

          • UpdateVersion — (Integer)

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

          • Staterequired — (String)

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

            • RequiresIndexDocuments: the option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
            • Processing: the option's latest value is in the process of being activated.
            • Active: the option's latest value is completely deployed.
            • FailedToValidate: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
            Possible values include:
            • "RequiresIndexDocuments"
            • "Processing"
            • "Active"
            • "FailedToValidate"
          • 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.

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

Removes an IndexField from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

Service Reference:

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 are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

    • IndexFieldName — (String)

      The name of the index field your want to remove from the domain's indexing options.

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 status of the index field being deleted.

        • Optionsrequired — (map)

          Configuration information for a field in the index, including its name, type, and options. The supported options depend on the IndexFieldType.

          • IndexFieldNamerequired — (String)

            A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

            Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

            The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

          • IndexFieldTyperequired — (String)

            The type of field. The valid options for a field depend on the field type. For more information about the supported field types, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

            Possible values include:
            • "int"
            • "double"
            • "literal"
            • "text"
            • "date"
            • "latlon"
            • "int-array"
            • "double-array"
            • "literal-array"
            • "text-array"
            • "date-array"
          • IntOptions — (map)

            Options for a 64-bit signed integer field. Present if IndexFieldType specifies the field is of type int. All options are enabled by default.

            • DefaultValue — (Integer) A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.
            • SourceField — (String)

              The name of the source field to map to the field.

            • FacetEnabled — (Boolean)

              Whether facet information can be returned for the field.

            • SearchEnabled — (Boolean)

              Whether the contents of the field are searchable.

            • ReturnEnabled — (Boolean)

              Whether the contents of the field can be returned in the search results.

            • SortEnabled — (Boolean)

              Whether the field can be used to sort the search results.

          • DoubleOptions — (map)

            Options for a double-precision 64-bit floating point field. Present if IndexFieldType specifies the field is of type double. All options are enabled by default.

            • DefaultValue — (Float)

              A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.

            • SourceField — (String)

              The name of the source field to map to the field.

            • FacetEnabled — (Boolean)

              Whether facet information can be returned for the field.

            • SearchEnabled — (Boolean)

              Whether the contents of the field are searchable.

            • ReturnEnabled — (Boolean)

              Whether the contents of the field can be returned in the search results.

            • SortEnabled — (Boolean)

              Whether the field can be used to sort the search results.

          • LiteralOptions — (map)

            Options for literal field. Present if IndexFieldType specifies the field is of type literal. All options are enabled by default.

            • DefaultValue — (String) A value to use for the field if the field isn't specified for a document.
            • SourceField — (String)

              A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

              Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

              The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

            • FacetEnabled — (Boolean)

              Whether facet information can be returned for the field.

            • SearchEnabled — (Boolean)

              Whether the contents of the field are searchable.

            • ReturnEnabled — (Boolean)

              Whether the contents of the field can be returned in the search results.

            • SortEnabled — (Boolean)

              Whether the field can be used to sort the search results.

          • TextOptions — (map)

            Options for text field. Present if IndexFieldType specifies the field is of type text. A text field is always searchable. All options are enabled by default.

            • DefaultValue — (String) A value to use for the field if the field isn't specified for a document.
            • SourceField — (String)

              A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

              Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

              The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

            • ReturnEnabled — (Boolean)

              Whether the contents of the field can be returned in the search results.

            • SortEnabled — (Boolean)

              Whether the field can be used to sort the search results.

            • HighlightEnabled — (Boolean)

              Whether highlights can be returned for the field.

            • AnalysisScheme — (String)

              The name of an analysis scheme for a text field.

          • DateOptions — (map)

            Options for a date field. Dates and times are specified in UTC (Coordinated Universal Time) according to IETF RFC3339: yyyy-mm-ddT00:00:00Z. Present if IndexFieldType specifies the field is of type date. All options are enabled by default.

            • DefaultValue — (String) A value to use for the field if the field isn't specified for a document.
            • SourceField — (String)

              A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

              Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

              The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

            • FacetEnabled — (Boolean)

              Whether facet information can be returned for the field.

            • SearchEnabled — (Boolean)

              Whether the contents of the field are searchable.

            • ReturnEnabled — (Boolean)

              Whether the contents of the field can be returned in the search results.

            • SortEnabled — (Boolean)

              Whether the field can be used to sort the search results.

          • LatLonOptions — (map)

            Options for a latlon field. A latlon field contains a location stored as a latitude and longitude value pair. Present if IndexFieldType specifies the field is of type latlon. All options are enabled by default.

            • DefaultValue — (String) A value to use for the field if the field isn't specified for a document.
            • SourceField — (String)

              A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

              Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

              The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

            • FacetEnabled — (Boolean)

              Whether facet information can be returned for the field.

            • SearchEnabled — (Boolean)

              Whether the contents of the field are searchable.

            • ReturnEnabled — (Boolean)

              Whether the contents of the field can be returned in the search results.

            • SortEnabled — (Boolean)

              Whether the field can be used to sort the search results.

          • IntArrayOptions — (map)

            Options for a field that contains an array of 64-bit signed integers. Present if IndexFieldType specifies the field is of type int-array. All options are enabled by default.

            • DefaultValue — (Integer) A value to use for the field if the field isn't specified for a document.
            • SourceFields — (String)

              A list of source fields to map to the field.

            • FacetEnabled — (Boolean)

              Whether facet information can be returned for the field.

            • SearchEnabled — (Boolean)

              Whether the contents of the field are searchable.

            • ReturnEnabled — (Boolean)

              Whether the contents of the field can be returned in the search results.

          • DoubleArrayOptions — (map)

            Options for a field that contains an array of double-precision 64-bit floating point values. Present if IndexFieldType specifies the field is of type double-array. All options are enabled by default.

            • DefaultValue — (Float) A value to use for the field if the field isn't specified for a document.
            • SourceFields — (String)

              A list of source fields to map to the field.

            • FacetEnabled — (Boolean)

              Whether facet information can be returned for the field.

            • SearchEnabled — (Boolean)

              Whether the contents of the field are searchable.

            • ReturnEnabled — (Boolean)

              Whether the contents of the field can be returned in the search results.

          • LiteralArrayOptions — (map)

            Options for a field that contains an array of literal strings. Present if IndexFieldType specifies the field is of type literal-array. All options are enabled by default.

            • DefaultValue — (String) A value to use for the field if the field isn't specified for a document.
            • SourceFields — (String)

              A list of source fields to map to the field.

            • FacetEnabled — (Boolean)

              Whether facet information can be returned for the field.

            • SearchEnabled — (Boolean)

              Whether the contents of the field are searchable.

            • ReturnEnabled — (Boolean)

              Whether the contents of the field can be returned in the search results.

          • TextArrayOptions — (map)

            Options for a field that contains an array of text strings. Present if IndexFieldType specifies the field is of type text-array. A text-array field is always searchable. All options are enabled by default.

            • DefaultValue — (String) A value to use for the field if the field isn't specified for a document.
            • SourceFields — (String)

              A list of source fields to map to the field.

            • ReturnEnabled — (Boolean)

              Whether the contents of the field can be returned in the search results.

            • HighlightEnabled — (Boolean)

              Whether highlights can be returned for the field.

            • AnalysisScheme — (String)

              The name of an analysis scheme for a text-array field.

          • DateArrayOptions — (map)

            Options for a field that contains an array of dates. Present if IndexFieldType specifies the field is of type date-array. All options are enabled by default.

            • DefaultValue — (String) A value to use for the field if the field isn't specified for a document.
            • SourceFields — (String)

              A list of source fields to map to the field.

            • FacetEnabled — (Boolean)

              Whether facet information can be returned for the field.

            • SearchEnabled — (Boolean)

              Whether the contents of the field are searchable.

            • ReturnEnabled — (Boolean)

              Whether the contents of the field can be returned in the search results.

        • Statusrequired — (map)

          The status of domain configuration option.

          • CreationDaterequired — (Date)

            A timestamp for when this option was created.

          • UpdateDaterequired — (Date)

            A timestamp for when this option was last updated.

          • UpdateVersion — (Integer)

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

          • Staterequired — (String)

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

            • RequiresIndexDocuments: the option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
            • Processing: the option's latest value is in the process of being activated.
            • Active: the option's latest value is completely deployed.
            • FailedToValidate: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
            Possible values include:
            • "RequiresIndexDocuments"
            • "Processing"
            • "Active"
            • "FailedToValidate"
          • 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.

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

Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.

Service Reference:

Examples:

Calling the deleteSuggester operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  SuggesterName: 'STRING_VALUE' /* required */
};
cloudsearch.deleteSuggester(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 are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

    • SuggesterName — (String)

      Specifies the name of the suggester you want 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:

      • Suggester — (map)

        The status of the suggester being deleted.

        • Optionsrequired — (map)

          Configuration information for a search suggester. Each suggester has a unique name and specifies the text field you want to use for suggestions. The following options can be configured for a suggester: FuzzyMatching, SortExpression.

          • SuggesterNamerequired — (String)

            Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).

          • DocumentSuggesterOptionsrequired — (map)

            Options for a search suggester.

            • SourceFieldrequired — (String)

              The name of the index field you want to use for suggestions.

            • FuzzyMatching — (String)

              The level of fuzziness allowed when suggesting matches for a string: none, low, or high. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.

              Possible values include:
              • "none"
              • "low"
              • "high"
            • SortExpression — (String)

              An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 231-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the _score value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.

        • Statusrequired — (map)

          The status of domain configuration option.

          • CreationDaterequired — (Date)

            A timestamp for when this option was created.

          • UpdateDaterequired — (Date)

            A timestamp for when this option was last updated.

          • UpdateVersion — (Integer)

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

          • Staterequired — (String)

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

            • RequiresIndexDocuments: the option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
            • Processing: the option's latest value is in the process of being activated.
            • Active: the option's latest value is completely deployed.
            • FailedToValidate: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
            Possible values include:
            • "RequiresIndexDocuments"
            • "Processing"
            • "Active"
            • "FailedToValidate"
          • 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.

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

Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing options for a text field. Can be limited to specific analysis schemes by name. By default, shows all analysis schemes and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.

Service Reference:

Examples:

Calling the describeAnalysisSchemes operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  AnalysisSchemeNames: [
    'STRING_VALUE',
    /* more items */
  ],
  Deployed: true || false
};
cloudsearch.describeAnalysisSchemes(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.

    • AnalysisSchemeNames — (Array<String>)

      The analysis schemes you want to describe.

    • Deployed — (Boolean)

      Whether to display the deployed configuration (true) or include any pending changes (false). Defaults 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:

      • AnalysisSchemes — (Array<map>)

        The analysis scheme descriptions.

        • Optionsrequired — (map)

          Configuration information for an analysis scheme. Each analysis scheme has a unique name and specifies the language of the text to be processed. The following options can be configured for an analysis scheme: Synonyms, Stopwords, StemmingDictionary, JapaneseTokenizationDictionary and AlgorithmicStemming.

          • AnalysisSchemeNamerequired — (String)

            Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).

          • AnalysisSchemeLanguagerequired — (String)

            An IETF RFC 4646 language code or mul for multiple languages.

            Possible values include:
            • "ar"
            • "bg"
            • "ca"
            • "cs"
            • "da"
            • "de"
            • "el"
            • "en"
            • "es"
            • "eu"
            • "fa"
            • "fi"
            • "fr"
            • "ga"
            • "gl"
            • "he"
            • "hi"
            • "hu"
            • "hy"
            • "id"
            • "it"
            • "ja"
            • "ko"
            • "lv"
            • "mul"
            • "nl"
            • "no"
            • "pt"
            • "ro"
            • "ru"
            • "sv"
            • "th"
            • "tr"
            • "zh-Hans"
            • "zh-Hant"
          • AnalysisOptions — (map)

            Synonyms, stopwords, and stemming options for an analysis scheme. Includes tokenization dictionary for Japanese.

            • Synonyms — (String)

              A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see Synonyms in the Amazon CloudSearch Developer Guide.

            • Stopwords — (String)

              A JSON array of terms to ignore during indexing and searching. For example, ["a", "an", "the", "of"]. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported.

            • StemmingDictionary — (String)

              A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, {"term1": "stem1", "term2": "stem2", "term3": "stem3"}. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.

            • JapaneseTokenizationDictionary — (String)

              A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton. The Japanese tokenization dictionary enables you to override the default tokenization for selected terms. This is only valid for Japanese language fields.

            • AlgorithmicStemming — (String)

              The level of algorithmic stemming to perform: none, minimal, light, or full. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide

              Possible values include:
              • "none"
              • "minimal"
              • "light"
              • "full"
        • Statusrequired — (map)

          The status of domain configuration option.

          • CreationDaterequired — (Date)

            A timestamp for when this option was created.

          • UpdateDaterequired — (Date)

            A timestamp for when this option was last updated.

          • UpdateVersion — (Integer)

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

          • Staterequired — (String)

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

            • RequiresIndexDocuments: the option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
            • Processing: the option's latest value is in the process of being activated.
            • Active: the option's latest value is completely deployed.
            • FailedToValidate: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
            Possible values include:
            • "RequiresIndexDocuments"
            • "Processing"
            • "Active"
            • "FailedToValidate"
          • 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.

Service Reference:

Examples:

Calling the describeAvailabilityOptions operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  Deployed: true || false
};
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.

    • Deployed — (Boolean)

      Whether to display the deployed configuration (true) or include any pending changes (false). Defaults 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 availability options configured for the domain. Indicates whether Multi-AZ is enabled for the domain.

        • Optionsrequired — (Boolean)

          The availability options configured for the domain.

        • Statusrequired — (map)

          The status of domain configuration option.

          • CreationDaterequired — (Date)

            A timestamp for when this option was created.

          • UpdateDaterequired — (Date)

            A timestamp for when this option was last updated.

          • UpdateVersion — (Integer)

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

          • Staterequired — (String)

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

            • RequiresIndexDocuments: the option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
            • Processing: the option's latest value is in the process of being activated.
            • Active: the option's latest value is completely deployed.
            • FailedToValidate: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
            Possible values include:
            • "RequiresIndexDocuments"
            • "Processing"
            • "Active"
            • "FailedToValidate"
          • 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. To get the number of searchable documents in a domain, use the console or submit a matchall request to your domain's search endpoint: q=matchall&amp;q.parser=structured&amp;size=0. For more information, see Getting Information about a Search Domain in the Amazon CloudSearch Developer Guide.

Service Reference:

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

      The names of the domains you want to include in the response.

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

        A list that contains the status of each requested domain.

        • DomainIdrequired — (String)

          An internally generated unique identifier for a domain.

        • DomainNamerequired — (String)

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

        • ARN — (String)

          The Amazon Resource Name (ARN) of the search domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

        • 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.

        • DocService — (map)

          The service endpoint for updating documents in a search domain.

          • Endpoint — (String)

            The endpoint to which service requests can be submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com.

        • SearchService — (map)

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

          • Endpoint — (String)

            The endpoint to which service requests can be submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com.

        • RequiresIndexDocumentsrequired — (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 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.

        • Limits — (map)
          • MaximumReplicationCountrequired — (Integer)
          • MaximumPartitionCountrequired — (Integer)

Returns:

  • (AWS.Request)

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

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

Gets the expressions configured for the search domain. Can be limited to specific expressions by name. By default, shows all expressions and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

Service Reference:

Examples:

Calling the describeExpressions operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  Deployed: true || false,
  ExpressionNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
cloudsearch.describeExpressions(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.

    • ExpressionNames — (Array<String>)

      Limits the DescribeExpressions response to the specified expressions. If not specified, all expressions are shown.

    • Deployed — (Boolean)

      Whether to display the deployed configuration (true) or include any pending changes (false). Defaults 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:

      • Expressions — (Array<map>)

        The expressions configured for the domain.

        • Optionsrequired — (map)

          The expression that is evaluated for sorting while processing a search request.

          • ExpressionNamerequired — (String)

            Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).

          • ExpressionValuerequired — (String)

            The expression to evaluate for sorting while processing a search request. The Expression syntax is based on JavaScript expressions. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

        • Statusrequired — (map)

          The status of domain configuration option.

          • CreationDaterequired — (Date)

            A timestamp for when this option was created.

          • UpdateDaterequired — (Date)

            A timestamp for when this option was last updated.

          • UpdateVersion — (Integer)

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

          • Staterequired — (String)

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

            • RequiresIndexDocuments: the option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
            • Processing: the option's latest value is in the process of being activated.
            • Active: the option's latest value is completely deployed.
            • FailedToValidate: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
            Possible values include:
            • "RequiresIndexDocuments"
            • "Processing"
            • "Active"
            • "FailedToValidate"
          • 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.

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

Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. By default, shows all fields and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Domain Information in the Amazon CloudSearch Developer Guide.

Service Reference:

Examples:

Calling the describeIndexFields operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  Deployed: true || false,
  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)

      The name of the domain you want to describe.

    • FieldNames — (Array<String>)

      A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.

    • Deployed — (Boolean)

      Whether to display the deployed configuration (true) or include any pending changes (false). Defaults 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:

      • IndexFields — (Array<map>)

        The index fields configured for the domain.

        • Optionsrequired — (map)

          Configuration information for a field in the index, including its name, type, and options. The supported options depend on the IndexFieldType.

          • IndexFieldNamerequired — (String)

            A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

            Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

            The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

          • IndexFieldTyperequired — (String)

            The type of field. The valid options for a field depend on the field type. For more information about the supported field types, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

            Possible values include:
            • "int"
            • "double"
            • "literal"
            • "text"
            • "date"
            • "latlon"
            • "int-array"
            • "double-array"
            • "literal-array"
            • "text-array"
            • "date-array"
          • IntOptions — (map)

            Options for a 64-bit signed integer field. Present if IndexFieldType specifies the field is of type int. All options are enabled by default.

            • DefaultValue — (Integer) A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.
            • SourceField — (String)

              The name of the source field to map to the field.

            • FacetEnabled — (Boolean)

              Whether facet information can be returned for the field.

            • SearchEnabled — (Boolean)

              Whether the contents of the field are searchable.

            • ReturnEnabled — (Boolean)

              Whether the contents of the field can be returned in the search results.

            • SortEnabled — (Boolean)

              Whether the field can be used to sort the search results.

          • DoubleOptions — (map)

            Options for a double-precision 64-bit floating point field. Present if IndexFieldType specifies the field is of type double. All options are enabled by default.

            • DefaultValue — (Float)

              A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.

            • SourceField — (String)

              The name of the source field to map to the field.

            • FacetEnabled — (Boolean)

              Whether facet information can be returned for the field.

            • SearchEnabled — (Boolean)

              Whether the contents of the field are searchable.

            • ReturnEnabled — (Boolean)

              Whether the contents of the field can be returned in the search results.

            • SortEnabled — (Boolean)

              Whether the field can be used to sort the search results.

          • LiteralOptions — (map)

            Options for literal field. Present if IndexFieldType specifies the field is of type literal. All options are enabled by default.

            • DefaultValue — (String) A value to use for the field if the field isn't specified for a document.
            • SourceField — (String)

              A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

              Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

              The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

            • FacetEnabled — (Boolean)

              Whether facet information can be returned for the field.

            • SearchEnabled — (Boolean)

              Whether the contents of the field are searchable.

            • ReturnEnabled — (Boolean)

              Whether the contents of the field can be returned in the search results.

            • SortEnabled — (Boolean)

              Whether the field can be used to sort the search results.

          • TextOptions — (map)

            Options for text field. Present if IndexFieldType specifies the field is of type text. A text field is always searchable. All options are enabled by default.

            • DefaultValue — (String) A value to use for the field if the field isn't specified for a document.
            • SourceField — (String)

              A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

              Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

              The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

            • ReturnEnabled — (Boolean)

              Whether the contents of the field can be returned in the search results.

            • SortEnabled — (Boolean)

              Whether the field can be used to sort the search results.

            • HighlightEnabled — (Boolean)

              Whether highlights can be returned for the field.

            • AnalysisScheme — (String)

              The name of an analysis scheme for a text field.

          • DateOptions — (map)

            Options for a date field. Dates and times are specified in UTC (Coordinated Universal Time) according to IETF RFC3339: yyyy-mm-ddT00:00:00Z. Present if IndexFieldType specifies the field is of type date. All options are enabled by default.

            • DefaultValue — (String) A value to use for the field if the field isn't specified for a document.
            • SourceField — (String)

              A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

              Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

              The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

            • FacetEnabled — (Boolean)

              Whether facet information can be returned for the field.

            • SearchEnabled — (Boolean)

              Whether the contents of the field are searchable.

            • ReturnEnabled — (Boolean)

              Whether the contents of the field can be returned in the search results.

            • SortEnabled — (Boolean)

              Whether the field can be used to sort the search results.

          • LatLonOptions — (map)

            Options for a latlon field. A latlon field contains a location stored as a latitude and longitude value pair. Present if IndexFieldType specifies the field is of type latlon. All options are enabled by default.

            • DefaultValue — (String) A value to use for the field if the field isn't specified for a document.
            • SourceField — (String)

              A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

              Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

              The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

            • FacetEnabled — (Boolean)

              Whether facet information can be returned for the field.

            • SearchEnabled — (Boolean)

              Whether the contents of the field are searchable.

            • ReturnEnabled — (Boolean)

              Whether the contents of the field can be returned in the search results.

            • SortEnabled — (Boolean)

              Whether the field can be used to sort the search results.

          • IntArrayOptions — (map)

            Options for a field that contains an array of 64-bit signed integers. Present if IndexFieldType specifies the field is of type int-array. All options are enabled by default.

            • DefaultValue — (Integer) A value to use for the field if the field isn't specified for a document.
            • SourceFields — (String)

              A list of source fields to map to the field.

            • FacetEnabled — (Boolean)

              Whether facet information can be returned for the field.

            • SearchEnabled — (Boolean)

              Whether the contents of the field are searchable.

            • ReturnEnabled — (Boolean)

              Whether the contents of the field can be returned in the search results.

          • DoubleArrayOptions — (map)

            Options for a field that contains an array of double-precision 64-bit floating point values. Present if IndexFieldType specifies the field is of type double-array. All options are enabled by default.

            • DefaultValue — (Float) A value to use for the field if the field isn't specified for a document.
            • SourceFields — (String)

              A list of source fields to map to the field.

            • FacetEnabled — (Boolean)

              Whether facet information can be returned for the field.

            • SearchEnabled — (Boolean)

              Whether the contents of the field are searchable.

            • ReturnEnabled — (Boolean)

              Whether the contents of the field can be returned in the search results.

          • LiteralArrayOptions — (map)

            Options for a field that contains an array of literal strings. Present if IndexFieldType specifies the field is of type literal-array. All options are enabled by default.

            • DefaultValue — (String) A value to use for the field if the field isn't specified for a document.
            • SourceFields — (String)

              A list of source fields to map to the field.

            • FacetEnabled — (Boolean)

              Whether facet information can be returned for the field.

            • SearchEnabled — (Boolean)

              Whether the contents of the field are searchable.

            • ReturnEnabled — (Boolean)

              Whether the contents of the field can be returned in the search results.

          • TextArrayOptions — (map)

            Options for a field that contains an array of text strings. Present if IndexFieldType specifies the field is of type text-array. A text-array field is always searchable. All options are enabled by default.

            • DefaultValue — (String) A value to use for the field if the field isn't specified for a document.
            • SourceFields — (String)

              A list of source fields to map to the field.

            • ReturnEnabled — (Boolean)

              Whether the contents of the field can be returned in the search results.

            • HighlightEnabled — (Boolean)

              Whether highlights can be returned for the field.

            • AnalysisScheme — (String)

              The name of an analysis scheme for a text-array field.

          • DateArrayOptions — (map)

            Options for a field that contains an array of dates. Present if IndexFieldType specifies the field is of type date-array. All options are enabled by default.

            • DefaultValue — (String) A value to use for the field if the field isn't specified for a document.
            • SourceFields — (String)

              A list of source fields to map to the field.

            • FacetEnabled — (Boolean)

              Whether facet information can be returned for the field.

            • SearchEnabled — (Boolean)

              Whether the contents of the field are searchable.

            • ReturnEnabled — (Boolean)

              Whether the contents of the field can be returned in the search results.

        • Statusrequired — (map)

          The status of domain configuration option.

          • CreationDaterequired — (Date)

            A timestamp for when this option was created.

          • UpdateDaterequired — (Date)

            A timestamp for when this option was last updated.

          • UpdateVersion — (Integer)

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

          • Staterequired — (String)

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

            • RequiresIndexDocuments: the option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
            • Processing: the option's latest value is in the process of being activated.
            • Active: the option's latest value is completely deployed.
            • FailedToValidate: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
            Possible values include:
            • "RequiresIndexDocuments"
            • "Processing"
            • "Active"
            • "FailedToValidate"
          • 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.

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

Gets the scaling parameters configured for a domain. A domain's scaling parameters specify the desired search instance type and replication count. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide.

Service Reference:

Examples:

Calling the describeScalingParameters operation

var params = {
  DomainName: 'STRING_VALUE' /* required */
};
cloudsearch.describeScalingParameters(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 are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

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:

      • ScalingParameters — (map)

        The status and configuration of a search domain's scaling parameters.

        • Optionsrequired — (map)

          The desired instance type and desired number of replicas of each index partition.

          • DesiredInstanceType — (String)

            The instance type that you want to preconfigure for your domain. For example, search.m1.small.

            Possible values include:
            • "search.m1.small"
            • "search.m1.large"
            • "search.m2.xlarge"
            • "search.m2.2xlarge"
            • "search.m3.medium"
            • "search.m3.large"
            • "search.m3.xlarge"
            • "search.m3.2xlarge"
          • DesiredReplicationCount — (Integer)

            The number of replicas you want to preconfigure for each index partition.

          • DesiredPartitionCount — (Integer)

            The number of partitions you want to preconfigure for your domain. Only valid when you select m2.2xlarge as the desired instance type.

        • Statusrequired — (map)

          The status of domain configuration option.

          • CreationDaterequired — (Date)

            A timestamp for when this option was created.

          • UpdateDaterequired — (Date)

            A timestamp for when this option was last updated.

          • UpdateVersion — (Integer)

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

          • Staterequired — (String)

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

            • RequiresIndexDocuments: the option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
            • Processing: the option's latest value is in the process of being activated.
            • Active: the option's latest value is completely deployed.
            • FailedToValidate: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
            Possible values include:
            • "RequiresIndexDocuments"
            • "Processing"
            • "Active"
            • "FailedToValidate"
          • 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 access policies that control access to the domain's document and search endpoints. 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 Access for a Search Domain in the Amazon CloudSearch Developer Guide.

Service Reference:

Examples:

Calling the describeServiceAccessPolicies operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  Deployed: true || false
};
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)

      The name of the domain you want to describe.

    • Deployed — (Boolean)

      Whether to display the deployed configuration (true) or include any pending changes (false). Defaults 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:

      • AccessPolicies — (map)

        The access rules configured for the domain specified in the request.

        • Optionsrequired — (String)

          Access rules for a domain's document or search service endpoints. For more information, see Configuring Access for a Search Domain in the Amazon CloudSearch Developer Guide. The maximum size of a policy document is 100 KB.

        • Statusrequired — (map)

          The status of domain configuration option.

          • CreationDaterequired — (Date)

            A timestamp for when this option was created.

          • UpdateDaterequired — (Date)

            A timestamp for when this option was last updated.

          • UpdateVersion — (Integer)

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

          • Staterequired — (String)

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

            • RequiresIndexDocuments: the option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
            • Processing: the option's latest value is in the process of being activated.
            • Active: the option's latest value is completely deployed.
            • FailedToValidate: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
            Possible values include:
            • "RequiresIndexDocuments"
            • "Processing"
            • "Active"
            • "FailedToValidate"
          • 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.

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

Gets the suggesters configured for a domain. A suggester enables you to display possible matches before users finish typing their queries. Can be limited to specific suggesters by name. By default, shows all suggesters and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.

Service Reference:

Examples:

Calling the describeSuggesters operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  Deployed: true || false,
  SuggesterNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
cloudsearch.describeSuggesters(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.

    • SuggesterNames — (Array<String>)

      The suggesters you want to describe.

    • Deployed — (Boolean)

      Whether to display the deployed configuration (true) or include any pending changes (false). Defaults 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:

      • Suggesters — (Array<map>)

        The suggesters configured for the domain specified in the request.

        • Optionsrequired — (map)

          Configuration information for a search suggester. Each suggester has a unique name and specifies the text field you want to use for suggestions. The following options can be configured for a suggester: FuzzyMatching, SortExpression.

          • SuggesterNamerequired — (String)

            Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).

          • DocumentSuggesterOptionsrequired — (map)

            Options for a search suggester.

            • SourceFieldrequired — (String)

              The name of the index field you want to use for suggestions.

            • FuzzyMatching — (String)

              The level of fuzziness allowed when suggesting matches for a string: none, low, or high. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.

              Possible values include:
              • "none"
              • "low"
              • "high"
            • SortExpression — (String)

              An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 231-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the _score value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.

        • Statusrequired — (map)

          The status of domain configuration option.

          • CreationDaterequired — (Date)

            A timestamp for when this option was created.

          • UpdateDaterequired — (Date)

            A timestamp for when this option was last updated.

          • UpdateVersion — (Integer)

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

          • Staterequired — (String)

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

            • RequiresIndexDocuments: the option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
            • Processing: the option's latest value is in the process of being activated.
            • Active: the option's latest value is completely deployed.
            • FailedToValidate: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
            Possible values include:
            • "RequiresIndexDocuments"
            • "Processing"
            • "Active"
            • "FailedToValidate"
          • 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 indexing options. This operation must be invoked to activate options whose OptionStatus is RequiresIndexDocuments.

Service Reference:

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 are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

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 indexed.

Returns:

  • (AWS.Request)

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

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

Lists all search domains owned by an account.

Service Reference:

Examples:

Calling the listDomainNames operation

cloudsearch.listDomainNames(function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

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:

      • DomainNames — (map<String>)

        The names of the search domains owned by an account.

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.

Service Reference:

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 are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

    • 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.

        • Optionsrequired — (Boolean)

          The availability options configured for the domain.

        • Statusrequired — (map)

          The status of domain configuration option.

          • CreationDaterequired — (Date)

            A timestamp for when this option was created.

          • UpdateDaterequired — (Date)

            A timestamp for when this option was last updated.

          • UpdateVersion — (Integer)

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

          • Staterequired — (String)

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

            • RequiresIndexDocuments: the option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
            • Processing: the option's latest value is in the process of being activated.
            • Active: the option's latest value is completely deployed.
            • FailedToValidate: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
            Possible values include:
            • "RequiresIndexDocuments"
            • "Processing"
            • "Active"
            • "FailedToValidate"
          • 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.

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

Configures scaling parameters for a domain. A domain's scaling parameters specify the desired search instance type and replication count. Amazon CloudSearch will still automatically scale your domain based on the volume of data and traffic, but not below the desired instance type and replication count. If the Multi-AZ option is enabled, these values control the resources used per Availability Zone. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide.

Service Reference:

Examples:

Calling the updateScalingParameters operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  ScalingParameters: { /* required */
    DesiredInstanceType: search.m1.small | search.m1.large | search.m2.xlarge | search.m2.2xlarge | search.m3.medium | search.m3.large | search.m3.xlarge | search.m3.2xlarge,
    DesiredPartitionCount: 0,
    DesiredReplicationCount: 0
  }
};
cloudsearch.updateScalingParameters(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 are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

    • ScalingParameters — (map)

      The desired instance type and desired number of replicas of each index partition.

      • DesiredInstanceType — (String)

        The instance type that you want to preconfigure for your domain. For example, search.m1.small.

        Possible values include:
        • "search.m1.small"
        • "search.m1.large"
        • "search.m2.xlarge"
        • "search.m2.2xlarge"
        • "search.m3.medium"
        • "search.m3.large"
        • "search.m3.xlarge"
        • "search.m3.2xlarge"
      • DesiredReplicationCount — (Integer)

        The number of replicas you want to preconfigure for each index partition.

      • DesiredPartitionCount — (Integer)

        The number of partitions you want to preconfigure for your domain. Only valid when you select m2.2xlarge as the desired instance type.

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:

      • ScalingParameters — (map)

        The status and configuration of a search domain's scaling parameters.

        • Optionsrequired — (map)

          The desired instance type and desired number of replicas of each index partition.

          • DesiredInstanceType — (String)

            The instance type that you want to preconfigure for your domain. For example, search.m1.small.

            Possible values include:
            • "search.m1.small"
            • "search.m1.large"
            • "search.m2.xlarge"
            • "search.m2.2xlarge"
            • "search.m3.medium"
            • "search.m3.large"
            • "search.m3.xlarge"
            • "search.m3.2xlarge"
          • DesiredReplicationCount — (Integer)

            The number of replicas you want to preconfigure for each index partition.

          • DesiredPartitionCount — (Integer)

            The number of partitions you want to preconfigure for your domain. Only valid when you select m2.2xlarge as the desired instance type.

        • Statusrequired — (map)

          The status of domain configuration option.

          • CreationDaterequired — (Date)

            A timestamp for when this option was created.

          • UpdateDaterequired — (Date)

            A timestamp for when this option was last updated.

          • UpdateVersion — (Integer)

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

          • Staterequired — (String)

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

            • RequiresIndexDocuments: the option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
            • Processing: the option's latest value is in the process of being activated.
            • Active: the option's latest value is completely deployed.
            • FailedToValidate: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
            Possible values include:
            • "RequiresIndexDocuments"
            • "Processing"
            • "Active"
            • "FailedToValidate"
          • 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 access rules that control access to the domain's document and search endpoints. For more information, see Configuring Access for an Amazon CloudSearch Domain.

Service Reference:

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 are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

    • AccessPolicies — (String)

      The access rules you want to configure. These rules replace any existing rules.

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)

        The access rules configured for the domain.

        • Optionsrequired — (String)

          Access rules for a domain's document or search service endpoints. For more information, see Configuring Access for a Search Domain in the Amazon CloudSearch Developer Guide. The maximum size of a policy document is 100 KB.

        • Statusrequired — (map)

          The status of domain configuration option.

          • CreationDaterequired — (Date)

            A timestamp for when this option was created.

          • UpdateDaterequired — (Date)

            A timestamp for when this option was last updated.

          • UpdateVersion — (Integer)

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

          • Staterequired — (String)

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

            • RequiresIndexDocuments: the option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
            • Processing: the option's latest value is in the process of being activated.
            • Active: the option's latest value is completely deployed.
            • FailedToValidate: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
            Possible values include:
            • "RequiresIndexDocuments"
            • "Processing"
            • "Active"
            • "FailedToValidate"
          • 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.