Class: Aws::CloudSearch::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
Aws::ClientStubs
Defined in:
lib/aws-sdk-cloudsearch/client.rb

Overview

An API client for CloudSearch. To construct a client, you need to configure a `:region` and `:credentials`.

client = Aws::CloudSearch::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See #initialize for a full list of supported configuration options.

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider)

    Your AWS credentials. This can be an instance of any one of the following classes:

    • `Aws::Credentials` - Used for configuring static, non-refreshing credentials.

    • `Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

    • `Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    • `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

    • `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

    • `Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

    • `Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • `Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

    • `Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

    When `:credentials` are not configured directly, the following locations will be searched for credentials:

    • `Aws.config`

    • The `:access_key_id`, `:secret_access_key`, and `:session_token` options.

    • ENV, ENV

    • `~/.aws/credentials`

    • `~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to enable retries and extended timeouts.

  • :region (required, String)

    The AWS region to connect to. The configured `:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:

  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false

    When set to `true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true

    Used only in `adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false

    When `true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: ""

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1"

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true

    When `true`, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true

    Used only in `standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :disable_host_prefix_injection (Boolean) — default: false

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String)

    The client endpoint is normally constructed from the `:region` option. You should only configure an `:endpoint` when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false

    When set to `true`, endpoint discovery will be enabled for operations when available.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default

    The log formatter.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the `:logger` at.

  • :logger (Logger)

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in `standard` and `adaptive` retry modes.

  • :profile (String) — default: "default"

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_backoff (Proc)

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the `legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function. This option is only used in the `legacy` retry mode.

  • :retry_jitter (Symbol) — default: :none

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the `legacy` retry mode.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the `legacy` retry mode.

  • :retry_max_delay (Integer) — default: 0

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the `legacy` retry mode.

  • :retry_mode (String) — default: "legacy"

    Specifies which retry algorithm to use. Values are:

    • `legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • `standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • `adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :validate_params (Boolean) — default: true

    When `true`, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String)

    A proxy to send requests through. Formatted like 'proxy.com:123'.

  • :http_open_timeout (Float) — default: 15

    The number of seconds to wait when opening a HTTP session before raising a `Timeout::Error`.

  • :http_read_timeout (Integer) — default: 60

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to `nil` which disables this behaviour. This value can safely be set per request on the session.

  • :http_wire_trace (Boolean) — default: false

    When `true`, HTTP debug output will be sent to the `:logger`.

  • :ssl_verify_peer (Boolean) — default: true

    When `true`, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String)

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_directory (String)

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.


324
325
326
# File 'lib/aws-sdk-cloudsearch/client.rb', line 324

def initialize(*args)
  super
end

Class Attribute Details

.identifierObject (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


1861
1862
1863
# File 'lib/aws-sdk-cloudsearch/client.rb', line 1861

def identifier
  @identifier
end

Class Method Details

.errors_moduleObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


1864
1865
1866
# File 'lib/aws-sdk-cloudsearch/client.rb', line 1864

def errors_module
  Errors
end

Instance Method Details

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

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

1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
# File 'lib/aws-sdk-cloudsearch/client.rb', line 1839

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config)
  context[:gem_name] = 'aws-sdk-cloudsearch'
  context[:gem_version] = '1.29.0'
  Seahorse::Client::Request.new(handlers, context)
end

#build_suggesters(params = {}) ⇒ Types::BuildSuggestersResponse

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

[1]: docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html#configuring-suggesters

Examples:

Request syntax with placeholder values


resp = client.build_suggesters({
  domain_name: "DomainName", # required
})

Response structure


resp.field_names #=> Array
resp.field_names[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, 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).

Returns:


360
361
362
363
# File 'lib/aws-sdk-cloudsearch/client.rb', line 360

def build_suggesters(params = {}, options = {})
  req = build_request(:build_suggesters, params)
  req.send_request(options)
end

#create_domain(params = {}) ⇒ Types::CreateDomainResponse

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

[1]: docs.aws.amazon.com/cloudsearch/latest/developerguide/creating-domains.html

Examples:

Request syntax with placeholder values


resp = client.create_domain({
  domain_name: "DomainName", # required
})

Response structure


resp.domain_status.domain_id #=> String
resp.domain_status.domain_name #=> String
resp.domain_status.arn #=> String
resp.domain_status.created #=> Boolean
resp.domain_status.deleted #=> Boolean
resp.domain_status.doc_service.endpoint #=> String
resp.domain_status.search_service.endpoint #=> String
resp.domain_status.requires_index_documents #=> Boolean
resp.domain_status.processing #=> Boolean
resp.domain_status.search_instance_type #=> String
resp.domain_status.search_partition_count #=> Integer
resp.domain_status.search_instance_count #=> Integer
resp.domain_status.limits.maximum_replication_count #=> Integer
resp.domain_status.limits.maximum_partition_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, 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.

Returns:


407
408
409
410
# File 'lib/aws-sdk-cloudsearch/client.rb', line 407

def create_domain(params = {}, options = {})
  req = build_request(:create_domain, params)
  req.send_request(options)
end

#define_analysis_scheme(params = {}) ⇒ Types::DefineAnalysisSchemeResponse

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

[1]: docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html

Examples:

Request syntax with placeholder values


resp = client.define_analysis_scheme({
  domain_name: "DomainName", # required
  analysis_scheme: { # required
    analysis_scheme_name: "StandardName", # required
    analysis_scheme_language: "ar", # required, accepts 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: {
      synonyms: "String",
      stopwords: "String",
      stemming_dictionary: "String",
      japanese_tokenization_dictionary: "String",
      algorithmic_stemming: "none", # accepts none, minimal, light, full
    },
  },
})

Response structure


resp.analysis_scheme.options.analysis_scheme_name #=> String
resp.analysis_scheme.options.analysis_scheme_language #=> String, one of "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"
resp.analysis_scheme.options.analysis_options.synonyms #=> String
resp.analysis_scheme.options.analysis_options.stopwords #=> String
resp.analysis_scheme.options.analysis_options.stemming_dictionary #=> String
resp.analysis_scheme.options.analysis_options.japanese_tokenization_dictionary #=> String
resp.analysis_scheme.options.analysis_options.algorithmic_stemming #=> String, one of "none", "minimal", "light", "full"
resp.analysis_scheme.status.creation_date #=> Time
resp.analysis_scheme.status.update_date #=> Time
resp.analysis_scheme.status.update_version #=> Integer
resp.analysis_scheme.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
resp.analysis_scheme.status.pending_deletion #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, 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).

  • :analysis_scheme (required, Types::AnalysisScheme)

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

Returns:


472
473
474
475
# File 'lib/aws-sdk-cloudsearch/client.rb', line 472

def define_analysis_scheme(params = {}, options = {})
  req = build_request(:define_analysis_scheme, params)
  req.send_request(options)
end

#define_expression(params = {}) ⇒ Types::DefineExpressionResponse

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][1

in the *Amazon CloudSearch Developer

Guide*.

[1]: docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html

Examples:

Request syntax with placeholder values


resp = client.define_expression({
  domain_name: "DomainName", # required
  expression: { # required
    expression_name: "StandardName", # required
    expression_value: "ExpressionValue", # required
  },
})

Response structure


resp.expression.options.expression_name #=> String
resp.expression.options.expression_value #=> String
resp.expression.status.creation_date #=> Time
resp.expression.status.update_date #=> Time
resp.expression.status.update_version #=> Integer
resp.expression.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
resp.expression.status.pending_deletion #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, 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 (required, Types::Expression)

    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.

Returns:


524
525
526
527
# File 'lib/aws-sdk-cloudsearch/client.rb', line 524

def define_expression(params = {}, options = {})
  req = build_request(:define_expression, params)
  req.send_request(options)
end

#define_index_field(params = {}) ⇒ Types::DefineIndexFieldResponse

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][1

in the *Amazon CloudSearch Developer

Guide*.

[1]: docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html

Examples:

Request syntax with placeholder values


resp = client.define_index_field({
  domain_name: "DomainName", # required
  index_field: { # required
    index_field_name: "DynamicFieldName", # required
    index_field_type: "int", # required, accepts int, double, literal, text, date, latlon, int-array, double-array, literal-array, text-array, date-array
    int_options: {
      default_value: 1,
      source_field: "FieldName",
      facet_enabled: false,
      search_enabled: false,
      return_enabled: false,
      sort_enabled: false,
    },
    double_options: {
      default_value: 1.0,
      source_field: "FieldName",
      facet_enabled: false,
      search_enabled: false,
      return_enabled: false,
      sort_enabled: false,
    },
    literal_options: {
      default_value: "FieldValue",
      source_field: "FieldName",
      facet_enabled: false,
      search_enabled: false,
      return_enabled: false,
      sort_enabled: false,
    },
    text_options: {
      default_value: "FieldValue",
      source_field: "FieldName",
      return_enabled: false,
      sort_enabled: false,
      highlight_enabled: false,
      analysis_scheme: "Word",
    },
    date_options: {
      default_value: "FieldValue",
      source_field: "FieldName",
      facet_enabled: false,
      search_enabled: false,
      return_enabled: false,
      sort_enabled: false,
    },
    lat_lon_options: {
      default_value: "FieldValue",
      source_field: "FieldName",
      facet_enabled: false,
      search_enabled: false,
      return_enabled: false,
      sort_enabled: false,
    },
    int_array_options: {
      default_value: 1,
      source_fields: "FieldNameCommaList",
      facet_enabled: false,
      search_enabled: false,
      return_enabled: false,
    },
    double_array_options: {
      default_value: 1.0,
      source_fields: "FieldNameCommaList",
      facet_enabled: false,
      search_enabled: false,
      return_enabled: false,
    },
    literal_array_options: {
      default_value: "FieldValue",
      source_fields: "FieldNameCommaList",
      facet_enabled: false,
      search_enabled: false,
      return_enabled: false,
    },
    text_array_options: {
      default_value: "FieldValue",
      source_fields: "FieldNameCommaList",
      return_enabled: false,
      highlight_enabled: false,
      analysis_scheme: "Word",
    },
    date_array_options: {
      default_value: "FieldValue",
      source_fields: "FieldNameCommaList",
      facet_enabled: false,
      search_enabled: false,
      return_enabled: false,
    },
  },
})

Response structure


resp.index_field.options.index_field_name #=> String
resp.index_field.options.index_field_type #=> String, one of "int", "double", "literal", "text", "date", "latlon", "int-array", "double-array", "literal-array", "text-array", "date-array"
resp.index_field.options.int_options.default_value #=> Integer
resp.index_field.options.int_options.source_field #=> String
resp.index_field.options.int_options.facet_enabled #=> Boolean
resp.index_field.options.int_options.search_enabled #=> Boolean
resp.index_field.options.int_options.return_enabled #=> Boolean
resp.index_field.options.int_options.sort_enabled #=> Boolean
resp.index_field.options.double_options.default_value #=> Float
resp.index_field.options.double_options.source_field #=> String
resp.index_field.options.double_options.facet_enabled #=> Boolean
resp.index_field.options.double_options.search_enabled #=> Boolean
resp.index_field.options.double_options.return_enabled #=> Boolean
resp.index_field.options.double_options.sort_enabled #=> Boolean
resp.index_field.options.literal_options.default_value #=> String
resp.index_field.options.literal_options.source_field #=> String
resp.index_field.options.literal_options.facet_enabled #=> Boolean
resp.index_field.options.literal_options.search_enabled #=> Boolean
resp.index_field.options.literal_options.return_enabled #=> Boolean
resp.index_field.options.literal_options.sort_enabled #=> Boolean
resp.index_field.options.text_options.default_value #=> String
resp.index_field.options.text_options.source_field #=> String
resp.index_field.options.text_options.return_enabled #=> Boolean
resp.index_field.options.text_options.sort_enabled #=> Boolean
resp.index_field.options.text_options.highlight_enabled #=> Boolean
resp.index_field.options.text_options.analysis_scheme #=> String
resp.index_field.options.date_options.default_value #=> String
resp.index_field.options.date_options.source_field #=> String
resp.index_field.options.date_options.facet_enabled #=> Boolean
resp.index_field.options.date_options.search_enabled #=> Boolean
resp.index_field.options.date_options.return_enabled #=> Boolean
resp.index_field.options.date_options.sort_enabled #=> Boolean
resp.index_field.options.lat_lon_options.default_value #=> String
resp.index_field.options.lat_lon_options.source_field #=> String
resp.index_field.options.lat_lon_options.facet_enabled #=> Boolean
resp.index_field.options.lat_lon_options.search_enabled #=> Boolean
resp.index_field.options.lat_lon_options.return_enabled #=> Boolean
resp.index_field.options.lat_lon_options.sort_enabled #=> Boolean
resp.index_field.options.int_array_options.default_value #=> Integer
resp.index_field.options.int_array_options.source_fields #=> String
resp.index_field.options.int_array_options.facet_enabled #=> Boolean
resp.index_field.options.int_array_options.search_enabled #=> Boolean
resp.index_field.options.int_array_options.return_enabled #=> Boolean
resp.index_field.options.double_array_options.default_value #=> Float
resp.index_field.options.double_array_options.source_fields #=> String
resp.index_field.options.double_array_options.facet_enabled #=> Boolean
resp.index_field.options.double_array_options.search_enabled #=> Boolean
resp.index_field.options.double_array_options.return_enabled #=> Boolean
resp.index_field.options.literal_array_options.default_value #=> String
resp.index_field.options.literal_array_options.source_fields #=> String
resp.index_field.options.literal_array_options.facet_enabled #=> Boolean
resp.index_field.options.literal_array_options.search_enabled #=> Boolean
resp.index_field.options.literal_array_options.return_enabled #=> Boolean
resp.index_field.options.text_array_options.default_value #=> String
resp.index_field.options.text_array_options.source_fields #=> String
resp.index_field.options.text_array_options.return_enabled #=> Boolean
resp.index_field.options.text_array_options.highlight_enabled #=> Boolean
resp.index_field.options.text_array_options.analysis_scheme #=> String
resp.index_field.options.date_array_options.default_value #=> String
resp.index_field.options.date_array_options.source_fields #=> String
resp.index_field.options.date_array_options.facet_enabled #=> Boolean
resp.index_field.options.date_array_options.search_enabled #=> Boolean
resp.index_field.options.date_array_options.return_enabled #=> Boolean
resp.index_field.status.creation_date #=> Time
resp.index_field.status.update_date #=> Time
resp.index_field.status.update_version #=> Integer
resp.index_field.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
resp.index_field.status.pending_deletion #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, 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).

  • :index_field (required, Types::IndexField)

    The index field and field options you want to configure.

Returns:


722
723
724
725
# File 'lib/aws-sdk-cloudsearch/client.rb', line 722

def define_index_field(params = {}, options = {})
  req = build_request(:define_index_field, params)
  req.send_request(options)
end

#define_suggester(params = {}) ⇒ Types::DefineSuggesterResponse

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

[1]: docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html

Examples:

Request syntax with placeholder values


resp = client.define_suggester({
  domain_name: "DomainName", # required
  suggester: { # required
    suggester_name: "StandardName", # required
    document_suggester_options: { # required
      source_field: "FieldName", # required
      fuzzy_matching: "none", # accepts none, low, high
      sort_expression: "String",
    },
  },
})

Response structure


resp.suggester.options.suggester_name #=> String
resp.suggester.options.document_suggester_options.source_field #=> String
resp.suggester.options.document_suggester_options.fuzzy_matching #=> String, one of "none", "low", "high"
resp.suggester.options.document_suggester_options.sort_expression #=> String
resp.suggester.status.creation_date #=> Time
resp.suggester.status.update_date #=> Time
resp.suggester.status.update_version #=> Integer
resp.suggester.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
resp.suggester.status.pending_deletion #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, 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 (required, Types::Suggester)

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

Returns:


782
783
784
785
# File 'lib/aws-sdk-cloudsearch/client.rb', line 782

def define_suggester(params = {}, options = {})
  req = build_request(:define_suggester, params)
  req.send_request(options)
end

#delete_analysis_scheme(params = {}) ⇒ Types::DeleteAnalysisSchemeResponse

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

[1]: docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html

Examples:

Request syntax with placeholder values


resp = client.delete_analysis_scheme({
  domain_name: "DomainName", # required
  analysis_scheme_name: "StandardName", # required
})

Response structure


resp.analysis_scheme.options.analysis_scheme_name #=> String
resp.analysis_scheme.options.analysis_scheme_language #=> String, one of "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"
resp.analysis_scheme.options.analysis_options.synonyms #=> String
resp.analysis_scheme.options.analysis_options.stopwords #=> String
resp.analysis_scheme.options.analysis_options.stemming_dictionary #=> String
resp.analysis_scheme.options.analysis_options.japanese_tokenization_dictionary #=> String
resp.analysis_scheme.options.analysis_options.algorithmic_stemming #=> String, one of "none", "minimal", "light", "full"
resp.analysis_scheme.status.creation_date #=> Time
resp.analysis_scheme.status.update_date #=> Time
resp.analysis_scheme.status.update_version #=> Integer
resp.analysis_scheme.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
resp.analysis_scheme.status.pending_deletion #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, 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).

  • :analysis_scheme_name (required, String)

    The name of the analysis scheme you want to delete.

Returns:


831
832
833
834
# File 'lib/aws-sdk-cloudsearch/client.rb', line 831

def delete_analysis_scheme(params = {}, options = {})
  req = build_request(:delete_analysis_scheme, params)
  req.send_request(options)
end

#delete_domain(params = {}) ⇒ Types::DeleteDomainResponse

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][1

in the *Amazon CloudSearch Developer

Guide*.

[1]: docs.aws.amazon.com/cloudsearch/latest/developerguide/deleting-domains.html

Examples:

Request syntax with placeholder values


resp = client.delete_domain({
  domain_name: "DomainName", # required
})

Response structure


resp.domain_status.domain_id #=> String
resp.domain_status.domain_name #=> String
resp.domain_status.arn #=> String
resp.domain_status.created #=> Boolean
resp.domain_status.deleted #=> Boolean
resp.domain_status.doc_service.endpoint #=> String
resp.domain_status.search_service.endpoint #=> String
resp.domain_status.requires_index_documents #=> Boolean
resp.domain_status.processing #=> Boolean
resp.domain_status.search_instance_type #=> String
resp.domain_status.search_partition_count #=> Integer
resp.domain_status.search_instance_count #=> Integer
resp.domain_status.limits.maximum_replication_count #=> Integer
resp.domain_status.limits.maximum_partition_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String)

    The name of the domain you want to permanently delete.

Returns:


877
878
879
880
# File 'lib/aws-sdk-cloudsearch/client.rb', line 877

def delete_domain(params = {}, options = {})
  req = build_request(:delete_domain, params)
  req.send_request(options)
end

#delete_expression(params = {}) ⇒ Types::DeleteExpressionResponse

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

[1]: docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html

Examples:

Request syntax with placeholder values


resp = client.delete_expression({
  domain_name: "DomainName", # required
  expression_name: "StandardName", # required
})

Response structure


resp.expression.options.expression_name #=> String
resp.expression.options.expression_value #=> String
resp.expression.status.creation_date #=> Time
resp.expression.status.update_date #=> Time
resp.expression.status.update_version #=> Integer
resp.expression.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
resp.expression.status.pending_deletion #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, 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_name (required, String)

    The name of the `Expression` to delete.

Returns:


922
923
924
925
# File 'lib/aws-sdk-cloudsearch/client.rb', line 922

def delete_expression(params = {}, options = {})
  req = build_request(:delete_expression, params)
  req.send_request(options)
end

#delete_index_field(params = {}) ⇒ Types::DeleteIndexFieldResponse

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

[1]: docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html

Examples:

Request syntax with placeholder values


resp = client.delete_index_field({
  domain_name: "DomainName", # required
  index_field_name: "DynamicFieldName", # required
})

Response structure


resp.index_field.options.index_field_name #=> String
resp.index_field.options.index_field_type #=> String, one of "int", "double", "literal", "text", "date", "latlon", "int-array", "double-array", "literal-array", "text-array", "date-array"
resp.index_field.options.int_options.default_value #=> Integer
resp.index_field.options.int_options.source_field #=> String
resp.index_field.options.int_options.facet_enabled #=> Boolean
resp.index_field.options.int_options.search_enabled #=> Boolean
resp.index_field.options.int_options.return_enabled #=> Boolean
resp.index_field.options.int_options.sort_enabled #=> Boolean
resp.index_field.options.double_options.default_value #=> Float
resp.index_field.options.double_options.source_field #=> String
resp.index_field.options.double_options.facet_enabled #=> Boolean
resp.index_field.options.double_options.search_enabled #=> Boolean
resp.index_field.options.double_options.return_enabled #=> Boolean
resp.index_field.options.double_options.sort_enabled #=> Boolean
resp.index_field.options.literal_options.default_value #=> String
resp.index_field.options.literal_options.source_field #=> String
resp.index_field.options.literal_options.facet_enabled #=> Boolean
resp.index_field.options.literal_options.search_enabled #=> Boolean
resp.index_field.options.literal_options.return_enabled #=> Boolean
resp.index_field.options.literal_options.sort_enabled #=> Boolean
resp.index_field.options.text_options.default_value #=> String
resp.index_field.options.text_options.source_field #=> String
resp.index_field.options.text_options.return_enabled #=> Boolean
resp.index_field.options.text_options.sort_enabled #=> Boolean
resp.index_field.options.text_options.highlight_enabled #=> Boolean
resp.index_field.options.text_options.analysis_scheme #=> String
resp.index_field.options.date_options.default_value #=> String
resp.index_field.options.date_options.source_field #=> String
resp.index_field.options.date_options.facet_enabled #=> Boolean
resp.index_field.options.date_options.search_enabled #=> Boolean
resp.index_field.options.date_options.return_enabled #=> Boolean
resp.index_field.options.date_options.sort_enabled #=> Boolean
resp.index_field.options.lat_lon_options.default_value #=> String
resp.index_field.options.lat_lon_options.source_field #=> String
resp.index_field.options.lat_lon_options.facet_enabled #=> Boolean
resp.index_field.options.lat_lon_options.search_enabled #=> Boolean
resp.index_field.options.lat_lon_options.return_enabled #=> Boolean
resp.index_field.options.lat_lon_options.sort_enabled #=> Boolean
resp.index_field.options.int_array_options.default_value #=> Integer
resp.index_field.options.int_array_options.source_fields #=> String
resp.index_field.options.int_array_options.facet_enabled #=> Boolean
resp.index_field.options.int_array_options.search_enabled #=> Boolean
resp.index_field.options.int_array_options.return_enabled #=> Boolean
resp.index_field.options.double_array_options.default_value #=> Float
resp.index_field.options.double_array_options.source_fields #=> String
resp.index_field.options.double_array_options.facet_enabled #=> Boolean
resp.index_field.options.double_array_options.search_enabled #=> Boolean
resp.index_field.options.double_array_options.return_enabled #=> Boolean
resp.index_field.options.literal_array_options.default_value #=> String
resp.index_field.options.literal_array_options.source_fields #=> String
resp.index_field.options.literal_array_options.facet_enabled #=> Boolean
resp.index_field.options.literal_array_options.search_enabled #=> Boolean
resp.index_field.options.literal_array_options.return_enabled #=> Boolean
resp.index_field.options.text_array_options.default_value #=> String
resp.index_field.options.text_array_options.source_fields #=> String
resp.index_field.options.text_array_options.return_enabled #=> Boolean
resp.index_field.options.text_array_options.highlight_enabled #=> Boolean
resp.index_field.options.text_array_options.analysis_scheme #=> String
resp.index_field.options.date_array_options.default_value #=> String
resp.index_field.options.date_array_options.source_fields #=> String
resp.index_field.options.date_array_options.facet_enabled #=> Boolean
resp.index_field.options.date_array_options.search_enabled #=> Boolean
resp.index_field.options.date_array_options.return_enabled #=> Boolean
resp.index_field.status.creation_date #=> Time
resp.index_field.status.update_date #=> Time
resp.index_field.status.update_version #=> Integer
resp.index_field.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
resp.index_field.status.pending_deletion #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, 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).

  • :index_field_name (required, String)

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

Returns:


1029
1030
1031
1032
# File 'lib/aws-sdk-cloudsearch/client.rb', line 1029

def delete_index_field(params = {}, options = {})
  req = build_request(:delete_index_field, params)
  req.send_request(options)
end

#delete_suggester(params = {}) ⇒ Types::DeleteSuggesterResponse

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

[1]: docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html

Examples:

Request syntax with placeholder values


resp = client.delete_suggester({
  domain_name: "DomainName", # required
  suggester_name: "StandardName", # required
})

Response structure


resp.suggester.options.suggester_name #=> String
resp.suggester.options.document_suggester_options.source_field #=> String
resp.suggester.options.document_suggester_options.fuzzy_matching #=> String, one of "none", "low", "high"
resp.suggester.options.document_suggester_options.sort_expression #=> String
resp.suggester.status.creation_date #=> Time
resp.suggester.status.update_date #=> Time
resp.suggester.status.update_version #=> Integer
resp.suggester.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
resp.suggester.status.pending_deletion #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, 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_name (required, String)

    Specifies the name of the suggester you want to delete.

Returns:


1075
1076
1077
1078
# File 'lib/aws-sdk-cloudsearch/client.rb', line 1075

def delete_suggester(params = {}, options = {})
  req = build_request(:delete_suggester, params)
  req.send_request(options)
end

#describe_analysis_schemes(params = {}) ⇒ Types::DescribeAnalysisSchemesResponse

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][1

in the *Amazon CloudSearch Developer

Guide*.

[1]: docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html

Examples:

Request syntax with placeholder values


resp = client.describe_analysis_schemes({
  domain_name: "DomainName", # required
  analysis_scheme_names: ["StandardName"],
  deployed: false,
})

Response structure


resp.analysis_schemes #=> Array
resp.analysis_schemes[0].options.analysis_scheme_name #=> String
resp.analysis_schemes[0].options.analysis_scheme_language #=> String, one of "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"
resp.analysis_schemes[0].options.analysis_options.synonyms #=> String
resp.analysis_schemes[0].options.analysis_options.stopwords #=> String
resp.analysis_schemes[0].options.analysis_options.stemming_dictionary #=> String
resp.analysis_schemes[0].options.analysis_options.japanese_tokenization_dictionary #=> String
resp.analysis_schemes[0].options.analysis_options.algorithmic_stemming #=> String, one of "none", "minimal", "light", "full"
resp.analysis_schemes[0].status.creation_date #=> Time
resp.analysis_schemes[0].status.update_date #=> Time
resp.analysis_schemes[0].status.update_version #=> Integer
resp.analysis_schemes[0].status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
resp.analysis_schemes[0].status.pending_deletion #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String)

    The name of the domain you want to describe.

  • :analysis_scheme_names (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`.

Returns:


1133
1134
1135
1136
# File 'lib/aws-sdk-cloudsearch/client.rb', line 1133

def describe_analysis_schemes(params = {}, options = {})
  req = build_request(:describe_analysis_schemes, params)
  req.send_request(options)
end

#describe_availability_options(params = {}) ⇒ Types::DescribeAvailabilityOptionsResponse

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

[1]: docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html

Examples:

Request syntax with placeholder values


resp = client.describe_availability_options({
  domain_name: "DomainName", # required
  deployed: false,
})

Response structure


resp.availability_options.options #=> Boolean
resp.availability_options.status.creation_date #=> Time
resp.availability_options.status.update_date #=> Time
resp.availability_options.status.update_version #=> Integer
resp.availability_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
resp.availability_options.status.pending_deletion #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, 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`.

Returns:


1177
1178
1179
1180
# File 'lib/aws-sdk-cloudsearch/client.rb', line 1177

def describe_availability_options(params = {}, options = {})
  req = build_request(:describe_availability_options, params)
  req.send_request(options)
end

#describe_domain_endpoint_options(params = {}) ⇒ Types::DescribeDomainEndpointOptionsResponse

Returns the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see [Configuring Domain Endpoint Options] in the *Amazon CloudSearch Developer Guide*.

[1]: docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-domain-endpoint-options.html

Examples:

Request syntax with placeholder values


resp = client.describe_domain_endpoint_options({
  domain_name: "DomainName", # required
  deployed: false,
})

Response structure


resp.domain_endpoint_options.options.enforce_https #=> Boolean
resp.domain_endpoint_options.options.tls_security_policy #=> String, one of "Policy-Min-TLS-1-0-2019-07", "Policy-Min-TLS-1-2-2019-07"
resp.domain_endpoint_options.status.creation_date #=> Time
resp.domain_endpoint_options.status.update_date #=> Time
resp.domain_endpoint_options.status.update_version #=> Integer
resp.domain_endpoint_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
resp.domain_endpoint_options.status.pending_deletion #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String)

    A string that represents the name of a domain.

  • :deployed (Boolean)

    Whether to retrieve the latest configuration (which might be in a Processing state) or the current, active configuration. Defaults to `false`.

Returns:


1222
1223
1224
1225
# File 'lib/aws-sdk-cloudsearch/client.rb', line 1222

def describe_domain_endpoint_options(params = {}, options = {})
  req = build_request(:describe_domain_endpoint_options, params)
  req.send_request(options)
end

#describe_domains(params = {}) ⇒ Types::DescribeDomainsResponse

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

[1]: docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html

Examples:

Request syntax with placeholder values


resp = client.describe_domains({
  domain_names: ["DomainName"],
})

Response structure


resp.domain_status_list #=> Array
resp.domain_status_list[0].domain_id #=> String
resp.domain_status_list[0].domain_name #=> String
resp.domain_status_list[0].arn #=> String
resp.domain_status_list[0].created #=> Boolean
resp.domain_status_list[0].deleted #=> Boolean
resp.domain_status_list[0].doc_service.endpoint #=> String
resp.domain_status_list[0].search_service.endpoint #=> String
resp.domain_status_list[0].requires_index_documents #=> Boolean
resp.domain_status_list[0].processing #=> Boolean
resp.domain_status_list[0].search_instance_type #=> String
resp.domain_status_list[0].search_partition_count #=> Integer
resp.domain_status_list[0].search_instance_count #=> Integer
resp.domain_status_list[0].limits.maximum_replication_count #=> Integer
resp.domain_status_list[0].limits.maximum_partition_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :domain_names (Array<String>)

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

Returns:


1272
1273
1274
1275
# File 'lib/aws-sdk-cloudsearch/client.rb', line 1272

def describe_domains(params = {}, options = {})
  req = build_request(:describe_domains, params)
  req.send_request(options)
end

#describe_expressions(params = {}) ⇒ Types::DescribeExpressionsResponse

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

[1]: docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html

Examples:

Request syntax with placeholder values


resp = client.describe_expressions({
  domain_name: "DomainName", # required
  expression_names: ["StandardName"],
  deployed: false,
})

Response structure


resp.expressions #=> Array
resp.expressions[0].options.expression_name #=> String
resp.expressions[0].options.expression_value #=> String
resp.expressions[0].status.creation_date #=> Time
resp.expressions[0].status.update_date #=> Time
resp.expressions[0].status.update_version #=> Integer
resp.expressions[0].status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
resp.expressions[0].status.pending_deletion #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String)

    The name of the domain you want to describe.

  • :expression_names (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`.

Returns:


1324
1325
1326
1327
# File 'lib/aws-sdk-cloudsearch/client.rb', line 1324

def describe_expressions(params = {}, options = {})
  req = build_request(:describe_expressions, params)
  req.send_request(options)
end

#describe_index_fields(params = {}) ⇒ Types::DescribeIndexFieldsResponse

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

[1]: docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html

Examples:

Request syntax with placeholder values


resp = client.describe_index_fields({
  domain_name: "DomainName", # required
  field_names: ["DynamicFieldName"],
  deployed: false,
})

Response structure


resp.index_fields #=> Array
resp.index_fields[0].options.index_field_name #=> String
resp.index_fields[0].options.index_field_type #=> String, one of "int", "double", "literal", "text", "date", "latlon", "int-array", "double-array", "literal-array", "text-array", "date-array"
resp.index_fields[0].options.int_options.default_value #=> Integer
resp.index_fields[0].options.int_options.source_field #=> String
resp.index_fields[0].options.int_options.facet_enabled #=> Boolean
resp.index_fields[0].options.int_options.search_enabled #=> Boolean
resp.index_fields[0].options.int_options.return_enabled #=> Boolean
resp.index_fields[0].options.int_options.sort_enabled #=> Boolean
resp.index_fields[0].options.double_options.default_value #=> Float
resp.index_fields[0].options.double_options.source_field #=> String
resp.index_fields[0].options.double_options.facet_enabled #=> Boolean
resp.index_fields[0].options.double_options.search_enabled #=> Boolean
resp.index_fields[0].options.double_options.return_enabled #=> Boolean
resp.index_fields[0].options.double_options.sort_enabled #=> Boolean
resp.index_fields[0].options.literal_options.default_value #=> String
resp.index_fields[0].options.literal_options.source_field #=> String
resp.index_fields[0].options.literal_options.facet_enabled #=> Boolean
resp.index_fields[0].options.literal_options.search_enabled #=> Boolean
resp.index_fields[0].options.literal_options.return_enabled #=> Boolean
resp.index_fields[0].options.literal_options.sort_enabled #=> Boolean
resp.index_fields[0].options.text_options.default_value #=> String
resp.index_fields[0].options.text_options.source_field #=> String
resp.index_fields[0].options.text_options.return_enabled #=> Boolean
resp.index_fields[0].options.text_options.sort_enabled #=> Boolean
resp.index_fields[0].options.text_options.highlight_enabled #=> Boolean
resp.index_fields[0].options.text_options.analysis_scheme #=> String
resp.index_fields[0].options.date_options.default_value #=> String
resp.index_fields[0].options.date_options.source_field #=> String
resp.index_fields[0].options.date_options.facet_enabled #=> Boolean
resp.index_fields[0].options.date_options.search_enabled #=> Boolean
resp.index_fields[0].options.date_options.return_enabled #=> Boolean
resp.index_fields[0].options.date_options.sort_enabled #=> Boolean
resp.index_fields[0].options.lat_lon_options.default_value #=> String
resp.index_fields[0].options.lat_lon_options.source_field #=> String
resp.index_fields[0].options.lat_lon_options.facet_enabled #=> Boolean
resp.index_fields[0].options.lat_lon_options.search_enabled #=> Boolean
resp.index_fields[0].options.lat_lon_options.return_enabled #=> Boolean
resp.index_fields[0].options.lat_lon_options.sort_enabled #=> Boolean
resp.index_fields[0].options.int_array_options.default_value #=> Integer
resp.index_fields[0].options.int_array_options.source_fields #=> String
resp.index_fields[0].options.int_array_options.facet_enabled #=> Boolean
resp.index_fields[0].options.int_array_options.search_enabled #=> Boolean
resp.index_fields[0].options.int_array_options.return_enabled #=> Boolean
resp.index_fields[0].options.double_array_options.default_value #=> Float
resp.index_fields[0].options.double_array_options.source_fields #=> String
resp.index_fields[0].options.double_array_options.facet_enabled #=> Boolean
resp.index_fields[0].options.double_array_options.search_enabled #=> Boolean
resp.index_fields[0].options.double_array_options.return_enabled #=> Boolean
resp.index_fields[0].options.literal_array_options.default_value #=> String
resp.index_fields[0].options.literal_array_options.source_fields #=> String
resp.index_fields[0].options.literal_array_options.facet_enabled #=> Boolean
resp.index_fields[0].options.literal_array_options.search_enabled #=> Boolean
resp.index_fields[0].options.literal_array_options.return_enabled #=> Boolean
resp.index_fields[0].options.text_array_options.default_value #=> String
resp.index_fields[0].options.text_array_options.source_fields #=> String
resp.index_fields[0].options.text_array_options.return_enabled #=> Boolean
resp.index_fields[0].options.text_array_options.highlight_enabled #=> Boolean
resp.index_fields[0].options.text_array_options.analysis_scheme #=> String
resp.index_fields[0].options.date_array_options.default_value #=> String
resp.index_fields[0].options.date_array_options.source_fields #=> String
resp.index_fields[0].options.date_array_options.facet_enabled #=> Boolean
resp.index_fields[0].options.date_array_options.search_enabled #=> Boolean
resp.index_fields[0].options.date_array_options.return_enabled #=> Boolean
resp.index_fields[0].status.creation_date #=> Time
resp.index_fields[0].status.update_date #=> Time
resp.index_fields[0].status.update_version #=> Integer
resp.index_fields[0].status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
resp.index_fields[0].status.pending_deletion #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String)

    The name of the domain you want to describe.

  • :field_names (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`.

Returns:


1437
1438
1439
1440
# File 'lib/aws-sdk-cloudsearch/client.rb', line 1437

def describe_index_fields(params = {}, options = {})
  req = build_request(:describe_index_fields, params)
  req.send_request(options)
end

#describe_scaling_parameters(params = {}) ⇒ Types::DescribeScalingParametersResponse

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

[1]: docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html

Examples:

Request syntax with placeholder values


resp = client.describe_scaling_parameters({
  domain_name: "DomainName", # required
})

Response structure


resp.scaling_parameters.options.desired_instance_type #=> String, one of "search.m1.small", "search.m1.large", "search.m2.xlarge", "search.m2.2xlarge", "search.m3.medium", "search.m3.large", "search.m3.xlarge", "search.m3.2xlarge", "search.small", "search.medium", "search.large", "search.xlarge", "search.2xlarge"
resp.scaling_parameters.options.desired_replication_count #=> Integer
resp.scaling_parameters.options.desired_partition_count #=> Integer
resp.scaling_parameters.status.creation_date #=> Time
resp.scaling_parameters.status.update_date #=> Time
resp.scaling_parameters.status.update_version #=> Integer
resp.scaling_parameters.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
resp.scaling_parameters.status.pending_deletion #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, 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).

Returns:


1480
1481
1482
1483
# File 'lib/aws-sdk-cloudsearch/client.rb', line 1480

def describe_scaling_parameters(params = {}, options = {})
  req = build_request(:describe_scaling_parameters, params)
  req.send_request(options)
end

#describe_service_access_policies(params = {}) ⇒ Types::DescribeServiceAccessPoliciesResponse

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

[1]: docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html

Examples:

Request syntax with placeholder values


resp = client.describe_service_access_policies({
  domain_name: "DomainName", # required
  deployed: false,
})

Response structure


resp.access_policies.options #=> String
resp.access_policies.status.creation_date #=> Time
resp.access_policies.status.update_date #=> Time
resp.access_policies.status.update_version #=> Integer
resp.access_policies.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
resp.access_policies.status.pending_deletion #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, 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`.

Returns:


1525
1526
1527
1528
# File 'lib/aws-sdk-cloudsearch/client.rb', line 1525

def describe_service_access_policies(params = {}, options = {})
  req = build_request(:describe_service_access_policies, params)
  req.send_request(options)
end

#describe_suggesters(params = {}) ⇒ Types::DescribeSuggestersResponse

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

[1]: docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html

Examples:

Request syntax with placeholder values


resp = client.describe_suggesters({
  domain_name: "DomainName", # required
  suggester_names: ["StandardName"],
  deployed: false,
})

Response structure


resp.suggesters #=> Array
resp.suggesters[0].options.suggester_name #=> String
resp.suggesters[0].options.document_suggester_options.source_field #=> String
resp.suggesters[0].options.document_suggester_options.fuzzy_matching #=> String, one of "none", "low", "high"
resp.suggesters[0].options.document_suggester_options.sort_expression #=> String
resp.suggesters[0].status.creation_date #=> Time
resp.suggesters[0].status.update_date #=> Time
resp.suggesters[0].status.update_version #=> Integer
resp.suggesters[0].status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
resp.suggesters[0].status.pending_deletion #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String)

    The name of the domain you want to describe.

  • :suggester_names (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`.

Returns:


1579
1580
1581
1582
# File 'lib/aws-sdk-cloudsearch/client.rb', line 1579

def describe_suggesters(params = {}, options = {})
  req = build_request(:describe_suggesters, params)
  req.send_request(options)
end

#index_documents(params = {}) ⇒ Types::IndexDocumentsResponse

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

Examples:

Request syntax with placeholder values


resp = client.index_documents({
  domain_name: "DomainName", # required
})

Response structure


resp.field_names #=> Array
resp.field_names[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, 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).

Returns:


1611
1612
1613
1614
# File 'lib/aws-sdk-cloudsearch/client.rb', line 1611

def index_documents(params = {}, options = {})
  req = build_request(:index_documents, params)
  req.send_request(options)
end

#list_domain_names(params = {}) ⇒ Types::ListDomainNamesResponse

Lists all search domains owned by an account.

Examples:

Response structure


resp.domain_names #=> Hash
resp.domain_names["DomainName"] #=> String

Parameters:

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

    ({})

Returns:


1629
1630
1631
1632
# File 'lib/aws-sdk-cloudsearch/client.rb', line 1629

def list_domain_names(params = {}, options = {})
  req = build_request(:list_domain_names, params)
  req.send_request(options)
end

#update_availability_options(params = {}) ⇒ Types::UpdateAvailabilityOptionsResponse

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][1

in the *Amazon CloudSearch

Developer Guide*.

[1]: docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html

Examples:

Request syntax with placeholder values


resp = client.update_availability_options({
  domain_name: "DomainName", # required
  multi_az: false, # required
})

Response structure


resp.availability_options.options #=> Boolean
resp.availability_options.status.creation_date #=> Time
resp.availability_options.status.update_date #=> Time
resp.availability_options.status.update_version #=> Integer
resp.availability_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
resp.availability_options.status.pending_deletion #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, 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).

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


1680
1681
1682
1683
# File 'lib/aws-sdk-cloudsearch/client.rb', line 1680

def update_availability_options(params = {}, options = {})
  req = build_request(:update_availability_options, params)
  req.send_request(options)
end

#update_domain_endpoint_options(params = {}) ⇒ Types::UpdateDomainEndpointOptionsResponse

Updates the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see [Configuring Domain Endpoint Options] in the *Amazon CloudSearch Developer Guide*.

[1]: docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-domain-endpoint-options.html

Examples:

Request syntax with placeholder values


resp = client.update_domain_endpoint_options({
  domain_name: "DomainName", # required
  domain_endpoint_options: { # required
    enforce_https: false,
    tls_security_policy: "Policy-Min-TLS-1-0-2019-07", # accepts Policy-Min-TLS-1-0-2019-07, Policy-Min-TLS-1-2-2019-07
  },
})

Response structure


resp.domain_endpoint_options.options.enforce_https #=> Boolean
resp.domain_endpoint_options.options.tls_security_policy #=> String, one of "Policy-Min-TLS-1-0-2019-07", "Policy-Min-TLS-1-2-2019-07"
resp.domain_endpoint_options.status.creation_date #=> Time
resp.domain_endpoint_options.status.update_date #=> Time
resp.domain_endpoint_options.status.update_version #=> Integer
resp.domain_endpoint_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
resp.domain_endpoint_options.status.pending_deletion #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String)

    A string that represents the name of a domain.

  • :domain_endpoint_options (required, Types::DomainEndpointOptions)

    Whether to require that all requests to the domain arrive over HTTPS. We recommend Policy-Min-TLS-1-2-2019-07 for TLSSecurityPolicy. For compatibility with older clients, the default is Policy-Min-TLS-1-0-2019-07.

Returns:


1729
1730
1731
1732
# File 'lib/aws-sdk-cloudsearch/client.rb', line 1729

def update_domain_endpoint_options(params = {}, options = {})
  req = build_request(:update_domain_endpoint_options, params)
  req.send_request(options)
end

#update_scaling_parameters(params = {}) ⇒ Types::UpdateScalingParametersResponse

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

[1]: docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html

Examples:

Request syntax with placeholder values


resp = client.update_scaling_parameters({
  domain_name: "DomainName", # required
  scaling_parameters: { # required
    desired_instance_type: "search.m1.small", # accepts search.m1.small, search.m1.large, search.m2.xlarge, search.m2.2xlarge, search.m3.medium, search.m3.large, search.m3.xlarge, search.m3.2xlarge, search.small, search.medium, search.large, search.xlarge, search.2xlarge
    desired_replication_count: 1,
    desired_partition_count: 1,
  },
})

Response structure


resp.scaling_parameters.options.desired_instance_type #=> String, one of "search.m1.small", "search.m1.large", "search.m2.xlarge", "search.m2.2xlarge", "search.m3.medium", "search.m3.large", "search.m3.xlarge", "search.m3.2xlarge", "search.small", "search.medium", "search.large", "search.xlarge", "search.2xlarge"
resp.scaling_parameters.options.desired_replication_count #=> Integer
resp.scaling_parameters.options.desired_partition_count #=> Integer
resp.scaling_parameters.status.creation_date #=> Time
resp.scaling_parameters.status.update_date #=> Time
resp.scaling_parameters.status.update_version #=> Integer
resp.scaling_parameters.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
resp.scaling_parameters.status.pending_deletion #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, 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).

  • :scaling_parameters (required, Types::ScalingParameters)

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

Returns:


1785
1786
1787
1788
# File 'lib/aws-sdk-cloudsearch/client.rb', line 1785

def update_scaling_parameters(params = {}, options = {})
  req = build_request(:update_scaling_parameters, params)
  req.send_request(options)
end

#update_service_access_policies(params = {}) ⇒ Types::UpdateServiceAccessPoliciesResponse

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

[1]: docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html

Examples:

Request syntax with placeholder values


resp = client.update_service_access_policies({
  domain_name: "DomainName", # required
  access_policies: "PolicyDocument", # required
})

Response structure


resp.access_policies.options #=> String
resp.access_policies.status.creation_date #=> Time
resp.access_policies.status.update_date #=> Time
resp.access_policies.status.update_version #=> Integer
resp.access_policies.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
resp.access_policies.status.pending_deletion #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, 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).

  • :access_policies (required, String)

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

Returns:


1830
1831
1832
1833
# File 'lib/aws-sdk-cloudsearch/client.rb', line 1830

def update_service_access_policies(params = {}, options = {})
  req = build_request(:update_service_access_policies, params)
  req.send_request(options)
end

#waiter_namesObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated.

1854
1855
1856
# File 'lib/aws-sdk-cloudsearch/client.rb', line 1854

def waiter_names
  []
end