1 | import {Request} from '../lib/request';
|
2 | import {Response} from '../lib/response';
|
3 | import {AWSError} from '../lib/error';
|
4 | import {Service} from '../lib/service';
|
5 | import {ServiceConfigurationOptions} from '../lib/service';
|
6 | import {ConfigBase as Config} from '../lib/config';
|
7 | interface Blob {}
|
8 | declare class CloudSearch extends Service {
|
9 | |
10 |
|
11 |
|
12 | constructor(options?: CloudSearch.Types.ClientConfiguration)
|
13 | config: Config & CloudSearch.Types.ClientConfiguration;
|
14 | /**
|
15 | * Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide.
|
16 | */
|
17 | buildSuggesters(params: CloudSearch.Types.BuildSuggestersRequest, callback?: (err: AWSError, data: CloudSearch.Types.BuildSuggestersResponse) => void): Request<CloudSearch.Types.BuildSuggestersResponse, AWSError>;
|
18 | /**
|
19 | * Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide.
|
20 | */
|
21 | buildSuggesters(callback?: (err: AWSError, data: CloudSearch.Types.BuildSuggestersResponse) => void): Request<CloudSearch.Types.BuildSuggestersResponse, AWSError>;
|
22 | /**
|
23 | * Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide.
|
24 | */
|
25 | createDomain(params: CloudSearch.Types.CreateDomainRequest, callback?: (err: AWSError, data: CloudSearch.Types.CreateDomainResponse) => void): Request<CloudSearch.Types.CreateDomainResponse, AWSError>;
|
26 | /**
|
27 | * Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide.
|
28 | */
|
29 | createDomain(callback?: (err: AWSError, data: CloudSearch.Types.CreateDomainResponse) => void): Request<CloudSearch.Types.CreateDomainResponse, AWSError>;
|
30 | /**
|
31 | * Configures an analysis scheme that can be applied to a text or text-array field to define language-specific text processing options. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.
|
32 | */
|
33 | defineAnalysisScheme(params: CloudSearch.Types.DefineAnalysisSchemeRequest, callback?: (err: AWSError, data: CloudSearch.Types.DefineAnalysisSchemeResponse) => void): Request<CloudSearch.Types.DefineAnalysisSchemeResponse, AWSError>;
|
34 | /**
|
35 | * Configures an analysis scheme that can be applied to a text or text-array field to define language-specific text processing options. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.
|
36 | */
|
37 | defineAnalysisScheme(callback?: (err: AWSError, data: CloudSearch.Types.DefineAnalysisSchemeResponse) => void): Request<CloudSearch.Types.DefineAnalysisSchemeResponse, AWSError>;
|
38 | /**
|
39 | * Configures an Expression for the search domain. Used to create new expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.
|
40 | */
|
41 | defineExpression(params: CloudSearch.Types.DefineExpressionRequest, callback?: (err: AWSError, data: CloudSearch.Types.DefineExpressionResponse) => void): Request<CloudSearch.Types.DefineExpressionResponse, AWSError>;
|
42 | /**
|
43 | * Configures an Expression for the search domain. Used to create new expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.
|
44 | */
|
45 | defineExpression(callback?: (err: AWSError, data: CloudSearch.Types.DefineExpressionResponse) => void): Request<CloudSearch.Types.DefineExpressionResponse, AWSError>;
|
46 | /**
|
47 | * Configures an IndexField for the search domain. Used to create new fields and modify existing ones. You must specify the name of the domain you are configuring and an index field configuration. The index field configuration specifies a unique name, the index field type, and the options you want to configure for the field. The options you can specify depend on the IndexFieldType. If the field exists, the new configuration replaces the old one. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.
|
48 | */
|
49 | defineIndexField(params: CloudSearch.Types.DefineIndexFieldRequest, callback?: (err: AWSError, data: CloudSearch.Types.DefineIndexFieldResponse) => void): Request<CloudSearch.Types.DefineIndexFieldResponse, AWSError>;
|
50 | /**
|
51 | * Configures an IndexField for the search domain. Used to create new fields and modify existing ones. You must specify the name of the domain you are configuring and an index field configuration. The index field configuration specifies a unique name, the index field type, and the options you want to configure for the field. The options you can specify depend on the IndexFieldType. If the field exists, the new configuration replaces the old one. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.
|
52 | */
|
53 | defineIndexField(callback?: (err: AWSError, data: CloudSearch.Types.DefineIndexFieldResponse) => void): Request<CloudSearch.Types.DefineIndexFieldResponse, AWSError>;
|
54 | /**
|
55 | * Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.
|
56 | */
|
57 | defineSuggester(params: CloudSearch.Types.DefineSuggesterRequest, callback?: (err: AWSError, data: CloudSearch.Types.DefineSuggesterResponse) => void): Request<CloudSearch.Types.DefineSuggesterResponse, AWSError>;
|
58 | /**
|
59 | * Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.
|
60 | */
|
61 | defineSuggester(callback?: (err: AWSError, data: CloudSearch.Types.DefineSuggesterResponse) => void): Request<CloudSearch.Types.DefineSuggesterResponse, AWSError>;
|
62 | /**
|
63 | * Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.
|
64 | */
|
65 | deleteAnalysisScheme(params: CloudSearch.Types.DeleteAnalysisSchemeRequest, callback?: (err: AWSError, data: CloudSearch.Types.DeleteAnalysisSchemeResponse) => void): Request<CloudSearch.Types.DeleteAnalysisSchemeResponse, AWSError>;
|
66 | /**
|
67 | * Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.
|
68 | */
|
69 | deleteAnalysisScheme(callback?: (err: AWSError, data: CloudSearch.Types.DeleteAnalysisSchemeResponse) => void): Request<CloudSearch.Types.DeleteAnalysisSchemeResponse, AWSError>;
|
70 | /**
|
71 | * Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information, see Deleting a Search Domain in the Amazon CloudSearch Developer Guide.
|
72 | */
|
73 | deleteDomain(params: CloudSearch.Types.DeleteDomainRequest, callback?: (err: AWSError, data: CloudSearch.Types.DeleteDomainResponse) => void): Request<CloudSearch.Types.DeleteDomainResponse, AWSError>;
|
74 | /**
|
75 | * Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information, see Deleting a Search Domain in the Amazon CloudSearch Developer Guide.
|
76 | */
|
77 | deleteDomain(callback?: (err: AWSError, data: CloudSearch.Types.DeleteDomainResponse) => void): Request<CloudSearch.Types.DeleteDomainResponse, AWSError>;
|
78 | /**
|
79 | * Removes an Expression from the search domain. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.
|
80 | */
|
81 | deleteExpression(params: CloudSearch.Types.DeleteExpressionRequest, callback?: (err: AWSError, data: CloudSearch.Types.DeleteExpressionResponse) => void): Request<CloudSearch.Types.DeleteExpressionResponse, AWSError>;
|
82 | /**
|
83 | * Removes an Expression from the search domain. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.
|
84 | */
|
85 | deleteExpression(callback?: (err: AWSError, data: CloudSearch.Types.DeleteExpressionResponse) => void): Request<CloudSearch.Types.DeleteExpressionResponse, AWSError>;
|
86 | /**
|
87 | * Removes an IndexField from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.
|
88 | */
|
89 | deleteIndexField(params: CloudSearch.Types.DeleteIndexFieldRequest, callback?: (err: AWSError, data: CloudSearch.Types.DeleteIndexFieldResponse) => void): Request<CloudSearch.Types.DeleteIndexFieldResponse, AWSError>;
|
90 | /**
|
91 | * Removes an IndexField from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.
|
92 | */
|
93 | deleteIndexField(callback?: (err: AWSError, data: CloudSearch.Types.DeleteIndexFieldResponse) => void): Request<CloudSearch.Types.DeleteIndexFieldResponse, AWSError>;
|
94 | /**
|
95 | * Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.
|
96 | */
|
97 | deleteSuggester(params: CloudSearch.Types.DeleteSuggesterRequest, callback?: (err: AWSError, data: CloudSearch.Types.DeleteSuggesterResponse) => void): Request<CloudSearch.Types.DeleteSuggesterResponse, AWSError>;
|
98 | /**
|
99 | * Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.
|
100 | */
|
101 | deleteSuggester(callback?: (err: AWSError, data: CloudSearch.Types.DeleteSuggesterResponse) => void): Request<CloudSearch.Types.DeleteSuggesterResponse, AWSError>;
|
102 | /**
|
103 | * Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing options for a text field. Can be limited to specific analysis schemes by name. By default, shows all analysis schemes and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.
|
104 | */
|
105 | describeAnalysisSchemes(params: CloudSearch.Types.DescribeAnalysisSchemesRequest, callback?: (err: AWSError, data: CloudSearch.Types.DescribeAnalysisSchemesResponse) => void): Request<CloudSearch.Types.DescribeAnalysisSchemesResponse, AWSError>;
|
106 | /**
|
107 | * Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing options for a text field. Can be limited to specific analysis schemes by name. By default, shows all analysis schemes and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.
|
108 | */
|
109 | describeAnalysisSchemes(callback?: (err: AWSError, data: CloudSearch.Types.DescribeAnalysisSchemesResponse) => void): Request<CloudSearch.Types.DescribeAnalysisSchemesResponse, AWSError>;
|
110 | /**
|
111 | * Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.
|
112 | */
|
113 | describeAvailabilityOptions(params: CloudSearch.Types.DescribeAvailabilityOptionsRequest, callback?: (err: AWSError, data: CloudSearch.Types.DescribeAvailabilityOptionsResponse) => void): Request<CloudSearch.Types.DescribeAvailabilityOptionsResponse, AWSError>;
|
114 | /**
|
115 | * Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.
|
116 | */
|
117 | describeAvailabilityOptions(callback?: (err: AWSError, data: CloudSearch.Types.DescribeAvailabilityOptionsResponse) => void): Request<CloudSearch.Types.DescribeAvailabilityOptionsResponse, AWSError>;
|
118 | /**
|
119 | * Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. To get the number of searchable documents in a domain, use the console or submit a matchall request to your domain's search endpoint: q=matchall&amp;q.parser=structured&amp;size=0. For more information, see Getting Information about a Search Domain in the Amazon CloudSearch Developer Guide.
|
120 | */
|
121 | describeDomains(params: CloudSearch.Types.DescribeDomainsRequest, callback?: (err: AWSError, data: CloudSearch.Types.DescribeDomainsResponse) => void): Request<CloudSearch.Types.DescribeDomainsResponse, AWSError>;
|
122 | /**
|
123 | * Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. To get the number of searchable documents in a domain, use the console or submit a matchall request to your domain's search endpoint: q=matchall&amp;q.parser=structured&amp;size=0. For more information, see Getting Information about a Search Domain in the Amazon CloudSearch Developer Guide.
|
124 | */
|
125 | describeDomains(callback?: (err: AWSError, data: CloudSearch.Types.DescribeDomainsResponse) => void): Request<CloudSearch.Types.DescribeDomainsResponse, AWSError>;
|
126 | /**
|
127 | * Gets the expressions configured for the search domain. Can be limited to specific expressions by name. By default, shows all expressions and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.
|
128 | */
|
129 | describeExpressions(params: CloudSearch.Types.DescribeExpressionsRequest, callback?: (err: AWSError, data: CloudSearch.Types.DescribeExpressionsResponse) => void): Request<CloudSearch.Types.DescribeExpressionsResponse, AWSError>;
|
130 | /**
|
131 | * Gets the expressions configured for the search domain. Can be limited to specific expressions by name. By default, shows all expressions and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.
|
132 | */
|
133 | describeExpressions(callback?: (err: AWSError, data: CloudSearch.Types.DescribeExpressionsResponse) => void): Request<CloudSearch.Types.DescribeExpressionsResponse, AWSError>;
|
134 | /**
|
135 | * Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. By default, shows all fields and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Domain Information in the Amazon CloudSearch Developer Guide.
|
136 | */
|
137 | describeIndexFields(params: CloudSearch.Types.DescribeIndexFieldsRequest, callback?: (err: AWSError, data: CloudSearch.Types.DescribeIndexFieldsResponse) => void): Request<CloudSearch.Types.DescribeIndexFieldsResponse, AWSError>;
|
138 | /**
|
139 | * Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. By default, shows all fields and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Domain Information in the Amazon CloudSearch Developer Guide.
|
140 | */
|
141 | describeIndexFields(callback?: (err: AWSError, data: CloudSearch.Types.DescribeIndexFieldsResponse) => void): Request<CloudSearch.Types.DescribeIndexFieldsResponse, AWSError>;
|
142 | /**
|
143 | * Gets the scaling parameters configured for a domain. A domain's scaling parameters specify the desired search instance type and replication count. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide.
|
144 | */
|
145 | describeScalingParameters(params: CloudSearch.Types.DescribeScalingParametersRequest, callback?: (err: AWSError, data: CloudSearch.Types.DescribeScalingParametersResponse) => void): Request<CloudSearch.Types.DescribeScalingParametersResponse, AWSError>;
|
146 | /**
|
147 | * Gets the scaling parameters configured for a domain. A domain's scaling parameters specify the desired search instance type and replication count. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide.
|
148 | */
|
149 | describeScalingParameters(callback?: (err: AWSError, data: CloudSearch.Types.DescribeScalingParametersResponse) => void): Request<CloudSearch.Types.DescribeScalingParametersResponse, AWSError>;
|
150 | /**
|
151 | * Gets information about the access policies that control access to the domain's document and search endpoints. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Access for a Search Domain in the Amazon CloudSearch Developer Guide.
|
152 | */
|
153 | describeServiceAccessPolicies(params: CloudSearch.Types.DescribeServiceAccessPoliciesRequest, callback?: (err: AWSError, data: CloudSearch.Types.DescribeServiceAccessPoliciesResponse) => void): Request<CloudSearch.Types.DescribeServiceAccessPoliciesResponse, AWSError>;
|
154 | /**
|
155 | * Gets information about the access policies that control access to the domain's document and search endpoints. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Access for a Search Domain in the Amazon CloudSearch Developer Guide.
|
156 | */
|
157 | describeServiceAccessPolicies(callback?: (err: AWSError, data: CloudSearch.Types.DescribeServiceAccessPoliciesResponse) => void): Request<CloudSearch.Types.DescribeServiceAccessPoliciesResponse, AWSError>;
|
158 | /**
|
159 | * Gets the suggesters configured for a domain. A suggester enables you to display possible matches before users finish typing their queries. Can be limited to specific suggesters by name. By default, shows all suggesters and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.
|
160 | */
|
161 | describeSuggesters(params: CloudSearch.Types.DescribeSuggestersRequest, callback?: (err: AWSError, data: CloudSearch.Types.DescribeSuggestersResponse) => void): Request<CloudSearch.Types.DescribeSuggestersResponse, AWSError>;
|
162 | /**
|
163 | * Gets the suggesters configured for a domain. A suggester enables you to display possible matches before users finish typing their queries. Can be limited to specific suggesters by name. By default, shows all suggesters and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.
|
164 | */
|
165 | describeSuggesters(callback?: (err: AWSError, data: CloudSearch.Types.DescribeSuggestersResponse) => void): Request<CloudSearch.Types.DescribeSuggestersResponse, AWSError>;
|
166 | /**
|
167 | * Tells the search domain to start indexing its documents using the latest indexing options. This operation must be invoked to activate options whose OptionStatus is RequiresIndexDocuments.
|
168 | */
|
169 | indexDocuments(params: CloudSearch.Types.IndexDocumentsRequest, callback?: (err: AWSError, data: CloudSearch.Types.IndexDocumentsResponse) => void): Request<CloudSearch.Types.IndexDocumentsResponse, AWSError>;
|
170 | /**
|
171 | * Tells the search domain to start indexing its documents using the latest indexing options. This operation must be invoked to activate options whose OptionStatus is RequiresIndexDocuments.
|
172 | */
|
173 | indexDocuments(callback?: (err: AWSError, data: CloudSearch.Types.IndexDocumentsResponse) => void): Request<CloudSearch.Types.IndexDocumentsResponse, AWSError>;
|
174 | /**
|
175 | * Lists all search domains owned by an account.
|
176 | */
|
177 | listDomainNames(callback?: (err: AWSError, data: CloudSearch.Types.ListDomainNamesResponse) => void): Request<CloudSearch.Types.ListDomainNamesResponse, AWSError>;
|
178 | /**
|
179 | * Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.
|
180 | */
|
181 | updateAvailabilityOptions(params: CloudSearch.Types.UpdateAvailabilityOptionsRequest, callback?: (err: AWSError, data: CloudSearch.Types.UpdateAvailabilityOptionsResponse) => void): Request<CloudSearch.Types.UpdateAvailabilityOptionsResponse, AWSError>;
|
182 | /**
|
183 | * Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.
|
184 | */
|
185 | updateAvailabilityOptions(callback?: (err: AWSError, data: CloudSearch.Types.UpdateAvailabilityOptionsResponse) => void): Request<CloudSearch.Types.UpdateAvailabilityOptionsResponse, AWSError>;
|
186 | /**
|
187 | * Configures scaling parameters for a domain. A domain's scaling parameters specify the desired search instance type and replication count. Amazon CloudSearch will still automatically scale your domain based on the volume of data and traffic, but not below the desired instance type and replication count. If the Multi-AZ option is enabled, these values control the resources used per Availability Zone. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide.
|
188 | */
|
189 | updateScalingParameters(params: CloudSearch.Types.UpdateScalingParametersRequest, callback?: (err: AWSError, data: CloudSearch.Types.UpdateScalingParametersResponse) => void): Request<CloudSearch.Types.UpdateScalingParametersResponse, AWSError>;
|
190 | /**
|
191 | * Configures scaling parameters for a domain. A domain's scaling parameters specify the desired search instance type and replication count. Amazon CloudSearch will still automatically scale your domain based on the volume of data and traffic, but not below the desired instance type and replication count. If the Multi-AZ option is enabled, these values control the resources used per Availability Zone. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide.
|
192 | */
|
193 | updateScalingParameters(callback?: (err: AWSError, data: CloudSearch.Types.UpdateScalingParametersResponse) => void): Request<CloudSearch.Types.UpdateScalingParametersResponse, AWSError>;
|
194 | /**
|
195 | * Configures the access rules that control access to the domain's document and search endpoints. For more information, see Configuring Access for an Amazon CloudSearch Domain.
|
196 | */
|
197 | updateServiceAccessPolicies(params: CloudSearch.Types.UpdateServiceAccessPoliciesRequest, callback?: (err: AWSError, data: CloudSearch.Types.UpdateServiceAccessPoliciesResponse) => void): Request<CloudSearch.Types.UpdateServiceAccessPoliciesResponse, AWSError>;
|
198 | /**
|
199 | * Configures the access rules that control access to the domain's document and search endpoints. For more information, see Configuring Access for an Amazon CloudSearch Domain.
|
200 | */
|
201 | updateServiceAccessPolicies(callback?: (err: AWSError, data: CloudSearch.Types.UpdateServiceAccessPoliciesResponse) => void): Request<CloudSearch.Types.UpdateServiceAccessPoliciesResponse, AWSError>;
|
202 | }
|
203 | declare namespace CloudSearch {
|
204 | export type APIVersion = string;
|
205 | export type ARN = string;
|
206 | export interface AccessPoliciesStatus {
|
207 | Options: PolicyDocument;
|
208 | Status: OptionStatus;
|
209 | }
|
210 | export type AlgorithmicStemming = "none"|"minimal"|"light"|"full"|string;
|
211 | export interface AnalysisOptions {
|
212 | |
213 |
|
214 |
|
215 | Synonyms?: String;
|
216 | |
217 |
|
218 |
|
219 | Stopwords?: String;
|
220 | |
221 |
|
222 |
|
223 | StemmingDictionary?: String;
|
224 | |
225 |
|
226 |
|
227 | JapaneseTokenizationDictionary?: String;
|
228 | |
229 |
|
230 |
|
231 | AlgorithmicStemming?: AlgorithmicStemming;
|
232 | }
|
233 | export interface AnalysisScheme {
|
234 | AnalysisSchemeName: StandardName;
|
235 | AnalysisSchemeLanguage: AnalysisSchemeLanguage;
|
236 | AnalysisOptions?: AnalysisOptions;
|
237 | }
|
238 | export type AnalysisSchemeLanguage = "ar"|"bg"|"ca"|"cs"|"da"|"de"|"el"|"en"|"es"|"eu"|"fa"|"fi"|"fr"|"ga"|"gl"|"he"|"hi"|"hu"|"hy"|"id"|"it"|"ja"|"ko"|"lv"|"mul"|"nl"|"no"|"pt"|"ro"|"ru"|"sv"|"th"|"tr"|"zh-Hans"|"zh-Hant"|string;
|
239 | export interface AnalysisSchemeStatus {
|
240 | Options: AnalysisScheme;
|
241 | Status: OptionStatus;
|
242 | }
|
243 | export type AnalysisSchemeStatusList = AnalysisSchemeStatus[];
|
244 | export interface AvailabilityOptionsStatus {
|
245 | |
246 |
|
247 |
|
248 | Options: MultiAZ;
|
249 | Status: OptionStatus;
|
250 | }
|
251 | export type Boolean = boolean;
|
252 | export interface BuildSuggestersRequest {
|
253 | DomainName: DomainName;
|
254 | }
|
255 | export interface BuildSuggestersResponse {
|
256 | FieldNames?: FieldNameList;
|
257 | }
|
258 | export interface CreateDomainRequest {
|
259 | |
260 |
|
261 |
|
262 | DomainName: DomainName;
|
263 | }
|
264 | export interface CreateDomainResponse {
|
265 | DomainStatus?: DomainStatus;
|
266 | }
|
267 | export interface DateArrayOptions {
|
268 | |
269 |
|
270 |
|
271 | DefaultValue?: FieldValue;
|
272 | |
273 |
|
274 |
|
275 | SourceFields?: FieldNameCommaList;
|
276 | |
277 |
|
278 |
|
279 | FacetEnabled?: Boolean;
|
280 | |
281 |
|
282 |
|
283 | SearchEnabled?: Boolean;
|
284 | |
285 |
|
286 |
|
287 | ReturnEnabled?: Boolean;
|
288 | }
|
289 | export interface DateOptions {
|
290 | |
291 |
|
292 |
|
293 | DefaultValue?: FieldValue;
|
294 | SourceField?: FieldName;
|
295 | |
296 |
|
297 |
|
298 | FacetEnabled?: Boolean;
|
299 | |
300 |
|
301 |
|
302 | SearchEnabled?: Boolean;
|
303 | |
304 |
|
305 |
|
306 | ReturnEnabled?: Boolean;
|
307 | |
308 |
|
309 |
|
310 | SortEnabled?: Boolean;
|
311 | }
|
312 | export interface DefineAnalysisSchemeRequest {
|
313 | DomainName: DomainName;
|
314 | AnalysisScheme: AnalysisScheme;
|
315 | }
|
316 | export interface DefineAnalysisSchemeResponse {
|
317 | AnalysisScheme: AnalysisSchemeStatus;
|
318 | }
|
319 | export interface DefineExpressionRequest {
|
320 | DomainName: DomainName;
|
321 | Expression: Expression;
|
322 | }
|
323 | export interface DefineExpressionResponse {
|
324 | Expression: ExpressionStatus;
|
325 | }
|
326 | export interface DefineIndexFieldRequest {
|
327 | DomainName: DomainName;
|
328 | |
329 |
|
330 |
|
331 | IndexField: IndexField;
|
332 | }
|
333 | export interface DefineIndexFieldResponse {
|
334 | IndexField: IndexFieldStatus;
|
335 | }
|
336 | export interface DefineSuggesterRequest {
|
337 | DomainName: DomainName;
|
338 | Suggester: Suggester;
|
339 | }
|
340 | export interface DefineSuggesterResponse {
|
341 | Suggester: SuggesterStatus;
|
342 | }
|
343 | export interface DeleteAnalysisSchemeRequest {
|
344 | DomainName: DomainName;
|
345 | |
346 |
|
347 |
|
348 | AnalysisSchemeName: StandardName;
|
349 | }
|
350 | export interface DeleteAnalysisSchemeResponse {
|
351 | |
352 |
|
353 |
|
354 | AnalysisScheme: AnalysisSchemeStatus;
|
355 | }
|
356 | export interface DeleteDomainRequest {
|
357 | |
358 |
|
359 |
|
360 | DomainName: DomainName;
|
361 | }
|
362 | export interface DeleteDomainResponse {
|
363 | DomainStatus?: DomainStatus;
|
364 | }
|
365 | export interface DeleteExpressionRequest {
|
366 | DomainName: DomainName;
|
367 | |
368 |
|
369 |
|
370 | ExpressionName: StandardName;
|
371 | }
|
372 | export interface DeleteExpressionResponse {
|
373 | |
374 |
|
375 |
|
376 | Expression: ExpressionStatus;
|
377 | }
|
378 | export interface DeleteIndexFieldRequest {
|
379 | DomainName: DomainName;
|
380 | |
381 |
|
382 |
|
383 | IndexFieldName: DynamicFieldName;
|
384 | }
|
385 | export interface DeleteIndexFieldResponse {
|
386 | |
387 |
|
388 |
|
389 | IndexField: IndexFieldStatus;
|
390 | }
|
391 | export interface DeleteSuggesterRequest {
|
392 | DomainName: DomainName;
|
393 | |
394 |
|
395 |
|
396 | SuggesterName: StandardName;
|
397 | }
|
398 | export interface DeleteSuggesterResponse {
|
399 | |
400 |
|
401 |
|
402 | Suggester: SuggesterStatus;
|
403 | }
|
404 | export interface DescribeAnalysisSchemesRequest {
|
405 | |
406 |
|
407 |
|
408 | DomainName: DomainName;
|
409 | |
410 |
|
411 |
|
412 | AnalysisSchemeNames?: StandardNameList;
|
413 | |
414 |
|
415 |
|
416 | Deployed?: Boolean;
|
417 | }
|
418 | export interface DescribeAnalysisSchemesResponse {
|
419 | |
420 |
|
421 |
|
422 | AnalysisSchemes: AnalysisSchemeStatusList;
|
423 | }
|
424 | export interface DescribeAvailabilityOptionsRequest {
|
425 | |
426 |
|
427 |
|
428 | DomainName: DomainName;
|
429 | |
430 |
|
431 |
|
432 | Deployed?: Boolean;
|
433 | }
|
434 | export interface DescribeAvailabilityOptionsResponse {
|
435 | |
436 |
|
437 |
|
438 | AvailabilityOptions?: AvailabilityOptionsStatus;
|
439 | }
|
440 | export interface DescribeDomainsRequest {
|
441 | |
442 |
|
443 |
|
444 | DomainNames?: DomainNameList;
|
445 | }
|
446 | export interface DescribeDomainsResponse {
|
447 | DomainStatusList: DomainStatusList;
|
448 | }
|
449 | export interface DescribeExpressionsRequest {
|
450 | |
451 |
|
452 |
|
453 | DomainName: DomainName;
|
454 | |
455 |
|
456 |
|
457 | ExpressionNames?: StandardNameList;
|
458 | |
459 |
|
460 |
|
461 | Deployed?: Boolean;
|
462 | }
|
463 | export interface DescribeExpressionsResponse {
|
464 | |
465 |
|
466 |
|
467 | Expressions: ExpressionStatusList;
|
468 | }
|
469 | export interface DescribeIndexFieldsRequest {
|
470 | |
471 |
|
472 |
|
473 | DomainName: DomainName;
|
474 | |
475 |
|
476 |
|
477 | FieldNames?: DynamicFieldNameList;
|
478 | |
479 |
|
480 |
|
481 | Deployed?: Boolean;
|
482 | }
|
483 | export interface DescribeIndexFieldsResponse {
|
484 | |
485 |
|
486 |
|
487 | IndexFields: IndexFieldStatusList;
|
488 | }
|
489 | export interface DescribeScalingParametersRequest {
|
490 | DomainName: DomainName;
|
491 | }
|
492 | export interface DescribeScalingParametersResponse {
|
493 | ScalingParameters: ScalingParametersStatus;
|
494 | }
|
495 | export interface DescribeServiceAccessPoliciesRequest {
|
496 | |
497 |
|
498 |
|
499 | DomainName: DomainName;
|
500 | |
501 |
|
502 |
|
503 | Deployed?: Boolean;
|
504 | }
|
505 | export interface DescribeServiceAccessPoliciesResponse {
|
506 | |
507 |
|
508 |
|
509 | AccessPolicies: AccessPoliciesStatus;
|
510 | }
|
511 | export interface DescribeSuggestersRequest {
|
512 | |
513 |
|
514 |
|
515 | DomainName: DomainName;
|
516 | |
517 |
|
518 |
|
519 | SuggesterNames?: StandardNameList;
|
520 | |
521 |
|
522 |
|
523 | Deployed?: Boolean;
|
524 | }
|
525 | export interface DescribeSuggestersResponse {
|
526 | |
527 |
|
528 |
|
529 | Suggesters: SuggesterStatusList;
|
530 | }
|
531 | export interface DocumentSuggesterOptions {
|
532 | |
533 |
|
534 |
|
535 | SourceField: FieldName;
|
536 | |
537 |
|
538 |
|
539 | FuzzyMatching?: SuggesterFuzzyMatching;
|
540 | |
541 |
|
542 |
|
543 | SortExpression?: String;
|
544 | }
|
545 | export type DomainId = string;
|
546 | export type DomainName = string;
|
547 | export type DomainNameList = DomainName[];
|
548 | export type DomainNameMap = {[key: string]: APIVersion};
|
549 | export interface DomainStatus {
|
550 | DomainId: DomainId;
|
551 | DomainName: DomainName;
|
552 | ARN?: ARN;
|
553 | |
554 |
|
555 |
|
556 | Created?: Boolean;
|
557 | |
558 |
|
559 |
|
560 | Deleted?: Boolean;
|
561 | |
562 |
|
563 |
|
564 | DocService?: ServiceEndpoint;
|
565 | |
566 |
|
567 |
|
568 | SearchService?: ServiceEndpoint;
|
569 | |
570 |
|
571 |
|
572 | RequiresIndexDocuments: Boolean;
|
573 | |
574 |
|
575 |
|
576 | Processing?: Boolean;
|
577 | |
578 |
|
579 |
|
580 | SearchInstanceType?: SearchInstanceType;
|
581 | |
582 |
|
583 |
|
584 | SearchPartitionCount?: PartitionCount;
|
585 | |
586 |
|
587 |
|
588 | SearchInstanceCount?: InstanceCount;
|
589 | Limits?: Limits;
|
590 | }
|
591 | export type DomainStatusList = DomainStatus[];
|
592 | export type Double = number;
|
593 | export interface DoubleArrayOptions {
|
594 | |
595 |
|
596 |
|
597 | DefaultValue?: Double;
|
598 | |
599 |
|
600 |
|
601 | SourceFields?: FieldNameCommaList;
|
602 | |
603 |
|
604 |
|
605 | FacetEnabled?: Boolean;
|
606 | |
607 |
|
608 |
|
609 | SearchEnabled?: Boolean;
|
610 | |
611 |
|
612 |
|
613 | ReturnEnabled?: Boolean;
|
614 | }
|
615 | export interface DoubleOptions {
|
616 | |
617 |
|
618 |
|
619 | DefaultValue?: Double;
|
620 | |
621 |
|
622 |
|
623 | SourceField?: FieldName;
|
624 | |
625 |
|
626 |
|
627 | FacetEnabled?: Boolean;
|
628 | |
629 |
|
630 |
|
631 | SearchEnabled?: Boolean;
|
632 | |
633 |
|
634 |
|
635 | ReturnEnabled?: Boolean;
|
636 | |
637 |
|
638 |
|
639 | SortEnabled?: Boolean;
|
640 | }
|
641 | export type DynamicFieldName = string;
|
642 | export type DynamicFieldNameList = DynamicFieldName[];
|
643 | export interface Expression {
|
644 | ExpressionName: StandardName;
|
645 | ExpressionValue: ExpressionValue;
|
646 | }
|
647 | export interface ExpressionStatus {
|
648 | |
649 |
|
650 |
|
651 | Options: Expression;
|
652 | Status: OptionStatus;
|
653 | }
|
654 | export type ExpressionStatusList = ExpressionStatus[];
|
655 | export type ExpressionValue = string;
|
656 | export type FieldName = string;
|
657 | export type FieldNameCommaList = string;
|
658 | export type FieldNameList = FieldName[];
|
659 | export type FieldValue = string;
|
660 | export interface IndexDocumentsRequest {
|
661 | DomainName: DomainName;
|
662 | }
|
663 | export interface IndexDocumentsResponse {
|
664 | |
665 |
|
666 |
|
667 | FieldNames?: FieldNameList;
|
668 | }
|
669 | export interface IndexField {
|
670 | |
671 |
|
672 |
|
673 | IndexFieldName: DynamicFieldName;
|
674 | IndexFieldType: IndexFieldType;
|
675 | IntOptions?: IntOptions;
|
676 | DoubleOptions?: DoubleOptions;
|
677 | LiteralOptions?: LiteralOptions;
|
678 | TextOptions?: TextOptions;
|
679 | DateOptions?: DateOptions;
|
680 | LatLonOptions?: LatLonOptions;
|
681 | IntArrayOptions?: IntArrayOptions;
|
682 | DoubleArrayOptions?: DoubleArrayOptions;
|
683 | LiteralArrayOptions?: LiteralArrayOptions;
|
684 | TextArrayOptions?: TextArrayOptions;
|
685 | DateArrayOptions?: DateArrayOptions;
|
686 | }
|
687 | export interface IndexFieldStatus {
|
688 | Options: IndexField;
|
689 | Status: OptionStatus;
|
690 | }
|
691 | export type IndexFieldStatusList = IndexFieldStatus[];
|
692 | export type IndexFieldType = "int"|"double"|"literal"|"text"|"date"|"latlon"|"int-array"|"double-array"|"literal-array"|"text-array"|"date-array"|string;
|
693 | export type InstanceCount = number;
|
694 | export interface IntArrayOptions {
|
695 | |
696 |
|
697 |
|
698 | DefaultValue?: Long;
|
699 | |
700 |
|
701 |
|
702 | SourceFields?: FieldNameCommaList;
|
703 | |
704 |
|
705 |
|
706 | FacetEnabled?: Boolean;
|
707 | |
708 |
|
709 |
|
710 | SearchEnabled?: Boolean;
|
711 | |
712 |
|
713 |
|
714 | ReturnEnabled?: Boolean;
|
715 | }
|
716 | export interface IntOptions {
|
717 | |
718 |
|
719 |
|
720 | DefaultValue?: Long;
|
721 | |
722 |
|
723 |
|
724 | SourceField?: FieldName;
|
725 | |
726 |
|
727 |
|
728 | FacetEnabled?: Boolean;
|
729 | |
730 |
|
731 |
|
732 | SearchEnabled?: Boolean;
|
733 | |
734 |
|
735 |
|
736 | ReturnEnabled?: Boolean;
|
737 | |
738 |
|
739 |
|
740 | SortEnabled?: Boolean;
|
741 | }
|
742 | export interface LatLonOptions {
|
743 | |
744 |
|
745 |
|
746 | DefaultValue?: FieldValue;
|
747 | SourceField?: FieldName;
|
748 | |
749 |
|
750 |
|
751 | FacetEnabled?: Boolean;
|
752 | |
753 |
|
754 |
|
755 | SearchEnabled?: Boolean;
|
756 | |
757 |
|
758 |
|
759 | ReturnEnabled?: Boolean;
|
760 | |
761 |
|
762 |
|
763 | SortEnabled?: Boolean;
|
764 | }
|
765 | export interface Limits {
|
766 | MaximumReplicationCount: MaximumReplicationCount;
|
767 | MaximumPartitionCount: MaximumPartitionCount;
|
768 | }
|
769 | export interface ListDomainNamesResponse {
|
770 | |
771 |
|
772 |
|
773 | DomainNames?: DomainNameMap;
|
774 | }
|
775 | export interface LiteralArrayOptions {
|
776 | |
777 |
|
778 |
|
779 | DefaultValue?: FieldValue;
|
780 | |
781 |
|
782 |
|
783 | SourceFields?: FieldNameCommaList;
|
784 | |
785 |
|
786 |
|
787 | FacetEnabled?: Boolean;
|
788 | |
789 |
|
790 |
|
791 | SearchEnabled?: Boolean;
|
792 | |
793 |
|
794 |
|
795 | ReturnEnabled?: Boolean;
|
796 | }
|
797 | export interface LiteralOptions {
|
798 | |
799 |
|
800 |
|
801 | DefaultValue?: FieldValue;
|
802 | SourceField?: FieldName;
|
803 | |
804 |
|
805 |
|
806 | FacetEnabled?: Boolean;
|
807 | |
808 |
|
809 |
|
810 | SearchEnabled?: Boolean;
|
811 | |
812 |
|
813 |
|
814 | ReturnEnabled?: Boolean;
|
815 | |
816 |
|
817 |
|
818 | SortEnabled?: Boolean;
|
819 | }
|
820 | export type Long = number;
|
821 | export type MaximumPartitionCount = number;
|
822 | export type MaximumReplicationCount = number;
|
823 | export type MultiAZ = boolean;
|
824 | export type OptionState = "RequiresIndexDocuments"|"Processing"|"Active"|"FailedToValidate"|string;
|
825 | export interface OptionStatus {
|
826 | |
827 |
|
828 |
|
829 | CreationDate: UpdateTimestamp;
|
830 | |
831 |
|
832 |
|
833 | UpdateDate: UpdateTimestamp;
|
834 | |
835 |
|
836 |
|
837 | UpdateVersion?: UIntValue;
|
838 | |
839 |
|
840 |
|
841 | State: OptionState;
|
842 | |
843 |
|
844 |
|
845 | PendingDeletion?: Boolean;
|
846 | }
|
847 | export type PartitionCount = number;
|
848 | export type PartitionInstanceType = "search.m1.small"|"search.m1.large"|"search.m2.xlarge"|"search.m2.2xlarge"|"search.m3.medium"|"search.m3.large"|"search.m3.xlarge"|"search.m3.2xlarge"|string;
|
849 | export type PolicyDocument = string;
|
850 | export interface ScalingParameters {
|
851 | |
852 |
|
853 |
|
854 | DesiredInstanceType?: PartitionInstanceType;
|
855 | |
856 |
|
857 |
|
858 | DesiredReplicationCount?: UIntValue;
|
859 | |
860 |
|
861 |
|
862 | DesiredPartitionCount?: UIntValue;
|
863 | }
|
864 | export interface ScalingParametersStatus {
|
865 | Options: ScalingParameters;
|
866 | Status: OptionStatus;
|
867 | }
|
868 | export type SearchInstanceType = string;
|
869 | export interface ServiceEndpoint {
|
870 | Endpoint?: ServiceUrl;
|
871 | }
|
872 | export type ServiceUrl = string;
|
873 | export type StandardName = string;
|
874 | export type StandardNameList = StandardName[];
|
875 | export type String = string;
|
876 | export interface Suggester {
|
877 | SuggesterName: StandardName;
|
878 | DocumentSuggesterOptions: DocumentSuggesterOptions;
|
879 | }
|
880 | export type SuggesterFuzzyMatching = "none"|"low"|"high"|string;
|
881 | export interface SuggesterStatus {
|
882 | Options: Suggester;
|
883 | Status: OptionStatus;
|
884 | }
|
885 | export type SuggesterStatusList = SuggesterStatus[];
|
886 | export interface TextArrayOptions {
|
887 | |
888 |
|
889 |
|
890 | DefaultValue?: FieldValue;
|
891 | |
892 |
|
893 |
|
894 | SourceFields?: FieldNameCommaList;
|
895 | |
896 |
|
897 |
|
898 | ReturnEnabled?: Boolean;
|
899 | |
900 |
|
901 |
|
902 | HighlightEnabled?: Boolean;
|
903 | |
904 |
|
905 |
|
906 | AnalysisScheme?: Word;
|
907 | }
|
908 | export interface TextOptions {
|
909 | |
910 |
|
911 |
|
912 | DefaultValue?: FieldValue;
|
913 | SourceField?: FieldName;
|
914 | |
915 |
|
916 |
|
917 | ReturnEnabled?: Boolean;
|
918 | |
919 |
|
920 |
|
921 | SortEnabled?: Boolean;
|
922 | |
923 |
|
924 |
|
925 | HighlightEnabled?: Boolean;
|
926 | |
927 |
|
928 |
|
929 | AnalysisScheme?: Word;
|
930 | }
|
931 | export type UIntValue = number;
|
932 | export interface UpdateAvailabilityOptionsRequest {
|
933 | DomainName: DomainName;
|
934 | |
935 |
|
936 |
|
937 | MultiAZ: Boolean;
|
938 | }
|
939 | export interface UpdateAvailabilityOptionsResponse {
|
940 | |
941 |
|
942 |
|
943 | AvailabilityOptions?: AvailabilityOptionsStatus;
|
944 | }
|
945 | export interface UpdateScalingParametersRequest {
|
946 | DomainName: DomainName;
|
947 | ScalingParameters: ScalingParameters;
|
948 | }
|
949 | export interface UpdateScalingParametersResponse {
|
950 | ScalingParameters: ScalingParametersStatus;
|
951 | }
|
952 | export interface UpdateServiceAccessPoliciesRequest {
|
953 | DomainName: DomainName;
|
954 | |
955 |
|
956 |
|
957 | AccessPolicies: PolicyDocument;
|
958 | }
|
959 | export interface UpdateServiceAccessPoliciesResponse {
|
960 | |
961 |
|
962 |
|
963 | AccessPolicies: AccessPoliciesStatus;
|
964 | }
|
965 | export type UpdateTimestamp = Date;
|
966 | export type Word = string;
|
967 | |
968 |
|
969 |
|
970 | export type apiVersion = "2011-02-01"|"2013-01-01"|"latest"|string;
|
971 | export interface ClientApiVersions {
|
972 | |
973 |
|
974 |
|
975 | apiVersion?: apiVersion;
|
976 | }
|
977 | export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
|
978 | |
979 |
|
980 |
|
981 | export import Types = CloudSearch;
|
982 | }
|
983 | export = CloudSearch;
|