@aws-sdk/client-cloudsearch 3.533.0 → 3.540.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.
- package/dist-cjs/endpoint/endpointResolver.js +4 -2
- package/dist-cjs/index.js +0 -3
- package/dist-es/endpoint/endpointResolver.js +3 -1
- package/dist-es/index.js +0 -1
- package/dist-types/CloudSearch.d.ts +3 -1
- package/dist-types/CloudSearchClient.d.ts +1 -1
- package/dist-types/commands/BuildSuggestersCommand.d.ts +2 -1
- package/dist-types/commands/CreateDomainCommand.d.ts +2 -1
- package/dist-types/commands/DefineAnalysisSchemeCommand.d.ts +2 -1
- package/dist-types/commands/DefineExpressionCommand.d.ts +2 -1
- package/dist-types/commands/DefineIndexFieldCommand.d.ts +2 -1
- package/dist-types/commands/DefineSuggesterCommand.d.ts +2 -1
- package/dist-types/commands/DeleteAnalysisSchemeCommand.d.ts +2 -1
- package/dist-types/commands/DeleteDomainCommand.d.ts +2 -1
- package/dist-types/commands/DeleteExpressionCommand.d.ts +2 -1
- package/dist-types/commands/DeleteIndexFieldCommand.d.ts +2 -1
- package/dist-types/commands/DeleteSuggesterCommand.d.ts +2 -1
- package/dist-types/commands/DescribeAnalysisSchemesCommand.d.ts +2 -1
- package/dist-types/commands/DescribeAvailabilityOptionsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeDomainEndpointOptionsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeDomainsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeExpressionsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeIndexFieldsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeScalingParametersCommand.d.ts +2 -1
- package/dist-types/commands/DescribeServiceAccessPoliciesCommand.d.ts +2 -1
- package/dist-types/commands/DescribeSuggestersCommand.d.ts +2 -1
- package/dist-types/commands/IndexDocumentsCommand.d.ts +2 -1
- package/dist-types/commands/ListDomainNamesCommand.d.ts +2 -1
- package/dist-types/commands/UpdateAvailabilityOptionsCommand.d.ts +2 -1
- package/dist-types/commands/UpdateDomainEndpointOptionsCommand.d.ts +2 -1
- package/dist-types/commands/UpdateScalingParametersCommand.d.ts +2 -1
- package/dist-types/commands/UpdateServiceAccessPoliciesCommand.d.ts +2 -1
- package/dist-types/index.d.ts +0 -1
- package/dist-types/models/models_0.d.ts +307 -307
- package/dist-types/ts3.4/CloudSearch.d.ts +2 -0
- package/dist-types/ts3.4/commands/BuildSuggestersCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateDomainCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DefineAnalysisSchemeCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DefineExpressionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DefineIndexFieldCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DefineSuggesterCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteAnalysisSchemeCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteDomainCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteExpressionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteIndexFieldCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteSuggesterCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeAnalysisSchemesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeAvailabilityOptionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeDomainEndpointOptionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeDomainsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeExpressionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeIndexFieldsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeScalingParametersCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeServiceAccessPoliciesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeSuggestersCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/IndexDocumentsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListDomainNamesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateAvailabilityOptionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateDomainEndpointOptionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateScalingParametersCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateServiceAccessPoliciesCommand.d.ts +9 -0
- package/dist-types/ts3.4/index.d.ts +0 -1
- package/package.json +40 -40
|
@@ -1,20 +1,20 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { CloudSearchServiceException as __BaseException } from "./CloudSearchServiceException";
|
|
3
3
|
/**
|
|
4
|
-
* @public
|
|
5
4
|
* <p>An error occurred while processing the request.</p>
|
|
5
|
+
* @public
|
|
6
6
|
*/
|
|
7
7
|
export declare class BaseException extends __BaseException {
|
|
8
8
|
readonly name: "BaseException";
|
|
9
9
|
readonly $fault: "client";
|
|
10
10
|
/**
|
|
11
|
-
* @public
|
|
12
11
|
* <p>A machine-parsable string error or warning code.</p>
|
|
12
|
+
* @public
|
|
13
13
|
*/
|
|
14
14
|
Code?: string;
|
|
15
15
|
/**
|
|
16
|
-
* @public
|
|
17
16
|
* <p>A human-readable string error or warning message.</p>
|
|
17
|
+
* @public
|
|
18
18
|
*/
|
|
19
19
|
Message?: string;
|
|
20
20
|
/**
|
|
@@ -23,43 +23,43 @@ export declare class BaseException extends __BaseException {
|
|
|
23
23
|
constructor(opts: __ExceptionOptionType<BaseException, __BaseException>);
|
|
24
24
|
}
|
|
25
25
|
/**
|
|
26
|
-
* @public
|
|
27
26
|
* <p>Container for the parameters to the <code><a>BuildSuggester</a></code> operation. Specifies the name of the domain you want to update.</p>
|
|
27
|
+
* @public
|
|
28
28
|
*/
|
|
29
29
|
export interface BuildSuggestersRequest {
|
|
30
30
|
/**
|
|
31
|
-
* @public
|
|
32
31
|
* <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>
|
|
32
|
+
* @public
|
|
33
33
|
*/
|
|
34
34
|
DomainName: string | undefined;
|
|
35
35
|
}
|
|
36
36
|
/**
|
|
37
|
-
* @public
|
|
38
37
|
* <p>The result of a <code>BuildSuggester</code> request. Contains a list of the fields used for suggestions.</p>
|
|
38
|
+
* @public
|
|
39
39
|
*/
|
|
40
40
|
export interface BuildSuggestersResponse {
|
|
41
41
|
/**
|
|
42
|
-
* @public
|
|
43
42
|
* <p>A list of field names.</p>
|
|
43
|
+
* @public
|
|
44
44
|
*/
|
|
45
45
|
FieldNames?: string[];
|
|
46
46
|
}
|
|
47
47
|
/**
|
|
48
|
-
* @public
|
|
49
48
|
* <p>An internal error occurred while processing the request. If this problem persists,
|
|
50
49
|
* report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>.</p>
|
|
50
|
+
* @public
|
|
51
51
|
*/
|
|
52
52
|
export declare class InternalException extends __BaseException {
|
|
53
53
|
readonly name: "InternalException";
|
|
54
54
|
readonly $fault: "server";
|
|
55
55
|
/**
|
|
56
|
-
* @public
|
|
57
56
|
* <p>A machine-parsable string error or warning code.</p>
|
|
57
|
+
* @public
|
|
58
58
|
*/
|
|
59
59
|
Code?: string;
|
|
60
60
|
/**
|
|
61
|
-
* @public
|
|
62
61
|
* <p>A human-readable string error or warning message.</p>
|
|
62
|
+
* @public
|
|
63
63
|
*/
|
|
64
64
|
Message?: string;
|
|
65
65
|
/**
|
|
@@ -68,20 +68,20 @@ export declare class InternalException extends __BaseException {
|
|
|
68
68
|
constructor(opts: __ExceptionOptionType<InternalException, __BaseException>);
|
|
69
69
|
}
|
|
70
70
|
/**
|
|
71
|
-
* @public
|
|
72
71
|
* <p>The request was rejected because it attempted to reference a resource that does not exist.</p>
|
|
72
|
+
* @public
|
|
73
73
|
*/
|
|
74
74
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
75
75
|
readonly name: "ResourceNotFoundException";
|
|
76
76
|
readonly $fault: "client";
|
|
77
77
|
/**
|
|
78
|
-
* @public
|
|
79
78
|
* <p>A machine-parsable string error or warning code.</p>
|
|
79
|
+
* @public
|
|
80
80
|
*/
|
|
81
81
|
Code?: string;
|
|
82
82
|
/**
|
|
83
|
-
* @public
|
|
84
83
|
* <p>A human-readable string error or warning message.</p>
|
|
84
|
+
* @public
|
|
85
85
|
*/
|
|
86
86
|
Message?: string;
|
|
87
87
|
/**
|
|
@@ -90,20 +90,20 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
90
90
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
91
91
|
}
|
|
92
92
|
/**
|
|
93
|
-
* @public
|
|
94
93
|
* <p>The request was rejected because it has invalid parameters.</p>
|
|
94
|
+
* @public
|
|
95
95
|
*/
|
|
96
96
|
export declare class ValidationException extends __BaseException {
|
|
97
97
|
readonly name: "ValidationException";
|
|
98
98
|
readonly $fault: "client";
|
|
99
99
|
/**
|
|
100
|
-
* @public
|
|
101
100
|
* <p>A machine-parsable string error or warning code.</p>
|
|
101
|
+
* @public
|
|
102
102
|
*/
|
|
103
103
|
Code?: string;
|
|
104
104
|
/**
|
|
105
|
-
* @public
|
|
106
105
|
* <p>A human-readable string error or warning message.</p>
|
|
106
|
+
* @public
|
|
107
107
|
*/
|
|
108
108
|
Message?: string;
|
|
109
109
|
/**
|
|
@@ -112,24 +112,24 @@ export declare class ValidationException extends __BaseException {
|
|
|
112
112
|
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
113
113
|
}
|
|
114
114
|
/**
|
|
115
|
-
* @public
|
|
116
115
|
* <p>Container for the parameters to the <code><a>CreateDomain</a></code> operation. Specifies a name for the new search domain.</p>
|
|
116
|
+
* @public
|
|
117
117
|
*/
|
|
118
118
|
export interface CreateDomainRequest {
|
|
119
119
|
/**
|
|
120
|
-
* @public
|
|
121
120
|
* <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>
|
|
121
|
+
* @public
|
|
122
122
|
*/
|
|
123
123
|
DomainName: string | undefined;
|
|
124
124
|
}
|
|
125
125
|
/**
|
|
126
|
-
* @public
|
|
127
126
|
* <p>The endpoint to which service requests can be submitted.</p>
|
|
127
|
+
* @public
|
|
128
128
|
*/
|
|
129
129
|
export interface ServiceEndpoint {
|
|
130
130
|
/**
|
|
131
|
-
* @public
|
|
132
131
|
* <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>
|
|
132
|
+
* @public
|
|
133
133
|
*/
|
|
134
134
|
Endpoint?: string;
|
|
135
135
|
}
|
|
@@ -141,98 +141,98 @@ export interface Limits {
|
|
|
141
141
|
MaximumPartitionCount: number | undefined;
|
|
142
142
|
}
|
|
143
143
|
/**
|
|
144
|
-
* @public
|
|
145
144
|
* <p>The current status of the search domain.</p>
|
|
145
|
+
* @public
|
|
146
146
|
*/
|
|
147
147
|
export interface DomainStatus {
|
|
148
148
|
/**
|
|
149
|
-
* @public
|
|
150
149
|
* <p>An internally generated unique identifier for a domain.</p>
|
|
150
|
+
* @public
|
|
151
151
|
*/
|
|
152
152
|
DomainId: string | undefined;
|
|
153
153
|
/**
|
|
154
|
-
* @public
|
|
155
154
|
* <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>
|
|
155
|
+
* @public
|
|
156
156
|
*/
|
|
157
157
|
DomainName: string | undefined;
|
|
158
158
|
/**
|
|
159
|
-
* @public
|
|
160
159
|
* <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>
|
|
160
|
+
* @public
|
|
161
161
|
*/
|
|
162
162
|
ARN?: string;
|
|
163
163
|
/**
|
|
164
|
-
* @public
|
|
165
164
|
* <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>
|
|
165
|
+
* @public
|
|
166
166
|
*/
|
|
167
167
|
Created?: boolean;
|
|
168
168
|
/**
|
|
169
|
-
* @public
|
|
170
169
|
* <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>
|
|
170
|
+
* @public
|
|
171
171
|
*/
|
|
172
172
|
Deleted?: boolean;
|
|
173
173
|
/**
|
|
174
|
-
* @public
|
|
175
174
|
* <p>The service endpoint for updating documents in a search domain.</p>
|
|
175
|
+
* @public
|
|
176
176
|
*/
|
|
177
177
|
DocService?: ServiceEndpoint;
|
|
178
178
|
/**
|
|
179
|
-
* @public
|
|
180
179
|
* <p>The service endpoint for requesting search results from a search domain.</p>
|
|
180
|
+
* @public
|
|
181
181
|
*/
|
|
182
182
|
SearchService?: ServiceEndpoint;
|
|
183
183
|
/**
|
|
184
|
-
* @public
|
|
185
184
|
* <p>True if <a>IndexDocuments</a> needs to be called to activate the current domain configuration.</p>
|
|
185
|
+
* @public
|
|
186
186
|
*/
|
|
187
187
|
RequiresIndexDocuments: boolean | undefined;
|
|
188
188
|
/**
|
|
189
|
-
* @public
|
|
190
189
|
* <p>True if processing is being done to activate the current domain configuration.</p>
|
|
190
|
+
* @public
|
|
191
191
|
*/
|
|
192
192
|
Processing?: boolean;
|
|
193
193
|
/**
|
|
194
|
-
* @public
|
|
195
194
|
* <p>The instance type that is being used to process search requests.</p>
|
|
195
|
+
* @public
|
|
196
196
|
*/
|
|
197
197
|
SearchInstanceType?: string;
|
|
198
198
|
/**
|
|
199
|
-
* @public
|
|
200
199
|
* <p>The number of partitions across which the search index is spread.</p>
|
|
200
|
+
* @public
|
|
201
201
|
*/
|
|
202
202
|
SearchPartitionCount?: number;
|
|
203
203
|
/**
|
|
204
|
-
* @public
|
|
205
204
|
* <p>The number of search instances that are available to process search requests.</p>
|
|
205
|
+
* @public
|
|
206
206
|
*/
|
|
207
207
|
SearchInstanceCount?: number;
|
|
208
208
|
Limits?: Limits;
|
|
209
209
|
}
|
|
210
210
|
/**
|
|
211
|
-
* @public
|
|
212
211
|
* <p>The result of a <code>CreateDomainRequest</code>. Contains the status of a newly created domain.</p>
|
|
212
|
+
* @public
|
|
213
213
|
*/
|
|
214
214
|
export interface CreateDomainResponse {
|
|
215
215
|
/**
|
|
216
|
-
* @public
|
|
217
216
|
* <p>The current status of the search domain.</p>
|
|
217
|
+
* @public
|
|
218
218
|
*/
|
|
219
219
|
DomainStatus?: DomainStatus;
|
|
220
220
|
}
|
|
221
221
|
/**
|
|
222
|
-
* @public
|
|
223
222
|
* <p>The request was rejected because a resource limit has already been met.</p>
|
|
223
|
+
* @public
|
|
224
224
|
*/
|
|
225
225
|
export declare class LimitExceededException extends __BaseException {
|
|
226
226
|
readonly name: "LimitExceededException";
|
|
227
227
|
readonly $fault: "client";
|
|
228
228
|
/**
|
|
229
|
-
* @public
|
|
230
229
|
* <p>A machine-parsable string error or warning code.</p>
|
|
230
|
+
* @public
|
|
231
231
|
*/
|
|
232
232
|
Code?: string;
|
|
233
233
|
/**
|
|
234
|
-
* @public
|
|
235
234
|
* <p>A human-readable string error or warning message.</p>
|
|
235
|
+
* @public
|
|
236
236
|
*/
|
|
237
237
|
Message?: string;
|
|
238
238
|
/**
|
|
@@ -241,20 +241,20 @@ export declare class LimitExceededException extends __BaseException {
|
|
|
241
241
|
constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
|
|
242
242
|
}
|
|
243
243
|
/**
|
|
244
|
-
* @public
|
|
245
244
|
* <p>The request was rejected because it attempted to create a resource that already exists.</p>
|
|
245
|
+
* @public
|
|
246
246
|
*/
|
|
247
247
|
export declare class ResourceAlreadyExistsException extends __BaseException {
|
|
248
248
|
readonly name: "ResourceAlreadyExistsException";
|
|
249
249
|
readonly $fault: "client";
|
|
250
250
|
/**
|
|
251
|
-
* @public
|
|
252
251
|
* <p>A machine-parsable string error or warning code.</p>
|
|
252
|
+
* @public
|
|
253
253
|
*/
|
|
254
254
|
Code?: string;
|
|
255
255
|
/**
|
|
256
|
-
* @public
|
|
257
256
|
* <p>A human-readable string error or warning message.</p>
|
|
257
|
+
* @public
|
|
258
258
|
*/
|
|
259
259
|
Message?: string;
|
|
260
260
|
/**
|
|
@@ -277,33 +277,33 @@ export declare const AlgorithmicStemming: {
|
|
|
277
277
|
*/
|
|
278
278
|
export type AlgorithmicStemming = (typeof AlgorithmicStemming)[keyof typeof AlgorithmicStemming];
|
|
279
279
|
/**
|
|
280
|
-
* @public
|
|
281
280
|
* <p>Synonyms, stopwords, and stemming options for an analysis scheme. Includes tokenization dictionary for Japanese.</p>
|
|
281
|
+
* @public
|
|
282
282
|
*/
|
|
283
283
|
export interface AnalysisOptions {
|
|
284
284
|
/**
|
|
285
|
-
* @public
|
|
286
285
|
* <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>
|
|
286
|
+
* @public
|
|
287
287
|
*/
|
|
288
288
|
Synonyms?: string;
|
|
289
289
|
/**
|
|
290
|
-
* @public
|
|
291
290
|
* <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>
|
|
291
|
+
* @public
|
|
292
292
|
*/
|
|
293
293
|
Stopwords?: string;
|
|
294
294
|
/**
|
|
295
|
-
* @public
|
|
296
295
|
* <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>
|
|
296
|
+
* @public
|
|
297
297
|
*/
|
|
298
298
|
StemmingDictionary?: string;
|
|
299
299
|
/**
|
|
300
|
-
* @public
|
|
301
300
|
* <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>
|
|
301
|
+
* @public
|
|
302
302
|
*/
|
|
303
303
|
JapaneseTokenizationDictionary?: string;
|
|
304
304
|
/**
|
|
305
|
-
* @public
|
|
306
305
|
* <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>
|
|
306
|
+
* @public
|
|
307
307
|
*/
|
|
308
308
|
AlgorithmicStemming?: AlgorithmicStemming;
|
|
309
309
|
}
|
|
@@ -353,40 +353,40 @@ export declare const AnalysisSchemeLanguage: {
|
|
|
353
353
|
*/
|
|
354
354
|
export type AnalysisSchemeLanguage = (typeof AnalysisSchemeLanguage)[keyof typeof AnalysisSchemeLanguage];
|
|
355
355
|
/**
|
|
356
|
-
* @public
|
|
357
356
|
* <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>
|
|
357
|
+
* @public
|
|
358
358
|
*/
|
|
359
359
|
export interface AnalysisScheme {
|
|
360
360
|
/**
|
|
361
|
-
* @public
|
|
362
361
|
* <p>Names must begin with a letter and can contain the following characters:
|
|
363
362
|
* a-z (lowercase), 0-9, and _ (underscore).</p>
|
|
363
|
+
* @public
|
|
364
364
|
*/
|
|
365
365
|
AnalysisSchemeName: string | undefined;
|
|
366
366
|
/**
|
|
367
|
-
* @public
|
|
368
367
|
* <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>
|
|
368
|
+
* @public
|
|
369
369
|
*/
|
|
370
370
|
AnalysisSchemeLanguage: AnalysisSchemeLanguage | undefined;
|
|
371
371
|
/**
|
|
372
|
-
* @public
|
|
373
372
|
* <p>Synonyms, stopwords, and stemming options for an analysis scheme. Includes tokenization dictionary for Japanese.</p>
|
|
373
|
+
* @public
|
|
374
374
|
*/
|
|
375
375
|
AnalysisOptions?: AnalysisOptions;
|
|
376
376
|
}
|
|
377
377
|
/**
|
|
378
|
-
* @public
|
|
379
378
|
* <p>Container for the parameters to the <code><a>DefineAnalysisScheme</a></code> operation. Specifies the name of the domain you want to update and the analysis scheme configuration.</p>
|
|
379
|
+
* @public
|
|
380
380
|
*/
|
|
381
381
|
export interface DefineAnalysisSchemeRequest {
|
|
382
382
|
/**
|
|
383
|
-
* @public
|
|
384
383
|
* <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>
|
|
384
|
+
* @public
|
|
385
385
|
*/
|
|
386
386
|
DomainName: string | undefined;
|
|
387
387
|
/**
|
|
388
|
-
* @public
|
|
389
388
|
* <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>
|
|
389
|
+
* @public
|
|
390
390
|
*/
|
|
391
391
|
AnalysisScheme: AnalysisScheme | undefined;
|
|
392
392
|
}
|
|
@@ -405,83 +405,83 @@ export declare const OptionState: {
|
|
|
405
405
|
*/
|
|
406
406
|
export type OptionState = (typeof OptionState)[keyof typeof OptionState];
|
|
407
407
|
/**
|
|
408
|
-
* @public
|
|
409
408
|
* <p>The status of domain configuration option.</p>
|
|
409
|
+
* @public
|
|
410
410
|
*/
|
|
411
411
|
export interface OptionStatus {
|
|
412
412
|
/**
|
|
413
|
-
* @public
|
|
414
413
|
* <p>A timestamp for when this option was created.</p>
|
|
414
|
+
* @public
|
|
415
415
|
*/
|
|
416
416
|
CreationDate: Date | undefined;
|
|
417
417
|
/**
|
|
418
|
-
* @public
|
|
419
418
|
* <p>A timestamp for when this option was last updated.</p>
|
|
419
|
+
* @public
|
|
420
420
|
*/
|
|
421
421
|
UpdateDate: Date | undefined;
|
|
422
422
|
/**
|
|
423
|
-
* @public
|
|
424
423
|
* <p>A unique integer that indicates when this option was last updated.</p>
|
|
424
|
+
* @public
|
|
425
425
|
*/
|
|
426
426
|
UpdateVersion?: number;
|
|
427
427
|
/**
|
|
428
|
-
* @public
|
|
429
428
|
* <p>The state of processing a change to an option. Possible values:</p><ul>
|
|
430
429
|
* <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>
|
|
431
430
|
* <li><code>Processing</code>: the option's latest value is in the process of being activated. </li>
|
|
432
431
|
* <li><code>Active</code>: the option's latest value is completely deployed.</li>
|
|
433
432
|
* <li><code>FailedToValidate</code>: 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.</li>
|
|
434
433
|
* </ul>
|
|
434
|
+
* @public
|
|
435
435
|
*/
|
|
436
436
|
State: OptionState | undefined;
|
|
437
437
|
/**
|
|
438
|
-
* @public
|
|
439
438
|
* <p>Indicates that the option will be deleted once processing is complete.</p>
|
|
439
|
+
* @public
|
|
440
440
|
*/
|
|
441
441
|
PendingDeletion?: boolean;
|
|
442
442
|
}
|
|
443
443
|
/**
|
|
444
|
-
* @public
|
|
445
444
|
* <p>The status and configuration of an <code>AnalysisScheme</code>.</p>
|
|
445
|
+
* @public
|
|
446
446
|
*/
|
|
447
447
|
export interface AnalysisSchemeStatus {
|
|
448
448
|
/**
|
|
449
|
-
* @public
|
|
450
449
|
* <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>
|
|
450
|
+
* @public
|
|
451
451
|
*/
|
|
452
452
|
Options: AnalysisScheme | undefined;
|
|
453
453
|
/**
|
|
454
|
-
* @public
|
|
455
454
|
* <p>The status of domain configuration option.</p>
|
|
455
|
+
* @public
|
|
456
456
|
*/
|
|
457
457
|
Status: OptionStatus | undefined;
|
|
458
458
|
}
|
|
459
459
|
/**
|
|
460
|
-
* @public
|
|
461
460
|
* <p>The result of a <code><a>DefineAnalysisScheme</a></code> request. Contains the status of the newly-configured analysis scheme.</p>
|
|
461
|
+
* @public
|
|
462
462
|
*/
|
|
463
463
|
export interface DefineAnalysisSchemeResponse {
|
|
464
464
|
/**
|
|
465
|
-
* @public
|
|
466
465
|
* <p>The status and configuration of an <code>AnalysisScheme</code>.</p>
|
|
466
|
+
* @public
|
|
467
467
|
*/
|
|
468
468
|
AnalysisScheme: AnalysisSchemeStatus | undefined;
|
|
469
469
|
}
|
|
470
470
|
/**
|
|
471
|
-
* @public
|
|
472
471
|
* <p>The request was rejected because it specified an invalid type definition.</p>
|
|
472
|
+
* @public
|
|
473
473
|
*/
|
|
474
474
|
export declare class InvalidTypeException extends __BaseException {
|
|
475
475
|
readonly name: "InvalidTypeException";
|
|
476
476
|
readonly $fault: "client";
|
|
477
477
|
/**
|
|
478
|
-
* @public
|
|
479
478
|
* <p>A machine-parsable string error or warning code.</p>
|
|
479
|
+
* @public
|
|
480
480
|
*/
|
|
481
481
|
Code?: string;
|
|
482
482
|
/**
|
|
483
|
-
* @public
|
|
484
483
|
* <p>A human-readable string error or warning message.</p>
|
|
484
|
+
* @public
|
|
485
485
|
*/
|
|
486
486
|
Message?: string;
|
|
487
487
|
/**
|
|
@@ -490,108 +490,107 @@ export declare class InvalidTypeException extends __BaseException {
|
|
|
490
490
|
constructor(opts: __ExceptionOptionType<InvalidTypeException, __BaseException>);
|
|
491
491
|
}
|
|
492
492
|
/**
|
|
493
|
-
* @public
|
|
494
493
|
* <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>
|
|
494
|
+
* @public
|
|
495
495
|
*/
|
|
496
496
|
export interface Expression {
|
|
497
497
|
/**
|
|
498
|
-
* @public
|
|
499
498
|
* <p>Names must begin with a letter and can contain the following characters:
|
|
500
499
|
* a-z (lowercase), 0-9, and _ (underscore).</p>
|
|
500
|
+
* @public
|
|
501
501
|
*/
|
|
502
502
|
ExpressionName: string | undefined;
|
|
503
503
|
/**
|
|
504
|
-
* @public
|
|
505
504
|
* <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>
|
|
505
|
+
* @public
|
|
506
506
|
*/
|
|
507
507
|
ExpressionValue: string | undefined;
|
|
508
508
|
}
|
|
509
509
|
/**
|
|
510
|
-
* @public
|
|
511
510
|
* <p>Container for the parameters to the <code><a>DefineExpression</a></code> operation. Specifies the name of the domain you want to update and the expression you want to configure.</p>
|
|
511
|
+
* @public
|
|
512
512
|
*/
|
|
513
513
|
export interface DefineExpressionRequest {
|
|
514
514
|
/**
|
|
515
|
-
* @public
|
|
516
515
|
* <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>
|
|
516
|
+
* @public
|
|
517
517
|
*/
|
|
518
518
|
DomainName: string | undefined;
|
|
519
519
|
/**
|
|
520
|
-
* @public
|
|
521
520
|
* <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>
|
|
521
|
+
* @public
|
|
522
522
|
*/
|
|
523
523
|
Expression: Expression | undefined;
|
|
524
524
|
}
|
|
525
525
|
/**
|
|
526
|
-
* @public
|
|
527
526
|
* <p>The value of an <code>Expression</code> and its current status.</p>
|
|
527
|
+
* @public
|
|
528
528
|
*/
|
|
529
529
|
export interface ExpressionStatus {
|
|
530
530
|
/**
|
|
531
|
-
* @public
|
|
532
531
|
* <p>The expression that is evaluated for sorting while processing a search request.</p>
|
|
532
|
+
* @public
|
|
533
533
|
*/
|
|
534
534
|
Options: Expression | undefined;
|
|
535
535
|
/**
|
|
536
|
-
* @public
|
|
537
536
|
* <p>The status of domain configuration option.</p>
|
|
537
|
+
* @public
|
|
538
538
|
*/
|
|
539
539
|
Status: OptionStatus | undefined;
|
|
540
540
|
}
|
|
541
541
|
/**
|
|
542
|
-
* @public
|
|
543
542
|
* <p>The result of a <code>DefineExpression</code> request. Contains the status of the newly-configured expression.</p>
|
|
543
|
+
* @public
|
|
544
544
|
*/
|
|
545
545
|
export interface DefineExpressionResponse {
|
|
546
546
|
/**
|
|
547
|
-
* @public
|
|
548
547
|
* <p>The value of an <code>Expression</code> and its current status.</p>
|
|
548
|
+
* @public
|
|
549
549
|
*/
|
|
550
550
|
Expression: ExpressionStatus | undefined;
|
|
551
551
|
}
|
|
552
552
|
/**
|
|
553
|
-
* @public
|
|
554
553
|
* <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>
|
|
554
|
+
* @public
|
|
555
555
|
*/
|
|
556
556
|
export interface DateArrayOptions {
|
|
557
557
|
/**
|
|
558
|
-
* @public
|
|
559
558
|
* A value to use for the field if the field isn't specified for a document.
|
|
559
|
+
* @public
|
|
560
560
|
*/
|
|
561
561
|
DefaultValue?: string;
|
|
562
562
|
/**
|
|
563
|
-
* @public
|
|
564
563
|
* <p>A list of source fields to map to the field. </p>
|
|
564
|
+
* @public
|
|
565
565
|
*/
|
|
566
566
|
SourceFields?: string;
|
|
567
567
|
/**
|
|
568
|
-
* @public
|
|
569
568
|
* <p>Whether facet information can be returned for the field.</p>
|
|
569
|
+
* @public
|
|
570
570
|
*/
|
|
571
571
|
FacetEnabled?: boolean;
|
|
572
572
|
/**
|
|
573
|
-
* @public
|
|
574
573
|
* <p>Whether the contents of the field are searchable.</p>
|
|
574
|
+
* @public
|
|
575
575
|
*/
|
|
576
576
|
SearchEnabled?: boolean;
|
|
577
577
|
/**
|
|
578
|
-
* @public
|
|
579
578
|
* <p>Whether the contents of the field can be returned in the search results.</p>
|
|
579
|
+
* @public
|
|
580
580
|
*/
|
|
581
581
|
ReturnEnabled?: boolean;
|
|
582
582
|
}
|
|
583
583
|
/**
|
|
584
|
-
* @public
|
|
585
584
|
* <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>
|
|
585
|
+
* @public
|
|
586
586
|
*/
|
|
587
587
|
export interface DateOptions {
|
|
588
588
|
/**
|
|
589
|
-
* @public
|
|
590
589
|
* A value to use for the field if the field isn't specified for a document.
|
|
590
|
+
* @public
|
|
591
591
|
*/
|
|
592
592
|
DefaultValue?: string;
|
|
593
593
|
/**
|
|
594
|
-
* @public
|
|
595
594
|
* <p>A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields.
|
|
596
595
|
* A dynamic field's name defines a pattern that begins or ends with a wildcard.
|
|
597
596
|
* Any document fields that don't map to a regular index field but do match a
|
|
@@ -606,93 +605,94 @@ export interface DateOptions {
|
|
|
606
605
|
* <p>The name <code>score</code> is reserved and cannot be used as a field name.
|
|
607
606
|
* To reference a document's ID, you can use the name <code>_id</code>.
|
|
608
607
|
* </p>
|
|
608
|
+
* @public
|
|
609
609
|
*/
|
|
610
610
|
SourceField?: string;
|
|
611
611
|
/**
|
|
612
|
-
* @public
|
|
613
612
|
* <p>Whether facet information can be returned for the field.</p>
|
|
613
|
+
* @public
|
|
614
614
|
*/
|
|
615
615
|
FacetEnabled?: boolean;
|
|
616
616
|
/**
|
|
617
|
-
* @public
|
|
618
617
|
* <p>Whether the contents of the field are searchable.</p>
|
|
618
|
+
* @public
|
|
619
619
|
*/
|
|
620
620
|
SearchEnabled?: boolean;
|
|
621
621
|
/**
|
|
622
|
-
* @public
|
|
623
622
|
* <p>Whether the contents of the field can be returned in the search results.</p>
|
|
623
|
+
* @public
|
|
624
624
|
*/
|
|
625
625
|
ReturnEnabled?: boolean;
|
|
626
626
|
/**
|
|
627
|
-
* @public
|
|
628
627
|
* <p>Whether the field can be used to sort the search results.</p>
|
|
628
|
+
* @public
|
|
629
629
|
*/
|
|
630
630
|
SortEnabled?: boolean;
|
|
631
631
|
}
|
|
632
632
|
/**
|
|
633
|
-
* @public
|
|
634
633
|
* <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>
|
|
634
|
+
* @public
|
|
635
635
|
*/
|
|
636
636
|
export interface DoubleArrayOptions {
|
|
637
637
|
/**
|
|
638
|
-
* @public
|
|
639
638
|
* A value to use for the field if the field isn't specified for a document.
|
|
639
|
+
* @public
|
|
640
640
|
*/
|
|
641
641
|
DefaultValue?: number;
|
|
642
642
|
/**
|
|
643
|
-
* @public
|
|
644
643
|
* <p>A list of source fields to map to the field. </p>
|
|
644
|
+
* @public
|
|
645
645
|
*/
|
|
646
646
|
SourceFields?: string;
|
|
647
647
|
/**
|
|
648
|
-
* @public
|
|
649
648
|
* <p>Whether facet information can be returned for the field.</p>
|
|
649
|
+
* @public
|
|
650
650
|
*/
|
|
651
651
|
FacetEnabled?: boolean;
|
|
652
652
|
/**
|
|
653
|
-
* @public
|
|
654
653
|
* <p>Whether the contents of the field are searchable.</p>
|
|
654
|
+
* @public
|
|
655
655
|
*/
|
|
656
656
|
SearchEnabled?: boolean;
|
|
657
657
|
/**
|
|
658
|
-
* @public
|
|
659
658
|
* <p>Whether the contents of the field can be returned in the search results.</p>
|
|
659
|
+
* @public
|
|
660
660
|
*/
|
|
661
661
|
ReturnEnabled?: boolean;
|
|
662
662
|
}
|
|
663
663
|
/**
|
|
664
|
-
* @public
|
|
665
664
|
* <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>
|
|
665
|
+
* @public
|
|
666
666
|
*/
|
|
667
667
|
export interface DoubleOptions {
|
|
668
668
|
/**
|
|
669
|
-
* @public
|
|
670
669
|
* <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>
|
|
670
|
+
* @public
|
|
671
671
|
*/
|
|
672
672
|
DefaultValue?: number;
|
|
673
673
|
/**
|
|
674
|
-
* @public
|
|
675
674
|
* <p>The name of the source field to map to the field. </p>
|
|
675
|
+
* @public
|
|
676
676
|
*/
|
|
677
677
|
SourceField?: string;
|
|
678
678
|
/**
|
|
679
|
-
* @public
|
|
680
679
|
* <p>Whether facet information can be returned for the field.</p>
|
|
680
|
+
* @public
|
|
681
681
|
*/
|
|
682
682
|
FacetEnabled?: boolean;
|
|
683
683
|
/**
|
|
684
|
-
* @public
|
|
685
684
|
* <p>Whether the contents of the field are searchable.</p>
|
|
685
|
+
* @public
|
|
686
686
|
*/
|
|
687
687
|
SearchEnabled?: boolean;
|
|
688
688
|
/**
|
|
689
|
-
* @public
|
|
690
689
|
* <p>Whether the contents of the field can be returned in the search results.</p>
|
|
690
|
+
* @public
|
|
691
691
|
*/
|
|
692
692
|
ReturnEnabled?: boolean;
|
|
693
693
|
/**
|
|
694
|
-
* @public
|
|
695
694
|
* <p>Whether the field can be used to sort the search results.</p>
|
|
695
|
+
* @public
|
|
696
696
|
*/
|
|
697
697
|
SortEnabled?: boolean;
|
|
698
698
|
}
|
|
@@ -718,84 +718,83 @@ export declare const IndexFieldType: {
|
|
|
718
718
|
*/
|
|
719
719
|
export type IndexFieldType = (typeof IndexFieldType)[keyof typeof IndexFieldType];
|
|
720
720
|
/**
|
|
721
|
-
* @public
|
|
722
721
|
* <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>
|
|
722
|
+
* @public
|
|
723
723
|
*/
|
|
724
724
|
export interface IntArrayOptions {
|
|
725
725
|
/**
|
|
726
|
-
* @public
|
|
727
726
|
* A value to use for the field if the field isn't specified for a document.
|
|
727
|
+
* @public
|
|
728
728
|
*/
|
|
729
729
|
DefaultValue?: number;
|
|
730
730
|
/**
|
|
731
|
-
* @public
|
|
732
731
|
* <p>A list of source fields to map to the field. </p>
|
|
732
|
+
* @public
|
|
733
733
|
*/
|
|
734
734
|
SourceFields?: string;
|
|
735
735
|
/**
|
|
736
|
-
* @public
|
|
737
736
|
* <p>Whether facet information can be returned for the field.</p>
|
|
737
|
+
* @public
|
|
738
738
|
*/
|
|
739
739
|
FacetEnabled?: boolean;
|
|
740
740
|
/**
|
|
741
|
-
* @public
|
|
742
741
|
* <p>Whether the contents of the field are searchable.</p>
|
|
742
|
+
* @public
|
|
743
743
|
*/
|
|
744
744
|
SearchEnabled?: boolean;
|
|
745
745
|
/**
|
|
746
|
-
* @public
|
|
747
746
|
* <p>Whether the contents of the field can be returned in the search results.</p>
|
|
747
|
+
* @public
|
|
748
748
|
*/
|
|
749
749
|
ReturnEnabled?: boolean;
|
|
750
750
|
}
|
|
751
751
|
/**
|
|
752
|
-
* @public
|
|
753
752
|
* <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>
|
|
753
|
+
* @public
|
|
754
754
|
*/
|
|
755
755
|
export interface IntOptions {
|
|
756
756
|
/**
|
|
757
|
-
* @public
|
|
758
757
|
* 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.
|
|
758
|
+
* @public
|
|
759
759
|
*/
|
|
760
760
|
DefaultValue?: number;
|
|
761
761
|
/**
|
|
762
|
-
* @public
|
|
763
762
|
* <p>The name of the source field to map to the field. </p>
|
|
763
|
+
* @public
|
|
764
764
|
*/
|
|
765
765
|
SourceField?: string;
|
|
766
766
|
/**
|
|
767
|
-
* @public
|
|
768
767
|
* <p>Whether facet information can be returned for the field.</p>
|
|
768
|
+
* @public
|
|
769
769
|
*/
|
|
770
770
|
FacetEnabled?: boolean;
|
|
771
771
|
/**
|
|
772
|
-
* @public
|
|
773
772
|
* <p>Whether the contents of the field are searchable.</p>
|
|
773
|
+
* @public
|
|
774
774
|
*/
|
|
775
775
|
SearchEnabled?: boolean;
|
|
776
776
|
/**
|
|
777
|
-
* @public
|
|
778
777
|
* <p>Whether the contents of the field can be returned in the search results.</p>
|
|
778
|
+
* @public
|
|
779
779
|
*/
|
|
780
780
|
ReturnEnabled?: boolean;
|
|
781
781
|
/**
|
|
782
|
-
* @public
|
|
783
782
|
* <p>Whether the field can be used to sort the search results.</p>
|
|
783
|
+
* @public
|
|
784
784
|
*/
|
|
785
785
|
SortEnabled?: boolean;
|
|
786
786
|
}
|
|
787
787
|
/**
|
|
788
|
-
* @public
|
|
789
788
|
* <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>
|
|
789
|
+
* @public
|
|
790
790
|
*/
|
|
791
791
|
export interface LatLonOptions {
|
|
792
792
|
/**
|
|
793
|
-
* @public
|
|
794
793
|
* A value to use for the field if the field isn't specified for a document.
|
|
794
|
+
* @public
|
|
795
795
|
*/
|
|
796
796
|
DefaultValue?: string;
|
|
797
797
|
/**
|
|
798
|
-
* @public
|
|
799
798
|
* <p>A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields.
|
|
800
799
|
* A dynamic field's name defines a pattern that begins or ends with a wildcard.
|
|
801
800
|
* Any document fields that don't map to a regular index field but do match a
|
|
@@ -810,72 +809,72 @@ export interface LatLonOptions {
|
|
|
810
809
|
* <p>The name <code>score</code> is reserved and cannot be used as a field name.
|
|
811
810
|
* To reference a document's ID, you can use the name <code>_id</code>.
|
|
812
811
|
* </p>
|
|
812
|
+
* @public
|
|
813
813
|
*/
|
|
814
814
|
SourceField?: string;
|
|
815
815
|
/**
|
|
816
|
-
* @public
|
|
817
816
|
* <p>Whether facet information can be returned for the field.</p>
|
|
817
|
+
* @public
|
|
818
818
|
*/
|
|
819
819
|
FacetEnabled?: boolean;
|
|
820
820
|
/**
|
|
821
|
-
* @public
|
|
822
821
|
* <p>Whether the contents of the field are searchable.</p>
|
|
822
|
+
* @public
|
|
823
823
|
*/
|
|
824
824
|
SearchEnabled?: boolean;
|
|
825
825
|
/**
|
|
826
|
-
* @public
|
|
827
826
|
* <p>Whether the contents of the field can be returned in the search results.</p>
|
|
827
|
+
* @public
|
|
828
828
|
*/
|
|
829
829
|
ReturnEnabled?: boolean;
|
|
830
830
|
/**
|
|
831
|
-
* @public
|
|
832
831
|
* <p>Whether the field can be used to sort the search results.</p>
|
|
832
|
+
* @public
|
|
833
833
|
*/
|
|
834
834
|
SortEnabled?: boolean;
|
|
835
835
|
}
|
|
836
836
|
/**
|
|
837
|
-
* @public
|
|
838
837
|
* <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>
|
|
838
|
+
* @public
|
|
839
839
|
*/
|
|
840
840
|
export interface LiteralArrayOptions {
|
|
841
841
|
/**
|
|
842
|
-
* @public
|
|
843
842
|
* A value to use for the field if the field isn't specified for a document.
|
|
843
|
+
* @public
|
|
844
844
|
*/
|
|
845
845
|
DefaultValue?: string;
|
|
846
846
|
/**
|
|
847
|
-
* @public
|
|
848
847
|
* <p>A list of source fields to map to the field. </p>
|
|
848
|
+
* @public
|
|
849
849
|
*/
|
|
850
850
|
SourceFields?: string;
|
|
851
851
|
/**
|
|
852
|
-
* @public
|
|
853
852
|
* <p>Whether facet information can be returned for the field.</p>
|
|
853
|
+
* @public
|
|
854
854
|
*/
|
|
855
855
|
FacetEnabled?: boolean;
|
|
856
856
|
/**
|
|
857
|
-
* @public
|
|
858
857
|
* <p>Whether the contents of the field are searchable.</p>
|
|
858
|
+
* @public
|
|
859
859
|
*/
|
|
860
860
|
SearchEnabled?: boolean;
|
|
861
861
|
/**
|
|
862
|
-
* @public
|
|
863
862
|
* <p>Whether the contents of the field can be returned in the search results.</p>
|
|
863
|
+
* @public
|
|
864
864
|
*/
|
|
865
865
|
ReturnEnabled?: boolean;
|
|
866
866
|
}
|
|
867
867
|
/**
|
|
868
|
-
* @public
|
|
869
868
|
* <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>
|
|
869
|
+
* @public
|
|
870
870
|
*/
|
|
871
871
|
export interface LiteralOptions {
|
|
872
872
|
/**
|
|
873
|
-
* @public
|
|
874
873
|
* A value to use for the field if the field isn't specified for a document.
|
|
874
|
+
* @public
|
|
875
875
|
*/
|
|
876
876
|
DefaultValue?: string;
|
|
877
877
|
/**
|
|
878
|
-
* @public
|
|
879
878
|
* <p>A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields.
|
|
880
879
|
* A dynamic field's name defines a pattern that begins or ends with a wildcard.
|
|
881
880
|
* Any document fields that don't map to a regular index field but do match a
|
|
@@ -890,72 +889,72 @@ export interface LiteralOptions {
|
|
|
890
889
|
* <p>The name <code>score</code> is reserved and cannot be used as a field name.
|
|
891
890
|
* To reference a document's ID, you can use the name <code>_id</code>.
|
|
892
891
|
* </p>
|
|
892
|
+
* @public
|
|
893
893
|
*/
|
|
894
894
|
SourceField?: string;
|
|
895
895
|
/**
|
|
896
|
-
* @public
|
|
897
896
|
* <p>Whether facet information can be returned for the field.</p>
|
|
897
|
+
* @public
|
|
898
898
|
*/
|
|
899
899
|
FacetEnabled?: boolean;
|
|
900
900
|
/**
|
|
901
|
-
* @public
|
|
902
901
|
* <p>Whether the contents of the field are searchable.</p>
|
|
902
|
+
* @public
|
|
903
903
|
*/
|
|
904
904
|
SearchEnabled?: boolean;
|
|
905
905
|
/**
|
|
906
|
-
* @public
|
|
907
906
|
* <p>Whether the contents of the field can be returned in the search results.</p>
|
|
907
|
+
* @public
|
|
908
908
|
*/
|
|
909
909
|
ReturnEnabled?: boolean;
|
|
910
910
|
/**
|
|
911
|
-
* @public
|
|
912
911
|
* <p>Whether the field can be used to sort the search results.</p>
|
|
912
|
+
* @public
|
|
913
913
|
*/
|
|
914
914
|
SortEnabled?: boolean;
|
|
915
915
|
}
|
|
916
916
|
/**
|
|
917
|
-
* @public
|
|
918
917
|
* <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>
|
|
918
|
+
* @public
|
|
919
919
|
*/
|
|
920
920
|
export interface TextArrayOptions {
|
|
921
921
|
/**
|
|
922
|
-
* @public
|
|
923
922
|
* A value to use for the field if the field isn't specified for a document.
|
|
923
|
+
* @public
|
|
924
924
|
*/
|
|
925
925
|
DefaultValue?: string;
|
|
926
926
|
/**
|
|
927
|
-
* @public
|
|
928
927
|
* <p>A list of source fields to map to the field. </p>
|
|
928
|
+
* @public
|
|
929
929
|
*/
|
|
930
930
|
SourceFields?: string;
|
|
931
931
|
/**
|
|
932
|
-
* @public
|
|
933
932
|
* <p>Whether the contents of the field can be returned in the search results.</p>
|
|
933
|
+
* @public
|
|
934
934
|
*/
|
|
935
935
|
ReturnEnabled?: boolean;
|
|
936
936
|
/**
|
|
937
|
-
* @public
|
|
938
937
|
* <p>Whether highlights can be returned for the field.</p>
|
|
938
|
+
* @public
|
|
939
939
|
*/
|
|
940
940
|
HighlightEnabled?: boolean;
|
|
941
941
|
/**
|
|
942
|
-
* @public
|
|
943
942
|
* <p>The name of an analysis scheme for a <code>text-array</code> field.</p>
|
|
943
|
+
* @public
|
|
944
944
|
*/
|
|
945
945
|
AnalysisScheme?: string;
|
|
946
946
|
}
|
|
947
947
|
/**
|
|
948
|
-
* @public
|
|
949
948
|
* <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>
|
|
949
|
+
* @public
|
|
950
950
|
*/
|
|
951
951
|
export interface TextOptions {
|
|
952
952
|
/**
|
|
953
|
-
* @public
|
|
954
953
|
* A value to use for the field if the field isn't specified for a document.
|
|
954
|
+
* @public
|
|
955
955
|
*/
|
|
956
956
|
DefaultValue?: string;
|
|
957
957
|
/**
|
|
958
|
-
* @public
|
|
959
958
|
* <p>A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields.
|
|
960
959
|
* A dynamic field's name defines a pattern that begins or ends with a wildcard.
|
|
961
960
|
* Any document fields that don't map to a regular index field but do match a
|
|
@@ -970,36 +969,36 @@ export interface TextOptions {
|
|
|
970
969
|
* <p>The name <code>score</code> is reserved and cannot be used as a field name.
|
|
971
970
|
* To reference a document's ID, you can use the name <code>_id</code>.
|
|
972
971
|
* </p>
|
|
972
|
+
* @public
|
|
973
973
|
*/
|
|
974
974
|
SourceField?: string;
|
|
975
975
|
/**
|
|
976
|
-
* @public
|
|
977
976
|
* <p>Whether the contents of the field can be returned in the search results.</p>
|
|
977
|
+
* @public
|
|
978
978
|
*/
|
|
979
979
|
ReturnEnabled?: boolean;
|
|
980
980
|
/**
|
|
981
|
-
* @public
|
|
982
981
|
* <p>Whether the field can be used to sort the search results.</p>
|
|
982
|
+
* @public
|
|
983
983
|
*/
|
|
984
984
|
SortEnabled?: boolean;
|
|
985
985
|
/**
|
|
986
|
-
* @public
|
|
987
986
|
* <p>Whether highlights can be returned for the field.</p>
|
|
987
|
+
* @public
|
|
988
988
|
*/
|
|
989
989
|
HighlightEnabled?: boolean;
|
|
990
990
|
/**
|
|
991
|
-
* @public
|
|
992
991
|
* <p>The name of an analysis scheme for a <code>text</code> field.</p>
|
|
992
|
+
* @public
|
|
993
993
|
*/
|
|
994
994
|
AnalysisScheme?: string;
|
|
995
995
|
}
|
|
996
996
|
/**
|
|
997
|
-
* @public
|
|
998
997
|
* <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>
|
|
998
|
+
* @public
|
|
999
999
|
*/
|
|
1000
1000
|
export interface IndexField {
|
|
1001
1001
|
/**
|
|
1002
|
-
* @public
|
|
1003
1002
|
* <p>A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields.
|
|
1004
1003
|
* A dynamic field's name defines a pattern that begins or ends with a wildcard.
|
|
1005
1004
|
* Any document fields that don't map to a regular index field but do match a
|
|
@@ -1014,109 +1013,110 @@ export interface IndexField {
|
|
|
1014
1013
|
* <p>The name <code>score</code> is reserved and cannot be used as a field name.
|
|
1015
1014
|
* To reference a document's ID, you can use the name <code>_id</code>.
|
|
1016
1015
|
* </p>
|
|
1016
|
+
* @public
|
|
1017
1017
|
*/
|
|
1018
1018
|
IndexFieldName: string | undefined;
|
|
1019
1019
|
/**
|
|
1020
|
-
* @public
|
|
1021
1020
|
* <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>
|
|
1021
|
+
* @public
|
|
1022
1022
|
*/
|
|
1023
1023
|
IndexFieldType: IndexFieldType | undefined;
|
|
1024
1024
|
/**
|
|
1025
|
-
* @public
|
|
1026
1025
|
* <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>
|
|
1026
|
+
* @public
|
|
1027
1027
|
*/
|
|
1028
1028
|
IntOptions?: IntOptions;
|
|
1029
1029
|
/**
|
|
1030
|
-
* @public
|
|
1031
1030
|
* <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>
|
|
1031
|
+
* @public
|
|
1032
1032
|
*/
|
|
1033
1033
|
DoubleOptions?: DoubleOptions;
|
|
1034
1034
|
/**
|
|
1035
|
-
* @public
|
|
1036
1035
|
* <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>
|
|
1036
|
+
* @public
|
|
1037
1037
|
*/
|
|
1038
1038
|
LiteralOptions?: LiteralOptions;
|
|
1039
1039
|
/**
|
|
1040
|
-
* @public
|
|
1041
1040
|
* <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>
|
|
1041
|
+
* @public
|
|
1042
1042
|
*/
|
|
1043
1043
|
TextOptions?: TextOptions;
|
|
1044
1044
|
/**
|
|
1045
|
-
* @public
|
|
1046
1045
|
* <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>
|
|
1046
|
+
* @public
|
|
1047
1047
|
*/
|
|
1048
1048
|
DateOptions?: DateOptions;
|
|
1049
1049
|
/**
|
|
1050
|
-
* @public
|
|
1051
1050
|
* <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>
|
|
1051
|
+
* @public
|
|
1052
1052
|
*/
|
|
1053
1053
|
LatLonOptions?: LatLonOptions;
|
|
1054
1054
|
/**
|
|
1055
|
-
* @public
|
|
1056
1055
|
* <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>
|
|
1056
|
+
* @public
|
|
1057
1057
|
*/
|
|
1058
1058
|
IntArrayOptions?: IntArrayOptions;
|
|
1059
1059
|
/**
|
|
1060
|
-
* @public
|
|
1061
1060
|
* <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>
|
|
1061
|
+
* @public
|
|
1062
1062
|
*/
|
|
1063
1063
|
DoubleArrayOptions?: DoubleArrayOptions;
|
|
1064
1064
|
/**
|
|
1065
|
-
* @public
|
|
1066
1065
|
* <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>
|
|
1066
|
+
* @public
|
|
1067
1067
|
*/
|
|
1068
1068
|
LiteralArrayOptions?: LiteralArrayOptions;
|
|
1069
1069
|
/**
|
|
1070
|
-
* @public
|
|
1071
1070
|
* <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>
|
|
1071
|
+
* @public
|
|
1072
1072
|
*/
|
|
1073
1073
|
TextArrayOptions?: TextArrayOptions;
|
|
1074
1074
|
/**
|
|
1075
|
-
* @public
|
|
1076
1075
|
* <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>
|
|
1076
|
+
* @public
|
|
1077
1077
|
*/
|
|
1078
1078
|
DateArrayOptions?: DateArrayOptions;
|
|
1079
1079
|
}
|
|
1080
1080
|
/**
|
|
1081
|
-
* @public
|
|
1082
1081
|
* <p>Container for the parameters to the <code><a>DefineIndexField</a></code> operation. Specifies the name of the domain you want to update and the index field configuration.</p>
|
|
1082
|
+
* @public
|
|
1083
1083
|
*/
|
|
1084
1084
|
export interface DefineIndexFieldRequest {
|
|
1085
1085
|
/**
|
|
1086
|
-
* @public
|
|
1087
1086
|
* <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>
|
|
1087
|
+
* @public
|
|
1088
1088
|
*/
|
|
1089
1089
|
DomainName: string | undefined;
|
|
1090
1090
|
/**
|
|
1091
|
-
* @public
|
|
1092
1091
|
* <p>The index field and field options you want to configure. </p>
|
|
1092
|
+
* @public
|
|
1093
1093
|
*/
|
|
1094
1094
|
IndexField: IndexField | undefined;
|
|
1095
1095
|
}
|
|
1096
1096
|
/**
|
|
1097
|
-
* @public
|
|
1098
1097
|
* <p>The value of an <code>IndexField</code> and its current status.</p>
|
|
1098
|
+
* @public
|
|
1099
1099
|
*/
|
|
1100
1100
|
export interface IndexFieldStatus {
|
|
1101
1101
|
/**
|
|
1102
|
-
* @public
|
|
1103
1102
|
* <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>
|
|
1103
|
+
* @public
|
|
1104
1104
|
*/
|
|
1105
1105
|
Options: IndexField | undefined;
|
|
1106
1106
|
/**
|
|
1107
|
-
* @public
|
|
1108
1107
|
* <p>The status of domain configuration option.</p>
|
|
1108
|
+
* @public
|
|
1109
1109
|
*/
|
|
1110
1110
|
Status: OptionStatus | undefined;
|
|
1111
1111
|
}
|
|
1112
1112
|
/**
|
|
1113
|
-
* @public
|
|
1114
1113
|
* <p>The result of a <code><a>DefineIndexField</a></code> request. Contains the status of the newly-configured index field.</p>
|
|
1114
|
+
* @public
|
|
1115
1115
|
*/
|
|
1116
1116
|
export interface DefineIndexFieldResponse {
|
|
1117
1117
|
/**
|
|
1118
|
-
* @public
|
|
1119
1118
|
* <p>The value of an <code>IndexField</code> and its current status.</p>
|
|
1119
|
+
* @public
|
|
1120
1120
|
*/
|
|
1121
1121
|
IndexField: IndexFieldStatus | undefined;
|
|
1122
1122
|
}
|
|
@@ -1134,312 +1134,312 @@ export declare const SuggesterFuzzyMatching: {
|
|
|
1134
1134
|
*/
|
|
1135
1135
|
export type SuggesterFuzzyMatching = (typeof SuggesterFuzzyMatching)[keyof typeof SuggesterFuzzyMatching];
|
|
1136
1136
|
/**
|
|
1137
|
-
* @public
|
|
1138
1137
|
* <p>Options for a search suggester.</p>
|
|
1138
|
+
* @public
|
|
1139
1139
|
*/
|
|
1140
1140
|
export interface DocumentSuggesterOptions {
|
|
1141
1141
|
/**
|
|
1142
|
-
* @public
|
|
1143
1142
|
* <p>The name of the index field you want to use for suggestions.
|
|
1144
1143
|
* </p>
|
|
1144
|
+
* @public
|
|
1145
1145
|
*/
|
|
1146
1146
|
SourceField: string | undefined;
|
|
1147
1147
|
/**
|
|
1148
|
-
* @public
|
|
1149
1148
|
* <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>
|
|
1149
|
+
* @public
|
|
1150
1150
|
*/
|
|
1151
1151
|
FuzzyMatching?: SuggesterFuzzyMatching;
|
|
1152
1152
|
/**
|
|
1153
|
-
* @public
|
|
1154
1153
|
* <p>An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest
|
|
1155
1154
|
* integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed
|
|
1156
1155
|
* for suggestions, so sort expressions cannot reference the <code>_score</code> value.
|
|
1157
1156
|
* To sort suggestions using a numeric field or existing expression, simply specify
|
|
1158
1157
|
* the name of the field or expression. If no expression is configured for the suggester, the
|
|
1159
1158
|
* suggestions are sorted with the closest matches listed first.</p>
|
|
1159
|
+
* @public
|
|
1160
1160
|
*/
|
|
1161
1161
|
SortExpression?: string;
|
|
1162
1162
|
}
|
|
1163
1163
|
/**
|
|
1164
|
-
* @public
|
|
1165
1164
|
* <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>
|
|
1165
|
+
* @public
|
|
1166
1166
|
*/
|
|
1167
1167
|
export interface Suggester {
|
|
1168
1168
|
/**
|
|
1169
|
-
* @public
|
|
1170
1169
|
* <p>Names must begin with a letter and can contain the following characters:
|
|
1171
1170
|
* a-z (lowercase), 0-9, and _ (underscore).</p>
|
|
1171
|
+
* @public
|
|
1172
1172
|
*/
|
|
1173
1173
|
SuggesterName: string | undefined;
|
|
1174
1174
|
/**
|
|
1175
|
-
* @public
|
|
1176
1175
|
* <p>Options for a search suggester.</p>
|
|
1176
|
+
* @public
|
|
1177
1177
|
*/
|
|
1178
1178
|
DocumentSuggesterOptions: DocumentSuggesterOptions | undefined;
|
|
1179
1179
|
}
|
|
1180
1180
|
/**
|
|
1181
|
-
* @public
|
|
1182
1181
|
* <p>Container for the parameters to the <code><a>DefineSuggester</a></code> operation. Specifies the name of the domain you want to update and the suggester configuration.</p>
|
|
1182
|
+
* @public
|
|
1183
1183
|
*/
|
|
1184
1184
|
export interface DefineSuggesterRequest {
|
|
1185
1185
|
/**
|
|
1186
|
-
* @public
|
|
1187
1186
|
* <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>
|
|
1187
|
+
* @public
|
|
1188
1188
|
*/
|
|
1189
1189
|
DomainName: string | undefined;
|
|
1190
1190
|
/**
|
|
1191
|
-
* @public
|
|
1192
1191
|
* <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>
|
|
1192
|
+
* @public
|
|
1193
1193
|
*/
|
|
1194
1194
|
Suggester: Suggester | undefined;
|
|
1195
1195
|
}
|
|
1196
1196
|
/**
|
|
1197
|
-
* @public
|
|
1198
1197
|
* <p>The value of a <code>Suggester</code> and its current status.</p>
|
|
1198
|
+
* @public
|
|
1199
1199
|
*/
|
|
1200
1200
|
export interface SuggesterStatus {
|
|
1201
1201
|
/**
|
|
1202
|
-
* @public
|
|
1203
1202
|
* <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>
|
|
1203
|
+
* @public
|
|
1204
1204
|
*/
|
|
1205
1205
|
Options: Suggester | undefined;
|
|
1206
1206
|
/**
|
|
1207
|
-
* @public
|
|
1208
1207
|
* <p>The status of domain configuration option.</p>
|
|
1208
|
+
* @public
|
|
1209
1209
|
*/
|
|
1210
1210
|
Status: OptionStatus | undefined;
|
|
1211
1211
|
}
|
|
1212
1212
|
/**
|
|
1213
|
-
* @public
|
|
1214
1213
|
* <p>The result of a <code>DefineSuggester</code> request. Contains the status of the newly-configured suggester.</p>
|
|
1214
|
+
* @public
|
|
1215
1215
|
*/
|
|
1216
1216
|
export interface DefineSuggesterResponse {
|
|
1217
1217
|
/**
|
|
1218
|
-
* @public
|
|
1219
1218
|
* <p>The value of a <code>Suggester</code> and its current status.</p>
|
|
1219
|
+
* @public
|
|
1220
1220
|
*/
|
|
1221
1221
|
Suggester: SuggesterStatus | undefined;
|
|
1222
1222
|
}
|
|
1223
1223
|
/**
|
|
1224
|
-
* @public
|
|
1225
1224
|
* <p>Container for the parameters to the <code><a>DeleteAnalysisScheme</a></code> operation. Specifies the name of the domain you want to update and the analysis scheme you want to delete. </p>
|
|
1225
|
+
* @public
|
|
1226
1226
|
*/
|
|
1227
1227
|
export interface DeleteAnalysisSchemeRequest {
|
|
1228
1228
|
/**
|
|
1229
|
-
* @public
|
|
1230
1229
|
* <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>
|
|
1230
|
+
* @public
|
|
1231
1231
|
*/
|
|
1232
1232
|
DomainName: string | undefined;
|
|
1233
1233
|
/**
|
|
1234
|
-
* @public
|
|
1235
1234
|
* <p>The name of the analysis scheme you want to delete.</p>
|
|
1235
|
+
* @public
|
|
1236
1236
|
*/
|
|
1237
1237
|
AnalysisSchemeName: string | undefined;
|
|
1238
1238
|
}
|
|
1239
1239
|
/**
|
|
1240
|
-
* @public
|
|
1241
1240
|
* <p>The result of a <code>DeleteAnalysisScheme</code> request. Contains the status of the deleted analysis scheme.</p>
|
|
1241
|
+
* @public
|
|
1242
1242
|
*/
|
|
1243
1243
|
export interface DeleteAnalysisSchemeResponse {
|
|
1244
1244
|
/**
|
|
1245
|
-
* @public
|
|
1246
1245
|
* <p>The status of the analysis scheme being deleted.</p>
|
|
1246
|
+
* @public
|
|
1247
1247
|
*/
|
|
1248
1248
|
AnalysisScheme: AnalysisSchemeStatus | undefined;
|
|
1249
1249
|
}
|
|
1250
1250
|
/**
|
|
1251
|
-
* @public
|
|
1252
1251
|
* <p>Container for the parameters to the <code><a>DeleteDomain</a></code> operation. Specifies the name of the domain you want to delete.</p>
|
|
1252
|
+
* @public
|
|
1253
1253
|
*/
|
|
1254
1254
|
export interface DeleteDomainRequest {
|
|
1255
1255
|
/**
|
|
1256
|
-
* @public
|
|
1257
1256
|
* <p>The name of the domain you want to permanently delete.</p>
|
|
1257
|
+
* @public
|
|
1258
1258
|
*/
|
|
1259
1259
|
DomainName: string | undefined;
|
|
1260
1260
|
}
|
|
1261
1261
|
/**
|
|
1262
|
-
* @public
|
|
1263
1262
|
* <p>The result of a <code>DeleteDomain</code> request. Contains the status of a newly deleted domain, or no status if the domain has already been completely deleted.</p>
|
|
1263
|
+
* @public
|
|
1264
1264
|
*/
|
|
1265
1265
|
export interface DeleteDomainResponse {
|
|
1266
1266
|
/**
|
|
1267
|
-
* @public
|
|
1268
1267
|
* <p>The current status of the search domain.</p>
|
|
1268
|
+
* @public
|
|
1269
1269
|
*/
|
|
1270
1270
|
DomainStatus?: DomainStatus;
|
|
1271
1271
|
}
|
|
1272
1272
|
/**
|
|
1273
|
-
* @public
|
|
1274
1273
|
* <p>Container for the parameters to the <code><a>DeleteExpression</a></code> operation. Specifies the name of the domain you want to update and the name of the expression you want to delete.</p>
|
|
1274
|
+
* @public
|
|
1275
1275
|
*/
|
|
1276
1276
|
export interface DeleteExpressionRequest {
|
|
1277
1277
|
/**
|
|
1278
|
-
* @public
|
|
1279
1278
|
* <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>
|
|
1279
|
+
* @public
|
|
1280
1280
|
*/
|
|
1281
1281
|
DomainName: string | undefined;
|
|
1282
1282
|
/**
|
|
1283
|
-
* @public
|
|
1284
1283
|
* <p>The name of the <code><a>Expression</a></code> to delete.</p>
|
|
1284
|
+
* @public
|
|
1285
1285
|
*/
|
|
1286
1286
|
ExpressionName: string | undefined;
|
|
1287
1287
|
}
|
|
1288
1288
|
/**
|
|
1289
|
-
* @public
|
|
1290
1289
|
* <p>The result of a <code><a>DeleteExpression</a></code> request. Specifies the expression being deleted.</p>
|
|
1290
|
+
* @public
|
|
1291
1291
|
*/
|
|
1292
1292
|
export interface DeleteExpressionResponse {
|
|
1293
1293
|
/**
|
|
1294
|
-
* @public
|
|
1295
1294
|
* <p>The status of the expression being deleted.</p>
|
|
1295
|
+
* @public
|
|
1296
1296
|
*/
|
|
1297
1297
|
Expression: ExpressionStatus | undefined;
|
|
1298
1298
|
}
|
|
1299
1299
|
/**
|
|
1300
|
-
* @public
|
|
1301
1300
|
* <p>Container for the parameters to the <code><a>DeleteIndexField</a></code> operation. Specifies the name of the domain you want to update and the name of the index field you want to delete.</p>
|
|
1301
|
+
* @public
|
|
1302
1302
|
*/
|
|
1303
1303
|
export interface DeleteIndexFieldRequest {
|
|
1304
1304
|
/**
|
|
1305
|
-
* @public
|
|
1306
1305
|
* <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>
|
|
1306
|
+
* @public
|
|
1307
1307
|
*/
|
|
1308
1308
|
DomainName: string | undefined;
|
|
1309
1309
|
/**
|
|
1310
|
-
* @public
|
|
1311
1310
|
* <p>The name of the index field your want to remove from the domain's indexing options.</p>
|
|
1311
|
+
* @public
|
|
1312
1312
|
*/
|
|
1313
1313
|
IndexFieldName: string | undefined;
|
|
1314
1314
|
}
|
|
1315
1315
|
/**
|
|
1316
|
-
* @public
|
|
1317
1316
|
* <p>The result of a <code><a>DeleteIndexField</a></code> request.</p>
|
|
1317
|
+
* @public
|
|
1318
1318
|
*/
|
|
1319
1319
|
export interface DeleteIndexFieldResponse {
|
|
1320
1320
|
/**
|
|
1321
|
-
* @public
|
|
1322
1321
|
* <p>The status of the index field being deleted.</p>
|
|
1322
|
+
* @public
|
|
1323
1323
|
*/
|
|
1324
1324
|
IndexField: IndexFieldStatus | undefined;
|
|
1325
1325
|
}
|
|
1326
1326
|
/**
|
|
1327
|
-
* @public
|
|
1328
1327
|
* <p>Container for the parameters to the <code><a>DeleteSuggester</a></code> operation. Specifies the name of the domain you want to update and name of the suggester you want to delete.</p>
|
|
1328
|
+
* @public
|
|
1329
1329
|
*/
|
|
1330
1330
|
export interface DeleteSuggesterRequest {
|
|
1331
1331
|
/**
|
|
1332
|
-
* @public
|
|
1333
1332
|
* <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>
|
|
1333
|
+
* @public
|
|
1334
1334
|
*/
|
|
1335
1335
|
DomainName: string | undefined;
|
|
1336
1336
|
/**
|
|
1337
|
-
* @public
|
|
1338
1337
|
* <p>Specifies the name of the suggester you want to delete.</p>
|
|
1338
|
+
* @public
|
|
1339
1339
|
*/
|
|
1340
1340
|
SuggesterName: string | undefined;
|
|
1341
1341
|
}
|
|
1342
1342
|
/**
|
|
1343
|
-
* @public
|
|
1344
1343
|
* <p>The result of a <code>DeleteSuggester</code> request. Contains the status of the deleted suggester.</p>
|
|
1344
|
+
* @public
|
|
1345
1345
|
*/
|
|
1346
1346
|
export interface DeleteSuggesterResponse {
|
|
1347
1347
|
/**
|
|
1348
|
-
* @public
|
|
1349
1348
|
* <p>The status of the suggester being deleted.</p>
|
|
1349
|
+
* @public
|
|
1350
1350
|
*/
|
|
1351
1351
|
Suggester: SuggesterStatus | undefined;
|
|
1352
1352
|
}
|
|
1353
1353
|
/**
|
|
1354
|
-
* @public
|
|
1355
1354
|
* <p>Container for the parameters to the <code><a>DescribeAnalysisSchemes</a></code> operation. Specifies the name of the domain you want to describe. To limit the response to particular analysis schemes, specify the names of the analysis schemes you want to describe. To show the active configuration and exclude any pending changes, set the <code>Deployed</code> option to <code>true</code>. </p>
|
|
1355
|
+
* @public
|
|
1356
1356
|
*/
|
|
1357
1357
|
export interface DescribeAnalysisSchemesRequest {
|
|
1358
1358
|
/**
|
|
1359
|
-
* @public
|
|
1360
1359
|
* <p>The name of the domain you want to describe.</p>
|
|
1360
|
+
* @public
|
|
1361
1361
|
*/
|
|
1362
1362
|
DomainName: string | undefined;
|
|
1363
1363
|
/**
|
|
1364
|
-
* @public
|
|
1365
1364
|
* <p>The analysis schemes you want to describe.</p>
|
|
1365
|
+
* @public
|
|
1366
1366
|
*/
|
|
1367
1367
|
AnalysisSchemeNames?: string[];
|
|
1368
1368
|
/**
|
|
1369
|
-
* @public
|
|
1370
1369
|
* <p>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</p>
|
|
1370
|
+
* @public
|
|
1371
1371
|
*/
|
|
1372
1372
|
Deployed?: boolean;
|
|
1373
1373
|
}
|
|
1374
1374
|
/**
|
|
1375
|
-
* @public
|
|
1376
1375
|
* <p>The result of a <code>DescribeAnalysisSchemes</code> request. Contains the analysis schemes configured for the domain specified in the request.</p>
|
|
1376
|
+
* @public
|
|
1377
1377
|
*/
|
|
1378
1378
|
export interface DescribeAnalysisSchemesResponse {
|
|
1379
1379
|
/**
|
|
1380
|
-
* @public
|
|
1381
1380
|
* <p>The analysis scheme descriptions.</p>
|
|
1381
|
+
* @public
|
|
1382
1382
|
*/
|
|
1383
1383
|
AnalysisSchemes: AnalysisSchemeStatus[] | undefined;
|
|
1384
1384
|
}
|
|
1385
1385
|
/**
|
|
1386
|
-
* @public
|
|
1387
1386
|
* <p>Container for the parameters to the <code><a>DescribeAvailabilityOptions</a></code> operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to <code>true</code>.</p>
|
|
1387
|
+
* @public
|
|
1388
1388
|
*/
|
|
1389
1389
|
export interface DescribeAvailabilityOptionsRequest {
|
|
1390
1390
|
/**
|
|
1391
|
-
* @public
|
|
1392
1391
|
* <p>The name of the domain you want to describe.</p>
|
|
1392
|
+
* @public
|
|
1393
1393
|
*/
|
|
1394
1394
|
DomainName: string | undefined;
|
|
1395
1395
|
/**
|
|
1396
|
-
* @public
|
|
1397
1396
|
* <p>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</p>
|
|
1397
|
+
* @public
|
|
1398
1398
|
*/
|
|
1399
1399
|
Deployed?: boolean;
|
|
1400
1400
|
}
|
|
1401
1401
|
/**
|
|
1402
|
-
* @public
|
|
1403
1402
|
* <p>The status and configuration of the domain's availability options.</p>
|
|
1403
|
+
* @public
|
|
1404
1404
|
*/
|
|
1405
1405
|
export interface AvailabilityOptionsStatus {
|
|
1406
1406
|
/**
|
|
1407
|
-
* @public
|
|
1408
1407
|
* <p>The availability options configured for the domain.</p>
|
|
1408
|
+
* @public
|
|
1409
1409
|
*/
|
|
1410
1410
|
Options: boolean | undefined;
|
|
1411
1411
|
/**
|
|
1412
|
-
* @public
|
|
1413
1412
|
* <p>The status of domain configuration option.</p>
|
|
1413
|
+
* @public
|
|
1414
1414
|
*/
|
|
1415
1415
|
Status: OptionStatus | undefined;
|
|
1416
1416
|
}
|
|
1417
1417
|
/**
|
|
1418
|
-
* @public
|
|
1419
1418
|
* <p>The result of a <code>DescribeAvailabilityOptions</code> request. Indicates whether or not the Multi-AZ option is enabled for the domain specified in the request. </p>
|
|
1419
|
+
* @public
|
|
1420
1420
|
*/
|
|
1421
1421
|
export interface DescribeAvailabilityOptionsResponse {
|
|
1422
1422
|
/**
|
|
1423
|
-
* @public
|
|
1424
1423
|
* <p>The availability options configured for the domain. Indicates whether Multi-AZ is enabled for the domain. </p>
|
|
1424
|
+
* @public
|
|
1425
1425
|
*/
|
|
1426
1426
|
AvailabilityOptions?: AvailabilityOptionsStatus;
|
|
1427
1427
|
}
|
|
1428
1428
|
/**
|
|
1429
|
-
* @public
|
|
1430
1429
|
* <p>The request was rejected because it attempted an operation which is not enabled.</p>
|
|
1430
|
+
* @public
|
|
1431
1431
|
*/
|
|
1432
1432
|
export declare class DisabledOperationException extends __BaseException {
|
|
1433
1433
|
readonly name: "DisabledOperationException";
|
|
1434
1434
|
readonly $fault: "client";
|
|
1435
1435
|
/**
|
|
1436
|
-
* @public
|
|
1437
1436
|
* <p>A machine-parsable string error or warning code.</p>
|
|
1437
|
+
* @public
|
|
1438
1438
|
*/
|
|
1439
1439
|
Code?: string;
|
|
1440
1440
|
/**
|
|
1441
|
-
* @public
|
|
1442
1441
|
* <p>A human-readable string error or warning message.</p>
|
|
1442
|
+
* @public
|
|
1443
1443
|
*/
|
|
1444
1444
|
Message?: string;
|
|
1445
1445
|
/**
|
|
@@ -1448,18 +1448,18 @@ export declare class DisabledOperationException extends __BaseException {
|
|
|
1448
1448
|
constructor(opts: __ExceptionOptionType<DisabledOperationException, __BaseException>);
|
|
1449
1449
|
}
|
|
1450
1450
|
/**
|
|
1451
|
-
* @public
|
|
1452
1451
|
* <p>Container for the parameters to the <code><a>DescribeDomainEndpointOptions</a></code> operation. Specify the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to <code>true</code>.</p>
|
|
1452
|
+
* @public
|
|
1453
1453
|
*/
|
|
1454
1454
|
export interface DescribeDomainEndpointOptionsRequest {
|
|
1455
1455
|
/**
|
|
1456
|
-
* @public
|
|
1457
1456
|
* <p>A string that represents the name of a domain.</p>
|
|
1457
|
+
* @public
|
|
1458
1458
|
*/
|
|
1459
1459
|
DomainName: string | undefined;
|
|
1460
1460
|
/**
|
|
1461
|
-
* @public
|
|
1462
1461
|
* <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>
|
|
1462
|
+
* @public
|
|
1463
1463
|
*/
|
|
1464
1464
|
Deployed?: boolean;
|
|
1465
1465
|
}
|
|
@@ -1476,143 +1476,143 @@ export declare const TLSSecurityPolicy: {
|
|
|
1476
1476
|
*/
|
|
1477
1477
|
export type TLSSecurityPolicy = (typeof TLSSecurityPolicy)[keyof typeof TLSSecurityPolicy];
|
|
1478
1478
|
/**
|
|
1479
|
-
* @public
|
|
1480
1479
|
* <p>The domain's endpoint options.</p>
|
|
1480
|
+
* @public
|
|
1481
1481
|
*/
|
|
1482
1482
|
export interface DomainEndpointOptions {
|
|
1483
1483
|
/**
|
|
1484
|
-
* @public
|
|
1485
1484
|
* <p>Whether the domain is HTTPS only enabled.</p>
|
|
1485
|
+
* @public
|
|
1486
1486
|
*/
|
|
1487
1487
|
EnforceHTTPS?: boolean;
|
|
1488
1488
|
/**
|
|
1489
|
-
* @public
|
|
1490
1489
|
* <p>The minimum required TLS version</p>
|
|
1490
|
+
* @public
|
|
1491
1491
|
*/
|
|
1492
1492
|
TLSSecurityPolicy?: TLSSecurityPolicy;
|
|
1493
1493
|
}
|
|
1494
1494
|
/**
|
|
1495
|
-
* @public
|
|
1496
1495
|
* <p>The configuration and status of the domain's endpoint options.</p>
|
|
1496
|
+
* @public
|
|
1497
1497
|
*/
|
|
1498
1498
|
export interface DomainEndpointOptionsStatus {
|
|
1499
1499
|
/**
|
|
1500
|
-
* @public
|
|
1501
1500
|
* <p>The domain endpoint options configured for the domain.</p>
|
|
1501
|
+
* @public
|
|
1502
1502
|
*/
|
|
1503
1503
|
Options: DomainEndpointOptions | undefined;
|
|
1504
1504
|
/**
|
|
1505
|
-
* @public
|
|
1506
1505
|
* <p>The status of the configured domain endpoint options.</p>
|
|
1506
|
+
* @public
|
|
1507
1507
|
*/
|
|
1508
1508
|
Status: OptionStatus | undefined;
|
|
1509
1509
|
}
|
|
1510
1510
|
/**
|
|
1511
|
-
* @public
|
|
1512
1511
|
* <p>The result of a <code>DescribeDomainEndpointOptions</code> request. Contains the status and configuration of a search domain's endpoint options. </p>
|
|
1512
|
+
* @public
|
|
1513
1513
|
*/
|
|
1514
1514
|
export interface DescribeDomainEndpointOptionsResponse {
|
|
1515
1515
|
/**
|
|
1516
|
-
* @public
|
|
1517
1516
|
* <p>The status and configuration of a search domain's endpoint options.</p>
|
|
1517
|
+
* @public
|
|
1518
1518
|
*/
|
|
1519
1519
|
DomainEndpointOptions?: DomainEndpointOptionsStatus;
|
|
1520
1520
|
}
|
|
1521
1521
|
/**
|
|
1522
|
-
* @public
|
|
1523
1522
|
* <p>Container for the parameters to the <code><a>DescribeDomains</a></code> operation. By default shows the status of all domains. To restrict the response to particular domains, specify the names of the domains you want to describe.</p>
|
|
1523
|
+
* @public
|
|
1524
1524
|
*/
|
|
1525
1525
|
export interface DescribeDomainsRequest {
|
|
1526
1526
|
/**
|
|
1527
|
-
* @public
|
|
1528
1527
|
* <p>The names of the domains you want to include in the response.</p>
|
|
1528
|
+
* @public
|
|
1529
1529
|
*/
|
|
1530
1530
|
DomainNames?: string[];
|
|
1531
1531
|
}
|
|
1532
1532
|
/**
|
|
1533
|
-
* @public
|
|
1534
1533
|
* <p>The result of a <code>DescribeDomains</code> request. Contains the status of the domains specified in the request or all domains owned by the account.</p>
|
|
1534
|
+
* @public
|
|
1535
1535
|
*/
|
|
1536
1536
|
export interface DescribeDomainsResponse {
|
|
1537
1537
|
/**
|
|
1538
|
-
* @public
|
|
1539
1538
|
* <p>A list that contains the status of each requested domain.</p>
|
|
1539
|
+
* @public
|
|
1540
1540
|
*/
|
|
1541
1541
|
DomainStatusList: DomainStatus[] | undefined;
|
|
1542
1542
|
}
|
|
1543
1543
|
/**
|
|
1544
|
-
* @public
|
|
1545
1544
|
* <p>Container for the parameters to the <code><a>DescribeDomains</a></code> operation.
|
|
1546
1545
|
* Specifies the name of the domain you want to describe. To restrict the response to particular expressions, specify the names of the expressions you want to describe. To show the active configuration and exclude any pending changes, set the <code>Deployed</code> option to <code>true</code>.</p>
|
|
1546
|
+
* @public
|
|
1547
1547
|
*/
|
|
1548
1548
|
export interface DescribeExpressionsRequest {
|
|
1549
1549
|
/**
|
|
1550
|
-
* @public
|
|
1551
1550
|
* <p>The name of the domain you want to describe.</p>
|
|
1551
|
+
* @public
|
|
1552
1552
|
*/
|
|
1553
1553
|
DomainName: string | undefined;
|
|
1554
1554
|
/**
|
|
1555
|
-
* @public
|
|
1556
1555
|
* <p>Limits the <code><a>DescribeExpressions</a></code> response to the specified expressions. If not specified, all expressions are shown.</p>
|
|
1556
|
+
* @public
|
|
1557
1557
|
*/
|
|
1558
1558
|
ExpressionNames?: string[];
|
|
1559
1559
|
/**
|
|
1560
|
-
* @public
|
|
1561
1560
|
* <p>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</p>
|
|
1561
|
+
* @public
|
|
1562
1562
|
*/
|
|
1563
1563
|
Deployed?: boolean;
|
|
1564
1564
|
}
|
|
1565
1565
|
/**
|
|
1566
|
-
* @public
|
|
1567
1566
|
* <p>The result of a <code>DescribeExpressions</code> request. Contains the expressions configured for the domain specified in the request.</p>
|
|
1567
|
+
* @public
|
|
1568
1568
|
*/
|
|
1569
1569
|
export interface DescribeExpressionsResponse {
|
|
1570
1570
|
/**
|
|
1571
|
-
* @public
|
|
1572
1571
|
* <p>The expressions configured for the domain.</p>
|
|
1572
|
+
* @public
|
|
1573
1573
|
*/
|
|
1574
1574
|
Expressions: ExpressionStatus[] | undefined;
|
|
1575
1575
|
}
|
|
1576
1576
|
/**
|
|
1577
|
-
* @public
|
|
1578
1577
|
* <p>Container for the parameters to the <code><a>DescribeIndexFields</a></code> operation. Specifies the name of the domain you want to describe. To restrict the response to particular index fields, specify the names of the index fields you want to describe. To show the active configuration and exclude any pending changes, set the <code>Deployed</code> option to <code>true</code>.</p>
|
|
1578
|
+
* @public
|
|
1579
1579
|
*/
|
|
1580
1580
|
export interface DescribeIndexFieldsRequest {
|
|
1581
1581
|
/**
|
|
1582
|
-
* @public
|
|
1583
1582
|
* <p>The name of the domain you want to describe.</p>
|
|
1583
|
+
* @public
|
|
1584
1584
|
*/
|
|
1585
1585
|
DomainName: string | undefined;
|
|
1586
1586
|
/**
|
|
1587
|
-
* @public
|
|
1588
1587
|
* <p>A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.</p>
|
|
1588
|
+
* @public
|
|
1589
1589
|
*/
|
|
1590
1590
|
FieldNames?: string[];
|
|
1591
1591
|
/**
|
|
1592
|
-
* @public
|
|
1593
1592
|
* <p>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</p>
|
|
1593
|
+
* @public
|
|
1594
1594
|
*/
|
|
1595
1595
|
Deployed?: boolean;
|
|
1596
1596
|
}
|
|
1597
1597
|
/**
|
|
1598
|
-
* @public
|
|
1599
1598
|
* <p>The result of a <code>DescribeIndexFields</code> request. Contains the index fields configured for the domain specified in the request.</p>
|
|
1599
|
+
* @public
|
|
1600
1600
|
*/
|
|
1601
1601
|
export interface DescribeIndexFieldsResponse {
|
|
1602
1602
|
/**
|
|
1603
|
-
* @public
|
|
1604
1603
|
* <p>The index fields configured for the domain.</p>
|
|
1604
|
+
* @public
|
|
1605
1605
|
*/
|
|
1606
1606
|
IndexFields: IndexFieldStatus[] | undefined;
|
|
1607
1607
|
}
|
|
1608
1608
|
/**
|
|
1609
|
-
* @public
|
|
1610
1609
|
* <p>Container for the parameters to the <code><a>DescribeScalingParameters</a></code> operation. Specifies the name of the domain you want to describe. </p>
|
|
1610
|
+
* @public
|
|
1611
1611
|
*/
|
|
1612
1612
|
export interface DescribeScalingParametersRequest {
|
|
1613
1613
|
/**
|
|
1614
|
-
* @public
|
|
1615
1614
|
* <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>
|
|
1615
|
+
* @public
|
|
1616
1616
|
*/
|
|
1617
1617
|
DomainName: string | undefined;
|
|
1618
1618
|
}
|
|
@@ -1644,267 +1644,267 @@ export declare const PartitionInstanceType: {
|
|
|
1644
1644
|
*/
|
|
1645
1645
|
export type PartitionInstanceType = (typeof PartitionInstanceType)[keyof typeof PartitionInstanceType];
|
|
1646
1646
|
/**
|
|
1647
|
-
* @public
|
|
1648
1647
|
* <p>The desired instance type and desired number of replicas of each index partition.</p>
|
|
1648
|
+
* @public
|
|
1649
1649
|
*/
|
|
1650
1650
|
export interface ScalingParameters {
|
|
1651
1651
|
/**
|
|
1652
|
-
* @public
|
|
1653
1652
|
* <p>The instance type that you want to preconfigure for your domain. For example, <code>search.m1.small</code>.</p>
|
|
1653
|
+
* @public
|
|
1654
1654
|
*/
|
|
1655
1655
|
DesiredInstanceType?: PartitionInstanceType;
|
|
1656
1656
|
/**
|
|
1657
|
-
* @public
|
|
1658
1657
|
* <p>The number of replicas you want to preconfigure for each index partition.</p>
|
|
1658
|
+
* @public
|
|
1659
1659
|
*/
|
|
1660
1660
|
DesiredReplicationCount?: number;
|
|
1661
1661
|
/**
|
|
1662
|
-
* @public
|
|
1663
1662
|
* <p>The number of partitions you want to preconfigure for your domain. Only valid when
|
|
1664
1663
|
* you select <code>m2.2xlarge</code> as the desired instance type.</p>
|
|
1664
|
+
* @public
|
|
1665
1665
|
*/
|
|
1666
1666
|
DesiredPartitionCount?: number;
|
|
1667
1667
|
}
|
|
1668
1668
|
/**
|
|
1669
|
-
* @public
|
|
1670
1669
|
* <p>The status and configuration of a search domain's scaling parameters. </p>
|
|
1670
|
+
* @public
|
|
1671
1671
|
*/
|
|
1672
1672
|
export interface ScalingParametersStatus {
|
|
1673
1673
|
/**
|
|
1674
|
-
* @public
|
|
1675
1674
|
* <p>The desired instance type and desired number of replicas of each index partition.</p>
|
|
1675
|
+
* @public
|
|
1676
1676
|
*/
|
|
1677
1677
|
Options: ScalingParameters | undefined;
|
|
1678
1678
|
/**
|
|
1679
|
-
* @public
|
|
1680
1679
|
* <p>The status of domain configuration option.</p>
|
|
1680
|
+
* @public
|
|
1681
1681
|
*/
|
|
1682
1682
|
Status: OptionStatus | undefined;
|
|
1683
1683
|
}
|
|
1684
1684
|
/**
|
|
1685
|
-
* @public
|
|
1686
1685
|
* <p>The result of a <code>DescribeScalingParameters</code> request. Contains the scaling parameters configured for the domain specified in the request.</p>
|
|
1686
|
+
* @public
|
|
1687
1687
|
*/
|
|
1688
1688
|
export interface DescribeScalingParametersResponse {
|
|
1689
1689
|
/**
|
|
1690
|
-
* @public
|
|
1691
1690
|
* <p>The status and configuration of a search domain's scaling parameters. </p>
|
|
1691
|
+
* @public
|
|
1692
1692
|
*/
|
|
1693
1693
|
ScalingParameters: ScalingParametersStatus | undefined;
|
|
1694
1694
|
}
|
|
1695
1695
|
/**
|
|
1696
|
-
* @public
|
|
1697
1696
|
* <p>Container for the parameters to the <code><a>DescribeServiceAccessPolicies</a></code> operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the <code>Deployed</code> option to <code>true</code>.</p>
|
|
1697
|
+
* @public
|
|
1698
1698
|
*/
|
|
1699
1699
|
export interface DescribeServiceAccessPoliciesRequest {
|
|
1700
1700
|
/**
|
|
1701
|
-
* @public
|
|
1702
1701
|
* <p>The name of the domain you want to describe.</p>
|
|
1702
|
+
* @public
|
|
1703
1703
|
*/
|
|
1704
1704
|
DomainName: string | undefined;
|
|
1705
1705
|
/**
|
|
1706
|
-
* @public
|
|
1707
1706
|
* <p>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</p>
|
|
1707
|
+
* @public
|
|
1708
1708
|
*/
|
|
1709
1709
|
Deployed?: boolean;
|
|
1710
1710
|
}
|
|
1711
1711
|
/**
|
|
1712
|
-
* @public
|
|
1713
1712
|
* <p>The configured access rules for the domain's document and search endpoints, and the current status of those rules.</p>
|
|
1713
|
+
* @public
|
|
1714
1714
|
*/
|
|
1715
1715
|
export interface AccessPoliciesStatus {
|
|
1716
1716
|
/**
|
|
1717
|
-
* @public
|
|
1718
1717
|
* <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>
|
|
1718
|
+
* @public
|
|
1719
1719
|
*/
|
|
1720
1720
|
Options: string | undefined;
|
|
1721
1721
|
/**
|
|
1722
|
-
* @public
|
|
1723
1722
|
* <p>The status of domain configuration option.</p>
|
|
1723
|
+
* @public
|
|
1724
1724
|
*/
|
|
1725
1725
|
Status: OptionStatus | undefined;
|
|
1726
1726
|
}
|
|
1727
1727
|
/**
|
|
1728
|
-
* @public
|
|
1729
1728
|
* <p>The result of a <code>DescribeServiceAccessPolicies</code> request.</p>
|
|
1729
|
+
* @public
|
|
1730
1730
|
*/
|
|
1731
1731
|
export interface DescribeServiceAccessPoliciesResponse {
|
|
1732
1732
|
/**
|
|
1733
|
-
* @public
|
|
1734
1733
|
* <p>The access rules configured for the domain specified in the request.</p>
|
|
1734
|
+
* @public
|
|
1735
1735
|
*/
|
|
1736
1736
|
AccessPolicies: AccessPoliciesStatus | undefined;
|
|
1737
1737
|
}
|
|
1738
1738
|
/**
|
|
1739
|
-
* @public
|
|
1740
1739
|
* <p>Container for the parameters to the <code><a>DescribeSuggester</a></code> operation. Specifies the name of the domain you want to describe. To restrict the response to particular suggesters, specify the names of the suggesters you want to describe. To show the active configuration and exclude any pending changes, set the <code>Deployed</code> option to <code>true</code>.</p>
|
|
1740
|
+
* @public
|
|
1741
1741
|
*/
|
|
1742
1742
|
export interface DescribeSuggestersRequest {
|
|
1743
1743
|
/**
|
|
1744
|
-
* @public
|
|
1745
1744
|
* <p>The name of the domain you want to describe.</p>
|
|
1745
|
+
* @public
|
|
1746
1746
|
*/
|
|
1747
1747
|
DomainName: string | undefined;
|
|
1748
1748
|
/**
|
|
1749
|
-
* @public
|
|
1750
1749
|
* <p>The suggesters you want to describe.</p>
|
|
1750
|
+
* @public
|
|
1751
1751
|
*/
|
|
1752
1752
|
SuggesterNames?: string[];
|
|
1753
1753
|
/**
|
|
1754
|
-
* @public
|
|
1755
1754
|
* <p>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</p>
|
|
1755
|
+
* @public
|
|
1756
1756
|
*/
|
|
1757
1757
|
Deployed?: boolean;
|
|
1758
1758
|
}
|
|
1759
1759
|
/**
|
|
1760
|
-
* @public
|
|
1761
1760
|
* <p>The result of a <code>DescribeSuggesters</code> request.</p>
|
|
1761
|
+
* @public
|
|
1762
1762
|
*/
|
|
1763
1763
|
export interface DescribeSuggestersResponse {
|
|
1764
1764
|
/**
|
|
1765
|
-
* @public
|
|
1766
1765
|
* <p>The suggesters configured for the domain specified in the request.</p>
|
|
1766
|
+
* @public
|
|
1767
1767
|
*/
|
|
1768
1768
|
Suggesters: SuggesterStatus[] | undefined;
|
|
1769
1769
|
}
|
|
1770
1770
|
/**
|
|
1771
|
-
* @public
|
|
1772
1771
|
* <p>Container for the parameters to the <code><a>IndexDocuments</a></code> operation. Specifies the name of the domain you want to re-index.</p>
|
|
1772
|
+
* @public
|
|
1773
1773
|
*/
|
|
1774
1774
|
export interface IndexDocumentsRequest {
|
|
1775
1775
|
/**
|
|
1776
|
-
* @public
|
|
1777
1776
|
* <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>
|
|
1777
|
+
* @public
|
|
1778
1778
|
*/
|
|
1779
1779
|
DomainName: string | undefined;
|
|
1780
1780
|
}
|
|
1781
1781
|
/**
|
|
1782
|
-
* @public
|
|
1783
1782
|
* <p>The result of an <code>IndexDocuments</code> request. Contains the status of the indexing operation, including the fields being indexed.</p>
|
|
1783
|
+
* @public
|
|
1784
1784
|
*/
|
|
1785
1785
|
export interface IndexDocumentsResponse {
|
|
1786
1786
|
/**
|
|
1787
|
-
* @public
|
|
1788
1787
|
* <p>The names of the fields that are currently being indexed.</p>
|
|
1788
|
+
* @public
|
|
1789
1789
|
*/
|
|
1790
1790
|
FieldNames?: string[];
|
|
1791
1791
|
}
|
|
1792
1792
|
/**
|
|
1793
|
-
* @public
|
|
1794
1793
|
* <p>The result of a <code>ListDomainNames</code> request. Contains a list of the domains owned by an account.</p>
|
|
1794
|
+
* @public
|
|
1795
1795
|
*/
|
|
1796
1796
|
export interface ListDomainNamesResponse {
|
|
1797
1797
|
/**
|
|
1798
|
-
* @public
|
|
1799
1798
|
* <p>The names of the search domains owned by an account.</p>
|
|
1799
|
+
* @public
|
|
1800
1800
|
*/
|
|
1801
1801
|
DomainNames?: Record<string, string>;
|
|
1802
1802
|
}
|
|
1803
1803
|
/**
|
|
1804
|
-
* @public
|
|
1805
1804
|
* <p>Container for the parameters to the <code><a>UpdateAvailabilityOptions</a></code> operation. Specifies the name of the domain you want to update and the Multi-AZ availability option.</p>
|
|
1805
|
+
* @public
|
|
1806
1806
|
*/
|
|
1807
1807
|
export interface UpdateAvailabilityOptionsRequest {
|
|
1808
1808
|
/**
|
|
1809
|
-
* @public
|
|
1810
1809
|
* <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>
|
|
1810
|
+
* @public
|
|
1811
1811
|
*/
|
|
1812
1812
|
DomainName: string | undefined;
|
|
1813
1813
|
/**
|
|
1814
|
-
* @public
|
|
1815
1814
|
* <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>
|
|
1815
|
+
* @public
|
|
1816
1816
|
*/
|
|
1817
1817
|
MultiAZ: boolean | undefined;
|
|
1818
1818
|
}
|
|
1819
1819
|
/**
|
|
1820
|
-
* @public
|
|
1821
1820
|
* <p>The result of a <code>UpdateAvailabilityOptions</code> request. Contains the status of the domain's availability options. </p>
|
|
1821
|
+
* @public
|
|
1822
1822
|
*/
|
|
1823
1823
|
export interface UpdateAvailabilityOptionsResponse {
|
|
1824
1824
|
/**
|
|
1825
|
-
* @public
|
|
1826
1825
|
* <p>The newly-configured availability options. Indicates whether Multi-AZ is enabled for the domain. </p>
|
|
1826
|
+
* @public
|
|
1827
1827
|
*/
|
|
1828
1828
|
AvailabilityOptions?: AvailabilityOptionsStatus;
|
|
1829
1829
|
}
|
|
1830
1830
|
/**
|
|
1831
|
-
* @public
|
|
1832
1831
|
* <p>Container for the parameters to the <code><a>UpdateDomainEndpointOptions</a></code> operation. Specifies the name of the domain you want to update and the domain endpoint options.</p>
|
|
1832
|
+
* @public
|
|
1833
1833
|
*/
|
|
1834
1834
|
export interface UpdateDomainEndpointOptionsRequest {
|
|
1835
1835
|
/**
|
|
1836
|
-
* @public
|
|
1837
1836
|
* <p>A string that represents the name of a domain.</p>
|
|
1837
|
+
* @public
|
|
1838
1838
|
*/
|
|
1839
1839
|
DomainName: string | undefined;
|
|
1840
1840
|
/**
|
|
1841
|
-
* @public
|
|
1842
1841
|
* <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>
|
|
1842
|
+
* @public
|
|
1843
1843
|
*/
|
|
1844
1844
|
DomainEndpointOptions: DomainEndpointOptions | undefined;
|
|
1845
1845
|
}
|
|
1846
1846
|
/**
|
|
1847
|
-
* @public
|
|
1848
1847
|
* <p>The result of a <code>UpdateDomainEndpointOptions</code> request. Contains the configuration and status of the domain's endpoint options. </p>
|
|
1848
|
+
* @public
|
|
1849
1849
|
*/
|
|
1850
1850
|
export interface UpdateDomainEndpointOptionsResponse {
|
|
1851
1851
|
/**
|
|
1852
|
-
* @public
|
|
1853
1852
|
* <p>The newly-configured domain endpoint options.</p>
|
|
1853
|
+
* @public
|
|
1854
1854
|
*/
|
|
1855
1855
|
DomainEndpointOptions?: DomainEndpointOptionsStatus;
|
|
1856
1856
|
}
|
|
1857
1857
|
/**
|
|
1858
|
-
* @public
|
|
1859
1858
|
* <p>Container for the parameters to the <code><a>UpdateScalingParameters</a></code> operation. Specifies the name of the domain you want to update and the scaling parameters you want to configure.</p>
|
|
1859
|
+
* @public
|
|
1860
1860
|
*/
|
|
1861
1861
|
export interface UpdateScalingParametersRequest {
|
|
1862
1862
|
/**
|
|
1863
|
-
* @public
|
|
1864
1863
|
* <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>
|
|
1864
|
+
* @public
|
|
1865
1865
|
*/
|
|
1866
1866
|
DomainName: string | undefined;
|
|
1867
1867
|
/**
|
|
1868
|
-
* @public
|
|
1869
1868
|
* <p>The desired instance type and desired number of replicas of each index partition.</p>
|
|
1869
|
+
* @public
|
|
1870
1870
|
*/
|
|
1871
1871
|
ScalingParameters: ScalingParameters | undefined;
|
|
1872
1872
|
}
|
|
1873
1873
|
/**
|
|
1874
|
-
* @public
|
|
1875
1874
|
* <p>The result of a <code>UpdateScalingParameters</code> request. Contains the status of the newly-configured scaling parameters.</p>
|
|
1875
|
+
* @public
|
|
1876
1876
|
*/
|
|
1877
1877
|
export interface UpdateScalingParametersResponse {
|
|
1878
1878
|
/**
|
|
1879
|
-
* @public
|
|
1880
1879
|
* <p>The status and configuration of a search domain's scaling parameters. </p>
|
|
1880
|
+
* @public
|
|
1881
1881
|
*/
|
|
1882
1882
|
ScalingParameters: ScalingParametersStatus | undefined;
|
|
1883
1883
|
}
|
|
1884
1884
|
/**
|
|
1885
|
-
* @public
|
|
1886
1885
|
* <p>Container for the parameters to the <code><a>UpdateServiceAccessPolicies</a></code> operation. Specifies the name of the domain you want to update and the access rules you want to configure.</p>
|
|
1886
|
+
* @public
|
|
1887
1887
|
*/
|
|
1888
1888
|
export interface UpdateServiceAccessPoliciesRequest {
|
|
1889
1889
|
/**
|
|
1890
|
-
* @public
|
|
1891
1890
|
* <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>
|
|
1891
|
+
* @public
|
|
1892
1892
|
*/
|
|
1893
1893
|
DomainName: string | undefined;
|
|
1894
1894
|
/**
|
|
1895
|
-
* @public
|
|
1896
1895
|
* <p>The access rules you want to configure. These rules replace any existing rules. </p>
|
|
1896
|
+
* @public
|
|
1897
1897
|
*/
|
|
1898
1898
|
AccessPolicies: string | undefined;
|
|
1899
1899
|
}
|
|
1900
1900
|
/**
|
|
1901
|
-
* @public
|
|
1902
1901
|
* <p>The result of an <code>UpdateServiceAccessPolicies</code> request. Contains the new access policies.</p>
|
|
1902
|
+
* @public
|
|
1903
1903
|
*/
|
|
1904
1904
|
export interface UpdateServiceAccessPoliciesResponse {
|
|
1905
1905
|
/**
|
|
1906
|
-
* @public
|
|
1907
1906
|
* <p>The access rules configured for the domain.</p>
|
|
1907
|
+
* @public
|
|
1908
1908
|
*/
|
|
1909
1909
|
AccessPolicies: AccessPoliciesStatus | undefined;
|
|
1910
1910
|
}
|