aws-sdk-cloudsearchdomain 1.33.0 → 1.74.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +211 -1
- data/VERSION +1 -1
- data/lib/aws-sdk-cloudsearchdomain/client.rb +239 -124
- data/lib/aws-sdk-cloudsearchdomain/client_api.rb +4 -0
- data/lib/aws-sdk-cloudsearchdomain/customizations.rb +0 -8
- data/lib/aws-sdk-cloudsearchdomain/types.rb +46 -85
- data/lib/aws-sdk-cloudsearchdomain.rb +9 -7
- data/sig/client.rbs +124 -0
- data/sig/errors.rbs +23 -0
- data/sig/resource.rbs +73 -0
- data/sig/types.rbs +145 -0
- data/sig/waiters.rbs +13 -0
- metadata +13 -11
|
@@ -7,32 +7,33 @@
|
|
|
7
7
|
#
|
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
|
9
9
|
|
|
10
|
-
require 'seahorse/client/plugins/content_length
|
|
11
|
-
require 'aws-sdk-core/plugins/credentials_configuration
|
|
12
|
-
require 'aws-sdk-core/plugins/logging
|
|
13
|
-
require 'aws-sdk-core/plugins/param_converter
|
|
14
|
-
require 'aws-sdk-core/plugins/param_validator
|
|
15
|
-
require 'aws-sdk-core/plugins/user_agent
|
|
16
|
-
require 'aws-sdk-core/plugins/helpful_socket_errors
|
|
17
|
-
require 'aws-sdk-core/plugins/retry_errors
|
|
18
|
-
require 'aws-sdk-core/plugins/global_configuration
|
|
19
|
-
require 'aws-sdk-core/plugins/response_paging
|
|
20
|
-
require 'aws-sdk-core/plugins/stub_responses
|
|
21
|
-
require 'aws-sdk-core/plugins/idempotency_token
|
|
22
|
-
require 'aws-sdk-core/plugins/
|
|
23
|
-
require 'aws-sdk-core/plugins/
|
|
24
|
-
require 'aws-sdk-core/plugins/
|
|
25
|
-
require 'aws-sdk-core/plugins/
|
|
26
|
-
require 'aws-sdk-core/plugins/
|
|
27
|
-
require 'aws-sdk-core/plugins/
|
|
28
|
-
require 'aws-sdk-core/plugins/
|
|
29
|
-
require 'aws-sdk-core/plugins/
|
|
30
|
-
require 'aws-sdk-core/plugins/
|
|
31
|
-
require 'aws-sdk-core/plugins/
|
|
32
|
-
require 'aws-sdk-
|
|
33
|
-
require 'aws-sdk-
|
|
34
|
-
|
|
35
|
-
|
|
10
|
+
require 'seahorse/client/plugins/content_length'
|
|
11
|
+
require 'aws-sdk-core/plugins/credentials_configuration'
|
|
12
|
+
require 'aws-sdk-core/plugins/logging'
|
|
13
|
+
require 'aws-sdk-core/plugins/param_converter'
|
|
14
|
+
require 'aws-sdk-core/plugins/param_validator'
|
|
15
|
+
require 'aws-sdk-core/plugins/user_agent'
|
|
16
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors'
|
|
17
|
+
require 'aws-sdk-core/plugins/retry_errors'
|
|
18
|
+
require 'aws-sdk-core/plugins/global_configuration'
|
|
19
|
+
require 'aws-sdk-core/plugins/response_paging'
|
|
20
|
+
require 'aws-sdk-core/plugins/stub_responses'
|
|
21
|
+
require 'aws-sdk-core/plugins/idempotency_token'
|
|
22
|
+
require 'aws-sdk-core/plugins/invocation_id'
|
|
23
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter'
|
|
24
|
+
require 'aws-sdk-core/plugins/client_metrics_plugin'
|
|
25
|
+
require 'aws-sdk-core/plugins/client_metrics_send_plugin'
|
|
26
|
+
require 'aws-sdk-core/plugins/transfer_encoding'
|
|
27
|
+
require 'aws-sdk-core/plugins/http_checksum'
|
|
28
|
+
require 'aws-sdk-core/plugins/checksum_algorithm'
|
|
29
|
+
require 'aws-sdk-core/plugins/request_compression'
|
|
30
|
+
require 'aws-sdk-core/plugins/defaults_mode'
|
|
31
|
+
require 'aws-sdk-core/plugins/recursion_detection'
|
|
32
|
+
require 'aws-sdk-core/plugins/telemetry'
|
|
33
|
+
require 'aws-sdk-core/plugins/signature_v4'
|
|
34
|
+
require 'aws-sdk-core/plugins/protocols/rest_json'
|
|
35
|
+
require 'aws-sdk-cloudsearchdomain/plugins/conditional_signing'
|
|
36
|
+
require 'aws-sdk-cloudsearchdomain/plugins/switch_to_post'
|
|
36
37
|
|
|
37
38
|
module Aws::CloudSearchDomain
|
|
38
39
|
# An API client for CloudSearchDomain. To construct a client, you need to configure a `:region` and `:credentials`.
|
|
@@ -67,14 +68,17 @@ module Aws::CloudSearchDomain
|
|
|
67
68
|
add_plugin(Aws::Plugins::ResponsePaging)
|
|
68
69
|
add_plugin(Aws::Plugins::StubResponses)
|
|
69
70
|
add_plugin(Aws::Plugins::IdempotencyToken)
|
|
71
|
+
add_plugin(Aws::Plugins::InvocationId)
|
|
70
72
|
add_plugin(Aws::Plugins::JsonvalueConverter)
|
|
71
73
|
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
|
72
74
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
|
73
75
|
add_plugin(Aws::Plugins::TransferEncoding)
|
|
74
76
|
add_plugin(Aws::Plugins::HttpChecksum)
|
|
75
77
|
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
|
78
|
+
add_plugin(Aws::Plugins::RequestCompression)
|
|
76
79
|
add_plugin(Aws::Plugins::DefaultsMode)
|
|
77
80
|
add_plugin(Aws::Plugins::RecursionDetection)
|
|
81
|
+
add_plugin(Aws::Plugins::Telemetry)
|
|
78
82
|
add_plugin(Aws::Plugins::SignatureV4)
|
|
79
83
|
add_plugin(Aws::Plugins::Protocols::RestJson)
|
|
80
84
|
add_plugin(Aws::CloudSearchDomain::Plugins::ConditionalSigning)
|
|
@@ -82,9 +86,14 @@ module Aws::CloudSearchDomain
|
|
|
82
86
|
|
|
83
87
|
# @overload initialize(options)
|
|
84
88
|
# @param [Hash] options
|
|
89
|
+
#
|
|
90
|
+
# @option options [Array<Seahorse::Client::Plugin>] :plugins ([]])
|
|
91
|
+
# A list of plugins to apply to the client. Each plugin is either a
|
|
92
|
+
# class name or an instance of a plugin class.
|
|
93
|
+
#
|
|
85
94
|
# @option options [required, Aws::CredentialProvider] :credentials
|
|
86
|
-
# Your AWS credentials. This can be
|
|
87
|
-
# following classes:
|
|
95
|
+
# Your AWS credentials used for authentication. This can be any class that includes and implements
|
|
96
|
+
# `Aws::CredentialProvider`, or instance of any one of the following classes:
|
|
88
97
|
#
|
|
89
98
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
|
90
99
|
# credentials.
|
|
@@ -112,29 +121,40 @@ module Aws::CloudSearchDomain
|
|
|
112
121
|
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
|
113
122
|
# from the Cognito Identity service.
|
|
114
123
|
#
|
|
115
|
-
# When `:credentials` are not configured directly, the following
|
|
116
|
-
# locations will be searched for credentials:
|
|
124
|
+
# When `:credentials` are not configured directly, the following locations will be searched for credentials:
|
|
117
125
|
#
|
|
118
126
|
# * `Aws.config[:credentials]`
|
|
119
|
-
#
|
|
120
|
-
# *
|
|
127
|
+
#
|
|
128
|
+
# * The `:access_key_id`, `:secret_access_key`, `:session_token`, and
|
|
129
|
+
# `:account_id` options.
|
|
130
|
+
#
|
|
131
|
+
# * `ENV['AWS_ACCESS_KEY_ID']`, `ENV['AWS_SECRET_ACCESS_KEY']`,
|
|
132
|
+
# `ENV['AWS_SESSION_TOKEN']`, and `ENV['AWS_ACCOUNT_ID']`.
|
|
133
|
+
#
|
|
121
134
|
# * `~/.aws/credentials`
|
|
135
|
+
#
|
|
122
136
|
# * `~/.aws/config`
|
|
123
|
-
#
|
|
124
|
-
#
|
|
125
|
-
# `Aws::
|
|
126
|
-
# enable retries and extended timeouts. Instance profile credential
|
|
127
|
-
#
|
|
128
|
-
# to true.
|
|
137
|
+
#
|
|
138
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive.
|
|
139
|
+
# Construct and pass an instance of `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
|
|
140
|
+
# enable retries and extended timeouts. Instance profile credential fetching can be disabled by
|
|
141
|
+
# setting `ENV['AWS_EC2_METADATA_DISABLED']` to `true`.
|
|
129
142
|
#
|
|
130
143
|
# @option options [String] :access_key_id
|
|
131
144
|
#
|
|
145
|
+
# @option options [String] :account_id
|
|
146
|
+
#
|
|
132
147
|
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
|
133
148
|
# Used only in `adaptive` retry mode. When true, the request will sleep
|
|
134
149
|
# until there is sufficent client side capacity to retry the request.
|
|
135
150
|
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
|
136
151
|
# not retry instead of sleeping.
|
|
137
152
|
#
|
|
153
|
+
# @option options [Array<String>] :auth_scheme_preference
|
|
154
|
+
# A list of preferred authentication schemes to use when making a request. Supported values are:
|
|
155
|
+
# `sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV['AWS_AUTH_SCHEME_PREFERENCE']` or in
|
|
156
|
+
# shared config as `auth_scheme_preference`, the value should be a comma-separated list.
|
|
157
|
+
#
|
|
138
158
|
# @option options [Boolean] :client_side_monitoring (false)
|
|
139
159
|
# When `true`, client-side metrics will be collected for all API requests from
|
|
140
160
|
# this client.
|
|
@@ -160,13 +180,17 @@ module Aws::CloudSearchDomain
|
|
|
160
180
|
# the required types.
|
|
161
181
|
#
|
|
162
182
|
# @option options [Boolean] :correct_clock_skew (true)
|
|
163
|
-
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
|
183
|
+
# Used only in `standard` and `adaptive` retry modes. Specifies whether to apply
|
|
164
184
|
# a clock skew correction and retry requests with skewed client clocks.
|
|
165
185
|
#
|
|
166
186
|
# @option options [String] :defaults_mode ("legacy")
|
|
167
187
|
# See {Aws::DefaultsModeConfiguration} for a list of the
|
|
168
188
|
# accepted modes and the configuration defaults that are included.
|
|
169
189
|
#
|
|
190
|
+
# @option options [Boolean] :disable_request_compression (false)
|
|
191
|
+
# When set to 'true' the request body will not be compressed
|
|
192
|
+
# for supported operations.
|
|
193
|
+
#
|
|
170
194
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
|
171
195
|
# The log formatter.
|
|
172
196
|
#
|
|
@@ -184,8 +208,36 @@ module Aws::CloudSearchDomain
|
|
|
184
208
|
# 4 times. Used in `standard` and `adaptive` retry modes.
|
|
185
209
|
#
|
|
186
210
|
# @option options [String] :profile ("default")
|
|
187
|
-
# Used when loading credentials from the shared credentials file
|
|
188
|
-
#
|
|
211
|
+
# Used when loading credentials from the shared credentials file at `HOME/.aws/credentials`.
|
|
212
|
+
# When not specified, 'default' is used.
|
|
213
|
+
#
|
|
214
|
+
# @option options [String] :request_checksum_calculation ("when_supported")
|
|
215
|
+
# Determines when a checksum will be calculated for request payloads. Values are:
|
|
216
|
+
#
|
|
217
|
+
# * `when_supported` - (default) When set, a checksum will be
|
|
218
|
+
# calculated for all request payloads of operations modeled with the
|
|
219
|
+
# `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a
|
|
220
|
+
# `requestAlgorithmMember` is modeled.
|
|
221
|
+
# * `when_required` - When set, a checksum will only be calculated for
|
|
222
|
+
# request payloads of operations modeled with the `httpChecksum` trait where
|
|
223
|
+
# `requestChecksumRequired` is `true` or where a `requestAlgorithmMember`
|
|
224
|
+
# is modeled and supplied.
|
|
225
|
+
#
|
|
226
|
+
# @option options [Integer] :request_min_compression_size_bytes (10240)
|
|
227
|
+
# The minimum size in bytes that triggers compression for request
|
|
228
|
+
# bodies. The value must be non-negative integer value between 0
|
|
229
|
+
# and 10485780 bytes inclusive.
|
|
230
|
+
#
|
|
231
|
+
# @option options [String] :response_checksum_validation ("when_supported")
|
|
232
|
+
# Determines when checksum validation will be performed on response payloads. Values are:
|
|
233
|
+
#
|
|
234
|
+
# * `when_supported` - (default) When set, checksum validation is performed on all
|
|
235
|
+
# response payloads of operations modeled with the `httpChecksum` trait where
|
|
236
|
+
# `responseAlgorithms` is modeled, except when no modeled checksum algorithms
|
|
237
|
+
# are supported.
|
|
238
|
+
# * `when_required` - When set, checksum validation is not performed on
|
|
239
|
+
# response payloads of operations unless the checksum algorithm is supported and
|
|
240
|
+
# the `requestValidationModeMember` member is set to `ENABLED`.
|
|
189
241
|
#
|
|
190
242
|
# @option options [Proc] :retry_backoff
|
|
191
243
|
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
|
@@ -219,18 +271,21 @@ module Aws::CloudSearchDomain
|
|
|
219
271
|
# @option options [String] :retry_mode ("legacy")
|
|
220
272
|
# Specifies which retry algorithm to use. Values are:
|
|
221
273
|
#
|
|
222
|
-
# * `legacy` - The pre-existing retry behavior.
|
|
223
|
-
# no retry mode is provided.
|
|
274
|
+
# * `legacy` - The pre-existing retry behavior. This is the default
|
|
275
|
+
# value if no retry mode is provided.
|
|
224
276
|
#
|
|
225
277
|
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
|
226
278
|
# This includes support for retry quotas, which limit the number of
|
|
227
279
|
# unsuccessful retries a client can make.
|
|
228
280
|
#
|
|
229
|
-
# * `adaptive` -
|
|
230
|
-
#
|
|
231
|
-
# throttling. This is a provisional mode that may change behavior
|
|
232
|
-
# in the future.
|
|
281
|
+
# * `adaptive` - A retry mode that includes all the functionality of
|
|
282
|
+
# `standard` mode along with automatic client side throttling.
|
|
233
283
|
#
|
|
284
|
+
# @option options [String] :sdk_ua_app_id
|
|
285
|
+
# A unique and opaque application ID that is appended to the
|
|
286
|
+
# User-Agent header as app/sdk_ua_app_id. It should have a
|
|
287
|
+
# maximum length of 50. This variable is sourced from environment
|
|
288
|
+
# variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
|
|
234
289
|
#
|
|
235
290
|
# @option options [String] :secret_access_key
|
|
236
291
|
#
|
|
@@ -249,54 +304,109 @@ module Aws::CloudSearchDomain
|
|
|
249
304
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
|
250
305
|
# requests are made, and retries are disabled.
|
|
251
306
|
#
|
|
252
|
-
# @option options [
|
|
253
|
-
#
|
|
254
|
-
#
|
|
307
|
+
# @option options [Aws::Telemetry::TelemetryProviderBase] :telemetry_provider (Aws::Telemetry::NoOpTelemetryProvider)
|
|
308
|
+
# Allows you to provide a telemetry provider, which is used to
|
|
309
|
+
# emit telemetry data. By default, uses `NoOpTelemetryProvider` which
|
|
310
|
+
# will not record or emit any telemetry data. The SDK supports the
|
|
311
|
+
# following telemetry providers:
|
|
255
312
|
#
|
|
256
|
-
#
|
|
257
|
-
#
|
|
313
|
+
# * OpenTelemetry (OTel) - To use the OTel provider, install and require the
|
|
314
|
+
# `opentelemetry-sdk` gem and then, pass in an instance of a
|
|
315
|
+
# `Aws::Telemetry::OTelProvider` for telemetry provider.
|
|
258
316
|
#
|
|
259
|
-
# @option options [
|
|
260
|
-
#
|
|
261
|
-
# `
|
|
317
|
+
# @option options [Aws::TokenProvider] :token_provider
|
|
318
|
+
# Your Bearer token used for authentication. This can be any class that includes and implements
|
|
319
|
+
# `Aws::TokenProvider`, or instance of any one of the following classes:
|
|
262
320
|
#
|
|
263
|
-
#
|
|
264
|
-
#
|
|
265
|
-
# safely be set per-request on the session.
|
|
321
|
+
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
|
322
|
+
# tokens.
|
|
266
323
|
#
|
|
267
|
-
#
|
|
268
|
-
#
|
|
269
|
-
# considered stale. Stale connections are closed and removed
|
|
270
|
-
# from the pool before making a request.
|
|
324
|
+
# * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
|
|
325
|
+
# access token generated from `aws login`.
|
|
271
326
|
#
|
|
272
|
-
#
|
|
273
|
-
#
|
|
274
|
-
# request body. This option has no effect unless the request has
|
|
275
|
-
# "Expect" header set to "100-continue". Defaults to `nil` which
|
|
276
|
-
# disables this behaviour. This value can safely be set per
|
|
277
|
-
# request on the session.
|
|
327
|
+
# When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
|
|
328
|
+
# will be used to search for tokens configured for your profile in shared configuration files.
|
|
278
329
|
#
|
|
279
|
-
# @option options [
|
|
280
|
-
#
|
|
330
|
+
# @option options [Boolean] :validate_params (true)
|
|
331
|
+
# When `true`, request parameters are validated before
|
|
332
|
+
# sending the request.
|
|
281
333
|
#
|
|
282
|
-
# @option options [
|
|
283
|
-
#
|
|
334
|
+
# @option options [String, URI::HTTPS, URI::HTTP] :endpoint
|
|
335
|
+
# Normally you should not configure the `:endpoint` option
|
|
336
|
+
# directly. This is normally constructed from the `:region`
|
|
337
|
+
# option. Configuring `:endpoint` is normally reserved for
|
|
338
|
+
# connecting to test or custom endpoints. The endpoint should
|
|
339
|
+
# be a URI formatted like:
|
|
340
|
+
#
|
|
341
|
+
# 'http://example.com'
|
|
342
|
+
# 'https://example.com'
|
|
343
|
+
# 'http://example.com:123'
|
|
344
|
+
#
|
|
345
|
+
# @option options [Float] :http_continue_timeout (1)
|
|
346
|
+
# The number of seconds to wait for a 100-continue response before sending the
|
|
347
|
+
# request body. This option has no effect unless the request has "Expect"
|
|
348
|
+
# header set to "100-continue". Defaults to `nil` which disables this
|
|
349
|
+
# behaviour. This value can safely be set per request on the session.
|
|
350
|
+
#
|
|
351
|
+
# @option options [Float] :http_idle_timeout (5)
|
|
352
|
+
# The number of seconds a connection is allowed to sit idle before it
|
|
353
|
+
# is considered stale. Stale connections are closed and removed from the
|
|
354
|
+
# pool before making a request.
|
|
355
|
+
#
|
|
356
|
+
# @option options [Float] :http_open_timeout (15)
|
|
357
|
+
# The default number of seconds to wait for response data.
|
|
358
|
+
# This value can safely be set per-request on the session.
|
|
359
|
+
#
|
|
360
|
+
# @option options [URI::HTTP,String] :http_proxy
|
|
361
|
+
# A proxy to send requests through. Formatted like 'http://proxy.com:123'.
|
|
362
|
+
#
|
|
363
|
+
# @option options [Float] :http_read_timeout (60)
|
|
364
|
+
# The default number of seconds to wait for response data.
|
|
365
|
+
# This value can safely be set per-request on the session.
|
|
366
|
+
#
|
|
367
|
+
# @option options [Boolean] :http_wire_trace (false)
|
|
368
|
+
# When `true`, HTTP debug output will be sent to the `:logger`.
|
|
369
|
+
#
|
|
370
|
+
# @option options [Proc] :on_chunk_received
|
|
371
|
+
# When a Proc object is provided, it will be used as callback when each chunk
|
|
372
|
+
# of the response body is received. It provides three arguments: the chunk,
|
|
373
|
+
# the number of bytes received, and the total number of
|
|
374
|
+
# bytes in the response (or nil if the server did not send a `content-length`).
|
|
375
|
+
#
|
|
376
|
+
# @option options [Proc] :on_chunk_sent
|
|
377
|
+
# When a Proc object is provided, it will be used as callback when each chunk
|
|
378
|
+
# of the request body is sent. It provides three arguments: the chunk,
|
|
379
|
+
# the number of bytes read from the body, and the total number of
|
|
380
|
+
# bytes in the body.
|
|
381
|
+
#
|
|
382
|
+
# @option options [Boolean] :raise_response_errors (true)
|
|
383
|
+
# When `true`, response errors are raised.
|
|
384
|
+
#
|
|
385
|
+
# @option options [String] :ssl_ca_bundle
|
|
386
|
+
# Full path to the SSL certificate authority bundle file that should be used when
|
|
387
|
+
# verifying peer certificates. If you do not pass `:ssl_ca_bundle` or
|
|
388
|
+
# `:ssl_ca_directory` the the system default will be used if available.
|
|
389
|
+
#
|
|
390
|
+
# @option options [String] :ssl_ca_directory
|
|
391
|
+
# Full path of the directory that contains the unbundled SSL certificate
|
|
392
|
+
# authority files for verifying peer certificates. If you do
|
|
393
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system
|
|
394
|
+
# default will be used if available.
|
|
284
395
|
#
|
|
285
|
-
# @option options [
|
|
286
|
-
#
|
|
287
|
-
# connection.
|
|
396
|
+
# @option options [String] :ssl_ca_store
|
|
397
|
+
# Sets the X509::Store to verify peer certificate.
|
|
288
398
|
#
|
|
289
|
-
# @option options [
|
|
290
|
-
#
|
|
291
|
-
# verifying peer certificates. If you do not pass
|
|
292
|
-
# `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
|
|
293
|
-
# will be used if available.
|
|
399
|
+
# @option options [OpenSSL::X509::Certificate] :ssl_cert
|
|
400
|
+
# Sets a client certificate when creating http connections.
|
|
294
401
|
#
|
|
295
|
-
# @option options [
|
|
296
|
-
#
|
|
297
|
-
#
|
|
298
|
-
#
|
|
299
|
-
#
|
|
402
|
+
# @option options [OpenSSL::PKey] :ssl_key
|
|
403
|
+
# Sets a client key when creating http connections.
|
|
404
|
+
#
|
|
405
|
+
# @option options [Float] :ssl_timeout
|
|
406
|
+
# Sets the SSL timeout in seconds
|
|
407
|
+
#
|
|
408
|
+
# @option options [Boolean] :ssl_verify_peer (true)
|
|
409
|
+
# When `true`, SSL peer certificates are verified when establishing a connection.
|
|
300
410
|
#
|
|
301
411
|
def initialize(*args)
|
|
302
412
|
super
|
|
@@ -308,16 +418,16 @@ module Aws::CloudSearchDomain
|
|
|
308
418
|
# criteria. How you specify the search criteria depends on which query
|
|
309
419
|
# parser you use. Amazon CloudSearch supports four query parsers:
|
|
310
420
|
#
|
|
311
|
-
# * `simple
|
|
421
|
+
# * `simple`: search all `text` and `text-array` fields for the
|
|
312
422
|
# specified string. Search for phrases, individual terms, and
|
|
313
423
|
# prefixes.
|
|
314
|
-
# * `structured
|
|
424
|
+
# * `structured`: search specific fields, construct compound queries
|
|
315
425
|
# using Boolean operators, and use advanced features such as term
|
|
316
426
|
# boosting and proximity searching.
|
|
317
|
-
# * `lucene
|
|
427
|
+
# * `lucene`: specify search criteria using the Apache Lucene query
|
|
318
428
|
# parser syntax.
|
|
319
|
-
# * `dismax
|
|
320
|
-
#
|
|
429
|
+
# * `dismax`: specify search criteria using the simplified subset of the
|
|
430
|
+
# Apache Lucene query parser syntax defined by the DisMax query
|
|
321
431
|
# parser.
|
|
322
432
|
#
|
|
323
433
|
# For more information, see [Searching Your Data][1] in the *Amazon
|
|
@@ -356,10 +466,10 @@ module Aws::CloudSearchDomain
|
|
|
356
466
|
# expressions as return fields.
|
|
357
467
|
#
|
|
358
468
|
# You specify the expressions in JSON using the form
|
|
359
|
-
#
|
|
469
|
+
# `{"EXPRESSIONNAME":"EXPRESSION"}`. You can define and use multiple
|
|
360
470
|
# expressions in a search request. For example:
|
|
361
471
|
#
|
|
362
|
-
# `
|
|
472
|
+
# ` {"expression1":"_score*rating", "expression2":"(1/rank)*year"} `
|
|
363
473
|
#
|
|
364
474
|
# For information about the variables, operators, and functions you can
|
|
365
475
|
# use in expressions, see [Writing Expressions][1] in the *Amazon
|
|
@@ -374,7 +484,7 @@ module Aws::CloudSearchDomain
|
|
|
374
484
|
# options that control how the facet information is returned. Each
|
|
375
485
|
# specified field must be facet-enabled in the domain configuration. The
|
|
376
486
|
# fields and options are specified in JSON using the form
|
|
377
|
-
#
|
|
487
|
+
# `{"FIELD":{"OPTION":VALUE,"OPTION:"STRING"},"FIELD":{"OPTION":VALUE,"OPTION":"STRING"}}`.
|
|
378
488
|
#
|
|
379
489
|
# You can specify the following faceting options:
|
|
380
490
|
#
|
|
@@ -407,7 +517,7 @@ module Aws::CloudSearchDomain
|
|
|
407
517
|
# and return facet counts by decade.
|
|
408
518
|
#
|
|
409
519
|
# `
|
|
410
|
-
#
|
|
520
|
+
# {"year":{"buckets":["[1970,1979]","[1980,1989]","[1990,1999]","[2000,2009]","[2010,}"]}}
|
|
411
521
|
# `
|
|
412
522
|
#
|
|
413
523
|
# To sort facets by facet count, use the `count` option. For example,
|
|
@@ -416,13 +526,13 @@ module Aws::CloudSearchDomain
|
|
|
416
526
|
# matching documents listed first. Setting the `size` option to 3
|
|
417
527
|
# returns only the top three facet values.
|
|
418
528
|
#
|
|
419
|
-
# `
|
|
529
|
+
# ` {"year":{"sort":"count","size":3}} `
|
|
420
530
|
#
|
|
421
531
|
# To sort the facets by value, use the `bucket` option. For example, the
|
|
422
532
|
# following request sets the `sort` option to `bucket` to sort the facet
|
|
423
533
|
# values numerically by year, with earliest year listed first.
|
|
424
534
|
#
|
|
425
|
-
# `
|
|
535
|
+
# ` {"year":{"sort":"bucket"}} `
|
|
426
536
|
#
|
|
427
537
|
# For more information, see [Getting and Using Facet Information][2] in
|
|
428
538
|
# the *Amazon CloudSearch Developer Guide*.
|
|
@@ -454,20 +564,20 @@ module Aws::CloudSearchDomain
|
|
|
454
564
|
# `text-array` fields. Each specified field must be highlight enabled in
|
|
455
565
|
# the domain configuration. The fields and options are specified in JSON
|
|
456
566
|
# using the form
|
|
457
|
-
#
|
|
567
|
+
# `{"FIELD":{"OPTION":VALUE,"OPTION:"STRING"},"FIELD":{"OPTION":VALUE,"OPTION":"STRING"}}`.
|
|
458
568
|
#
|
|
459
569
|
# You can specify the following highlight options:
|
|
460
570
|
#
|
|
461
|
-
# * `format
|
|
462
|
-
#
|
|
463
|
-
#
|
|
464
|
-
# * `max_phrases
|
|
571
|
+
# * `format`: specifies the format of the data in the text field: `text`
|
|
572
|
+
# or `html`. When data is returned as HTML, all non-alphanumeric
|
|
573
|
+
# characters are encoded. The default is `html`.
|
|
574
|
+
# * `max_phrases`: specifies the maximum number of occurrences of the
|
|
465
575
|
# search term(s) you want to highlight. By default, the first
|
|
466
576
|
# occurrence is highlighted.
|
|
467
|
-
# * `pre_tag
|
|
577
|
+
# * `pre_tag`: specifies the string to prepend to an occurrence of a
|
|
468
578
|
# search term. The default for HTML highlights is `<em>`. The
|
|
469
579
|
# default for text highlights is `*`.
|
|
470
|
-
# * `post_tag
|
|
580
|
+
# * `post_tag`: specifies the string to append to an occurrence of a
|
|
471
581
|
# search term. The default for HTML highlights is `</em>`. The
|
|
472
582
|
# default for text highlights is `*`.
|
|
473
583
|
#
|
|
@@ -478,8 +588,8 @@ module Aws::CloudSearchDomain
|
|
|
478
588
|
# For example, the following request retrieves highlights for the
|
|
479
589
|
# `actors` and `title` fields.
|
|
480
590
|
#
|
|
481
|
-
#
|
|
482
|
-
# 2,"pre_tag": "","post_tag": ""
|
|
591
|
+
# `{ "actors": {}, "title": {"format": "text","max_phrases":
|
|
592
|
+
# 2,"pre_tag": "","post_tag": ""} }`
|
|
483
593
|
#
|
|
484
594
|
# @option params [Boolean] :partial
|
|
485
595
|
# Enables partial results to be returned if one or more index partitions
|
|
@@ -513,11 +623,11 @@ module Aws::CloudSearchDomain
|
|
|
513
623
|
# @option params [String] :query_options
|
|
514
624
|
# Configures options for the query parser specified in the `queryParser`
|
|
515
625
|
# parameter. You specify the options in JSON using the following form
|
|
516
|
-
#
|
|
626
|
+
# `{"OPTION1":"VALUE1","OPTION2":VALUE2"..."OPTIONN":"VALUEN"}.`
|
|
517
627
|
#
|
|
518
628
|
# The options you can configure vary according to which parser you use:
|
|
519
629
|
#
|
|
520
|
-
# * `defaultOperator
|
|
630
|
+
# * `defaultOperator`: The default operator used to combine individual
|
|
521
631
|
# terms in the search string. For example: `defaultOperator: 'or'`.
|
|
522
632
|
# For the `dismax` parser, you specify a percentage that represents
|
|
523
633
|
# the percentage of terms in the search string (rounded down) that
|
|
@@ -529,7 +639,7 @@ module Aws::CloudSearchDomain
|
|
|
529
639
|
# (`dismax`). Default: `and` (`simple`, `structured`, `lucene`) or
|
|
530
640
|
# `100` (`dismax`). Valid for: `simple`, `structured`, `lucene`, and
|
|
531
641
|
# `dismax`.
|
|
532
|
-
# * `fields
|
|
642
|
+
# * `fields`: An array of the fields to search when no fields are
|
|
533
643
|
# specified in a search. If no fields are specified in a search and
|
|
534
644
|
# this option is not specified, all text and text-array fields are
|
|
535
645
|
# searched. You can specify a weight for each field to control the
|
|
@@ -541,7 +651,7 @@ module Aws::CloudSearchDomain
|
|
|
541
651
|
# The name of any configured field and an optional numeric value
|
|
542
652
|
# greater than zero. Default: All `text` and `text-array` fields.
|
|
543
653
|
# Valid for: `simple`, `structured`, `lucene`, and `dismax`.
|
|
544
|
-
# * `operators
|
|
654
|
+
# * `operators`: An array of the operators or special characters you
|
|
545
655
|
# want to disable for the simple query parser. If you disable the
|
|
546
656
|
# `and`, `or`, or `not` operators, the corresponding operators (`+`,
|
|
547
657
|
# `|`, `-`) have no special meaning and are dropped from the search
|
|
@@ -563,7 +673,7 @@ module Aws::CloudSearchDomain
|
|
|
563
673
|
# `escape`, `fuzzy`, `near`, `not`, `or`, `phrase`, `precedence`,
|
|
564
674
|
# `prefix`, `whitespace`. Default: All operators and special
|
|
565
675
|
# characters are enabled. Valid for: `simple`.
|
|
566
|
-
# * `phraseFields
|
|
676
|
+
# * `phraseFields`: An array of the `text` or `text-array` fields you
|
|
567
677
|
# want to use for phrase searches. When the terms in the search string
|
|
568
678
|
# appear in close proximity within a field, the field scores higher.
|
|
569
679
|
# You can specify a weight for each field to boost that score. The
|
|
@@ -577,20 +687,20 @@ module Aws::CloudSearchDomain
|
|
|
577
687
|
# If you don't specify any fields with `phraseFields`, proximity
|
|
578
688
|
# scoring is disabled even if `phraseSlop` is specified. Valid for:
|
|
579
689
|
# `dismax`.
|
|
580
|
-
# * `phraseSlop
|
|
690
|
+
# * `phraseSlop`: An integer value that specifies how much matches can
|
|
581
691
|
# deviate from the search phrase and still be boosted according to the
|
|
582
692
|
# weights specified in the `phraseFields` option; for example,
|
|
583
693
|
# `phraseSlop: 2`. You must also specify `phraseFields` to enable
|
|
584
694
|
# proximity scoring. Valid values: positive integers. Default: 0.
|
|
585
695
|
# Valid for: `dismax`.
|
|
586
|
-
# * `explicitPhraseSlop
|
|
696
|
+
# * `explicitPhraseSlop`: An integer value that specifies how much a
|
|
587
697
|
# match can deviate from the search phrase when the phrase is enclosed
|
|
588
698
|
# in double quotes in the search string. (Phrases that exceed this
|
|
589
699
|
# proximity distance are not considered a match.) For example, to
|
|
590
700
|
# specify a slop of three for dismax phrase queries, you would specify
|
|
591
701
|
# `"explicitPhraseSlop":3`. Valid values: positive integers. Default:
|
|
592
702
|
# 0. Valid for: `dismax`.
|
|
593
|
-
# * `tieBreaker
|
|
703
|
+
# * `tieBreaker`: When a term in the search string is found in a
|
|
594
704
|
# document's field, a score is calculated for that field based on how
|
|
595
705
|
# common the word is in that field compared to other documents. If the
|
|
596
706
|
# term occurs in multiple fields within a document, by default only
|
|
@@ -614,11 +724,11 @@ module Aws::CloudSearchDomain
|
|
|
614
724
|
#
|
|
615
725
|
# Amazon CloudSearch supports four query parsers:
|
|
616
726
|
#
|
|
617
|
-
# * `simple
|
|
618
|
-
#
|
|
619
|
-
#
|
|
620
|
-
#
|
|
621
|
-
#
|
|
727
|
+
# * `simple`: perform simple searches of `text` and `text-array` fields.
|
|
728
|
+
# By default, the `simple` query parser searches all `text` and
|
|
729
|
+
# `text-array` fields. You can specify which fields to search by with
|
|
730
|
+
# the `queryOptions` parameter. If you prefix a search term with a
|
|
731
|
+
# plus sign (+) documents must contain the term to be considered a
|
|
622
732
|
# match. (This is the default, unless you configure the default
|
|
623
733
|
# operator with the `queryOptions` parameter.) You can use the `-`
|
|
624
734
|
# (NOT), `|` (OR), and `*` (wildcard) operators to exclude particular
|
|
@@ -626,15 +736,15 @@ module Aws::CloudSearchDomain
|
|
|
626
736
|
# for a prefix. To search for a phrase rather than individual terms,
|
|
627
737
|
# enclose the phrase in double quotes. For more information, see
|
|
628
738
|
# [Searching for Text][1] in the *Amazon CloudSearch Developer Guide*.
|
|
629
|
-
# * `structured
|
|
739
|
+
# * `structured`: perform advanced searches by combining multiple
|
|
630
740
|
# expressions to define the search criteria. You can also search
|
|
631
741
|
# within particular fields, search for values and ranges of values,
|
|
632
742
|
# and use advanced options such as term boosting, `matchall`, and
|
|
633
743
|
# `near`. For more information, see [Constructing Compound Queries][2]
|
|
634
744
|
# in the *Amazon CloudSearch Developer Guide*.
|
|
635
|
-
# * `lucene
|
|
745
|
+
# * `lucene`: search using the Apache Lucene query parser syntax. For
|
|
636
746
|
# more information, see [Apache Lucene Query Parser Syntax][3].
|
|
637
|
-
# * `dismax
|
|
747
|
+
# * `dismax`: search using the simplified subset of the Apache Lucene
|
|
638
748
|
# query parser syntax defined by the DisMax query parser. For more
|
|
639
749
|
# information, see [DisMax Query Parser Syntax][4].
|
|
640
750
|
#
|
|
@@ -693,7 +803,7 @@ module Aws::CloudSearchDomain
|
|
|
693
803
|
# Each specified field must be facet-enabled in the domain
|
|
694
804
|
# configuration. The fields are specified in JSON using the form:
|
|
695
805
|
#
|
|
696
|
-
#
|
|
806
|
+
# `{"FIELD-A":{},"FIELD-B":{}}` There are currently no options supported for statistics.
|
|
697
807
|
#
|
|
698
808
|
# @return [Types::SearchResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
699
809
|
#
|
|
@@ -896,14 +1006,19 @@ module Aws::CloudSearchDomain
|
|
|
896
1006
|
# @api private
|
|
897
1007
|
def build_request(operation_name, params = {})
|
|
898
1008
|
handlers = @handlers.for(operation_name)
|
|
1009
|
+
tracer = config.telemetry_provider.tracer_provider.tracer(
|
|
1010
|
+
Aws::Telemetry.module_to_tracer_name('Aws::CloudSearchDomain')
|
|
1011
|
+
)
|
|
899
1012
|
context = Seahorse::Client::RequestContext.new(
|
|
900
1013
|
operation_name: operation_name,
|
|
901
1014
|
operation: config.api.operation(operation_name),
|
|
902
1015
|
client: self,
|
|
903
1016
|
params: params,
|
|
904
|
-
config: config
|
|
1017
|
+
config: config,
|
|
1018
|
+
tracer: tracer
|
|
1019
|
+
)
|
|
905
1020
|
context[:gem_name] = 'aws-sdk-cloudsearchdomain'
|
|
906
|
-
context[:gem_version] = '1.
|
|
1021
|
+
context[:gem_version] = '1.74.0'
|
|
907
1022
|
Seahorse::Client::Request.new(handlers, context)
|
|
908
1023
|
end
|
|
909
1024
|
|
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
#
|
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
|
9
9
|
|
|
10
|
+
|
|
10
11
|
module Aws::CloudSearchDomain
|
|
11
12
|
# @api private
|
|
12
13
|
module ClientApi
|
|
@@ -198,10 +199,13 @@ module Aws::CloudSearchDomain
|
|
|
198
199
|
|
|
199
200
|
api.metadata = {
|
|
200
201
|
"apiVersion" => "2013-01-01",
|
|
202
|
+
"auth" => ["aws.auth#sigv4"],
|
|
201
203
|
"endpointPrefix" => "cloudsearchdomain",
|
|
202
204
|
"jsonVersion" => "1.1",
|
|
203
205
|
"protocol" => "rest-json",
|
|
206
|
+
"protocols" => ["rest-json"],
|
|
204
207
|
"serviceFullName" => "Amazon CloudSearch Domain",
|
|
208
|
+
"serviceId" => "CloudSearch Domain",
|
|
205
209
|
"signatureVersion" => "v4",
|
|
206
210
|
"signingName" => "cloudsearch",
|
|
207
211
|
"uid" => "cloudsearchdomain-2013-01-01",
|