@aws-sdk/client-cloudsearch-domain 3.296.0 → 3.297.0

package/dist-types/CloudSearchDomain.d.ts

@@ -4,6 +4,7 @@ import { SearchCommandInput, SearchCommandOutput } from "./commands/SearchComman
 import { SuggestCommandInput, SuggestCommandOutput } from "./commands/SuggestCommand";
 import { UploadDocumentsCommandInput, UploadDocumentsCommandOutput } from "./commands/UploadDocumentsCommand";
 /**
+ * @public
  * <p>You use the AmazonCloudSearch2013 API to upload documents to a search domain and search those documents. </p>
  *
  *          <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>
@@ -11,6 +12,7 @@ import { UploadDocumentsCommandInput, UploadDocumentsCommandOutput } from "./com
  */
 export declare class CloudSearchDomain extends CloudSearchDomainClient {
     /**
+     * @public
      * <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>
      *       <ul>
      *          <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>
@@ -25,6 +27,7 @@ export declare class CloudSearchDomain extends CloudSearchDomainClient {
     search(args: SearchCommandInput, cb: (err: any, data?: SearchCommandOutput) => void): void;
     search(args: SearchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchCommandOutput) => void): void;
     /**
+     * @public
      * <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>
      *       <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>
      *
@@ -34,6 +37,7 @@ export declare class CloudSearchDomain extends CloudSearchDomainClient {
     suggest(args: SuggestCommandInput, cb: (err: any, data?: SuggestCommandOutput) => void): void;
     suggest(args: SuggestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SuggestCommandOutput) => void): void;
     /**
+     * @public
      * <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>
      *       <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>
      *       <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>.

package/dist-types/CloudSearchDomainClient.d.ts

@@ -11,15 +11,24 @@ import { SearchCommandInput, SearchCommandOutput } from "./commands/SearchComman
 import { SuggestCommandInput, SuggestCommandOutput } from "./commands/SuggestCommand";
 import { UploadDocumentsCommandInput, UploadDocumentsCommandOutput } from "./commands/UploadDocumentsCommand";
 import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
+/**
+ * @public
+ */
 export type ServiceInputTypes = SearchCommandInput | SuggestCommandInput | UploadDocumentsCommandInput;
+/**
+ * @public
+ */
 export type ServiceOutputTypes = SearchCommandOutput | SuggestCommandOutput | UploadDocumentsCommandOutput;
+/**
+ * @public
+ */
 export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
     /**
      * The HTTP handler to use. Fetch in browser and Https in Nodejs.
      */
     requestHandler?: __HttpHandler;
     /**
-     * A constructor for a class implementing the {@link __Checksum} interface
+     * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
      * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
      * @internal
      */
@@ -109,23 +118,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
      */
     logger?: __Logger;
     /**
-     * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
+     * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
      */
     defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
 }
+/**
+ * @public
+ */
 type CloudSearchDomainClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
 /**
- * The configuration interface of CloudSearchDomainClient class constructor that set the region, credentials and other options.
+ * @public
+ *
+ *  The configuration interface of CloudSearchDomainClient class constructor that set the region, credentials and other options.
  */
 export interface CloudSearchDomainClientConfig extends CloudSearchDomainClientConfigType {
 }
+/**
+ * @public
+ */
 type CloudSearchDomainClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
 /**
- * The resolved configuration interface of CloudSearchDomainClient class. This is resolved and normalized from the {@link CloudSearchDomainClientConfig | constructor configuration interface}.
+ * @public
+ *
+ *  The resolved configuration interface of CloudSearchDomainClient class. This is resolved and normalized from the {@link CloudSearchDomainClientConfig | constructor configuration interface}.
  */
 export interface CloudSearchDomainClientResolvedConfig extends CloudSearchDomainClientResolvedConfigType {
 }
 /**
+ * @public
  * <p>You use the AmazonCloudSearch2013 API to upload documents to a search domain and search those documents. </p>
  *
  *          <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>

package/dist-types/commands/SearchCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CloudSearchDomainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudSearchDomainClient";
 import { SearchRequest, SearchResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link SearchCommand}.
  */
 export interface SearchCommandInput extends SearchRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link SearchCommand}.
  */
 export interface SearchCommandOutput extends SearchResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <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>
  *       <ul>
  *          <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>
@@ -33,6 +38,8 @@ export interface SearchCommandOutput extends SearchResponse, __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param SearchCommandInput - {@link SearchCommandInput}
+ * @returns {@link SearchCommandOutput}
  * @see {@link SearchCommandInput} for command's `input` shape.
  * @see {@link SearchCommandOutput} for command's `response` shape.
  * @see {@link CloudSearchDomainClientResolvedConfig | config} for CloudSearchDomainClient's `config` shape.
@@ -45,11 +52,20 @@ export interface SearchCommandOutput extends SearchResponse, __MetadataBearer {
 export declare class SearchCommand extends $Command<SearchCommandInput, SearchCommandOutput, CloudSearchDomainClientResolvedConfig> {
     readonly input: SearchCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: SearchCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudSearchDomainClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SearchCommandInput, SearchCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/SuggestCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CloudSearchDomainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudSearchDomainClient";
 import { SuggestRequest, SuggestResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link SuggestCommand}.
  */
 export interface SuggestCommandInput extends SuggestRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link SuggestCommand}.
  */
 export interface SuggestCommandOutput extends SuggestResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <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>
  *       <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>
  *
@@ -28,6 +33,8 @@ export interface SuggestCommandOutput extends SuggestResponse, __MetadataBearer
  * const response = await client.send(command);
  * ```
  *
+ * @param SuggestCommandInput - {@link SuggestCommandInput}
+ * @returns {@link SuggestCommandOutput}
  * @see {@link SuggestCommandInput} for command's `input` shape.
  * @see {@link SuggestCommandOutput} for command's `response` shape.
  * @see {@link CloudSearchDomainClientResolvedConfig | config} for CloudSearchDomainClient's `config` shape.
@@ -40,11 +47,20 @@ export interface SuggestCommandOutput extends SuggestResponse, __MetadataBearer
 export declare class SuggestCommand extends $Command<SuggestCommandInput, SuggestCommandOutput, CloudSearchDomainClientResolvedConfig> {
     readonly input: SuggestCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: SuggestCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudSearchDomainClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SuggestCommandInput, SuggestCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/UploadDocumentsCommand.d.ts

@@ -5,9 +5,11 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CloudSearchDomainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudSearchDomainClient";
 import { UploadDocumentsRequest, UploadDocumentsResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UploadDocumentsCommand}.
  */
-type UploadDocumentsCommandInputType = Omit<UploadDocumentsRequest, "documents"> & {
+export type UploadDocumentsCommandInputType = Omit<UploadDocumentsRequest, "documents"> & {
     /**
      * For *`UploadDocumentsRequest["documents"]`*, see {@link UploadDocumentsRequest.documents}.
      */
@@ -19,11 +21,14 @@ type UploadDocumentsCommandInputType = Omit<UploadDocumentsRequest, "documents">
 export interface UploadDocumentsCommandInput extends UploadDocumentsCommandInputType {
 }
 /**
+ * @public
+ *
  * The output of {@link UploadDocumentsCommand}.
  */
 export interface UploadDocumentsCommandOutput extends UploadDocumentsResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <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>
  *       <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>
  *       <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>.
@@ -38,6 +43,8 @@ export interface UploadDocumentsCommandOutput extends UploadDocumentsResponse, _
  * const response = await client.send(command);
  * ```
  *
+ * @param UploadDocumentsCommandInput - {@link UploadDocumentsCommandInput}
+ * @returns {@link UploadDocumentsCommandOutput}
  * @see {@link UploadDocumentsCommandInput} for command's `input` shape.
  * @see {@link UploadDocumentsCommandOutput} for command's `response` shape.
  * @see {@link CloudSearchDomainClientResolvedConfig | config} for CloudSearchDomainClient's `config` shape.
@@ -50,12 +57,20 @@ export interface UploadDocumentsCommandOutput extends UploadDocumentsResponse, _
 export declare class UploadDocumentsCommand extends $Command<UploadDocumentsCommandInput, UploadDocumentsCommandOutput, CloudSearchDomainClientResolvedConfig> {
     readonly input: UploadDocumentsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UploadDocumentsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudSearchDomainClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UploadDocumentsCommandInput, UploadDocumentsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }
-export {};

package/dist-types/models/CloudSearchDomainServiceException.d.ts

@@ -1,5 +1,7 @@
 import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
 /**
+ * @public
+ *
  * Base exception class for all service exceptions from CloudSearchDomain service.
  */
 export declare class CloudSearchDomainServiceException extends __ServiceException {

package/dist-types/models/models_0.d.ts

@@ -3,6 +3,7 @@ import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-cl
 import { Readable } from "stream";
 import { CloudSearchDomainServiceException as __BaseException } from "./CloudSearchDomainServiceException";
 /**
+ * @public
  * <p>Information about any problems encountered while processing a search request.</p>
  */
 export declare class SearchException extends __BaseException {
@@ -13,8 +14,12 @@ export declare class SearchException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<SearchException, __BaseException>);
 }
+/**
+ * @public
+ */
 export type QueryParser = "dismax" | "lucene" | "simple" | "structured";
 /**
+ * @public
  * <p>Container for the parameters to the <code>Search</code> request.</p>
  */
 export interface SearchRequest {
@@ -29,16 +34,16 @@ export interface SearchRequest {
     /**
      * <p>Defines one or more numeric expressions that can be used to sort results or specify search or filter
      *          criteria. You can also specify expressions as return fields. </p>
-     *       <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>
+     *       <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>
      *       <p><code>
-     *          {"expression1":"_score*rating", "expression2":"(1/rank)*year"}
+     *          \{"expression1":"_score*rating", "expression2":"(1/rank)*year"\}
      *       </code> </p>
      *       <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>
      *          in the <i>Amazon CloudSearch Developer Guide</i>.</p>
      */
     expr?: string;
     /**
-     * <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>
+     * <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>
      *          <p>You can specify the following faceting options:</p>
      *       <ul>
      *          <li>
@@ -71,18 +76,18 @@ export interface SearchRequest {
      *
      *       <p>To count particular buckets of values, use the <code>buckets</code> option. For example, the following request uses the <code>buckets</code> option to calculate and return facet counts by decade.</p>
      *       <p><code>
-     *          {"year":{"buckets":["[1970,1979]","[1980,1989]","[1990,1999]","[2000,2009]","[2010,}"]}}
+     *          \{"year":\{"buckets":["[1970,1979]","[1980,1989]","[1990,1999]","[2000,2009]","[2010,\}"]\}\}
      *       </code></p>
      *
      *          <p>To sort facets by facet count, use the <code>count</code> option. For example, the following request sets the <code>sort</code> option to <code>count</code> to sort the facet values by facet count, with the facet
      *             values that have the most matching documents listed first. Setting the <code>size</code> option to 3 returns only the top three facet values.</p>
      *          <p><code>
-     *             {"year":{"sort":"count","size":3}}
+     *             \{"year":\{"sort":"count","size":3\}\}
      *          </code></p>
      *
      *          <p>To sort the facets by value, use the <code>bucket</code> option. For example, the following  request sets the <code>sort</code> option to <code>bucket</code> to sort the facet values numerically by year, with earliest year listed first. </p>
      *          <p><code>
-     *             {"year":{"sort":"bucket"}}
+     *             \{"year":\{"sort":"bucket"\}\}
      *          </code></p>
      *       <p>For more
      *          information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/faceting.html">Getting and Using Facet Information</a>
@@ -97,7 +102,7 @@ export interface SearchRequest {
     filterQuery?: string;
     /**
      * <p>Retrieves highlights for matches in the specified <code>text</code> or
-     *          <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>
+     *          <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>
      *       <p>You can specify the following highlight options:</p>
      *          <ul>
      *             <li>
@@ -127,10 +132,10 @@ export interface SearchRequest {
      *          <p>If no highlight options are specified for a field, the returned field text is treated as HTML and the first match is
      *             highlighted with emphasis tags:  <code>&lt;em>search-term&lt;/em&gt;</code>.</p>
      *             <p>For example, the following request retrieves highlights for the <code>actors</code> and <code>title</code> fields.</p>
-     *                  <p> <code>{
-     *     "actors": {},
-     *     "title": {"format": "text","max_phrases": 2,"pre_tag": "<b>","post_tag": "</b>"}
-     *                     }</code></p>
+     *                  <p> <code>\{
+     *     "actors": \{\},
+     *     "title": \{"format": "text","max_phrases": 2,"pre_tag": "<b>","post_tag": "</b>"\}
+     *                     \}</code></p>
      */
     highlight?: string;
     /**
@@ -148,7 +153,7 @@ export interface SearchRequest {
      */
     query: string | undefined;
     /**
-     * <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>
+     * <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>
      *
      *       <p>The options you can configure vary according to which parser you use:</p>
      *       <ul>
@@ -281,12 +286,13 @@ export interface SearchRequest {
     start?: number;
     /**
      * <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>
-     *       <code>{"FIELD-A":{},"FIELD-B":{}}</code>
+     *       <code>\{"FIELD-A":\{\},"FIELD-B":\{\}\}</code>
      *       <p>There are currently no options supported for statistics.</p>
      */
     stats?: string;
 }
 /**
+ * @public
  * <p>A container for facet information. </p>
  */
 export interface Bucket {
@@ -300,6 +306,7 @@ export interface Bucket {
     count?: number;
 }
 /**
+ * @public
  * <p>A container for the calculated facet values and counts.</p>
  */
 export interface BucketInfo {
@@ -309,6 +316,7 @@ export interface BucketInfo {
     buckets?: Bucket[];
 }
 /**
+ * @public
  * <p>Information about a document that matches the search request.</p>
  */
 export interface Hit {
@@ -330,6 +338,7 @@ export interface Hit {
     highlights?: Record<string, string>;
 }
 /**
+ * @public
  * <p>The collection of documents that match the search request.</p>
  */
 export interface Hits {
@@ -351,6 +360,7 @@ export interface Hits {
     hit?: Hit[];
 }
 /**
+ * @public
  * <p>The statistics for a field calculated in the request.</p>
  */
 export interface FieldStats {
@@ -391,6 +401,7 @@ export interface FieldStats {
     stddev?: number;
 }
 /**
+ * @public
  * <p>Contains the resource id (<code>rid</code>) and the time it took to process the request (<code>timems</code>).</p>
  */
 export interface SearchStatus {
@@ -404,6 +415,7 @@ export interface SearchStatus {
     rid?: string;
 }
 /**
+ * @public
  * <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>
  */
 export interface SearchResponse {
@@ -425,6 +437,7 @@ export interface SearchResponse {
     stats?: Record<string, FieldStats>;
 }
 /**
+ * @public
  * <p>Container for the parameters to the <code>Suggest</code> request.</p>
  */
 export interface SuggestRequest {
@@ -442,6 +455,7 @@ export interface SuggestRequest {
     size?: number;
 }
 /**
+ * @public
  * <p>Contains the resource id (<code>rid</code>) and the time it took to process the request (<code>timems</code>).</p>
  */
 export interface SuggestStatus {
@@ -455,6 +469,7 @@ export interface SuggestStatus {
     rid?: string;
 }
 /**
+ * @public
  * <p>An autocomplete suggestion that matches the query string specified in a <code>SuggestRequest</code>. </p>
  */
 export interface SuggestionMatch {
@@ -472,6 +487,7 @@ export interface SuggestionMatch {
     id?: string;
 }
 /**
+ * @public
  * <p>Container for the suggestion information returned in a <code>SuggestResponse</code>.</p>
  */
 export interface SuggestModel {
@@ -489,6 +505,7 @@ export interface SuggestModel {
     suggestions?: SuggestionMatch[];
 }
 /**
+ * @public
  * <p>Contains the response to a <code>Suggest</code> request.</p>
  */
 export interface SuggestResponse {
@@ -502,6 +519,7 @@ export interface SuggestResponse {
     suggest?: SuggestModel;
 }
 /**
+ * @public
  * <p>Information about any problems encountered while processing an upload request.</p>
  */
 export declare class DocumentServiceException extends __BaseException {
@@ -516,8 +534,12 @@ export declare class DocumentServiceException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<DocumentServiceException, __BaseException>);
 }
+/**
+ * @public
+ */
 export type ContentType = "application/json" | "application/xml";
 /**
+ * @public
  * <p>Container for the parameters to the <code>UploadDocuments</code> request.</p>
  */
 export interface UploadDocumentsRequest {
@@ -535,6 +557,7 @@ export interface UploadDocumentsRequest {
     contentType: ContentType | string | undefined;
 }
 /**
+ * @public
  * <p>A warning returned by the document service when an issue is discovered while processing an upload request.</p>
  */
 export interface DocumentServiceWarning {
@@ -544,6 +567,7 @@ export interface DocumentServiceWarning {
     message?: string;
 }
 /**
+ * @public
  * <p>Contains the response to an <code>UploadDocuments</code> request.</p>
  */
 export interface UploadDocumentsResponse {

package/dist-types/ts3.4/commands/UploadDocumentsCommand.d.ts

@@ -15,7 +15,7 @@ import {
   UploadDocumentsRequest,
   UploadDocumentsResponse,
 } from "../models/models_0";
-type UploadDocumentsCommandInputType = Pick<
+export type UploadDocumentsCommandInputType = Pick<
   UploadDocumentsRequest,
   Exclude<keyof UploadDocumentsRequest, "documents">
 > & {
@@ -42,4 +42,3 @@ export declare class UploadDocumentsCommand extends $Command<
   private serialize;
   private deserialize;
 }
-export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-cloudsearch-domain",
   "description": "AWS SDK for JavaScript Cloudsearch Domain Client for Node.js, Browser and React Native",
-  "version": "3.296.0",
+  "version": "3.297.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,9 +20,9 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.296.0",
+    "@aws-sdk/client-sts": "3.297.0",
     "@aws-sdk/config-resolver": "3.296.0",
-    "@aws-sdk/credential-provider-node": "3.296.0",
+    "@aws-sdk/credential-provider-node": "3.297.0",
     "@aws-sdk/fetch-http-handler": "3.296.0",
     "@aws-sdk/hash-node": "3.296.0",
     "@aws-sdk/invalid-dependency": "3.296.0",