@aws-sdk/client-cloudsearch 3.379.1 → 3.382.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -8,10 +8,12 @@ export declare class BaseException extends __BaseException {
8
8
  readonly name: "BaseException";
9
9
  readonly $fault: "client";
10
10
  /**
11
+ * @public
11
12
  * <p>A machine-parsable string error or warning code.</p>
12
13
  */
13
14
  Code?: string;
14
15
  /**
16
+ * @public
15
17
  * <p>A human-readable string error or warning message.</p>
16
18
  */
17
19
  Message?: string;
@@ -26,6 +28,7 @@ export declare class BaseException extends __BaseException {
26
28
  */
27
29
  export interface BuildSuggestersRequest {
28
30
  /**
31
+ * @public
29
32
  * <p>A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>
30
33
  */
31
34
  DomainName: string | undefined;
@@ -36,6 +39,7 @@ export interface BuildSuggestersRequest {
36
39
  */
37
40
  export interface BuildSuggestersResponse {
38
41
  /**
42
+ * @public
39
43
  * <p>A list of field names.</p>
40
44
  */
41
45
  FieldNames?: string[];
@@ -49,10 +53,12 @@ export declare class InternalException extends __BaseException {
49
53
  readonly name: "InternalException";
50
54
  readonly $fault: "server";
51
55
  /**
56
+ * @public
52
57
  * <p>A machine-parsable string error or warning code.</p>
53
58
  */
54
59
  Code?: string;
55
60
  /**
61
+ * @public
56
62
  * <p>A human-readable string error or warning message.</p>
57
63
  */
58
64
  Message?: string;
@@ -69,10 +75,12 @@ export declare class ResourceNotFoundException extends __BaseException {
69
75
  readonly name: "ResourceNotFoundException";
70
76
  readonly $fault: "client";
71
77
  /**
78
+ * @public
72
79
  * <p>A machine-parsable string error or warning code.</p>
73
80
  */
74
81
  Code?: string;
75
82
  /**
83
+ * @public
76
84
  * <p>A human-readable string error or warning message.</p>
77
85
  */
78
86
  Message?: string;
@@ -89,10 +97,12 @@ export declare class ValidationException extends __BaseException {
89
97
  readonly name: "ValidationException";
90
98
  readonly $fault: "client";
91
99
  /**
100
+ * @public
92
101
  * <p>A machine-parsable string error or warning code.</p>
93
102
  */
94
103
  Code?: string;
95
104
  /**
105
+ * @public
96
106
  * <p>A human-readable string error or warning message.</p>
97
107
  */
98
108
  Message?: string;
@@ -107,6 +117,7 @@ export declare class ValidationException extends __BaseException {
107
117
  */
108
118
  export interface CreateDomainRequest {
109
119
  /**
120
+ * @public
110
121
  * <p>A name for the domain you are creating. Allowed characters are a-z (lower-case letters), 0-9, and hyphen (-). Domain names must start with a letter or number and be at least 3 and no more than 28 characters long.</p>
111
122
  */
112
123
  DomainName: string | undefined;
@@ -117,6 +128,7 @@ export interface CreateDomainRequest {
117
128
  */
118
129
  export interface ServiceEndpoint {
119
130
  /**
131
+ * @public
120
132
  * <p>The endpoint to which service requests can be submitted. For example, <code>search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com</code> or <code>doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com</code>.</p>
121
133
  */
122
134
  Endpoint?: string;
@@ -134,50 +146,62 @@ export interface Limits {
134
146
  */
135
147
  export interface DomainStatus {
136
148
  /**
149
+ * @public
137
150
  * <p>An internally generated unique identifier for a domain.</p>
138
151
  */
139
152
  DomainId: string | undefined;
140
153
  /**
154
+ * @public
141
155
  * <p>A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>
142
156
  */
143
157
  DomainName: string | undefined;
144
158
  /**
159
+ * @public
145
160
  * <p>The Amazon Resource Name (ARN) of the search domain. See <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html" target="_blank">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access Management</i> for more information.</p>
146
161
  */
147
162
  ARN?: string;
148
163
  /**
164
+ * @public
149
165
  * <p>True if the search domain is created. It can take several minutes to initialize a domain when <a>CreateDomain</a> is called. Newly created search domains are returned from <a>DescribeDomains</a> with a false value for Created until domain creation is complete.</p>
150
166
  */
151
167
  Created?: boolean;
152
168
  /**
169
+ * @public
153
170
  * <p>True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when <a>DeleteDomain</a> is called. Newly deleted search domains are returned from <a>DescribeDomains</a> with a true value for IsDeleted for several minutes until resource cleanup is complete.</p>
154
171
  */
155
172
  Deleted?: boolean;
156
173
  /**
174
+ * @public
157
175
  * <p>The service endpoint for updating documents in a search domain.</p>
158
176
  */
159
177
  DocService?: ServiceEndpoint;
160
178
  /**
179
+ * @public
161
180
  * <p>The service endpoint for requesting search results from a search domain.</p>
162
181
  */
163
182
  SearchService?: ServiceEndpoint;
164
183
  /**
184
+ * @public
165
185
  * <p>True if <a>IndexDocuments</a> needs to be called to activate the current domain configuration.</p>
166
186
  */
167
187
  RequiresIndexDocuments: boolean | undefined;
168
188
  /**
189
+ * @public
169
190
  * <p>True if processing is being done to activate the current domain configuration.</p>
170
191
  */
171
192
  Processing?: boolean;
172
193
  /**
194
+ * @public
173
195
  * <p>The instance type that is being used to process search requests.</p>
174
196
  */
175
197
  SearchInstanceType?: string;
176
198
  /**
199
+ * @public
177
200
  * <p>The number of partitions across which the search index is spread.</p>
178
201
  */
179
202
  SearchPartitionCount?: number;
180
203
  /**
204
+ * @public
181
205
  * <p>The number of search instances that are available to process search requests.</p>
182
206
  */
183
207
  SearchInstanceCount?: number;
@@ -189,6 +213,7 @@ export interface DomainStatus {
189
213
  */
190
214
  export interface CreateDomainResponse {
191
215
  /**
216
+ * @public
192
217
  * <p>The current status of the search domain.</p>
193
218
  */
194
219
  DomainStatus?: DomainStatus;
@@ -201,10 +226,12 @@ export declare class LimitExceededException extends __BaseException {
201
226
  readonly name: "LimitExceededException";
202
227
  readonly $fault: "client";
203
228
  /**
229
+ * @public
204
230
  * <p>A machine-parsable string error or warning code.</p>
205
231
  */
206
232
  Code?: string;
207
233
  /**
234
+ * @public
208
235
  * <p>A human-readable string error or warning message.</p>
209
236
  */
210
237
  Message?: string;
@@ -221,10 +248,12 @@ export declare class ResourceAlreadyExistsException extends __BaseException {
221
248
  readonly name: "ResourceAlreadyExistsException";
222
249
  readonly $fault: "client";
223
250
  /**
251
+ * @public
224
252
  * <p>A machine-parsable string error or warning code.</p>
225
253
  */
226
254
  Code?: string;
227
255
  /**
256
+ * @public
228
257
  * <p>A human-readable string error or warning message.</p>
229
258
  */
230
259
  Message?: string;
@@ -243,22 +272,27 @@ export type AlgorithmicStemming = "full" | "light" | "minimal" | "none";
243
272
  */
244
273
  export interface AnalysisOptions {
245
274
  /**
275
+ * @public
246
276
  * <p>A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html#synonyms">Synonyms</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>
247
277
  */
248
278
  Synonyms?: string;
249
279
  /**
280
+ * @public
250
281
  * <p>A JSON array of terms to ignore during indexing and searching. For example, <code>["a", "an", "the", "of"]</code>. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported. </p>
251
282
  */
252
283
  Stopwords?: string;
253
284
  /**
285
+ * @public
254
286
  * <p>A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, <code>\{"term1": "stem1", "term2": "stem2", "term3": "stem3"\}</code>. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.</p>
255
287
  */
256
288
  StemmingDictionary?: string;
257
289
  /**
290
+ * @public
258
291
  * <p>A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton. The Japanese tokenization dictionary enables you to override the default tokenization for selected terms. This is only valid for Japanese language fields.</p>
259
292
  */
260
293
  JapaneseTokenizationDictionary?: string;
261
294
  /**
295
+ * @public
262
296
  * <p>The level of algorithmic stemming to perform: <code>none</code>, <code>minimal</code>, <code>light</code>, or <code>full</code>. The available levels vary depending on the language. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/text-processing.html#text-processing-settings" target="_blank">Language Specific Text Processing Settings</a> in the <i>Amazon CloudSearch Developer Guide</i> </p>
263
297
  */
264
298
  AlgorithmicStemming?: AlgorithmicStemming | string;
@@ -273,15 +307,18 @@ export type AnalysisSchemeLanguage = "ar" | "bg" | "ca" | "cs" | "da" | "de" | "
273
307
  */
274
308
  export interface AnalysisScheme {
275
309
  /**
310
+ * @public
276
311
  * <p>Names must begin with a letter and can contain the following characters:
277
312
  * a-z (lowercase), 0-9, and _ (underscore).</p>
278
313
  */
279
314
  AnalysisSchemeName: string | undefined;
280
315
  /**
316
+ * @public
281
317
  * <p>An <a href="http://tools.ietf.org/html/rfc4646" target="_blank">IETF RFC 4646</a> language code or <code>mul</code> for multiple languages.</p>
282
318
  */
283
319
  AnalysisSchemeLanguage: AnalysisSchemeLanguage | string | undefined;
284
320
  /**
321
+ * @public
285
322
  * <p>Synonyms, stopwords, and stemming options for an analysis scheme. Includes tokenization dictionary for Japanese.</p>
286
323
  */
287
324
  AnalysisOptions?: AnalysisOptions;
@@ -292,10 +329,12 @@ export interface AnalysisScheme {
292
329
  */
293
330
  export interface DefineAnalysisSchemeRequest {
294
331
  /**
332
+ * @public
295
333
  * <p>A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>
296
334
  */
297
335
  DomainName: string | undefined;
298
336
  /**
337
+ * @public
299
338
  * <p>Configuration information for an analysis scheme. Each analysis scheme has a unique name and specifies the language of the text to be processed. The following options can be configured for an analysis scheme: <code>Synonyms</code>, <code>Stopwords</code>, <code>StemmingDictionary</code>, <code>JapaneseTokenizationDictionary</code> and <code>AlgorithmicStemming</code>.</p>
300
339
  */
301
340
  AnalysisScheme: AnalysisScheme | undefined;
@@ -310,18 +349,22 @@ export type OptionState = "Active" | "FailedToValidate" | "Processing" | "Requir
310
349
  */
311
350
  export interface OptionStatus {
312
351
  /**
352
+ * @public
313
353
  * <p>A timestamp for when this option was created.</p>
314
354
  */
315
355
  CreationDate: Date | undefined;
316
356
  /**
357
+ * @public
317
358
  * <p>A timestamp for when this option was last updated.</p>
318
359
  */
319
360
  UpdateDate: Date | undefined;
320
361
  /**
362
+ * @public
321
363
  * <p>A unique integer that indicates when this option was last updated.</p>
322
364
  */
323
365
  UpdateVersion?: number;
324
366
  /**
367
+ * @public
325
368
  * <p>The state of processing a change to an option. Possible values:</p><ul>
326
369
  * <li><code>RequiresIndexDocuments</code>: the option's latest value will not be deployed until <a>IndexDocuments</a> has been called and indexing is complete.</li>
327
370
  * <li><code>Processing</code>: the option's latest value is in the process of being activated. </li>
@@ -331,6 +374,7 @@ export interface OptionStatus {
331
374
  */
332
375
  State: OptionState | string | undefined;
333
376
  /**
377
+ * @public
334
378
  * <p>Indicates that the option will be deleted once processing is complete.</p>
335
379
  */
336
380
  PendingDeletion?: boolean;
@@ -341,10 +385,12 @@ export interface OptionStatus {
341
385
  */
342
386
  export interface AnalysisSchemeStatus {
343
387
  /**
388
+ * @public
344
389
  * <p>Configuration information for an analysis scheme. Each analysis scheme has a unique name and specifies the language of the text to be processed. The following options can be configured for an analysis scheme: <code>Synonyms</code>, <code>Stopwords</code>, <code>StemmingDictionary</code>, <code>JapaneseTokenizationDictionary</code> and <code>AlgorithmicStemming</code>.</p>
345
390
  */
346
391
  Options: AnalysisScheme | undefined;
347
392
  /**
393
+ * @public
348
394
  * <p>The status of domain configuration option.</p>
349
395
  */
350
396
  Status: OptionStatus | undefined;
@@ -355,6 +401,7 @@ export interface AnalysisSchemeStatus {
355
401
  */
356
402
  export interface DefineAnalysisSchemeResponse {
357
403
  /**
404
+ * @public
358
405
  * <p>The status and configuration of an <code>AnalysisScheme</code>.</p>
359
406
  */
360
407
  AnalysisScheme: AnalysisSchemeStatus | undefined;
@@ -367,10 +414,12 @@ export declare class InvalidTypeException extends __BaseException {
367
414
  readonly name: "InvalidTypeException";
368
415
  readonly $fault: "client";
369
416
  /**
417
+ * @public
370
418
  * <p>A machine-parsable string error or warning code.</p>
371
419
  */
372
420
  Code?: string;
373
421
  /**
422
+ * @public
374
423
  * <p>A human-readable string error or warning message.</p>
375
424
  */
376
425
  Message?: string;
@@ -385,11 +434,13 @@ export declare class InvalidTypeException extends __BaseException {
385
434
  */
386
435
  export interface Expression {
387
436
  /**
437
+ * @public
388
438
  * <p>Names must begin with a letter and can contain the following characters:
389
439
  * a-z (lowercase), 0-9, and _ (underscore).</p>
390
440
  */
391
441
  ExpressionName: string | undefined;
392
442
  /**
443
+ * @public
393
444
  * <p>The expression to evaluate for sorting while processing a search request. The <code>Expression</code> syntax is based on JavaScript expressions. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html" target="_blank">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>
394
445
  */
395
446
  ExpressionValue: string | undefined;
@@ -400,10 +451,12 @@ export interface Expression {
400
451
  */
401
452
  export interface DefineExpressionRequest {
402
453
  /**
454
+ * @public
403
455
  * <p>A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>
404
456
  */
405
457
  DomainName: string | undefined;
406
458
  /**
459
+ * @public
407
460
  * <p>A named expression that can be evaluated at search time. Can be used to sort the search results, define other expressions, or return computed information in the search results. </p>
408
461
  */
409
462
  Expression: Expression | undefined;
@@ -414,10 +467,12 @@ export interface DefineExpressionRequest {
414
467
  */
415
468
  export interface ExpressionStatus {
416
469
  /**
470
+ * @public
417
471
  * <p>The expression that is evaluated for sorting while processing a search request.</p>
418
472
  */
419
473
  Options: Expression | undefined;
420
474
  /**
475
+ * @public
421
476
  * <p>The status of domain configuration option.</p>
422
477
  */
423
478
  Status: OptionStatus | undefined;
@@ -428,6 +483,7 @@ export interface ExpressionStatus {
428
483
  */
429
484
  export interface DefineExpressionResponse {
430
485
  /**
486
+ * @public
431
487
  * <p>The value of an <code>Expression</code> and its current status.</p>
432
488
  */
433
489
  Expression: ExpressionStatus | undefined;
@@ -438,22 +494,27 @@ export interface DefineExpressionResponse {
438
494
  */
439
495
  export interface DateArrayOptions {
440
496
  /**
497
+ * @public
441
498
  * A value to use for the field if the field isn't specified for a document.
442
499
  */
443
500
  DefaultValue?: string;
444
501
  /**
502
+ * @public
445
503
  * <p>A list of source fields to map to the field. </p>
446
504
  */
447
505
  SourceFields?: string;
448
506
  /**
507
+ * @public
449
508
  * <p>Whether facet information can be returned for the field.</p>
450
509
  */
451
510
  FacetEnabled?: boolean;
452
511
  /**
512
+ * @public
453
513
  * <p>Whether the contents of the field are searchable.</p>
454
514
  */
455
515
  SearchEnabled?: boolean;
456
516
  /**
517
+ * @public
457
518
  * <p>Whether the contents of the field can be returned in the search results.</p>
458
519
  */
459
520
  ReturnEnabled?: boolean;
@@ -464,10 +525,12 @@ export interface DateArrayOptions {
464
525
  */
465
526
  export interface DateOptions {
466
527
  /**
528
+ * @public
467
529
  * A value to use for the field if the field isn't specified for a document.
468
530
  */
469
531
  DefaultValue?: string;
470
532
  /**
533
+ * @public
471
534
  * <p>A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields.
472
535
  * A dynamic field's name defines a pattern that begins or ends with a wildcard.
473
536
  * Any document fields that don't map to a regular index field but do match a
@@ -485,18 +548,22 @@ export interface DateOptions {
485
548
  */
486
549
  SourceField?: string;
487
550
  /**
551
+ * @public
488
552
  * <p>Whether facet information can be returned for the field.</p>
489
553
  */
490
554
  FacetEnabled?: boolean;
491
555
  /**
556
+ * @public
492
557
  * <p>Whether the contents of the field are searchable.</p>
493
558
  */
494
559
  SearchEnabled?: boolean;
495
560
  /**
561
+ * @public
496
562
  * <p>Whether the contents of the field can be returned in the search results.</p>
497
563
  */
498
564
  ReturnEnabled?: boolean;
499
565
  /**
566
+ * @public
500
567
  * <p>Whether the field can be used to sort the search results.</p>
501
568
  */
502
569
  SortEnabled?: boolean;
@@ -507,22 +574,27 @@ export interface DateOptions {
507
574
  */
508
575
  export interface DoubleArrayOptions {
509
576
  /**
577
+ * @public
510
578
  * A value to use for the field if the field isn't specified for a document.
511
579
  */
512
580
  DefaultValue?: number;
513
581
  /**
582
+ * @public
514
583
  * <p>A list of source fields to map to the field. </p>
515
584
  */
516
585
  SourceFields?: string;
517
586
  /**
587
+ * @public
518
588
  * <p>Whether facet information can be returned for the field.</p>
519
589
  */
520
590
  FacetEnabled?: boolean;
521
591
  /**
592
+ * @public
522
593
  * <p>Whether the contents of the field are searchable.</p>
523
594
  */
524
595
  SearchEnabled?: boolean;
525
596
  /**
597
+ * @public
526
598
  * <p>Whether the contents of the field can be returned in the search results.</p>
527
599
  */
528
600
  ReturnEnabled?: boolean;
@@ -533,26 +605,32 @@ export interface DoubleArrayOptions {
533
605
  */
534
606
  export interface DoubleOptions {
535
607
  /**
608
+ * @public
536
609
  * <p>A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.</p>
537
610
  */
538
611
  DefaultValue?: number;
539
612
  /**
613
+ * @public
540
614
  * <p>The name of the source field to map to the field. </p>
541
615
  */
542
616
  SourceField?: string;
543
617
  /**
618
+ * @public
544
619
  * <p>Whether facet information can be returned for the field.</p>
545
620
  */
546
621
  FacetEnabled?: boolean;
547
622
  /**
623
+ * @public
548
624
  * <p>Whether the contents of the field are searchable.</p>
549
625
  */
550
626
  SearchEnabled?: boolean;
551
627
  /**
628
+ * @public
552
629
  * <p>Whether the contents of the field can be returned in the search results.</p>
553
630
  */
554
631
  ReturnEnabled?: boolean;
555
632
  /**
633
+ * @public
556
634
  * <p>Whether the field can be used to sort the search results.</p>
557
635
  */
558
636
  SortEnabled?: boolean;
@@ -567,22 +645,27 @@ export type IndexFieldType = "date" | "date-array" | "double" | "double-array" |
567
645
  */
568
646
  export interface IntArrayOptions {
569
647
  /**
648
+ * @public
570
649
  * A value to use for the field if the field isn't specified for a document.
571
650
  */
572
651
  DefaultValue?: number;
573
652
  /**
653
+ * @public
574
654
  * <p>A list of source fields to map to the field. </p>
575
655
  */
576
656
  SourceFields?: string;
577
657
  /**
658
+ * @public
578
659
  * <p>Whether facet information can be returned for the field.</p>
579
660
  */
580
661
  FacetEnabled?: boolean;
581
662
  /**
663
+ * @public
582
664
  * <p>Whether the contents of the field are searchable.</p>
583
665
  */
584
666
  SearchEnabled?: boolean;
585
667
  /**
668
+ * @public
586
669
  * <p>Whether the contents of the field can be returned in the search results.</p>
587
670
  */
588
671
  ReturnEnabled?: boolean;
@@ -593,26 +676,32 @@ export interface IntArrayOptions {
593
676
  */
594
677
  export interface IntOptions {
595
678
  /**
679
+ * @public
596
680
  * A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.
597
681
  */
598
682
  DefaultValue?: number;
599
683
  /**
684
+ * @public
600
685
  * <p>The name of the source field to map to the field. </p>
601
686
  */
602
687
  SourceField?: string;
603
688
  /**
689
+ * @public
604
690
  * <p>Whether facet information can be returned for the field.</p>
605
691
  */
606
692
  FacetEnabled?: boolean;
607
693
  /**
694
+ * @public
608
695
  * <p>Whether the contents of the field are searchable.</p>
609
696
  */
610
697
  SearchEnabled?: boolean;
611
698
  /**
699
+ * @public
612
700
  * <p>Whether the contents of the field can be returned in the search results.</p>
613
701
  */
614
702
  ReturnEnabled?: boolean;
615
703
  /**
704
+ * @public
616
705
  * <p>Whether the field can be used to sort the search results.</p>
617
706
  */
618
707
  SortEnabled?: boolean;
@@ -623,10 +712,12 @@ export interface IntOptions {
623
712
  */
624
713
  export interface LatLonOptions {
625
714
  /**
715
+ * @public
626
716
  * A value to use for the field if the field isn't specified for a document.
627
717
  */
628
718
  DefaultValue?: string;
629
719
  /**
720
+ * @public
630
721
  * <p>A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields.
631
722
  * A dynamic field's name defines a pattern that begins or ends with a wildcard.
632
723
  * Any document fields that don't map to a regular index field but do match a
@@ -644,18 +735,22 @@ export interface LatLonOptions {
644
735
  */
645
736
  SourceField?: string;
646
737
  /**
738
+ * @public
647
739
  * <p>Whether facet information can be returned for the field.</p>
648
740
  */
649
741
  FacetEnabled?: boolean;
650
742
  /**
743
+ * @public
651
744
  * <p>Whether the contents of the field are searchable.</p>
652
745
  */
653
746
  SearchEnabled?: boolean;
654
747
  /**
748
+ * @public
655
749
  * <p>Whether the contents of the field can be returned in the search results.</p>
656
750
  */
657
751
  ReturnEnabled?: boolean;
658
752
  /**
753
+ * @public
659
754
  * <p>Whether the field can be used to sort the search results.</p>
660
755
  */
661
756
  SortEnabled?: boolean;
@@ -666,22 +761,27 @@ export interface LatLonOptions {
666
761
  */
667
762
  export interface LiteralArrayOptions {
668
763
  /**
764
+ * @public
669
765
  * A value to use for the field if the field isn't specified for a document.
670
766
  */
671
767
  DefaultValue?: string;
672
768
  /**
769
+ * @public
673
770
  * <p>A list of source fields to map to the field. </p>
674
771
  */
675
772
  SourceFields?: string;
676
773
  /**
774
+ * @public
677
775
  * <p>Whether facet information can be returned for the field.</p>
678
776
  */
679
777
  FacetEnabled?: boolean;
680
778
  /**
779
+ * @public
681
780
  * <p>Whether the contents of the field are searchable.</p>
682
781
  */
683
782
  SearchEnabled?: boolean;
684
783
  /**
784
+ * @public
685
785
  * <p>Whether the contents of the field can be returned in the search results.</p>
686
786
  */
687
787
  ReturnEnabled?: boolean;
@@ -692,10 +792,12 @@ export interface LiteralArrayOptions {
692
792
  */
693
793
  export interface LiteralOptions {
694
794
  /**
795
+ * @public
695
796
  * A value to use for the field if the field isn't specified for a document.
696
797
  */
697
798
  DefaultValue?: string;
698
799
  /**
800
+ * @public
699
801
  * <p>A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields.
700
802
  * A dynamic field's name defines a pattern that begins or ends with a wildcard.
701
803
  * Any document fields that don't map to a regular index field but do match a
@@ -713,18 +815,22 @@ export interface LiteralOptions {
713
815
  */
714
816
  SourceField?: string;
715
817
  /**
818
+ * @public
716
819
  * <p>Whether facet information can be returned for the field.</p>
717
820
  */
718
821
  FacetEnabled?: boolean;
719
822
  /**
823
+ * @public
720
824
  * <p>Whether the contents of the field are searchable.</p>
721
825
  */
722
826
  SearchEnabled?: boolean;
723
827
  /**
828
+ * @public
724
829
  * <p>Whether the contents of the field can be returned in the search results.</p>
725
830
  */
726
831
  ReturnEnabled?: boolean;
727
832
  /**
833
+ * @public
728
834
  * <p>Whether the field can be used to sort the search results.</p>
729
835
  */
730
836
  SortEnabled?: boolean;
@@ -735,22 +841,27 @@ export interface LiteralOptions {
735
841
  */
736
842
  export interface TextArrayOptions {
737
843
  /**
844
+ * @public
738
845
  * A value to use for the field if the field isn't specified for a document.
739
846
  */
740
847
  DefaultValue?: string;
741
848
  /**
849
+ * @public
742
850
  * <p>A list of source fields to map to the field. </p>
743
851
  */
744
852
  SourceFields?: string;
745
853
  /**
854
+ * @public
746
855
  * <p>Whether the contents of the field can be returned in the search results.</p>
747
856
  */
748
857
  ReturnEnabled?: boolean;
749
858
  /**
859
+ * @public
750
860
  * <p>Whether highlights can be returned for the field.</p>
751
861
  */
752
862
  HighlightEnabled?: boolean;
753
863
  /**
864
+ * @public
754
865
  * <p>The name of an analysis scheme for a <code>text-array</code> field.</p>
755
866
  */
756
867
  AnalysisScheme?: string;
@@ -761,10 +872,12 @@ export interface TextArrayOptions {
761
872
  */
762
873
  export interface TextOptions {
763
874
  /**
875
+ * @public
764
876
  * A value to use for the field if the field isn't specified for a document.
765
877
  */
766
878
  DefaultValue?: string;
767
879
  /**
880
+ * @public
768
881
  * <p>A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields.
769
882
  * A dynamic field's name defines a pattern that begins or ends with a wildcard.
770
883
  * Any document fields that don't map to a regular index field but do match a
@@ -782,18 +895,22 @@ export interface TextOptions {
782
895
  */
783
896
  SourceField?: string;
784
897
  /**
898
+ * @public
785
899
  * <p>Whether the contents of the field can be returned in the search results.</p>
786
900
  */
787
901
  ReturnEnabled?: boolean;
788
902
  /**
903
+ * @public
789
904
  * <p>Whether the field can be used to sort the search results.</p>
790
905
  */
791
906
  SortEnabled?: boolean;
792
907
  /**
908
+ * @public
793
909
  * <p>Whether highlights can be returned for the field.</p>
794
910
  */
795
911
  HighlightEnabled?: boolean;
796
912
  /**
913
+ * @public
797
914
  * <p>The name of an analysis scheme for a <code>text</code> field.</p>
798
915
  */
799
916
  AnalysisScheme?: string;
@@ -804,6 +921,7 @@ export interface TextOptions {
804
921
  */
805
922
  export interface IndexField {
806
923
  /**
924
+ * @public
807
925
  * <p>A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields.
808
926
  * A dynamic field's name defines a pattern that begins or ends with a wildcard.
809
927
  * Any document fields that don't map to a regular index field but do match a
@@ -821,50 +939,62 @@ export interface IndexField {
821
939
  */
822
940
  IndexFieldName: string | undefined;
823
941
  /**
942
+ * @public
824
943
  * <p>The type of field. The valid options for a field depend on the field type. For more information about the supported field types, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html" target="_blank">Configuring Index Fields</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>
825
944
  */
826
945
  IndexFieldType: IndexFieldType | string | undefined;
827
946
  /**
947
+ * @public
828
948
  * <p>Options for a 64-bit signed integer field. Present if <code>IndexFieldType</code> specifies the field is of type <code>int</code>. All options are enabled by default.</p>
829
949
  */
830
950
  IntOptions?: IntOptions;
831
951
  /**
952
+ * @public
832
953
  * <p>Options for a double-precision 64-bit floating point field. Present if <code>IndexFieldType</code> specifies the field is of type <code>double</code>. All options are enabled by default.</p>
833
954
  */
834
955
  DoubleOptions?: DoubleOptions;
835
956
  /**
957
+ * @public
836
958
  * <p>Options for literal field. Present if <code>IndexFieldType</code> specifies the field is of type <code>literal</code>. All options are enabled by default.</p>
837
959
  */
838
960
  LiteralOptions?: LiteralOptions;
839
961
  /**
962
+ * @public
840
963
  * <p>Options for text field. Present if <code>IndexFieldType</code> specifies the field is of type <code>text</code>. A <code>text</code> field is always searchable. All options are enabled by default.</p>
841
964
  */
842
965
  TextOptions?: TextOptions;
843
966
  /**
967
+ * @public
844
968
  * <p>Options for a date field. Dates and times are specified in UTC (Coordinated Universal Time) according to IETF RFC3339: yyyy-mm-ddT00:00:00Z. Present if <code>IndexFieldType</code> specifies the field is of type <code>date</code>. All options are enabled by default.</p>
845
969
  */
846
970
  DateOptions?: DateOptions;
847
971
  /**
972
+ * @public
848
973
  * <p>Options for a latlon field. A latlon field contains a location stored as a latitude and longitude value pair. Present if <code>IndexFieldType</code> specifies the field is of type <code>latlon</code>. All options are enabled by default.</p>
849
974
  */
850
975
  LatLonOptions?: LatLonOptions;
851
976
  /**
977
+ * @public
852
978
  * <p>Options for a field that contains an array of 64-bit signed integers. Present if <code>IndexFieldType</code> specifies the field is of type <code>int-array</code>. All options are enabled by default.</p>
853
979
  */
854
980
  IntArrayOptions?: IntArrayOptions;
855
981
  /**
982
+ * @public
856
983
  * <p>Options for a field that contains an array of double-precision 64-bit floating point values. Present if <code>IndexFieldType</code> specifies the field is of type <code>double-array</code>. All options are enabled by default.</p>
857
984
  */
858
985
  DoubleArrayOptions?: DoubleArrayOptions;
859
986
  /**
987
+ * @public
860
988
  * <p>Options for a field that contains an array of literal strings. Present if <code>IndexFieldType</code> specifies the field is of type <code>literal-array</code>. All options are enabled by default.</p>
861
989
  */
862
990
  LiteralArrayOptions?: LiteralArrayOptions;
863
991
  /**
992
+ * @public
864
993
  * <p>Options for a field that contains an array of text strings. Present if <code>IndexFieldType</code> specifies the field is of type <code>text-array</code>. A <code>text-array</code> field is always searchable. All options are enabled by default.</p>
865
994
  */
866
995
  TextArrayOptions?: TextArrayOptions;
867
996
  /**
997
+ * @public
868
998
  * <p>Options for a field that contains an array of dates. Present if <code>IndexFieldType</code> specifies the field is of type <code>date-array</code>. All options are enabled by default.</p>
869
999
  */
870
1000
  DateArrayOptions?: DateArrayOptions;
@@ -875,10 +1005,12 @@ export interface IndexField {
875
1005
  */
876
1006
  export interface DefineIndexFieldRequest {
877
1007
  /**
1008
+ * @public
878
1009
  * <p>A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>
879
1010
  */
880
1011
  DomainName: string | undefined;
881
1012
  /**
1013
+ * @public
882
1014
  * <p>The index field and field options you want to configure. </p>
883
1015
  */
884
1016
  IndexField: IndexField | undefined;
@@ -889,10 +1021,12 @@ export interface DefineIndexFieldRequest {
889
1021
  */
890
1022
  export interface IndexFieldStatus {
891
1023
  /**
1024
+ * @public
892
1025
  * <p>Configuration information for a field in the index, including its name, type, and options. The supported options depend on the <code><a>IndexFieldType</a></code>.</p>
893
1026
  */
894
1027
  Options: IndexField | undefined;
895
1028
  /**
1029
+ * @public
896
1030
  * <p>The status of domain configuration option.</p>
897
1031
  */
898
1032
  Status: OptionStatus | undefined;
@@ -903,6 +1037,7 @@ export interface IndexFieldStatus {
903
1037
  */
904
1038
  export interface DefineIndexFieldResponse {
905
1039
  /**
1040
+ * @public
906
1041
  * <p>The value of an <code>IndexField</code> and its current status.</p>
907
1042
  */
908
1043
  IndexField: IndexFieldStatus | undefined;
@@ -917,15 +1052,18 @@ export type SuggesterFuzzyMatching = "high" | "low" | "none";
917
1052
  */
918
1053
  export interface DocumentSuggesterOptions {
919
1054
  /**
1055
+ * @public
920
1056
  * <p>The name of the index field you want to use for suggestions.
921
1057
  * </p>
922
1058
  */
923
1059
  SourceField: string | undefined;
924
1060
  /**
1061
+ * @public
925
1062
  * <p>The level of fuzziness allowed when suggesting matches for a string: <code>none</code>, <code>low</code>, or <code>high</code>. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none. </p>
926
1063
  */
927
1064
  FuzzyMatching?: SuggesterFuzzyMatching | string;
928
1065
  /**
1066
+ * @public
929
1067
  * <p>An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest
930
1068
  * integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed
931
1069
  * for suggestions, so sort expressions cannot reference the <code>_score</code> value.
@@ -941,11 +1079,13 @@ export interface DocumentSuggesterOptions {
941
1079
  */
942
1080
  export interface Suggester {
943
1081
  /**
1082
+ * @public
944
1083
  * <p>Names must begin with a letter and can contain the following characters:
945
1084
  * a-z (lowercase), 0-9, and _ (underscore).</p>
946
1085
  */
947
1086
  SuggesterName: string | undefined;
948
1087
  /**
1088
+ * @public
949
1089
  * <p>Options for a search suggester.</p>
950
1090
  */
951
1091
  DocumentSuggesterOptions: DocumentSuggesterOptions | undefined;
@@ -956,10 +1096,12 @@ export interface Suggester {
956
1096
  */
957
1097
  export interface DefineSuggesterRequest {
958
1098
  /**
1099
+ * @public
959
1100
  * <p>A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>
960
1101
  */
961
1102
  DomainName: string | undefined;
962
1103
  /**
1104
+ * @public
963
1105
  * <p>Configuration information for a search suggester. Each suggester has a unique name and specifies the text field you want to use for suggestions. The following options can be configured for a suggester: <code>FuzzyMatching</code>, <code>SortExpression</code>. </p>
964
1106
  */
965
1107
  Suggester: Suggester | undefined;
@@ -970,10 +1112,12 @@ export interface DefineSuggesterRequest {
970
1112
  */
971
1113
  export interface SuggesterStatus {
972
1114
  /**
1115
+ * @public
973
1116
  * <p>Configuration information for a search suggester. Each suggester has a unique name and specifies the text field you want to use for suggestions. The following options can be configured for a suggester: <code>FuzzyMatching</code>, <code>SortExpression</code>. </p>
974
1117
  */
975
1118
  Options: Suggester | undefined;
976
1119
  /**
1120
+ * @public
977
1121
  * <p>The status of domain configuration option.</p>
978
1122
  */
979
1123
  Status: OptionStatus | undefined;
@@ -984,6 +1128,7 @@ export interface SuggesterStatus {
984
1128
  */
985
1129
  export interface DefineSuggesterResponse {
986
1130
  /**
1131
+ * @public
987
1132
  * <p>The value of a <code>Suggester</code> and its current status.</p>
988
1133
  */
989
1134
  Suggester: SuggesterStatus | undefined;
@@ -994,10 +1139,12 @@ export interface DefineSuggesterResponse {
994
1139
  */
995
1140
  export interface DeleteAnalysisSchemeRequest {
996
1141
  /**
1142
+ * @public
997
1143
  * <p>A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>
998
1144
  */
999
1145
  DomainName: string | undefined;
1000
1146
  /**
1147
+ * @public
1001
1148
  * <p>The name of the analysis scheme you want to delete.</p>
1002
1149
  */
1003
1150
  AnalysisSchemeName: string | undefined;
@@ -1008,6 +1155,7 @@ export interface DeleteAnalysisSchemeRequest {
1008
1155
  */
1009
1156
  export interface DeleteAnalysisSchemeResponse {
1010
1157
  /**
1158
+ * @public
1011
1159
  * <p>The status of the analysis scheme being deleted.</p>
1012
1160
  */
1013
1161
  AnalysisScheme: AnalysisSchemeStatus | undefined;
@@ -1018,6 +1166,7 @@ export interface DeleteAnalysisSchemeResponse {
1018
1166
  */
1019
1167
  export interface DeleteDomainRequest {
1020
1168
  /**
1169
+ * @public
1021
1170
  * <p>The name of the domain you want to permanently delete.</p>
1022
1171
  */
1023
1172
  DomainName: string | undefined;
@@ -1028,6 +1177,7 @@ export interface DeleteDomainRequest {
1028
1177
  */
1029
1178
  export interface DeleteDomainResponse {
1030
1179
  /**
1180
+ * @public
1031
1181
  * <p>The current status of the search domain.</p>
1032
1182
  */
1033
1183
  DomainStatus?: DomainStatus;
@@ -1038,10 +1188,12 @@ export interface DeleteDomainResponse {
1038
1188
  */
1039
1189
  export interface DeleteExpressionRequest {
1040
1190
  /**
1191
+ * @public
1041
1192
  * <p>A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>
1042
1193
  */
1043
1194
  DomainName: string | undefined;
1044
1195
  /**
1196
+ * @public
1045
1197
  * <p>The name of the <code><a>Expression</a></code> to delete.</p>
1046
1198
  */
1047
1199
  ExpressionName: string | undefined;
@@ -1052,6 +1204,7 @@ export interface DeleteExpressionRequest {
1052
1204
  */
1053
1205
  export interface DeleteExpressionResponse {
1054
1206
  /**
1207
+ * @public
1055
1208
  * <p>The status of the expression being deleted.</p>
1056
1209
  */
1057
1210
  Expression: ExpressionStatus | undefined;
@@ -1062,10 +1215,12 @@ export interface DeleteExpressionResponse {
1062
1215
  */
1063
1216
  export interface DeleteIndexFieldRequest {
1064
1217
  /**
1218
+ * @public
1065
1219
  * <p>A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>
1066
1220
  */
1067
1221
  DomainName: string | undefined;
1068
1222
  /**
1223
+ * @public
1069
1224
  * <p>The name of the index field your want to remove from the domain's indexing options.</p>
1070
1225
  */
1071
1226
  IndexFieldName: string | undefined;
@@ -1076,6 +1231,7 @@ export interface DeleteIndexFieldRequest {
1076
1231
  */
1077
1232
  export interface DeleteIndexFieldResponse {
1078
1233
  /**
1234
+ * @public
1079
1235
  * <p>The status of the index field being deleted.</p>
1080
1236
  */
1081
1237
  IndexField: IndexFieldStatus | undefined;
@@ -1086,10 +1242,12 @@ export interface DeleteIndexFieldResponse {
1086
1242
  */
1087
1243
  export interface DeleteSuggesterRequest {
1088
1244
  /**
1245
+ * @public
1089
1246
  * <p>A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>
1090
1247
  */
1091
1248
  DomainName: string | undefined;
1092
1249
  /**
1250
+ * @public
1093
1251
  * <p>Specifies the name of the suggester you want to delete.</p>
1094
1252
  */
1095
1253
  SuggesterName: string | undefined;
@@ -1100,6 +1258,7 @@ export interface DeleteSuggesterRequest {
1100
1258
  */
1101
1259
  export interface DeleteSuggesterResponse {
1102
1260
  /**
1261
+ * @public
1103
1262
  * <p>The status of the suggester being deleted.</p>
1104
1263
  */
1105
1264
  Suggester: SuggesterStatus | undefined;
@@ -1110,14 +1269,17 @@ export interface DeleteSuggesterResponse {
1110
1269
  */
1111
1270
  export interface DescribeAnalysisSchemesRequest {
1112
1271
  /**
1272
+ * @public
1113
1273
  * <p>The name of the domain you want to describe.</p>
1114
1274
  */
1115
1275
  DomainName: string | undefined;
1116
1276
  /**
1277
+ * @public
1117
1278
  * <p>The analysis schemes you want to describe.</p>
1118
1279
  */
1119
1280
  AnalysisSchemeNames?: string[];
1120
1281
  /**
1282
+ * @public
1121
1283
  * <p>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</p>
1122
1284
  */
1123
1285
  Deployed?: boolean;
@@ -1128,6 +1290,7 @@ export interface DescribeAnalysisSchemesRequest {
1128
1290
  */
1129
1291
  export interface DescribeAnalysisSchemesResponse {
1130
1292
  /**
1293
+ * @public
1131
1294
  * <p>The analysis scheme descriptions.</p>
1132
1295
  */
1133
1296
  AnalysisSchemes: AnalysisSchemeStatus[] | undefined;
@@ -1138,10 +1301,12 @@ export interface DescribeAnalysisSchemesResponse {
1138
1301
  */
1139
1302
  export interface DescribeAvailabilityOptionsRequest {
1140
1303
  /**
1304
+ * @public
1141
1305
  * <p>The name of the domain you want to describe.</p>
1142
1306
  */
1143
1307
  DomainName: string | undefined;
1144
1308
  /**
1309
+ * @public
1145
1310
  * <p>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</p>
1146
1311
  */
1147
1312
  Deployed?: boolean;
@@ -1152,10 +1317,12 @@ export interface DescribeAvailabilityOptionsRequest {
1152
1317
  */
1153
1318
  export interface AvailabilityOptionsStatus {
1154
1319
  /**
1320
+ * @public
1155
1321
  * <p>The availability options configured for the domain.</p>
1156
1322
  */
1157
1323
  Options: boolean | undefined;
1158
1324
  /**
1325
+ * @public
1159
1326
  * <p>The status of domain configuration option.</p>
1160
1327
  */
1161
1328
  Status: OptionStatus | undefined;
@@ -1166,6 +1333,7 @@ export interface AvailabilityOptionsStatus {
1166
1333
  */
1167
1334
  export interface DescribeAvailabilityOptionsResponse {
1168
1335
  /**
1336
+ * @public
1169
1337
  * <p>The availability options configured for the domain. Indicates whether Multi-AZ is enabled for the domain. </p>
1170
1338
  */
1171
1339
  AvailabilityOptions?: AvailabilityOptionsStatus;
@@ -1178,10 +1346,12 @@ export declare class DisabledOperationException extends __BaseException {
1178
1346
  readonly name: "DisabledOperationException";
1179
1347
  readonly $fault: "client";
1180
1348
  /**
1349
+ * @public
1181
1350
  * <p>A machine-parsable string error or warning code.</p>
1182
1351
  */
1183
1352
  Code?: string;
1184
1353
  /**
1354
+ * @public
1185
1355
  * <p>A human-readable string error or warning message.</p>
1186
1356
  */
1187
1357
  Message?: string;
@@ -1196,10 +1366,12 @@ export declare class DisabledOperationException extends __BaseException {
1196
1366
  */
1197
1367
  export interface DescribeDomainEndpointOptionsRequest {
1198
1368
  /**
1369
+ * @public
1199
1370
  * <p>A string that represents the name of a domain.</p>
1200
1371
  */
1201
1372
  DomainName: string | undefined;
1202
1373
  /**
1374
+ * @public
1203
1375
  * <p>Whether to retrieve the latest configuration (which might be in a Processing state) or the current, active configuration. Defaults to <code>false</code>.</p>
1204
1376
  */
1205
1377
  Deployed?: boolean;
@@ -1222,10 +1394,12 @@ export type TLSSecurityPolicy = (typeof TLSSecurityPolicy)[keyof typeof TLSSecur
1222
1394
  */
1223
1395
  export interface DomainEndpointOptions {
1224
1396
  /**
1397
+ * @public
1225
1398
  * <p>Whether the domain is HTTPS only enabled.</p>
1226
1399
  */
1227
1400
  EnforceHTTPS?: boolean;
1228
1401
  /**
1402
+ * @public
1229
1403
  * <p>The minimum required TLS version</p>
1230
1404
  */
1231
1405
  TLSSecurityPolicy?: TLSSecurityPolicy | string;
@@ -1236,10 +1410,12 @@ export interface DomainEndpointOptions {
1236
1410
  */
1237
1411
  export interface DomainEndpointOptionsStatus {
1238
1412
  /**
1413
+ * @public
1239
1414
  * <p>The domain endpoint options configured for the domain.</p>
1240
1415
  */
1241
1416
  Options: DomainEndpointOptions | undefined;
1242
1417
  /**
1418
+ * @public
1243
1419
  * <p>The status of the configured domain endpoint options.</p>
1244
1420
  */
1245
1421
  Status: OptionStatus | undefined;
@@ -1250,6 +1426,7 @@ export interface DomainEndpointOptionsStatus {
1250
1426
  */
1251
1427
  export interface DescribeDomainEndpointOptionsResponse {
1252
1428
  /**
1429
+ * @public
1253
1430
  * <p>The status and configuration of a search domain's endpoint options.</p>
1254
1431
  */
1255
1432
  DomainEndpointOptions?: DomainEndpointOptionsStatus;
@@ -1260,6 +1437,7 @@ export interface DescribeDomainEndpointOptionsResponse {
1260
1437
  */
1261
1438
  export interface DescribeDomainsRequest {
1262
1439
  /**
1440
+ * @public
1263
1441
  * <p>The names of the domains you want to include in the response.</p>
1264
1442
  */
1265
1443
  DomainNames?: string[];
@@ -1270,6 +1448,7 @@ export interface DescribeDomainsRequest {
1270
1448
  */
1271
1449
  export interface DescribeDomainsResponse {
1272
1450
  /**
1451
+ * @public
1273
1452
  * <p>A list that contains the status of each requested domain.</p>
1274
1453
  */
1275
1454
  DomainStatusList: DomainStatus[] | undefined;
@@ -1281,14 +1460,17 @@ export interface DescribeDomainsResponse {
1281
1460
  */
1282
1461
  export interface DescribeExpressionsRequest {
1283
1462
  /**
1463
+ * @public
1284
1464
  * <p>The name of the domain you want to describe.</p>
1285
1465
  */
1286
1466
  DomainName: string | undefined;
1287
1467
  /**
1468
+ * @public
1288
1469
  * <p>Limits the <code><a>DescribeExpressions</a></code> response to the specified expressions. If not specified, all expressions are shown.</p>
1289
1470
  */
1290
1471
  ExpressionNames?: string[];
1291
1472
  /**
1473
+ * @public
1292
1474
  * <p>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</p>
1293
1475
  */
1294
1476
  Deployed?: boolean;
@@ -1299,6 +1481,7 @@ export interface DescribeExpressionsRequest {
1299
1481
  */
1300
1482
  export interface DescribeExpressionsResponse {
1301
1483
  /**
1484
+ * @public
1302
1485
  * <p>The expressions configured for the domain.</p>
1303
1486
  */
1304
1487
  Expressions: ExpressionStatus[] | undefined;
@@ -1309,14 +1492,17 @@ export interface DescribeExpressionsResponse {
1309
1492
  */
1310
1493
  export interface DescribeIndexFieldsRequest {
1311
1494
  /**
1495
+ * @public
1312
1496
  * <p>The name of the domain you want to describe.</p>
1313
1497
  */
1314
1498
  DomainName: string | undefined;
1315
1499
  /**
1500
+ * @public
1316
1501
  * <p>A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.</p>
1317
1502
  */
1318
1503
  FieldNames?: string[];
1319
1504
  /**
1505
+ * @public
1320
1506
  * <p>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</p>
1321
1507
  */
1322
1508
  Deployed?: boolean;
@@ -1327,6 +1513,7 @@ export interface DescribeIndexFieldsRequest {
1327
1513
  */
1328
1514
  export interface DescribeIndexFieldsResponse {
1329
1515
  /**
1516
+ * @public
1330
1517
  * <p>The index fields configured for the domain.</p>
1331
1518
  */
1332
1519
  IndexFields: IndexFieldStatus[] | undefined;
@@ -1337,6 +1524,7 @@ export interface DescribeIndexFieldsResponse {
1337
1524
  */
1338
1525
  export interface DescribeScalingParametersRequest {
1339
1526
  /**
1527
+ * @public
1340
1528
  * <p>A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>
1341
1529
  */
1342
1530
  DomainName: string | undefined;
@@ -1351,14 +1539,17 @@ export type PartitionInstanceType = "search.2xlarge" | "search.large" | "search.
1351
1539
  */
1352
1540
  export interface ScalingParameters {
1353
1541
  /**
1542
+ * @public
1354
1543
  * <p>The instance type that you want to preconfigure for your domain. For example, <code>search.m1.small</code>.</p>
1355
1544
  */
1356
1545
  DesiredInstanceType?: PartitionInstanceType | string;
1357
1546
  /**
1547
+ * @public
1358
1548
  * <p>The number of replicas you want to preconfigure for each index partition.</p>
1359
1549
  */
1360
1550
  DesiredReplicationCount?: number;
1361
1551
  /**
1552
+ * @public
1362
1553
  * <p>The number of partitions you want to preconfigure for your domain. Only valid when
1363
1554
  * you select <code>m2.2xlarge</code> as the desired instance type.</p>
1364
1555
  */
@@ -1370,10 +1561,12 @@ export interface ScalingParameters {
1370
1561
  */
1371
1562
  export interface ScalingParametersStatus {
1372
1563
  /**
1564
+ * @public
1373
1565
  * <p>The desired instance type and desired number of replicas of each index partition.</p>
1374
1566
  */
1375
1567
  Options: ScalingParameters | undefined;
1376
1568
  /**
1569
+ * @public
1377
1570
  * <p>The status of domain configuration option.</p>
1378
1571
  */
1379
1572
  Status: OptionStatus | undefined;
@@ -1384,6 +1577,7 @@ export interface ScalingParametersStatus {
1384
1577
  */
1385
1578
  export interface DescribeScalingParametersResponse {
1386
1579
  /**
1580
+ * @public
1387
1581
  * <p>The status and configuration of a search domain's scaling parameters. </p>
1388
1582
  */
1389
1583
  ScalingParameters: ScalingParametersStatus | undefined;
@@ -1394,10 +1588,12 @@ export interface DescribeScalingParametersResponse {
1394
1588
  */
1395
1589
  export interface DescribeServiceAccessPoliciesRequest {
1396
1590
  /**
1591
+ * @public
1397
1592
  * <p>The name of the domain you want to describe.</p>
1398
1593
  */
1399
1594
  DomainName: string | undefined;
1400
1595
  /**
1596
+ * @public
1401
1597
  * <p>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</p>
1402
1598
  */
1403
1599
  Deployed?: boolean;
@@ -1408,10 +1604,12 @@ export interface DescribeServiceAccessPoliciesRequest {
1408
1604
  */
1409
1605
  export interface AccessPoliciesStatus {
1410
1606
  /**
1607
+ * @public
1411
1608
  * <p>Access rules for a domain's document or search service endpoints. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html" target="_blank">Configuring Access for a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>. The maximum size of a policy document is 100 KB.</p>
1412
1609
  */
1413
1610
  Options: string | undefined;
1414
1611
  /**
1612
+ * @public
1415
1613
  * <p>The status of domain configuration option.</p>
1416
1614
  */
1417
1615
  Status: OptionStatus | undefined;
@@ -1422,6 +1620,7 @@ export interface AccessPoliciesStatus {
1422
1620
  */
1423
1621
  export interface DescribeServiceAccessPoliciesResponse {
1424
1622
  /**
1623
+ * @public
1425
1624
  * <p>The access rules configured for the domain specified in the request.</p>
1426
1625
  */
1427
1626
  AccessPolicies: AccessPoliciesStatus | undefined;
@@ -1432,14 +1631,17 @@ export interface DescribeServiceAccessPoliciesResponse {
1432
1631
  */
1433
1632
  export interface DescribeSuggestersRequest {
1434
1633
  /**
1634
+ * @public
1435
1635
  * <p>The name of the domain you want to describe.</p>
1436
1636
  */
1437
1637
  DomainName: string | undefined;
1438
1638
  /**
1639
+ * @public
1439
1640
  * <p>The suggesters you want to describe.</p>
1440
1641
  */
1441
1642
  SuggesterNames?: string[];
1442
1643
  /**
1644
+ * @public
1443
1645
  * <p>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</p>
1444
1646
  */
1445
1647
  Deployed?: boolean;
@@ -1450,6 +1652,7 @@ export interface DescribeSuggestersRequest {
1450
1652
  */
1451
1653
  export interface DescribeSuggestersResponse {
1452
1654
  /**
1655
+ * @public
1453
1656
  * <p>The suggesters configured for the domain specified in the request.</p>
1454
1657
  */
1455
1658
  Suggesters: SuggesterStatus[] | undefined;
@@ -1460,6 +1663,7 @@ export interface DescribeSuggestersResponse {
1460
1663
  */
1461
1664
  export interface IndexDocumentsRequest {
1462
1665
  /**
1666
+ * @public
1463
1667
  * <p>A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>
1464
1668
  */
1465
1669
  DomainName: string | undefined;
@@ -1470,6 +1674,7 @@ export interface IndexDocumentsRequest {
1470
1674
  */
1471
1675
  export interface IndexDocumentsResponse {
1472
1676
  /**
1677
+ * @public
1473
1678
  * <p>The names of the fields that are currently being indexed.</p>
1474
1679
  */
1475
1680
  FieldNames?: string[];
@@ -1480,6 +1685,7 @@ export interface IndexDocumentsResponse {
1480
1685
  */
1481
1686
  export interface ListDomainNamesResponse {
1482
1687
  /**
1688
+ * @public
1483
1689
  * <p>The names of the search domains owned by an account.</p>
1484
1690
  */
1485
1691
  DomainNames?: Record<string, string>;
@@ -1490,10 +1696,12 @@ export interface ListDomainNamesResponse {
1490
1696
  */
1491
1697
  export interface UpdateAvailabilityOptionsRequest {
1492
1698
  /**
1699
+ * @public
1493
1700
  * <p>A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>
1494
1701
  */
1495
1702
  DomainName: string | undefined;
1496
1703
  /**
1704
+ * @public
1497
1705
  * <p>You expand an existing search domain to a second Availability Zone by setting the Multi-AZ option to true. Similarly, you can turn off the Multi-AZ option to downgrade the domain to a single Availability Zone by setting the Multi-AZ option to <code>false</code>. </p>
1498
1706
  */
1499
1707
  MultiAZ: boolean | undefined;
@@ -1504,6 +1712,7 @@ export interface UpdateAvailabilityOptionsRequest {
1504
1712
  */
1505
1713
  export interface UpdateAvailabilityOptionsResponse {
1506
1714
  /**
1715
+ * @public
1507
1716
  * <p>The newly-configured availability options. Indicates whether Multi-AZ is enabled for the domain. </p>
1508
1717
  */
1509
1718
  AvailabilityOptions?: AvailabilityOptionsStatus;
@@ -1514,10 +1723,12 @@ export interface UpdateAvailabilityOptionsResponse {
1514
1723
  */
1515
1724
  export interface UpdateDomainEndpointOptionsRequest {
1516
1725
  /**
1726
+ * @public
1517
1727
  * <p>A string that represents the name of a domain.</p>
1518
1728
  */
1519
1729
  DomainName: string | undefined;
1520
1730
  /**
1731
+ * @public
1521
1732
  * <p>Whether to require that all requests to the domain arrive over HTTPS. We recommend Policy-Min-TLS-1-2-2019-07 for TLSSecurityPolicy. For compatibility with older clients, the default is Policy-Min-TLS-1-0-2019-07. </p>
1522
1733
  */
1523
1734
  DomainEndpointOptions: DomainEndpointOptions | undefined;
@@ -1528,6 +1739,7 @@ export interface UpdateDomainEndpointOptionsRequest {
1528
1739
  */
1529
1740
  export interface UpdateDomainEndpointOptionsResponse {
1530
1741
  /**
1742
+ * @public
1531
1743
  * <p>The newly-configured domain endpoint options.</p>
1532
1744
  */
1533
1745
  DomainEndpointOptions?: DomainEndpointOptionsStatus;
@@ -1538,10 +1750,12 @@ export interface UpdateDomainEndpointOptionsResponse {
1538
1750
  */
1539
1751
  export interface UpdateScalingParametersRequest {
1540
1752
  /**
1753
+ * @public
1541
1754
  * <p>A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>
1542
1755
  */
1543
1756
  DomainName: string | undefined;
1544
1757
  /**
1758
+ * @public
1545
1759
  * <p>The desired instance type and desired number of replicas of each index partition.</p>
1546
1760
  */
1547
1761
  ScalingParameters: ScalingParameters | undefined;
@@ -1552,6 +1766,7 @@ export interface UpdateScalingParametersRequest {
1552
1766
  */
1553
1767
  export interface UpdateScalingParametersResponse {
1554
1768
  /**
1769
+ * @public
1555
1770
  * <p>The status and configuration of a search domain's scaling parameters. </p>
1556
1771
  */
1557
1772
  ScalingParameters: ScalingParametersStatus | undefined;
@@ -1562,10 +1777,12 @@ export interface UpdateScalingParametersResponse {
1562
1777
  */
1563
1778
  export interface UpdateServiceAccessPoliciesRequest {
1564
1779
  /**
1780
+ * @public
1565
1781
  * <p>A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>
1566
1782
  */
1567
1783
  DomainName: string | undefined;
1568
1784
  /**
1785
+ * @public
1569
1786
  * <p>The access rules you want to configure. These rules replace any existing rules. </p>
1570
1787
  */
1571
1788
  AccessPolicies: string | undefined;
@@ -1576,6 +1793,7 @@ export interface UpdateServiceAccessPoliciesRequest {
1576
1793
  */
1577
1794
  export interface UpdateServiceAccessPoliciesResponse {
1578
1795
  /**
1796
+ * @public
1579
1797
  * <p>The access rules configured for the domain.</p>
1580
1798
  */
1581
1799
  AccessPolicies: AccessPoliciesStatus | undefined;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-cloudsearch",
3
3
  "description": "AWS SDK for JavaScript Cloudsearch Client for Node.js, Browser and React Native",
4
- "version": "3.379.1",
4
+ "version": "3.382.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.379.1",
25
- "@aws-sdk/credential-provider-node": "3.379.1",
24
+ "@aws-sdk/client-sts": "3.382.0",
25
+ "@aws-sdk/credential-provider-node": "3.382.0",
26
26
  "@aws-sdk/middleware-host-header": "3.379.1",
27
27
  "@aws-sdk/middleware-logger": "3.378.0",
28
28
  "@aws-sdk/middleware-recursion-detection": "3.378.0",
29
29
  "@aws-sdk/middleware-signing": "3.379.1",
30
- "@aws-sdk/middleware-user-agent": "3.379.1",
30
+ "@aws-sdk/middleware-user-agent": "3.382.0",
31
31
  "@aws-sdk/types": "3.378.0",
32
- "@aws-sdk/util-endpoints": "3.378.0",
32
+ "@aws-sdk/util-endpoints": "3.382.0",
33
33
  "@aws-sdk/util-user-agent-browser": "3.378.0",
34
34
  "@aws-sdk/util-user-agent-node": "3.378.0",
35
35
  "@smithy/config-resolver": "^2.0.1",