Class: Aws::CloudSearch::Client

Inherits:

Seahorse::Client::Base

• Object
• Seahorse::Client::Base
• Aws::CloudSearch::Client

Includes:

Aws::ClientStubs

Defined in:

gems/aws-sdk-cloudsearch/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.

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

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations

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

  Indexes the search suggestions.

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

  Creates a new search domain.

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

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

  Configures an Expression for the search domain.

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

  Configures an IndexField for the search domain.

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

  Configures a suggester for a domain.

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

  Deletes an analysis scheme.

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

  Permanently deletes a search domain and all of its data.

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

  Removes an Expression from the search domain.

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

  Removes an IndexField from the search domain.

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

  Deletes a suggester.

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

  Gets the analysis schemes configured for a domain.

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

  Gets the availability options configured for a domain.

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

  Returns the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS.

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

  Gets information about the search domains owned by this account.

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

  Gets the expressions configured for the search domain.

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

  Gets information about the index fields configured for the search domain.

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

  Gets the scaling parameters configured for a domain.

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

  Gets information about the access policies that control access to the domain's document and search endpoints.

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

  Gets the suggesters configured for a domain.

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

  Tells the search domain to start indexing its documents using the latest indexing options.

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

  Lists all search domains owned by an account.

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

  Configures the availability options for a domain.

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

  Updates the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS.

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

  Configures scaling parameters for a domain.

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

  Configures the access rules that control access to the domain's document and search endpoints.

Instance Method Summary

• #initialize(options) ⇒ Client constructor

  A new instance of Client.

Methods included from Aws::ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

• options (Hash)

Options Hash (options):

• :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

  A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

• :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[:credentials]
  • The :access_key_id, :secret_access_key, :session_token, and :account_id options.
  • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
  • ~/.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::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
• :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:

  • Aws.config[:region]
  • ENV['AWS_REGION']
  • ENV['AMAZON_REGION']
  • ENV['AWS_DEFAULT_REGION']
  • ~/.aws/credentials
  • ~/.aws/config
• :access_key_id (String)
• :account_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.

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

  See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

• :disable_host_prefix_injection (Boolean) — default: false —

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

• :disable_request_compression (Boolean) — default: false —

  When set to 'true' the request body will not be compressed for supported operations.

• :endpoint (String, URI::HTTPS, URI::HTTP) —

  Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

  'http://example.com'
  'https://example.com'
  'http://example.com:123'
  

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

• :ignore_configured_endpoint_urls (Boolean) —

  Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

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

• :request_checksum_calculation (String) — default: "when_supported" —

  Determines when a checksum will be calculated for request payloads. Values are:

  • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
  • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
• :request_min_compression_size_bytes (Integer) — default: 10240 —

  The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

• :response_checksum_validation (String) — default: "when_supported" —

  Determines when checksum validation will be performed on response payloads. Values are:

  • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
  • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
• :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 https://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.

• :sdk_ua_app_id (String) —

  A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

• :secret_access_key (String)
• :session_token (String)
• :sigv4a_signing_region_set (Array) —

  A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

  • Aws.config[:sigv4a_signing_region_set]
  • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
  • ~/.aws/config
• :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 Aws::ClientStubs#stub_responses. See Aws::ClientStubs for more information.

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

• :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

  Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

  • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
• :token_provider (Aws::TokenProvider) —

  A Bearer Token Provider. This can be an instance of any one of the following classes:

  • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

  • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

  When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

• :use_dualstack_endpoint (Boolean) —

  When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

• :use_fips_endpoint (Boolean) —

  When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

• :validate_params (Boolean) — default: true —

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

• :endpoint_provider (Aws::CloudSearch::EndpointProvider) —

  The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::CloudSearch::EndpointParameters.

• :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_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_open_timeout (Float) — default: 15 —

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

• :http_proxy (URI::HTTP, String) —

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

• :http_read_timeout (Float) — default: 60 —

  The default number of seconds to wait for response data. 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.

• :on_chunk_received (Proc) —

  When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

• :on_chunk_sent (Proc) —

  When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

• :raise_response_errors (Boolean) — default: true —

  When true, response errors are raised.

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

• :ssl_ca_store (String) —

  Sets the X509::Store to verify peer certificate.

• :ssl_cert (OpenSSL::X509::Certificate) —

  Sets a client certificate when creating http connections.

• :ssl_key (OpenSSL::PKey) —

  Sets a client key when creating http connections.

• :ssl_timeout (Float) —

  Sets the SSL timeout in seconds

• :ssl_verify_peer (Boolean) — default: true —

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

# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 467

def initialize(*args)
  super
end

Instance Method Details

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

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

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:

• (Types::BuildSuggestersResponse) —

  Returns a response object which responds to the following methods:

  • #field_names => Array<String>

# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 503

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.

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:

• (Types::CreateDomainResponse) —

  Returns a response object which responds to the following methods:

  • #domain_status => Types::DomainStatus

# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 550

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.

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:

• (Types::DefineAnalysisSchemeResponse) —

  Returns a response object which responds to the following methods:

  • #analysis_scheme => Types::AnalysisSchemeStatus

# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 615

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 in the Amazon CloudSearch Developer Guide.

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:

• (Types::DefineExpressionResponse) —

  Returns a response object which responds to the following methods:

  • #expression => Types::ExpressionStatus

# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 667

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 in the Amazon CloudSearch Developer Guide.

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:

• (Types::DefineIndexFieldResponse) —

  Returns a response object which responds to the following methods:

  • #index_field => Types::IndexFieldStatus

# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 865

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.

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:

• (Types::DefineSuggesterResponse) —

  Returns a response object which responds to the following methods:

  • #suggester => Types::SuggesterStatus

# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 925

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.

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:

• (Types::DeleteAnalysisSchemeResponse) —

  Returns a response object which responds to the following methods:

  • #analysis_scheme => Types::AnalysisSchemeStatus

# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 974

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 in the Amazon CloudSearch Developer Guide.

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:

• (Types::DeleteDomainResponse) —

  Returns a response object which responds to the following methods:

  • #domain_status => Types::DomainStatus

# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 1020

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.

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:

• (Types::DeleteExpressionResponse) —

  Returns a response object which responds to the following methods:

  • #expression => Types::ExpressionStatus

# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 1065

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.

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:

• (Types::DeleteIndexFieldResponse) —

  Returns a response object which responds to the following methods:

  • #index_field => Types::IndexFieldStatus

# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 1172

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.

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:

• (Types::DeleteSuggesterResponse) —

  Returns a response object which responds to the following methods:

  • #suggester => Types::SuggesterStatus

# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 1218

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 in the Amazon CloudSearch Developer Guide.

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:

• (Types::DescribeAnalysisSchemesResponse) —

  Returns a response object which responds to the following methods:

  • #analysis_schemes => Array<Types::AnalysisSchemeStatus>

# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 1276

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.

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:

• (Types::DescribeAvailabilityOptionsResponse) —

  Returns a response object which responds to the following methods:

  • #availability_options => Types::AvailabilityOptionsStatus

# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 1320

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.

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:

• (Types::DescribeDomainEndpointOptionsResponse) —

  Returns a response object which responds to the following methods:

  • #domain_endpoint_options => Types::DomainEndpointOptionsStatus

# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 1365

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&q.parser=structured&size=0. For more information, see Getting Information about a Search Domain in the Amazon CloudSearch Developer Guide.

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:

• (Types::DescribeDomainsResponse) —

  Returns a response object which responds to the following methods:

  • #domain_status_list => Array<Types::DomainStatus>

# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 1415

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.

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:

• (Types::DescribeExpressionsResponse) —

  Returns a response object which responds to the following methods:

  • #expressions => Array<Types::ExpressionStatus>

# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 1467

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.

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:

• (Types::DescribeIndexFieldsResponse) —

  Returns a response object which responds to the following methods:

  • #index_fields => Array<Types::IndexFieldStatus>

# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 1580

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.

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", "search.previousgeneration.small", "search.previousgeneration.large", "search.previousgeneration.xlarge", "search.previousgeneration.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:

• (Types::DescribeScalingParametersResponse) —

  Returns a response object which responds to the following methods:

  • #scaling_parameters => Types::ScalingParametersStatus

# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 1623

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.

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:

• (Types::DescribeServiceAccessPoliciesResponse) —

  Returns a response object which responds to the following methods:

  • #access_policies => Types::AccessPoliciesStatus

# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 1668

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.

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:

• (Types::DescribeSuggestersResponse) —

  Returns a response object which responds to the following methods:

  • #suggesters => Array<Types::SuggesterStatus>

# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 1722

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:

• (Types::IndexDocumentsResponse) —

  Returns a response object which responds to the following methods:

  • #field_names => Array<String>

# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 1754

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:

• (Types::ListDomainNamesResponse) —

  Returns a response object which responds to the following methods:

  • #domain_names => Hash<String,String>

# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 1772

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 in the Amazon CloudSearch Developer Guide.

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:

• (Types::UpdateAvailabilityOptionsResponse) —

  Returns a response object which responds to the following methods:

  • #availability_options => Types::AvailabilityOptionsStatus

# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 1823

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.

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:

• (Types::UpdateDomainEndpointOptionsResponse) —

  Returns a response object which responds to the following methods:

  • #domain_endpoint_options => Types::DomainEndpointOptionsStatus

# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 1872

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.

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, search.previousgeneration.small, search.previousgeneration.large, search.previousgeneration.xlarge, search.previousgeneration.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", "search.previousgeneration.small", "search.previousgeneration.large", "search.previousgeneration.xlarge", "search.previousgeneration.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:

• (Types::UpdateScalingParametersResponse) —

  Returns a response object which responds to the following methods:

  • #scaling_parameters => Types::ScalingParametersStatus

# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 1928

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.

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:

• (Types::UpdateServiceAccessPoliciesResponse) —

  Returns a response object which responds to the following methods:

  • #access_policies => Types::AccessPoliciesStatus

# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/client.rb', line 1973

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