@aws-sdk/client-cloudsearch-domain 3.533.0 → 3.540.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,12 +1,14 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.defaultEndpointResolver = void 0;
4
- const util_endpoints_1 = require("@smithy/util-endpoints");
4
+ const util_endpoints_1 = require("@aws-sdk/util-endpoints");
5
+ const util_endpoints_2 = require("@smithy/util-endpoints");
5
6
  const ruleset_1 = require("./ruleset");
6
7
  const defaultEndpointResolver = (endpointParams, context = {}) => {
7
- return (0, util_endpoints_1.resolveEndpoint)(ruleset_1.ruleSet, {
8
+ return (0, util_endpoints_2.resolveEndpoint)(ruleset_1.ruleSet, {
8
9
  endpointParams: endpointParams,
9
10
  logger: context.logger,
10
11
  });
11
12
  };
12
13
  exports.defaultEndpointResolver = defaultEndpointResolver;
14
+ util_endpoints_2.customEndpointFunctions.aws = util_endpoints_1.awsEndpointFunctions;
package/dist-cjs/index.js CHANGED
@@ -524,9 +524,6 @@ var _CloudSearchDomain = class _CloudSearchDomain extends CloudSearchDomainClien
524
524
  __name(_CloudSearchDomain, "CloudSearchDomain");
525
525
  var CloudSearchDomain = _CloudSearchDomain;
526
526
  (0, import_smithy_client.createAggregatedClient)(commands, CloudSearchDomain);
527
-
528
- // src/index.ts
529
- var import_util_endpoints = require("@aws-sdk/util-endpoints");
530
527
  // Annotate the CommonJS export names for ESM import in node:
531
528
 
532
529
  0 && (module.exports = {
@@ -1,4 +1,5 @@
1
- import { resolveEndpoint } from "@smithy/util-endpoints";
1
+ import { awsEndpointFunctions } from "@aws-sdk/util-endpoints";
2
+ import { customEndpointFunctions, resolveEndpoint } from "@smithy/util-endpoints";
2
3
  import { ruleSet } from "./ruleset";
3
4
  export const defaultEndpointResolver = (endpointParams, context = {}) => {
4
5
  return resolveEndpoint(ruleSet, {
@@ -6,3 +7,4 @@ export const defaultEndpointResolver = (endpointParams, context = {}) => {
6
7
  logger: context.logger,
7
8
  });
8
9
  };
10
+ customEndpointFunctions.aws = awsEndpointFunctions;
package/dist-es/index.js CHANGED
@@ -2,5 +2,4 @@ export * from "./CloudSearchDomainClient";
2
2
  export * from "./CloudSearchDomain";
3
3
  export * from "./commands";
4
4
  export * from "./models";
5
- import "@aws-sdk/util-endpoints";
6
5
  export { CloudSearchDomainServiceException } from "./models/CloudSearchDomainServiceException";
@@ -24,11 +24,11 @@ export interface CloudSearchDomain {
24
24
  uploadDocuments(args: UploadDocumentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UploadDocumentsCommandOutput) => void): void;
25
25
  }
26
26
  /**
27
- * @public
28
27
  * <p>You use the AmazonCloudSearch2013 API to upload documents to a search domain and search those documents. </p>
29
28
  *
30
29
  * <p>The endpoints for submitting <code>UploadDocuments</code>, <code>Search</code>, and <code>Suggest</code> requests are domain-specific. To get the endpoints for your domain, use the Amazon CloudSearch configuration service <code>DescribeDomains</code> action. The domain endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. You submit suggest requests to the search endpoint. </p>
31
30
  * <p>For more information, see the <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide">Amazon CloudSearch Developer Guide</a>.</p>
31
+ * @public
32
32
  */
33
33
  export declare class CloudSearchDomain extends CloudSearchDomainClient implements CloudSearchDomain {
34
34
  }
@@ -154,11 +154,11 @@ export type CloudSearchDomainClientResolvedConfigType = __SmithyResolvedConfigur
154
154
  export interface CloudSearchDomainClientResolvedConfig extends CloudSearchDomainClientResolvedConfigType {
155
155
  }
156
156
  /**
157
- * @public
158
157
  * <p>You use the AmazonCloudSearch2013 API to upload documents to a search domain and search those documents. </p>
159
158
  *
160
159
  * <p>The endpoints for submitting <code>UploadDocuments</code>, <code>Search</code>, and <code>Suggest</code> requests are domain-specific. To get the endpoints for your domain, use the Amazon CloudSearch configuration service <code>DescribeDomains</code> action. The domain endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. You submit suggest requests to the search endpoint. </p>
161
160
  * <p>For more information, see the <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide">Amazon CloudSearch Developer Guide</a>.</p>
161
+ * @public
162
162
  */
163
163
  export declare class CloudSearchDomainClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, CloudSearchDomainClientResolvedConfig> {
164
164
  /**
@@ -22,10 +22,10 @@ export interface SearchCommandOutput extends SearchResponse, __MetadataBearer {
22
22
  }
23
23
  declare const SearchCommand_base: {
24
24
  new (input: SearchCommandInput): import("@smithy/smithy-client").CommandImpl<SearchCommandInput, SearchCommandOutput, CloudSearchDomainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ new (__0_0: SearchCommandInput): import("@smithy/smithy-client").CommandImpl<SearchCommandInput, SearchCommandOutput, CloudSearchDomainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
26
27
  };
27
28
  /**
28
- * @public
29
29
  * <p>Retrieves a list of documents that match the specified search criteria. How you specify the search criteria depends on which query parser you use. Amazon CloudSearch supports four query parsers:</p>
30
30
  * <ul>
31
31
  * <li><code>simple</code>: search all <code>text</code> and <code>text-array</code> fields for the specified string. Search for phrases, individual terms, and prefixes. </li>
@@ -123,6 +123,7 @@ declare const SearchCommand_base: {
123
123
  * @throws {@link CloudSearchDomainServiceException}
124
124
  * <p>Base exception class for all service exceptions from CloudSearchDomain service.</p>
125
125
  *
126
+ * @public
126
127
  */
127
128
  export declare class SearchCommand extends SearchCommand_base {
128
129
  }
@@ -22,10 +22,10 @@ export interface SuggestCommandOutput extends SuggestResponse, __MetadataBearer
22
22
  }
23
23
  declare const SuggestCommand_base: {
24
24
  new (input: SuggestCommandInput): import("@smithy/smithy-client").CommandImpl<SuggestCommandInput, SuggestCommandOutput, CloudSearchDomainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ new (__0_0: SuggestCommandInput): import("@smithy/smithy-client").CommandImpl<SuggestCommandInput, SuggestCommandOutput, CloudSearchDomainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
26
27
  };
27
28
  /**
28
- * @public
29
29
  * <p>Retrieves autocomplete suggestions for a partial query string. You can use suggestions enable you to display likely matches before users finish typing. In Amazon CloudSearch, suggestions are based on the contents of a particular text field. When you request suggestions, Amazon CloudSearch finds all of the documents whose values in the suggester field start with the specified query string. The beginning of the field must match the query string to be considered a match. </p>
30
30
  * <p>For more information about configuring suggesters and retrieving suggestions, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html">Getting Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </p>
31
31
  *
@@ -75,6 +75,7 @@ declare const SuggestCommand_base: {
75
75
  * @throws {@link CloudSearchDomainServiceException}
76
76
  * <p>Base exception class for all service exceptions from CloudSearchDomain service.</p>
77
77
  *
78
+ * @public
78
79
  */
79
80
  export declare class SuggestCommand extends SuggestCommand_base {
80
81
  }
@@ -23,10 +23,10 @@ export interface UploadDocumentsCommandOutput extends UploadDocumentsResponse, _
23
23
  }
24
24
  declare const UploadDocumentsCommand_base: {
25
25
  new (input: UploadDocumentsCommandInput): import("@smithy/smithy-client").CommandImpl<UploadDocumentsCommandInput, UploadDocumentsCommandOutput, CloudSearchDomainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: UploadDocumentsCommandInput): import("@smithy/smithy-client").CommandImpl<UploadDocumentsCommandInput, UploadDocumentsCommandOutput, CloudSearchDomainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
28
  };
28
29
  /**
29
- * @public
30
30
  * <p>Posts a batch of documents to a search domain for indexing. A document batch is a collection of add and delete operations that represent the documents you want to add, update, or delete from your domain. Batches can be described in either JSON or XML. Each item that you want Amazon CloudSearch to return as a search result (such as a product) is represented as a document. Every document has a unique ID and one or more fields that contain the data that you want to search and return in results. Individual documents cannot contain more than 1 MB of data. The entire batch cannot exceed 5 MB. To get the best possible upload performance, group add and delete operations in batches that are close the 5 MB limit. Submitting a large volume of single-document batches can overload a domain's document service. </p>
31
31
  * <p>The endpoint for submitting <code>UploadDocuments</code> requests is domain-specific. To get the document endpoint for your domain, use the Amazon CloudSearch configuration service <code>DescribeDomains</code> action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. </p>
32
32
  * <p>For more information about formatting your data for Amazon CloudSearch, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/preparing-data.html">Preparing Your Data</a> in the <i>Amazon CloudSearch Developer Guide</i>.
@@ -68,6 +68,7 @@ declare const UploadDocumentsCommand_base: {
68
68
  * @throws {@link CloudSearchDomainServiceException}
69
69
  * <p>Base exception class for all service exceptions from CloudSearchDomain service.</p>
70
70
  *
71
+ * @public
71
72
  */
72
73
  export declare class UploadDocumentsCommand extends UploadDocumentsCommand_base {
73
74
  }
@@ -13,5 +13,4 @@ export { RuntimeExtension } from "./runtimeExtensions";
13
13
  export { CloudSearchDomainExtensionConfiguration } from "./extensionConfiguration";
14
14
  export * from "./commands";
15
15
  export * from "./models";
16
- import "@aws-sdk/util-endpoints";
17
16
  export { CloudSearchDomainServiceException } from "./models/CloudSearchDomainServiceException";
@@ -2,8 +2,8 @@ import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-cli
2
2
  import { StreamingBlobTypes } from "@smithy/types";
3
3
  import { CloudSearchDomainServiceException as __BaseException } from "./CloudSearchDomainServiceException";
4
4
  /**
5
- * @public
6
5
  * <p>Information about any problems encountered while processing a search request.</p>
6
+ * @public
7
7
  */
8
8
  export declare class SearchException extends __BaseException {
9
9
  readonly name: "SearchException";
@@ -28,21 +28,20 @@ export declare const QueryParser: {
28
28
  */
29
29
  export type QueryParser = (typeof QueryParser)[keyof typeof QueryParser];
30
30
  /**
31
- * @public
32
31
  * <p>Container for the parameters to the <code>Search</code> request.</p>
32
+ * @public
33
33
  */
34
34
  export interface SearchRequest {
35
35
  /**
36
- * @public
37
36
  * <p>Retrieves a cursor value you can use to page through large result sets.
38
37
  * Use the <code>size</code> parameter to control the number of hits to include in each response. You can specify either the <code>cursor</code> or
39
38
  * <code>start</code> parameter in a request; they are mutually exclusive. To get the first cursor, set the cursor value to <code>initial</code>. In subsequent requests, specify the cursor value returned in the hits section of the response. </p>
40
39
  * <p>For more
41
40
  * information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/paginating-results.html">Paginating Results</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>
41
+ * @public
42
42
  */
43
43
  cursor?: string;
44
44
  /**
45
- * @public
46
45
  * <p>Defines one or more numeric expressions that can be used to sort results or specify search or filter
47
46
  * criteria. You can also specify expressions as return fields. </p>
48
47
  * <p>You specify the expressions in JSON using the form <code>\{"EXPRESSIONNAME":"EXPRESSION"\}</code>. You can define and use multiple expressions in a search request. For example:</p>
@@ -51,10 +50,10 @@ export interface SearchRequest {
51
50
  * </code> </p>
52
51
  * <p>For information about the variables, operators, and functions you can use in expressions, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html#writing-expressions">Writing Expressions</a>
53
52
  * in the <i>Amazon CloudSearch Developer Guide</i>.</p>
53
+ * @public
54
54
  */
55
55
  expr?: string;
56
56
  /**
57
- * @public
58
57
  * <p>Specifies one or more fields for which to get facet information, and options that control how the facet information is returned. Each specified field must be facet-enabled in the domain configuration. The fields and options are specified in JSON using the form <code>\{"FIELD":\{"OPTION":VALUE,"OPTION:"STRING"\},"FIELD":\{"OPTION":VALUE,"OPTION":"STRING"\}\}</code>.</p>
59
58
  * <p>You can specify the following faceting options:</p>
60
59
  * <ul>
@@ -104,17 +103,17 @@ export interface SearchRequest {
104
103
  * <p>For more
105
104
  * information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/faceting.html">Getting and Using Facet Information</a>
106
105
  * in the <i>Amazon CloudSearch Developer Guide</i>.</p>
106
+ * @public
107
107
  */
108
108
  facet?: string;
109
109
  /**
110
- * @public
111
110
  * <p>Specifies a structured query that filters the results of a search without affecting how the results are scored and sorted. You use <code>filterQuery</code> in conjunction with the <code>query</code> parameter to filter the documents that match the constraints specified in the <code>query</code> parameter. Specifying a filter controls only which matching documents are included in the results, it has no effect on how they are scored and sorted. The <code>filterQuery</code> parameter supports the full structured query syntax. </p>
112
111
  * <p>For more information about using filters, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/filtering-results.html">Filtering Matching Documents</a>
113
112
  * in the <i>Amazon CloudSearch Developer Guide</i>.</p>
113
+ * @public
114
114
  */
115
115
  filterQuery?: string;
116
116
  /**
117
- * @public
118
117
  * <p>Retrieves highlights for matches in the specified <code>text</code> or
119
118
  * <code>text-array</code> fields. Each specified field must be highlight enabled in the domain configuration. The fields and options are specified in JSON using the form <code>\{"FIELD":\{"OPTION":VALUE,"OPTION:"STRING"\},"FIELD":\{"OPTION":VALUE,"OPTION":"STRING"\}\}</code>.</p>
120
119
  * <p>You can specify the following highlight options:</p>
@@ -150,15 +149,15 @@ export interface SearchRequest {
150
149
  * "actors": \{\},
151
150
  * "title": \{"format": "text","max_phrases": 2,"pre_tag": "<b>","post_tag": "</b>"\}
152
151
  * \}</code></p>
152
+ * @public
153
153
  */
154
154
  highlight?: string;
155
155
  /**
156
- * @public
157
156
  * <p>Enables partial results to be returned if one or more index partitions are unavailable. When your search index is partitioned across multiple search instances, by default Amazon CloudSearch only returns results if every partition can be queried. This means that the failure of a single search instance can result in 5xx (internal server) errors. When you enable partial results, Amazon CloudSearch returns whatever results are available and includes the percentage of documents searched in the search results (percent-searched). This enables you to more gracefully degrade your users' search experience. For example, rather than displaying no results, you could display the partial results and a message indicating that the results might be incomplete due to a temporary system outage.</p>
157
+ * @public
158
158
  */
159
159
  partial?: boolean;
160
160
  /**
161
- * @public
162
161
  * <p>Specifies the search criteria for the request. How you specify the search
163
162
  * criteria depends on the query parser used for the request and the parser options
164
163
  * specified in the <code>queryOptions</code> parameter. By default,
@@ -166,10 +165,10 @@ export interface SearchRequest {
166
165
  * the <code>structured</code>, <code>lucene</code>, or <code>dismax</code> query parser,
167
166
  * you must also specify the <code>queryParser</code> parameter. </p>
168
167
  * <p>For more information about specifying search criteria, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching.html">Searching Your Data</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>
168
+ * @public
169
169
  */
170
170
  query: string | undefined;
171
171
  /**
172
- * @public
173
172
  * <p>Configures options for the query parser specified in the <code>queryParser</code> parameter. You specify the options in JSON using the following form <code>\{"OPTION1":"VALUE1","OPTION2":VALUE2"..."OPTIONN":"VALUEN"\}.</code></p>
174
173
  *
175
174
  * <p>The options you can configure vary according to which parser you use:</p>
@@ -225,10 +224,10 @@ export interface SearchRequest {
225
224
  * Set <code>tieBreaker</code> to 0 to disregard all but the highest scoring field (pure max): <code>"tieBreaker":0</code>. Set to 1 to sum the scores from all fields (pure sum): <code>"tieBreaker":1</code>. Valid values: 0.0 to 1.0. Default: 0.0. Valid for: <code>dismax</code>.
226
225
  * </li>
227
226
  * </ul>
227
+ * @public
228
228
  */
229
229
  queryOptions?: string;
230
230
  /**
231
- * @public
232
231
  * <p>Specifies which
233
232
  * query parser to use to process the request. If <code>queryParser</code> is not specified, Amazon CloudSearch
234
233
  * uses the <code>simple</code> query parser. </p>
@@ -268,25 +267,25 @@ export interface SearchRequest {
268
267
  * </li>
269
268
  *
270
269
  * </ul>
270
+ * @public
271
271
  */
272
272
  queryParser?: QueryParser;
273
273
  /**
274
- * @public
275
274
  * <p>Specifies the field and expression values to include in the response. Multiple fields or expressions are specified as a comma-separated list. By default, a search response includes all
276
275
  * return enabled fields (<code>_all_fields</code>).
277
276
  * To return only the document IDs for the matching documents,
278
277
  * specify <code>_no_fields</code>.
279
278
  * To retrieve the relevance score calculated for each document,
280
279
  * specify <code>_score</code>. </p>
280
+ * @public
281
281
  */
282
282
  return?: string;
283
283
  /**
284
- * @public
285
284
  * <p>Specifies the maximum number of search hits to include in the response. </p>
285
+ * @public
286
286
  */
287
287
  size?: number;
288
288
  /**
289
- * @public
290
289
  * <p>Specifies the fields or custom expressions to use to sort the search
291
290
  * results. Multiple fields or expressions are specified as a comma-separated list.
292
291
  * You must specify the sort direction (<code>asc</code> or
@@ -298,297 +297,298 @@ export interface SearchRequest {
298
297
  * desc</code>. You can also sort by document ID
299
298
  * (<code>_id asc</code>) and version (<code>_version desc</code>).</p>
300
299
  * <p>For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/sorting-results.html">Sorting Results</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>
300
+ * @public
301
301
  */
302
302
  sort?: string;
303
303
  /**
304
- * @public
305
304
  * <p>Specifies the offset of the first search hit you want to return. Note that the result set is zero-based; the first result is at index 0. You can specify either the <code>start</code> or <code>cursor</code> parameter in a request, they are mutually exclusive. </p>
306
305
  * <p>For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/paginating-results.html">Paginating Results</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>
306
+ * @public
307
307
  */
308
308
  start?: number;
309
309
  /**
310
- * @public
311
310
  * <p>Specifies one or more fields for which to get statistics information. Each specified field must be facet-enabled in the domain configuration. The fields are specified in JSON using the form:</p>
312
311
  * <code>\{"FIELD-A":\{\},"FIELD-B":\{\}\}</code>
313
312
  * <p>There are currently no options supported for statistics.</p>
313
+ * @public
314
314
  */
315
315
  stats?: string;
316
316
  }
317
317
  /**
318
- * @public
319
318
  * <p>A container for facet information. </p>
319
+ * @public
320
320
  */
321
321
  export interface Bucket {
322
322
  /**
323
- * @public
324
323
  * <p>The facet value being counted.</p>
324
+ * @public
325
325
  */
326
326
  value?: string;
327
327
  /**
328
- * @public
329
328
  * <p>The number of hits that contain the facet value in the specified facet field.</p>
329
+ * @public
330
330
  */
331
331
  count?: number;
332
332
  }
333
333
  /**
334
- * @public
335
334
  * <p>A container for the calculated facet values and counts.</p>
335
+ * @public
336
336
  */
337
337
  export interface BucketInfo {
338
338
  /**
339
- * @public
340
339
  * <p>A list of the calculated facet values and counts.</p>
340
+ * @public
341
341
  */
342
342
  buckets?: Bucket[];
343
343
  }
344
344
  /**
345
- * @public
346
345
  * <p>Information about a document that matches the search request.</p>
346
+ * @public
347
347
  */
348
348
  export interface Hit {
349
349
  /**
350
- * @public
351
350
  * <p>The document ID of a document that matches the search request.</p>
351
+ * @public
352
352
  */
353
353
  id?: string;
354
354
  /**
355
- * @public
356
355
  * <p>The fields returned from a document that matches the search request.</p>
356
+ * @public
357
357
  */
358
358
  fields?: Record<string, string[]>;
359
359
  /**
360
- * @public
361
360
  * <p>The expressions returned from a document that matches the search request.</p>
361
+ * @public
362
362
  */
363
363
  exprs?: Record<string, string>;
364
364
  /**
365
- * @public
366
365
  * <p>The highlights returned from a document that matches the search request.</p>
366
+ * @public
367
367
  */
368
368
  highlights?: Record<string, string>;
369
369
  }
370
370
  /**
371
- * @public
372
371
  * <p>The collection of documents that match the search request.</p>
372
+ * @public
373
373
  */
374
374
  export interface Hits {
375
375
  /**
376
- * @public
377
376
  * <p>The total number of documents that match the search request.</p>
377
+ * @public
378
378
  */
379
379
  found?: number;
380
380
  /**
381
- * @public
382
381
  * <p>The index of the first matching document.</p>
382
+ * @public
383
383
  */
384
384
  start?: number;
385
385
  /**
386
- * @public
387
386
  * <p>A cursor that can be used to retrieve the next set of matching documents when you want to page through a large result set.</p>
387
+ * @public
388
388
  */
389
389
  cursor?: string;
390
390
  /**
391
- * @public
392
391
  * <p>A document that matches the search request.</p>
392
+ * @public
393
393
  */
394
394
  hit?: Hit[];
395
395
  }
396
396
  /**
397
- * @public
398
397
  * <p>The statistics for a field calculated in the request.</p>
398
+ * @public
399
399
  */
400
400
  export interface FieldStats {
401
401
  /**
402
- * @public
403
402
  * <p>The minimum value found in the specified field in the result set.</p>
404
403
  * <p>If the field is numeric (<code>int</code>, <code>int-array</code>, <code>double</code>, or <code>double-array</code>), <code>min</code> is the string representation of a double-precision 64-bit floating point value. If the field is <code>date</code> or <code>date-array</code>, <code>min</code> is the string representation of a date with the format specified in <a href="http://tools.ietf.org/html/rfc3339">IETF RFC3339</a>: yyyy-mm-ddTHH:mm:ss.SSSZ.</p>
404
+ * @public
405
405
  */
406
406
  min?: string;
407
407
  /**
408
- * @public
409
408
  * <p>The maximum value found in the specified field in the result set.</p>
410
409
  * <p>If the field is numeric (<code>int</code>, <code>int-array</code>, <code>double</code>, or <code>double-array</code>), <code>max</code> is the string representation of a double-precision 64-bit floating point value. If the field is <code>date</code> or <code>date-array</code>, <code>max</code> is the string representation of a date with the format specified in <a href="http://tools.ietf.org/html/rfc3339">IETF RFC3339</a>: yyyy-mm-ddTHH:mm:ss.SSSZ.</p>
410
+ * @public
411
411
  */
412
412
  max?: string;
413
413
  /**
414
- * @public
415
414
  * <p>The number of documents that contain a value in the specified field in the result set.</p>
415
+ * @public
416
416
  */
417
417
  count?: number;
418
418
  /**
419
- * @public
420
419
  * <p>The number of documents that do not contain a value in the specified field in the result set.</p>
420
+ * @public
421
421
  */
422
422
  missing?: number;
423
423
  /**
424
- * @public
425
424
  * <p>The sum of the field values across the documents in the result set. <code>null</code> for date fields.</p>
425
+ * @public
426
426
  */
427
427
  sum?: number;
428
428
  /**
429
- * @public
430
429
  * <p>The sum of all field values in the result set squared.</p>
430
+ * @public
431
431
  */
432
432
  sumOfSquares?: number;
433
433
  /**
434
- * @public
435
434
  * <p>The average of the values found in the specified field in the result set.</p>
436
435
  * <p>If the field is numeric (<code>int</code>, <code>int-array</code>, <code>double</code>, or <code>double-array</code>), <code>mean</code> is the string representation of a double-precision 64-bit floating point value. If the field is <code>date</code> or <code>date-array</code>, <code>mean</code> is the string representation of a date with the format specified in <a href="http://tools.ietf.org/html/rfc3339">IETF RFC3339</a>: yyyy-mm-ddTHH:mm:ss.SSSZ.</p>
436
+ * @public
437
437
  */
438
438
  mean?: string;
439
439
  /**
440
- * @public
441
440
  * <p>The standard deviation of the values in the specified field in the result set.</p>
441
+ * @public
442
442
  */
443
443
  stddev?: number;
444
444
  }
445
445
  /**
446
- * @public
447
446
  * <p>Contains the resource id (<code>rid</code>) and the time it took to process the request (<code>timems</code>).</p>
447
+ * @public
448
448
  */
449
449
  export interface SearchStatus {
450
450
  /**
451
- * @public
452
451
  * <p>How long it took to process the request, in milliseconds.</p>
452
+ * @public
453
453
  */
454
454
  timems?: number;
455
455
  /**
456
- * @public
457
456
  * <p>The encrypted resource ID for the request.</p>
457
+ * @public
458
458
  */
459
459
  rid?: string;
460
460
  }
461
461
  /**
462
- * @public
463
462
  * <p>The result of a <code>Search</code> request. Contains the documents that match the specified search criteria and any requested fields, highlights, and facet information.</p>
463
+ * @public
464
464
  */
465
465
  export interface SearchResponse {
466
466
  /**
467
- * @public
468
467
  * <p>The status information returned for the search request.</p>
468
+ * @public
469
469
  */
470
470
  status?: SearchStatus;
471
471
  /**
472
- * @public
473
472
  * <p>The documents that match the search criteria.</p>
473
+ * @public
474
474
  */
475
475
  hits?: Hits;
476
476
  /**
477
- * @public
478
477
  * <p>The requested facet information.</p>
478
+ * @public
479
479
  */
480
480
  facets?: Record<string, BucketInfo>;
481
481
  /**
482
- * @public
483
482
  * <p>The requested field statistics information.</p>
483
+ * @public
484
484
  */
485
485
  stats?: Record<string, FieldStats>;
486
486
  }
487
487
  /**
488
- * @public
489
488
  * <p>Container for the parameters to the <code>Suggest</code> request.</p>
489
+ * @public
490
490
  */
491
491
  export interface SuggestRequest {
492
492
  /**
493
- * @public
494
493
  * <p>Specifies the string for which you want to get suggestions.</p>
494
+ * @public
495
495
  */
496
496
  query: string | undefined;
497
497
  /**
498
- * @public
499
498
  * <p>Specifies the name of the suggester to use to find suggested matches.</p>
499
+ * @public
500
500
  */
501
501
  suggester: string | undefined;
502
502
  /**
503
- * @public
504
503
  * <p>Specifies the maximum number of suggestions to return. </p>
504
+ * @public
505
505
  */
506
506
  size?: number;
507
507
  }
508
508
  /**
509
- * @public
510
509
  * <p>Contains the resource id (<code>rid</code>) and the time it took to process the request (<code>timems</code>).</p>
510
+ * @public
511
511
  */
512
512
  export interface SuggestStatus {
513
513
  /**
514
- * @public
515
514
  * <p>How long it took to process the request, in milliseconds.</p>
515
+ * @public
516
516
  */
517
517
  timems?: number;
518
518
  /**
519
- * @public
520
519
  * <p>The encrypted resource ID for the request.</p>
520
+ * @public
521
521
  */
522
522
  rid?: string;
523
523
  }
524
524
  /**
525
- * @public
526
525
  * <p>An autocomplete suggestion that matches the query string specified in a <code>SuggestRequest</code>. </p>
526
+ * @public
527
527
  */
528
528
  export interface SuggestionMatch {
529
529
  /**
530
- * @public
531
530
  * <p>The string that matches the query string specified in the <code>SuggestRequest</code>. </p>
531
+ * @public
532
532
  */
533
533
  suggestion?: string;
534
534
  /**
535
- * @public
536
535
  * <p>The relevance score of a suggested match.</p>
536
+ * @public
537
537
  */
538
538
  score?: number;
539
539
  /**
540
- * @public
541
540
  * <p>The document ID of the suggested document.</p>
541
+ * @public
542
542
  */
543
543
  id?: string;
544
544
  }
545
545
  /**
546
- * @public
547
546
  * <p>Container for the suggestion information returned in a <code>SuggestResponse</code>.</p>
547
+ * @public
548
548
  */
549
549
  export interface SuggestModel {
550
550
  /**
551
- * @public
552
551
  * <p>The query string specified in the suggest request.</p>
552
+ * @public
553
553
  */
554
554
  query?: string;
555
555
  /**
556
- * @public
557
556
  * <p>The number of documents that were found to match the query string.</p>
557
+ * @public
558
558
  */
559
559
  found?: number;
560
560
  /**
561
- * @public
562
561
  * <p>The documents that match the query string.</p>
562
+ * @public
563
563
  */
564
564
  suggestions?: SuggestionMatch[];
565
565
  }
566
566
  /**
567
- * @public
568
567
  * <p>Contains the response to a <code>Suggest</code> request.</p>
568
+ * @public
569
569
  */
570
570
  export interface SuggestResponse {
571
571
  /**
572
- * @public
573
572
  * <p>The status of a <code>SuggestRequest</code>. Contains the resource ID (<code>rid</code>) and how long it took to process the request (<code>timems</code>).</p>
573
+ * @public
574
574
  */
575
575
  status?: SuggestStatus;
576
576
  /**
577
- * @public
578
577
  * <p>Container for the matching search suggestion information.</p>
578
+ * @public
579
579
  */
580
580
  suggest?: SuggestModel;
581
581
  }
582
582
  /**
583
- * @public
584
583
  * <p>Information about any problems encountered while processing an upload request.</p>
584
+ * @public
585
585
  */
586
586
  export declare class DocumentServiceException extends __BaseException {
587
587
  readonly name: "DocumentServiceException";
588
588
  readonly $fault: "client";
589
589
  /**
590
- * @public
591
590
  * <p>The return status of a document upload request, <code>error</code> or <code>success</code>.</p>
591
+ * @public
592
592
  */
593
593
  status?: string;
594
594
  /**
@@ -609,59 +609,59 @@ export declare const ContentType: {
609
609
  */
610
610
  export type ContentType = (typeof ContentType)[keyof typeof ContentType];
611
611
  /**
612
- * @public
613
612
  * <p>Container for the parameters to the <code>UploadDocuments</code> request.</p>
613
+ * @public
614
614
  */
615
615
  export interface UploadDocumentsRequest {
616
616
  /**
617
- * @public
618
617
  * <p>A batch of documents formatted in JSON or HTML.</p>
618
+ * @public
619
619
  */
620
620
  documents: StreamingBlobTypes | undefined;
621
621
  /**
622
- * @public
623
622
  * <p>The format of the batch you are uploading. Amazon CloudSearch supports two document batch formats:</p>
624
623
  * <ul>
625
624
  * <li>application/json</li>
626
625
  * <li>application/xml</li>
627
626
  * </ul>
627
+ * @public
628
628
  */
629
629
  contentType: ContentType | undefined;
630
630
  }
631
631
  /**
632
- * @public
633
632
  * <p>A warning returned by the document service when an issue is discovered while processing an upload request.</p>
633
+ * @public
634
634
  */
635
635
  export interface DocumentServiceWarning {
636
636
  /**
637
- * @public
638
637
  * <p>The description for a warning returned by the document service.</p>
638
+ * @public
639
639
  */
640
640
  message?: string;
641
641
  }
642
642
  /**
643
- * @public
644
643
  * <p>Contains the response to an <code>UploadDocuments</code> request.</p>
644
+ * @public
645
645
  */
646
646
  export interface UploadDocumentsResponse {
647
647
  /**
648
- * @public
649
648
  * <p>The status of an <code>UploadDocumentsRequest</code>.</p>
649
+ * @public
650
650
  */
651
651
  status?: string;
652
652
  /**
653
- * @public
654
653
  * <p>The number of documents that were added to the search domain.</p>
654
+ * @public
655
655
  */
656
656
  adds?: number;
657
657
  /**
658
- * @public
659
658
  * <p>The number of documents that were deleted from the search domain.</p>
659
+ * @public
660
660
  */
661
661
  deletes?: number;
662
662
  /**
663
- * @public
664
663
  * <p>Any warnings returned by the document service about the documents being uploaded.</p>
664
+ * @public
665
665
  */
666
666
  warnings?: DocumentServiceWarning[];
667
667
  }
@@ -17,6 +17,13 @@ declare const SearchCommand_base: {
17
17
  ServiceInputTypes,
18
18
  ServiceOutputTypes
19
19
  >;
20
+ new (__0_0: SearchCommandInput): import("@smithy/smithy-client").CommandImpl<
21
+ SearchCommandInput,
22
+ SearchCommandOutput,
23
+ CloudSearchDomainClientResolvedConfig,
24
+ ServiceInputTypes,
25
+ ServiceOutputTypes
26
+ >;
20
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
21
28
  };
22
29
  export declare class SearchCommand extends SearchCommand_base {}
@@ -19,6 +19,13 @@ declare const SuggestCommand_base: {
19
19
  ServiceInputTypes,
20
20
  ServiceOutputTypes
21
21
  >;
22
+ new (__0_0: SuggestCommandInput): import("@smithy/smithy-client").CommandImpl<
23
+ SuggestCommandInput,
24
+ SuggestCommandOutput,
25
+ CloudSearchDomainClientResolvedConfig,
26
+ ServiceInputTypes,
27
+ ServiceOutputTypes
28
+ >;
22
29
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
23
30
  };
24
31
  export declare class SuggestCommand extends SuggestCommand_base {}
@@ -33,6 +33,15 @@ declare const UploadDocumentsCommand_base: {
33
33
  ServiceInputTypes,
34
34
  ServiceOutputTypes
35
35
  >;
36
+ new (
37
+ __0_0: UploadDocumentsCommandInput
38
+ ): import("@smithy/smithy-client").CommandImpl<
39
+ UploadDocumentsCommandInput,
40
+ UploadDocumentsCommandOutput,
41
+ CloudSearchDomainClientResolvedConfig,
42
+ ServiceInputTypes,
43
+ ServiceOutputTypes
44
+ >;
36
45
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
37
46
  };
38
47
  export declare class UploadDocumentsCommand extends UploadDocumentsCommand_base {}
@@ -5,5 +5,4 @@ export { RuntimeExtension } from "./runtimeExtensions";
5
5
  export { CloudSearchDomainExtensionConfiguration } from "./extensionConfiguration";
6
6
  export * from "./commands";
7
7
  export * from "./models";
8
- import "@aws-sdk/util-endpoints";
9
8
  export { CloudSearchDomainServiceException } from "./models/CloudSearchDomainServiceException";
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-cloudsearch-domain",
3
3
  "description": "AWS SDK for JavaScript Cloudsearch Domain Client for Node.js, Browser and React Native",
4
- "version": "3.533.0",
4
+ "version": "3.540.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-cloudsearch-domain",
@@ -20,47 +20,47 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.533.0",
24
- "@aws-sdk/core": "3.533.0",
25
- "@aws-sdk/credential-provider-node": "3.533.0",
26
- "@aws-sdk/middleware-host-header": "3.533.0",
27
- "@aws-sdk/middleware-logger": "3.533.0",
28
- "@aws-sdk/middleware-recursion-detection": "3.533.0",
29
- "@aws-sdk/middleware-user-agent": "3.533.0",
30
- "@aws-sdk/region-config-resolver": "3.533.0",
31
- "@aws-sdk/types": "3.533.0",
32
- "@aws-sdk/util-endpoints": "3.533.0",
33
- "@aws-sdk/util-user-agent-browser": "3.533.0",
34
- "@aws-sdk/util-user-agent-node": "3.533.0",
35
- "@smithy/config-resolver": "^2.1.5",
36
- "@smithy/core": "^1.3.8",
37
- "@smithy/fetch-http-handler": "^2.4.5",
38
- "@smithy/hash-node": "^2.1.4",
39
- "@smithy/invalid-dependency": "^2.1.4",
40
- "@smithy/middleware-content-length": "^2.1.4",
41
- "@smithy/middleware-endpoint": "^2.4.6",
42
- "@smithy/middleware-retry": "^2.1.7",
43
- "@smithy/middleware-serde": "^2.2.1",
44
- "@smithy/middleware-stack": "^2.1.4",
45
- "@smithy/node-config-provider": "^2.2.5",
46
- "@smithy/node-http-handler": "^2.4.3",
47
- "@smithy/protocol-http": "^3.2.2",
48
- "@smithy/smithy-client": "^2.4.5",
49
- "@smithy/types": "^2.11.0",
50
- "@smithy/url-parser": "^2.1.4",
51
- "@smithy/util-base64": "^2.2.1",
52
- "@smithy/util-body-length-browser": "^2.1.1",
53
- "@smithy/util-body-length-node": "^2.2.2",
54
- "@smithy/util-defaults-mode-browser": "^2.1.7",
55
- "@smithy/util-defaults-mode-node": "^2.2.7",
56
- "@smithy/util-endpoints": "^1.1.5",
57
- "@smithy/util-middleware": "^2.1.4",
58
- "@smithy/util-retry": "^2.1.4",
59
- "@smithy/util-utf8": "^2.2.0",
60
- "tslib": "^2.5.0"
23
+ "@aws-sdk/client-sts": "3.540.0",
24
+ "@aws-sdk/core": "3.535.0",
25
+ "@aws-sdk/credential-provider-node": "3.540.0",
26
+ "@aws-sdk/middleware-host-header": "3.535.0",
27
+ "@aws-sdk/middleware-logger": "3.535.0",
28
+ "@aws-sdk/middleware-recursion-detection": "3.535.0",
29
+ "@aws-sdk/middleware-user-agent": "3.540.0",
30
+ "@aws-sdk/region-config-resolver": "3.535.0",
31
+ "@aws-sdk/types": "3.535.0",
32
+ "@aws-sdk/util-endpoints": "3.540.0",
33
+ "@aws-sdk/util-user-agent-browser": "3.535.0",
34
+ "@aws-sdk/util-user-agent-node": "3.535.0",
35
+ "@smithy/config-resolver": "^2.2.0",
36
+ "@smithy/core": "^1.4.0",
37
+ "@smithy/fetch-http-handler": "^2.5.0",
38
+ "@smithy/hash-node": "^2.2.0",
39
+ "@smithy/invalid-dependency": "^2.2.0",
40
+ "@smithy/middleware-content-length": "^2.2.0",
41
+ "@smithy/middleware-endpoint": "^2.5.0",
42
+ "@smithy/middleware-retry": "^2.2.0",
43
+ "@smithy/middleware-serde": "^2.3.0",
44
+ "@smithy/middleware-stack": "^2.2.0",
45
+ "@smithy/node-config-provider": "^2.3.0",
46
+ "@smithy/node-http-handler": "^2.5.0",
47
+ "@smithy/protocol-http": "^3.3.0",
48
+ "@smithy/smithy-client": "^2.5.0",
49
+ "@smithy/types": "^2.12.0",
50
+ "@smithy/url-parser": "^2.2.0",
51
+ "@smithy/util-base64": "^2.3.0",
52
+ "@smithy/util-body-length-browser": "^2.2.0",
53
+ "@smithy/util-body-length-node": "^2.3.0",
54
+ "@smithy/util-defaults-mode-browser": "^2.2.0",
55
+ "@smithy/util-defaults-mode-node": "^2.3.0",
56
+ "@smithy/util-endpoints": "^1.2.0",
57
+ "@smithy/util-middleware": "^2.2.0",
58
+ "@smithy/util-retry": "^2.2.0",
59
+ "@smithy/util-utf8": "^2.3.0",
60
+ "tslib": "^2.6.2"
61
61
  },
62
62
  "devDependencies": {
63
- "@smithy/service-client-documentation-generator": "^2.1.1",
63
+ "@smithy/service-client-documentation-generator": "^2.2.0",
64
64
  "@tsconfig/node14": "1.0.3",
65
65
  "@types/node": "^14.14.31",
66
66
  "concurrently": "7.0.0",