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
+ # 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
+
@@ -0,0 +1,23 @@
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
+ module Aws
9
+ module CloudSearch
10
+ module Errors
11
+
12
+ extend Aws::Errors::DynamicErrors
13
+
14
+ # Raised when calling #load or #data on a resource class that can not be
15
+ # loaded. This can happen when:
16
+ #
17
+ # * A resource class has identifiers, but no data attributes.
18
+ # * Resource data is only available when making an API call that
19
+ # enumerates all resources of that type.
20
+ class ResourceNotLoadable < RuntimeError; end
21
+ end
22
+ end
23
+ end
@@ -0,0 +1,25 @@
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
+ module Aws
9
+ module CloudSearch
10
+ class Resource
11
+
12
+ # @param options ({})
13
+ # @option options [Client] :client
14
+ def initialize(options = {})
15
+ @client = options[:client] || Client.new(options)
16
+ end
17
+
18
+ # @return [Client]
19
+ def client
20
+ @client
21
+ end
22
+
23
+ end
24
+ end
25
+ end
@@ -0,0 +1,2256 @@
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
+ module Aws
9
+ module CloudSearch
10
+ module Types
11
+
12
+ # The configured access rules for the domain's document and search
13
+ # endpoints, and the current status of those rules.
14
+ # @!attribute [rw] options
15
+ # Access rules for a domain's document or search service endpoints.
16
+ # For more information, see [Configuring Access for a Search
17
+ # Domain][1] in the *Amazon CloudSearch Developer Guide*. The maximum
18
+ # size of a policy document is 100 KB.
19
+ #
20
+ #
21
+ #
22
+ # [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html
23
+ # @return [String]
24
+ #
25
+ # @!attribute [rw] status
26
+ # The status of domain configuration option.
27
+ # @return [Types::OptionStatus]
28
+ class AccessPoliciesStatus < Struct.new(
29
+ :options,
30
+ :status)
31
+ include Aws::Structure
32
+ end
33
+
34
+ # Synonyms, stopwords, and stemming options for an analysis scheme.
35
+ # Includes tokenization dictionary for Japanese.
36
+ # @note When making an API call, pass AnalysisOptions
37
+ # data as a hash:
38
+ #
39
+ # {
40
+ # synonyms: "String",
41
+ # stopwords: "String",
42
+ # stemming_dictionary: "String",
43
+ # japanese_tokenization_dictionary: "String",
44
+ # algorithmic_stemming: "none", # accepts none, minimal, light, full
45
+ # }
46
+ # @!attribute [rw] synonyms
47
+ # A JSON object that defines synonym groups and aliases. A synonym
48
+ # group is an array of arrays, where each sub-array is a group of
49
+ # terms where each term in the group is considered a synonym of every
50
+ # other term in the group. The aliases value is an object that
51
+ # contains a collection of string:value pairs where the string
52
+ # specifies a term and the array of values specifies each of the
53
+ # aliases for that term. An alias is considered a synonym of the
54
+ # specified term, but the term is not considered a synonym of the
55
+ # alias. For more information about specifying synonyms, see
56
+ # [Synonyms][1] in the *Amazon CloudSearch Developer Guide*.
57
+ #
58
+ #
59
+ #
60
+ # [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html#synonyms
61
+ # @return [String]
62
+ #
63
+ # @!attribute [rw] stopwords
64
+ # A JSON array of terms to ignore during indexing and searching. For
65
+ # example, `["a", "an", "the", "of"]`. The stopwords dictionary must
66
+ # explicitly list each word you want to ignore. Wildcards and regular
67
+ # expressions are not supported.
68
+ # @return [String]
69
+ #
70
+ # @!attribute [rw] stemming_dictionary
71
+ # A JSON object that contains a collection of string:value pairs that
72
+ # each map a term to its stem. For example, `\{"term1": "stem1",
73
+ # "term2": "stem2", "term3": "stem3"\}`. The stemming dictionary is
74
+ # applied in addition to any algorithmic stemming. This enables you to
75
+ # override the results of the algorithmic stemming to correct specific
76
+ # cases of overstemming or understemming. The maximum size of a
77
+ # stemming dictionary is 500 KB.
78
+ # @return [String]
79
+ #
80
+ # @!attribute [rw] japanese_tokenization_dictionary
81
+ # A JSON array that contains a collection of terms, tokens, readings
82
+ # and part of speech for Japanese Tokenizaiton. The Japanese
83
+ # tokenization dictionary enables you to override the default
84
+ # tokenization for selected terms. This is only valid for Japanese
85
+ # language fields.
86
+ # @return [String]
87
+ #
88
+ # @!attribute [rw] algorithmic_stemming
89
+ # The level of algorithmic stemming to perform: `none`, `minimal`,
90
+ # `light`, or `full`. The available levels vary depending on the
91
+ # language. For more information, see [Language Specific Text
92
+ # Processing Settings][1] in the *Amazon CloudSearch Developer Guide*
93
+ #
94
+ #
95
+ #
96
+ # [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/text-processing.html#text-processing-settings
97
+ # @return [String]
98
+ class AnalysisOptions < Struct.new(
99
+ :synonyms,
100
+ :stopwords,
101
+ :stemming_dictionary,
102
+ :japanese_tokenization_dictionary,
103
+ :algorithmic_stemming)
104
+ include Aws::Structure
105
+ end
106
+
107
+ # Configuration information for an analysis scheme. Each analysis scheme
108
+ # has a unique name and specifies the language of the text to be
109
+ # processed. The following options can be configured for an analysis
110
+ # scheme: `Synonyms`, `Stopwords`, `StemmingDictionary`,
111
+ # `JapaneseTokenizationDictionary` and `AlgorithmicStemming`.
112
+ # @note When making an API call, pass AnalysisScheme
113
+ # data as a hash:
114
+ #
115
+ # {
116
+ # analysis_scheme_name: "StandardName", # required
117
+ # 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
118
+ # analysis_options: {
119
+ # synonyms: "String",
120
+ # stopwords: "String",
121
+ # stemming_dictionary: "String",
122
+ # japanese_tokenization_dictionary: "String",
123
+ # algorithmic_stemming: "none", # accepts none, minimal, light, full
124
+ # },
125
+ # }
126
+ # @!attribute [rw] analysis_scheme_name
127
+ # Names must begin with a letter and can contain the following
128
+ # characters: a-z (lowercase), 0-9, and \_ (underscore).
129
+ # @return [String]
130
+ #
131
+ # @!attribute [rw] analysis_scheme_language
132
+ # An [IETF RFC 4646][1] language code or `mul` for multiple languages.
133
+ #
134
+ #
135
+ #
136
+ # [1]: http://tools.ietf.org/html/rfc4646
137
+ # @return [String]
138
+ #
139
+ # @!attribute [rw] analysis_options
140
+ # Synonyms, stopwords, and stemming options for an analysis scheme.
141
+ # Includes tokenization dictionary for Japanese.
142
+ # @return [Types::AnalysisOptions]
143
+ class AnalysisScheme < Struct.new(
144
+ :analysis_scheme_name,
145
+ :analysis_scheme_language,
146
+ :analysis_options)
147
+ include Aws::Structure
148
+ end
149
+
150
+ # The status and configuration of an `AnalysisScheme`.
151
+ # @!attribute [rw] options
152
+ # Configuration information for an analysis scheme. Each analysis
153
+ # scheme has a unique name and specifies the language of the text to
154
+ # be processed. The following options can be configured for an
155
+ # analysis scheme: `Synonyms`, `Stopwords`, `StemmingDictionary`,
156
+ # `JapaneseTokenizationDictionary` and `AlgorithmicStemming`.
157
+ # @return [Types::AnalysisScheme]
158
+ #
159
+ # @!attribute [rw] status
160
+ # The status of domain configuration option.
161
+ # @return [Types::OptionStatus]
162
+ class AnalysisSchemeStatus < Struct.new(
163
+ :options,
164
+ :status)
165
+ include Aws::Structure
166
+ end
167
+
168
+ # The status and configuration of the domain's availability options.
169
+ # @!attribute [rw] options
170
+ # The availability options configured for the domain.
171
+ # @return [Boolean]
172
+ #
173
+ # @!attribute [rw] status
174
+ # The status of domain configuration option.
175
+ # @return [Types::OptionStatus]
176
+ class AvailabilityOptionsStatus < Struct.new(
177
+ :options,
178
+ :status)
179
+ include Aws::Structure
180
+ end
181
+
182
+ # Container for the parameters to the `BuildSuggester` operation.
183
+ # Specifies the name of the domain you want to update.
184
+ # @note When making an API call, pass BuildSuggestersRequest
185
+ # data as a hash:
186
+ #
187
+ # {
188
+ # domain_name: "DomainName", # required
189
+ # }
190
+ # @!attribute [rw] domain_name
191
+ # A string that represents the name of a domain. Domain names are
192
+ # unique across the domains owned by an account within an AWS region.
193
+ # Domain names start with a letter or number and can contain the
194
+ # following characters: a-z (lowercase), 0-9, and - (hyphen).
195
+ # @return [String]
196
+ class BuildSuggestersRequest < Struct.new(
197
+ :domain_name)
198
+ include Aws::Structure
199
+ end
200
+
201
+ # The result of a `BuildSuggester` request. Contains a list of the
202
+ # fields used for suggestions.
203
+ # @!attribute [rw] field_names
204
+ # A list of field names.
205
+ # @return [Array<String>]
206
+ class BuildSuggestersResponse < Struct.new(
207
+ :field_names)
208
+ include Aws::Structure
209
+ end
210
+
211
+ # Container for the parameters to the `CreateDomain` operation.
212
+ # Specifies a name for the new search domain.
213
+ # @note When making an API call, pass CreateDomainRequest
214
+ # data as a hash:
215
+ #
216
+ # {
217
+ # domain_name: "DomainName", # required
218
+ # }
219
+ # @!attribute [rw] domain_name
220
+ # A name for the domain you are creating. Allowed characters are a-z
221
+ # (lower-case letters), 0-9, and hyphen (-). Domain names must start
222
+ # with a letter or number and be at least 3 and no more than 28
223
+ # characters long.
224
+ # @return [String]
225
+ class CreateDomainRequest < Struct.new(
226
+ :domain_name)
227
+ include Aws::Structure
228
+ end
229
+
230
+ # The result of a `CreateDomainRequest`. Contains the status of a newly
231
+ # created domain.
232
+ # @!attribute [rw] domain_status
233
+ # The current status of the search domain.
234
+ # @return [Types::DomainStatus]
235
+ class CreateDomainResponse < Struct.new(
236
+ :domain_status)
237
+ include Aws::Structure
238
+ end
239
+
240
+ # Options for a field that contains an array of dates. Present if
241
+ # `IndexFieldType` specifies the field is of type `date-array`. All
242
+ # options are enabled by default.
243
+ # @note When making an API call, pass DateArrayOptions
244
+ # data as a hash:
245
+ #
246
+ # {
247
+ # default_value: "FieldValue",
248
+ # source_fields: "FieldNameCommaList",
249
+ # facet_enabled: false,
250
+ # search_enabled: false,
251
+ # return_enabled: false,
252
+ # }
253
+ # @!attribute [rw] default_value
254
+ # A value to use for the field if the field isn't specified for a
255
+ # document.
256
+ # @return [String]
257
+ #
258
+ # @!attribute [rw] source_fields
259
+ # A list of source fields to map to the field.
260
+ # @return [String]
261
+ #
262
+ # @!attribute [rw] facet_enabled
263
+ # Whether facet information can be returned for the field.
264
+ # @return [Boolean]
265
+ #
266
+ # @!attribute [rw] search_enabled
267
+ # Whether the contents of the field are searchable.
268
+ # @return [Boolean]
269
+ #
270
+ # @!attribute [rw] return_enabled
271
+ # Whether the contents of the field can be returned in the search
272
+ # results.
273
+ # @return [Boolean]
274
+ class DateArrayOptions < Struct.new(
275
+ :default_value,
276
+ :source_fields,
277
+ :facet_enabled,
278
+ :search_enabled,
279
+ :return_enabled)
280
+ include Aws::Structure
281
+ end
282
+
283
+ # Options for a date field. Dates and times are specified in UTC
284
+ # (Coordinated Universal Time) according to IETF RFC3339:
285
+ # yyyy-mm-ddT00:00:00Z. Present if `IndexFieldType` specifies the field
286
+ # is of type `date`. All options are enabled by default.
287
+ # @note When making an API call, pass DateOptions
288
+ # data as a hash:
289
+ #
290
+ # {
291
+ # default_value: "FieldValue",
292
+ # source_field: "FieldName",
293
+ # facet_enabled: false,
294
+ # search_enabled: false,
295
+ # return_enabled: false,
296
+ # sort_enabled: false,
297
+ # }
298
+ # @!attribute [rw] default_value
299
+ # A value to use for the field if the field isn't specified for a
300
+ # document.
301
+ # @return [String]
302
+ #
303
+ # @!attribute [rw] source_field
304
+ # A string that represents the name of an index field. CloudSearch
305
+ # supports regular index fields as well as dynamic fields. A dynamic
306
+ # field's name defines a pattern that begins or ends with a wildcard.
307
+ # Any document fields that don't map to a regular index field but do
308
+ # match a dynamic field's pattern are configured with the dynamic
309
+ # field's indexing options.
310
+ #
311
+ # Regular field names begin with a letter and can contain the
312
+ # following characters: a-z (lowercase), 0-9, and \_ (underscore).
313
+ # Dynamic field names must begin or end with a wildcard (*). The
314
+ # wildcard can also be the only character in a dynamic field name.
315
+ # Multiple wildcards, and wildcards embedded within a string are not
316
+ # supported.
317
+ #
318
+ # The name `score` is reserved and cannot be used as a field name. To
319
+ # reference a document's ID, you can use the name `_id`.
320
+ # @return [String]
321
+ #
322
+ # @!attribute [rw] facet_enabled
323
+ # Whether facet information can be returned for the field.
324
+ # @return [Boolean]
325
+ #
326
+ # @!attribute [rw] search_enabled
327
+ # Whether the contents of the field are searchable.
328
+ # @return [Boolean]
329
+ #
330
+ # @!attribute [rw] return_enabled
331
+ # Whether the contents of the field can be returned in the search
332
+ # results.
333
+ # @return [Boolean]
334
+ #
335
+ # @!attribute [rw] sort_enabled
336
+ # Whether the field can be used to sort the search results.
337
+ # @return [Boolean]
338
+ class DateOptions < Struct.new(
339
+ :default_value,
340
+ :source_field,
341
+ :facet_enabled,
342
+ :search_enabled,
343
+ :return_enabled,
344
+ :sort_enabled)
345
+ include Aws::Structure
346
+ end
347
+
348
+ # Container for the parameters to the `DefineAnalysisScheme` operation.
349
+ # Specifies the name of the domain you want to update and the analysis
350
+ # scheme configuration.
351
+ # @note When making an API call, pass DefineAnalysisSchemeRequest
352
+ # data as a hash:
353
+ #
354
+ # {
355
+ # domain_name: "DomainName", # required
356
+ # analysis_scheme: { # required
357
+ # analysis_scheme_name: "StandardName", # required
358
+ # 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
359
+ # analysis_options: {
360
+ # synonyms: "String",
361
+ # stopwords: "String",
362
+ # stemming_dictionary: "String",
363
+ # japanese_tokenization_dictionary: "String",
364
+ # algorithmic_stemming: "none", # accepts none, minimal, light, full
365
+ # },
366
+ # },
367
+ # }
368
+ # @!attribute [rw] domain_name
369
+ # A string that represents the name of a domain. Domain names are
370
+ # unique across the domains owned by an account within an AWS region.
371
+ # Domain names start with a letter or number and can contain the
372
+ # following characters: a-z (lowercase), 0-9, and - (hyphen).
373
+ # @return [String]
374
+ #
375
+ # @!attribute [rw] analysis_scheme
376
+ # Configuration information for an analysis scheme. Each analysis
377
+ # scheme has a unique name and specifies the language of the text to
378
+ # be processed. The following options can be configured for an
379
+ # analysis scheme: `Synonyms`, `Stopwords`, `StemmingDictionary`,
380
+ # `JapaneseTokenizationDictionary` and `AlgorithmicStemming`.
381
+ # @return [Types::AnalysisScheme]
382
+ class DefineAnalysisSchemeRequest < Struct.new(
383
+ :domain_name,
384
+ :analysis_scheme)
385
+ include Aws::Structure
386
+ end
387
+
388
+ # The result of a `DefineAnalysisScheme` request. Contains the status of
389
+ # the newly-configured analysis scheme.
390
+ # @!attribute [rw] analysis_scheme
391
+ # The status and configuration of an `AnalysisScheme`.
392
+ # @return [Types::AnalysisSchemeStatus]
393
+ class DefineAnalysisSchemeResponse < Struct.new(
394
+ :analysis_scheme)
395
+ include Aws::Structure
396
+ end
397
+
398
+ # Container for the parameters to the `DefineExpression` operation.
399
+ # Specifies the name of the domain you want to update and the expression
400
+ # you want to configure.
401
+ # @note When making an API call, pass DefineExpressionRequest
402
+ # data as a hash:
403
+ #
404
+ # {
405
+ # domain_name: "DomainName", # required
406
+ # expression: { # required
407
+ # expression_name: "StandardName", # required
408
+ # expression_value: "ExpressionValue", # required
409
+ # },
410
+ # }
411
+ # @!attribute [rw] domain_name
412
+ # A string that represents the name of a domain. Domain names are
413
+ # unique across the domains owned by an account within an AWS region.
414
+ # Domain names start with a letter or number and can contain the
415
+ # following characters: a-z (lowercase), 0-9, and - (hyphen).
416
+ # @return [String]
417
+ #
418
+ # @!attribute [rw] expression
419
+ # A named expression that can be evaluated at search time. Can be used
420
+ # to sort the search results, define other expressions, or return
421
+ # computed information in the search results.
422
+ # @return [Types::Expression]
423
+ class DefineExpressionRequest < Struct.new(
424
+ :domain_name,
425
+ :expression)
426
+ include Aws::Structure
427
+ end
428
+
429
+ # The result of a `DefineExpression` request. Contains the status of the
430
+ # newly-configured expression.
431
+ # @!attribute [rw] expression
432
+ # The value of an `Expression` and its current status.
433
+ # @return [Types::ExpressionStatus]
434
+ class DefineExpressionResponse < Struct.new(
435
+ :expression)
436
+ include Aws::Structure
437
+ end
438
+
439
+ # Container for the parameters to the `DefineIndexField` operation.
440
+ # Specifies the name of the domain you want to update and the index
441
+ # field configuration.
442
+ # @note When making an API call, pass DefineIndexFieldRequest
443
+ # data as a hash:
444
+ #
445
+ # {
446
+ # domain_name: "DomainName", # required
447
+ # index_field: { # required
448
+ # index_field_name: "DynamicFieldName", # required
449
+ # index_field_type: "int", # required, accepts int, double, literal, text, date, latlon, int-array, double-array, literal-array, text-array, date-array
450
+ # int_options: {
451
+ # default_value: 1,
452
+ # source_field: "FieldName",
453
+ # facet_enabled: false,
454
+ # search_enabled: false,
455
+ # return_enabled: false,
456
+ # sort_enabled: false,
457
+ # },
458
+ # double_options: {
459
+ # default_value: 1.0,
460
+ # source_field: "FieldName",
461
+ # facet_enabled: false,
462
+ # search_enabled: false,
463
+ # return_enabled: false,
464
+ # sort_enabled: false,
465
+ # },
466
+ # literal_options: {
467
+ # default_value: "FieldValue",
468
+ # source_field: "FieldName",
469
+ # facet_enabled: false,
470
+ # search_enabled: false,
471
+ # return_enabled: false,
472
+ # sort_enabled: false,
473
+ # },
474
+ # text_options: {
475
+ # default_value: "FieldValue",
476
+ # source_field: "FieldName",
477
+ # return_enabled: false,
478
+ # sort_enabled: false,
479
+ # highlight_enabled: false,
480
+ # analysis_scheme: "Word",
481
+ # },
482
+ # date_options: {
483
+ # default_value: "FieldValue",
484
+ # source_field: "FieldName",
485
+ # facet_enabled: false,
486
+ # search_enabled: false,
487
+ # return_enabled: false,
488
+ # sort_enabled: false,
489
+ # },
490
+ # lat_lon_options: {
491
+ # default_value: "FieldValue",
492
+ # source_field: "FieldName",
493
+ # facet_enabled: false,
494
+ # search_enabled: false,
495
+ # return_enabled: false,
496
+ # sort_enabled: false,
497
+ # },
498
+ # int_array_options: {
499
+ # default_value: 1,
500
+ # source_fields: "FieldNameCommaList",
501
+ # facet_enabled: false,
502
+ # search_enabled: false,
503
+ # return_enabled: false,
504
+ # },
505
+ # double_array_options: {
506
+ # default_value: 1.0,
507
+ # source_fields: "FieldNameCommaList",
508
+ # facet_enabled: false,
509
+ # search_enabled: false,
510
+ # return_enabled: false,
511
+ # },
512
+ # literal_array_options: {
513
+ # default_value: "FieldValue",
514
+ # source_fields: "FieldNameCommaList",
515
+ # facet_enabled: false,
516
+ # search_enabled: false,
517
+ # return_enabled: false,
518
+ # },
519
+ # text_array_options: {
520
+ # default_value: "FieldValue",
521
+ # source_fields: "FieldNameCommaList",
522
+ # return_enabled: false,
523
+ # highlight_enabled: false,
524
+ # analysis_scheme: "Word",
525
+ # },
526
+ # date_array_options: {
527
+ # default_value: "FieldValue",
528
+ # source_fields: "FieldNameCommaList",
529
+ # facet_enabled: false,
530
+ # search_enabled: false,
531
+ # return_enabled: false,
532
+ # },
533
+ # },
534
+ # }
535
+ # @!attribute [rw] domain_name
536
+ # A string that represents the name of a domain. Domain names are
537
+ # unique across the domains owned by an account within an AWS region.
538
+ # Domain names start with a letter or number and can contain the
539
+ # following characters: a-z (lowercase), 0-9, and - (hyphen).
540
+ # @return [String]
541
+ #
542
+ # @!attribute [rw] index_field
543
+ # The index field and field options you want to configure.
544
+ # @return [Types::IndexField]
545
+ class DefineIndexFieldRequest < Struct.new(
546
+ :domain_name,
547
+ :index_field)
548
+ include Aws::Structure
549
+ end
550
+
551
+ # The result of a `DefineIndexField` request. Contains the status of the
552
+ # newly-configured index field.
553
+ # @!attribute [rw] index_field
554
+ # The value of an `IndexField` and its current status.
555
+ # @return [Types::IndexFieldStatus]
556
+ class DefineIndexFieldResponse < Struct.new(
557
+ :index_field)
558
+ include Aws::Structure
559
+ end
560
+
561
+ # Container for the parameters to the `DefineSuggester` operation.
562
+ # Specifies the name of the domain you want to update and the suggester
563
+ # configuration.
564
+ # @note When making an API call, pass DefineSuggesterRequest
565
+ # data as a hash:
566
+ #
567
+ # {
568
+ # domain_name: "DomainName", # required
569
+ # suggester: { # required
570
+ # suggester_name: "StandardName", # required
571
+ # document_suggester_options: { # required
572
+ # source_field: "FieldName", # required
573
+ # fuzzy_matching: "none", # accepts none, low, high
574
+ # sort_expression: "String",
575
+ # },
576
+ # },
577
+ # }
578
+ # @!attribute [rw] domain_name
579
+ # A string that represents the name of a domain. Domain names are
580
+ # unique across the domains owned by an account within an AWS region.
581
+ # Domain names start with a letter or number and can contain the
582
+ # following characters: a-z (lowercase), 0-9, and - (hyphen).
583
+ # @return [String]
584
+ #
585
+ # @!attribute [rw] suggester
586
+ # Configuration information for a search suggester. Each suggester has
587
+ # a unique name and specifies the text field you want to use for
588
+ # suggestions. The following options can be configured for a
589
+ # suggester: `FuzzyMatching`, `SortExpression`.
590
+ # @return [Types::Suggester]
591
+ class DefineSuggesterRequest < Struct.new(
592
+ :domain_name,
593
+ :suggester)
594
+ include Aws::Structure
595
+ end
596
+
597
+ # The result of a `DefineSuggester` request. Contains the status of the
598
+ # newly-configured suggester.
599
+ # @!attribute [rw] suggester
600
+ # The value of a `Suggester` and its current status.
601
+ # @return [Types::SuggesterStatus]
602
+ class DefineSuggesterResponse < Struct.new(
603
+ :suggester)
604
+ include Aws::Structure
605
+ end
606
+
607
+ # Container for the parameters to the `DeleteAnalysisScheme` operation.
608
+ # Specifies the name of the domain you want to update and the analysis
609
+ # scheme you want to delete.
610
+ # @note When making an API call, pass DeleteAnalysisSchemeRequest
611
+ # data as a hash:
612
+ #
613
+ # {
614
+ # domain_name: "DomainName", # required
615
+ # analysis_scheme_name: "StandardName", # required
616
+ # }
617
+ # @!attribute [rw] domain_name
618
+ # A string that represents the name of a domain. Domain names are
619
+ # unique across the domains owned by an account within an AWS region.
620
+ # Domain names start with a letter or number and can contain the
621
+ # following characters: a-z (lowercase), 0-9, and - (hyphen).
622
+ # @return [String]
623
+ #
624
+ # @!attribute [rw] analysis_scheme_name
625
+ # The name of the analysis scheme you want to delete.
626
+ # @return [String]
627
+ class DeleteAnalysisSchemeRequest < Struct.new(
628
+ :domain_name,
629
+ :analysis_scheme_name)
630
+ include Aws::Structure
631
+ end
632
+
633
+ # The result of a `DeleteAnalysisScheme` request. Contains the status of
634
+ # the deleted analysis scheme.
635
+ # @!attribute [rw] analysis_scheme
636
+ # The status of the analysis scheme being deleted.
637
+ # @return [Types::AnalysisSchemeStatus]
638
+ class DeleteAnalysisSchemeResponse < Struct.new(
639
+ :analysis_scheme)
640
+ include Aws::Structure
641
+ end
642
+
643
+ # Container for the parameters to the `DeleteDomain` operation.
644
+ # Specifies the name of the domain you want to delete.
645
+ # @note When making an API call, pass DeleteDomainRequest
646
+ # data as a hash:
647
+ #
648
+ # {
649
+ # domain_name: "DomainName", # required
650
+ # }
651
+ # @!attribute [rw] domain_name
652
+ # The name of the domain you want to permanently delete.
653
+ # @return [String]
654
+ class DeleteDomainRequest < Struct.new(
655
+ :domain_name)
656
+ include Aws::Structure
657
+ end
658
+
659
+ # The result of a `DeleteDomain` request. Contains the status of a newly
660
+ # deleted domain, or no status if the domain has already been completely
661
+ # deleted.
662
+ # @!attribute [rw] domain_status
663
+ # The current status of the search domain.
664
+ # @return [Types::DomainStatus]
665
+ class DeleteDomainResponse < Struct.new(
666
+ :domain_status)
667
+ include Aws::Structure
668
+ end
669
+
670
+ # Container for the parameters to the `DeleteExpression` operation.
671
+ # Specifies the name of the domain you want to update and the name of
672
+ # the expression you want to delete.
673
+ # @note When making an API call, pass DeleteExpressionRequest
674
+ # data as a hash:
675
+ #
676
+ # {
677
+ # domain_name: "DomainName", # required
678
+ # expression_name: "StandardName", # required
679
+ # }
680
+ # @!attribute [rw] domain_name
681
+ # A string that represents the name of a domain. Domain names are
682
+ # unique across the domains owned by an account within an AWS region.
683
+ # Domain names start with a letter or number and can contain the
684
+ # following characters: a-z (lowercase), 0-9, and - (hyphen).
685
+ # @return [String]
686
+ #
687
+ # @!attribute [rw] expression_name
688
+ # The name of the `Expression` to delete.
689
+ # @return [String]
690
+ class DeleteExpressionRequest < Struct.new(
691
+ :domain_name,
692
+ :expression_name)
693
+ include Aws::Structure
694
+ end
695
+
696
+ # The result of a `DeleteExpression` request. Specifies the expression
697
+ # being deleted.
698
+ # @!attribute [rw] expression
699
+ # The status of the expression being deleted.
700
+ # @return [Types::ExpressionStatus]
701
+ class DeleteExpressionResponse < Struct.new(
702
+ :expression)
703
+ include Aws::Structure
704
+ end
705
+
706
+ # Container for the parameters to the `DeleteIndexField` operation.
707
+ # Specifies the name of the domain you want to update and the name of
708
+ # the index field you want to delete.
709
+ # @note When making an API call, pass DeleteIndexFieldRequest
710
+ # data as a hash:
711
+ #
712
+ # {
713
+ # domain_name: "DomainName", # required
714
+ # index_field_name: "DynamicFieldName", # required
715
+ # }
716
+ # @!attribute [rw] domain_name
717
+ # A string that represents the name of a domain. Domain names are
718
+ # unique across the domains owned by an account within an AWS region.
719
+ # Domain names start with a letter or number and can contain the
720
+ # following characters: a-z (lowercase), 0-9, and - (hyphen).
721
+ # @return [String]
722
+ #
723
+ # @!attribute [rw] index_field_name
724
+ # The name of the index field your want to remove from the domain's
725
+ # indexing options.
726
+ # @return [String]
727
+ class DeleteIndexFieldRequest < Struct.new(
728
+ :domain_name,
729
+ :index_field_name)
730
+ include Aws::Structure
731
+ end
732
+
733
+ # The result of a `DeleteIndexField` request.
734
+ # @!attribute [rw] index_field
735
+ # The status of the index field being deleted.
736
+ # @return [Types::IndexFieldStatus]
737
+ class DeleteIndexFieldResponse < Struct.new(
738
+ :index_field)
739
+ include Aws::Structure
740
+ end
741
+
742
+ # Container for the parameters to the `DeleteSuggester` operation.
743
+ # Specifies the name of the domain you want to update and name of the
744
+ # suggester you want to delete.
745
+ # @note When making an API call, pass DeleteSuggesterRequest
746
+ # data as a hash:
747
+ #
748
+ # {
749
+ # domain_name: "DomainName", # required
750
+ # suggester_name: "StandardName", # required
751
+ # }
752
+ # @!attribute [rw] domain_name
753
+ # A string that represents the name of a domain. Domain names are
754
+ # unique across the domains owned by an account within an AWS region.
755
+ # Domain names start with a letter or number and can contain the
756
+ # following characters: a-z (lowercase), 0-9, and - (hyphen).
757
+ # @return [String]
758
+ #
759
+ # @!attribute [rw] suggester_name
760
+ # Specifies the name of the suggester you want to delete.
761
+ # @return [String]
762
+ class DeleteSuggesterRequest < Struct.new(
763
+ :domain_name,
764
+ :suggester_name)
765
+ include Aws::Structure
766
+ end
767
+
768
+ # The result of a `DeleteSuggester` request. Contains the status of the
769
+ # deleted suggester.
770
+ # @!attribute [rw] suggester
771
+ # The status of the suggester being deleted.
772
+ # @return [Types::SuggesterStatus]
773
+ class DeleteSuggesterResponse < Struct.new(
774
+ :suggester)
775
+ include Aws::Structure
776
+ end
777
+
778
+ # Container for the parameters to the `DescribeAnalysisSchemes`
779
+ # operation. Specifies the name of the domain you want to describe. To
780
+ # limit the response to particular analysis schemes, specify the names
781
+ # of the analysis schemes you want to describe. To show the active
782
+ # configuration and exclude any pending changes, set the `Deployed`
783
+ # option to `true`.
784
+ # @note When making an API call, pass DescribeAnalysisSchemesRequest
785
+ # data as a hash:
786
+ #
787
+ # {
788
+ # domain_name: "DomainName", # required
789
+ # analysis_scheme_names: ["StandardName"],
790
+ # deployed: false,
791
+ # }
792
+ # @!attribute [rw] domain_name
793
+ # The name of the domain you want to describe.
794
+ # @return [String]
795
+ #
796
+ # @!attribute [rw] analysis_scheme_names
797
+ # The analysis schemes you want to describe.
798
+ # @return [Array<String>]
799
+ #
800
+ # @!attribute [rw] deployed
801
+ # Whether to display the deployed configuration (`true`) or include
802
+ # any pending changes (`false`). Defaults to `false`.
803
+ # @return [Boolean]
804
+ class DescribeAnalysisSchemesRequest < Struct.new(
805
+ :domain_name,
806
+ :analysis_scheme_names,
807
+ :deployed)
808
+ include Aws::Structure
809
+ end
810
+
811
+ # The result of a `DescribeAnalysisSchemes` request. Contains the
812
+ # analysis schemes configured for the domain specified in the request.
813
+ # @!attribute [rw] analysis_schemes
814
+ # The analysis scheme descriptions.
815
+ # @return [Array<Types::AnalysisSchemeStatus>]
816
+ class DescribeAnalysisSchemesResponse < Struct.new(
817
+ :analysis_schemes)
818
+ include Aws::Structure
819
+ end
820
+
821
+ # Container for the parameters to the `DescribeAvailabilityOptions`
822
+ # operation. Specifies the name of the domain you want to describe. To
823
+ # show the active configuration and exclude any pending changes, set the
824
+ # Deployed option to `true`.
825
+ # @note When making an API call, pass DescribeAvailabilityOptionsRequest
826
+ # data as a hash:
827
+ #
828
+ # {
829
+ # domain_name: "DomainName", # required
830
+ # deployed: false,
831
+ # }
832
+ # @!attribute [rw] domain_name
833
+ # The name of the domain you want to describe.
834
+ # @return [String]
835
+ #
836
+ # @!attribute [rw] deployed
837
+ # Whether to display the deployed configuration (`true`) or include
838
+ # any pending changes (`false`). Defaults to `false`.
839
+ # @return [Boolean]
840
+ class DescribeAvailabilityOptionsRequest < Struct.new(
841
+ :domain_name,
842
+ :deployed)
843
+ include Aws::Structure
844
+ end
845
+
846
+ # The result of a `DescribeAvailabilityOptions` request. Indicates
847
+ # whether or not the Multi-AZ option is enabled for the domain specified
848
+ # in the request.
849
+ # @!attribute [rw] availability_options
850
+ # The availability options configured for the domain. Indicates
851
+ # whether Multi-AZ is enabled for the domain.
852
+ # @return [Types::AvailabilityOptionsStatus]
853
+ class DescribeAvailabilityOptionsResponse < Struct.new(
854
+ :availability_options)
855
+ include Aws::Structure
856
+ end
857
+
858
+ # Container for the parameters to the `DescribeDomains` operation. By
859
+ # default shows the status of all domains. To restrict the response to
860
+ # particular domains, specify the names of the domains you want to
861
+ # describe.
862
+ # @note When making an API call, pass DescribeDomainsRequest
863
+ # data as a hash:
864
+ #
865
+ # {
866
+ # domain_names: ["DomainName"],
867
+ # }
868
+ # @!attribute [rw] domain_names
869
+ # The names of the domains you want to include in the response.
870
+ # @return [Array<String>]
871
+ class DescribeDomainsRequest < Struct.new(
872
+ :domain_names)
873
+ include Aws::Structure
874
+ end
875
+
876
+ # The result of a `DescribeDomains` request. Contains the status of the
877
+ # domains specified in the request or all domains owned by the account.
878
+ # @!attribute [rw] domain_status_list
879
+ # A list that contains the status of each requested domain.
880
+ # @return [Array<Types::DomainStatus>]
881
+ class DescribeDomainsResponse < Struct.new(
882
+ :domain_status_list)
883
+ include Aws::Structure
884
+ end
885
+
886
+ # Container for the parameters to the `DescribeDomains` operation.
887
+ # Specifies the name of the domain you want to describe. To restrict the
888
+ # response to particular expressions, specify the names of the
889
+ # expressions you want to describe. To show the active configuration and
890
+ # exclude any pending changes, set the `Deployed` option to `true`.
891
+ # @note When making an API call, pass DescribeExpressionsRequest
892
+ # data as a hash:
893
+ #
894
+ # {
895
+ # domain_name: "DomainName", # required
896
+ # expression_names: ["StandardName"],
897
+ # deployed: false,
898
+ # }
899
+ # @!attribute [rw] domain_name
900
+ # The name of the domain you want to describe.
901
+ # @return [String]
902
+ #
903
+ # @!attribute [rw] expression_names
904
+ # Limits the `DescribeExpressions` response to the specified
905
+ # expressions. If not specified, all expressions are shown.
906
+ # @return [Array<String>]
907
+ #
908
+ # @!attribute [rw] deployed
909
+ # Whether to display the deployed configuration (`true`) or include
910
+ # any pending changes (`false`). Defaults to `false`.
911
+ # @return [Boolean]
912
+ class DescribeExpressionsRequest < Struct.new(
913
+ :domain_name,
914
+ :expression_names,
915
+ :deployed)
916
+ include Aws::Structure
917
+ end
918
+
919
+ # The result of a `DescribeExpressions` request. Contains the
920
+ # expressions configured for the domain specified in the request.
921
+ # @!attribute [rw] expressions
922
+ # The expressions configured for the domain.
923
+ # @return [Array<Types::ExpressionStatus>]
924
+ class DescribeExpressionsResponse < Struct.new(
925
+ :expressions)
926
+ include Aws::Structure
927
+ end
928
+
929
+ # Container for the parameters to the `DescribeIndexFields` operation.
930
+ # Specifies the name of the domain you want to describe. To restrict the
931
+ # response to particular index fields, specify the names of the index
932
+ # fields you want to describe. To show the active configuration and
933
+ # exclude any pending changes, set the `Deployed` option to `true`.
934
+ # @note When making an API call, pass DescribeIndexFieldsRequest
935
+ # data as a hash:
936
+ #
937
+ # {
938
+ # domain_name: "DomainName", # required
939
+ # field_names: ["DynamicFieldName"],
940
+ # deployed: false,
941
+ # }
942
+ # @!attribute [rw] domain_name
943
+ # The name of the domain you want to describe.
944
+ # @return [String]
945
+ #
946
+ # @!attribute [rw] field_names
947
+ # A list of the index fields you want to describe. If not specified,
948
+ # information is returned for all configured index fields.
949
+ # @return [Array<String>]
950
+ #
951
+ # @!attribute [rw] deployed
952
+ # Whether to display the deployed configuration (`true`) or include
953
+ # any pending changes (`false`). Defaults to `false`.
954
+ # @return [Boolean]
955
+ class DescribeIndexFieldsRequest < Struct.new(
956
+ :domain_name,
957
+ :field_names,
958
+ :deployed)
959
+ include Aws::Structure
960
+ end
961
+
962
+ # The result of a `DescribeIndexFields` request. Contains the index
963
+ # fields configured for the domain specified in the request.
964
+ # @!attribute [rw] index_fields
965
+ # The index fields configured for the domain.
966
+ # @return [Array<Types::IndexFieldStatus>]
967
+ class DescribeIndexFieldsResponse < Struct.new(
968
+ :index_fields)
969
+ include Aws::Structure
970
+ end
971
+
972
+ # Container for the parameters to the `DescribeScalingParameters`
973
+ # operation. Specifies the name of the domain you want to describe.
974
+ # @note When making an API call, pass DescribeScalingParametersRequest
975
+ # data as a hash:
976
+ #
977
+ # {
978
+ # domain_name: "DomainName", # required
979
+ # }
980
+ # @!attribute [rw] domain_name
981
+ # A string that represents the name of a domain. Domain names are
982
+ # unique across the domains owned by an account within an AWS region.
983
+ # Domain names start with a letter or number and can contain the
984
+ # following characters: a-z (lowercase), 0-9, and - (hyphen).
985
+ # @return [String]
986
+ class DescribeScalingParametersRequest < Struct.new(
987
+ :domain_name)
988
+ include Aws::Structure
989
+ end
990
+
991
+ # The result of a `DescribeScalingParameters` request. Contains the
992
+ # scaling parameters configured for the domain specified in the request.
993
+ # @!attribute [rw] scaling_parameters
994
+ # The status and configuration of a search domain's scaling
995
+ # parameters.
996
+ # @return [Types::ScalingParametersStatus]
997
+ class DescribeScalingParametersResponse < Struct.new(
998
+ :scaling_parameters)
999
+ include Aws::Structure
1000
+ end
1001
+
1002
+ # Container for the parameters to the `DescribeServiceAccessPolicies`
1003
+ # operation. Specifies the name of the domain you want to describe. To
1004
+ # show the active configuration and exclude any pending changes, set the
1005
+ # `Deployed` option to `true`.
1006
+ # @note When making an API call, pass DescribeServiceAccessPoliciesRequest
1007
+ # data as a hash:
1008
+ #
1009
+ # {
1010
+ # domain_name: "DomainName", # required
1011
+ # deployed: false,
1012
+ # }
1013
+ # @!attribute [rw] domain_name
1014
+ # The name of the domain you want to describe.
1015
+ # @return [String]
1016
+ #
1017
+ # @!attribute [rw] deployed
1018
+ # Whether to display the deployed configuration (`true`) or include
1019
+ # any pending changes (`false`). Defaults to `false`.
1020
+ # @return [Boolean]
1021
+ class DescribeServiceAccessPoliciesRequest < Struct.new(
1022
+ :domain_name,
1023
+ :deployed)
1024
+ include Aws::Structure
1025
+ end
1026
+
1027
+ # The result of a `DescribeServiceAccessPolicies` request.
1028
+ # @!attribute [rw] access_policies
1029
+ # The access rules configured for the domain specified in the request.
1030
+ # @return [Types::AccessPoliciesStatus]
1031
+ class DescribeServiceAccessPoliciesResponse < Struct.new(
1032
+ :access_policies)
1033
+ include Aws::Structure
1034
+ end
1035
+
1036
+ # Container for the parameters to the `DescribeSuggester` operation.
1037
+ # Specifies the name of the domain you want to describe. To restrict the
1038
+ # response to particular suggesters, specify the names of the suggesters
1039
+ # you want to describe. To show the active configuration and exclude any
1040
+ # pending changes, set the `Deployed` option to `true`.
1041
+ # @note When making an API call, pass DescribeSuggestersRequest
1042
+ # data as a hash:
1043
+ #
1044
+ # {
1045
+ # domain_name: "DomainName", # required
1046
+ # suggester_names: ["StandardName"],
1047
+ # deployed: false,
1048
+ # }
1049
+ # @!attribute [rw] domain_name
1050
+ # The name of the domain you want to describe.
1051
+ # @return [String]
1052
+ #
1053
+ # @!attribute [rw] suggester_names
1054
+ # The suggesters you want to describe.
1055
+ # @return [Array<String>]
1056
+ #
1057
+ # @!attribute [rw] deployed
1058
+ # Whether to display the deployed configuration (`true`) or include
1059
+ # any pending changes (`false`). Defaults to `false`.
1060
+ # @return [Boolean]
1061
+ class DescribeSuggestersRequest < Struct.new(
1062
+ :domain_name,
1063
+ :suggester_names,
1064
+ :deployed)
1065
+ include Aws::Structure
1066
+ end
1067
+
1068
+ # The result of a `DescribeSuggesters` request.
1069
+ # @!attribute [rw] suggesters
1070
+ # The suggesters configured for the domain specified in the request.
1071
+ # @return [Array<Types::SuggesterStatus>]
1072
+ class DescribeSuggestersResponse < Struct.new(
1073
+ :suggesters)
1074
+ include Aws::Structure
1075
+ end
1076
+
1077
+ # Options for a search suggester.
1078
+ # @note When making an API call, pass DocumentSuggesterOptions
1079
+ # data as a hash:
1080
+ #
1081
+ # {
1082
+ # source_field: "FieldName", # required
1083
+ # fuzzy_matching: "none", # accepts none, low, high
1084
+ # sort_expression: "String",
1085
+ # }
1086
+ # @!attribute [rw] source_field
1087
+ # The name of the index field you want to use for suggestions.
1088
+ # @return [String]
1089
+ #
1090
+ # @!attribute [rw] fuzzy_matching
1091
+ # The level of fuzziness allowed when suggesting matches for a string:
1092
+ # `none`, `low`, or `high`. With none, the specified string is treated
1093
+ # as an exact prefix. With low, suggestions must differ from the
1094
+ # specified string by no more than one character. With high,
1095
+ # suggestions can differ by up to two characters. The default is none.
1096
+ # @return [String]
1097
+ #
1098
+ # @!attribute [rw] sort_expression
1099
+ # An expression that computes a score for each suggestion to control
1100
+ # how they are sorted. The scores are rounded to the nearest integer,
1101
+ # with a floor of 0 and a ceiling of 2^31-1. A document's relevance
1102
+ # score is not computed for suggestions, so sort expressions cannot
1103
+ # reference the `_score` value. To sort suggestions using a numeric
1104
+ # field or existing expression, simply specify the name of the field
1105
+ # or expression. If no expression is configured for the suggester, the
1106
+ # suggestions are sorted with the closest matches listed first.
1107
+ # @return [String]
1108
+ class DocumentSuggesterOptions < Struct.new(
1109
+ :source_field,
1110
+ :fuzzy_matching,
1111
+ :sort_expression)
1112
+ include Aws::Structure
1113
+ end
1114
+
1115
+ # The current status of the search domain.
1116
+ # @!attribute [rw] domain_id
1117
+ # An internally generated unique identifier for a domain.
1118
+ # @return [String]
1119
+ #
1120
+ # @!attribute [rw] domain_name
1121
+ # A string that represents the name of a domain. Domain names are
1122
+ # unique across the domains owned by an account within an AWS region.
1123
+ # Domain names start with a letter or number and can contain the
1124
+ # following characters: a-z (lowercase), 0-9, and - (hyphen).
1125
+ # @return [String]
1126
+ #
1127
+ # @!attribute [rw] arn
1128
+ # The Amazon Resource Name (ARN) of the search domain. See
1129
+ # [Identifiers for IAM Entities][1] in *Using AWS Identity and Access
1130
+ # Management* for more information.
1131
+ #
1132
+ #
1133
+ #
1134
+ # [1]: http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html
1135
+ # @return [String]
1136
+ #
1137
+ # @!attribute [rw] created
1138
+ # True if the search domain is created. It can take several minutes to
1139
+ # initialize a domain when CreateDomain is called. Newly created
1140
+ # search domains are returned from DescribeDomains with a false value
1141
+ # for Created until domain creation is complete.
1142
+ # @return [Boolean]
1143
+ #
1144
+ # @!attribute [rw] deleted
1145
+ # True if the search domain has been deleted. The system must clean up
1146
+ # resources dedicated to the search domain when DeleteDomain is
1147
+ # called. Newly deleted search domains are returned from
1148
+ # DescribeDomains with a true value for IsDeleted for several minutes
1149
+ # until resource cleanup is complete.
1150
+ # @return [Boolean]
1151
+ #
1152
+ # @!attribute [rw] doc_service
1153
+ # The service endpoint for updating documents in a search domain.
1154
+ # @return [Types::ServiceEndpoint]
1155
+ #
1156
+ # @!attribute [rw] search_service
1157
+ # The service endpoint for requesting search results from a search
1158
+ # domain.
1159
+ # @return [Types::ServiceEndpoint]
1160
+ #
1161
+ # @!attribute [rw] requires_index_documents
1162
+ # True if IndexDocuments needs to be called to activate the current
1163
+ # domain configuration.
1164
+ # @return [Boolean]
1165
+ #
1166
+ # @!attribute [rw] processing
1167
+ # True if processing is being done to activate the current domain
1168
+ # configuration.
1169
+ # @return [Boolean]
1170
+ #
1171
+ # @!attribute [rw] search_instance_type
1172
+ # The instance type that is being used to process search requests.
1173
+ # @return [String]
1174
+ #
1175
+ # @!attribute [rw] search_partition_count
1176
+ # The number of partitions across which the search index is spread.
1177
+ # @return [Integer]
1178
+ #
1179
+ # @!attribute [rw] search_instance_count
1180
+ # The number of search instances that are available to process search
1181
+ # requests.
1182
+ # @return [Integer]
1183
+ #
1184
+ # @!attribute [rw] limits
1185
+ # @return [Types::Limits]
1186
+ class DomainStatus < Struct.new(
1187
+ :domain_id,
1188
+ :domain_name,
1189
+ :arn,
1190
+ :created,
1191
+ :deleted,
1192
+ :doc_service,
1193
+ :search_service,
1194
+ :requires_index_documents,
1195
+ :processing,
1196
+ :search_instance_type,
1197
+ :search_partition_count,
1198
+ :search_instance_count,
1199
+ :limits)
1200
+ include Aws::Structure
1201
+ end
1202
+
1203
+ # Options for a field that contains an array of double-precision 64-bit
1204
+ # floating point values. Present if `IndexFieldType` specifies the field
1205
+ # is of type `double-array`. All options are enabled by default.
1206
+ # @note When making an API call, pass DoubleArrayOptions
1207
+ # data as a hash:
1208
+ #
1209
+ # {
1210
+ # default_value: 1.0,
1211
+ # source_fields: "FieldNameCommaList",
1212
+ # facet_enabled: false,
1213
+ # search_enabled: false,
1214
+ # return_enabled: false,
1215
+ # }
1216
+ # @!attribute [rw] default_value
1217
+ # A value to use for the field if the field isn't specified for a
1218
+ # document.
1219
+ # @return [Float]
1220
+ #
1221
+ # @!attribute [rw] source_fields
1222
+ # A list of source fields to map to the field.
1223
+ # @return [String]
1224
+ #
1225
+ # @!attribute [rw] facet_enabled
1226
+ # Whether facet information can be returned for the field.
1227
+ # @return [Boolean]
1228
+ #
1229
+ # @!attribute [rw] search_enabled
1230
+ # Whether the contents of the field are searchable.
1231
+ # @return [Boolean]
1232
+ #
1233
+ # @!attribute [rw] return_enabled
1234
+ # Whether the contents of the field can be returned in the search
1235
+ # results.
1236
+ # @return [Boolean]
1237
+ class DoubleArrayOptions < Struct.new(
1238
+ :default_value,
1239
+ :source_fields,
1240
+ :facet_enabled,
1241
+ :search_enabled,
1242
+ :return_enabled)
1243
+ include Aws::Structure
1244
+ end
1245
+
1246
+ # Options for a double-precision 64-bit floating point field. Present if
1247
+ # `IndexFieldType` specifies the field is of type `double`. All options
1248
+ # are enabled by default.
1249
+ # @note When making an API call, pass DoubleOptions
1250
+ # data as a hash:
1251
+ #
1252
+ # {
1253
+ # default_value: 1.0,
1254
+ # source_field: "FieldName",
1255
+ # facet_enabled: false,
1256
+ # search_enabled: false,
1257
+ # return_enabled: false,
1258
+ # sort_enabled: false,
1259
+ # }
1260
+ # @!attribute [rw] default_value
1261
+ # A value to use for the field if the field isn't specified for a
1262
+ # document. This can be important if you are using the field in an
1263
+ # expression and that field is not present in every document.
1264
+ # @return [Float]
1265
+ #
1266
+ # @!attribute [rw] source_field
1267
+ # The name of the source field to map to the field.
1268
+ # @return [String]
1269
+ #
1270
+ # @!attribute [rw] facet_enabled
1271
+ # Whether facet information can be returned for the field.
1272
+ # @return [Boolean]
1273
+ #
1274
+ # @!attribute [rw] search_enabled
1275
+ # Whether the contents of the field are searchable.
1276
+ # @return [Boolean]
1277
+ #
1278
+ # @!attribute [rw] return_enabled
1279
+ # Whether the contents of the field can be returned in the search
1280
+ # results.
1281
+ # @return [Boolean]
1282
+ #
1283
+ # @!attribute [rw] sort_enabled
1284
+ # Whether the field can be used to sort the search results.
1285
+ # @return [Boolean]
1286
+ class DoubleOptions < Struct.new(
1287
+ :default_value,
1288
+ :source_field,
1289
+ :facet_enabled,
1290
+ :search_enabled,
1291
+ :return_enabled,
1292
+ :sort_enabled)
1293
+ include Aws::Structure
1294
+ end
1295
+
1296
+ # A named expression that can be evaluated at search time. Can be used
1297
+ # to sort the search results, define other expressions, or return
1298
+ # computed information in the search results.
1299
+ # @note When making an API call, pass Expression
1300
+ # data as a hash:
1301
+ #
1302
+ # {
1303
+ # expression_name: "StandardName", # required
1304
+ # expression_value: "ExpressionValue", # required
1305
+ # }
1306
+ # @!attribute [rw] expression_name
1307
+ # Names must begin with a letter and can contain the following
1308
+ # characters: a-z (lowercase), 0-9, and \_ (underscore).
1309
+ # @return [String]
1310
+ #
1311
+ # @!attribute [rw] expression_value
1312
+ # The expression to evaluate for sorting while processing a search
1313
+ # request. The `Expression` syntax is based on JavaScript expressions.
1314
+ # For more information, see [Configuring Expressions][1] in the
1315
+ # *Amazon CloudSearch Developer Guide*.
1316
+ #
1317
+ #
1318
+ #
1319
+ # [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html
1320
+ # @return [String]
1321
+ class Expression < Struct.new(
1322
+ :expression_name,
1323
+ :expression_value)
1324
+ include Aws::Structure
1325
+ end
1326
+
1327
+ # The value of an `Expression` and its current status.
1328
+ # @!attribute [rw] options
1329
+ # The expression that is evaluated for sorting while processing a
1330
+ # search request.
1331
+ # @return [Types::Expression]
1332
+ #
1333
+ # @!attribute [rw] status
1334
+ # The status of domain configuration option.
1335
+ # @return [Types::OptionStatus]
1336
+ class ExpressionStatus < Struct.new(
1337
+ :options,
1338
+ :status)
1339
+ include Aws::Structure
1340
+ end
1341
+
1342
+ # Container for the parameters to the `IndexDocuments` operation.
1343
+ # Specifies the name of the domain you want to re-index.
1344
+ # @note When making an API call, pass IndexDocumentsRequest
1345
+ # data as a hash:
1346
+ #
1347
+ # {
1348
+ # domain_name: "DomainName", # required
1349
+ # }
1350
+ # @!attribute [rw] domain_name
1351
+ # A string that represents the name of a domain. Domain names are
1352
+ # unique across the domains owned by an account within an AWS region.
1353
+ # Domain names start with a letter or number and can contain the
1354
+ # following characters: a-z (lowercase), 0-9, and - (hyphen).
1355
+ # @return [String]
1356
+ class IndexDocumentsRequest < Struct.new(
1357
+ :domain_name)
1358
+ include Aws::Structure
1359
+ end
1360
+
1361
+ # The result of an `IndexDocuments` request. Contains the status of the
1362
+ # indexing operation, including the fields being indexed.
1363
+ # @!attribute [rw] field_names
1364
+ # The names of the fields that are currently being indexed.
1365
+ # @return [Array<String>]
1366
+ class IndexDocumentsResponse < Struct.new(
1367
+ :field_names)
1368
+ include Aws::Structure
1369
+ end
1370
+
1371
+ # Configuration information for a field in the index, including its
1372
+ # name, type, and options. The supported options depend on the
1373
+ # `IndexFieldType`.
1374
+ # @note When making an API call, pass IndexField
1375
+ # data as a hash:
1376
+ #
1377
+ # {
1378
+ # index_field_name: "DynamicFieldName", # required
1379
+ # index_field_type: "int", # required, accepts int, double, literal, text, date, latlon, int-array, double-array, literal-array, text-array, date-array
1380
+ # int_options: {
1381
+ # default_value: 1,
1382
+ # source_field: "FieldName",
1383
+ # facet_enabled: false,
1384
+ # search_enabled: false,
1385
+ # return_enabled: false,
1386
+ # sort_enabled: false,
1387
+ # },
1388
+ # double_options: {
1389
+ # default_value: 1.0,
1390
+ # source_field: "FieldName",
1391
+ # facet_enabled: false,
1392
+ # search_enabled: false,
1393
+ # return_enabled: false,
1394
+ # sort_enabled: false,
1395
+ # },
1396
+ # literal_options: {
1397
+ # default_value: "FieldValue",
1398
+ # source_field: "FieldName",
1399
+ # facet_enabled: false,
1400
+ # search_enabled: false,
1401
+ # return_enabled: false,
1402
+ # sort_enabled: false,
1403
+ # },
1404
+ # text_options: {
1405
+ # default_value: "FieldValue",
1406
+ # source_field: "FieldName",
1407
+ # return_enabled: false,
1408
+ # sort_enabled: false,
1409
+ # highlight_enabled: false,
1410
+ # analysis_scheme: "Word",
1411
+ # },
1412
+ # date_options: {
1413
+ # default_value: "FieldValue",
1414
+ # source_field: "FieldName",
1415
+ # facet_enabled: false,
1416
+ # search_enabled: false,
1417
+ # return_enabled: false,
1418
+ # sort_enabled: false,
1419
+ # },
1420
+ # lat_lon_options: {
1421
+ # default_value: "FieldValue",
1422
+ # source_field: "FieldName",
1423
+ # facet_enabled: false,
1424
+ # search_enabled: false,
1425
+ # return_enabled: false,
1426
+ # sort_enabled: false,
1427
+ # },
1428
+ # int_array_options: {
1429
+ # default_value: 1,
1430
+ # source_fields: "FieldNameCommaList",
1431
+ # facet_enabled: false,
1432
+ # search_enabled: false,
1433
+ # return_enabled: false,
1434
+ # },
1435
+ # double_array_options: {
1436
+ # default_value: 1.0,
1437
+ # source_fields: "FieldNameCommaList",
1438
+ # facet_enabled: false,
1439
+ # search_enabled: false,
1440
+ # return_enabled: false,
1441
+ # },
1442
+ # literal_array_options: {
1443
+ # default_value: "FieldValue",
1444
+ # source_fields: "FieldNameCommaList",
1445
+ # facet_enabled: false,
1446
+ # search_enabled: false,
1447
+ # return_enabled: false,
1448
+ # },
1449
+ # text_array_options: {
1450
+ # default_value: "FieldValue",
1451
+ # source_fields: "FieldNameCommaList",
1452
+ # return_enabled: false,
1453
+ # highlight_enabled: false,
1454
+ # analysis_scheme: "Word",
1455
+ # },
1456
+ # date_array_options: {
1457
+ # default_value: "FieldValue",
1458
+ # source_fields: "FieldNameCommaList",
1459
+ # facet_enabled: false,
1460
+ # search_enabled: false,
1461
+ # return_enabled: false,
1462
+ # },
1463
+ # }
1464
+ # @!attribute [rw] index_field_name
1465
+ # A string that represents the name of an index field. CloudSearch
1466
+ # supports regular index fields as well as dynamic fields. A dynamic
1467
+ # field's name defines a pattern that begins or ends with a wildcard.
1468
+ # Any document fields that don't map to a regular index field but do
1469
+ # match a dynamic field's pattern are configured with the dynamic
1470
+ # field's indexing options.
1471
+ #
1472
+ # Regular field names begin with a letter and can contain the
1473
+ # following characters: a-z (lowercase), 0-9, and \_ (underscore).
1474
+ # Dynamic field names must begin or end with a wildcard (*). The
1475
+ # wildcard can also be the only character in a dynamic field name.
1476
+ # Multiple wildcards, and wildcards embedded within a string are not
1477
+ # supported.
1478
+ #
1479
+ # The name `score` is reserved and cannot be used as a field name. To
1480
+ # reference a document's ID, you can use the name `_id`.
1481
+ # @return [String]
1482
+ #
1483
+ # @!attribute [rw] index_field_type
1484
+ # The type of field. The valid options for a field depend on the field
1485
+ # type. For more information about the supported field types, see
1486
+ # [Configuring Index Fields][1] in the *Amazon CloudSearch Developer
1487
+ # Guide*.
1488
+ #
1489
+ #
1490
+ #
1491
+ # [1]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html
1492
+ # @return [String]
1493
+ #
1494
+ # @!attribute [rw] int_options
1495
+ # Options for a 64-bit signed integer field. Present if
1496
+ # `IndexFieldType` specifies the field is of type `int`. All options
1497
+ # are enabled by default.
1498
+ # @return [Types::IntOptions]
1499
+ #
1500
+ # @!attribute [rw] double_options
1501
+ # Options for a double-precision 64-bit floating point field. Present
1502
+ # if `IndexFieldType` specifies the field is of type `double`. All
1503
+ # options are enabled by default.
1504
+ # @return [Types::DoubleOptions]
1505
+ #
1506
+ # @!attribute [rw] literal_options
1507
+ # Options for literal field. Present if `IndexFieldType` specifies the
1508
+ # field is of type `literal`. All options are enabled by default.
1509
+ # @return [Types::LiteralOptions]
1510
+ #
1511
+ # @!attribute [rw] text_options
1512
+ # Options for text field. Present if `IndexFieldType` specifies the
1513
+ # field is of type `text`. A `text` field is always searchable. All
1514
+ # options are enabled by default.
1515
+ # @return [Types::TextOptions]
1516
+ #
1517
+ # @!attribute [rw] date_options
1518
+ # Options for a date field. Dates and times are specified in UTC
1519
+ # (Coordinated Universal Time) according to IETF RFC3339:
1520
+ # yyyy-mm-ddT00:00:00Z. Present if `IndexFieldType` specifies the
1521
+ # field is of type `date`. All options are enabled by default.
1522
+ # @return [Types::DateOptions]
1523
+ #
1524
+ # @!attribute [rw] lat_lon_options
1525
+ # Options for a latlon field. A latlon field contains a location
1526
+ # stored as a latitude and longitude value pair. Present if
1527
+ # `IndexFieldType` specifies the field is of type `latlon`. All
1528
+ # options are enabled by default.
1529
+ # @return [Types::LatLonOptions]
1530
+ #
1531
+ # @!attribute [rw] int_array_options
1532
+ # Options for a field that contains an array of 64-bit signed
1533
+ # integers. Present if `IndexFieldType` specifies the field is of type
1534
+ # `int-array`. All options are enabled by default.
1535
+ # @return [Types::IntArrayOptions]
1536
+ #
1537
+ # @!attribute [rw] double_array_options
1538
+ # Options for a field that contains an array of double-precision
1539
+ # 64-bit floating point values. Present if `IndexFieldType` specifies
1540
+ # the field is of type `double-array`. All options are enabled by
1541
+ # default.
1542
+ # @return [Types::DoubleArrayOptions]
1543
+ #
1544
+ # @!attribute [rw] literal_array_options
1545
+ # Options for a field that contains an array of literal strings.
1546
+ # Present if `IndexFieldType` specifies the field is of type
1547
+ # `literal-array`. All options are enabled by default.
1548
+ # @return [Types::LiteralArrayOptions]
1549
+ #
1550
+ # @!attribute [rw] text_array_options
1551
+ # Options for a field that contains an array of text strings. Present
1552
+ # if `IndexFieldType` specifies the field is of type `text-array`. A
1553
+ # `text-array` field is always searchable. All options are enabled by
1554
+ # default.
1555
+ # @return [Types::TextArrayOptions]
1556
+ #
1557
+ # @!attribute [rw] date_array_options
1558
+ # Options for a field that contains an array of dates. Present if
1559
+ # `IndexFieldType` specifies the field is of type `date-array`. All
1560
+ # options are enabled by default.
1561
+ # @return [Types::DateArrayOptions]
1562
+ class IndexField < Struct.new(
1563
+ :index_field_name,
1564
+ :index_field_type,
1565
+ :int_options,
1566
+ :double_options,
1567
+ :literal_options,
1568
+ :text_options,
1569
+ :date_options,
1570
+ :lat_lon_options,
1571
+ :int_array_options,
1572
+ :double_array_options,
1573
+ :literal_array_options,
1574
+ :text_array_options,
1575
+ :date_array_options)
1576
+ include Aws::Structure
1577
+ end
1578
+
1579
+ # The value of an `IndexField` and its current status.
1580
+ # @!attribute [rw] options
1581
+ # Configuration information for a field in the index, including its
1582
+ # name, type, and options. The supported options depend on the
1583
+ # `IndexFieldType`.
1584
+ # @return [Types::IndexField]
1585
+ #
1586
+ # @!attribute [rw] status
1587
+ # The status of domain configuration option.
1588
+ # @return [Types::OptionStatus]
1589
+ class IndexFieldStatus < Struct.new(
1590
+ :options,
1591
+ :status)
1592
+ include Aws::Structure
1593
+ end
1594
+
1595
+ # Options for a field that contains an array of 64-bit signed integers.
1596
+ # Present if `IndexFieldType` specifies the field is of type
1597
+ # `int-array`. All options are enabled by default.
1598
+ # @note When making an API call, pass IntArrayOptions
1599
+ # data as a hash:
1600
+ #
1601
+ # {
1602
+ # default_value: 1,
1603
+ # source_fields: "FieldNameCommaList",
1604
+ # facet_enabled: false,
1605
+ # search_enabled: false,
1606
+ # return_enabled: false,
1607
+ # }
1608
+ # @!attribute [rw] default_value
1609
+ # A value to use for the field if the field isn't specified for a
1610
+ # document.
1611
+ # @return [Integer]
1612
+ #
1613
+ # @!attribute [rw] source_fields
1614
+ # A list of source fields to map to the field.
1615
+ # @return [String]
1616
+ #
1617
+ # @!attribute [rw] facet_enabled
1618
+ # Whether facet information can be returned for the field.
1619
+ # @return [Boolean]
1620
+ #
1621
+ # @!attribute [rw] search_enabled
1622
+ # Whether the contents of the field are searchable.
1623
+ # @return [Boolean]
1624
+ #
1625
+ # @!attribute [rw] return_enabled
1626
+ # Whether the contents of the field can be returned in the search
1627
+ # results.
1628
+ # @return [Boolean]
1629
+ class IntArrayOptions < Struct.new(
1630
+ :default_value,
1631
+ :source_fields,
1632
+ :facet_enabled,
1633
+ :search_enabled,
1634
+ :return_enabled)
1635
+ include Aws::Structure
1636
+ end
1637
+
1638
+ # Options for a 64-bit signed integer field. Present if `IndexFieldType`
1639
+ # specifies the field is of type `int`. All options are enabled by
1640
+ # default.
1641
+ # @note When making an API call, pass IntOptions
1642
+ # data as a hash:
1643
+ #
1644
+ # {
1645
+ # default_value: 1,
1646
+ # source_field: "FieldName",
1647
+ # facet_enabled: false,
1648
+ # search_enabled: false,
1649
+ # return_enabled: false,
1650
+ # sort_enabled: false,
1651
+ # }
1652
+ # @!attribute [rw] default_value
1653
+ # A value to use for the field if the field isn't specified for a
1654
+ # document. This can be important if you are using the field in an
1655
+ # expression and that field is not present in every document.
1656
+ # @return [Integer]
1657
+ #
1658
+ # @!attribute [rw] source_field
1659
+ # The name of the source field to map to the field.
1660
+ # @return [String]
1661
+ #
1662
+ # @!attribute [rw] facet_enabled
1663
+ # Whether facet information can be returned for the field.
1664
+ # @return [Boolean]
1665
+ #
1666
+ # @!attribute [rw] search_enabled
1667
+ # Whether the contents of the field are searchable.
1668
+ # @return [Boolean]
1669
+ #
1670
+ # @!attribute [rw] return_enabled
1671
+ # Whether the contents of the field can be returned in the search
1672
+ # results.
1673
+ # @return [Boolean]
1674
+ #
1675
+ # @!attribute [rw] sort_enabled
1676
+ # Whether the field can be used to sort the search results.
1677
+ # @return [Boolean]
1678
+ class IntOptions < Struct.new(
1679
+ :default_value,
1680
+ :source_field,
1681
+ :facet_enabled,
1682
+ :search_enabled,
1683
+ :return_enabled,
1684
+ :sort_enabled)
1685
+ include Aws::Structure
1686
+ end
1687
+
1688
+ # Options for a latlon field. A latlon field contains a location stored
1689
+ # as a latitude and longitude value pair. Present if `IndexFieldType`
1690
+ # specifies the field is of type `latlon`. All options are enabled by
1691
+ # default.
1692
+ # @note When making an API call, pass LatLonOptions
1693
+ # data as a hash:
1694
+ #
1695
+ # {
1696
+ # default_value: "FieldValue",
1697
+ # source_field: "FieldName",
1698
+ # facet_enabled: false,
1699
+ # search_enabled: false,
1700
+ # return_enabled: false,
1701
+ # sort_enabled: false,
1702
+ # }
1703
+ # @!attribute [rw] default_value
1704
+ # A value to use for the field if the field isn't specified for a
1705
+ # document.
1706
+ # @return [String]
1707
+ #
1708
+ # @!attribute [rw] source_field
1709
+ # A string that represents the name of an index field. CloudSearch
1710
+ # supports regular index fields as well as dynamic fields. A dynamic
1711
+ # field's name defines a pattern that begins or ends with a wildcard.
1712
+ # Any document fields that don't map to a regular index field but do
1713
+ # match a dynamic field's pattern are configured with the dynamic
1714
+ # field's indexing options.
1715
+ #
1716
+ # Regular field names begin with a letter and can contain the
1717
+ # following characters: a-z (lowercase), 0-9, and \_ (underscore).
1718
+ # Dynamic field names must begin or end with a wildcard (*). The
1719
+ # wildcard can also be the only character in a dynamic field name.
1720
+ # Multiple wildcards, and wildcards embedded within a string are not
1721
+ # supported.
1722
+ #
1723
+ # The name `score` is reserved and cannot be used as a field name. To
1724
+ # reference a document's ID, you can use the name `_id`.
1725
+ # @return [String]
1726
+ #
1727
+ # @!attribute [rw] facet_enabled
1728
+ # Whether facet information can be returned for the field.
1729
+ # @return [Boolean]
1730
+ #
1731
+ # @!attribute [rw] search_enabled
1732
+ # Whether the contents of the field are searchable.
1733
+ # @return [Boolean]
1734
+ #
1735
+ # @!attribute [rw] return_enabled
1736
+ # Whether the contents of the field can be returned in the search
1737
+ # results.
1738
+ # @return [Boolean]
1739
+ #
1740
+ # @!attribute [rw] sort_enabled
1741
+ # Whether the field can be used to sort the search results.
1742
+ # @return [Boolean]
1743
+ class LatLonOptions < Struct.new(
1744
+ :default_value,
1745
+ :source_field,
1746
+ :facet_enabled,
1747
+ :search_enabled,
1748
+ :return_enabled,
1749
+ :sort_enabled)
1750
+ include Aws::Structure
1751
+ end
1752
+
1753
+ # @!attribute [rw] maximum_replication_count
1754
+ # @return [Integer]
1755
+ #
1756
+ # @!attribute [rw] maximum_partition_count
1757
+ # @return [Integer]
1758
+ class Limits < Struct.new(
1759
+ :maximum_replication_count,
1760
+ :maximum_partition_count)
1761
+ include Aws::Structure
1762
+ end
1763
+
1764
+ # The result of a `ListDomainNames` request. Contains a list of the
1765
+ # domains owned by an account.
1766
+ # @!attribute [rw] domain_names
1767
+ # The names of the search domains owned by an account.
1768
+ # @return [Hash<String,String>]
1769
+ class ListDomainNamesResponse < Struct.new(
1770
+ :domain_names)
1771
+ include Aws::Structure
1772
+ end
1773
+
1774
+ # Options for a field that contains an array of literal strings. Present
1775
+ # if `IndexFieldType` specifies the field is of type `literal-array`.
1776
+ # All options are enabled by default.
1777
+ # @note When making an API call, pass LiteralArrayOptions
1778
+ # data as a hash:
1779
+ #
1780
+ # {
1781
+ # default_value: "FieldValue",
1782
+ # source_fields: "FieldNameCommaList",
1783
+ # facet_enabled: false,
1784
+ # search_enabled: false,
1785
+ # return_enabled: false,
1786
+ # }
1787
+ # @!attribute [rw] default_value
1788
+ # A value to use for the field if the field isn't specified for a
1789
+ # document.
1790
+ # @return [String]
1791
+ #
1792
+ # @!attribute [rw] source_fields
1793
+ # A list of source fields to map to the field.
1794
+ # @return [String]
1795
+ #
1796
+ # @!attribute [rw] facet_enabled
1797
+ # Whether facet information can be returned for the field.
1798
+ # @return [Boolean]
1799
+ #
1800
+ # @!attribute [rw] search_enabled
1801
+ # Whether the contents of the field are searchable.
1802
+ # @return [Boolean]
1803
+ #
1804
+ # @!attribute [rw] return_enabled
1805
+ # Whether the contents of the field can be returned in the search
1806
+ # results.
1807
+ # @return [Boolean]
1808
+ class LiteralArrayOptions < Struct.new(
1809
+ :default_value,
1810
+ :source_fields,
1811
+ :facet_enabled,
1812
+ :search_enabled,
1813
+ :return_enabled)
1814
+ include Aws::Structure
1815
+ end
1816
+
1817
+ # Options for literal field. Present if `IndexFieldType` specifies the
1818
+ # field is of type `literal`. All options are enabled by default.
1819
+ # @note When making an API call, pass LiteralOptions
1820
+ # data as a hash:
1821
+ #
1822
+ # {
1823
+ # default_value: "FieldValue",
1824
+ # source_field: "FieldName",
1825
+ # facet_enabled: false,
1826
+ # search_enabled: false,
1827
+ # return_enabled: false,
1828
+ # sort_enabled: false,
1829
+ # }
1830
+ # @!attribute [rw] default_value
1831
+ # A value to use for the field if the field isn't specified for a
1832
+ # document.
1833
+ # @return [String]
1834
+ #
1835
+ # @!attribute [rw] source_field
1836
+ # A string that represents the name of an index field. CloudSearch
1837
+ # supports regular index fields as well as dynamic fields. A dynamic
1838
+ # field's name defines a pattern that begins or ends with a wildcard.
1839
+ # Any document fields that don't map to a regular index field but do
1840
+ # match a dynamic field's pattern are configured with the dynamic
1841
+ # field's indexing options.
1842
+ #
1843
+ # Regular field names begin with a letter and can contain the
1844
+ # following characters: a-z (lowercase), 0-9, and \_ (underscore).
1845
+ # Dynamic field names must begin or end with a wildcard (*). The
1846
+ # wildcard can also be the only character in a dynamic field name.
1847
+ # Multiple wildcards, and wildcards embedded within a string are not
1848
+ # supported.
1849
+ #
1850
+ # The name `score` is reserved and cannot be used as a field name. To
1851
+ # reference a document's ID, you can use the name `_id`.
1852
+ # @return [String]
1853
+ #
1854
+ # @!attribute [rw] facet_enabled
1855
+ # Whether facet information can be returned for the field.
1856
+ # @return [Boolean]
1857
+ #
1858
+ # @!attribute [rw] search_enabled
1859
+ # Whether the contents of the field are searchable.
1860
+ # @return [Boolean]
1861
+ #
1862
+ # @!attribute [rw] return_enabled
1863
+ # Whether the contents of the field can be returned in the search
1864
+ # results.
1865
+ # @return [Boolean]
1866
+ #
1867
+ # @!attribute [rw] sort_enabled
1868
+ # Whether the field can be used to sort the search results.
1869
+ # @return [Boolean]
1870
+ class LiteralOptions < Struct.new(
1871
+ :default_value,
1872
+ :source_field,
1873
+ :facet_enabled,
1874
+ :search_enabled,
1875
+ :return_enabled,
1876
+ :sort_enabled)
1877
+ include Aws::Structure
1878
+ end
1879
+
1880
+ # The status of domain configuration option.
1881
+ # @!attribute [rw] creation_date
1882
+ # A timestamp for when this option was created.
1883
+ # @return [Time]
1884
+ #
1885
+ # @!attribute [rw] update_date
1886
+ # A timestamp for when this option was last updated.
1887
+ # @return [Time]
1888
+ #
1889
+ # @!attribute [rw] update_version
1890
+ # A unique integer that indicates when this option was last updated.
1891
+ # @return [Integer]
1892
+ #
1893
+ # @!attribute [rw] state
1894
+ # The state of processing a change to an option. Possible values:
1895
+ #
1896
+ # * `RequiresIndexDocuments`\: the option's latest value will not be
1897
+ # deployed until IndexDocuments has been called and indexing is
1898
+ # complete.
1899
+ # * `Processing`\: the option's latest value is in the process of
1900
+ # being activated.
1901
+ # * `Active`\: the option's latest value is completely deployed.
1902
+ # * `FailedToValidate`\: the option value is not compatible with the
1903
+ # domain's data and cannot be used to index the data. You must
1904
+ # either modify the option value or update or remove the
1905
+ # incompatible documents.
1906
+ # @return [String]
1907
+ #
1908
+ # @!attribute [rw] pending_deletion
1909
+ # Indicates that the option will be deleted once processing is
1910
+ # complete.
1911
+ # @return [Boolean]
1912
+ class OptionStatus < Struct.new(
1913
+ :creation_date,
1914
+ :update_date,
1915
+ :update_version,
1916
+ :state,
1917
+ :pending_deletion)
1918
+ include Aws::Structure
1919
+ end
1920
+
1921
+ # The desired instance type and desired number of replicas of each index
1922
+ # partition.
1923
+ # @note When making an API call, pass ScalingParameters
1924
+ # data as a hash:
1925
+ #
1926
+ # {
1927
+ # 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
1928
+ # desired_replication_count: 1,
1929
+ # desired_partition_count: 1,
1930
+ # }
1931
+ # @!attribute [rw] desired_instance_type
1932
+ # The instance type that you want to preconfigure for your domain. For
1933
+ # example, `search.m1.small`.
1934
+ # @return [String]
1935
+ #
1936
+ # @!attribute [rw] desired_replication_count
1937
+ # The number of replicas you want to preconfigure for each index
1938
+ # partition.
1939
+ # @return [Integer]
1940
+ #
1941
+ # @!attribute [rw] desired_partition_count
1942
+ # The number of partitions you want to preconfigure for your domain.
1943
+ # Only valid when you select `m2.2xlarge` as the desired instance
1944
+ # type.
1945
+ # @return [Integer]
1946
+ class ScalingParameters < Struct.new(
1947
+ :desired_instance_type,
1948
+ :desired_replication_count,
1949
+ :desired_partition_count)
1950
+ include Aws::Structure
1951
+ end
1952
+
1953
+ # The status and configuration of a search domain's scaling parameters.
1954
+ # @!attribute [rw] options
1955
+ # The desired instance type and desired number of replicas of each
1956
+ # index partition.
1957
+ # @return [Types::ScalingParameters]
1958
+ #
1959
+ # @!attribute [rw] status
1960
+ # The status of domain configuration option.
1961
+ # @return [Types::OptionStatus]
1962
+ class ScalingParametersStatus < Struct.new(
1963
+ :options,
1964
+ :status)
1965
+ include Aws::Structure
1966
+ end
1967
+
1968
+ # The endpoint to which service requests can be submitted.
1969
+ # @!attribute [rw] endpoint
1970
+ # The endpoint to which service requests can be submitted. For
1971
+ # example,
1972
+ # `search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com`
1973
+ # or
1974
+ # `doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com`.
1975
+ # @return [String]
1976
+ class ServiceEndpoint < Struct.new(
1977
+ :endpoint)
1978
+ include Aws::Structure
1979
+ end
1980
+
1981
+ # Configuration information for a search suggester. Each suggester has a
1982
+ # unique name and specifies the text field you want to use for
1983
+ # suggestions. The following options can be configured for a suggester:
1984
+ # `FuzzyMatching`, `SortExpression`.
1985
+ # @note When making an API call, pass Suggester
1986
+ # data as a hash:
1987
+ #
1988
+ # {
1989
+ # suggester_name: "StandardName", # required
1990
+ # document_suggester_options: { # required
1991
+ # source_field: "FieldName", # required
1992
+ # fuzzy_matching: "none", # accepts none, low, high
1993
+ # sort_expression: "String",
1994
+ # },
1995
+ # }
1996
+ # @!attribute [rw] suggester_name
1997
+ # Names must begin with a letter and can contain the following
1998
+ # characters: a-z (lowercase), 0-9, and \_ (underscore).
1999
+ # @return [String]
2000
+ #
2001
+ # @!attribute [rw] document_suggester_options
2002
+ # Options for a search suggester.
2003
+ # @return [Types::DocumentSuggesterOptions]
2004
+ class Suggester < Struct.new(
2005
+ :suggester_name,
2006
+ :document_suggester_options)
2007
+ include Aws::Structure
2008
+ end
2009
+
2010
+ # The value of a `Suggester` and its current status.
2011
+ # @!attribute [rw] options
2012
+ # Configuration information for a search suggester. Each suggester has
2013
+ # a unique name and specifies the text field you want to use for
2014
+ # suggestions. The following options can be configured for a
2015
+ # suggester: `FuzzyMatching`, `SortExpression`.
2016
+ # @return [Types::Suggester]
2017
+ #
2018
+ # @!attribute [rw] status
2019
+ # The status of domain configuration option.
2020
+ # @return [Types::OptionStatus]
2021
+ class SuggesterStatus < Struct.new(
2022
+ :options,
2023
+ :status)
2024
+ include Aws::Structure
2025
+ end
2026
+
2027
+ # Options for a field that contains an array of text strings. Present if
2028
+ # `IndexFieldType` specifies the field is of type `text-array`. A
2029
+ # `text-array` field is always searchable. All options are enabled by
2030
+ # default.
2031
+ # @note When making an API call, pass TextArrayOptions
2032
+ # data as a hash:
2033
+ #
2034
+ # {
2035
+ # default_value: "FieldValue",
2036
+ # source_fields: "FieldNameCommaList",
2037
+ # return_enabled: false,
2038
+ # highlight_enabled: false,
2039
+ # analysis_scheme: "Word",
2040
+ # }
2041
+ # @!attribute [rw] default_value
2042
+ # A value to use for the field if the field isn't specified for a
2043
+ # document.
2044
+ # @return [String]
2045
+ #
2046
+ # @!attribute [rw] source_fields
2047
+ # A list of source fields to map to the field.
2048
+ # @return [String]
2049
+ #
2050
+ # @!attribute [rw] return_enabled
2051
+ # Whether the contents of the field can be returned in the search
2052
+ # results.
2053
+ # @return [Boolean]
2054
+ #
2055
+ # @!attribute [rw] highlight_enabled
2056
+ # Whether highlights can be returned for the field.
2057
+ # @return [Boolean]
2058
+ #
2059
+ # @!attribute [rw] analysis_scheme
2060
+ # The name of an analysis scheme for a `text-array` field.
2061
+ # @return [String]
2062
+ class TextArrayOptions < Struct.new(
2063
+ :default_value,
2064
+ :source_fields,
2065
+ :return_enabled,
2066
+ :highlight_enabled,
2067
+ :analysis_scheme)
2068
+ include Aws::Structure
2069
+ end
2070
+
2071
+ # Options for text field. Present if `IndexFieldType` specifies the
2072
+ # field is of type `text`. A `text` field is always searchable. All
2073
+ # options are enabled by default.
2074
+ # @note When making an API call, pass TextOptions
2075
+ # data as a hash:
2076
+ #
2077
+ # {
2078
+ # default_value: "FieldValue",
2079
+ # source_field: "FieldName",
2080
+ # return_enabled: false,
2081
+ # sort_enabled: false,
2082
+ # highlight_enabled: false,
2083
+ # analysis_scheme: "Word",
2084
+ # }
2085
+ # @!attribute [rw] default_value
2086
+ # A value to use for the field if the field isn't specified for a
2087
+ # document.
2088
+ # @return [String]
2089
+ #
2090
+ # @!attribute [rw] source_field
2091
+ # A string that represents the name of an index field. CloudSearch
2092
+ # supports regular index fields as well as dynamic fields. A dynamic
2093
+ # field's name defines a pattern that begins or ends with a wildcard.
2094
+ # Any document fields that don't map to a regular index field but do
2095
+ # match a dynamic field's pattern are configured with the dynamic
2096
+ # field's indexing options.
2097
+ #
2098
+ # Regular field names begin with a letter and can contain the
2099
+ # following characters: a-z (lowercase), 0-9, and \_ (underscore).
2100
+ # Dynamic field names must begin or end with a wildcard (*). The
2101
+ # wildcard can also be the only character in a dynamic field name.
2102
+ # Multiple wildcards, and wildcards embedded within a string are not
2103
+ # supported.
2104
+ #
2105
+ # The name `score` is reserved and cannot be used as a field name. To
2106
+ # reference a document's ID, you can use the name `_id`.
2107
+ # @return [String]
2108
+ #
2109
+ # @!attribute [rw] return_enabled
2110
+ # Whether the contents of the field can be returned in the search
2111
+ # results.
2112
+ # @return [Boolean]
2113
+ #
2114
+ # @!attribute [rw] sort_enabled
2115
+ # Whether the field can be used to sort the search results.
2116
+ # @return [Boolean]
2117
+ #
2118
+ # @!attribute [rw] highlight_enabled
2119
+ # Whether highlights can be returned for the field.
2120
+ # @return [Boolean]
2121
+ #
2122
+ # @!attribute [rw] analysis_scheme
2123
+ # The name of an analysis scheme for a `text` field.
2124
+ # @return [String]
2125
+ class TextOptions < Struct.new(
2126
+ :default_value,
2127
+ :source_field,
2128
+ :return_enabled,
2129
+ :sort_enabled,
2130
+ :highlight_enabled,
2131
+ :analysis_scheme)
2132
+ include Aws::Structure
2133
+ end
2134
+
2135
+ # Container for the parameters to the `UpdateAvailabilityOptions`
2136
+ # operation. Specifies the name of the domain you want to update and the
2137
+ # Multi-AZ availability option.
2138
+ # @note When making an API call, pass UpdateAvailabilityOptionsRequest
2139
+ # data as a hash:
2140
+ #
2141
+ # {
2142
+ # domain_name: "DomainName", # required
2143
+ # multi_az: false, # required
2144
+ # }
2145
+ # @!attribute [rw] domain_name
2146
+ # A string that represents the name of a domain. Domain names are
2147
+ # unique across the domains owned by an account within an AWS region.
2148
+ # Domain names start with a letter or number and can contain the
2149
+ # following characters: a-z (lowercase), 0-9, and - (hyphen).
2150
+ # @return [String]
2151
+ #
2152
+ # @!attribute [rw] multi_az
2153
+ # You expand an existing search domain to a second Availability Zone
2154
+ # by setting the Multi-AZ option to true. Similarly, you can turn off
2155
+ # the Multi-AZ option to downgrade the domain to a single Availability
2156
+ # Zone by setting the Multi-AZ option to `false`.
2157
+ # @return [Boolean]
2158
+ class UpdateAvailabilityOptionsRequest < Struct.new(
2159
+ :domain_name,
2160
+ :multi_az)
2161
+ include Aws::Structure
2162
+ end
2163
+
2164
+ # The result of a `UpdateAvailabilityOptions` request. Contains the
2165
+ # status of the domain's availability options.
2166
+ # @!attribute [rw] availability_options
2167
+ # The newly-configured availability options. Indicates whether
2168
+ # Multi-AZ is enabled for the domain.
2169
+ # @return [Types::AvailabilityOptionsStatus]
2170
+ class UpdateAvailabilityOptionsResponse < Struct.new(
2171
+ :availability_options)
2172
+ include Aws::Structure
2173
+ end
2174
+
2175
+ # Container for the parameters to the `UpdateScalingParameters`
2176
+ # operation. Specifies the name of the domain you want to update and the
2177
+ # scaling parameters you want to configure.
2178
+ # @note When making an API call, pass UpdateScalingParametersRequest
2179
+ # data as a hash:
2180
+ #
2181
+ # {
2182
+ # domain_name: "DomainName", # required
2183
+ # scaling_parameters: { # required
2184
+ # 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
2185
+ # desired_replication_count: 1,
2186
+ # desired_partition_count: 1,
2187
+ # },
2188
+ # }
2189
+ # @!attribute [rw] domain_name
2190
+ # A string that represents the name of a domain. Domain names are
2191
+ # unique across the domains owned by an account within an AWS region.
2192
+ # Domain names start with a letter or number and can contain the
2193
+ # following characters: a-z (lowercase), 0-9, and - (hyphen).
2194
+ # @return [String]
2195
+ #
2196
+ # @!attribute [rw] scaling_parameters
2197
+ # The desired instance type and desired number of replicas of each
2198
+ # index partition.
2199
+ # @return [Types::ScalingParameters]
2200
+ class UpdateScalingParametersRequest < Struct.new(
2201
+ :domain_name,
2202
+ :scaling_parameters)
2203
+ include Aws::Structure
2204
+ end
2205
+
2206
+ # The result of a `UpdateScalingParameters` request. Contains the status
2207
+ # of the newly-configured scaling parameters.
2208
+ # @!attribute [rw] scaling_parameters
2209
+ # The status and configuration of a search domain's scaling
2210
+ # parameters.
2211
+ # @return [Types::ScalingParametersStatus]
2212
+ class UpdateScalingParametersResponse < Struct.new(
2213
+ :scaling_parameters)
2214
+ include Aws::Structure
2215
+ end
2216
+
2217
+ # Container for the parameters to the `UpdateServiceAccessPolicies`
2218
+ # operation. Specifies the name of the domain you want to update and the
2219
+ # access rules you want to configure.
2220
+ # @note When making an API call, pass UpdateServiceAccessPoliciesRequest
2221
+ # data as a hash:
2222
+ #
2223
+ # {
2224
+ # domain_name: "DomainName", # required
2225
+ # access_policies: "PolicyDocument", # required
2226
+ # }
2227
+ # @!attribute [rw] domain_name
2228
+ # A string that represents the name of a domain. Domain names are
2229
+ # unique across the domains owned by an account within an AWS region.
2230
+ # Domain names start with a letter or number and can contain the
2231
+ # following characters: a-z (lowercase), 0-9, and - (hyphen).
2232
+ # @return [String]
2233
+ #
2234
+ # @!attribute [rw] access_policies
2235
+ # The access rules you want to configure. These rules replace any
2236
+ # existing rules.
2237
+ # @return [String]
2238
+ class UpdateServiceAccessPoliciesRequest < Struct.new(
2239
+ :domain_name,
2240
+ :access_policies)
2241
+ include Aws::Structure
2242
+ end
2243
+
2244
+ # The result of an `UpdateServiceAccessPolicies` request. Contains the
2245
+ # new access policies.
2246
+ # @!attribute [rw] access_policies
2247
+ # The access rules configured for the domain.
2248
+ # @return [Types::AccessPoliciesStatus]
2249
+ class UpdateServiceAccessPoliciesResponse < Struct.new(
2250
+ :access_policies)
2251
+ include Aws::Structure
2252
+ end
2253
+
2254
+ end
2255
+ end
2256
+ end