aws-sdk 1.8.5 → 1.9.0

data/lib/aws/cloud_front/request.rb

@@ -23,6 +23,9 @@ module AWS
 
         self.access_key_id = credentials.access_key_id
 
+        headers['x-amz-security-token'] = credentials.session_token if
+          credentials.session_token
+
         auth = "AWS #{access_key_id}:#{signature(credentials)}"
         headers['authorization'] = auth
 

data/lib/aws/cloud_search.rb

@@ -19,41 +19,41 @@ module AWS
   # This class is the starting point for working with Amazon CloudSearch.
   #
   # To use Amazon CloudSearch you must first
-  # {sign up here}[http://aws.amazon.com/cloudsearch/].
+  # [sign up here](http://aws.amazon.com/cloudsearch/).
   #
   # For more information about Amazon CloudSearch:
   #
-  # * {Amazon CloudSearch}[http://aws.amazon.com/cloudsearch/]
-  # * {Amazon CloudSearch Documentation}[http://aws.amazon.com/documentation/cloudsearch/]
+  # * [Amazon CloudSearch](http://aws.amazon.com/cloudsearch/)
+  # * [Amazon CloudSearch Documentation](http://aws.amazon.com/documentation/cloudsearch/)
   #
-  # = Credentials
+  # # Credentials
   #
   # You can setup default credentials for all AWS services via
   # AWS.config:
   #
-  #   AWS.config(
-  #     :access_key_id => 'YOUR_ACCESS_KEY_ID',
-  #     :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
+  #     AWS.config(
+  #       :access_key_id => 'YOUR_ACCESS_KEY_ID',
+  #       :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
   #
-  # Or you can set them directly on the AWS::Route53 interface:
+  # Or you can set them directly on the AWS::CloudSearch interface:
   #
-  #   cs = AWS::CloudSearch.new(
-  #     :access_key_id => 'YOUR_ACCESS_KEY_ID',
-  #     :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
+  #     cs = AWS::CloudSearch.new(
+  #       :access_key_id => 'YOUR_ACCESS_KEY_ID',
+  #       :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
   #
-  # = Using the Client
+  # # Using the Client
   #
   # AWS::CloudSearch does not provide higher level abstractions for CloudSearch at
   # this time.  You can still access all of the API methods using
   # {AWS::CloudSearch::Client}.  Here is how you access the client and make
   # a simple request:
   #
-  #   cs = AWS::CloudSearch.new
+  #     cs = AWS::CloudSearch.new
   #
-  #   resp = cs.client.describe_domains
-  #   resp[:domain_status_list].each do |domain|
-  #     puts domain[:domain_id]
-  #   end
+  #     resp = cs.client.describe_domains
+  #     resp[:domain_status_list].each do |domain|
+  #       puts domain[:domain_id]
+  #     end
   #
   # See {Client} for documentation on all of the supported operations.
   #
@@ -61,14 +61,14 @@ module AWS
   #   @return [Client] the low-level CloudSearch client object
   class CloudSearch
 
-    AWS.register_autoloads(self, 'aws/cloud_search') do
-      autoload :Client,                        'client'
-      autoload :Errors,                        'errors'
-      autoload :Request,                       'request'
-    end
+    autoload :Client, 'aws/cloud_search/client'
+    autoload :Errors, 'aws/cloud_search/errors'
+    autoload :Request, 'aws/cloud_search/request'
 
     include Core::ServiceInterface
 
+    endpoint_prefix 'cloudsearch'
+
   end
 
 end

data/lib/aws/cloud_search/client.rb

@@ -25,152 +25,159 @@ module AWS
       # @!method create_domain(options = {})
       # Calls the CreateDomain API operation.
       # @param [Hash] options
-      #   * +:domain_name+ - *required* - (String)
+      #   * `:domain_name` - *required* - (String)
       # @return [Core::Response]
       #   The #data method of the response object returns
       #   a hash with the following structure:
-      #   * +:domain_status+ - (Hash)
-      #     * +:domain_id+ - (String)
-      #     * +:domain_name+ - (String)
-      #     * +:created+ - (Boolean)
-      #     * +:deleted+ - (Boolean)
-      #     * +:num_searchable_docs+ - (Integer)
-      #     * +:doc_service+ - (Hash)
-      #       * +:arn+ - (String)
-      #       * +:endpoint+ - (String)
-      #     * +:search_service+ - (Hash)
-      #       * +:arn+ - (String)
-      #       * +:endpoint+ - (String)
-      #     * +:requires_index_documents+ - (Boolean)
-      #     * +:processing+ - (Boolean)
-      #     * +:search_instance_type+ - (String)
-      #     * +:search_partition_count+ - (Integer)
-      #     * +:search_instance_count+ - (Integer)
+      #   * `:domain_status` - (Hash)
+      #     * `:domain_id` - (String)
+      #     * `:domain_name` - (String)
+      #     * `:created` - (Boolean)
+      #     * `:deleted` - (Boolean)
+      #     * `:num_searchable_docs` - (Integer)
+      #     * `:doc_service` - (Hash)
+      #       * `:arn` - (String)
+      #       * `:endpoint` - (String)
+      #     * `:search_service` - (Hash)
+      #       * `:arn` - (String)
+      #       * `:endpoint` - (String)
+      #     * `:requires_index_documents` - (Boolean)
+      #     * `:processing` - (Boolean)
+      #     * `:search_instance_type` - (String)
+      #     * `:search_partition_count` - (Integer)
+      #     * `:search_instance_count` - (Integer)
 
       # @!method define_index_field(options = {})
       # Calls the DefineIndexField API operation.
       # @param [Hash] options
-      #   * +:domain_name+ - *required* - (String)
-      #   * +:index_field+ - *required* - (Hash)
-      #     * +:index_field_name+ - *required* - (String) The name of a field
+      #   * `:domain_name` - *required* - (String)
+      #   * `:index_field` - *required* - (Hash)
+      #     * `:index_field_name` - *required* - (String) The name of a field
       #       in the search index. Field names must begin with a letter and can
       #       contain the following characters: a-z (lowercase), 0-9, and _
       #       (underscore). Uppercase letters and hyphens are not allowed. The
       #       names "body", "docid", and "text_relevance" are reserved and
       #       cannot be specified as field or rank expression names.
-      #     * +:index_field_type+ - *required* - (String) The type of field.
+      #     * `:index_field_type` - *required* - (String) The type of field.
       #       Based on this type, exactly one of the UIntOptions,
-      #       LiteralOptions or TextOptions must be present.
-      #     * +:u_int_options+ - (Hash) Options for an unsigned integer field.
+      #       LiteralOptions or TextOptions must be present. Valid values
+      #       include:
+      #       * `uint`
+      #       * `literal`
+      #       * `text`
+      #     * `:u_int_options` - (Hash) Options for an unsigned integer field.
       #       Present if IndexFieldType specifies the field is of type unsigned
       #       integer.
-      #       * +:default_value+ - (Integer) The default value for an unsigned
+      #       * `:default_value` - (Integer) The default value for an unsigned
       #         integer field.
-      #     * +:literal_options+ - (Hash) Options for literal field. Present if
+      #     * `:literal_options` - (Hash) Options for literal field. Present if
       #       IndexFieldType specifies the field is of type literal.
-      #       * +:default_value+ - (String) The default value for a literal
+      #       * `:default_value` - (String) The default value for a literal
       #         field.
-      #       * +:search_enabled+ - (Boolean) Specifies whether search is
+      #       * `:search_enabled` - (Boolean) Specifies whether search is
       #         enabled for this field.
-      #       * +:facet_enabled+ - (Boolean) Specifies whether facets are
+      #       * `:facet_enabled` - (Boolean) Specifies whether facets are
       #         enabled for this field.
-      #       * +:result_enabled+ - (Boolean) Specifies whether values of this
+      #       * `:result_enabled` - (Boolean) Specifies whether values of this
       #         field can be returned in search results and used for ranking.
-      #     * +:text_options+ - (Hash) Options for text field. Present if
+      #     * `:text_options` - (Hash) Options for text field. Present if
       #       IndexFieldType specifies the field is of type text.
-      #       * +:default_value+ - (String) The default value for a text field.
-      #       * +:facet_enabled+ - (Boolean) Specifies whether facets are
+      #       * `:default_value` - (String) The default value for a text field.
+      #       * `:facet_enabled` - (Boolean) Specifies whether facets are
       #         enabled for this field.
-      #       * +:result_enabled+ - (Boolean) Specifies whether values of this
+      #       * `:result_enabled` - (Boolean) Specifies whether values of this
       #         field can be returned in search results and used for ranking.
-      #     * +:source_attributes+ - (Array<Hash>) An optional list of source
+      #     * `:source_attributes` - (Array<Hash>) An optional list of source
       #       attributes that provide data for this index field. If not
       #       specified, the data is pulled from a source attribute with the
       #       same name as this IndexField. When one or more source attributes
       #       are specified, an optional data transformation can be applied to
       #       the source data when populating the index field. You can
       #       configure a maximum of 20 sources for an IndexField.
-      #       * +:source_data_function+ - *required* - (String) Identifies the
+      #       * `:source_data_function` - *required* - (String) Identifies the
       #         transformation to apply when copying data from a source
-      #         attribute.
-      #       * +:source_data_copy+ - (Hash) Copies data from a source document
+      #         attribute. Valid values include:
+      #         * `Copy`
+      #         * `TrimTitle`
+      #         * `Map`
+      #       * `:source_data_copy` - (Hash) Copies data from a source document
       #         attribute to an IndexField.
-      #         * +:source_name+ - *required* - (String) The name of the
+      #         * `:source_name` - *required* - (String) The name of the
       #           document source field to add to this IndexField.
-      #         * +:default_value+ - (String)
-      #       * +:source_data_trim_title+ - (Hash) Trims common title words
+      #         * `:default_value` - (String)
+      #       * `:source_data_trim_title` - (Hash) Trims common title words
       #         from a source document attribute when populating an IndexField.
       #         This can be used to create an IndexField you can use for
       #         sorting.
-      #         * +:source_name+ - *required* - (String) The name of the
+      #         * `:source_name` - *required* - (String) The name of the
       #           document source field to add to this IndexField.
-      #         * +:default_value+ - (String)
-      #         * +:separator+ - (String) The separator that follows the text
+      #         * `:default_value` - (String)
+      #         * `:separator` - (String) The separator that follows the text
       #           to trim.
-      #         * +:language+ - (String)
-      #       * +:source_data_map+ - (Hash) Maps source document attribute
+      #         * `:language` - (String)
+      #       * `:source_data_map` - (Hash) Maps source document attribute
       #         values to new values when populating the IndexField.
-      #         * +:source_name+ - *required* - (String) The name of the
+      #         * `:source_name` - *required* - (String) The name of the
       #           document source field to add to this IndexField.
-      #         * +:default_value+ - (String)
-      #         * +:cases+ - (Hash<String,String>) A map that translates source
+      #         * `:default_value` - (String)
+      #         * `:cases` - (Hash<String,String>) A map that translates source
       #           field values to custom values.
       # @return [Core::Response]
       #   The #data method of the response object returns
       #   a hash with the following structure:
-      #   * +:index_field+ - (Hash)
-      #     * +:options+ - (Hash)
-      #       * +:index_field_name+ - (String)
-      #       * +:index_field_type+ - (String)
-      #       * +:u_int_options+ - (Hash)
-      #         * +:default_value+ - (Integer)
-      #       * +:literal_options+ - (Hash)
-      #         * +:default_value+ - (String)
-      #         * +:search_enabled+ - (Boolean)
-      #         * +:facet_enabled+ - (Boolean)
-      #         * +:result_enabled+ - (Boolean)
-      #       * +:text_options+ - (Hash)
-      #         * +:default_value+ - (String)
-      #         * +:facet_enabled+ - (Boolean)
-      #         * +:result_enabled+ - (Boolean)
-      #       * +:source_attributes+ - (Array<Hash>)
-      #         * +:source_data_function+ - (String)
-      #         * +:source_data_copy+ - (Hash)
-      #           * +:source_name+ - (String)
-      #           * +:default_value+ - (String)
-      #         * +:source_data_trim_title+ - (Hash)
-      #           * +:source_name+ - (String)
-      #           * +:default_value+ - (String)
-      #           * +:separator+ - (String)
-      #           * +:language+ - (String)
-      #         * +:source_data_map+ - (Hash)
-      #           * +:source_name+ - (String)
-      #           * +:default_value+ - (String)
-      #           * +:cases+ - (Hash<String,String>)
-      #     * +:status+ - (Hash)
-      #       * +:creation_date+ - (Time)
-      #       * +:update_date+ - (Time)
-      #       * +:update_version+ - (Integer)
-      #       * +:state+ - (String)
+      #   * `:index_field` - (Hash)
+      #     * `:options` - (Hash)
+      #       * `:index_field_name` - (String)
+      #       * `:index_field_type` - (String)
+      #       * `:u_int_options` - (Hash)
+      #         * `:default_value` - (Integer)
+      #       * `:literal_options` - (Hash)
+      #         * `:default_value` - (String)
+      #         * `:search_enabled` - (Boolean)
+      #         * `:facet_enabled` - (Boolean)
+      #         * `:result_enabled` - (Boolean)
+      #       * `:text_options` - (Hash)
+      #         * `:default_value` - (String)
+      #         * `:facet_enabled` - (Boolean)
+      #         * `:result_enabled` - (Boolean)
+      #       * `:source_attributes` - (Array<Hash>)
+      #         * `:source_data_function` - (String)
+      #         * `:source_data_copy` - (Hash)
+      #           * `:source_name` - (String)
+      #           * `:default_value` - (String)
+      #         * `:source_data_trim_title` - (Hash)
+      #           * `:source_name` - (String)
+      #           * `:default_value` - (String)
+      #           * `:separator` - (String)
+      #           * `:language` - (String)
+      #         * `:source_data_map` - (Hash)
+      #           * `:source_name` - (String)
+      #           * `:default_value` - (String)
+      #           * `:cases` - (Hash<String,String>)
+      #     * `:status` - (Hash)
+      #       * `:creation_date` - (Time)
+      #       * `:update_date` - (Time)
+      #       * `:update_version` - (Integer)
+      #       * `:state` - (String)
 
       # @!method define_rank_expression(options = {})
       # Calls the DefineRankExpression API operation.
       # @param [Hash] options
-      #   * +:domain_name+ - *required* - (String)
-      #   * +:rank_expression+ - *required* - (Hash)
-      #     * +:rank_name+ - *required* - (String) The name of a rank
+      #   * `:domain_name` - *required* - (String)
+      #   * `:rank_expression` - *required* - (Hash)
+      #     * `:rank_name` - *required* - (String) The name of a rank
       #       expression. Rank expression names must begin with a letter and
       #       can contain the following characters: a-z (lowercase), 0-9, and _
       #       (underscore). Uppercase letters and hyphens are not allowed. The
       #       names "body", "docid", and "text_relevance" are reserved and
       #       cannot be specified as field or rank expression names.
-      #     * +:rank_expression+ - *required* - (String) The expression to
+      #     * `:rank_expression` - *required* - (String) The expression to
       #       evaluate for ranking or thresholding while processing a search
       #       request. The RankExpression syntax is based on JavaScript
       #       expressions and supports: Integer, floating point, hex and octal
       #       literals Shortcut evaluation of logical operators such that an
-      #       expression a || b evaluates to the value a if a is +true+ without
-      #       evaluating b at all JavaScript order of precedence for operators
+      #       expression a || b evaluates to the value a if a is `true` without
+      #       evaluting b at all JavaScript order of precendence for operators
       #       Arithmetic operators: + - * / % Boolean operators (including the
       #       ternary operator) Bitwise operators Comparison operators Common
       #       mathematic functions: abs ceil erf exp floor lgamma ln log2 log10
@@ -197,357 +204,357 @@ module AWS
       # @return [Core::Response]
       #   The #data method of the response object returns
       #   a hash with the following structure:
-      #   * +:rank_expression+ - (Hash)
-      #     * +:options+ - (Hash)
-      #       * +:rank_name+ - (String)
-      #       * +:rank_expression+ - (String)
-      #     * +:status+ - (Hash)
-      #       * +:creation_date+ - (Time)
-      #       * +:update_date+ - (Time)
-      #       * +:update_version+ - (Integer)
-      #       * +:state+ - (String)
+      #   * `:rank_expression` - (Hash)
+      #     * `:options` - (Hash)
+      #       * `:rank_name` - (String)
+      #       * `:rank_expression` - (String)
+      #     * `:status` - (Hash)
+      #       * `:creation_date` - (Time)
+      #       * `:update_date` - (Time)
+      #       * `:update_version` - (Integer)
+      #       * `:state` - (String)
 
       # @!method delete_domain(options = {})
       # Calls the DeleteDomain API operation.
       # @param [Hash] options
-      #   * +:domain_name+ - *required* - (String)
+      #   * `:domain_name` - *required* - (String)
       # @return [Core::Response]
       #   The #data method of the response object returns
       #   a hash with the following structure:
-      #   * +:domain_status+ - (Hash)
-      #     * +:domain_id+ - (String)
-      #     * +:domain_name+ - (String)
-      #     * +:created+ - (Boolean)
-      #     * +:deleted+ - (Boolean)
-      #     * +:num_searchable_docs+ - (Integer)
-      #     * +:doc_service+ - (Hash)
-      #       * +:arn+ - (String)
-      #       * +:endpoint+ - (String)
-      #     * +:search_service+ - (Hash)
-      #       * +:arn+ - (String)
-      #       * +:endpoint+ - (String)
-      #     * +:requires_index_documents+ - (Boolean)
-      #     * +:processing+ - (Boolean)
-      #     * +:search_instance_type+ - (String)
-      #     * +:search_partition_count+ - (Integer)
-      #     * +:search_instance_count+ - (Integer)
+      #   * `:domain_status` - (Hash)
+      #     * `:domain_id` - (String)
+      #     * `:domain_name` - (String)
+      #     * `:created` - (Boolean)
+      #     * `:deleted` - (Boolean)
+      #     * `:num_searchable_docs` - (Integer)
+      #     * `:doc_service` - (Hash)
+      #       * `:arn` - (String)
+      #       * `:endpoint` - (String)
+      #     * `:search_service` - (Hash)
+      #       * `:arn` - (String)
+      #       * `:endpoint` - (String)
+      #     * `:requires_index_documents` - (Boolean)
+      #     * `:processing` - (Boolean)
+      #     * `:search_instance_type` - (String)
+      #     * `:search_partition_count` - (Integer)
+      #     * `:search_instance_count` - (Integer)
 
       # @!method delete_index_field(options = {})
       # Calls the DeleteIndexField API operation.
       # @param [Hash] options
-      #   * +:domain_name+ - *required* - (String)
-      #   * +:index_field_name+ - *required* - (String)
+      #   * `:domain_name` - *required* - (String)
+      #   * `:index_field_name` - *required* - (String)
       # @return [Core::Response]
       #   The #data method of the response object returns
       #   a hash with the following structure:
-      #   * +:index_field+ - (Hash)
-      #     * +:options+ - (Hash)
-      #       * +:index_field_name+ - (String)
-      #       * +:index_field_type+ - (String)
-      #       * +:u_int_options+ - (Hash)
-      #         * +:default_value+ - (Integer)
-      #       * +:literal_options+ - (Hash)
-      #         * +:default_value+ - (String)
-      #         * +:search_enabled+ - (Boolean)
-      #         * +:facet_enabled+ - (Boolean)
-      #         * +:result_enabled+ - (Boolean)
-      #       * +:text_options+ - (Hash)
-      #         * +:default_value+ - (String)
-      #         * +:facet_enabled+ - (Boolean)
-      #         * +:result_enabled+ - (Boolean)
-      #       * +:source_attributes+ - (Array<Hash>)
-      #         * +:source_data_function+ - (String)
-      #         * +:source_data_copy+ - (Hash)
-      #           * +:source_name+ - (String)
-      #           * +:default_value+ - (String)
-      #         * +:source_data_trim_title+ - (Hash)
-      #           * +:source_name+ - (String)
-      #           * +:default_value+ - (String)
-      #           * +:separator+ - (String)
-      #           * +:language+ - (String)
-      #         * +:source_data_map+ - (Hash)
-      #           * +:source_name+ - (String)
-      #           * +:default_value+ - (String)
-      #           * +:cases+ - (Hash<String,String>)
-      #     * +:status+ - (Hash)
-      #       * +:creation_date+ - (Time)
-      #       * +:update_date+ - (Time)
-      #       * +:update_version+ - (Integer)
-      #       * +:state+ - (String)
+      #   * `:index_field` - (Hash)
+      #     * `:options` - (Hash)
+      #       * `:index_field_name` - (String)
+      #       * `:index_field_type` - (String)
+      #       * `:u_int_options` - (Hash)
+      #         * `:default_value` - (Integer)
+      #       * `:literal_options` - (Hash)
+      #         * `:default_value` - (String)
+      #         * `:search_enabled` - (Boolean)
+      #         * `:facet_enabled` - (Boolean)
+      #         * `:result_enabled` - (Boolean)
+      #       * `:text_options` - (Hash)
+      #         * `:default_value` - (String)
+      #         * `:facet_enabled` - (Boolean)
+      #         * `:result_enabled` - (Boolean)
+      #       * `:source_attributes` - (Array<Hash>)
+      #         * `:source_data_function` - (String)
+      #         * `:source_data_copy` - (Hash)
+      #           * `:source_name` - (String)
+      #           * `:default_value` - (String)
+      #         * `:source_data_trim_title` - (Hash)
+      #           * `:source_name` - (String)
+      #           * `:default_value` - (String)
+      #           * `:separator` - (String)
+      #           * `:language` - (String)
+      #         * `:source_data_map` - (Hash)
+      #           * `:source_name` - (String)
+      #           * `:default_value` - (String)
+      #           * `:cases` - (Hash<String,String>)
+      #     * `:status` - (Hash)
+      #       * `:creation_date` - (Time)
+      #       * `:update_date` - (Time)
+      #       * `:update_version` - (Integer)
+      #       * `:state` - (String)
 
       # @!method delete_rank_expression(options = {})
       # Calls the DeleteRankExpression API operation.
       # @param [Hash] options
-      #   * +:domain_name+ - *required* - (String)
-      #   * +:rank_name+ - *required* - (String) The name of the RankExpression
+      #   * `:domain_name` - *required* - (String)
+      #   * `:rank_name` - *required* - (String) The name of the RankExpression
       #     to delete.
       # @return [Core::Response]
       #   The #data method of the response object returns
       #   a hash with the following structure:
-      #   * +:rank_expression+ - (Hash)
-      #     * +:options+ - (Hash)
-      #       * +:rank_name+ - (String)
-      #       * +:rank_expression+ - (String)
-      #     * +:status+ - (Hash)
-      #       * +:creation_date+ - (Time)
-      #       * +:update_date+ - (Time)
-      #       * +:update_version+ - (Integer)
-      #       * +:state+ - (String)
+      #   * `:rank_expression` - (Hash)
+      #     * `:options` - (Hash)
+      #       * `:rank_name` - (String)
+      #       * `:rank_expression` - (String)
+      #     * `:status` - (Hash)
+      #       * `:creation_date` - (Time)
+      #       * `:update_date` - (Time)
+      #       * `:update_version` - (Integer)
+      #       * `:state` - (String)
 
       # @!method describe_default_search_field(options = {})
       # Calls the DescribeDefaultSearchField API operation.
       # @param [Hash] options
-      #   * +:domain_name+ - *required* - (String)
+      #   * `:domain_name` - *required* - (String)
       # @return [Core::Response]
       #   The #data method of the response object returns
       #   a hash with the following structure:
-      #   * +:default_search_field+ - (Hash)
-      #     * +:options+ - (String)
-      #     * +:status+ - (Hash)
-      #       * +:creation_date+ - (Time)
-      #       * +:update_date+ - (Time)
-      #       * +:update_version+ - (Integer)
-      #       * +:state+ - (String)
+      #   * `:default_search_field` - (Hash)
+      #     * `:options` - (String)
+      #     * `:status` - (Hash)
+      #       * `:creation_date` - (Time)
+      #       * `:update_date` - (Time)
+      #       * `:update_version` - (Integer)
+      #       * `:state` - (String)
 
       # @!method describe_domains(options = {})
       # Calls the DescribeDomains API operation.
       # @param [Hash] options
-      #   * +:domain_names+ - (Array<String>) Limits the DescribeDomains
+      #   * `:domain_names` - (Array<String>) Limits the DescribeDomains
       #     response to the specified search domains.
       # @return [Core::Response]
       #   The #data method of the response object returns
       #   a hash with the following structure:
-      #   * +:domain_status_list+ - (Array<Hash>)
-      #     * +:domain_id+ - (String)
-      #     * +:domain_name+ - (String)
-      #     * +:created+ - (Boolean)
-      #     * +:deleted+ - (Boolean)
-      #     * +:num_searchable_docs+ - (Integer)
-      #     * +:doc_service+ - (Hash)
-      #       * +:arn+ - (String)
-      #       * +:endpoint+ - (String)
-      #     * +:search_service+ - (Hash)
-      #       * +:arn+ - (String)
-      #       * +:endpoint+ - (String)
-      #     * +:requires_index_documents+ - (Boolean)
-      #     * +:processing+ - (Boolean)
-      #     * +:search_instance_type+ - (String)
-      #     * +:search_partition_count+ - (Integer)
-      #     * +:search_instance_count+ - (Integer)
+      #   * `:domain_status_list` - (Array<Hash>)
+      #     * `:domain_id` - (String)
+      #     * `:domain_name` - (String)
+      #     * `:created` - (Boolean)
+      #     * `:deleted` - (Boolean)
+      #     * `:num_searchable_docs` - (Integer)
+      #     * `:doc_service` - (Hash)
+      #       * `:arn` - (String)
+      #       * `:endpoint` - (String)
+      #     * `:search_service` - (Hash)
+      #       * `:arn` - (String)
+      #       * `:endpoint` - (String)
+      #     * `:requires_index_documents` - (Boolean)
+      #     * `:processing` - (Boolean)
+      #     * `:search_instance_type` - (String)
+      #     * `:search_partition_count` - (Integer)
+      #     * `:search_instance_count` - (Integer)
 
       # @!method describe_index_fields(options = {})
       # Calls the DescribeIndexFields API operation.
       # @param [Hash] options
-      #   * +:domain_name+ - *required* - (String)
-      #   * +:field_names+ - (Array<String>) Limits the DescribeIndexFields
+      #   * `:domain_name` - *required* - (String)
+      #   * `:field_names` - (Array<String>) Limits the DescribeIndexFields
       #     response to the specified fields.
       # @return [Core::Response]
       #   The #data method of the response object returns
       #   a hash with the following structure:
-      #   * +:index_fields+ - (Array<Hash>)
-      #     * +:options+ - (Hash)
-      #       * +:index_field_name+ - (String)
-      #       * +:index_field_type+ - (String)
-      #       * +:u_int_options+ - (Hash)
-      #         * +:default_value+ - (Integer)
-      #       * +:literal_options+ - (Hash)
-      #         * +:default_value+ - (String)
-      #         * +:search_enabled+ - (Boolean)
-      #         * +:facet_enabled+ - (Boolean)
-      #         * +:result_enabled+ - (Boolean)
-      #       * +:text_options+ - (Hash)
-      #         * +:default_value+ - (String)
-      #         * +:facet_enabled+ - (Boolean)
-      #         * +:result_enabled+ - (Boolean)
-      #       * +:source_attributes+ - (Array<Hash>)
-      #         * +:source_data_function+ - (String)
-      #         * +:source_data_copy+ - (Hash)
-      #           * +:source_name+ - (String)
-      #           * +:default_value+ - (String)
-      #         * +:source_data_trim_title+ - (Hash)
-      #           * +:source_name+ - (String)
-      #           * +:default_value+ - (String)
-      #           * +:separator+ - (String)
-      #           * +:language+ - (String)
-      #         * +:source_data_map+ - (Hash)
-      #           * +:source_name+ - (String)
-      #           * +:default_value+ - (String)
-      #           * +:cases+ - (Hash<String,String>)
-      #     * +:status+ - (Hash)
-      #       * +:creation_date+ - (Time)
-      #       * +:update_date+ - (Time)
-      #       * +:update_version+ - (Integer)
-      #       * +:state+ - (String)
+      #   * `:index_fields` - (Array<Hash>)
+      #     * `:options` - (Hash)
+      #       * `:index_field_name` - (String)
+      #       * `:index_field_type` - (String)
+      #       * `:u_int_options` - (Hash)
+      #         * `:default_value` - (Integer)
+      #       * `:literal_options` - (Hash)
+      #         * `:default_value` - (String)
+      #         * `:search_enabled` - (Boolean)
+      #         * `:facet_enabled` - (Boolean)
+      #         * `:result_enabled` - (Boolean)
+      #       * `:text_options` - (Hash)
+      #         * `:default_value` - (String)
+      #         * `:facet_enabled` - (Boolean)
+      #         * `:result_enabled` - (Boolean)
+      #       * `:source_attributes` - (Array<Hash>)
+      #         * `:source_data_function` - (String)
+      #         * `:source_data_copy` - (Hash)
+      #           * `:source_name` - (String)
+      #           * `:default_value` - (String)
+      #         * `:source_data_trim_title` - (Hash)
+      #           * `:source_name` - (String)
+      #           * `:default_value` - (String)
+      #           * `:separator` - (String)
+      #           * `:language` - (String)
+      #         * `:source_data_map` - (Hash)
+      #           * `:source_name` - (String)
+      #           * `:default_value` - (String)
+      #           * `:cases` - (Hash<String,String>)
+      #     * `:status` - (Hash)
+      #       * `:creation_date` - (Time)
+      #       * `:update_date` - (Time)
+      #       * `:update_version` - (Integer)
+      #       * `:state` - (String)
 
       # @!method describe_rank_expressions(options = {})
       # Calls the DescribeRankExpressions API operation.
       # @param [Hash] options
-      #   * +:domain_name+ - *required* - (String)
-      #   * +:rank_names+ - (Array<String>) Limits the DescribeRankExpressions
+      #   * `:domain_name` - *required* - (String)
+      #   * `:rank_names` - (Array<String>) Limits the DescribeRankExpressions
       #     response to the specified fields.
       # @return [Core::Response]
       #   The #data method of the response object returns
       #   a hash with the following structure:
-      #   * +:rank_expressions+ - (Array<Hash>)
-      #     * +:options+ - (Hash)
-      #       * +:rank_name+ - (String)
-      #       * +:rank_expression+ - (String)
-      #     * +:status+ - (Hash)
-      #       * +:creation_date+ - (Time)
-      #       * +:update_date+ - (Time)
-      #       * +:update_version+ - (Integer)
-      #       * +:state+ - (String)
+      #   * `:rank_expressions` - (Array<Hash>)
+      #     * `:options` - (Hash)
+      #       * `:rank_name` - (String)
+      #       * `:rank_expression` - (String)
+      #     * `:status` - (Hash)
+      #       * `:creation_date` - (Time)
+      #       * `:update_date` - (Time)
+      #       * `:update_version` - (Integer)
+      #       * `:state` - (String)
 
       # @!method describe_service_access_policies(options = {})
       # Calls the DescribeServiceAccessPolicies API operation.
       # @param [Hash] options
-      #   * +:domain_name+ - *required* - (String)
+      #   * `:domain_name` - *required* - (String)
       # @return [Core::Response]
       #   The #data method of the response object returns
       #   a hash with the following structure:
-      #   * +:access_policies+ - (Hash)
-      #     * +:options+ - (String)
-      #     * +:status+ - (Hash)
-      #       * +:creation_date+ - (Time)
-      #       * +:update_date+ - (Time)
-      #       * +:update_version+ - (Integer)
-      #       * +:state+ - (String)
+      #   * `:access_policies` - (Hash)
+      #     * `:options` - (String)
+      #     * `:status` - (Hash)
+      #       * `:creation_date` - (Time)
+      #       * `:update_date` - (Time)
+      #       * `:update_version` - (Integer)
+      #       * `:state` - (String)
 
       # @!method describe_stemming_options(options = {})
       # Calls the DescribeStemmingOptions API operation.
       # @param [Hash] options
-      #   * +:domain_name+ - *required* - (String)
+      #   * `:domain_name` - *required* - (String)
       # @return [Core::Response]
       #   The #data method of the response object returns
       #   a hash with the following structure:
-      #   * +:stems+ - (Hash)
-      #     * +:options+ - (String)
-      #     * +:status+ - (Hash)
-      #       * +:creation_date+ - (Time)
-      #       * +:update_date+ - (Time)
-      #       * +:update_version+ - (Integer)
-      #       * +:state+ - (String)
+      #   * `:stems` - (Hash)
+      #     * `:options` - (String)
+      #     * `:status` - (Hash)
+      #       * `:creation_date` - (Time)
+      #       * `:update_date` - (Time)
+      #       * `:update_version` - (Integer)
+      #       * `:state` - (String)
 
       # @!method describe_stopword_options(options = {})
       # Calls the DescribeStopwordOptions API operation.
       # @param [Hash] options
-      #   * +:domain_name+ - *required* - (String)
+      #   * `:domain_name` - *required* - (String)
       # @return [Core::Response]
       #   The #data method of the response object returns
       #   a hash with the following structure:
-      #   * +:stopwords+ - (Hash)
-      #     * +:options+ - (String)
-      #     * +:status+ - (Hash)
-      #       * +:creation_date+ - (Time)
-      #       * +:update_date+ - (Time)
-      #       * +:update_version+ - (Integer)
-      #       * +:state+ - (String)
+      #   * `:stopwords` - (Hash)
+      #     * `:options` - (String)
+      #     * `:status` - (Hash)
+      #       * `:creation_date` - (Time)
+      #       * `:update_date` - (Time)
+      #       * `:update_version` - (Integer)
+      #       * `:state` - (String)
 
       # @!method describe_synonym_options(options = {})
       # Calls the DescribeSynonymOptions API operation.
       # @param [Hash] options
-      #   * +:domain_name+ - *required* - (String)
+      #   * `:domain_name` - *required* - (String)
       # @return [Core::Response]
       #   The #data method of the response object returns
       #   a hash with the following structure:
-      #   * +:synonyms+ - (Hash)
-      #     * +:options+ - (String)
-      #     * +:status+ - (Hash)
-      #       * +:creation_date+ - (Time)
-      #       * +:update_date+ - (Time)
-      #       * +:update_version+ - (Integer)
-      #       * +:state+ - (String)
+      #   * `:synonyms` - (Hash)
+      #     * `:options` - (String)
+      #     * `:status` - (Hash)
+      #       * `:creation_date` - (Time)
+      #       * `:update_date` - (Time)
+      #       * `:update_version` - (Integer)
+      #       * `:state` - (String)
 
       # @!method index_documents(options = {})
       # Calls the IndexDocuments API operation.
       # @param [Hash] options
-      #   * +:domain_name+ - *required* - (String)
+      #   * `:domain_name` - *required* - (String)
       # @return [Core::Response]
       #   The #data method of the response object returns
       #   a hash with the following structure:
-      #   * +:field_names+ - (Array<String>)
+      #   * `:field_names` - (Array<String>)
 
       # @!method update_default_search_field(options = {})
       # Calls the UpdateDefaultSearchField API operation.
       # @param [Hash] options
-      #   * +:domain_name+ - *required* - (String)
-      #   * +:default_search_field+ - *required* - (String) The IndexField to
+      #   * `:domain_name` - *required* - (String)
+      #   * `:default_search_field` - *required* - (String) The IndexField to
       #     use for search requests issued with the q parameter. The default is
       #     an empty string, which automatically searches all text fields.
       # @return [Core::Response]
       #   The #data method of the response object returns
       #   a hash with the following structure:
-      #   * +:default_search_field+ - (Hash)
-      #     * +:options+ - (String)
-      #     * +:status+ - (Hash)
-      #       * +:creation_date+ - (Time)
-      #       * +:update_date+ - (Time)
-      #       * +:update_version+ - (Integer)
-      #       * +:state+ - (String)
+      #   * `:default_search_field` - (Hash)
+      #     * `:options` - (String)
+      #     * `:status` - (Hash)
+      #       * `:creation_date` - (Time)
+      #       * `:update_date` - (Time)
+      #       * `:update_version` - (Integer)
+      #       * `:state` - (String)
 
       # @!method update_service_access_policies(options = {})
       # Calls the UpdateServiceAccessPolicies API operation.
       # @param [Hash] options
-      #   * +:domain_name+ - *required* - (String)
-      #   * +:access_policies+ - *required* - (String)
+      #   * `:domain_name` - *required* - (String)
+      #   * `:access_policies` - *required* - (String)
       # @return [Core::Response]
       #   The #data method of the response object returns
       #   a hash with the following structure:
-      #   * +:access_policies+ - (Hash)
-      #     * +:options+ - (String)
-      #     * +:status+ - (Hash)
-      #       * +:creation_date+ - (Time)
-      #       * +:update_date+ - (Time)
-      #       * +:update_version+ - (Integer)
-      #       * +:state+ - (String)
+      #   * `:access_policies` - (Hash)
+      #     * `:options` - (String)
+      #     * `:status` - (Hash)
+      #       * `:creation_date` - (Time)
+      #       * `:update_date` - (Time)
+      #       * `:update_version` - (Integer)
+      #       * `:state` - (String)
 
       # @!method update_stemming_options(options = {})
       # Calls the UpdateStemmingOptions API operation.
       # @param [Hash] options
-      #   * +:domain_name+ - *required* - (String)
-      #   * +:stems+ - *required* - (String)
+      #   * `:domain_name` - *required* - (String)
+      #   * `:stems` - *required* - (String)
       # @return [Core::Response]
       #   The #data method of the response object returns
       #   a hash with the following structure:
-      #   * +:stems+ - (Hash)
-      #     * +:options+ - (String)
-      #     * +:status+ - (Hash)
-      #       * +:creation_date+ - (Time)
-      #       * +:update_date+ - (Time)
-      #       * +:update_version+ - (Integer)
-      #       * +:state+ - (String)
+      #   * `:stems` - (Hash)
+      #     * `:options` - (String)
+      #     * `:status` - (Hash)
+      #       * `:creation_date` - (Time)
+      #       * `:update_date` - (Time)
+      #       * `:update_version` - (Integer)
+      #       * `:state` - (String)
 
       # @!method update_stopword_options(options = {})
       # Calls the UpdateStopwordOptions API operation.
       # @param [Hash] options
-      #   * +:domain_name+ - *required* - (String)
-      #   * +:stopwords+ - *required* - (String)
+      #   * `:domain_name` - *required* - (String)
+      #   * `:stopwords` - *required* - (String)
       # @return [Core::Response]
       #   The #data method of the response object returns
       #   a hash with the following structure:
-      #   * +:stopwords+ - (Hash)
-      #     * +:options+ - (String)
-      #     * +:status+ - (Hash)
-      #       * +:creation_date+ - (Time)
-      #       * +:update_date+ - (Time)
-      #       * +:update_version+ - (Integer)
-      #       * +:state+ - (String)
+      #   * `:stopwords` - (Hash)
+      #     * `:options` - (String)
+      #     * `:status` - (Hash)
+      #       * `:creation_date` - (Time)
+      #       * `:update_date` - (Time)
+      #       * `:update_version` - (Integer)
+      #       * `:state` - (String)
 
       # @!method update_synonym_options(options = {})
       # Calls the UpdateSynonymOptions API operation.
       # @param [Hash] options
-      #   * +:domain_name+ - *required* - (String)
-      #   * +:synonyms+ - *required* - (String)
+      #   * `:domain_name` - *required* - (String)
+      #   * `:synonyms` - *required* - (String)
       # @return [Core::Response]
       #   The #data method of the response object returns
       #   a hash with the following structure:
-      #   * +:synonyms+ - (Hash)
-      #     * +:options+ - (String)
-      #     * +:status+ - (Hash)
-      #       * +:creation_date+ - (Time)
-      #       * +:update_date+ - (Time)
-      #       * +:update_version+ - (Integer)
-      #       * +:state+ - (String)
+      #   * `:synonyms` - (Hash)
+      #     * `:options` - (String)
+      #     * `:status` - (Hash)
+      #       * `:creation_date` - (Time)
+      #       * `:update_date` - (Time)
+      #       * `:update_version` - (Integer)
+      #       * `:state` - (String)
 
       # end client methods #