File: types.go

package info (click to toggle)
golang-github-aws-aws-sdk-go-v2 1.24.1-2~bpo12%2B1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-backports
  • size: 554,032 kB
  • sloc: java: 15,941; makefile: 419; sh: 175
file content (829 lines) | stat: -rw-r--r-- 29,814 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
// Code generated by smithy-go-codegen DO NOT EDIT.

package types

import (
	smithydocument "github.com/aws/smithy-go/document"
	"time"
)

// The configured access rules for the domain's document and search endpoints, and
// the current status of those rules.
type AccessPoliciesStatus struct {

	// Access rules for a domain's document or search service endpoints. For more
	// information, see Configuring Access for a Search Domain (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html)
	// in the Amazon CloudSearch Developer Guide. The maximum size of a policy document
	// is 100 KB.
	//
	// This member is required.
	Options *string

	// The status of domain configuration option.
	//
	// This member is required.
	Status *OptionStatus

	noSmithyDocumentSerde
}

// Synonyms, stopwords, and stemming options for an analysis scheme. Includes
// tokenization dictionary for Japanese.
type AnalysisOptions struct {

	// The level of algorithmic stemming to perform: none , minimal , light , or full .
	// The available levels vary depending on the language. For more information, see
	// Language Specific Text Processing Settings (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/text-processing.html#text-processing-settings)
	// in the Amazon CloudSearch Developer Guide
	AlgorithmicStemming AlgorithmicStemming

	// 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.
	JapaneseTokenizationDictionary *string

	// A JSON object that contains a collection of string:value pairs that each map a
	// term to its stem. For example, {"term1": "stem1", "term2": "stem2", "term3":
	// "stem3"} . 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.
	StemmingDictionary *string

	// A JSON array of terms to ignore during indexing and searching. For example,
	// ["a", "an", "the", "of"] . The stopwords dictionary must explicitly list each
	// word you want to ignore. Wildcards and regular expressions are not supported.
	Stopwords *string

	// 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 Synonyms (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html#synonyms)
	// in the Amazon CloudSearch Developer Guide.
	Synonyms *string

	noSmithyDocumentSerde
}

// Configuration information for an analysis scheme. Each analysis scheme has a
// unique name and specifies the language of the text to be processed. The
// following options can be configured for an analysis scheme: Synonyms , Stopwords
// , StemmingDictionary , JapaneseTokenizationDictionary and AlgorithmicStemming .
type AnalysisScheme struct {

	// An IETF RFC 4646 (http://tools.ietf.org/html/rfc4646) language code or mul for
	// multiple languages.
	//
	// This member is required.
	AnalysisSchemeLanguage AnalysisSchemeLanguage

	// Names must begin with a letter and can contain the following characters: a-z
	// (lowercase), 0-9, and _ (underscore).
	//
	// This member is required.
	AnalysisSchemeName *string

	// Synonyms, stopwords, and stemming options for an analysis scheme. Includes
	// tokenization dictionary for Japanese.
	AnalysisOptions *AnalysisOptions

	noSmithyDocumentSerde
}

// The status and configuration of an AnalysisScheme .
type AnalysisSchemeStatus struct {

	// Configuration information for an analysis scheme. Each analysis scheme has a
	// unique name and specifies the language of the text to be processed. The
	// following options can be configured for an analysis scheme: Synonyms , Stopwords
	// , StemmingDictionary , JapaneseTokenizationDictionary and AlgorithmicStemming .
	//
	// This member is required.
	Options *AnalysisScheme

	// The status of domain configuration option.
	//
	// This member is required.
	Status *OptionStatus

	noSmithyDocumentSerde
}

// The status and configuration of the domain's availability options.
type AvailabilityOptionsStatus struct {

	// The availability options configured for the domain.
	//
	// This member is required.
	Options bool

	// The status of domain configuration option.
	//
	// This member is required.
	Status *OptionStatus

	noSmithyDocumentSerde
}

// Options for a field that contains an array of dates. Present if IndexFieldType
// specifies the field is of type date-array . All options are enabled by default.
type DateArrayOptions struct {

	// A value to use for the field if the field isn't specified for a document.
	DefaultValue *string

	// Whether facet information can be returned for the field.
	FacetEnabled *bool

	// Whether the contents of the field can be returned in the search results.
	ReturnEnabled *bool

	// Whether the contents of the field are searchable.
	SearchEnabled *bool

	// A list of source fields to map to the field.
	SourceFields *string

	noSmithyDocumentSerde
}

// 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
// IndexFieldType specifies the field is of type date . All options are enabled by
// default.
type DateOptions struct {

	// A value to use for the field if the field isn't specified for a document.
	DefaultValue *string

	// Whether facet information can be returned for the field.
	FacetEnabled *bool

	// Whether the contents of the field can be returned in the search results.
	ReturnEnabled *bool

	// Whether the contents of the field are searchable.
	SearchEnabled *bool

	// Whether the field can be used to sort the search results.
	SortEnabled *bool

	// A string that represents the name of an index field. CloudSearch supports
	// regular index fields as well as dynamic fields. A dynamic field's name defines a
	// pattern that begins or ends with a wildcard. Any document fields that don't map
	// to a regular index field but do match a dynamic field's pattern are configured
	// with the dynamic field's indexing options. Regular field names begin with a
	// letter and can contain the following characters: a-z (lowercase), 0-9, and _
	// (underscore). Dynamic field names must begin or end with a wildcard (*). The
	// wildcard can also be the only character in a dynamic field name. Multiple
	// wildcards, and wildcards embedded within a string are not supported. The name
	// score is reserved and cannot be used as a field name. To reference a document's
	// ID, you can use the name _id .
	SourceField *string

	noSmithyDocumentSerde
}

// Options for a search suggester.
type DocumentSuggesterOptions struct {

	// The name of the index field you want to use for suggestions.
	//
	// This member is required.
	SourceField *string

	// The level of fuzziness allowed when suggesting matches for a string: none , low
	// , or high . 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.
	FuzzyMatching SuggesterFuzzyMatching

	// An expression that computes a score for each suggestion to control how they are
	// sorted. The scores are rounded to the nearest integer, with a floor of 0 and a
	// ceiling of 2^31-1. A document's relevance score is not computed for suggestions,
	// so sort expressions cannot reference the _score value. To sort suggestions
	// using a numeric field or existing expression, simply specify the name of the
	// field or expression. If no expression is configured for the suggester, the
	// suggestions are sorted with the closest matches listed first.
	SortExpression *string

	noSmithyDocumentSerde
}

// The domain's endpoint options.
type DomainEndpointOptions struct {

	// Whether the domain is HTTPS only enabled.
	EnforceHTTPS *bool

	// The minimum required TLS version
	TLSSecurityPolicy TLSSecurityPolicy

	noSmithyDocumentSerde
}

// The configuration and status of the domain's endpoint options.
type DomainEndpointOptionsStatus struct {

	// The domain endpoint options configured for the domain.
	//
	// This member is required.
	Options *DomainEndpointOptions

	// The status of the configured domain endpoint options.
	//
	// This member is required.
	Status *OptionStatus

	noSmithyDocumentSerde
}

// The current status of the search domain.
type DomainStatus struct {

	// An internally generated unique identifier for a domain.
	//
	// This member is required.
	DomainId *string

	// A string that represents the name of a domain. Domain names are unique across
	// the domains owned by an account within an AWS region. Domain names start with a
	// letter or number and can contain the following characters: a-z (lowercase), 0-9,
	// and - (hyphen).
	//
	// This member is required.
	DomainName *string

	// True if IndexDocuments needs to be called to activate the current domain
	// configuration.
	//
	// This member is required.
	RequiresIndexDocuments *bool

	// The Amazon Resource Name (ARN) of the search domain. See Identifiers for IAM
	// Entities (http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html)
	// in Using AWS Identity and Access Management for more information.
	ARN *string

	// True if the search domain is created. It can take several minutes to initialize
	// a domain when CreateDomain is called. Newly created search domains are returned
	// from DescribeDomains with a false value for Created until domain creation is
	// complete.
	Created *bool

	// True if the search domain has been deleted. The system must clean up resources
	// dedicated to the search domain when DeleteDomain is called. Newly deleted
	// search domains are returned from DescribeDomains with a true value for
	// IsDeleted for several minutes until resource cleanup is complete.
	Deleted *bool

	// The service endpoint for updating documents in a search domain.
	DocService *ServiceEndpoint

	Limits *Limits

	// True if processing is being done to activate the current domain configuration.
	Processing *bool

	// The number of search instances that are available to process search requests.
	SearchInstanceCount *int32

	// The instance type that is being used to process search requests.
	SearchInstanceType *string

	// The number of partitions across which the search index is spread.
	SearchPartitionCount *int32

	// The service endpoint for requesting search results from a search domain.
	SearchService *ServiceEndpoint

	noSmithyDocumentSerde
}

// Options for a field that contains an array of double-precision 64-bit floating
// point values. Present if IndexFieldType specifies the field is of type
// double-array . All options are enabled by default.
type DoubleArrayOptions struct {

	// A value to use for the field if the field isn't specified for a document.
	DefaultValue *float64

	// Whether facet information can be returned for the field.
	FacetEnabled *bool

	// Whether the contents of the field can be returned in the search results.
	ReturnEnabled *bool

	// Whether the contents of the field are searchable.
	SearchEnabled *bool

	// A list of source fields to map to the field.
	SourceFields *string

	noSmithyDocumentSerde
}

// Options for a double-precision 64-bit floating point field. Present if
// IndexFieldType specifies the field is of type double . All options are enabled
// by default.
type DoubleOptions struct {

	// 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.
	DefaultValue *float64

	// Whether facet information can be returned for the field.
	FacetEnabled *bool

	// Whether the contents of the field can be returned in the search results.
	ReturnEnabled *bool

	// Whether the contents of the field are searchable.
	SearchEnabled *bool

	// Whether the field can be used to sort the search results.
	SortEnabled *bool

	// The name of the source field to map to the field.
	SourceField *string

	noSmithyDocumentSerde
}

// 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.
type Expression struct {

	// Names must begin with a letter and can contain the following characters: a-z
	// (lowercase), 0-9, and _ (underscore).
	//
	// This member is required.
	ExpressionName *string

	// The expression to evaluate for sorting while processing a search request. The
	// Expression syntax is based on JavaScript expressions. For more information, see
	// Configuring Expressions (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html)
	// in the Amazon CloudSearch Developer Guide.
	//
	// This member is required.
	ExpressionValue *string

	noSmithyDocumentSerde
}

// The value of an Expression and its current status.
type ExpressionStatus struct {

	// The expression that is evaluated for sorting while processing a search request.
	//
	// This member is required.
	Options *Expression

	// The status of domain configuration option.
	//
	// This member is required.
	Status *OptionStatus

	noSmithyDocumentSerde
}

// Configuration information for a field in the index, including its name, type,
// and options. The supported options depend on the IndexFieldType .
type IndexField struct {

	// A string that represents the name of an index field. CloudSearch supports
	// regular index fields as well as dynamic fields. A dynamic field's name defines a
	// pattern that begins or ends with a wildcard. Any document fields that don't map
	// to a regular index field but do match a dynamic field's pattern are configured
	// with the dynamic field's indexing options. Regular field names begin with a
	// letter and can contain the following characters: a-z (lowercase), 0-9, and _
	// (underscore). Dynamic field names must begin or end with a wildcard (*). The
	// wildcard can also be the only character in a dynamic field name. Multiple
	// wildcards, and wildcards embedded within a string are not supported. The name
	// score is reserved and cannot be used as a field name. To reference a document's
	// ID, you can use the name _id .
	//
	// This member is required.
	IndexFieldName *string

	// The type of field. The valid options for a field depend on the field type. For
	// more information about the supported field types, see Configuring Index Fields (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html)
	// in the Amazon CloudSearch Developer Guide.
	//
	// This member is required.
	IndexFieldType IndexFieldType

	// Options for a field that contains an array of dates. Present if IndexFieldType
	// specifies the field is of type date-array . All options are enabled by default.
	DateArrayOptions *DateArrayOptions

	// 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
	// IndexFieldType specifies the field is of type date . All options are enabled by
	// default.
	DateOptions *DateOptions

	// Options for a field that contains an array of double-precision 64-bit floating
	// point values. Present if IndexFieldType specifies the field is of type
	// double-array . All options are enabled by default.
	DoubleArrayOptions *DoubleArrayOptions

	// Options for a double-precision 64-bit floating point field. Present if
	// IndexFieldType specifies the field is of type double . All options are enabled
	// by default.
	DoubleOptions *DoubleOptions

	// Options for a field that contains an array of 64-bit signed integers. Present
	// if IndexFieldType specifies the field is of type int-array . All options are
	// enabled by default.
	IntArrayOptions *IntArrayOptions

	// Options for a 64-bit signed integer field. Present if IndexFieldType specifies
	// the field is of type int . All options are enabled by default.
	IntOptions *IntOptions

	// Options for a latlon field. A latlon field contains a location stored as a
	// latitude and longitude value pair. Present if IndexFieldType specifies the
	// field is of type latlon . All options are enabled by default.
	LatLonOptions *LatLonOptions

	// Options for a field that contains an array of literal strings. Present if
	// IndexFieldType specifies the field is of type literal-array . All options are
	// enabled by default.
	LiteralArrayOptions *LiteralArrayOptions

	// Options for literal field. Present if IndexFieldType specifies the field is of
	// type literal . All options are enabled by default.
	LiteralOptions *LiteralOptions

	// Options for a field that contains an array of text strings. Present if
	// IndexFieldType specifies the field is of type text-array . A text-array field
	// is always searchable. All options are enabled by default.
	TextArrayOptions *TextArrayOptions

	// Options for text field. Present if IndexFieldType specifies the field is of
	// type text . A text field is always searchable. All options are enabled by
	// default.
	TextOptions *TextOptions

	noSmithyDocumentSerde
}

// The value of an IndexField and its current status.
type IndexFieldStatus struct {

	// Configuration information for a field in the index, including its name, type,
	// and options. The supported options depend on the IndexFieldType .
	//
	// This member is required.
	Options *IndexField

	// The status of domain configuration option.
	//
	// This member is required.
	Status *OptionStatus

	noSmithyDocumentSerde
}

// Options for a field that contains an array of 64-bit signed integers. Present
// if IndexFieldType specifies the field is of type int-array . All options are
// enabled by default.
type IntArrayOptions struct {

	// A value to use for the field if the field isn't specified for a document.
	DefaultValue *int64

	// Whether facet information can be returned for the field.
	FacetEnabled *bool

	// Whether the contents of the field can be returned in the search results.
	ReturnEnabled *bool

	// Whether the contents of the field are searchable.
	SearchEnabled *bool

	// A list of source fields to map to the field.
	SourceFields *string

	noSmithyDocumentSerde
}

// Options for a 64-bit signed integer field. Present if IndexFieldType specifies
// the field is of type int . All options are enabled by default.
type IntOptions struct {

	// 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.
	DefaultValue *int64

	// Whether facet information can be returned for the field.
	FacetEnabled *bool

	// Whether the contents of the field can be returned in the search results.
	ReturnEnabled *bool

	// Whether the contents of the field are searchable.
	SearchEnabled *bool

	// Whether the field can be used to sort the search results.
	SortEnabled *bool

	// The name of the source field to map to the field.
	SourceField *string

	noSmithyDocumentSerde
}

// Options for a latlon field. A latlon field contains a location stored as a
// latitude and longitude value pair. Present if IndexFieldType specifies the
// field is of type latlon . All options are enabled by default.
type LatLonOptions struct {

	// A value to use for the field if the field isn't specified for a document.
	DefaultValue *string

	// Whether facet information can be returned for the field.
	FacetEnabled *bool

	// Whether the contents of the field can be returned in the search results.
	ReturnEnabled *bool

	// Whether the contents of the field are searchable.
	SearchEnabled *bool

	// Whether the field can be used to sort the search results.
	SortEnabled *bool

	// A string that represents the name of an index field. CloudSearch supports
	// regular index fields as well as dynamic fields. A dynamic field's name defines a
	// pattern that begins or ends with a wildcard. Any document fields that don't map
	// to a regular index field but do match a dynamic field's pattern are configured
	// with the dynamic field's indexing options. Regular field names begin with a
	// letter and can contain the following characters: a-z (lowercase), 0-9, and _
	// (underscore). Dynamic field names must begin or end with a wildcard (*). The
	// wildcard can also be the only character in a dynamic field name. Multiple
	// wildcards, and wildcards embedded within a string are not supported. The name
	// score is reserved and cannot be used as a field name. To reference a document's
	// ID, you can use the name _id .
	SourceField *string

	noSmithyDocumentSerde
}

type Limits struct {

	// This member is required.
	MaximumPartitionCount *int32

	// This member is required.
	MaximumReplicationCount *int32

	noSmithyDocumentSerde
}

// Options for a field that contains an array of literal strings. Present if
// IndexFieldType specifies the field is of type literal-array . All options are
// enabled by default.
type LiteralArrayOptions struct {

	// A value to use for the field if the field isn't specified for a document.
	DefaultValue *string

	// Whether facet information can be returned for the field.
	FacetEnabled *bool

	// Whether the contents of the field can be returned in the search results.
	ReturnEnabled *bool

	// Whether the contents of the field are searchable.
	SearchEnabled *bool

	// A list of source fields to map to the field.
	SourceFields *string

	noSmithyDocumentSerde
}

// Options for literal field. Present if IndexFieldType specifies the field is of
// type literal . All options are enabled by default.
type LiteralOptions struct {

	// A value to use for the field if the field isn't specified for a document.
	DefaultValue *string

	// Whether facet information can be returned for the field.
	FacetEnabled *bool

	// Whether the contents of the field can be returned in the search results.
	ReturnEnabled *bool

	// Whether the contents of the field are searchable.
	SearchEnabled *bool

	// Whether the field can be used to sort the search results.
	SortEnabled *bool

	// A string that represents the name of an index field. CloudSearch supports
	// regular index fields as well as dynamic fields. A dynamic field's name defines a
	// pattern that begins or ends with a wildcard. Any document fields that don't map
	// to a regular index field but do match a dynamic field's pattern are configured
	// with the dynamic field's indexing options. Regular field names begin with a
	// letter and can contain the following characters: a-z (lowercase), 0-9, and _
	// (underscore). Dynamic field names must begin or end with a wildcard (*). The
	// wildcard can also be the only character in a dynamic field name. Multiple
	// wildcards, and wildcards embedded within a string are not supported. The name
	// score is reserved and cannot be used as a field name. To reference a document's
	// ID, you can use the name _id .
	SourceField *string

	noSmithyDocumentSerde
}

// The status of domain configuration option.
type OptionStatus struct {

	// A timestamp for when this option was created.
	//
	// This member is required.
	CreationDate *time.Time

	// The state of processing a change to an option. Possible values:
	//   - RequiresIndexDocuments : the option's latest value will not be deployed
	//   until IndexDocuments has been called and indexing is complete.
	//   - Processing : the option's latest value is in the process of being activated.
	//   - Active : the option's latest value is completely deployed.
	//   - FailedToValidate : the option value is not compatible with the domain's data
	//   and cannot be used to index the data. You must either modify the option value or
	//   update or remove the incompatible documents.
	//
	// This member is required.
	State OptionState

	// A timestamp for when this option was last updated.
	//
	// This member is required.
	UpdateDate *time.Time

	// Indicates that the option will be deleted once processing is complete.
	PendingDeletion *bool

	// A unique integer that indicates when this option was last updated.
	UpdateVersion int32

	noSmithyDocumentSerde
}

// The desired instance type and desired number of replicas of each index
// partition.
type ScalingParameters struct {

	// The instance type that you want to preconfigure for your domain. For example,
	// search.m1.small .
	DesiredInstanceType PartitionInstanceType

	// The number of partitions you want to preconfigure for your domain. Only valid
	// when you select m2.2xlarge as the desired instance type.
	DesiredPartitionCount int32

	// The number of replicas you want to preconfigure for each index partition.
	DesiredReplicationCount int32

	noSmithyDocumentSerde
}

// The status and configuration of a search domain's scaling parameters.
type ScalingParametersStatus struct {

	// The desired instance type and desired number of replicas of each index
	// partition.
	//
	// This member is required.
	Options *ScalingParameters

	// The status of domain configuration option.
	//
	// This member is required.
	Status *OptionStatus

	noSmithyDocumentSerde
}

// The endpoint to which service requests can be submitted.
type ServiceEndpoint struct {

	// The endpoint to which service requests can be submitted. For example,
	// search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com
	// or
	// doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com .
	Endpoint *string

	noSmithyDocumentSerde
}

// Configuration information for a search suggester. Each suggester has a unique
// name and specifies the text field you want to use for suggestions. The following
// options can be configured for a suggester: FuzzyMatching , SortExpression .
type Suggester struct {

	// Options for a search suggester.
	//
	// This member is required.
	DocumentSuggesterOptions *DocumentSuggesterOptions

	// Names must begin with a letter and can contain the following characters: a-z
	// (lowercase), 0-9, and _ (underscore).
	//
	// This member is required.
	SuggesterName *string

	noSmithyDocumentSerde
}

// The value of a Suggester and its current status.
type SuggesterStatus struct {

	// Configuration information for a search suggester. Each suggester has a unique
	// name and specifies the text field you want to use for suggestions. The following
	// options can be configured for a suggester: FuzzyMatching , SortExpression .
	//
	// This member is required.
	Options *Suggester

	// The status of domain configuration option.
	//
	// This member is required.
	Status *OptionStatus

	noSmithyDocumentSerde
}

// Options for a field that contains an array of text strings. Present if
// IndexFieldType specifies the field is of type text-array . A text-array field
// is always searchable. All options are enabled by default.
type TextArrayOptions struct {

	// The name of an analysis scheme for a text-array field.
	AnalysisScheme *string

	// A value to use for the field if the field isn't specified for a document.
	DefaultValue *string

	// Whether highlights can be returned for the field.
	HighlightEnabled *bool

	// Whether the contents of the field can be returned in the search results.
	ReturnEnabled *bool

	// A list of source fields to map to the field.
	SourceFields *string

	noSmithyDocumentSerde
}

// Options for text field. Present if IndexFieldType specifies the field is of
// type text . A text field is always searchable. All options are enabled by
// default.
type TextOptions struct {

	// The name of an analysis scheme for a text field.
	AnalysisScheme *string

	// A value to use for the field if the field isn't specified for a document.
	DefaultValue *string

	// Whether highlights can be returned for the field.
	HighlightEnabled *bool

	// Whether the contents of the field can be returned in the search results.
	ReturnEnabled *bool

	// Whether the field can be used to sort the search results.
	SortEnabled *bool

	// A string that represents the name of an index field. CloudSearch supports
	// regular index fields as well as dynamic fields. A dynamic field's name defines a
	// pattern that begins or ends with a wildcard. Any document fields that don't map
	// to a regular index field but do match a dynamic field's pattern are configured
	// with the dynamic field's indexing options. Regular field names begin with a
	// letter and can contain the following characters: a-z (lowercase), 0-9, and _
	// (underscore). Dynamic field names must begin or end with a wildcard (*). The
	// wildcard can also be the only character in a dynamic field name. Multiple
	// wildcards, and wildcards embedded within a string are not supported. The name
	// score is reserved and cannot be used as a field name. To reference a document's
	// ID, you can use the name _id .
	SourceField *string

	noSmithyDocumentSerde
}

type noSmithyDocumentSerde = smithydocument.NoSerde