client.rb in aws-sdk-cloudsearchdomain-1.35.0

- old
+ new

@@ -230,10 +230,15 @@
     #       functionality of `standard` mode along with automatic client side
     #       throttling.  This is a provisional mode that may change behavior
     #       in the future.
     #
     #
+    #   @option options [String] :sdk_ua_app_id
+    #     A unique and opaque application ID that is appended to the
+    #     User-Agent header as app/<sdk_ua_app_id>. It should have a
+    #     maximum length of 50.
+    #
     #   @option options [String] :secret_access_key
     #
     #   @option options [String] :session_token
     #
     #   @option options [String] :sigv4_region
@@ -319,20 +324,20 @@
 
     # Retrieves a list of documents that match the specified search
     # criteria. How you specify the search criteria depends on which query
     # parser you use. Amazon CloudSearch supports four query parsers:
     #
-    # * `simple`\: search all `text` and `text-array` fields for the
+    # * `simple`: search all `text` and `text-array` fields for the
     #   specified string. Search for phrases, individual terms, and
     #   prefixes.
-    # * `structured`\: search specific fields, construct compound queries
+    # * `structured`: search specific fields, construct compound queries
     #   using Boolean operators, and use advanced features such as term
     #   boosting and proximity searching.
-    # * `lucene`\: specify search criteria using the Apache Lucene query
+    # * `lucene`: specify search criteria using the Apache Lucene query
     #   parser syntax.
-    # * `dismax`\: specify search criteria using the simplified subset of
-    #   the Apache Lucene query parser syntax defined by the DisMax query
+    # * `dismax`: specify search criteria using the simplified subset of the
+    #   Apache Lucene query parser syntax defined by the DisMax query
     #   parser.
     #
     # For more information, see [Searching Your Data][1] in the *Amazon
     # CloudSearch Developer Guide*.
     #
@@ -469,20 +474,20 @@
     #   using the form
     #   `\{"FIELD":\{"OPTION":VALUE,"OPTION:"STRING"\},"FIELD":\{"OPTION":VALUE,"OPTION":"STRING"\}\}`.
     #
     #   You can specify the following highlight options:
     #
-    #   * `format`\: specifies the format of the data in the text field:
-    #     `text` or `html`. When data is returned as HTML, all
-    #     non-alphanumeric characters are encoded. The default is `html`.
-    #   * `max_phrases`\: specifies the maximum number of occurrences of the
+    #   * `format`: specifies the format of the data in the text field: `text`
+    #     or `html`. When data is returned as HTML, all non-alphanumeric
+    #     characters are encoded. The default is `html`.
+    #   * `max_phrases`: specifies the maximum number of occurrences of the
     #     search term(s) you want to highlight. By default, the first
     #     occurrence is highlighted.
-    #   * `pre_tag`\: specifies the string to prepend to an occurrence of a
+    #   * `pre_tag`: specifies the string to prepend to an occurrence of a
     #     search term. The default for HTML highlights is `&lt;em&gt;`. The
     #     default for text highlights is `*`.
-    #   * `post_tag`\: specifies the string to append to an occurrence of a
+    #   * `post_tag`: specifies the string to append to an occurrence of a
     #     search term. The default for HTML highlights is `&lt;/em&gt;`. The
     #     default for text highlights is `*`.
     #
     #   If no highlight options are specified for a field, the returned field
     #   text is treated as HTML and the first match is highlighted with
@@ -528,11 +533,11 @@
     #   parameter. You specify the options in JSON using the following form
     #   `\{"OPTION1":"VALUE1","OPTION2":VALUE2"..."OPTIONN":"VALUEN"\}.`
     #
     #   The options you can configure vary according to which parser you use:
     #
-    #   * `defaultOperator`\: The default operator used to combine individual
+    #   * `defaultOperator`: The default operator used to combine individual
     #     terms in the search string. For example: `defaultOperator: 'or'`.
     #     For the `dismax` parser, you specify a percentage that represents
     #     the percentage of terms in the search string (rounded down) that
     #     must match, rather than a default operator. A value of `0%` is the
     #     equivalent to OR, and a value of `100%` is equivalent to AND. The
@@ -540,11 +545,11 @@
     #     by the percent (%) symbol. For example, `defaultOperator: 50%`.
     #     Valid values: `and`, `or`, a percentage in the range 0%-100%
     #     (`dismax`). Default: `and` (`simple`, `structured`, `lucene`) or
     #     `100` (`dismax`). Valid for: `simple`, `structured`, `lucene`, and
     #     `dismax`.
-    #   * `fields`\: An array of the fields to search when no fields are
+    #   * `fields`: An array of the fields to search when no fields are
     #     specified in a search. If no fields are specified in a search and
     #     this option is not specified, all text and text-array fields are
     #     searched. You can specify a weight for each field to control the
     #     relative importance of each field when Amazon CloudSearch calculates
     #     relevance scores. To specify a field weight, append a caret (`^`)
@@ -552,11 +557,11 @@
     #     importance of the `title` field over the `description` field you
     #     could specify: `"fields":["title^5","description"]`. Valid values:
     #     The name of any configured field and an optional numeric value
     #     greater than zero. Default: All `text` and `text-array` fields.
     #     Valid for: `simple`, `structured`, `lucene`, and `dismax`.
-    #   * `operators`\: An array of the operators or special characters you
+    #   * `operators`: An array of the operators or special characters you
     #     want to disable for the simple query parser. If you disable the
     #     `and`, `or`, or `not` operators, the corresponding operators (`+`,
     #     `|`, `-`) have no special meaning and are dropped from the search
     #     string. Similarly, disabling `prefix` disables the wildcard operator
     #     (`*`) and disabling `phrase` disables the ability to search for
@@ -574,11 +579,11 @@
     #     operator to support just simple term and phrase queries:
     #     `"operators":["and","not","or", "prefix"]`. Valid values: `and`,
     #     `escape`, `fuzzy`, `near`, `not`, `or`, `phrase`, `precedence`,
     #     `prefix`, `whitespace`. Default: All operators and special
     #     characters are enabled. Valid for: `simple`.
-    #   * `phraseFields`\: An array of the `text` or `text-array` fields you
+    #   * `phraseFields`: An array of the `text` or `text-array` fields you
     #     want to use for phrase searches. When the terms in the search string
     #     appear in close proximity within a field, the field scores higher.
     #     You can specify a weight for each field to boost that score. The
     #     `phraseSlop` option controls how much the matches can deviate from
     #     the search string and still be boosted. To specify a field weight,
@@ -588,24 +593,24 @@
     #     "plot"]` Valid values: The name of any `text` or `text-array` field
     #     and an optional numeric value greater than zero. Default: No fields.
     #     If you don't specify any fields with `phraseFields`, proximity
     #     scoring is disabled even if `phraseSlop` is specified. Valid for:
     #     `dismax`.
-    #   * `phraseSlop`\: An integer value that specifies how much matches can
+    #   * `phraseSlop`: An integer value that specifies how much matches can
     #     deviate from the search phrase and still be boosted according to the
     #     weights specified in the `phraseFields` option; for example,
     #     `phraseSlop: 2`. You must also specify `phraseFields` to enable
     #     proximity scoring. Valid values: positive integers. Default: 0.
     #     Valid for: `dismax`.
-    #   * `explicitPhraseSlop`\: An integer value that specifies how much a
+    #   * `explicitPhraseSlop`: An integer value that specifies how much a
     #     match can deviate from the search phrase when the phrase is enclosed
     #     in double quotes in the search string. (Phrases that exceed this
     #     proximity distance are not considered a match.) For example, to
     #     specify a slop of three for dismax phrase queries, you would specify
     #     `"explicitPhraseSlop":3`. Valid values: positive integers. Default:
     #     0. Valid for: `dismax`.
-    #   * `tieBreaker`\: When a term in the search string is found in a
+    #   * `tieBreaker`: When a term in the search string is found in a
     #     document's field, a score is calculated for that field based on how
     #     common the word is in that field compared to other documents. If the
     #     term occurs in multiple fields within a document, by default only
     #     the highest scoring field contributes to the document's overall
     #     score. You can specify a `tieBreaker` value to enable the matches in
@@ -625,31 +630,31 @@
     #   `queryParser` is not specified, Amazon CloudSearch uses the `simple`
     #   query parser.
     #
     #   Amazon CloudSearch supports four query parsers:
     #
-    #   * `simple`\: perform simple searches of `text` and `text-array`
-    #     fields. By default, the `simple` query parser searches all `text`
-    #     and `text-array` fields. You can specify which fields to search by
-    #     with the `queryOptions` parameter. If you prefix a search term with
-    #     a plus sign (+) documents must contain the term to be considered a
+    #   * `simple`: perform simple searches of `text` and `text-array` fields.
+    #     By default, the `simple` query parser searches all `text` and
+    #     `text-array` fields. You can specify which fields to search by with
+    #     the `queryOptions` parameter. If you prefix a search term with a
+    #     plus sign (+) documents must contain the term to be considered a
     #     match. (This is the default, unless you configure the default
     #     operator with the `queryOptions` parameter.) You can use the `-`
     #     (NOT), `|` (OR), and `*` (wildcard) operators to exclude particular
     #     terms, find results that match any of the specified terms, or search
     #     for a prefix. To search for a phrase rather than individual terms,
     #     enclose the phrase in double quotes. For more information, see
     #     [Searching for Text][1] in the *Amazon CloudSearch Developer Guide*.
-    #   * `structured`\: perform advanced searches by combining multiple
+    #   * `structured`: perform advanced searches by combining multiple
     #     expressions to define the search criteria. You can also search
     #     within particular fields, search for values and ranges of values,
     #     and use advanced options such as term boosting, `matchall`, and
     #     `near`. For more information, see [Constructing Compound Queries][2]
     #     in the *Amazon CloudSearch Developer Guide*.
-    #   * `lucene`\: search using the Apache Lucene query parser syntax. For
+    #   * `lucene`: search using the Apache Lucene query parser syntax. For
     #     more information, see [Apache Lucene Query Parser Syntax][3].
-    #   * `dismax`\: search using the simplified subset of the Apache Lucene
+    #   * `dismax`: search using the simplified subset of the Apache Lucene
     #     query parser syntax defined by the DisMax query parser. For more
     #     information, see [DisMax Query Parser Syntax][4].
     #
     #
     #
@@ -914,10 +919,10 @@
         operation: config.api.operation(operation_name),
         client: self,
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-cloudsearchdomain'
-      context[:gem_version] = '1.34.1'
+      context[:gem_version] = '1.35.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 
     # @api private
     # @deprecated