cloudsearch.d.ts (52784B)
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 * 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 * 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.Types { 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 * 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. 214 */ 215 Synonyms?: String; 216 /** 217 * 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. 218 */ 219 Stopwords?: String; 220 /** 221 * 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. 222 */ 223 StemmingDictionary?: String; 224 /** 225 * 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. 226 */ 227 JapaneseTokenizationDictionary?: String; 228 /** 229 * 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 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 * The availability options configured for the domain. 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 * 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. 261 */ 262 DomainName: DomainName; 263 } 264 export interface CreateDomainResponse { 265 DomainStatus?: DomainStatus; 266 } 267 export interface DateArrayOptions { 268 /** 269 * A value to use for the field if the field isn't specified for a document. 270 */ 271 DefaultValue?: FieldValue; 272 /** 273 * A list of source fields to map to the field. 274 */ 275 SourceFields?: FieldNameCommaList; 276 /** 277 * Whether facet information can be returned for the field. 278 */ 279 FacetEnabled?: Boolean; 280 /** 281 * Whether the contents of the field are searchable. 282 */ 283 SearchEnabled?: Boolean; 284 /** 285 * Whether the contents of the field can be returned in the search results. 286 */ 287 ReturnEnabled?: Boolean; 288 } 289 export interface DateOptions { 290 /** 291 * A value to use for the field if the field isn't specified for a document. 292 */ 293 DefaultValue?: FieldValue; 294 SourceField?: FieldName; 295 /** 296 * Whether facet information can be returned for the field. 297 */ 298 FacetEnabled?: Boolean; 299 /** 300 * Whether the contents of the field are searchable. 301 */ 302 SearchEnabled?: Boolean; 303 /** 304 * Whether the contents of the field can be returned in the search results. 305 */ 306 ReturnEnabled?: Boolean; 307 /** 308 * Whether the field can be used to sort the search results. 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 * The index field and field options you want to configure. 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 * The name of the analysis scheme you want to delete. 347 */ 348 AnalysisSchemeName: StandardName; 349 } 350 export interface DeleteAnalysisSchemeResponse { 351 /** 352 * The status of the analysis scheme being deleted. 353 */ 354 AnalysisScheme: AnalysisSchemeStatus; 355 } 356 export interface DeleteDomainRequest { 357 /** 358 * The name of the domain you want to permanently delete. 359 */ 360 DomainName: DomainName; 361 } 362 export interface DeleteDomainResponse { 363 DomainStatus?: DomainStatus; 364 } 365 export interface DeleteExpressionRequest { 366 DomainName: DomainName; 367 /** 368 * The name of the Expression to delete. 369 */ 370 ExpressionName: StandardName; 371 } 372 export interface DeleteExpressionResponse { 373 /** 374 * The status of the expression being deleted. 375 */ 376 Expression: ExpressionStatus; 377 } 378 export interface DeleteIndexFieldRequest { 379 DomainName: DomainName; 380 /** 381 * The name of the index field your want to remove from the domain's indexing options. 382 */ 383 IndexFieldName: DynamicFieldName; 384 } 385 export interface DeleteIndexFieldResponse { 386 /** 387 * The status of the index field being deleted. 388 */ 389 IndexField: IndexFieldStatus; 390 } 391 export interface DeleteSuggesterRequest { 392 DomainName: DomainName; 393 /** 394 * Specifies the name of the suggester you want to delete. 395 */ 396 SuggesterName: StandardName; 397 } 398 export interface DeleteSuggesterResponse { 399 /** 400 * The status of the suggester being deleted. 401 */ 402 Suggester: SuggesterStatus; 403 } 404 export interface DescribeAnalysisSchemesRequest { 405 /** 406 * The name of the domain you want to describe. 407 */ 408 DomainName: DomainName; 409 /** 410 * The analysis schemes you want to describe. 411 */ 412 AnalysisSchemeNames?: StandardNameList; 413 /** 414 * Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false. 415 */ 416 Deployed?: Boolean; 417 } 418 export interface DescribeAnalysisSchemesResponse { 419 /** 420 * The analysis scheme descriptions. 421 */ 422 AnalysisSchemes: AnalysisSchemeStatusList; 423 } 424 export interface DescribeAvailabilityOptionsRequest { 425 /** 426 * The name of the domain you want to describe. 427 */ 428 DomainName: DomainName; 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 DescribeAvailabilityOptionsResponse { 435 /** 436 * The availability options configured for the domain. Indicates whether Multi-AZ is enabled for the domain. 437 */ 438 AvailabilityOptions?: AvailabilityOptionsStatus; 439 } 440 export interface DescribeDomainsRequest { 441 /** 442 * The names of the domains you want to include in the response. 443 */ 444 DomainNames?: DomainNameList; 445 } 446 export interface DescribeDomainsResponse { 447 DomainStatusList: DomainStatusList; 448 } 449 export interface DescribeExpressionsRequest { 450 /** 451 * The name of the domain you want to describe. 452 */ 453 DomainName: DomainName; 454 /** 455 * Limits the DescribeExpressions response to the specified expressions. If not specified, all expressions are shown. 456 */ 457 ExpressionNames?: StandardNameList; 458 /** 459 * Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false. 460 */ 461 Deployed?: Boolean; 462 } 463 export interface DescribeExpressionsResponse { 464 /** 465 * The expressions configured for the domain. 466 */ 467 Expressions: ExpressionStatusList; 468 } 469 export interface DescribeIndexFieldsRequest { 470 /** 471 * The name of the domain you want to describe. 472 */ 473 DomainName: DomainName; 474 /** 475 * A list of the index fields you want to describe. If not specified, information is returned for all configured index fields. 476 */ 477 FieldNames?: DynamicFieldNameList; 478 /** 479 * Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false. 480 */ 481 Deployed?: Boolean; 482 } 483 export interface DescribeIndexFieldsResponse { 484 /** 485 * The index fields configured for the domain. 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 * The name of the domain you want to describe. 498 */ 499 DomainName: DomainName; 500 /** 501 * Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false. 502 */ 503 Deployed?: Boolean; 504 } 505 export interface DescribeServiceAccessPoliciesResponse { 506 /** 507 * The access rules configured for the domain specified in the request. 508 */ 509 AccessPolicies: AccessPoliciesStatus; 510 } 511 export interface DescribeSuggestersRequest { 512 /** 513 * The name of the domain you want to describe. 514 */ 515 DomainName: DomainName; 516 /** 517 * The suggesters you want to describe. 518 */ 519 SuggesterNames?: StandardNameList; 520 /** 521 * Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false. 522 */ 523 Deployed?: Boolean; 524 } 525 export interface DescribeSuggestersResponse { 526 /** 527 * The suggesters configured for the domain specified in the request. 528 */ 529 Suggesters: SuggesterStatusList; 530 } 531 export interface DocumentSuggesterOptions { 532 /** 533 * The name of the index field you want to use for suggestions. 534 */ 535 SourceField: FieldName; 536 /** 537 * 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. 538 */ 539 FuzzyMatching?: SuggesterFuzzyMatching; 540 /** 541 * 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. 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 * 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. 555 */ 556 Created?: Boolean; 557 /** 558 * 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. 559 */ 560 Deleted?: Boolean; 561 /** 562 * The service endpoint for updating documents in a search domain. 563 */ 564 DocService?: ServiceEndpoint; 565 /** 566 * The service endpoint for requesting search results from a search domain. 567 */ 568 SearchService?: ServiceEndpoint; 569 /** 570 * True if IndexDocuments needs to be called to activate the current domain configuration. 571 */ 572 RequiresIndexDocuments: Boolean; 573 /** 574 * True if processing is being done to activate the current domain configuration. 575 */ 576 Processing?: Boolean; 577 /** 578 * The instance type that is being used to process search requests. 579 */ 580 SearchInstanceType?: SearchInstanceType; 581 /** 582 * The number of partitions across which the search index is spread. 583 */ 584 SearchPartitionCount?: PartitionCount; 585 /** 586 * The number of search instances that are available to process search requests. 587 */ 588 SearchInstanceCount?: InstanceCount; 589 Limits?: Limits; 590 } 591 export type DomainStatusList = DomainStatus[]; 592 export type Double = number; 593 export interface DoubleArrayOptions { 594 /** 595 * A value to use for the field if the field isn't specified for a document. 596 */ 597 DefaultValue?: Double; 598 /** 599 * A list of source fields to map to the field. 600 */ 601 SourceFields?: FieldNameCommaList; 602 /** 603 * Whether facet information can be returned for the field. 604 */ 605 FacetEnabled?: Boolean; 606 /** 607 * Whether the contents of the field are searchable. 608 */ 609 SearchEnabled?: Boolean; 610 /** 611 * Whether the contents of the field can be returned in the search results. 612 */ 613 ReturnEnabled?: Boolean; 614 } 615 export interface DoubleOptions { 616 /** 617 * 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. 618 */ 619 DefaultValue?: Double; 620 /** 621 * The name of the source field to map to the field. 622 */ 623 SourceField?: FieldName; 624 /** 625 * Whether facet information can be returned for the field. 626 */ 627 FacetEnabled?: Boolean; 628 /** 629 * Whether the contents of the field are searchable. 630 */ 631 SearchEnabled?: Boolean; 632 /** 633 * Whether the contents of the field can be returned in the search results. 634 */ 635 ReturnEnabled?: Boolean; 636 /** 637 * Whether the field can be used to sort the search results. 638 */ 639 SortEnabled?: Boolean; 640 } 641 export type DynamicFieldName = string; 642 export type DynamicFieldNameList = DynamicFieldName[]; 643 export type ErrorCode = string; 644 export type ErrorMessage = string; 645 export interface Expression { 646 ExpressionName: StandardName; 647 ExpressionValue: ExpressionValue; 648 } 649 export interface ExpressionStatus { 650 /** 651 * The expression that is evaluated for sorting while processing a search request. 652 */ 653 Options: Expression; 654 Status: OptionStatus; 655 } 656 export type ExpressionStatusList = ExpressionStatus[]; 657 export type ExpressionValue = string; 658 export type FieldName = string; 659 export type FieldNameCommaList = string; 660 export type FieldNameList = FieldName[]; 661 export type FieldValue = string; 662 export interface IndexDocumentsRequest { 663 DomainName: DomainName; 664 } 665 export interface IndexDocumentsResponse { 666 /** 667 * The names of the fields that are currently being indexed. 668 */ 669 FieldNames?: FieldNameList; 670 } 671 export interface IndexField { 672 /** 673 * 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. 674 */ 675 IndexFieldName: DynamicFieldName; 676 IndexFieldType: IndexFieldType; 677 IntOptions?: IntOptions; 678 DoubleOptions?: DoubleOptions; 679 LiteralOptions?: LiteralOptions; 680 TextOptions?: TextOptions; 681 DateOptions?: DateOptions; 682 LatLonOptions?: LatLonOptions; 683 IntArrayOptions?: IntArrayOptions; 684 DoubleArrayOptions?: DoubleArrayOptions; 685 LiteralArrayOptions?: LiteralArrayOptions; 686 TextArrayOptions?: TextArrayOptions; 687 DateArrayOptions?: DateArrayOptions; 688 } 689 export interface IndexFieldStatus { 690 Options: IndexField; 691 Status: OptionStatus; 692 } 693 export type IndexFieldStatusList = IndexFieldStatus[]; 694 export type IndexFieldType = "int"|"double"|"literal"|"text"|"date"|"latlon"|"int-array"|"double-array"|"literal-array"|"text-array"|"date-array"|string; 695 export type InstanceCount = number; 696 export interface IntArrayOptions { 697 /** 698 * A value to use for the field if the field isn't specified for a document. 699 */ 700 DefaultValue?: Long; 701 /** 702 * A list of source fields to map to the field. 703 */ 704 SourceFields?: FieldNameCommaList; 705 /** 706 * Whether facet information can be returned for the field. 707 */ 708 FacetEnabled?: Boolean; 709 /** 710 * Whether the contents of the field are searchable. 711 */ 712 SearchEnabled?: Boolean; 713 /** 714 * Whether the contents of the field can be returned in the search results. 715 */ 716 ReturnEnabled?: Boolean; 717 } 718 export interface IntOptions { 719 /** 720 * 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. 721 */ 722 DefaultValue?: Long; 723 /** 724 * The name of the source field to map to the field. 725 */ 726 SourceField?: FieldName; 727 /** 728 * Whether facet information can be returned for the field. 729 */ 730 FacetEnabled?: Boolean; 731 /** 732 * Whether the contents of the field are searchable. 733 */ 734 SearchEnabled?: Boolean; 735 /** 736 * Whether the contents of the field can be returned in the search results. 737 */ 738 ReturnEnabled?: Boolean; 739 /** 740 * Whether the field can be used to sort the search results. 741 */ 742 SortEnabled?: Boolean; 743 } 744 export interface LatLonOptions { 745 /** 746 * A value to use for the field if the field isn't specified for a document. 747 */ 748 DefaultValue?: FieldValue; 749 SourceField?: FieldName; 750 /** 751 * Whether facet information can be returned for the field. 752 */ 753 FacetEnabled?: Boolean; 754 /** 755 * Whether the contents of the field are searchable. 756 */ 757 SearchEnabled?: Boolean; 758 /** 759 * Whether the contents of the field can be returned in the search results. 760 */ 761 ReturnEnabled?: Boolean; 762 /** 763 * Whether the field can be used to sort the search results. 764 */ 765 SortEnabled?: Boolean; 766 } 767 export interface Limits { 768 MaximumReplicationCount: MaximumReplicationCount; 769 MaximumPartitionCount: MaximumPartitionCount; 770 } 771 export interface ListDomainNamesResponse { 772 /** 773 * The names of the search domains owned by an account. 774 */ 775 DomainNames?: DomainNameMap; 776 } 777 export interface LiteralArrayOptions { 778 /** 779 * A value to use for the field if the field isn't specified for a document. 780 */ 781 DefaultValue?: FieldValue; 782 /** 783 * A list of source fields to map to the field. 784 */ 785 SourceFields?: FieldNameCommaList; 786 /** 787 * Whether facet information can be returned for the field. 788 */ 789 FacetEnabled?: Boolean; 790 /** 791 * Whether the contents of the field are searchable. 792 */ 793 SearchEnabled?: Boolean; 794 /** 795 * Whether the contents of the field can be returned in the search results. 796 */ 797 ReturnEnabled?: Boolean; 798 } 799 export interface LiteralOptions { 800 /** 801 * A value to use for the field if the field isn't specified for a document. 802 */ 803 DefaultValue?: FieldValue; 804 SourceField?: FieldName; 805 /** 806 * Whether facet information can be returned for the field. 807 */ 808 FacetEnabled?: Boolean; 809 /** 810 * Whether the contents of the field are searchable. 811 */ 812 SearchEnabled?: Boolean; 813 /** 814 * Whether the contents of the field can be returned in the search results. 815 */ 816 ReturnEnabled?: Boolean; 817 /** 818 * Whether the field can be used to sort the search results. 819 */ 820 SortEnabled?: Boolean; 821 } 822 export type Long = number; 823 export type MaximumPartitionCount = number; 824 export type MaximumReplicationCount = number; 825 export type MultiAZ = boolean; 826 export type OptionState = "RequiresIndexDocuments"|"Processing"|"Active"|"FailedToValidate"|string; 827 export interface OptionStatus { 828 /** 829 * A timestamp for when this option was created. 830 */ 831 CreationDate: UpdateTimestamp; 832 /** 833 * A timestamp for when this option was last updated. 834 */ 835 UpdateDate: UpdateTimestamp; 836 /** 837 * A unique integer that indicates when this option was last updated. 838 */ 839 UpdateVersion?: UIntValue; 840 /** 841 * 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. 842 */ 843 State: OptionState; 844 /** 845 * Indicates that the option will be deleted once processing is complete. 846 */ 847 PendingDeletion?: Boolean; 848 } 849 export type PartitionCount = number; 850 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; 851 export type PolicyDocument = string; 852 export interface ScalingParameters { 853 /** 854 * The instance type that you want to preconfigure for your domain. For example, search.m1.small. 855 */ 856 DesiredInstanceType?: PartitionInstanceType; 857 /** 858 * The number of replicas you want to preconfigure for each index partition. 859 */ 860 DesiredReplicationCount?: UIntValue; 861 /** 862 * The number of partitions you want to preconfigure for your domain. Only valid when you select m2.2xlarge as the desired instance type. 863 */ 864 DesiredPartitionCount?: UIntValue; 865 } 866 export interface ScalingParametersStatus { 867 Options: ScalingParameters; 868 Status: OptionStatus; 869 } 870 export type SearchInstanceType = string; 871 export interface ServiceEndpoint { 872 Endpoint?: ServiceUrl; 873 } 874 export type ServiceUrl = string; 875 export type StandardName = string; 876 export type StandardNameList = StandardName[]; 877 export type String = string; 878 export interface Suggester { 879 SuggesterName: StandardName; 880 DocumentSuggesterOptions: DocumentSuggesterOptions; 881 } 882 export type SuggesterFuzzyMatching = "none"|"low"|"high"|string; 883 export interface SuggesterStatus { 884 Options: Suggester; 885 Status: OptionStatus; 886 } 887 export type SuggesterStatusList = SuggesterStatus[]; 888 export interface TextArrayOptions { 889 /** 890 * A value to use for the field if the field isn't specified for a document. 891 */ 892 DefaultValue?: FieldValue; 893 /** 894 * A list of source fields to map to the field. 895 */ 896 SourceFields?: FieldNameCommaList; 897 /** 898 * Whether the contents of the field can be returned in the search results. 899 */ 900 ReturnEnabled?: Boolean; 901 /** 902 * Whether highlights can be returned for the field. 903 */ 904 HighlightEnabled?: Boolean; 905 /** 906 * The name of an analysis scheme for a text-array field. 907 */ 908 AnalysisScheme?: Word; 909 } 910 export interface TextOptions { 911 /** 912 * A value to use for the field if the field isn't specified for a document. 913 */ 914 DefaultValue?: FieldValue; 915 SourceField?: FieldName; 916 /** 917 * Whether the contents of the field can be returned in the search results. 918 */ 919 ReturnEnabled?: Boolean; 920 /** 921 * Whether the field can be used to sort the search results. 922 */ 923 SortEnabled?: Boolean; 924 /** 925 * Whether highlights can be returned for the field. 926 */ 927 HighlightEnabled?: Boolean; 928 /** 929 * The name of an analysis scheme for a text field. 930 */ 931 AnalysisScheme?: Word; 932 } 933 export type UIntValue = number; 934 export interface UpdateAvailabilityOptionsRequest { 935 DomainName: DomainName; 936 /** 937 * 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. 938 */ 939 MultiAZ: Boolean; 940 } 941 export interface UpdateAvailabilityOptionsResponse { 942 /** 943 * The newly-configured availability options. Indicates whether Multi-AZ is enabled for the domain. 944 */ 945 AvailabilityOptions?: AvailabilityOptionsStatus; 946 } 947 export interface UpdateScalingParametersRequest { 948 DomainName: DomainName; 949 ScalingParameters: ScalingParameters; 950 } 951 export interface UpdateScalingParametersResponse { 952 ScalingParameters: ScalingParametersStatus; 953 } 954 export interface UpdateServiceAccessPoliciesRequest { 955 DomainName: DomainName; 956 /** 957 * The access rules you want to configure. These rules replace any existing rules. 958 */ 959 AccessPolicies: PolicyDocument; 960 } 961 export interface UpdateServiceAccessPoliciesResponse { 962 /** 963 * The access rules configured for the domain. 964 */ 965 AccessPolicies: AccessPoliciesStatus; 966 } 967 export type UpdateTimestamp = Date; 968 export type Word = string; 969 /** 970 * 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. 971 */ 972 export type apiVersion = "2011-02-01"|"2013-01-01"|"latest"|string; 973 export interface ClientApiVersions { 974 /** 975 * 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. 976 */ 977 apiVersion?: apiVersion; 978 } 979 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 980 } 981 export = CloudSearch;