@aws-sdk/client-cloudsearch 3.296.0 → 3.298.0

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CloudSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudSearchClient";
 import { DescribeServiceAccessPoliciesRequest, DescribeServiceAccessPoliciesResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link DescribeServiceAccessPoliciesCommand}.
  */
 export interface DescribeServiceAccessPoliciesCommandInput extends DescribeServiceAccessPoliciesRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link DescribeServiceAccessPoliciesCommand}.
  */
 export interface DescribeServiceAccessPoliciesCommandOutput extends DescribeServiceAccessPoliciesResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>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 <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information,
  *       see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html" target="_blank">Configuring Access for a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>
  * @example
@@ -26,6 +31,8 @@ export interface DescribeServiceAccessPoliciesCommandOutput extends DescribeServ
  * const response = await client.send(command);
  * ```
  *
+ * @param DescribeServiceAccessPoliciesCommandInput - {@link DescribeServiceAccessPoliciesCommandInput}
+ * @returns {@link DescribeServiceAccessPoliciesCommandOutput}
  * @see {@link DescribeServiceAccessPoliciesCommandInput} for command's `input` shape.
  * @see {@link DescribeServiceAccessPoliciesCommandOutput} for command's `response` shape.
  * @see {@link CloudSearchClientResolvedConfig | config} for CloudSearchClient's `config` shape.
@@ -45,11 +52,20 @@ export interface DescribeServiceAccessPoliciesCommandOutput extends DescribeServ
 export declare class DescribeServiceAccessPoliciesCommand extends $Command<DescribeServiceAccessPoliciesCommandInput, DescribeServiceAccessPoliciesCommandOutput, CloudSearchClientResolvedConfig> {
     readonly input: DescribeServiceAccessPoliciesCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DescribeServiceAccessPoliciesCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudSearchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeServiceAccessPoliciesCommandInput, DescribeServiceAccessPoliciesCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CloudSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudSearchClient";
 import { DescribeSuggestersRequest, DescribeSuggestersResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link DescribeSuggestersCommand}.
  */
 export interface DescribeSuggestersCommandInput extends DescribeSuggestersRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link DescribeSuggestersCommand}.
  */
 export interface DescribeSuggestersCommandOutput extends DescribeSuggestersResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>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 <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes.  For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html" target="_blank">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeSuggestersCommandOutput extends DescribeSuggestersRespo
  * const response = await client.send(command);
  * ```
  *
+ * @param DescribeSuggestersCommandInput - {@link DescribeSuggestersCommandInput}
+ * @returns {@link DescribeSuggestersCommandOutput}
  * @see {@link DescribeSuggestersCommandInput} for command's `input` shape.
  * @see {@link DescribeSuggestersCommandOutput} for command's `response` shape.
  * @see {@link CloudSearchClientResolvedConfig | config} for CloudSearchClient's `config` shape.
@@ -44,11 +51,20 @@ export interface DescribeSuggestersCommandOutput extends DescribeSuggestersRespo
 export declare class DescribeSuggestersCommand extends $Command<DescribeSuggestersCommandInput, DescribeSuggestersCommandOutput, CloudSearchClientResolvedConfig> {
     readonly input: DescribeSuggestersCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DescribeSuggestersCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudSearchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeSuggestersCommandInput, DescribeSuggestersCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CloudSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudSearchClient";
 import { IndexDocumentsRequest, IndexDocumentsResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link IndexDocumentsCommand}.
  */
 export interface IndexDocumentsCommandInput extends IndexDocumentsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link IndexDocumentsCommand}.
  */
 export interface IndexDocumentsCommandOutput extends IndexDocumentsResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Tells the search domain to start indexing its documents using the latest indexing options. This operation must be invoked to activate options whose <a>OptionStatus</a> is  <code>RequiresIndexDocuments</code>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface IndexDocumentsCommandOutput extends IndexDocumentsResponse, __M
  * const response = await client.send(command);
  * ```
  *
+ * @param IndexDocumentsCommandInput - {@link IndexDocumentsCommandInput}
+ * @returns {@link IndexDocumentsCommandOutput}
  * @see {@link IndexDocumentsCommandInput} for command's `input` shape.
  * @see {@link IndexDocumentsCommandOutput} for command's `response` shape.
  * @see {@link CloudSearchClientResolvedConfig | config} for CloudSearchClient's `config` shape.
@@ -47,11 +54,20 @@ export interface IndexDocumentsCommandOutput extends IndexDocumentsResponse, __M
 export declare class IndexDocumentsCommand extends $Command<IndexDocumentsCommandInput, IndexDocumentsCommandOutput, CloudSearchClientResolvedConfig> {
     readonly input: IndexDocumentsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: IndexDocumentsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudSearchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<IndexDocumentsCommandInput, IndexDocumentsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CloudSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudSearchClient";
 import { ListDomainNamesResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link ListDomainNamesCommand}.
  */
 export interface ListDomainNamesCommandInput {
 }
 /**
+ * @public
+ *
  * The output of {@link ListDomainNamesCommand}.
  */
 export interface ListDomainNamesCommandOutput extends ListDomainNamesResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Lists all search domains owned by an account.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListDomainNamesCommandOutput extends ListDomainNamesResponse, _
  * const response = await client.send(command);
  * ```
  *
+ * @param ListDomainNamesCommandInput - {@link ListDomainNamesCommandInput}
+ * @returns {@link ListDomainNamesCommandOutput}
  * @see {@link ListDomainNamesCommandInput} for command's `input` shape.
  * @see {@link ListDomainNamesCommandOutput} for command's `response` shape.
  * @see {@link CloudSearchClientResolvedConfig | config} for CloudSearchClient's `config` shape.
@@ -37,11 +44,20 @@ export interface ListDomainNamesCommandOutput extends ListDomainNamesResponse, _
 export declare class ListDomainNamesCommand extends $Command<ListDomainNamesCommandInput, ListDomainNamesCommandOutput, CloudSearchClientResolvedConfig> {
     readonly input: ListDomainNamesCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListDomainNamesCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudSearchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListDomainNamesCommandInput, ListDomainNamesCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CloudSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudSearchClient";
 import { UpdateAvailabilityOptionsRequest, UpdateAvailabilityOptionsResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateAvailabilityOptionsCommand}.
  */
 export interface UpdateAvailabilityOptionsCommandInput extends UpdateAvailabilityOptionsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateAvailabilityOptionsCommand}.
  */
 export interface UpdateAvailabilityOptionsCommandOutput extends UpdateAvailabilityOptionsResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>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 <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html" target="_blank">Configuring Availability Options</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateAvailabilityOptionsCommandOutput extends UpdateAvailabili
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateAvailabilityOptionsCommandInput - {@link UpdateAvailabilityOptionsCommandInput}
+ * @returns {@link UpdateAvailabilityOptionsCommandOutput}
  * @see {@link UpdateAvailabilityOptionsCommandInput} for command's `input` shape.
  * @see {@link UpdateAvailabilityOptionsCommandOutput} for command's `response` shape.
  * @see {@link CloudSearchClientResolvedConfig | config} for CloudSearchClient's `config` shape.
@@ -56,11 +63,20 @@ export interface UpdateAvailabilityOptionsCommandOutput extends UpdateAvailabili
 export declare class UpdateAvailabilityOptionsCommand extends $Command<UpdateAvailabilityOptionsCommandInput, UpdateAvailabilityOptionsCommandOutput, CloudSearchClientResolvedConfig> {
     readonly input: UpdateAvailabilityOptionsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateAvailabilityOptionsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudSearchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateAvailabilityOptionsCommandInput, UpdateAvailabilityOptionsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CloudSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudSearchClient";
 import { UpdateDomainEndpointOptionsRequest, UpdateDomainEndpointOptionsResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateDomainEndpointOptionsCommand}.
  */
 export interface UpdateDomainEndpointOptionsCommandInput extends UpdateDomainEndpointOptionsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateDomainEndpointOptionsCommand}.
  */
 export interface UpdateDomainEndpointOptionsCommandOutput extends UpdateDomainEndpointOptionsResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-domain-endpoint-options.html" target="_blank">Configuring Domain Endpoint Options</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateDomainEndpointOptionsCommandOutput extends UpdateDomainEn
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateDomainEndpointOptionsCommandInput - {@link UpdateDomainEndpointOptionsCommandInput}
+ * @returns {@link UpdateDomainEndpointOptionsCommandOutput}
  * @see {@link UpdateDomainEndpointOptionsCommandInput} for command's `input` shape.
  * @see {@link UpdateDomainEndpointOptionsCommandOutput} for command's `response` shape.
  * @see {@link CloudSearchClientResolvedConfig | config} for CloudSearchClient's `config` shape.
@@ -56,11 +63,20 @@ export interface UpdateDomainEndpointOptionsCommandOutput extends UpdateDomainEn
 export declare class UpdateDomainEndpointOptionsCommand extends $Command<UpdateDomainEndpointOptionsCommandInput, UpdateDomainEndpointOptionsCommandOutput, CloudSearchClientResolvedConfig> {
     readonly input: UpdateDomainEndpointOptionsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateDomainEndpointOptionsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudSearchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateDomainEndpointOptionsCommandInput, UpdateDomainEndpointOptionsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CloudSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudSearchClient";
 import { UpdateScalingParametersRequest, UpdateScalingParametersResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateScalingParametersCommand}.
  */
 export interface UpdateScalingParametersCommandInput extends UpdateScalingParametersRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateScalingParametersCommand}.
  */
 export interface UpdateScalingParametersCommandOutput extends UpdateScalingParametersResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>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 <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html" target="_blank">Configuring Scaling Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateScalingParametersCommandOutput extends UpdateScalingParam
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateScalingParametersCommandInput - {@link UpdateScalingParametersCommandInput}
+ * @returns {@link UpdateScalingParametersCommandOutput}
  * @see {@link UpdateScalingParametersCommandInput} for command's `input` shape.
  * @see {@link UpdateScalingParametersCommandOutput} for command's `response` shape.
  * @see {@link CloudSearchClientResolvedConfig | config} for CloudSearchClient's `config` shape.
@@ -53,11 +60,20 @@ export interface UpdateScalingParametersCommandOutput extends UpdateScalingParam
 export declare class UpdateScalingParametersCommand extends $Command<UpdateScalingParametersCommandInput, UpdateScalingParametersCommandOutput, CloudSearchClientResolvedConfig> {
     readonly input: UpdateScalingParametersCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateScalingParametersCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudSearchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateScalingParametersCommandInput, UpdateScalingParametersCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CloudSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudSearchClient";
 import { UpdateServiceAccessPoliciesRequest, UpdateServiceAccessPoliciesResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateServiceAccessPoliciesCommand}.
  */
 export interface UpdateServiceAccessPoliciesCommandInput extends UpdateServiceAccessPoliciesRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateServiceAccessPoliciesCommand}.
  */
 export interface UpdateServiceAccessPoliciesCommandOutput extends UpdateServiceAccessPoliciesResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Configures the access rules that control access to the domain's document and search endpoints.
  *       For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html" target="_blank">
  *         Configuring Access for an Amazon CloudSearch Domain</a>.</p>
@@ -27,6 +32,8 @@ export interface UpdateServiceAccessPoliciesCommandOutput extends UpdateServiceA
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateServiceAccessPoliciesCommandInput - {@link UpdateServiceAccessPoliciesCommandInput}
+ * @returns {@link UpdateServiceAccessPoliciesCommandOutput}
  * @see {@link UpdateServiceAccessPoliciesCommandInput} for command's `input` shape.
  * @see {@link UpdateServiceAccessPoliciesCommandOutput} for command's `response` shape.
  * @see {@link CloudSearchClientResolvedConfig | config} for CloudSearchClient's `config` shape.
@@ -55,11 +62,20 @@ export interface UpdateServiceAccessPoliciesCommandOutput extends UpdateServiceA
 export declare class UpdateServiceAccessPoliciesCommand extends $Command<UpdateServiceAccessPoliciesCommandInput, UpdateServiceAccessPoliciesCommandOutput, CloudSearchClientResolvedConfig> {
     readonly input: UpdateServiceAccessPoliciesCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateServiceAccessPoliciesCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudSearchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateServiceAccessPoliciesCommandInput, UpdateServiceAccessPoliciesCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/models/CloudSearchServiceException.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 CloudSearch service.
  */
 export declare class CloudSearchServiceException extends __ServiceException {