UNPKG

56.5 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare class CloudSearch extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
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 * Returns the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see Configuring Domain Endpoint Options in the Amazon CloudSearch Developer Guide.
120 */
121 describeDomainEndpointOptions(params: CloudSearch.Types.DescribeDomainEndpointOptionsRequest, callback?: (err: AWSError, data: CloudSearch.Types.DescribeDomainEndpointOptionsResponse) => void): Request<CloudSearch.Types.DescribeDomainEndpointOptionsResponse, AWSError>;
122 /**
123 * Returns the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see Configuring Domain Endpoint Options in the Amazon CloudSearch Developer Guide.
124 */
125 describeDomainEndpointOptions(callback?: (err: AWSError, data: CloudSearch.Types.DescribeDomainEndpointOptionsResponse) => void): Request<CloudSearch.Types.DescribeDomainEndpointOptionsResponse, AWSError>;
126 /**
127 * 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;amp;q.parser=structured&amp;amp;size=0. For more information, see Getting Information about a Search Domain in the Amazon CloudSearch Developer Guide.
128 */
129 describeDomains(params: CloudSearch.Types.DescribeDomainsRequest, callback?: (err: AWSError, data: CloudSearch.Types.DescribeDomainsResponse) => void): Request<CloudSearch.Types.DescribeDomainsResponse, AWSError>;
130 /**
131 * 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;amp;q.parser=structured&amp;amp;size=0. For more information, see Getting Information about a Search Domain in the Amazon CloudSearch Developer Guide.
132 */
133 describeDomains(callback?: (err: AWSError, data: CloudSearch.Types.DescribeDomainsResponse) => void): Request<CloudSearch.Types.DescribeDomainsResponse, AWSError>;
134 /**
135 * 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.
136 */
137 describeExpressions(params: CloudSearch.Types.DescribeExpressionsRequest, callback?: (err: AWSError, data: CloudSearch.Types.DescribeExpressionsResponse) => void): Request<CloudSearch.Types.DescribeExpressionsResponse, AWSError>;
138 /**
139 * 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.
140 */
141 describeExpressions(callback?: (err: AWSError, data: CloudSearch.Types.DescribeExpressionsResponse) => void): Request<CloudSearch.Types.DescribeExpressionsResponse, AWSError>;
142 /**
143 * 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.
144 */
145 describeIndexFields(params: CloudSearch.Types.DescribeIndexFieldsRequest, callback?: (err: AWSError, data: CloudSearch.Types.DescribeIndexFieldsResponse) => void): Request<CloudSearch.Types.DescribeIndexFieldsResponse, AWSError>;
146 /**
147 * 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.
148 */
149 describeIndexFields(callback?: (err: AWSError, data: CloudSearch.Types.DescribeIndexFieldsResponse) => void): Request<CloudSearch.Types.DescribeIndexFieldsResponse, AWSError>;
150 /**
151 * 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.
152 */
153 describeScalingParameters(params: CloudSearch.Types.DescribeScalingParametersRequest, callback?: (err: AWSError, data: CloudSearch.Types.DescribeScalingParametersResponse) => void): Request<CloudSearch.Types.DescribeScalingParametersResponse, AWSError>;
154 /**
155 * 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.
156 */
157 describeScalingParameters(callback?: (err: AWSError, data: CloudSearch.Types.DescribeScalingParametersResponse) => void): Request<CloudSearch.Types.DescribeScalingParametersResponse, AWSError>;
158 /**
159 * 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.
160 */
161 describeServiceAccessPolicies(params: CloudSearch.Types.DescribeServiceAccessPoliciesRequest, callback?: (err: AWSError, data: CloudSearch.Types.DescribeServiceAccessPoliciesResponse) => void): Request<CloudSearch.Types.DescribeServiceAccessPoliciesResponse, AWSError>;
162 /**
163 * 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.
164 */
165 describeServiceAccessPolicies(callback?: (err: AWSError, data: CloudSearch.Types.DescribeServiceAccessPoliciesResponse) => void): Request<CloudSearch.Types.DescribeServiceAccessPoliciesResponse, AWSError>;
166 /**
167 * 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.
168 */
169 describeSuggesters(params: CloudSearch.Types.DescribeSuggestersRequest, callback?: (err: AWSError, data: CloudSearch.Types.DescribeSuggestersResponse) => void): Request<CloudSearch.Types.DescribeSuggestersResponse, AWSError>;
170 /**
171 * 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.
172 */
173 describeSuggesters(callback?: (err: AWSError, data: CloudSearch.Types.DescribeSuggestersResponse) => void): Request<CloudSearch.Types.DescribeSuggestersResponse, AWSError>;
174 /**
175 * 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.
176 */
177 indexDocuments(params: CloudSearch.Types.IndexDocumentsRequest, callback?: (err: AWSError, data: CloudSearch.Types.IndexDocumentsResponse) => void): Request<CloudSearch.Types.IndexDocumentsResponse, AWSError>;
178 /**
179 * 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.
180 */
181 indexDocuments(callback?: (err: AWSError, data: CloudSearch.Types.IndexDocumentsResponse) => void): Request<CloudSearch.Types.IndexDocumentsResponse, AWSError>;
182 /**
183 * Lists all search domains owned by an account.
184 */
185 listDomainNames(callback?: (err: AWSError, data: CloudSearch.Types.ListDomainNamesResponse) => void): Request<CloudSearch.Types.ListDomainNamesResponse, AWSError>;
186 /**
187 * 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.
188 */
189 updateAvailabilityOptions(params: CloudSearch.Types.UpdateAvailabilityOptionsRequest, callback?: (err: AWSError, data: CloudSearch.Types.UpdateAvailabilityOptionsResponse) => void): Request<CloudSearch.Types.UpdateAvailabilityOptionsResponse, AWSError>;
190 /**
191 * 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.
192 */
193 updateAvailabilityOptions(callback?: (err: AWSError, data: CloudSearch.Types.UpdateAvailabilityOptionsResponse) => void): Request<CloudSearch.Types.UpdateAvailabilityOptionsResponse, AWSError>;
194 /**
195 * Updates the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see Configuring Domain Endpoint Options in the Amazon CloudSearch Developer Guide.
196 */
197 updateDomainEndpointOptions(params: CloudSearch.Types.UpdateDomainEndpointOptionsRequest, callback?: (err: AWSError, data: CloudSearch.Types.UpdateDomainEndpointOptionsResponse) => void): Request<CloudSearch.Types.UpdateDomainEndpointOptionsResponse, AWSError>;
198 /**
199 * Updates the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see Configuring Domain Endpoint Options in the Amazon CloudSearch Developer Guide.
200 */
201 updateDomainEndpointOptions(callback?: (err: AWSError, data: CloudSearch.Types.UpdateDomainEndpointOptionsResponse) => void): Request<CloudSearch.Types.UpdateDomainEndpointOptionsResponse, AWSError>;
202 /**
203 * 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.
204 */
205 updateScalingParameters(params: CloudSearch.Types.UpdateScalingParametersRequest, callback?: (err: AWSError, data: CloudSearch.Types.UpdateScalingParametersResponse) => void): Request<CloudSearch.Types.UpdateScalingParametersResponse, AWSError>;
206 /**
207 * 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.
208 */
209 updateScalingParameters(callback?: (err: AWSError, data: CloudSearch.Types.UpdateScalingParametersResponse) => void): Request<CloudSearch.Types.UpdateScalingParametersResponse, AWSError>;
210 /**
211 * 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.
212 */
213 updateServiceAccessPolicies(params: CloudSearch.Types.UpdateServiceAccessPoliciesRequest, callback?: (err: AWSError, data: CloudSearch.Types.UpdateServiceAccessPoliciesResponse) => void): Request<CloudSearch.Types.UpdateServiceAccessPoliciesResponse, AWSError>;
214 /**
215 * 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.
216 */
217 updateServiceAccessPolicies(callback?: (err: AWSError, data: CloudSearch.Types.UpdateServiceAccessPoliciesResponse) => void): Request<CloudSearch.Types.UpdateServiceAccessPoliciesResponse, AWSError>;
218}
219declare namespace CloudSearch {
220 export type APIVersion = string;
221 export type ARN = string;
222 export interface AccessPoliciesStatus {
223 Options: PolicyDocument;
224 Status: OptionStatus;
225 }
226 export type AlgorithmicStemming = "none"|"minimal"|"light"|"full"|string;
227 export interface AnalysisOptions {
228 /**
229 * A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see Synonyms in the Amazon CloudSearch Developer Guide.
230 */
231 Synonyms?: String;
232 /**
233 * A JSON array of terms to ignore during indexing and searching. For example, ["a", "an", "the", "of"]. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported.
234 */
235 Stopwords?: String;
236 /**
237 * A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, {"term1": "stem1", "term2": "stem2", "term3": "stem3"}. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.
238 */
239 StemmingDictionary?: String;
240 /**
241 * 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.
242 */
243 JapaneseTokenizationDictionary?: String;
244 /**
245 * The level of algorithmic stemming to perform: none, minimal, light, or full. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide
246 */
247 AlgorithmicStemming?: AlgorithmicStemming;
248 }
249 export interface AnalysisScheme {
250 AnalysisSchemeName: StandardName;
251 AnalysisSchemeLanguage: AnalysisSchemeLanguage;
252 AnalysisOptions?: AnalysisOptions;
253 }
254 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;
255 export interface AnalysisSchemeStatus {
256 Options: AnalysisScheme;
257 Status: OptionStatus;
258 }
259 export type AnalysisSchemeStatusList = AnalysisSchemeStatus[];
260 export interface AvailabilityOptionsStatus {
261 /**
262 * The availability options configured for the domain.
263 */
264 Options: MultiAZ;
265 Status: OptionStatus;
266 }
267 export type Boolean = boolean;
268 export interface BuildSuggestersRequest {
269 DomainName: DomainName;
270 }
271 export interface BuildSuggestersResponse {
272 FieldNames?: FieldNameList;
273 }
274 export interface CreateDomainRequest {
275 /**
276 * 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.
277 */
278 DomainName: DomainName;
279 }
280 export interface CreateDomainResponse {
281 DomainStatus?: DomainStatus;
282 }
283 export interface DateArrayOptions {
284 /**
285 * A value to use for the field if the field isn't specified for a document.
286 */
287 DefaultValue?: FieldValue;
288 /**
289 * A list of source fields to map to the field.
290 */
291 SourceFields?: FieldNameCommaList;
292 /**
293 * Whether facet information can be returned for the field.
294 */
295 FacetEnabled?: Boolean;
296 /**
297 * Whether the contents of the field are searchable.
298 */
299 SearchEnabled?: Boolean;
300 /**
301 * Whether the contents of the field can be returned in the search results.
302 */
303 ReturnEnabled?: Boolean;
304 }
305 export interface DateOptions {
306 /**
307 * A value to use for the field if the field isn't specified for a document.
308 */
309 DefaultValue?: FieldValue;
310 SourceField?: FieldName;
311 /**
312 * Whether facet information can be returned for the field.
313 */
314 FacetEnabled?: Boolean;
315 /**
316 * Whether the contents of the field are searchable.
317 */
318 SearchEnabled?: Boolean;
319 /**
320 * Whether the contents of the field can be returned in the search results.
321 */
322 ReturnEnabled?: Boolean;
323 /**
324 * Whether the field can be used to sort the search results.
325 */
326 SortEnabled?: Boolean;
327 }
328 export interface DefineAnalysisSchemeRequest {
329 DomainName: DomainName;
330 AnalysisScheme: AnalysisScheme;
331 }
332 export interface DefineAnalysisSchemeResponse {
333 AnalysisScheme: AnalysisSchemeStatus;
334 }
335 export interface DefineExpressionRequest {
336 DomainName: DomainName;
337 Expression: Expression;
338 }
339 export interface DefineExpressionResponse {
340 Expression: ExpressionStatus;
341 }
342 export interface DefineIndexFieldRequest {
343 DomainName: DomainName;
344 /**
345 * The index field and field options you want to configure.
346 */
347 IndexField: IndexField;
348 }
349 export interface DefineIndexFieldResponse {
350 IndexField: IndexFieldStatus;
351 }
352 export interface DefineSuggesterRequest {
353 DomainName: DomainName;
354 Suggester: Suggester;
355 }
356 export interface DefineSuggesterResponse {
357 Suggester: SuggesterStatus;
358 }
359 export interface DeleteAnalysisSchemeRequest {
360 DomainName: DomainName;
361 /**
362 * The name of the analysis scheme you want to delete.
363 */
364 AnalysisSchemeName: StandardName;
365 }
366 export interface DeleteAnalysisSchemeResponse {
367 /**
368 * The status of the analysis scheme being deleted.
369 */
370 AnalysisScheme: AnalysisSchemeStatus;
371 }
372 export interface DeleteDomainRequest {
373 /**
374 * The name of the domain you want to permanently delete.
375 */
376 DomainName: DomainName;
377 }
378 export interface DeleteDomainResponse {
379 DomainStatus?: DomainStatus;
380 }
381 export interface DeleteExpressionRequest {
382 DomainName: DomainName;
383 /**
384 * The name of the Expression to delete.
385 */
386 ExpressionName: StandardName;
387 }
388 export interface DeleteExpressionResponse {
389 /**
390 * The status of the expression being deleted.
391 */
392 Expression: ExpressionStatus;
393 }
394 export interface DeleteIndexFieldRequest {
395 DomainName: DomainName;
396 /**
397 * The name of the index field your want to remove from the domain's indexing options.
398 */
399 IndexFieldName: DynamicFieldName;
400 }
401 export interface DeleteIndexFieldResponse {
402 /**
403 * The status of the index field being deleted.
404 */
405 IndexField: IndexFieldStatus;
406 }
407 export interface DeleteSuggesterRequest {
408 DomainName: DomainName;
409 /**
410 * Specifies the name of the suggester you want to delete.
411 */
412 SuggesterName: StandardName;
413 }
414 export interface DeleteSuggesterResponse {
415 /**
416 * The status of the suggester being deleted.
417 */
418 Suggester: SuggesterStatus;
419 }
420 export interface DescribeAnalysisSchemesRequest {
421 /**
422 * The name of the domain you want to describe.
423 */
424 DomainName: DomainName;
425 /**
426 * The analysis schemes you want to describe.
427 */
428 AnalysisSchemeNames?: StandardNameList;
429 /**
430 * Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.
431 */
432 Deployed?: Boolean;
433 }
434 export interface DescribeAnalysisSchemesResponse {
435 /**
436 * The analysis scheme descriptions.
437 */
438 AnalysisSchemes: AnalysisSchemeStatusList;
439 }
440 export interface DescribeAvailabilityOptionsRequest {
441 /**
442 * The name of the domain you want to describe.
443 */
444 DomainName: DomainName;
445 /**
446 * Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.
447 */
448 Deployed?: Boolean;
449 }
450 export interface DescribeAvailabilityOptionsResponse {
451 /**
452 * The availability options configured for the domain. Indicates whether Multi-AZ is enabled for the domain.
453 */
454 AvailabilityOptions?: AvailabilityOptionsStatus;
455 }
456 export interface DescribeDomainEndpointOptionsRequest {
457 /**
458 * A string that represents the name of a domain.
459 */
460 DomainName: DomainName;
461 /**
462 * Whether to retrieve the latest configuration (which might be in a Processing state) or the current, active configuration. Defaults to false.
463 */
464 Deployed?: Boolean;
465 }
466 export interface DescribeDomainEndpointOptionsResponse {
467 /**
468 * The status and configuration of a search domain's endpoint options.
469 */
470 DomainEndpointOptions?: DomainEndpointOptionsStatus;
471 }
472 export interface DescribeDomainsRequest {
473 /**
474 * The names of the domains you want to include in the response.
475 */
476 DomainNames?: DomainNameList;
477 }
478 export interface DescribeDomainsResponse {
479 DomainStatusList: DomainStatusList;
480 }
481 export interface DescribeExpressionsRequest {
482 /**
483 * The name of the domain you want to describe.
484 */
485 DomainName: DomainName;
486 /**
487 * Limits the DescribeExpressions response to the specified expressions. If not specified, all expressions are shown.
488 */
489 ExpressionNames?: StandardNameList;
490 /**
491 * Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.
492 */
493 Deployed?: Boolean;
494 }
495 export interface DescribeExpressionsResponse {
496 /**
497 * The expressions configured for the domain.
498 */
499 Expressions: ExpressionStatusList;
500 }
501 export interface DescribeIndexFieldsRequest {
502 /**
503 * The name of the domain you want to describe.
504 */
505 DomainName: DomainName;
506 /**
507 * A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.
508 */
509 FieldNames?: DynamicFieldNameList;
510 /**
511 * Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.
512 */
513 Deployed?: Boolean;
514 }
515 export interface DescribeIndexFieldsResponse {
516 /**
517 * The index fields configured for the domain.
518 */
519 IndexFields: IndexFieldStatusList;
520 }
521 export interface DescribeScalingParametersRequest {
522 DomainName: DomainName;
523 }
524 export interface DescribeScalingParametersResponse {
525 ScalingParameters: ScalingParametersStatus;
526 }
527 export interface DescribeServiceAccessPoliciesRequest {
528 /**
529 * The name of the domain you want to describe.
530 */
531 DomainName: DomainName;
532 /**
533 * Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.
534 */
535 Deployed?: Boolean;
536 }
537 export interface DescribeServiceAccessPoliciesResponse {
538 /**
539 * The access rules configured for the domain specified in the request.
540 */
541 AccessPolicies: AccessPoliciesStatus;
542 }
543 export interface DescribeSuggestersRequest {
544 /**
545 * The name of the domain you want to describe.
546 */
547 DomainName: DomainName;
548 /**
549 * The suggesters you want to describe.
550 */
551 SuggesterNames?: StandardNameList;
552 /**
553 * Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.
554 */
555 Deployed?: Boolean;
556 }
557 export interface DescribeSuggestersResponse {
558 /**
559 * The suggesters configured for the domain specified in the request.
560 */
561 Suggesters: SuggesterStatusList;
562 }
563 export interface DocumentSuggesterOptions {
564 /**
565 * The name of the index field you want to use for suggestions.
566 */
567 SourceField: FieldName;
568 /**
569 * The level of fuzziness allowed when suggesting matches for a string: none, low, or high. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.
570 */
571 FuzzyMatching?: SuggesterFuzzyMatching;
572 /**
573 * An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the _score value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.
574 */
575 SortExpression?: String;
576 }
577 export interface DomainEndpointOptions {
578 /**
579 * Whether the domain is HTTPS only enabled.
580 */
581 EnforceHTTPS?: Boolean;
582 /**
583 * The minimum required TLS version
584 */
585 TLSSecurityPolicy?: TLSSecurityPolicy;
586 }
587 export interface DomainEndpointOptionsStatus {
588 /**
589 * The domain endpoint options configured for the domain.
590 */
591 Options: DomainEndpointOptions;
592 /**
593 * The status of the configured domain endpoint options.
594 */
595 Status: OptionStatus;
596 }
597 export type DomainId = string;
598 export type DomainName = string;
599 export type DomainNameList = DomainName[];
600 export type DomainNameMap = {[key: string]: APIVersion};
601 export interface DomainStatus {
602 DomainId: DomainId;
603 DomainName: DomainName;
604 ARN?: ARN;
605 /**
606 * True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete.
607 */
608 Created?: Boolean;
609 /**
610 * True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true value for IsDeleted for several minutes until resource cleanup is complete.
611 */
612 Deleted?: Boolean;
613 /**
614 * The service endpoint for updating documents in a search domain.
615 */
616 DocService?: ServiceEndpoint;
617 /**
618 * The service endpoint for requesting search results from a search domain.
619 */
620 SearchService?: ServiceEndpoint;
621 /**
622 * True if IndexDocuments needs to be called to activate the current domain configuration.
623 */
624 RequiresIndexDocuments: Boolean;
625 /**
626 * True if processing is being done to activate the current domain configuration.
627 */
628 Processing?: Boolean;
629 /**
630 * The instance type that is being used to process search requests.
631 */
632 SearchInstanceType?: SearchInstanceType;
633 /**
634 * The number of partitions across which the search index is spread.
635 */
636 SearchPartitionCount?: PartitionCount;
637 /**
638 * The number of search instances that are available to process search requests.
639 */
640 SearchInstanceCount?: InstanceCount;
641 Limits?: Limits;
642 }
643 export type DomainStatusList = DomainStatus[];
644 export type Double = number;
645 export interface DoubleArrayOptions {
646 /**
647 * A value to use for the field if the field isn't specified for a document.
648 */
649 DefaultValue?: Double;
650 /**
651 * A list of source fields to map to the field.
652 */
653 SourceFields?: FieldNameCommaList;
654 /**
655 * Whether facet information can be returned for the field.
656 */
657 FacetEnabled?: Boolean;
658 /**
659 * Whether the contents of the field are searchable.
660 */
661 SearchEnabled?: Boolean;
662 /**
663 * Whether the contents of the field can be returned in the search results.
664 */
665 ReturnEnabled?: Boolean;
666 }
667 export interface DoubleOptions {
668 /**
669 * 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.
670 */
671 DefaultValue?: Double;
672 /**
673 * The name of the source field to map to the field.
674 */
675 SourceField?: FieldName;
676 /**
677 * Whether facet information can be returned for the field.
678 */
679 FacetEnabled?: Boolean;
680 /**
681 * Whether the contents of the field are searchable.
682 */
683 SearchEnabled?: Boolean;
684 /**
685 * Whether the contents of the field can be returned in the search results.
686 */
687 ReturnEnabled?: Boolean;
688 /**
689 * Whether the field can be used to sort the search results.
690 */
691 SortEnabled?: Boolean;
692 }
693 export type DynamicFieldName = string;
694 export type DynamicFieldNameList = DynamicFieldName[];
695 export interface Expression {
696 ExpressionName: StandardName;
697 ExpressionValue: ExpressionValue;
698 }
699 export interface ExpressionStatus {
700 /**
701 * The expression that is evaluated for sorting while processing a search request.
702 */
703 Options: Expression;
704 Status: OptionStatus;
705 }
706 export type ExpressionStatusList = ExpressionStatus[];
707 export type ExpressionValue = string;
708 export type FieldName = string;
709 export type FieldNameCommaList = string;
710 export type FieldNameList = FieldName[];
711 export type FieldValue = string;
712 export interface IndexDocumentsRequest {
713 DomainName: DomainName;
714 }
715 export interface IndexDocumentsResponse {
716 /**
717 * The names of the fields that are currently being indexed.
718 */
719 FieldNames?: FieldNameList;
720 }
721 export interface IndexField {
722 /**
723 * A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options. Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported. The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.
724 */
725 IndexFieldName: DynamicFieldName;
726 IndexFieldType: IndexFieldType;
727 IntOptions?: IntOptions;
728 DoubleOptions?: DoubleOptions;
729 LiteralOptions?: LiteralOptions;
730 TextOptions?: TextOptions;
731 DateOptions?: DateOptions;
732 LatLonOptions?: LatLonOptions;
733 IntArrayOptions?: IntArrayOptions;
734 DoubleArrayOptions?: DoubleArrayOptions;
735 LiteralArrayOptions?: LiteralArrayOptions;
736 TextArrayOptions?: TextArrayOptions;
737 DateArrayOptions?: DateArrayOptions;
738 }
739 export interface IndexFieldStatus {
740 Options: IndexField;
741 Status: OptionStatus;
742 }
743 export type IndexFieldStatusList = IndexFieldStatus[];
744 export type IndexFieldType = "int"|"double"|"literal"|"text"|"date"|"latlon"|"int-array"|"double-array"|"literal-array"|"text-array"|"date-array"|string;
745 export type InstanceCount = number;
746 export interface IntArrayOptions {
747 /**
748 * A value to use for the field if the field isn't specified for a document.
749 */
750 DefaultValue?: Long;
751 /**
752 * A list of source fields to map to the field.
753 */
754 SourceFields?: FieldNameCommaList;
755 /**
756 * Whether facet information can be returned for the field.
757 */
758 FacetEnabled?: Boolean;
759 /**
760 * Whether the contents of the field are searchable.
761 */
762 SearchEnabled?: Boolean;
763 /**
764 * Whether the contents of the field can be returned in the search results.
765 */
766 ReturnEnabled?: Boolean;
767 }
768 export interface IntOptions {
769 /**
770 * 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.
771 */
772 DefaultValue?: Long;
773 /**
774 * The name of the source field to map to the field.
775 */
776 SourceField?: FieldName;
777 /**
778 * Whether facet information can be returned for the field.
779 */
780 FacetEnabled?: Boolean;
781 /**
782 * Whether the contents of the field are searchable.
783 */
784 SearchEnabled?: Boolean;
785 /**
786 * Whether the contents of the field can be returned in the search results.
787 */
788 ReturnEnabled?: Boolean;
789 /**
790 * Whether the field can be used to sort the search results.
791 */
792 SortEnabled?: Boolean;
793 }
794 export interface LatLonOptions {
795 /**
796 * A value to use for the field if the field isn't specified for a document.
797 */
798 DefaultValue?: FieldValue;
799 SourceField?: FieldName;
800 /**
801 * Whether facet information can be returned for the field.
802 */
803 FacetEnabled?: Boolean;
804 /**
805 * Whether the contents of the field are searchable.
806 */
807 SearchEnabled?: Boolean;
808 /**
809 * Whether the contents of the field can be returned in the search results.
810 */
811 ReturnEnabled?: Boolean;
812 /**
813 * Whether the field can be used to sort the search results.
814 */
815 SortEnabled?: Boolean;
816 }
817 export interface Limits {
818 MaximumReplicationCount: MaximumReplicationCount;
819 MaximumPartitionCount: MaximumPartitionCount;
820 }
821 export interface ListDomainNamesResponse {
822 /**
823 * The names of the search domains owned by an account.
824 */
825 DomainNames?: DomainNameMap;
826 }
827 export interface LiteralArrayOptions {
828 /**
829 * A value to use for the field if the field isn't specified for a document.
830 */
831 DefaultValue?: FieldValue;
832 /**
833 * A list of source fields to map to the field.
834 */
835 SourceFields?: FieldNameCommaList;
836 /**
837 * Whether facet information can be returned for the field.
838 */
839 FacetEnabled?: Boolean;
840 /**
841 * Whether the contents of the field are searchable.
842 */
843 SearchEnabled?: Boolean;
844 /**
845 * Whether the contents of the field can be returned in the search results.
846 */
847 ReturnEnabled?: Boolean;
848 }
849 export interface LiteralOptions {
850 /**
851 * A value to use for the field if the field isn't specified for a document.
852 */
853 DefaultValue?: FieldValue;
854 SourceField?: FieldName;
855 /**
856 * Whether facet information can be returned for the field.
857 */
858 FacetEnabled?: Boolean;
859 /**
860 * Whether the contents of the field are searchable.
861 */
862 SearchEnabled?: Boolean;
863 /**
864 * Whether the contents of the field can be returned in the search results.
865 */
866 ReturnEnabled?: Boolean;
867 /**
868 * Whether the field can be used to sort the search results.
869 */
870 SortEnabled?: Boolean;
871 }
872 export type Long = number;
873 export type MaximumPartitionCount = number;
874 export type MaximumReplicationCount = number;
875 export type MultiAZ = boolean;
876 export type OptionState = "RequiresIndexDocuments"|"Processing"|"Active"|"FailedToValidate"|string;
877 export interface OptionStatus {
878 /**
879 * A timestamp for when this option was created.
880 */
881 CreationDate: UpdateTimestamp;
882 /**
883 * A timestamp for when this option was last updated.
884 */
885 UpdateDate: UpdateTimestamp;
886 /**
887 * A unique integer that indicates when this option was last updated.
888 */
889 UpdateVersion?: UIntValue;
890 /**
891 * The state of processing a change to an option. Possible values: RequiresIndexDocuments: the option's latest value will not be deployed until IndexDocuments has been called and indexing is complete. Processing: the option's latest value is in the process of being activated. Active: the option's latest value is completely deployed. FailedToValidate: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
892 */
893 State: OptionState;
894 /**
895 * Indicates that the option will be deleted once processing is complete.
896 */
897 PendingDeletion?: Boolean;
898 }
899 export type PartitionCount = number;
900 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;
901 export type PolicyDocument = string;
902 export interface ScalingParameters {
903 /**
904 * The instance type that you want to preconfigure for your domain. For example, search.m1.small.
905 */
906 DesiredInstanceType?: PartitionInstanceType;
907 /**
908 * The number of replicas you want to preconfigure for each index partition.
909 */
910 DesiredReplicationCount?: UIntValue;
911 /**
912 * The number of partitions you want to preconfigure for your domain. Only valid when you select m2.2xlarge as the desired instance type.
913 */
914 DesiredPartitionCount?: UIntValue;
915 }
916 export interface ScalingParametersStatus {
917 Options: ScalingParameters;
918 Status: OptionStatus;
919 }
920 export type SearchInstanceType = string;
921 export interface ServiceEndpoint {
922 Endpoint?: ServiceUrl;
923 }
924 export type ServiceUrl = string;
925 export type StandardName = string;
926 export type StandardNameList = StandardName[];
927 export type String = string;
928 export interface Suggester {
929 SuggesterName: StandardName;
930 DocumentSuggesterOptions: DocumentSuggesterOptions;
931 }
932 export type SuggesterFuzzyMatching = "none"|"low"|"high"|string;
933 export interface SuggesterStatus {
934 Options: Suggester;
935 Status: OptionStatus;
936 }
937 export type SuggesterStatusList = SuggesterStatus[];
938 export type TLSSecurityPolicy = "Policy-Min-TLS-1-0-2019-07"|"Policy-Min-TLS-1-2-2019-07"|string;
939 export interface TextArrayOptions {
940 /**
941 * A value to use for the field if the field isn't specified for a document.
942 */
943 DefaultValue?: FieldValue;
944 /**
945 * A list of source fields to map to the field.
946 */
947 SourceFields?: FieldNameCommaList;
948 /**
949 * Whether the contents of the field can be returned in the search results.
950 */
951 ReturnEnabled?: Boolean;
952 /**
953 * Whether highlights can be returned for the field.
954 */
955 HighlightEnabled?: Boolean;
956 /**
957 * The name of an analysis scheme for a text-array field.
958 */
959 AnalysisScheme?: Word;
960 }
961 export interface TextOptions {
962 /**
963 * A value to use for the field if the field isn't specified for a document.
964 */
965 DefaultValue?: FieldValue;
966 SourceField?: FieldName;
967 /**
968 * Whether the contents of the field can be returned in the search results.
969 */
970 ReturnEnabled?: Boolean;
971 /**
972 * Whether the field can be used to sort the search results.
973 */
974 SortEnabled?: Boolean;
975 /**
976 * Whether highlights can be returned for the field.
977 */
978 HighlightEnabled?: Boolean;
979 /**
980 * The name of an analysis scheme for a text field.
981 */
982 AnalysisScheme?: Word;
983 }
984 export type UIntValue = number;
985 export interface UpdateAvailabilityOptionsRequest {
986 DomainName: DomainName;
987 /**
988 * 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 false.
989 */
990 MultiAZ: Boolean;
991 }
992 export interface UpdateAvailabilityOptionsResponse {
993 /**
994 * The newly-configured availability options. Indicates whether Multi-AZ is enabled for the domain.
995 */
996 AvailabilityOptions?: AvailabilityOptionsStatus;
997 }
998 export interface UpdateDomainEndpointOptionsRequest {
999 /**
1000 * A string that represents the name of a domain.
1001 */
1002 DomainName: DomainName;
1003 /**
1004 * 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.
1005 */
1006 DomainEndpointOptions: DomainEndpointOptions;
1007 }
1008 export interface UpdateDomainEndpointOptionsResponse {
1009 /**
1010 * The newly-configured domain endpoint options.
1011 */
1012 DomainEndpointOptions?: DomainEndpointOptionsStatus;
1013 }
1014 export interface UpdateScalingParametersRequest {
1015 DomainName: DomainName;
1016 ScalingParameters: ScalingParameters;
1017 }
1018 export interface UpdateScalingParametersResponse {
1019 ScalingParameters: ScalingParametersStatus;
1020 }
1021 export interface UpdateServiceAccessPoliciesRequest {
1022 DomainName: DomainName;
1023 /**
1024 * The access rules you want to configure. These rules replace any existing rules.
1025 */
1026 AccessPolicies: PolicyDocument;
1027 }
1028 export interface UpdateServiceAccessPoliciesResponse {
1029 /**
1030 * The access rules configured for the domain.
1031 */
1032 AccessPolicies: AccessPoliciesStatus;
1033 }
1034 export type UpdateTimestamp = Date;
1035 export type Word = string;
1036 /**
1037 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
1038 */
1039 export type apiVersion = "2011-02-01"|"2013-01-01"|"latest"|string;
1040 export interface ClientApiVersions {
1041 /**
1042 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
1043 */
1044 apiVersion?: apiVersion;
1045 }
1046 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
1047 /**
1048 * Contains interfaces for use with the CloudSearch client.
1049 */
1050 export import Types = CloudSearch;
1051}
1052export = CloudSearch;