@aws-sdk/client-cloudsearch 3.296.0 → 3.298.0

package/dist-types/CloudSearch.d.ts

@@ -27,6 +27,7 @@ import { UpdateDomainEndpointOptionsCommandInput, UpdateDomainEndpointOptionsCom
 import { UpdateScalingParametersCommandInput, UpdateScalingParametersCommandOutput } from "./commands/UpdateScalingParametersCommand";
 import { UpdateServiceAccessPoliciesCommandInput, UpdateServiceAccessPoliciesCommandOutput } from "./commands/UpdateServiceAccessPoliciesCommand";
 /**
+ * @public
  * <fullname>Amazon CloudSearch Configuration Service</fullname>
  *     <p>You use the Amazon CloudSearch configuration service to create, configure, and manage search domains.
  *       Configuration service  requests are submitted using the AWS Query protocol. AWS Query requests
@@ -37,12 +38,14 @@ import { UpdateServiceAccessPoliciesCommandInput, UpdateServiceAccessPoliciesCom
  */
 export declare class CloudSearch extends CloudSearchClient {
     /**
+     * @public
      * <p>Indexes the search suggestions. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html#configuring-suggesters">Configuring Suggesters</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>
      */
     buildSuggesters(args: BuildSuggestersCommandInput, options?: __HttpHandlerOptions): Promise<BuildSuggestersCommandOutput>;
     buildSuggesters(args: BuildSuggestersCommandInput, cb: (err: any, data?: BuildSuggestersCommandOutput) => void): void;
     buildSuggesters(args: BuildSuggestersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BuildSuggestersCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates a new search domain. For more information,
      *       see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/creating-domains.html" target="_blank">Creating a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>
      */
@@ -50,36 +53,42 @@ export declare class CloudSearch extends CloudSearchClient {
     createDomain(args: CreateDomainCommandInput, cb: (err: any, data?: CreateDomainCommandOutput) => void): void;
     createDomain(args: CreateDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDomainCommandOutput) => void): void;
     /**
+     * @public
      * <p>Configures an analysis scheme that can be applied to a <code>text</code> or <code>text-array</code> field to define language-specific text processing options. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html" target="_blank">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>
      */
     defineAnalysisScheme(args: DefineAnalysisSchemeCommandInput, options?: __HttpHandlerOptions): Promise<DefineAnalysisSchemeCommandOutput>;
     defineAnalysisScheme(args: DefineAnalysisSchemeCommandInput, cb: (err: any, data?: DefineAnalysisSchemeCommandOutput) => void): void;
     defineAnalysisScheme(args: DefineAnalysisSchemeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DefineAnalysisSchemeCommandOutput) => void): void;
     /**
+     * @public
      * <p>Configures an <code><a>Expression</a></code> for the search domain. Used to create new expressions and modify existing ones.  If the expression exists, the new configuration replaces the old one. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html" target="_blank">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>
      */
     defineExpression(args: DefineExpressionCommandInput, options?: __HttpHandlerOptions): Promise<DefineExpressionCommandOutput>;
     defineExpression(args: DefineExpressionCommandInput, cb: (err: any, data?: DefineExpressionCommandOutput) => void): void;
     defineExpression(args: DefineExpressionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DefineExpressionCommandOutput) => void): void;
     /**
+     * @public
      * <p>Configures an <code><a>IndexField</a></code> for the search domain. Used to create new fields and modify existing ones. You must specify the name of the domain you are configuring and an index field configuration. The index field configuration specifies a unique name, the index field type, and the options you want to configure for the field. The options you can specify depend on the <code><a>IndexFieldType</a></code>. If the field exists, the new configuration replaces the old one. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html" target="_blank">Configuring Index Fields</a> in the <i>Amazon CloudSearch Developer Guide</i>. </p>
      */
     defineIndexField(args: DefineIndexFieldCommandInput, options?: __HttpHandlerOptions): Promise<DefineIndexFieldCommandOutput>;
     defineIndexField(args: DefineIndexFieldCommandInput, cb: (err: any, data?: DefineIndexFieldCommandOutput) => void): void;
     defineIndexField(args: DefineIndexFieldCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DefineIndexFieldCommandOutput) => void): void;
     /**
+     * @public
      * <p>Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see <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>
      */
     defineSuggester(args: DefineSuggesterCommandInput, options?: __HttpHandlerOptions): Promise<DefineSuggesterCommandOutput>;
     defineSuggester(args: DefineSuggesterCommandInput, cb: (err: any, data?: DefineSuggesterCommandOutput) => void): void;
     defineSuggester(args: DefineSuggesterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DefineSuggesterCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes an analysis scheme. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html" target="_blank">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i>. </p>
      */
     deleteAnalysisScheme(args: DeleteAnalysisSchemeCommandInput, options?: __HttpHandlerOptions): Promise<DeleteAnalysisSchemeCommandOutput>;
     deleteAnalysisScheme(args: DeleteAnalysisSchemeCommandInput, cb: (err: any, data?: DeleteAnalysisSchemeCommandOutput) => void): void;
     deleteAnalysisScheme(args: DeleteAnalysisSchemeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAnalysisSchemeCommandOutput) => void): void;
     /**
+     * @public
      * <p>Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information,
      *       see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/deleting-domains.html" target="_blank">Deleting a Search  Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>. </p>
      */
@@ -87,42 +96,49 @@ export declare class CloudSearch extends CloudSearchClient {
     deleteDomain(args: DeleteDomainCommandInput, cb: (err: any, data?: DeleteDomainCommandOutput) => void): void;
     deleteDomain(args: DeleteDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDomainCommandOutput) => void): void;
     /**
+     * @public
      * <p>Removes an <code><a>Expression</a></code> from the search domain. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html" target="_blank">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>
      */
     deleteExpression(args: DeleteExpressionCommandInput, options?: __HttpHandlerOptions): Promise<DeleteExpressionCommandOutput>;
     deleteExpression(args: DeleteExpressionCommandInput, cb: (err: any, data?: DeleteExpressionCommandOutput) => void): void;
     deleteExpression(args: DeleteExpressionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteExpressionCommandOutput) => void): void;
     /**
+     * @public
      * <p>Removes an <code><a>IndexField</a></code> from the search domain. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html" target="_blank">Configuring Index Fields</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>
      */
     deleteIndexField(args: DeleteIndexFieldCommandInput, options?: __HttpHandlerOptions): Promise<DeleteIndexFieldCommandOutput>;
     deleteIndexField(args: DeleteIndexFieldCommandInput, cb: (err: any, data?: DeleteIndexFieldCommandOutput) => void): void;
     deleteIndexField(args: DeleteIndexFieldCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIndexFieldCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes a suggester. 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>
      */
     deleteSuggester(args: DeleteSuggesterCommandInput, options?: __HttpHandlerOptions): Promise<DeleteSuggesterCommandOutput>;
     deleteSuggester(args: DeleteSuggesterCommandInput, cb: (err: any, data?: DeleteSuggesterCommandOutput) => void): void;
     deleteSuggester(args: DeleteSuggesterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSuggesterCommandOutput) => void): void;
     /**
+     * @public
      * <p>Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing options for a <code>text</code> field. Can be limited to specific analysis schemes by name.  By default, shows all analysis schemes and includes any pending changes to the configuration. Set the <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-analysis-schemes.html" target="_blank">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>
      */
     describeAnalysisSchemes(args: DescribeAnalysisSchemesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAnalysisSchemesCommandOutput>;
     describeAnalysisSchemes(args: DescribeAnalysisSchemesCommandInput, cb: (err: any, data?: DescribeAnalysisSchemesCommandOutput) => void): void;
     describeAnalysisSchemes(args: DescribeAnalysisSchemesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAnalysisSchemesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Gets the availability options configured for a domain. 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-availability-options.html" target="_blank">Configuring Availability Options</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>
      */
     describeAvailabilityOptions(args: DescribeAvailabilityOptionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAvailabilityOptionsCommandOutput>;
     describeAvailabilityOptions(args: DescribeAvailabilityOptionsCommandInput, cb: (err: any, data?: DescribeAvailabilityOptionsCommandOutput) => void): void;
     describeAvailabilityOptions(args: DescribeAvailabilityOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAvailabilityOptionsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns 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>
      */
     describeDomainEndpointOptions(args: DescribeDomainEndpointOptionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDomainEndpointOptionsCommandOutput>;
     describeDomainEndpointOptions(args: DescribeDomainEndpointOptionsCommandInput, cb: (err: any, data?: DescribeDomainEndpointOptionsCommandOutput) => void): void;
     describeDomainEndpointOptions(args: DescribeDomainEndpointOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDomainEndpointOptionsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Gets information about the search domains owned by this account. Can be limited to specific domains. Shows
      *       all domains by default. To get the number of searchable documents in a domain, use the console or submit a <code>matchall</code> request to your domain's search endpoint: <code>q=matchall&amp;q.parser=structured&amp;size=0</code>. For more information,
      *       see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html" target="_blank">Getting Information about a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>
@@ -131,12 +147,14 @@ export declare class CloudSearch extends CloudSearchClient {
     describeDomains(args: DescribeDomainsCommandInput, cb: (err: any, data?: DescribeDomainsCommandOutput) => void): void;
     describeDomains(args: DescribeDomainsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDomainsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Gets the expressions configured for the search domain. Can be limited to specific expressions by name. By default, shows all expressions and includes any pending changes to the configuration. Set the <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-expressions.html" target="_blank">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>
      */
     describeExpressions(args: DescribeExpressionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeExpressionsCommandOutput>;
     describeExpressions(args: DescribeExpressionsCommandInput, cb: (err: any, data?: DescribeExpressionsCommandOutput) => void): void;
     describeExpressions(args: DescribeExpressionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeExpressionsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Gets information about the index fields configured for the search domain.
      *       Can be limited to specific fields by name.  By default, shows all fields and includes any pending changes to the configuration. Set the <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-domain-info.html" target="_blank">Getting Domain Information</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>
@@ -145,12 +163,14 @@ export declare class CloudSearch extends CloudSearchClient {
     describeIndexFields(args: DescribeIndexFieldsCommandInput, cb: (err: any, data?: DescribeIndexFieldsCommandOutput) => void): void;
     describeIndexFields(args: DescribeIndexFieldsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeIndexFieldsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Gets the scaling parameters configured for a domain. A domain's scaling parameters specify the desired search instance type and replication count. For more information, see   <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>
      */
     describeScalingParameters(args: DescribeScalingParametersCommandInput, options?: __HttpHandlerOptions): Promise<DescribeScalingParametersCommandOutput>;
     describeScalingParameters(args: DescribeScalingParametersCommandInput, cb: (err: any, data?: DescribeScalingParametersCommandOutput) => void): void;
     describeScalingParameters(args: DescribeScalingParametersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeScalingParametersCommandOutput) => void): void;
     /**
+     * @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>
      */
@@ -158,42 +178,49 @@ export declare class CloudSearch extends CloudSearchClient {
     describeServiceAccessPolicies(args: DescribeServiceAccessPoliciesCommandInput, cb: (err: any, data?: DescribeServiceAccessPoliciesCommandOutput) => void): void;
     describeServiceAccessPolicies(args: DescribeServiceAccessPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeServiceAccessPoliciesCommandOutput) => void): void;
     /**
+     * @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>
      */
     describeSuggesters(args: DescribeSuggestersCommandInput, options?: __HttpHandlerOptions): Promise<DescribeSuggestersCommandOutput>;
     describeSuggesters(args: DescribeSuggestersCommandInput, cb: (err: any, data?: DescribeSuggestersCommandOutput) => void): void;
     describeSuggesters(args: DescribeSuggestersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSuggestersCommandOutput) => void): void;
     /**
+     * @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>
      */
     indexDocuments(args: IndexDocumentsCommandInput, options?: __HttpHandlerOptions): Promise<IndexDocumentsCommandOutput>;
     indexDocuments(args: IndexDocumentsCommandInput, cb: (err: any, data?: IndexDocumentsCommandOutput) => void): void;
     indexDocuments(args: IndexDocumentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: IndexDocumentsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists all search domains owned by an account.</p>
      */
     listDomainNames(args: ListDomainNamesCommandInput, options?: __HttpHandlerOptions): Promise<ListDomainNamesCommandOutput>;
     listDomainNames(args: ListDomainNamesCommandInput, cb: (err: any, data?: ListDomainNamesCommandOutput) => void): void;
     listDomainNames(args: ListDomainNamesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDomainNamesCommandOutput) => void): void;
     /**
+     * @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>
      */
     updateAvailabilityOptions(args: UpdateAvailabilityOptionsCommandInput, options?: __HttpHandlerOptions): Promise<UpdateAvailabilityOptionsCommandOutput>;
     updateAvailabilityOptions(args: UpdateAvailabilityOptionsCommandInput, cb: (err: any, data?: UpdateAvailabilityOptionsCommandOutput) => void): void;
     updateAvailabilityOptions(args: UpdateAvailabilityOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAvailabilityOptionsCommandOutput) => void): void;
     /**
+     * @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>
      */
     updateDomainEndpointOptions(args: UpdateDomainEndpointOptionsCommandInput, options?: __HttpHandlerOptions): Promise<UpdateDomainEndpointOptionsCommandOutput>;
     updateDomainEndpointOptions(args: UpdateDomainEndpointOptionsCommandInput, cb: (err: any, data?: UpdateDomainEndpointOptionsCommandOutput) => void): void;
     updateDomainEndpointOptions(args: UpdateDomainEndpointOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDomainEndpointOptionsCommandOutput) => void): void;
     /**
+     * @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>
      */
     updateScalingParameters(args: UpdateScalingParametersCommandInput, options?: __HttpHandlerOptions): Promise<UpdateScalingParametersCommandOutput>;
     updateScalingParameters(args: UpdateScalingParametersCommandInput, cb: (err: any, data?: UpdateScalingParametersCommandOutput) => void): void;
     updateScalingParameters(args: UpdateScalingParametersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateScalingParametersCommandOutput) => void): void;
     /**
+     * @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>

package/dist-types/CloudSearchClient.d.ts

@@ -34,15 +34,24 @@ import { UpdateDomainEndpointOptionsCommandInput, UpdateDomainEndpointOptionsCom
 import { UpdateScalingParametersCommandInput, UpdateScalingParametersCommandOutput } from "./commands/UpdateScalingParametersCommand";
 import { UpdateServiceAccessPoliciesCommandInput, UpdateServiceAccessPoliciesCommandOutput } from "./commands/UpdateServiceAccessPoliciesCommand";
 import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
+/**
+ * @public
+ */
 export type ServiceInputTypes = BuildSuggestersCommandInput | CreateDomainCommandInput | DefineAnalysisSchemeCommandInput | DefineExpressionCommandInput | DefineIndexFieldCommandInput | DefineSuggesterCommandInput | DeleteAnalysisSchemeCommandInput | DeleteDomainCommandInput | DeleteExpressionCommandInput | DeleteIndexFieldCommandInput | DeleteSuggesterCommandInput | DescribeAnalysisSchemesCommandInput | DescribeAvailabilityOptionsCommandInput | DescribeDomainEndpointOptionsCommandInput | DescribeDomainsCommandInput | DescribeExpressionsCommandInput | DescribeIndexFieldsCommandInput | DescribeScalingParametersCommandInput | DescribeServiceAccessPoliciesCommandInput | DescribeSuggestersCommandInput | IndexDocumentsCommandInput | ListDomainNamesCommandInput | UpdateAvailabilityOptionsCommandInput | UpdateDomainEndpointOptionsCommandInput | UpdateScalingParametersCommandInput | UpdateServiceAccessPoliciesCommandInput;
+/**
+ * @public
+ */
 export type ServiceOutputTypes = BuildSuggestersCommandOutput | CreateDomainCommandOutput | DefineAnalysisSchemeCommandOutput | DefineExpressionCommandOutput | DefineIndexFieldCommandOutput | DefineSuggesterCommandOutput | DeleteAnalysisSchemeCommandOutput | DeleteDomainCommandOutput | DeleteExpressionCommandOutput | DeleteIndexFieldCommandOutput | DeleteSuggesterCommandOutput | DescribeAnalysisSchemesCommandOutput | DescribeAvailabilityOptionsCommandOutput | DescribeDomainEndpointOptionsCommandOutput | DescribeDomainsCommandOutput | DescribeExpressionsCommandOutput | DescribeIndexFieldsCommandOutput | DescribeScalingParametersCommandOutput | DescribeServiceAccessPoliciesCommandOutput | DescribeSuggestersCommandOutput | IndexDocumentsCommandOutput | ListDomainNamesCommandOutput | UpdateAvailabilityOptionsCommandOutput | UpdateDomainEndpointOptionsCommandOutput | UpdateScalingParametersCommandOutput | UpdateServiceAccessPoliciesCommandOutput;
+/**
+ * @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
      */
@@ -132,23 +141,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 CloudSearchClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
 /**
- * The configuration interface of CloudSearchClient class constructor that set the region, credentials and other options.
+ * @public
+ *
+ *  The configuration interface of CloudSearchClient class constructor that set the region, credentials and other options.
  */
 export interface CloudSearchClientConfig extends CloudSearchClientConfigType {
 }
+/**
+ * @public
+ */
 type CloudSearchClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
 /**
- * The resolved configuration interface of CloudSearchClient class. This is resolved and normalized from the {@link CloudSearchClientConfig | constructor configuration interface}.
+ * @public
+ *
+ *  The resolved configuration interface of CloudSearchClient class. This is resolved and normalized from the {@link CloudSearchClientConfig | constructor configuration interface}.
  */
 export interface CloudSearchClientResolvedConfig extends CloudSearchClientResolvedConfigType {
 }
 /**
+ * @public
  * <fullname>Amazon CloudSearch Configuration Service</fullname>
  *     <p>You use the Amazon CloudSearch configuration service to create, configure, and manage search domains.
  *       Configuration service  requests are submitted using the AWS Query protocol. AWS Query requests

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CloudSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudSearchClient";
 import { BuildSuggestersRequest, BuildSuggestersResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link BuildSuggestersCommand}.
  */
 export interface BuildSuggestersCommandInput extends BuildSuggestersRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link BuildSuggestersCommand}.
  */
 export interface BuildSuggestersCommandOutput extends BuildSuggestersResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Indexes the search suggestions. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html#configuring-suggesters">Configuring Suggesters</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 BuildSuggestersCommandOutput extends BuildSuggestersResponse, _
  * const response = await client.send(command);
  * ```
  *
+ * @param BuildSuggestersCommandInput - {@link BuildSuggestersCommandInput}
+ * @returns {@link BuildSuggestersCommandOutput}
  * @see {@link BuildSuggestersCommandInput} for command's `input` shape.
  * @see {@link BuildSuggestersCommandOutput} for command's `response` shape.
  * @see {@link CloudSearchClientResolvedConfig | config} for CloudSearchClient's `config` shape.
@@ -47,11 +54,20 @@ export interface BuildSuggestersCommandOutput extends BuildSuggestersResponse, _
 export declare class BuildSuggestersCommand extends $Command<BuildSuggestersCommandInput, BuildSuggestersCommandOutput, CloudSearchClientResolvedConfig> {
     readonly input: BuildSuggestersCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: BuildSuggestersCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudSearchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BuildSuggestersCommandInput, BuildSuggestersCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CloudSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudSearchClient";
 import { CreateDomainRequest, CreateDomainResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link CreateDomainCommand}.
  */
 export interface CreateDomainCommandInput extends CreateDomainRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateDomainCommand}.
  */
 export interface CreateDomainCommandOutput extends CreateDomainResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates a new search domain. For more information,
  *       see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/creating-domains.html" target="_blank">Creating a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>
  * @example
@@ -26,6 +31,8 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateDomainCommandInput - {@link CreateDomainCommandInput}
+ * @returns {@link CreateDomainCommandOutput}
  * @see {@link CreateDomainCommandInput} for command's `input` shape.
  * @see {@link CreateDomainCommandOutput} for command's `response` shape.
  * @see {@link CloudSearchClientResolvedConfig | config} for CloudSearchClient's `config` shape.
@@ -51,11 +58,20 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad
 export declare class CreateDomainCommand extends $Command<CreateDomainCommandInput, CreateDomainCommandOutput, CloudSearchClientResolvedConfig> {
     readonly input: CreateDomainCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateDomainCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudSearchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateDomainCommandInput, CreateDomainCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CloudSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudSearchClient";
 import { DefineAnalysisSchemeRequest, DefineAnalysisSchemeResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link DefineAnalysisSchemeCommand}.
  */
 export interface DefineAnalysisSchemeCommandInput extends DefineAnalysisSchemeRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link DefineAnalysisSchemeCommand}.
  */
 export interface DefineAnalysisSchemeCommandOutput extends DefineAnalysisSchemeResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Configures an analysis scheme that can be applied to a <code>text</code> or <code>text-array</code> field to define language-specific text processing options. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html" target="_blank">Configuring Analysis Schemes</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 DefineAnalysisSchemeCommandOutput extends DefineAnalysisSchemeR
  * const response = await client.send(command);
  * ```
  *
+ * @param DefineAnalysisSchemeCommandInput - {@link DefineAnalysisSchemeCommandInput}
+ * @returns {@link DefineAnalysisSchemeCommandOutput}
  * @see {@link DefineAnalysisSchemeCommandInput} for command's `input` shape.
  * @see {@link DefineAnalysisSchemeCommandOutput} for command's `response` shape.
  * @see {@link CloudSearchClientResolvedConfig | config} for CloudSearchClient's `config` shape.
@@ -53,11 +60,20 @@ export interface DefineAnalysisSchemeCommandOutput extends DefineAnalysisSchemeR
 export declare class DefineAnalysisSchemeCommand extends $Command<DefineAnalysisSchemeCommandInput, DefineAnalysisSchemeCommandOutput, CloudSearchClientResolvedConfig> {
     readonly input: DefineAnalysisSchemeCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DefineAnalysisSchemeCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudSearchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DefineAnalysisSchemeCommandInput, DefineAnalysisSchemeCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CloudSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudSearchClient";
 import { DefineExpressionRequest, DefineExpressionResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link DefineExpressionCommand}.
  */
 export interface DefineExpressionCommandInput extends DefineExpressionRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link DefineExpressionCommand}.
  */
 export interface DefineExpressionCommandOutput extends DefineExpressionResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Configures an <code><a>Expression</a></code> for the search domain. Used to create new expressions and modify existing ones.  If the expression exists, the new configuration replaces the old one. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html" target="_blank">Configuring Expressions</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 DefineExpressionCommandOutput extends DefineExpressionResponse,
  * const response = await client.send(command);
  * ```
  *
+ * @param DefineExpressionCommandInput - {@link DefineExpressionCommandInput}
+ * @returns {@link DefineExpressionCommandOutput}
  * @see {@link DefineExpressionCommandInput} for command's `input` shape.
  * @see {@link DefineExpressionCommandOutput} for command's `response` shape.
  * @see {@link CloudSearchClientResolvedConfig | config} for CloudSearchClient's `config` shape.
@@ -53,11 +60,20 @@ export interface DefineExpressionCommandOutput extends DefineExpressionResponse,
 export declare class DefineExpressionCommand extends $Command<DefineExpressionCommandInput, DefineExpressionCommandOutput, CloudSearchClientResolvedConfig> {
     readonly input: DefineExpressionCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DefineExpressionCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudSearchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DefineExpressionCommandInput, DefineExpressionCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CloudSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudSearchClient";
 import { DefineIndexFieldRequest, DefineIndexFieldResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link DefineIndexFieldCommand}.
  */
 export interface DefineIndexFieldCommandInput extends DefineIndexFieldRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link DefineIndexFieldCommand}.
  */
 export interface DefineIndexFieldCommandOutput extends DefineIndexFieldResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Configures an <code><a>IndexField</a></code> for the search domain. Used to create new fields and modify existing ones. You must specify the name of the domain you are configuring and an index field configuration. The index field configuration specifies a unique name, the index field type, and the options you want to configure for the field. The options you can specify depend on the <code><a>IndexFieldType</a></code>. If the field exists, the new configuration replaces the old one. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html" target="_blank">Configuring Index Fields</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 DefineIndexFieldCommandOutput extends DefineIndexFieldResponse,
  * const response = await client.send(command);
  * ```
  *
+ * @param DefineIndexFieldCommandInput - {@link DefineIndexFieldCommandInput}
+ * @returns {@link DefineIndexFieldCommandOutput}
  * @see {@link DefineIndexFieldCommandInput} for command's `input` shape.
  * @see {@link DefineIndexFieldCommandOutput} for command's `response` shape.
  * @see {@link CloudSearchClientResolvedConfig | config} for CloudSearchClient's `config` shape.
@@ -53,11 +60,20 @@ export interface DefineIndexFieldCommandOutput extends DefineIndexFieldResponse,
 export declare class DefineIndexFieldCommand extends $Command<DefineIndexFieldCommandInput, DefineIndexFieldCommandOutput, CloudSearchClientResolvedConfig> {
     readonly input: DefineIndexFieldCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DefineIndexFieldCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudSearchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DefineIndexFieldCommandInput, DefineIndexFieldCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CloudSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudSearchClient";
 import { DefineSuggesterRequest, DefineSuggesterResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link DefineSuggesterCommand}.
  */
 export interface DefineSuggesterCommandInput extends DefineSuggesterRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link DefineSuggesterCommand}.
  */
 export interface DefineSuggesterCommandOutput extends DefineSuggesterResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see <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 DefineSuggesterCommandOutput extends DefineSuggesterResponse, _
  * const response = await client.send(command);
  * ```
  *
+ * @param DefineSuggesterCommandInput - {@link DefineSuggesterCommandInput}
+ * @returns {@link DefineSuggesterCommandOutput}
  * @see {@link DefineSuggesterCommandInput} for command's `input` shape.
  * @see {@link DefineSuggesterCommandOutput} for command's `response` shape.
  * @see {@link CloudSearchClientResolvedConfig | config} for CloudSearchClient's `config` shape.
@@ -53,11 +60,20 @@ export interface DefineSuggesterCommandOutput extends DefineSuggesterResponse, _
 export declare class DefineSuggesterCommand extends $Command<DefineSuggesterCommandInput, DefineSuggesterCommandOutput, CloudSearchClientResolvedConfig> {
     readonly input: DefineSuggesterCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DefineSuggesterCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudSearchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DefineSuggesterCommandInput, DefineSuggesterCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }