aws-sdk-cloudsearch 1.0.0.rc1

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 87b2e9fd3c785fa04230358d5c39150145067e9b
4
+ data.tar.gz: e9cfce47f68628d217eab842b81ba95662875186
5
+ SHA512:
6
+ metadata.gz: 589b33de570bcc6329908d191d82c7c4c46e657fa27879b28ae3218e0a528d62723b647d9759d238b1ce83ea82dae286de3a281b32796ae699d1a0972c89661d
7
+ data.tar.gz: e39257457e26ba175417fabe8784dc7a11b3a9b5ffda38841b4ef131afa7be38141bef89a0b629ebbd9a6069d71da1c0782ad4a5db09c4cb194cbb4fc9a3a97c
@@ -0,0 +1,47 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing for info on making contributions:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ require 'aws-sdk-core'
9
+ require 'aws-sigv4'
10
+
11
+ require_relative 'aws-sdk-cloudsearch/types'
12
+ require_relative 'aws-sdk-cloudsearch/client_api'
13
+ require_relative 'aws-sdk-cloudsearch/client'
14
+ require_relative 'aws-sdk-cloudsearch/errors'
15
+ require_relative 'aws-sdk-cloudsearch/resource'
16
+ require_relative 'aws-sdk-cloudsearch/customizations'
17
+
18
+ # This module provides support for Amazon CloudSearch. This module is available in the
19
+ # `aws-sdk-cloudsearch` gem.
20
+ #
21
+ # # Client
22
+ #
23
+ # The {Client} class provides one method for each API operation. Operation
24
+ # methods each accept a hash of request parameters and return a response
25
+ # structure.
26
+ #
27
+ # See {Client} for more information.
28
+ #
29
+ # # Errors
30
+ #
31
+ # Errors returned from Amazon CloudSearch all
32
+ # extend {Errors::ServiceError}.
33
+ #
34
+ # begin
35
+ # # do stuff
36
+ # rescue Aws::CloudSearch::Errors::ServiceError
37
+ # # rescues all service API errors
38
+ # end
39
+ #
40
+ # See {Errors} for more information.
41
+ #
42
+ # @service
43
+ module Aws::CloudSearch
44
+
45
+ GEM_VERSION = '1.0.0.rc1'
46
+
47
+ end
@@ -0,0 +1,1441 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing for info on making contributions:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ require 'seahorse/client/plugins/content_length.rb'
9
+ require 'aws-sdk-core/plugins/credentials_configuration.rb'
10
+ require 'aws-sdk-core/plugins/logging.rb'
11
+ require 'aws-sdk-core/plugins/param_converter.rb'
12
+ require 'aws-sdk-core/plugins/param_validator.rb'
13
+ require 'aws-sdk-core/plugins/user_agent.rb'
14
+ require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
15
+ require 'aws-sdk-core/plugins/retry_errors.rb'
16
+ require 'aws-sdk-core/plugins/global_configuration.rb'
17
+ require 'aws-sdk-core/plugins/regional_endpoint.rb'
18
+ require 'aws-sdk-core/plugins/response_paging.rb'
19
+ require 'aws-sdk-core/plugins/stub_responses.rb'
20
+ require 'aws-sdk-core/plugins/idempotency_token.rb'
21
+ require 'aws-sdk-core/plugins/signature_v4.rb'
22
+ require 'aws-sdk-core/plugins/protocols/query.rb'
23
+
24
+ Aws::Plugins::GlobalConfiguration.add_identifier(:cloudsearch)
25
+
26
+ module Aws
27
+ module CloudSearch
28
+ class Client < Seahorse::Client::Base
29
+
30
+ include Aws::ClientStubs
31
+
32
+ @identifier = :cloudsearch
33
+
34
+ set_api(ClientApi::API)
35
+
36
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
37
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
38
+ add_plugin(Aws::Plugins::Logging)
39
+ add_plugin(Aws::Plugins::ParamConverter)
40
+ add_plugin(Aws::Plugins::ParamValidator)
41
+ add_plugin(Aws::Plugins::UserAgent)
42
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
43
+ add_plugin(Aws::Plugins::RetryErrors)
44
+ add_plugin(Aws::Plugins::GlobalConfiguration)
45
+ add_plugin(Aws::Plugins::RegionalEndpoint)
46
+ add_plugin(Aws::Plugins::ResponsePaging)
47
+ add_plugin(Aws::Plugins::StubResponses)
48
+ add_plugin(Aws::Plugins::IdempotencyToken)
49
+ add_plugin(Aws::Plugins::SignatureV4)
50
+ add_plugin(Aws::Plugins::Protocols::Query)
51
+
52
+ # @option options [required, Aws::CredentialProvider] :credentials
53
+ # Your AWS credentials. This can be an instance of any one of the
54
+ # following classes:
55
+ #
56
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
57
+ # credentials.
58
+ #
59
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
60
+ # from an EC2 IMDS on an EC2 instance.
61
+ #
62
+ # * `Aws::SharedCredentials` - Used for loading credentials from a
63
+ # shared file, such as `~/.aws/config`.
64
+ #
65
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
66
+ #
67
+ # When `:credentials` are not configured directly, the following
68
+ # locations will be searched for credentials:
69
+ #
70
+ # * `Aws.config[:credentials]`
71
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
72
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
73
+ # * `~/.aws/credentials`
74
+ # * `~/.aws/config`
75
+ # * EC2 IMDS instance profile - When used by default, the timeouts are
76
+ # very aggressive. Construct and pass an instance of
77
+ # `Aws::InstanceProfileCredentails` to enable retries and extended
78
+ # timeouts.
79
+ # @option options [required, String] :region
80
+ # The AWS region to connect to. The configured `:region` is
81
+ # used to determine the service `:endpoint`. When not passed,
82
+ # a default `:region` is search for in the following locations:
83
+ #
84
+ # * `Aws.config[:region]`
85
+ # * `ENV['AWS_REGION']`
86
+ # * `ENV['AMAZON_REGION']`
87
+ # * `ENV['AWS_DEFAULT_REGION']`
88
+ # * `~/.aws/credentials`
89
+ # * `~/.aws/config`
90
+ # @option options [String] :access_key_id
91
+ # @option options [Boolean] :convert_params (true)
92
+ # When `true`, an attempt is made to coerce request parameters into
93
+ # the required types.
94
+ # @option options [String] :endpoint
95
+ # The client endpoint is normally constructed from the `:region`
96
+ # option. You should only configure an `:endpoint` when connecting
97
+ # to test endpoints. This should be avalid HTTP(S) URI.
98
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
99
+ # The log formatter.
100
+ # @option options [Symbol] :log_level (:info)
101
+ # The log level to send messages to the `:logger` at.
102
+ # @option options [Logger] :logger
103
+ # The Logger instance to send log messages to. If this option
104
+ # is not set, logging will be disabled.
105
+ # @option options [String] :profile ("default")
106
+ # Used when loading credentials from the shared credentials file
107
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
108
+ # @option options [Integer] :retry_limit (3)
109
+ # The maximum number of times to retry failed requests. Only
110
+ # ~ 500 level server errors and certain ~ 400 level client errors
111
+ # are retried. Generally, these are throttling errors, data
112
+ # checksum errors, networking errors, timeout errors and auth
113
+ # errors from expired credentials.
114
+ # @option options [String] :secret_access_key
115
+ # @option options [String] :session_token
116
+ # @option options [Boolean] :stub_responses (false)
117
+ # Causes the client to return stubbed responses. By default
118
+ # fake responses are generated and returned. You can specify
119
+ # the response data to return or errors to raise by calling
120
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
121
+ #
122
+ # ** Please note ** When response stubbing is enabled, no HTTP
123
+ # requests are made, and retries are disabled.
124
+ # @option options [Boolean] :validate_params (true)
125
+ # When `true`, request parameters are validated before
126
+ # sending the request.
127
+ def initialize(*args)
128
+ super
129
+ end
130
+
131
+ # @!group API Operations
132
+
133
+ # Indexes the search suggestions. For more information, see [Configuring
134
+ # Suggesters][1] in the *Amazon CloudSearch Developer Guide*.
135
+ #
136
+ #
137
+ #
138
+ # [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html#configuring-suggesters
139
+ # @option params [required, String] :domain_name
140
+ # A string that represents the name of a domain. Domain names are unique
141
+ # across the domains owned by an account within an AWS region. Domain
142
+ # names start with a letter or number and can contain the following
143
+ # characters: a-z (lowercase), 0-9, and - (hyphen).
144
+ # @return [Types::BuildSuggestersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
145
+ #
146
+ # * {Types::BuildSuggestersResponse#field_names #FieldNames} => Array&lt;String&gt;
147
+ #
148
+ # @example Request syntax with placeholder values
149
+ # resp = client.build_suggesters({
150
+ # domain_name: "DomainName", # required
151
+ # })
152
+ #
153
+ # @example Response structure
154
+ # resp.field_names #=> Array
155
+ # resp.field_names[0] #=> String
156
+ # @overload build_suggesters(params = {})
157
+ # @param [Hash] params ({})
158
+ def build_suggesters(params = {}, options = {})
159
+ req = build_request(:build_suggesters, params)
160
+ req.send_request(options)
161
+ end
162
+
163
+ # Creates a new search domain. For more information, see [Creating a
164
+ # Search Domain][1] in the *Amazon CloudSearch Developer Guide*.
165
+ #
166
+ #
167
+ #
168
+ # [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/creating-domains.html
169
+ # @option params [required, String] :domain_name
170
+ # A name for the domain you are creating. Allowed characters are a-z
171
+ # (lower-case letters), 0-9, and hyphen (-). Domain names must start
172
+ # with a letter or number and be at least 3 and no more than 28
173
+ # characters long.
174
+ # @return [Types::CreateDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
175
+ #
176
+ # * {Types::CreateDomainResponse#domain_status #DomainStatus} => Types::DomainStatus
177
+ #
178
+ # @example Request syntax with placeholder values
179
+ # resp = client.create_domain({
180
+ # domain_name: "DomainName", # required
181
+ # })
182
+ #
183
+ # @example Response structure
184
+ # resp.domain_status.domain_id #=> String
185
+ # resp.domain_status.domain_name #=> String
186
+ # resp.domain_status.arn #=> String
187
+ # resp.domain_status.created #=> Boolean
188
+ # resp.domain_status.deleted #=> Boolean
189
+ # resp.domain_status.doc_service.endpoint #=> String
190
+ # resp.domain_status.search_service.endpoint #=> String
191
+ # resp.domain_status.requires_index_documents #=> Boolean
192
+ # resp.domain_status.processing #=> Boolean
193
+ # resp.domain_status.search_instance_type #=> String
194
+ # resp.domain_status.search_partition_count #=> Integer
195
+ # resp.domain_status.search_instance_count #=> Integer
196
+ # resp.domain_status.limits.maximum_replication_count #=> Integer
197
+ # resp.domain_status.limits.maximum_partition_count #=> Integer
198
+ # @overload create_domain(params = {})
199
+ # @param [Hash] params ({})
200
+ def create_domain(params = {}, options = {})
201
+ req = build_request(:create_domain, params)
202
+ req.send_request(options)
203
+ end
204
+
205
+ # Configures an analysis scheme that can be applied to a `text` or
206
+ # `text-array` field to define language-specific text processing
207
+ # options. For more information, see [Configuring Analysis Schemes][1]
208
+ # in the *Amazon CloudSearch Developer Guide*.
209
+ #
210
+ #
211
+ #
212
+ # [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html
213
+ # @option params [required, String] :domain_name
214
+ # A string that represents the name of a domain. Domain names are unique
215
+ # across the domains owned by an account within an AWS region. Domain
216
+ # names start with a letter or number and can contain the following
217
+ # characters: a-z (lowercase), 0-9, and - (hyphen).
218
+ # @option params [required, Types::AnalysisScheme] :analysis_scheme
219
+ # Configuration information for an analysis scheme. Each analysis scheme
220
+ # has a unique name and specifies the language of the text to be
221
+ # processed. The following options can be configured for an analysis
222
+ # scheme: `Synonyms`, `Stopwords`, `StemmingDictionary`,
223
+ # `JapaneseTokenizationDictionary` and `AlgorithmicStemming`.
224
+ # @return [Types::DefineAnalysisSchemeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
225
+ #
226
+ # * {Types::DefineAnalysisSchemeResponse#analysis_scheme #AnalysisScheme} => Types::AnalysisSchemeStatus
227
+ #
228
+ # @example Request syntax with placeholder values
229
+ # resp = client.define_analysis_scheme({
230
+ # domain_name: "DomainName", # required
231
+ # analysis_scheme: { # required
232
+ # analysis_scheme_name: "StandardName", # required
233
+ # 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
234
+ # analysis_options: {
235
+ # synonyms: "String",
236
+ # stopwords: "String",
237
+ # stemming_dictionary: "String",
238
+ # japanese_tokenization_dictionary: "String",
239
+ # algorithmic_stemming: "none", # accepts none, minimal, light, full
240
+ # },
241
+ # },
242
+ # })
243
+ #
244
+ # @example Response structure
245
+ # resp.analysis_scheme.options.analysis_scheme_name #=> String
246
+ # 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"
247
+ # resp.analysis_scheme.options.analysis_options.synonyms #=> String
248
+ # resp.analysis_scheme.options.analysis_options.stopwords #=> String
249
+ # resp.analysis_scheme.options.analysis_options.stemming_dictionary #=> String
250
+ # resp.analysis_scheme.options.analysis_options.japanese_tokenization_dictionary #=> String
251
+ # resp.analysis_scheme.options.analysis_options.algorithmic_stemming #=> String, one of "none", "minimal", "light", "full"
252
+ # resp.analysis_scheme.status.creation_date #=> Time
253
+ # resp.analysis_scheme.status.update_date #=> Time
254
+ # resp.analysis_scheme.status.update_version #=> Integer
255
+ # resp.analysis_scheme.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
256
+ # resp.analysis_scheme.status.pending_deletion #=> Boolean
257
+ # @overload define_analysis_scheme(params = {})
258
+ # @param [Hash] params ({})
259
+ def define_analysis_scheme(params = {}, options = {})
260
+ req = build_request(:define_analysis_scheme, params)
261
+ req.send_request(options)
262
+ end
263
+
264
+ # Configures an `Expression` for the search domain. Used to create new
265
+ # expressions and modify existing ones. If the expression exists, the
266
+ # new configuration replaces the old one. For more information, see
267
+ # [Configuring Expressions][1] in the *Amazon CloudSearch Developer
268
+ # Guide*.
269
+ #
270
+ #
271
+ #
272
+ # [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html
273
+ # @option params [required, String] :domain_name
274
+ # A string that represents the name of a domain. Domain names are unique
275
+ # across the domains owned by an account within an AWS region. Domain
276
+ # names start with a letter or number and can contain the following
277
+ # characters: a-z (lowercase), 0-9, and - (hyphen).
278
+ # @option params [required, Types::Expression] :expression
279
+ # A named expression that can be evaluated at search time. Can be used
280
+ # to sort the search results, define other expressions, or return
281
+ # computed information in the search results.
282
+ # @return [Types::DefineExpressionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
283
+ #
284
+ # * {Types::DefineExpressionResponse#expression #Expression} => Types::ExpressionStatus
285
+ #
286
+ # @example Request syntax with placeholder values
287
+ # resp = client.define_expression({
288
+ # domain_name: "DomainName", # required
289
+ # expression: { # required
290
+ # expression_name: "StandardName", # required
291
+ # expression_value: "ExpressionValue", # required
292
+ # },
293
+ # })
294
+ #
295
+ # @example Response structure
296
+ # resp.expression.options.expression_name #=> String
297
+ # resp.expression.options.expression_value #=> String
298
+ # resp.expression.status.creation_date #=> Time
299
+ # resp.expression.status.update_date #=> Time
300
+ # resp.expression.status.update_version #=> Integer
301
+ # resp.expression.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
302
+ # resp.expression.status.pending_deletion #=> Boolean
303
+ # @overload define_expression(params = {})
304
+ # @param [Hash] params ({})
305
+ def define_expression(params = {}, options = {})
306
+ req = build_request(:define_expression, params)
307
+ req.send_request(options)
308
+ end
309
+
310
+ # Configures an `IndexField` for the search domain. Used to create new
311
+ # fields and modify existing ones. You must specify the name of the
312
+ # domain you are configuring and an index field configuration. The index
313
+ # field configuration specifies a unique name, the index field type, and
314
+ # the options you want to configure for the field. The options you can
315
+ # specify depend on the `IndexFieldType`. If the field exists, the new
316
+ # configuration replaces the old one. For more information, see
317
+ # [Configuring Index Fields][1] in the *Amazon CloudSearch Developer
318
+ # Guide*.
319
+ #
320
+ #
321
+ #
322
+ # [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html
323
+ # @option params [required, String] :domain_name
324
+ # A string that represents the name of a domain. Domain names are unique
325
+ # across the domains owned by an account within an AWS region. Domain
326
+ # names start with a letter or number and can contain the following
327
+ # characters: a-z (lowercase), 0-9, and - (hyphen).
328
+ # @option params [required, Types::IndexField] :index_field
329
+ # The index field and field options you want to configure.
330
+ # @return [Types::DefineIndexFieldResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
331
+ #
332
+ # * {Types::DefineIndexFieldResponse#index_field #IndexField} => Types::IndexFieldStatus
333
+ #
334
+ # @example Request syntax with placeholder values
335
+ # resp = client.define_index_field({
336
+ # domain_name: "DomainName", # required
337
+ # index_field: { # required
338
+ # index_field_name: "DynamicFieldName", # required
339
+ # index_field_type: "int", # required, accepts int, double, literal, text, date, latlon, int-array, double-array, literal-array, text-array, date-array
340
+ # int_options: {
341
+ # default_value: 1,
342
+ # source_field: "FieldName",
343
+ # facet_enabled: false,
344
+ # search_enabled: false,
345
+ # return_enabled: false,
346
+ # sort_enabled: false,
347
+ # },
348
+ # double_options: {
349
+ # default_value: 1.0,
350
+ # source_field: "FieldName",
351
+ # facet_enabled: false,
352
+ # search_enabled: false,
353
+ # return_enabled: false,
354
+ # sort_enabled: false,
355
+ # },
356
+ # literal_options: {
357
+ # default_value: "FieldValue",
358
+ # source_field: "FieldName",
359
+ # facet_enabled: false,
360
+ # search_enabled: false,
361
+ # return_enabled: false,
362
+ # sort_enabled: false,
363
+ # },
364
+ # text_options: {
365
+ # default_value: "FieldValue",
366
+ # source_field: "FieldName",
367
+ # return_enabled: false,
368
+ # sort_enabled: false,
369
+ # highlight_enabled: false,
370
+ # analysis_scheme: "Word",
371
+ # },
372
+ # date_options: {
373
+ # default_value: "FieldValue",
374
+ # source_field: "FieldName",
375
+ # facet_enabled: false,
376
+ # search_enabled: false,
377
+ # return_enabled: false,
378
+ # sort_enabled: false,
379
+ # },
380
+ # lat_lon_options: {
381
+ # default_value: "FieldValue",
382
+ # source_field: "FieldName",
383
+ # facet_enabled: false,
384
+ # search_enabled: false,
385
+ # return_enabled: false,
386
+ # sort_enabled: false,
387
+ # },
388
+ # int_array_options: {
389
+ # default_value: 1,
390
+ # source_fields: "FieldNameCommaList",
391
+ # facet_enabled: false,
392
+ # search_enabled: false,
393
+ # return_enabled: false,
394
+ # },
395
+ # double_array_options: {
396
+ # default_value: 1.0,
397
+ # source_fields: "FieldNameCommaList",
398
+ # facet_enabled: false,
399
+ # search_enabled: false,
400
+ # return_enabled: false,
401
+ # },
402
+ # literal_array_options: {
403
+ # default_value: "FieldValue",
404
+ # source_fields: "FieldNameCommaList",
405
+ # facet_enabled: false,
406
+ # search_enabled: false,
407
+ # return_enabled: false,
408
+ # },
409
+ # text_array_options: {
410
+ # default_value: "FieldValue",
411
+ # source_fields: "FieldNameCommaList",
412
+ # return_enabled: false,
413
+ # highlight_enabled: false,
414
+ # analysis_scheme: "Word",
415
+ # },
416
+ # date_array_options: {
417
+ # default_value: "FieldValue",
418
+ # source_fields: "FieldNameCommaList",
419
+ # facet_enabled: false,
420
+ # search_enabled: false,
421
+ # return_enabled: false,
422
+ # },
423
+ # },
424
+ # })
425
+ #
426
+ # @example Response structure
427
+ # resp.index_field.options.index_field_name #=> String
428
+ # 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"
429
+ # resp.index_field.options.int_options.default_value #=> Integer
430
+ # resp.index_field.options.int_options.source_field #=> String
431
+ # resp.index_field.options.int_options.facet_enabled #=> Boolean
432
+ # resp.index_field.options.int_options.search_enabled #=> Boolean
433
+ # resp.index_field.options.int_options.return_enabled #=> Boolean
434
+ # resp.index_field.options.int_options.sort_enabled #=> Boolean
435
+ # resp.index_field.options.double_options.default_value #=> Float
436
+ # resp.index_field.options.double_options.source_field #=> String
437
+ # resp.index_field.options.double_options.facet_enabled #=> Boolean
438
+ # resp.index_field.options.double_options.search_enabled #=> Boolean
439
+ # resp.index_field.options.double_options.return_enabled #=> Boolean
440
+ # resp.index_field.options.double_options.sort_enabled #=> Boolean
441
+ # resp.index_field.options.literal_options.default_value #=> String
442
+ # resp.index_field.options.literal_options.source_field #=> String
443
+ # resp.index_field.options.literal_options.facet_enabled #=> Boolean
444
+ # resp.index_field.options.literal_options.search_enabled #=> Boolean
445
+ # resp.index_field.options.literal_options.return_enabled #=> Boolean
446
+ # resp.index_field.options.literal_options.sort_enabled #=> Boolean
447
+ # resp.index_field.options.text_options.default_value #=> String
448
+ # resp.index_field.options.text_options.source_field #=> String
449
+ # resp.index_field.options.text_options.return_enabled #=> Boolean
450
+ # resp.index_field.options.text_options.sort_enabled #=> Boolean
451
+ # resp.index_field.options.text_options.highlight_enabled #=> Boolean
452
+ # resp.index_field.options.text_options.analysis_scheme #=> String
453
+ # resp.index_field.options.date_options.default_value #=> String
454
+ # resp.index_field.options.date_options.source_field #=> String
455
+ # resp.index_field.options.date_options.facet_enabled #=> Boolean
456
+ # resp.index_field.options.date_options.search_enabled #=> Boolean
457
+ # resp.index_field.options.date_options.return_enabled #=> Boolean
458
+ # resp.index_field.options.date_options.sort_enabled #=> Boolean
459
+ # resp.index_field.options.lat_lon_options.default_value #=> String
460
+ # resp.index_field.options.lat_lon_options.source_field #=> String
461
+ # resp.index_field.options.lat_lon_options.facet_enabled #=> Boolean
462
+ # resp.index_field.options.lat_lon_options.search_enabled #=> Boolean
463
+ # resp.index_field.options.lat_lon_options.return_enabled #=> Boolean
464
+ # resp.index_field.options.lat_lon_options.sort_enabled #=> Boolean
465
+ # resp.index_field.options.int_array_options.default_value #=> Integer
466
+ # resp.index_field.options.int_array_options.source_fields #=> String
467
+ # resp.index_field.options.int_array_options.facet_enabled #=> Boolean
468
+ # resp.index_field.options.int_array_options.search_enabled #=> Boolean
469
+ # resp.index_field.options.int_array_options.return_enabled #=> Boolean
470
+ # resp.index_field.options.double_array_options.default_value #=> Float
471
+ # resp.index_field.options.double_array_options.source_fields #=> String
472
+ # resp.index_field.options.double_array_options.facet_enabled #=> Boolean
473
+ # resp.index_field.options.double_array_options.search_enabled #=> Boolean
474
+ # resp.index_field.options.double_array_options.return_enabled #=> Boolean
475
+ # resp.index_field.options.literal_array_options.default_value #=> String
476
+ # resp.index_field.options.literal_array_options.source_fields #=> String
477
+ # resp.index_field.options.literal_array_options.facet_enabled #=> Boolean
478
+ # resp.index_field.options.literal_array_options.search_enabled #=> Boolean
479
+ # resp.index_field.options.literal_array_options.return_enabled #=> Boolean
480
+ # resp.index_field.options.text_array_options.default_value #=> String
481
+ # resp.index_field.options.text_array_options.source_fields #=> String
482
+ # resp.index_field.options.text_array_options.return_enabled #=> Boolean
483
+ # resp.index_field.options.text_array_options.highlight_enabled #=> Boolean
484
+ # resp.index_field.options.text_array_options.analysis_scheme #=> String
485
+ # resp.index_field.options.date_array_options.default_value #=> String
486
+ # resp.index_field.options.date_array_options.source_fields #=> String
487
+ # resp.index_field.options.date_array_options.facet_enabled #=> Boolean
488
+ # resp.index_field.options.date_array_options.search_enabled #=> Boolean
489
+ # resp.index_field.options.date_array_options.return_enabled #=> Boolean
490
+ # resp.index_field.status.creation_date #=> Time
491
+ # resp.index_field.status.update_date #=> Time
492
+ # resp.index_field.status.update_version #=> Integer
493
+ # resp.index_field.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
494
+ # resp.index_field.status.pending_deletion #=> Boolean
495
+ # @overload define_index_field(params = {})
496
+ # @param [Hash] params ({})
497
+ def define_index_field(params = {}, options = {})
498
+ req = build_request(:define_index_field, params)
499
+ req.send_request(options)
500
+ end
501
+
502
+ # Configures a suggester for a domain. A suggester enables you to
503
+ # display possible matches before users finish typing their queries.
504
+ # When you configure a suggester, you must specify the name of the text
505
+ # field you want to search for possible matches and a unique name for
506
+ # the suggester. For more information, see [Getting Search
507
+ # Suggestions][1] in the *Amazon CloudSearch Developer Guide*.
508
+ #
509
+ #
510
+ #
511
+ # [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html
512
+ # @option params [required, String] :domain_name
513
+ # A string that represents the name of a domain. Domain names are unique
514
+ # across the domains owned by an account within an AWS region. Domain
515
+ # names start with a letter or number and can contain the following
516
+ # characters: a-z (lowercase), 0-9, and - (hyphen).
517
+ # @option params [required, Types::Suggester] :suggester
518
+ # Configuration information for a search suggester. Each suggester has a
519
+ # unique name and specifies the text field you want to use for
520
+ # suggestions. The following options can be configured for a suggester:
521
+ # `FuzzyMatching`, `SortExpression`.
522
+ # @return [Types::DefineSuggesterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
523
+ #
524
+ # * {Types::DefineSuggesterResponse#suggester #Suggester} => Types::SuggesterStatus
525
+ #
526
+ # @example Request syntax with placeholder values
527
+ # resp = client.define_suggester({
528
+ # domain_name: "DomainName", # required
529
+ # suggester: { # required
530
+ # suggester_name: "StandardName", # required
531
+ # document_suggester_options: { # required
532
+ # source_field: "FieldName", # required
533
+ # fuzzy_matching: "none", # accepts none, low, high
534
+ # sort_expression: "String",
535
+ # },
536
+ # },
537
+ # })
538
+ #
539
+ # @example Response structure
540
+ # resp.suggester.options.suggester_name #=> String
541
+ # resp.suggester.options.document_suggester_options.source_field #=> String
542
+ # resp.suggester.options.document_suggester_options.fuzzy_matching #=> String, one of "none", "low", "high"
543
+ # resp.suggester.options.document_suggester_options.sort_expression #=> String
544
+ # resp.suggester.status.creation_date #=> Time
545
+ # resp.suggester.status.update_date #=> Time
546
+ # resp.suggester.status.update_version #=> Integer
547
+ # resp.suggester.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
548
+ # resp.suggester.status.pending_deletion #=> Boolean
549
+ # @overload define_suggester(params = {})
550
+ # @param [Hash] params ({})
551
+ def define_suggester(params = {}, options = {})
552
+ req = build_request(:define_suggester, params)
553
+ req.send_request(options)
554
+ end
555
+
556
+ # Deletes an analysis scheme. For more information, see [Configuring
557
+ # Analysis Schemes][1] in the *Amazon CloudSearch Developer Guide*.
558
+ #
559
+ #
560
+ #
561
+ # [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html
562
+ # @option params [required, String] :domain_name
563
+ # A string that represents the name of a domain. Domain names are unique
564
+ # across the domains owned by an account within an AWS region. Domain
565
+ # names start with a letter or number and can contain the following
566
+ # characters: a-z (lowercase), 0-9, and - (hyphen).
567
+ # @option params [required, String] :analysis_scheme_name
568
+ # The name of the analysis scheme you want to delete.
569
+ # @return [Types::DeleteAnalysisSchemeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
570
+ #
571
+ # * {Types::DeleteAnalysisSchemeResponse#analysis_scheme #AnalysisScheme} => Types::AnalysisSchemeStatus
572
+ #
573
+ # @example Request syntax with placeholder values
574
+ # resp = client.delete_analysis_scheme({
575
+ # domain_name: "DomainName", # required
576
+ # analysis_scheme_name: "StandardName", # required
577
+ # })
578
+ #
579
+ # @example Response structure
580
+ # resp.analysis_scheme.options.analysis_scheme_name #=> String
581
+ # 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"
582
+ # resp.analysis_scheme.options.analysis_options.synonyms #=> String
583
+ # resp.analysis_scheme.options.analysis_options.stopwords #=> String
584
+ # resp.analysis_scheme.options.analysis_options.stemming_dictionary #=> String
585
+ # resp.analysis_scheme.options.analysis_options.japanese_tokenization_dictionary #=> String
586
+ # resp.analysis_scheme.options.analysis_options.algorithmic_stemming #=> String, one of "none", "minimal", "light", "full"
587
+ # resp.analysis_scheme.status.creation_date #=> Time
588
+ # resp.analysis_scheme.status.update_date #=> Time
589
+ # resp.analysis_scheme.status.update_version #=> Integer
590
+ # resp.analysis_scheme.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
591
+ # resp.analysis_scheme.status.pending_deletion #=> Boolean
592
+ # @overload delete_analysis_scheme(params = {})
593
+ # @param [Hash] params ({})
594
+ def delete_analysis_scheme(params = {}, options = {})
595
+ req = build_request(:delete_analysis_scheme, params)
596
+ req.send_request(options)
597
+ end
598
+
599
+ # Permanently deletes a search domain and all of its data. Once a domain
600
+ # has been deleted, it cannot be recovered. For more information, see
601
+ # [Deleting a Search Domain][1] in the *Amazon CloudSearch Developer
602
+ # Guide*.
603
+ #
604
+ #
605
+ #
606
+ # [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/deleting-domains.html
607
+ # @option params [required, String] :domain_name
608
+ # The name of the domain you want to permanently delete.
609
+ # @return [Types::DeleteDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
610
+ #
611
+ # * {Types::DeleteDomainResponse#domain_status #DomainStatus} => Types::DomainStatus
612
+ #
613
+ # @example Request syntax with placeholder values
614
+ # resp = client.delete_domain({
615
+ # domain_name: "DomainName", # required
616
+ # })
617
+ #
618
+ # @example Response structure
619
+ # resp.domain_status.domain_id #=> String
620
+ # resp.domain_status.domain_name #=> String
621
+ # resp.domain_status.arn #=> String
622
+ # resp.domain_status.created #=> Boolean
623
+ # resp.domain_status.deleted #=> Boolean
624
+ # resp.domain_status.doc_service.endpoint #=> String
625
+ # resp.domain_status.search_service.endpoint #=> String
626
+ # resp.domain_status.requires_index_documents #=> Boolean
627
+ # resp.domain_status.processing #=> Boolean
628
+ # resp.domain_status.search_instance_type #=> String
629
+ # resp.domain_status.search_partition_count #=> Integer
630
+ # resp.domain_status.search_instance_count #=> Integer
631
+ # resp.domain_status.limits.maximum_replication_count #=> Integer
632
+ # resp.domain_status.limits.maximum_partition_count #=> Integer
633
+ # @overload delete_domain(params = {})
634
+ # @param [Hash] params ({})
635
+ def delete_domain(params = {}, options = {})
636
+ req = build_request(:delete_domain, params)
637
+ req.send_request(options)
638
+ end
639
+
640
+ # Removes an `Expression` from the search domain. For more information,
641
+ # see [Configuring Expressions][1] in the *Amazon CloudSearch Developer
642
+ # Guide*.
643
+ #
644
+ #
645
+ #
646
+ # [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html
647
+ # @option params [required, String] :domain_name
648
+ # A string that represents the name of a domain. Domain names are unique
649
+ # across the domains owned by an account within an AWS region. Domain
650
+ # names start with a letter or number and can contain the following
651
+ # characters: a-z (lowercase), 0-9, and - (hyphen).
652
+ # @option params [required, String] :expression_name
653
+ # The name of the `Expression` to delete.
654
+ # @return [Types::DeleteExpressionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
655
+ #
656
+ # * {Types::DeleteExpressionResponse#expression #Expression} => Types::ExpressionStatus
657
+ #
658
+ # @example Request syntax with placeholder values
659
+ # resp = client.delete_expression({
660
+ # domain_name: "DomainName", # required
661
+ # expression_name: "StandardName", # required
662
+ # })
663
+ #
664
+ # @example Response structure
665
+ # resp.expression.options.expression_name #=> String
666
+ # resp.expression.options.expression_value #=> String
667
+ # resp.expression.status.creation_date #=> Time
668
+ # resp.expression.status.update_date #=> Time
669
+ # resp.expression.status.update_version #=> Integer
670
+ # resp.expression.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
671
+ # resp.expression.status.pending_deletion #=> Boolean
672
+ # @overload delete_expression(params = {})
673
+ # @param [Hash] params ({})
674
+ def delete_expression(params = {}, options = {})
675
+ req = build_request(:delete_expression, params)
676
+ req.send_request(options)
677
+ end
678
+
679
+ # Removes an `IndexField` from the search domain. For more information,
680
+ # see [Configuring Index Fields][1] in the *Amazon CloudSearch Developer
681
+ # Guide*.
682
+ #
683
+ #
684
+ #
685
+ # [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html
686
+ # @option params [required, String] :domain_name
687
+ # A string that represents the name of a domain. Domain names are unique
688
+ # across the domains owned by an account within an AWS region. Domain
689
+ # names start with a letter or number and can contain the following
690
+ # characters: a-z (lowercase), 0-9, and - (hyphen).
691
+ # @option params [required, String] :index_field_name
692
+ # The name of the index field your want to remove from the domain's
693
+ # indexing options.
694
+ # @return [Types::DeleteIndexFieldResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
695
+ #
696
+ # * {Types::DeleteIndexFieldResponse#index_field #IndexField} => Types::IndexFieldStatus
697
+ #
698
+ # @example Request syntax with placeholder values
699
+ # resp = client.delete_index_field({
700
+ # domain_name: "DomainName", # required
701
+ # index_field_name: "DynamicFieldName", # required
702
+ # })
703
+ #
704
+ # @example Response structure
705
+ # resp.index_field.options.index_field_name #=> String
706
+ # 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"
707
+ # resp.index_field.options.int_options.default_value #=> Integer
708
+ # resp.index_field.options.int_options.source_field #=> String
709
+ # resp.index_field.options.int_options.facet_enabled #=> Boolean
710
+ # resp.index_field.options.int_options.search_enabled #=> Boolean
711
+ # resp.index_field.options.int_options.return_enabled #=> Boolean
712
+ # resp.index_field.options.int_options.sort_enabled #=> Boolean
713
+ # resp.index_field.options.double_options.default_value #=> Float
714
+ # resp.index_field.options.double_options.source_field #=> String
715
+ # resp.index_field.options.double_options.facet_enabled #=> Boolean
716
+ # resp.index_field.options.double_options.search_enabled #=> Boolean
717
+ # resp.index_field.options.double_options.return_enabled #=> Boolean
718
+ # resp.index_field.options.double_options.sort_enabled #=> Boolean
719
+ # resp.index_field.options.literal_options.default_value #=> String
720
+ # resp.index_field.options.literal_options.source_field #=> String
721
+ # resp.index_field.options.literal_options.facet_enabled #=> Boolean
722
+ # resp.index_field.options.literal_options.search_enabled #=> Boolean
723
+ # resp.index_field.options.literal_options.return_enabled #=> Boolean
724
+ # resp.index_field.options.literal_options.sort_enabled #=> Boolean
725
+ # resp.index_field.options.text_options.default_value #=> String
726
+ # resp.index_field.options.text_options.source_field #=> String
727
+ # resp.index_field.options.text_options.return_enabled #=> Boolean
728
+ # resp.index_field.options.text_options.sort_enabled #=> Boolean
729
+ # resp.index_field.options.text_options.highlight_enabled #=> Boolean
730
+ # resp.index_field.options.text_options.analysis_scheme #=> String
731
+ # resp.index_field.options.date_options.default_value #=> String
732
+ # resp.index_field.options.date_options.source_field #=> String
733
+ # resp.index_field.options.date_options.facet_enabled #=> Boolean
734
+ # resp.index_field.options.date_options.search_enabled #=> Boolean
735
+ # resp.index_field.options.date_options.return_enabled #=> Boolean
736
+ # resp.index_field.options.date_options.sort_enabled #=> Boolean
737
+ # resp.index_field.options.lat_lon_options.default_value #=> String
738
+ # resp.index_field.options.lat_lon_options.source_field #=> String
739
+ # resp.index_field.options.lat_lon_options.facet_enabled #=> Boolean
740
+ # resp.index_field.options.lat_lon_options.search_enabled #=> Boolean
741
+ # resp.index_field.options.lat_lon_options.return_enabled #=> Boolean
742
+ # resp.index_field.options.lat_lon_options.sort_enabled #=> Boolean
743
+ # resp.index_field.options.int_array_options.default_value #=> Integer
744
+ # resp.index_field.options.int_array_options.source_fields #=> String
745
+ # resp.index_field.options.int_array_options.facet_enabled #=> Boolean
746
+ # resp.index_field.options.int_array_options.search_enabled #=> Boolean
747
+ # resp.index_field.options.int_array_options.return_enabled #=> Boolean
748
+ # resp.index_field.options.double_array_options.default_value #=> Float
749
+ # resp.index_field.options.double_array_options.source_fields #=> String
750
+ # resp.index_field.options.double_array_options.facet_enabled #=> Boolean
751
+ # resp.index_field.options.double_array_options.search_enabled #=> Boolean
752
+ # resp.index_field.options.double_array_options.return_enabled #=> Boolean
753
+ # resp.index_field.options.literal_array_options.default_value #=> String
754
+ # resp.index_field.options.literal_array_options.source_fields #=> String
755
+ # resp.index_field.options.literal_array_options.facet_enabled #=> Boolean
756
+ # resp.index_field.options.literal_array_options.search_enabled #=> Boolean
757
+ # resp.index_field.options.literal_array_options.return_enabled #=> Boolean
758
+ # resp.index_field.options.text_array_options.default_value #=> String
759
+ # resp.index_field.options.text_array_options.source_fields #=> String
760
+ # resp.index_field.options.text_array_options.return_enabled #=> Boolean
761
+ # resp.index_field.options.text_array_options.highlight_enabled #=> Boolean
762
+ # resp.index_field.options.text_array_options.analysis_scheme #=> String
763
+ # resp.index_field.options.date_array_options.default_value #=> String
764
+ # resp.index_field.options.date_array_options.source_fields #=> String
765
+ # resp.index_field.options.date_array_options.facet_enabled #=> Boolean
766
+ # resp.index_field.options.date_array_options.search_enabled #=> Boolean
767
+ # resp.index_field.options.date_array_options.return_enabled #=> Boolean
768
+ # resp.index_field.status.creation_date #=> Time
769
+ # resp.index_field.status.update_date #=> Time
770
+ # resp.index_field.status.update_version #=> Integer
771
+ # resp.index_field.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
772
+ # resp.index_field.status.pending_deletion #=> Boolean
773
+ # @overload delete_index_field(params = {})
774
+ # @param [Hash] params ({})
775
+ def delete_index_field(params = {}, options = {})
776
+ req = build_request(:delete_index_field, params)
777
+ req.send_request(options)
778
+ end
779
+
780
+ # Deletes a suggester. For more information, see [Getting Search
781
+ # Suggestions][1] in the *Amazon CloudSearch Developer Guide*.
782
+ #
783
+ #
784
+ #
785
+ # [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html
786
+ # @option params [required, String] :domain_name
787
+ # A string that represents the name of a domain. Domain names are unique
788
+ # across the domains owned by an account within an AWS region. Domain
789
+ # names start with a letter or number and can contain the following
790
+ # characters: a-z (lowercase), 0-9, and - (hyphen).
791
+ # @option params [required, String] :suggester_name
792
+ # Specifies the name of the suggester you want to delete.
793
+ # @return [Types::DeleteSuggesterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
794
+ #
795
+ # * {Types::DeleteSuggesterResponse#suggester #Suggester} => Types::SuggesterStatus
796
+ #
797
+ # @example Request syntax with placeholder values
798
+ # resp = client.delete_suggester({
799
+ # domain_name: "DomainName", # required
800
+ # suggester_name: "StandardName", # required
801
+ # })
802
+ #
803
+ # @example Response structure
804
+ # resp.suggester.options.suggester_name #=> String
805
+ # resp.suggester.options.document_suggester_options.source_field #=> String
806
+ # resp.suggester.options.document_suggester_options.fuzzy_matching #=> String, one of "none", "low", "high"
807
+ # resp.suggester.options.document_suggester_options.sort_expression #=> String
808
+ # resp.suggester.status.creation_date #=> Time
809
+ # resp.suggester.status.update_date #=> Time
810
+ # resp.suggester.status.update_version #=> Integer
811
+ # resp.suggester.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
812
+ # resp.suggester.status.pending_deletion #=> Boolean
813
+ # @overload delete_suggester(params = {})
814
+ # @param [Hash] params ({})
815
+ def delete_suggester(params = {}, options = {})
816
+ req = build_request(:delete_suggester, params)
817
+ req.send_request(options)
818
+ end
819
+
820
+ # Gets the analysis schemes configured for a domain. An analysis scheme
821
+ # defines language-specific text processing options for a `text` field.
822
+ # Can be limited to specific analysis schemes by name. By default, shows
823
+ # all analysis schemes and includes any pending changes to the
824
+ # configuration. Set the `Deployed` option to `true` to show the active
825
+ # configuration and exclude pending changes. For more information, see
826
+ # [Configuring Analysis Schemes][1] in the *Amazon CloudSearch Developer
827
+ # Guide*.
828
+ #
829
+ #
830
+ #
831
+ # [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html
832
+ # @option params [required, String] :domain_name
833
+ # The name of the domain you want to describe.
834
+ # @option params [Array<String>] :analysis_scheme_names
835
+ # The analysis schemes you want to describe.
836
+ # @option params [Boolean] :deployed
837
+ # Whether to display the deployed configuration (`true`) or include any
838
+ # pending changes (`false`). Defaults to `false`.
839
+ # @return [Types::DescribeAnalysisSchemesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
840
+ #
841
+ # * {Types::DescribeAnalysisSchemesResponse#analysis_schemes #AnalysisSchemes} => Array&lt;Types::AnalysisSchemeStatus&gt;
842
+ #
843
+ # @example Request syntax with placeholder values
844
+ # resp = client.describe_analysis_schemes({
845
+ # domain_name: "DomainName", # required
846
+ # analysis_scheme_names: ["StandardName"],
847
+ # deployed: false,
848
+ # })
849
+ #
850
+ # @example Response structure
851
+ # resp.analysis_schemes #=> Array
852
+ # resp.analysis_schemes[0].options.analysis_scheme_name #=> String
853
+ # 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"
854
+ # resp.analysis_schemes[0].options.analysis_options.synonyms #=> String
855
+ # resp.analysis_schemes[0].options.analysis_options.stopwords #=> String
856
+ # resp.analysis_schemes[0].options.analysis_options.stemming_dictionary #=> String
857
+ # resp.analysis_schemes[0].options.analysis_options.japanese_tokenization_dictionary #=> String
858
+ # resp.analysis_schemes[0].options.analysis_options.algorithmic_stemming #=> String, one of "none", "minimal", "light", "full"
859
+ # resp.analysis_schemes[0].status.creation_date #=> Time
860
+ # resp.analysis_schemes[0].status.update_date #=> Time
861
+ # resp.analysis_schemes[0].status.update_version #=> Integer
862
+ # resp.analysis_schemes[0].status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
863
+ # resp.analysis_schemes[0].status.pending_deletion #=> Boolean
864
+ # @overload describe_analysis_schemes(params = {})
865
+ # @param [Hash] params ({})
866
+ def describe_analysis_schemes(params = {}, options = {})
867
+ req = build_request(:describe_analysis_schemes, params)
868
+ req.send_request(options)
869
+ end
870
+
871
+ # Gets the availability options configured for a domain. By default,
872
+ # shows the configuration with any pending changes. Set the `Deployed`
873
+ # option to `true` to show the active configuration and exclude pending
874
+ # changes. For more information, see [Configuring Availability
875
+ # Options][1] in the *Amazon CloudSearch Developer Guide*.
876
+ #
877
+ #
878
+ #
879
+ # [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html
880
+ # @option params [required, String] :domain_name
881
+ # The name of the domain you want to describe.
882
+ # @option params [Boolean] :deployed
883
+ # Whether to display the deployed configuration (`true`) or include any
884
+ # pending changes (`false`). Defaults to `false`.
885
+ # @return [Types::DescribeAvailabilityOptionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
886
+ #
887
+ # * {Types::DescribeAvailabilityOptionsResponse#availability_options #AvailabilityOptions} => Types::AvailabilityOptionsStatus
888
+ #
889
+ # @example Request syntax with placeholder values
890
+ # resp = client.describe_availability_options({
891
+ # domain_name: "DomainName", # required
892
+ # deployed: false,
893
+ # })
894
+ #
895
+ # @example Response structure
896
+ # resp.availability_options.options #=> Boolean
897
+ # resp.availability_options.status.creation_date #=> Time
898
+ # resp.availability_options.status.update_date #=> Time
899
+ # resp.availability_options.status.update_version #=> Integer
900
+ # resp.availability_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
901
+ # resp.availability_options.status.pending_deletion #=> Boolean
902
+ # @overload describe_availability_options(params = {})
903
+ # @param [Hash] params ({})
904
+ def describe_availability_options(params = {}, options = {})
905
+ req = build_request(:describe_availability_options, params)
906
+ req.send_request(options)
907
+ end
908
+
909
+ # Gets information about the search domains owned by this account. Can
910
+ # be limited to specific domains. Shows all domains by default. To get
911
+ # the number of searchable documents in a domain, use the console or
912
+ # submit a `matchall` request to your domain's search endpoint:
913
+ # `q=matchall&amp;q.parser=structured&amp;size=0`. For more information,
914
+ # see [Getting Information about a Search Domain][1] in the *Amazon
915
+ # CloudSearch Developer Guide*.
916
+ #
917
+ #
918
+ #
919
+ # [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html
920
+ # @option params [Array<String>] :domain_names
921
+ # The names of the domains you want to include in the response.
922
+ # @return [Types::DescribeDomainsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
923
+ #
924
+ # * {Types::DescribeDomainsResponse#domain_status_list #DomainStatusList} => Array&lt;Types::DomainStatus&gt;
925
+ #
926
+ # @example Request syntax with placeholder values
927
+ # resp = client.describe_domains({
928
+ # domain_names: ["DomainName"],
929
+ # })
930
+ #
931
+ # @example Response structure
932
+ # resp.domain_status_list #=> Array
933
+ # resp.domain_status_list[0].domain_id #=> String
934
+ # resp.domain_status_list[0].domain_name #=> String
935
+ # resp.domain_status_list[0].arn #=> String
936
+ # resp.domain_status_list[0].created #=> Boolean
937
+ # resp.domain_status_list[0].deleted #=> Boolean
938
+ # resp.domain_status_list[0].doc_service.endpoint #=> String
939
+ # resp.domain_status_list[0].search_service.endpoint #=> String
940
+ # resp.domain_status_list[0].requires_index_documents #=> Boolean
941
+ # resp.domain_status_list[0].processing #=> Boolean
942
+ # resp.domain_status_list[0].search_instance_type #=> String
943
+ # resp.domain_status_list[0].search_partition_count #=> Integer
944
+ # resp.domain_status_list[0].search_instance_count #=> Integer
945
+ # resp.domain_status_list[0].limits.maximum_replication_count #=> Integer
946
+ # resp.domain_status_list[0].limits.maximum_partition_count #=> Integer
947
+ # @overload describe_domains(params = {})
948
+ # @param [Hash] params ({})
949
+ def describe_domains(params = {}, options = {})
950
+ req = build_request(:describe_domains, params)
951
+ req.send_request(options)
952
+ end
953
+
954
+ # Gets the expressions configured for the search domain. Can be limited
955
+ # to specific expressions by name. By default, shows all expressions and
956
+ # includes any pending changes to the configuration. Set the `Deployed`
957
+ # option to `true` to show the active configuration and exclude pending
958
+ # changes. For more information, see [Configuring Expressions][1] in the
959
+ # *Amazon CloudSearch Developer Guide*.
960
+ #
961
+ #
962
+ #
963
+ # [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html
964
+ # @option params [required, String] :domain_name
965
+ # The name of the domain you want to describe.
966
+ # @option params [Array<String>] :expression_names
967
+ # Limits the `DescribeExpressions` response to the specified
968
+ # expressions. If not specified, all expressions are shown.
969
+ # @option params [Boolean] :deployed
970
+ # Whether to display the deployed configuration (`true`) or include any
971
+ # pending changes (`false`). Defaults to `false`.
972
+ # @return [Types::DescribeExpressionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
973
+ #
974
+ # * {Types::DescribeExpressionsResponse#expressions #Expressions} => Array&lt;Types::ExpressionStatus&gt;
975
+ #
976
+ # @example Request syntax with placeholder values
977
+ # resp = client.describe_expressions({
978
+ # domain_name: "DomainName", # required
979
+ # expression_names: ["StandardName"],
980
+ # deployed: false,
981
+ # })
982
+ #
983
+ # @example Response structure
984
+ # resp.expressions #=> Array
985
+ # resp.expressions[0].options.expression_name #=> String
986
+ # resp.expressions[0].options.expression_value #=> String
987
+ # resp.expressions[0].status.creation_date #=> Time
988
+ # resp.expressions[0].status.update_date #=> Time
989
+ # resp.expressions[0].status.update_version #=> Integer
990
+ # resp.expressions[0].status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
991
+ # resp.expressions[0].status.pending_deletion #=> Boolean
992
+ # @overload describe_expressions(params = {})
993
+ # @param [Hash] params ({})
994
+ def describe_expressions(params = {}, options = {})
995
+ req = build_request(:describe_expressions, params)
996
+ req.send_request(options)
997
+ end
998
+
999
+ # Gets information about the index fields configured for the search
1000
+ # domain. Can be limited to specific fields by name. By default, shows
1001
+ # all fields and includes any pending changes to the configuration. Set
1002
+ # the `Deployed` option to `true` to show the active configuration and
1003
+ # exclude pending changes. For more information, see [Getting Domain
1004
+ # Information][1] in the *Amazon CloudSearch Developer Guide*.
1005
+ #
1006
+ #
1007
+ #
1008
+ # [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html
1009
+ # @option params [required, String] :domain_name
1010
+ # The name of the domain you want to describe.
1011
+ # @option params [Array<String>] :field_names
1012
+ # A list of the index fields you want to describe. If not specified,
1013
+ # information is returned for all configured index fields.
1014
+ # @option params [Boolean] :deployed
1015
+ # Whether to display the deployed configuration (`true`) or include any
1016
+ # pending changes (`false`). Defaults to `false`.
1017
+ # @return [Types::DescribeIndexFieldsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1018
+ #
1019
+ # * {Types::DescribeIndexFieldsResponse#index_fields #IndexFields} => Array&lt;Types::IndexFieldStatus&gt;
1020
+ #
1021
+ # @example Request syntax with placeholder values
1022
+ # resp = client.describe_index_fields({
1023
+ # domain_name: "DomainName", # required
1024
+ # field_names: ["DynamicFieldName"],
1025
+ # deployed: false,
1026
+ # })
1027
+ #
1028
+ # @example Response structure
1029
+ # resp.index_fields #=> Array
1030
+ # resp.index_fields[0].options.index_field_name #=> String
1031
+ # 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"
1032
+ # resp.index_fields[0].options.int_options.default_value #=> Integer
1033
+ # resp.index_fields[0].options.int_options.source_field #=> String
1034
+ # resp.index_fields[0].options.int_options.facet_enabled #=> Boolean
1035
+ # resp.index_fields[0].options.int_options.search_enabled #=> Boolean
1036
+ # resp.index_fields[0].options.int_options.return_enabled #=> Boolean
1037
+ # resp.index_fields[0].options.int_options.sort_enabled #=> Boolean
1038
+ # resp.index_fields[0].options.double_options.default_value #=> Float
1039
+ # resp.index_fields[0].options.double_options.source_field #=> String
1040
+ # resp.index_fields[0].options.double_options.facet_enabled #=> Boolean
1041
+ # resp.index_fields[0].options.double_options.search_enabled #=> Boolean
1042
+ # resp.index_fields[0].options.double_options.return_enabled #=> Boolean
1043
+ # resp.index_fields[0].options.double_options.sort_enabled #=> Boolean
1044
+ # resp.index_fields[0].options.literal_options.default_value #=> String
1045
+ # resp.index_fields[0].options.literal_options.source_field #=> String
1046
+ # resp.index_fields[0].options.literal_options.facet_enabled #=> Boolean
1047
+ # resp.index_fields[0].options.literal_options.search_enabled #=> Boolean
1048
+ # resp.index_fields[0].options.literal_options.return_enabled #=> Boolean
1049
+ # resp.index_fields[0].options.literal_options.sort_enabled #=> Boolean
1050
+ # resp.index_fields[0].options.text_options.default_value #=> String
1051
+ # resp.index_fields[0].options.text_options.source_field #=> String
1052
+ # resp.index_fields[0].options.text_options.return_enabled #=> Boolean
1053
+ # resp.index_fields[0].options.text_options.sort_enabled #=> Boolean
1054
+ # resp.index_fields[0].options.text_options.highlight_enabled #=> Boolean
1055
+ # resp.index_fields[0].options.text_options.analysis_scheme #=> String
1056
+ # resp.index_fields[0].options.date_options.default_value #=> String
1057
+ # resp.index_fields[0].options.date_options.source_field #=> String
1058
+ # resp.index_fields[0].options.date_options.facet_enabled #=> Boolean
1059
+ # resp.index_fields[0].options.date_options.search_enabled #=> Boolean
1060
+ # resp.index_fields[0].options.date_options.return_enabled #=> Boolean
1061
+ # resp.index_fields[0].options.date_options.sort_enabled #=> Boolean
1062
+ # resp.index_fields[0].options.lat_lon_options.default_value #=> String
1063
+ # resp.index_fields[0].options.lat_lon_options.source_field #=> String
1064
+ # resp.index_fields[0].options.lat_lon_options.facet_enabled #=> Boolean
1065
+ # resp.index_fields[0].options.lat_lon_options.search_enabled #=> Boolean
1066
+ # resp.index_fields[0].options.lat_lon_options.return_enabled #=> Boolean
1067
+ # resp.index_fields[0].options.lat_lon_options.sort_enabled #=> Boolean
1068
+ # resp.index_fields[0].options.int_array_options.default_value #=> Integer
1069
+ # resp.index_fields[0].options.int_array_options.source_fields #=> String
1070
+ # resp.index_fields[0].options.int_array_options.facet_enabled #=> Boolean
1071
+ # resp.index_fields[0].options.int_array_options.search_enabled #=> Boolean
1072
+ # resp.index_fields[0].options.int_array_options.return_enabled #=> Boolean
1073
+ # resp.index_fields[0].options.double_array_options.default_value #=> Float
1074
+ # resp.index_fields[0].options.double_array_options.source_fields #=> String
1075
+ # resp.index_fields[0].options.double_array_options.facet_enabled #=> Boolean
1076
+ # resp.index_fields[0].options.double_array_options.search_enabled #=> Boolean
1077
+ # resp.index_fields[0].options.double_array_options.return_enabled #=> Boolean
1078
+ # resp.index_fields[0].options.literal_array_options.default_value #=> String
1079
+ # resp.index_fields[0].options.literal_array_options.source_fields #=> String
1080
+ # resp.index_fields[0].options.literal_array_options.facet_enabled #=> Boolean
1081
+ # resp.index_fields[0].options.literal_array_options.search_enabled #=> Boolean
1082
+ # resp.index_fields[0].options.literal_array_options.return_enabled #=> Boolean
1083
+ # resp.index_fields[0].options.text_array_options.default_value #=> String
1084
+ # resp.index_fields[0].options.text_array_options.source_fields #=> String
1085
+ # resp.index_fields[0].options.text_array_options.return_enabled #=> Boolean
1086
+ # resp.index_fields[0].options.text_array_options.highlight_enabled #=> Boolean
1087
+ # resp.index_fields[0].options.text_array_options.analysis_scheme #=> String
1088
+ # resp.index_fields[0].options.date_array_options.default_value #=> String
1089
+ # resp.index_fields[0].options.date_array_options.source_fields #=> String
1090
+ # resp.index_fields[0].options.date_array_options.facet_enabled #=> Boolean
1091
+ # resp.index_fields[0].options.date_array_options.search_enabled #=> Boolean
1092
+ # resp.index_fields[0].options.date_array_options.return_enabled #=> Boolean
1093
+ # resp.index_fields[0].status.creation_date #=> Time
1094
+ # resp.index_fields[0].status.update_date #=> Time
1095
+ # resp.index_fields[0].status.update_version #=> Integer
1096
+ # resp.index_fields[0].status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
1097
+ # resp.index_fields[0].status.pending_deletion #=> Boolean
1098
+ # @overload describe_index_fields(params = {})
1099
+ # @param [Hash] params ({})
1100
+ def describe_index_fields(params = {}, options = {})
1101
+ req = build_request(:describe_index_fields, params)
1102
+ req.send_request(options)
1103
+ end
1104
+
1105
+ # Gets the scaling parameters configured for a domain. A domain's
1106
+ # scaling parameters specify the desired search instance type and
1107
+ # replication count. For more information, see [Configuring Scaling
1108
+ # Options][1] in the *Amazon CloudSearch Developer Guide*.
1109
+ #
1110
+ #
1111
+ #
1112
+ # [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html
1113
+ # @option params [required, String] :domain_name
1114
+ # A string that represents the name of a domain. Domain names are unique
1115
+ # across the domains owned by an account within an AWS region. Domain
1116
+ # names start with a letter or number and can contain the following
1117
+ # characters: a-z (lowercase), 0-9, and - (hyphen).
1118
+ # @return [Types::DescribeScalingParametersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1119
+ #
1120
+ # * {Types::DescribeScalingParametersResponse#scaling_parameters #ScalingParameters} => Types::ScalingParametersStatus
1121
+ #
1122
+ # @example Request syntax with placeholder values
1123
+ # resp = client.describe_scaling_parameters({
1124
+ # domain_name: "DomainName", # required
1125
+ # })
1126
+ #
1127
+ # @example Response structure
1128
+ # 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"
1129
+ # resp.scaling_parameters.options.desired_replication_count #=> Integer
1130
+ # resp.scaling_parameters.options.desired_partition_count #=> Integer
1131
+ # resp.scaling_parameters.status.creation_date #=> Time
1132
+ # resp.scaling_parameters.status.update_date #=> Time
1133
+ # resp.scaling_parameters.status.update_version #=> Integer
1134
+ # resp.scaling_parameters.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
1135
+ # resp.scaling_parameters.status.pending_deletion #=> Boolean
1136
+ # @overload describe_scaling_parameters(params = {})
1137
+ # @param [Hash] params ({})
1138
+ def describe_scaling_parameters(params = {}, options = {})
1139
+ req = build_request(:describe_scaling_parameters, params)
1140
+ req.send_request(options)
1141
+ end
1142
+
1143
+ # Gets information about the access policies that control access to the
1144
+ # domain's document and search endpoints. By default, shows the
1145
+ # configuration with any pending changes. Set the `Deployed` option to
1146
+ # `true` to show the active configuration and exclude pending changes.
1147
+ # For more information, see [Configuring Access for a Search Domain][1]
1148
+ # in the *Amazon CloudSearch Developer Guide*.
1149
+ #
1150
+ #
1151
+ #
1152
+ # [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html
1153
+ # @option params [required, String] :domain_name
1154
+ # The name of the domain you want to describe.
1155
+ # @option params [Boolean] :deployed
1156
+ # Whether to display the deployed configuration (`true`) or include any
1157
+ # pending changes (`false`). Defaults to `false`.
1158
+ # @return [Types::DescribeServiceAccessPoliciesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1159
+ #
1160
+ # * {Types::DescribeServiceAccessPoliciesResponse#access_policies #AccessPolicies} => Types::AccessPoliciesStatus
1161
+ #
1162
+ # @example Request syntax with placeholder values
1163
+ # resp = client.describe_service_access_policies({
1164
+ # domain_name: "DomainName", # required
1165
+ # deployed: false,
1166
+ # })
1167
+ #
1168
+ # @example Response structure
1169
+ # resp.access_policies.options #=> String
1170
+ # resp.access_policies.status.creation_date #=> Time
1171
+ # resp.access_policies.status.update_date #=> Time
1172
+ # resp.access_policies.status.update_version #=> Integer
1173
+ # resp.access_policies.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
1174
+ # resp.access_policies.status.pending_deletion #=> Boolean
1175
+ # @overload describe_service_access_policies(params = {})
1176
+ # @param [Hash] params ({})
1177
+ def describe_service_access_policies(params = {}, options = {})
1178
+ req = build_request(:describe_service_access_policies, params)
1179
+ req.send_request(options)
1180
+ end
1181
+
1182
+ # Gets the suggesters configured for a domain. A suggester enables you
1183
+ # to display possible matches before users finish typing their queries.
1184
+ # Can be limited to specific suggesters by name. By default, shows all
1185
+ # suggesters and includes any pending changes to the configuration. Set
1186
+ # the `Deployed` option to `true` to show the active configuration and
1187
+ # exclude pending changes. For more information, see [Getting Search
1188
+ # Suggestions][1] in the *Amazon CloudSearch Developer Guide*.
1189
+ #
1190
+ #
1191
+ #
1192
+ # [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html
1193
+ # @option params [required, String] :domain_name
1194
+ # The name of the domain you want to describe.
1195
+ # @option params [Array<String>] :suggester_names
1196
+ # The suggesters you want to describe.
1197
+ # @option params [Boolean] :deployed
1198
+ # Whether to display the deployed configuration (`true`) or include any
1199
+ # pending changes (`false`). Defaults to `false`.
1200
+ # @return [Types::DescribeSuggestersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1201
+ #
1202
+ # * {Types::DescribeSuggestersResponse#suggesters #Suggesters} => Array&lt;Types::SuggesterStatus&gt;
1203
+ #
1204
+ # @example Request syntax with placeholder values
1205
+ # resp = client.describe_suggesters({
1206
+ # domain_name: "DomainName", # required
1207
+ # suggester_names: ["StandardName"],
1208
+ # deployed: false,
1209
+ # })
1210
+ #
1211
+ # @example Response structure
1212
+ # resp.suggesters #=> Array
1213
+ # resp.suggesters[0].options.suggester_name #=> String
1214
+ # resp.suggesters[0].options.document_suggester_options.source_field #=> String
1215
+ # resp.suggesters[0].options.document_suggester_options.fuzzy_matching #=> String, one of "none", "low", "high"
1216
+ # resp.suggesters[0].options.document_suggester_options.sort_expression #=> String
1217
+ # resp.suggesters[0].status.creation_date #=> Time
1218
+ # resp.suggesters[0].status.update_date #=> Time
1219
+ # resp.suggesters[0].status.update_version #=> Integer
1220
+ # resp.suggesters[0].status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
1221
+ # resp.suggesters[0].status.pending_deletion #=> Boolean
1222
+ # @overload describe_suggesters(params = {})
1223
+ # @param [Hash] params ({})
1224
+ def describe_suggesters(params = {}, options = {})
1225
+ req = build_request(:describe_suggesters, params)
1226
+ req.send_request(options)
1227
+ end
1228
+
1229
+ # Tells the search domain to start indexing its documents using the
1230
+ # latest indexing options. This operation must be invoked to activate
1231
+ # options whose OptionStatus is `RequiresIndexDocuments`.
1232
+ # @option params [required, String] :domain_name
1233
+ # A string that represents the name of a domain. Domain names are unique
1234
+ # across the domains owned by an account within an AWS region. Domain
1235
+ # names start with a letter or number and can contain the following
1236
+ # characters: a-z (lowercase), 0-9, and - (hyphen).
1237
+ # @return [Types::IndexDocumentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1238
+ #
1239
+ # * {Types::IndexDocumentsResponse#field_names #FieldNames} => Array&lt;String&gt;
1240
+ #
1241
+ # @example Request syntax with placeholder values
1242
+ # resp = client.index_documents({
1243
+ # domain_name: "DomainName", # required
1244
+ # })
1245
+ #
1246
+ # @example Response structure
1247
+ # resp.field_names #=> Array
1248
+ # resp.field_names[0] #=> String
1249
+ # @overload index_documents(params = {})
1250
+ # @param [Hash] params ({})
1251
+ def index_documents(params = {}, options = {})
1252
+ req = build_request(:index_documents, params)
1253
+ req.send_request(options)
1254
+ end
1255
+
1256
+ # Lists all search domains owned by an account.
1257
+ # @return [Types::ListDomainNamesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1258
+ #
1259
+ # * {Types::ListDomainNamesResponse#domain_names #DomainNames} => Hash&lt;String,String&gt;
1260
+ #
1261
+ # @example Response structure
1262
+ # resp.domain_names #=> Hash
1263
+ # resp.domain_names["DomainName"] #=> String
1264
+ # @overload list_domain_names(params = {})
1265
+ # @param [Hash] params ({})
1266
+ def list_domain_names(params = {}, options = {})
1267
+ req = build_request(:list_domain_names, params)
1268
+ req.send_request(options)
1269
+ end
1270
+
1271
+ # Configures the availability options for a domain. Enabling the
1272
+ # Multi-AZ option expands an Amazon CloudSearch domain to an additional
1273
+ # Availability Zone in the same Region to increase fault tolerance in
1274
+ # the event of a service disruption. Changes to the Multi-AZ option can
1275
+ # take about half an hour to become active. For more information, see
1276
+ # [Configuring Availability Options][1] in the *Amazon CloudSearch
1277
+ # Developer Guide*.
1278
+ #
1279
+ #
1280
+ #
1281
+ # [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html
1282
+ # @option params [required, String] :domain_name
1283
+ # A string that represents the name of a domain. Domain names are unique
1284
+ # across the domains owned by an account within an AWS region. Domain
1285
+ # names start with a letter or number and can contain the following
1286
+ # characters: a-z (lowercase), 0-9, and - (hyphen).
1287
+ # @option params [required, Boolean] :multi_az
1288
+ # You expand an existing search domain to a second Availability Zone by
1289
+ # setting the Multi-AZ option to true. Similarly, you can turn off the
1290
+ # Multi-AZ option to downgrade the domain to a single Availability Zone
1291
+ # by setting the Multi-AZ option to `false`.
1292
+ # @return [Types::UpdateAvailabilityOptionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1293
+ #
1294
+ # * {Types::UpdateAvailabilityOptionsResponse#availability_options #AvailabilityOptions} => Types::AvailabilityOptionsStatus
1295
+ #
1296
+ # @example Request syntax with placeholder values
1297
+ # resp = client.update_availability_options({
1298
+ # domain_name: "DomainName", # required
1299
+ # multi_az: false, # required
1300
+ # })
1301
+ #
1302
+ # @example Response structure
1303
+ # resp.availability_options.options #=> Boolean
1304
+ # resp.availability_options.status.creation_date #=> Time
1305
+ # resp.availability_options.status.update_date #=> Time
1306
+ # resp.availability_options.status.update_version #=> Integer
1307
+ # resp.availability_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
1308
+ # resp.availability_options.status.pending_deletion #=> Boolean
1309
+ # @overload update_availability_options(params = {})
1310
+ # @param [Hash] params ({})
1311
+ def update_availability_options(params = {}, options = {})
1312
+ req = build_request(:update_availability_options, params)
1313
+ req.send_request(options)
1314
+ end
1315
+
1316
+ # Configures scaling parameters for a domain. A domain's scaling
1317
+ # parameters specify the desired search instance type and replication
1318
+ # count. Amazon CloudSearch will still automatically scale your domain
1319
+ # based on the volume of data and traffic, but not below the desired
1320
+ # instance type and replication count. If the Multi-AZ option is
1321
+ # enabled, these values control the resources used per Availability
1322
+ # Zone. For more information, see [Configuring Scaling Options][1] in
1323
+ # the *Amazon CloudSearch Developer Guide*.
1324
+ #
1325
+ #
1326
+ #
1327
+ # [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html
1328
+ # @option params [required, String] :domain_name
1329
+ # A string that represents the name of a domain. Domain names are unique
1330
+ # across the domains owned by an account within an AWS region. Domain
1331
+ # names start with a letter or number and can contain the following
1332
+ # characters: a-z (lowercase), 0-9, and - (hyphen).
1333
+ # @option params [required, Types::ScalingParameters] :scaling_parameters
1334
+ # The desired instance type and desired number of replicas of each index
1335
+ # partition.
1336
+ # @return [Types::UpdateScalingParametersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1337
+ #
1338
+ # * {Types::UpdateScalingParametersResponse#scaling_parameters #ScalingParameters} => Types::ScalingParametersStatus
1339
+ #
1340
+ # @example Request syntax with placeholder values
1341
+ # resp = client.update_scaling_parameters({
1342
+ # domain_name: "DomainName", # required
1343
+ # scaling_parameters: { # required
1344
+ # 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
1345
+ # desired_replication_count: 1,
1346
+ # desired_partition_count: 1,
1347
+ # },
1348
+ # })
1349
+ #
1350
+ # @example Response structure
1351
+ # 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"
1352
+ # resp.scaling_parameters.options.desired_replication_count #=> Integer
1353
+ # resp.scaling_parameters.options.desired_partition_count #=> Integer
1354
+ # resp.scaling_parameters.status.creation_date #=> Time
1355
+ # resp.scaling_parameters.status.update_date #=> Time
1356
+ # resp.scaling_parameters.status.update_version #=> Integer
1357
+ # resp.scaling_parameters.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
1358
+ # resp.scaling_parameters.status.pending_deletion #=> Boolean
1359
+ # @overload update_scaling_parameters(params = {})
1360
+ # @param [Hash] params ({})
1361
+ def update_scaling_parameters(params = {}, options = {})
1362
+ req = build_request(:update_scaling_parameters, params)
1363
+ req.send_request(options)
1364
+ end
1365
+
1366
+ # Configures the access rules that control access to the domain's
1367
+ # document and search endpoints. For more information, see [ Configuring
1368
+ # Access for an Amazon CloudSearch Domain][1].
1369
+ #
1370
+ #
1371
+ #
1372
+ # [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html
1373
+ # @option params [required, String] :domain_name
1374
+ # A string that represents the name of a domain. Domain names are unique
1375
+ # across the domains owned by an account within an AWS region. Domain
1376
+ # names start with a letter or number and can contain the following
1377
+ # characters: a-z (lowercase), 0-9, and - (hyphen).
1378
+ # @option params [required, String] :access_policies
1379
+ # The access rules you want to configure. These rules replace any
1380
+ # existing rules.
1381
+ # @return [Types::UpdateServiceAccessPoliciesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1382
+ #
1383
+ # * {Types::UpdateServiceAccessPoliciesResponse#access_policies #AccessPolicies} => Types::AccessPoliciesStatus
1384
+ #
1385
+ # @example Request syntax with placeholder values
1386
+ # resp = client.update_service_access_policies({
1387
+ # domain_name: "DomainName", # required
1388
+ # access_policies: "PolicyDocument", # required
1389
+ # })
1390
+ #
1391
+ # @example Response structure
1392
+ # resp.access_policies.options #=> String
1393
+ # resp.access_policies.status.creation_date #=> Time
1394
+ # resp.access_policies.status.update_date #=> Time
1395
+ # resp.access_policies.status.update_version #=> Integer
1396
+ # resp.access_policies.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate"
1397
+ # resp.access_policies.status.pending_deletion #=> Boolean
1398
+ # @overload update_service_access_policies(params = {})
1399
+ # @param [Hash] params ({})
1400
+ def update_service_access_policies(params = {}, options = {})
1401
+ req = build_request(:update_service_access_policies, params)
1402
+ req.send_request(options)
1403
+ end
1404
+
1405
+ # @!endgroup
1406
+
1407
+ # @param params ({})
1408
+ # @api private
1409
+ def build_request(operation_name, params = {})
1410
+ handlers = @handlers.for(operation_name)
1411
+ context = Seahorse::Client::RequestContext.new(
1412
+ operation_name: operation_name,
1413
+ operation: config.api.operation(operation_name),
1414
+ client: self,
1415
+ params: params,
1416
+ config: config)
1417
+ context[:gem_name] = 'aws-sdk-cloudsearch'
1418
+ context[:gem_version] = '1.0.0.rc1'
1419
+ Seahorse::Client::Request.new(handlers, context)
1420
+ end
1421
+
1422
+ # @api private
1423
+ # @deprecated
1424
+ def waiter_names
1425
+ []
1426
+ end
1427
+
1428
+ class << self
1429
+
1430
+ # @api private
1431
+ attr_reader :identifier
1432
+
1433
+ # @api private
1434
+ def errors_module
1435
+ Errors
1436
+ end
1437
+
1438
+ end
1439
+ end
1440
+ end
1441
+ end