You are viewing documentation for version 1 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: AWS::CloudSearch::Client::V20130101

Inherits:

AWS::CloudSearch::Client

• Object
• AWS::Core::Client
• AWS::Core::QueryClient
• AWS::CloudSearch::Client
• AWS::CloudSearch::Client::V20130101

Defined in:

lib/aws/cloud_search/client.rb

Constant Summary

Constant Summary

Constants inherited from AWS::CloudSearch::Client

API_VERSION

Instance Attribute Summary

Attributes inherited from AWS::Core::Client

#config

Instance Method Summary

• #build_suggesters(options = {}) ⇒ Core::Response

  Calls the BuildSuggesters API operation.

• #create_domain(options = {}) ⇒ Core::Response

  Calls the CreateDomain API operation.

• #define_analysis_scheme(options = {}) ⇒ Core::Response

  Calls the DefineAnalysisScheme API operation.

• #define_expression(options = {}) ⇒ Core::Response

  Calls the DefineExpression API operation.

• #define_index_field(options = {}) ⇒ Core::Response

  Calls the DefineIndexField API operation.

• #define_suggester(options = {}) ⇒ Core::Response

  Calls the DefineSuggester API operation.

• #delete_analysis_scheme(options = {}) ⇒ Core::Response

  Calls the DeleteAnalysisScheme API operation.

• #delete_domain(options = {}) ⇒ Core::Response

  Calls the DeleteDomain API operation.

• #delete_expression(options = {}) ⇒ Core::Response

  Calls the DeleteExpression API operation.

• #delete_index_field(options = {}) ⇒ Core::Response

  Calls the DeleteIndexField API operation.

• #delete_suggester(options = {}) ⇒ Core::Response

  Calls the DeleteSuggester API operation.

• #describe_analysis_schemes(options = {}) ⇒ Core::Response

  Calls the DescribeAnalysisSchemes API operation.

• #describe_availability_options(options = {}) ⇒ Core::Response

  Calls the DescribeAvailabilityOptions API operation.

• #describe_domains(options = {}) ⇒ Core::Response

  Calls the DescribeDomains API operation.

• #describe_expressions(options = {}) ⇒ Core::Response

  Calls the DescribeExpressions API operation.

• #describe_index_fields(options = {}) ⇒ Core::Response

  Calls the DescribeIndexFields API operation.

• #describe_scaling_parameters(options = {}) ⇒ Core::Response

  Calls the DescribeScalingParameters API operation.

• #describe_service_access_policies(options = {}) ⇒ Core::Response

  Calls the DescribeServiceAccessPolicies API operation.

• #describe_suggesters(options = {}) ⇒ Core::Response

  Calls the DescribeSuggesters API operation.

• #index_documents(options = {}) ⇒ Core::Response

  Calls the IndexDocuments API operation.

• #list_domain_names(options = {}) ⇒ Core::Response

  Calls the ListDomainNames API operation.

• #update_availability_options(options = {}) ⇒ Core::Response

  Calls the UpdateAvailabilityOptions API operation.

• #update_scaling_parameters(options = {}) ⇒ Core::Response

  Calls the UpdateScalingParameters API operation.

• #update_service_access_policies(options = {}) ⇒ Core::Response

  Calls the UpdateServiceAccessPolicies API operation.

Methods inherited from AWS::CloudSearch::Client

#define_rank_expression, #delete_rank_expression, #describe_default_search_field, #describe_rank_expressions, #describe_stemming_options, #describe_stopword_options, #describe_synonym_options, #update_default_search_field, #update_stemming_options, #update_stopword_options, #update_synonym_options

Methods inherited from AWS::Core::Client

#initialize, #log_warning, #operations, #with_http_handler, #with_options

Constructor Details

This class inherits a constructor from AWS::Core::Client

Instance Method Details

#build_suggesters(options = {}) ⇒ Core::Response

Calls the BuildSuggesters API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :domain_name - required - (String)

Returns:

• (Core::Response) —

  The #data method of the response object returns a hash with the following structure:

  • :field_names - (Array)

#create_domain(options = {}) ⇒ Core::Response

Calls the CreateDomain API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :domain_name - required - (String)

Returns:

• (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)
    • :arn - (String)
    • :created - (Boolean)
    • :deleted - (Boolean)
    • :doc_service - (Hash)
      • :endpoint - (String)
    • :search_service - (Hash)
      • :endpoint - (String)
    • :requires_index_documents - (Boolean)
    • :processing - (Boolean)
    • :search_instance_type - (String)
    • :search_partition_count - (Integer)
    • :search_instance_count - (Integer)
    • :limits - (Hash)
      • :maximum_replication_count - (Integer)
      • :maximum_partition_count - (Integer)

#define_analysis_scheme(options = {}) ⇒ Core::Response

Calls the DefineAnalysisScheme API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :domain_name - required - (String)
  • :analysis_scheme - required - (Hash)
    • :analysis_scheme_name - required - (String)
    • :analysis_scheme_language - required - (String) Valid 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
    • :analysis_options - (Hash)
      • :synonyms - (String)
      • :stopwords - (String)
      • :stemming_dictionary - (String)
      • :japanese_tokenization_dictionary - (String)
      • :algorithmic_stemming - (String) Valid values include:
        • none
        • minimal
        • light
        • full

Returns:

• (Core::Response) —

  The #data method of the response object returns a hash with the following structure:

  • :analysis_scheme - (Hash)
    • :options - (Hash)
      • :analysis_scheme_name - (String)
      • :analysis_scheme_language - (String)
      • :analysis_options - (Hash)
        • :synonyms - (String)
        • :stopwords - (String)
        • :stemming_dictionary - (String)
        • :japanese_tokenization_dictionary - (String)
        • :algorithmic_stemming - (String)
    • :status - (Hash)
      • :creation_date - (Time)
      • :update_date - (Time)
      • :update_version - (Integer)
      • :state - (String)
      • :pending_deletion - (Boolean)

#define_expression(options = {}) ⇒ Core::Response

Calls the DefineExpression API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :domain_name - required - (String)
  • :expression - required - (Hash)
    • :expression_name - required - (String)
    • :expression_value - required - (String)

Returns:

• (Core::Response) —

  The #data method of the response object returns a hash with the following structure:

  • :expression - (Hash)
    • :options - (Hash)
      • :expression_name - (String)
      • :expression_value - (String)
    • :status - (Hash)
      • :creation_date - (Time)
      • :update_date - (Time)
      • :update_version - (Integer)
      • :state - (String)
      • :pending_deletion - (Boolean)

#define_index_field(options = {}) ⇒ Core::Response

Calls the DefineIndexField API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :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. Based on this type, exactly one of the UIntOptions, LiteralOptions or TextOptions must be present. Valid values include:
      • int
      • double
      • literal
      • text
      • date
      • latlon
      • int-array
      • double-array
      • literal-array
      • text-array
      • date-array
    • :int_options - (Hash)
      • :default_value - (Integer)
      • :source_field - (String)
      • :facet_enabled - (Boolean)
      • :search_enabled - (Boolean)
      • :return_enabled - (Boolean)
      • :sort_enabled - (Boolean)
    • :double_options - (Hash)
      • :default_value - (Float)
      • :source_field - (String)
      • :facet_enabled - (Boolean)
      • :search_enabled - (Boolean)
      • :return_enabled - (Boolean)
      • :sort_enabled - (Boolean)
    • :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 field. Optional.
      • :source_field - (String)
      • :facet_enabled - (Boolean) Specifies whether facets are enabled for this field. Default: False.
      • :search_enabled - (Boolean) Specifies whether search is enabled for this field. Default: False.
      • :return_enabled - (Boolean)
      • :sort_enabled - (Boolean)
    • :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. Optional.
      • :source_field - (String)
      • :return_enabled - (Boolean)
      • :sort_enabled - (Boolean)
      • :highlight_enabled - (Boolean)
      • :analysis_scheme - (String)
    • :date_options - (Hash)
      • :default_value - (String)
      • :source_field - (String)
      • :facet_enabled - (Boolean)
      • :search_enabled - (Boolean)
      • :return_enabled - (Boolean)
      • :sort_enabled - (Boolean)
    • :lat_lon_options - (Hash)
      • :default_value - (String)
      • :source_field - (String)
      • :facet_enabled - (Boolean)
      • :search_enabled - (Boolean)
      • :return_enabled - (Boolean)
      • :sort_enabled - (Boolean)
    • :int_array_options - (Hash)
      • :default_value - (Integer)
      • :source_fields - (String)
      • :facet_enabled - (Boolean)
      • :search_enabled - (Boolean)
      • :return_enabled - (Boolean)
    • :double_array_options - (Hash)
      • :default_value - (Float)
      • :source_fields - (String)
      • :facet_enabled - (Boolean)
      • :search_enabled - (Boolean)
      • :return_enabled - (Boolean)
    • :literal_array_options - (Hash)
      • :default_value - (String)
      • :source_fields - (String)
      • :facet_enabled - (Boolean)
      • :search_enabled - (Boolean)
      • :return_enabled - (Boolean)
    • :text_array_options - (Hash)
      • :default_value - (String)
      • :source_fields - (String)
      • :return_enabled - (Boolean)
      • :highlight_enabled - (Boolean)
      • :analysis_scheme - (String)
    • :date_array_options - (Hash)
      • :default_value - (String)
      • :source_fields - (String)
      • :facet_enabled - (Boolean)
      • :search_enabled - (Boolean)
      • :return_enabled - (Boolean)

Returns:

• (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)
      • :int_options - (Hash)
        • :default_value - (Integer)
        • :source_field - (String)
        • :facet_enabled - (Boolean)
        • :search_enabled - (Boolean)
        • :return_enabled - (Boolean)
        • :sort_enabled - (Boolean)
      • :double_options - (Hash)
        • :default_value - (Numeric)
        • :source_field - (String)
        • :facet_enabled - (Boolean)
        • :search_enabled - (Boolean)
        • :return_enabled - (Boolean)
        • :sort_enabled - (Boolean)
      • :literal_options - (Hash)
        • :default_value - (String)
        • :source_field - (String)
        • :facet_enabled - (Boolean)
        • :search_enabled - (Boolean)
        • :return_enabled - (Boolean)
        • :sort_enabled - (Boolean)
      • :text_options - (Hash)
        • :default_value - (String)
        • :source_field - (String)
        • :return_enabled - (Boolean)
        • :sort_enabled - (Boolean)
        • :highlight_enabled - (Boolean)
        • :analysis_scheme - (String)
      • :date_options - (Hash)
        • :default_value - (String)
        • :source_field - (String)
        • :facet_enabled - (Boolean)
        • :search_enabled - (Boolean)
        • :return_enabled - (Boolean)
        • :sort_enabled - (Boolean)
      • :lat_lon_options - (Hash)
        • :default_value - (String)
        • :source_field - (String)
        • :facet_enabled - (Boolean)
        • :search_enabled - (Boolean)
        • :return_enabled - (Boolean)
        • :sort_enabled - (Boolean)
      • :int_array_options - (Hash)
        • :default_value - (Integer)
        • :source_fields - (String)
        • :facet_enabled - (Boolean)
        • :search_enabled - (Boolean)
        • :return_enabled - (Boolean)
      • :double_array_options - (Hash)
        • :default_value - (Numeric)
        • :source_fields - (String)
        • :facet_enabled - (Boolean)
        • :search_enabled - (Boolean)
        • :return_enabled - (Boolean)
      • :literal_array_options - (Hash)
        • :default_value - (String)
        • :source_fields - (String)
        • :facet_enabled - (Boolean)
        • :search_enabled - (Boolean)
        • :return_enabled - (Boolean)
      • :text_array_options - (Hash)
        • :default_value - (String)
        • :source_fields - (String)
        • :return_enabled - (Boolean)
        • :highlight_enabled - (Boolean)
        • :analysis_scheme - (String)
      • :date_array_options - (Hash)
        • :default_value - (String)
        • :source_fields - (String)
        • :facet_enabled - (Boolean)
        • :search_enabled - (Boolean)
        • :return_enabled - (Boolean)
    • :status - (Hash)
      • :creation_date - (Time)
      • :update_date - (Time)
      • :update_version - (Integer)
      • :state - (String)
      • :pending_deletion - (Boolean)

#define_suggester(options = {}) ⇒ Core::Response

Calls the DefineSuggester API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :domain_name - required - (String)
  • :suggester - required - (Hash)
    • :suggester_name - required - (String)
    • :document_suggester_options - required - (Hash)
      • :source_field - required - (String)
      • :fuzzy_matching - (String) Valid values include:
        • none
        • low
        • high
      • :sort_expression - (String)

Returns:

• (Core::Response) —

  The #data method of the response object returns a hash with the following structure:

  • :suggester - (Hash)
    • :options - (Hash)
      • :suggester_name - (String)
      • :document_suggester_options - (Hash)
        • :source_field - (String)
        • :fuzzy_matching - (String)
        • :sort_expression - (String)
    • :status - (Hash)
      • :creation_date - (Time)
      • :update_date - (Time)
      • :update_version - (Integer)
      • :state - (String)
      • :pending_deletion - (Boolean)

#delete_analysis_scheme(options = {}) ⇒ Core::Response

Calls the DeleteAnalysisScheme API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :domain_name - required - (String)
  • :analysis_scheme_name - required - (String)

Returns:

• (Core::Response) —

  The #data method of the response object returns a hash with the following structure:

  • :analysis_scheme - (Hash)
    • :options - (Hash)
      • :analysis_scheme_name - (String)
      • :analysis_scheme_language - (String)
      • :analysis_options - (Hash)
        • :synonyms - (String)
        • :stopwords - (String)
        • :stemming_dictionary - (String)
        • :japanese_tokenization_dictionary - (String)
        • :algorithmic_stemming - (String)
    • :status - (Hash)
      • :creation_date - (Time)
      • :update_date - (Time)
      • :update_version - (Integer)
      • :state - (String)
      • :pending_deletion - (Boolean)

#delete_domain(options = {}) ⇒ Core::Response

Calls the DeleteDomain API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :domain_name - required - (String)

Returns:

• (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)
    • :arn - (String)
    • :created - (Boolean)
    • :deleted - (Boolean)
    • :doc_service - (Hash)
      • :endpoint - (String)
    • :search_service - (Hash)
      • :endpoint - (String)
    • :requires_index_documents - (Boolean)
    • :processing - (Boolean)
    • :search_instance_type - (String)
    • :search_partition_count - (Integer)
    • :search_instance_count - (Integer)
    • :limits - (Hash)
      • :maximum_replication_count - (Integer)
      • :maximum_partition_count - (Integer)

#delete_expression(options = {}) ⇒ Core::Response

Calls the DeleteExpression API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :domain_name - required - (String)
  • :expression_name - required - (String)

Returns:

• (Core::Response) —

  The #data method of the response object returns a hash with the following structure:

  • :expression - (Hash)
    • :options - (Hash)
      • :expression_name - (String)
      • :expression_value - (String)
    • :status - (Hash)
      • :creation_date - (Time)
      • :update_date - (Time)
      • :update_version - (Integer)
      • :state - (String)
      • :pending_deletion - (Boolean)

#delete_index_field(options = {}) ⇒ Core::Response

Calls the DeleteIndexField API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :domain_name - required - (String)
  • :index_field_name - required - (String)

Returns:

• (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)
      • :int_options - (Hash)
        • :default_value - (Integer)
        • :source_field - (String)
        • :facet_enabled - (Boolean)
        • :search_enabled - (Boolean)
        • :return_enabled - (Boolean)
        • :sort_enabled - (Boolean)
      • :double_options - (Hash)
        • :default_value - (Numeric)
        • :source_field - (String)
        • :facet_enabled - (Boolean)
        • :search_enabled - (Boolean)
        • :return_enabled - (Boolean)
        • :sort_enabled - (Boolean)
      • :literal_options - (Hash)
        • :default_value - (String)
        • :source_field - (String)
        • :facet_enabled - (Boolean)
        • :search_enabled - (Boolean)
        • :return_enabled - (Boolean)
        • :sort_enabled - (Boolean)
      • :text_options - (Hash)
        • :default_value - (String)
        • :source_field - (String)
        • :return_enabled - (Boolean)
        • :sort_enabled - (Boolean)
        • :highlight_enabled - (Boolean)
        • :analysis_scheme - (String)
      • :date_options - (Hash)
        • :default_value - (String)
        • :source_field - (String)
        • :facet_enabled - (Boolean)
        • :search_enabled - (Boolean)
        • :return_enabled - (Boolean)
        • :sort_enabled - (Boolean)
      • :lat_lon_options - (Hash)
        • :default_value - (String)
        • :source_field - (String)
        • :facet_enabled - (Boolean)
        • :search_enabled - (Boolean)
        • :return_enabled - (Boolean)
        • :sort_enabled - (Boolean)
      • :int_array_options - (Hash)
        • :default_value - (Integer)
        • :source_fields - (String)
        • :facet_enabled - (Boolean)
        • :search_enabled - (Boolean)
        • :return_enabled - (Boolean)
      • :double_array_options - (Hash)
        • :default_value - (Numeric)
        • :source_fields - (String)
        • :facet_enabled - (Boolean)
        • :search_enabled - (Boolean)
        • :return_enabled - (Boolean)
      • :literal_array_options - (Hash)
        • :default_value - (String)
        • :source_fields - (String)
        • :facet_enabled - (Boolean)
        • :search_enabled - (Boolean)
        • :return_enabled - (Boolean)
      • :text_array_options - (Hash)
        • :default_value - (String)
        • :source_fields - (String)
        • :return_enabled - (Boolean)
        • :highlight_enabled - (Boolean)
        • :analysis_scheme - (String)
      • :date_array_options - (Hash)
        • :default_value - (String)
        • :source_fields - (String)
        • :facet_enabled - (Boolean)
        • :search_enabled - (Boolean)
        • :return_enabled - (Boolean)
    • :status - (Hash)
      • :creation_date - (Time)
      • :update_date - (Time)
      • :update_version - (Integer)
      • :state - (String)
      • :pending_deletion - (Boolean)

#delete_suggester(options = {}) ⇒ Core::Response

Calls the DeleteSuggester API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :domain_name - required - (String)
  • :suggester_name - required - (String)

Returns:

• (Core::Response) —

  The #data method of the response object returns a hash with the following structure:

  • :suggester - (Hash)
    • :options - (Hash)
      • :suggester_name - (String)
      • :document_suggester_options - (Hash)
        • :source_field - (String)
        • :fuzzy_matching - (String)
        • :sort_expression - (String)
    • :status - (Hash)
      • :creation_date - (Time)
      • :update_date - (Time)
      • :update_version - (Integer)
      • :state - (String)
      • :pending_deletion - (Boolean)

#describe_analysis_schemes(options = {}) ⇒ Core::Response

Calls the DescribeAnalysisSchemes API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :domain_name - required - (String)
  • :analysis_scheme_names - (Array<)
  • :deployed - (Boolean)

Returns:

• (Core::Response) —

  The #data method of the response object returns a hash with the following structure:

  • :analysis_schemes - (Array)
    • :options - (Hash)
      • :analysis_scheme_name - (String)
      • :analysis_scheme_language - (String)
      • :analysis_options - (Hash)
        • :synonyms - (String)
        • :stopwords - (String)
        • :stemming_dictionary - (String)
        • :japanese_tokenization_dictionary - (String)
        • :algorithmic_stemming - (String)
    • :status - (Hash)
      • :creation_date - (Time)
      • :update_date - (Time)
      • :update_version - (Integer)
      • :state - (String)
      • :pending_deletion - (Boolean)

#describe_availability_options(options = {}) ⇒ Core::Response

Calls the DescribeAvailabilityOptions API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :domain_name - required - (String) The name of the domain you want to describe.
  • :deployed - (Boolean)

Returns:

• (Core::Response) —

  The #data method of the response object returns a hash with the following structure:

  • :availability_options - (Hash)
    • :options - (Boolean)
    • :status - (Hash)
      • :creation_date - (Time)
      • :update_date - (Time)
      • :update_version - (Integer)
      • :state - (String)
      • :pending_deletion - (Boolean)

#describe_domains(options = {}) ⇒ Core::Response

Calls the DescribeDomains API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :domain_names - (Array<) Limits the DescribeDomains response to the specified search domains.

Returns:

• (Core::Response) —

  The #data method of the response object returns a hash with the following structure:

  • :domain_status_list - (Array)
    • :domain_id - (String)
    • :domain_name - (String)
    • :arn - (String)
    • :created - (Boolean)
    • :deleted - (Boolean)
    • :doc_service - (Hash)
      • :endpoint - (String)
    • :search_service - (Hash)
      • :endpoint - (String)
    • :requires_index_documents - (Boolean)
    • :processing - (Boolean)
    • :search_instance_type - (String)
    • :search_partition_count - (Integer)
    • :search_instance_count - (Integer)
    • :limits - (Hash)
      • :maximum_replication_count - (Integer)
      • :maximum_partition_count - (Integer)

#describe_expressions(options = {}) ⇒ Core::Response

Calls the DescribeExpressions API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :domain_name - required - (String)
  • :expression_names - (Array<)
  • :deployed - (Boolean)

Returns:

• (Core::Response) —

  The #data method of the response object returns a hash with the following structure:

  • :expressions - (Array)
    • :options - (Hash)
      • :expression_name - (String)
      • :expression_value - (String)
    • :status - (Hash)
      • :creation_date - (Time)
      • :update_date - (Time)
      • :update_version - (Integer)
      • :state - (String)
      • :pending_deletion - (Boolean)

#describe_index_fields(options = {}) ⇒ Core::Response

Calls the DescribeIndexFields API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :domain_name - required - (String)
  • :field_names - (Array<) Limits the DescribeIndexFields response to the specified fields.
  • :deployed - (Boolean)

Returns:

• (Core::Response) —

  The #data method of the response object returns a hash with the following structure:

  • :index_fields - (Array)
    • :options - (Hash)
      • :index_field_name - (String)
      • :index_field_type - (String)
      • :int_options - (Hash)
        • :default_value - (Integer)
        • :source_field - (String)
        • :facet_enabled - (Boolean)
        • :search_enabled - (Boolean)
        • :return_enabled - (Boolean)
        • :sort_enabled - (Boolean)
      • :double_options - (Hash)
        • :default_value - (Numeric)
        • :source_field - (String)
        • :facet_enabled - (Boolean)
        • :search_enabled - (Boolean)
        • :return_enabled - (Boolean)
        • :sort_enabled - (Boolean)
      • :literal_options - (Hash)
        • :default_value - (String)
        • :source_field - (String)
        • :facet_enabled - (Boolean)
        • :search_enabled - (Boolean)
        • :return_enabled - (Boolean)
        • :sort_enabled - (Boolean)
      • :text_options - (Hash)
        • :default_value - (String)
        • :source_field - (String)
        • :return_enabled - (Boolean)
        • :sort_enabled - (Boolean)
        • :highlight_enabled - (Boolean)
        • :analysis_scheme - (String)
      • :date_options - (Hash)
        • :default_value - (String)
        • :source_field - (String)
        • :facet_enabled - (Boolean)
        • :search_enabled - (Boolean)
        • :return_enabled - (Boolean)
        • :sort_enabled - (Boolean)
      • :lat_lon_options - (Hash)
        • :default_value - (String)
        • :source_field - (String)
        • :facet_enabled - (Boolean)
        • :search_enabled - (Boolean)
        • :return_enabled - (Boolean)
        • :sort_enabled - (Boolean)
      • :int_array_options - (Hash)
        • :default_value - (Integer)
        • :source_fields - (String)
        • :facet_enabled - (Boolean)
        • :search_enabled - (Boolean)
        • :return_enabled - (Boolean)
      • :double_array_options - (Hash)
        • :default_value - (Numeric)
        • :source_fields - (String)
        • :facet_enabled - (Boolean)
        • :search_enabled - (Boolean)
        • :return_enabled - (Boolean)
      • :literal_array_options - (Hash)
        • :default_value - (String)
        • :source_fields - (String)
        • :facet_enabled - (Boolean)
        • :search_enabled - (Boolean)
        • :return_enabled - (Boolean)
      • :text_array_options - (Hash)
        • :default_value - (String)
        • :source_fields - (String)
        • :return_enabled - (Boolean)
        • :highlight_enabled - (Boolean)
        • :analysis_scheme - (String)
      • :date_array_options - (Hash)
        • :default_value - (String)
        • :source_fields - (String)
        • :facet_enabled - (Boolean)
        • :search_enabled - (Boolean)
        • :return_enabled - (Boolean)
    • :status - (Hash)
      • :creation_date - (Time)
      • :update_date - (Time)
      • :update_version - (Integer)
      • :state - (String)
      • :pending_deletion - (Boolean)

#describe_scaling_parameters(options = {}) ⇒ Core::Response

Calls the DescribeScalingParameters API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :domain_name - required - (String)

Returns:

• (Core::Response) —

  The #data method of the response object returns a hash with the following structure:

  • :scaling_parameters - (Hash)
    • :options - (Hash)
      • :desired_instance_type - (String)
      • :desired_replication_count - (Integer)
      • :desired_partition_count - (Integer)
    • :status - (Hash)
      • :creation_date - (Time)
      • :update_date - (Time)
      • :update_version - (Integer)
      • :state - (String)
      • :pending_deletion - (Boolean)

#describe_service_access_policies(options = {}) ⇒ Core::Response

Calls the DescribeServiceAccessPolicies API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :domain_name - required - (String)
  • :deployed - (Boolean)

Returns:

• (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)
      • :pending_deletion - (Boolean)

#describe_suggesters(options = {}) ⇒ Core::Response

Calls the DescribeSuggesters API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :domain_name - required - (String)
  • :suggester_names - (Array<)
  • :deployed - (Boolean)

Returns:

• (Core::Response) —

  The #data method of the response object returns a hash with the following structure:

  • :suggesters - (Array)
    • :options - (Hash)
      • :suggester_name - (String)
      • :document_suggester_options - (Hash)
        • :source_field - (String)
        • :fuzzy_matching - (String)
        • :sort_expression - (String)
    • :status - (Hash)
      • :creation_date - (Time)
      • :update_date - (Time)
      • :update_version - (Integer)
      • :state - (String)
      • :pending_deletion - (Boolean)

#index_documents(options = {}) ⇒ Core::Response

Calls the IndexDocuments API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :domain_name - required - (String)

Returns:

• (Core::Response) —

  The #data method of the response object returns a hash with the following structure:

  • :field_names - (Array)

#list_domain_names(options = {}) ⇒ Core::Response

Calls the ListDomainNames API operation.

Parameters:

• options (Hash) (defaults to: {})

Returns:

• (Core::Response) —

  The #data method of the response object returns a hash with the following structure:

  • :domain_names - (Hash<String,String>)

#update_availability_options(options = {}) ⇒ Core::Response

Calls the UpdateAvailabilityOptions API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :domain_name - required - (String)
  • :multi_az - required - (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 .

Returns:

• (Core::Response) —

  The #data method of the response object returns a hash with the following structure:

  • :availability_options - (Hash)
    • :options - (Boolean)
    • :status - (Hash)
      • :creation_date - (Time)
      • :update_date - (Time)
      • :update_version - (Integer)
      • :state - (String)
      • :pending_deletion - (Boolean)

#update_scaling_parameters(options = {}) ⇒ Core::Response

Calls the UpdateScalingParameters API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :domain_name - required - (String)
  • :scaling_parameters - required - (Hash)
    • :desired_instance_type - (String) Valid values include:
      • search.m1.small
      • search.m1.large
      • search.m2.xlarge
      • search.m2.2xlarge
    • :desired_replication_count - (Integer)
    • :desired_partition_count - (Integer)

Returns:

• (Core::Response) —

  The #data method of the response object returns a hash with the following structure:

  • :scaling_parameters - (Hash)
    • :options - (Hash)
      • :desired_instance_type - (String)
      • :desired_replication_count - (Integer)
      • :desired_partition_count - (Integer)
    • :status - (Hash)
      • :creation_date - (Time)
      • :update_date - (Time)
      • :update_version - (Integer)
      • :state - (String)
      • :pending_deletion - (Boolean)

#update_service_access_policies(options = {}) ⇒ Core::Response

Calls the UpdateServiceAccessPolicies API operation.

Parameters:

• options (Hash) (defaults to: {}) —
  • :domain_name - required - (String)
  • :access_policies - required - (String)

Returns:

• (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)
      • :pending_deletion - (Boolean)