@aws-sdk/client-opensearchserverless 3.296.0 → 3.297.0

package/dist-types/OpenSearchServerless.d.ts

@@ -32,6 +32,7 @@ import { UpdateSecurityPolicyCommandInput, UpdateSecurityPolicyCommandOutput } f
 import { UpdateVpcEndpointCommandInput, UpdateVpcEndpointCommandOutput } from "./commands/UpdateVpcEndpointCommand";
 import { OpenSearchServerlessClient } from "./OpenSearchServerlessClient";
 /**
+ * @public
  * <p>Use the Amazon OpenSearch Serverless API to create, configure, and manage OpenSearch Serverless collections and
  *             security policies.</p>
  *         <p>OpenSearch Serverless is an on-demand, pre-provisioned serverless configuration for
@@ -45,6 +46,7 @@ import { OpenSearchServerlessClient } from "./OpenSearchServerlessClient";
  */
 export declare class OpenSearchServerless extends OpenSearchServerlessClient {
     /**
+     * @public
      * <p>Returns attributes for one or more collections, including the collection endpoint and
      *             the OpenSearch Dashboards endpoint. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html">Creating and
      *                 managing Amazon OpenSearch Serverless collections</a>.</p>
@@ -53,6 +55,7 @@ export declare class OpenSearchServerless extends OpenSearchServerlessClient {
     batchGetCollection(args: BatchGetCollectionCommandInput, cb: (err: any, data?: BatchGetCollectionCommandOutput) => void): void;
     batchGetCollection(args: BatchGetCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetCollectionCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns attributes for one or more VPC endpoints associated with the current account.
      *             For more information, see
      *             <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html">Access Amazon OpenSearch Serverless using an interface endpoint</a>.</p>
@@ -61,6 +64,7 @@ export declare class OpenSearchServerless extends OpenSearchServerlessClient {
     batchGetVpcEndpoint(args: BatchGetVpcEndpointCommandInput, cb: (err: any, data?: BatchGetVpcEndpointCommandOutput) => void): void;
     batchGetVpcEndpoint(args: BatchGetVpcEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetVpcEndpointCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates a data access policy for OpenSearch Serverless. Access policies limit access to collections
      *             and the resources within them, and allow a user to access that data irrespective of the
      *             access mechanism or network source. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html">Data access
@@ -70,6 +74,7 @@ export declare class OpenSearchServerless extends OpenSearchServerlessClient {
     createAccessPolicy(args: CreateAccessPolicyCommandInput, cb: (err: any, data?: CreateAccessPolicyCommandOutput) => void): void;
     createAccessPolicy(args: CreateAccessPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAccessPolicyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates a new OpenSearch Serverless collection. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html">Creating and
      *                 managing Amazon OpenSearch Serverless collections</a>.</p>
      */
@@ -77,6 +82,7 @@ export declare class OpenSearchServerless extends OpenSearchServerlessClient {
     createCollection(args: CreateCollectionCommandInput, cb: (err: any, data?: CreateCollectionCommandOutput) => void): void;
     createCollection(args: CreateCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCollectionCommandOutput) => void): void;
     /**
+     * @public
      * <p>Specifies a security configuration for OpenSearch Serverless. For more information, see
      *             <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html">SAML
      *                 authentication for Amazon OpenSearch Serverless</a>. </p>
@@ -85,6 +91,7 @@ export declare class OpenSearchServerless extends OpenSearchServerlessClient {
     createSecurityConfig(args: CreateSecurityConfigCommandInput, cb: (err: any, data?: CreateSecurityConfigCommandOutput) => void): void;
     createSecurityConfig(args: CreateSecurityConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSecurityConfigCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates a security policy to be used by one or more OpenSearch Serverless collections. Security
      *             policies provide access to a collection and its OpenSearch Dashboards endpoint from
      *             public networks or specific VPC endpoints. They also allow you to secure a collection
@@ -96,6 +103,7 @@ export declare class OpenSearchServerless extends OpenSearchServerlessClient {
     createSecurityPolicy(args: CreateSecurityPolicyCommandInput, cb: (err: any, data?: CreateSecurityPolicyCommandOutput) => void): void;
     createSecurityPolicy(args: CreateSecurityPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSecurityPolicyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates an OpenSearch Serverless-managed interface VPC endpoint. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html">Access
      *                 Amazon OpenSearch Serverless using an interface endpoint</a>.</p>
      */
@@ -103,6 +111,7 @@ export declare class OpenSearchServerless extends OpenSearchServerlessClient {
     createVpcEndpoint(args: CreateVpcEndpointCommandInput, cb: (err: any, data?: CreateVpcEndpointCommandOutput) => void): void;
     createVpcEndpoint(args: CreateVpcEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVpcEndpointCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes an OpenSearch Serverless access policy. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html">Data
      *                 access control for Amazon OpenSearch Serverless</a>.</p>
      */
@@ -110,6 +119,7 @@ export declare class OpenSearchServerless extends OpenSearchServerlessClient {
     deleteAccessPolicy(args: DeleteAccessPolicyCommandInput, cb: (err: any, data?: DeleteAccessPolicyCommandOutput) => void): void;
     deleteAccessPolicy(args: DeleteAccessPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccessPolicyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes an OpenSearch Serverless collection. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html">Creating and
      *                 managing Amazon OpenSearch Serverless collections</a>.</p>
      */
@@ -117,6 +127,7 @@ export declare class OpenSearchServerless extends OpenSearchServerlessClient {
     deleteCollection(args: DeleteCollectionCommandInput, cb: (err: any, data?: DeleteCollectionCommandOutput) => void): void;
     deleteCollection(args: DeleteCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCollectionCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes a security configuration for OpenSearch Serverless. For more information, see
      *             <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html">SAML
      *                 authentication for Amazon OpenSearch Serverless</a>.</p>
@@ -125,12 +136,14 @@ export declare class OpenSearchServerless extends OpenSearchServerlessClient {
     deleteSecurityConfig(args: DeleteSecurityConfigCommandInput, cb: (err: any, data?: DeleteSecurityConfigCommandOutput) => void): void;
     deleteSecurityConfig(args: DeleteSecurityConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSecurityConfigCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes an OpenSearch Serverless security policy.</p>
      */
     deleteSecurityPolicy(args: DeleteSecurityPolicyCommandInput, options?: __HttpHandlerOptions): Promise<DeleteSecurityPolicyCommandOutput>;
     deleteSecurityPolicy(args: DeleteSecurityPolicyCommandInput, cb: (err: any, data?: DeleteSecurityPolicyCommandOutput) => void): void;
     deleteSecurityPolicy(args: DeleteSecurityPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSecurityPolicyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes an OpenSearch Serverless-managed interface endpoint. For more information, see
      *             <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html">Access Amazon OpenSearch Serverless using an interface endpoint</a>.</p>
      */
@@ -138,6 +151,7 @@ export declare class OpenSearchServerless extends OpenSearchServerlessClient {
     deleteVpcEndpoint(args: DeleteVpcEndpointCommandInput, cb: (err: any, data?: DeleteVpcEndpointCommandOutput) => void): void;
     deleteVpcEndpoint(args: DeleteVpcEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVpcEndpointCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns an OpenSearch Serverless access policy. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html">Data
      *             access control for Amazon OpenSearch Serverless</a>.</p>
      */
@@ -145,12 +159,14 @@ export declare class OpenSearchServerless extends OpenSearchServerlessClient {
     getAccessPolicy(args: GetAccessPolicyCommandInput, cb: (err: any, data?: GetAccessPolicyCommandOutput) => void): void;
     getAccessPolicy(args: GetAccessPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccessPolicyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns account-level settings related to OpenSearch Serverless.</p>
      */
     getAccountSettings(args: GetAccountSettingsCommandInput, options?: __HttpHandlerOptions): Promise<GetAccountSettingsCommandOutput>;
     getAccountSettings(args: GetAccountSettingsCommandInput, cb: (err: any, data?: GetAccountSettingsCommandOutput) => void): void;
     getAccountSettings(args: GetAccountSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccountSettingsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns statistical information about your OpenSearch Serverless access policies, security
      *             configurations, and security policies.</p>
      */
@@ -158,6 +174,7 @@ export declare class OpenSearchServerless extends OpenSearchServerlessClient {
     getPoliciesStats(args: GetPoliciesStatsCommandInput, cb: (err: any, data?: GetPoliciesStatsCommandOutput) => void): void;
     getPoliciesStats(args: GetPoliciesStatsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPoliciesStatsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns information about an OpenSearch Serverless security configuration. For more information, see
      *                 <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html">SAML
      *                 authentication for Amazon OpenSearch Serverless</a>.</p>
@@ -166,6 +183,7 @@ export declare class OpenSearchServerless extends OpenSearchServerlessClient {
     getSecurityConfig(args: GetSecurityConfigCommandInput, cb: (err: any, data?: GetSecurityConfigCommandOutput) => void): void;
     getSecurityConfig(args: GetSecurityConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSecurityConfigCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns information about a configured OpenSearch Serverless security policy. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-network.html">Network access
      *             for Amazon OpenSearch Serverless</a> and <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-encryption.html">Encryption at
      *                 rest for Amazon OpenSearch Serverless</a>.</p>
@@ -174,16 +192,18 @@ export declare class OpenSearchServerless extends OpenSearchServerlessClient {
     getSecurityPolicy(args: GetSecurityPolicyCommandInput, cb: (err: any, data?: GetSecurityPolicyCommandOutput) => void): void;
     getSecurityPolicy(args: GetSecurityPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSecurityPolicyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns information about a list of OpenSearch Serverless access policies.</p>
      */
     listAccessPolicies(args: ListAccessPoliciesCommandInput, options?: __HttpHandlerOptions): Promise<ListAccessPoliciesCommandOutput>;
     listAccessPolicies(args: ListAccessPoliciesCommandInput, cb: (err: any, data?: ListAccessPoliciesCommandOutput) => void): void;
     listAccessPolicies(args: ListAccessPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccessPoliciesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists all OpenSearch Serverless collections. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html">Creating and
      *                 managing Amazon OpenSearch Serverless collections</a>.</p>
      *         <note>
-     *             <p>Make sure to include an empty request body {} if you don't include any collection
+     *             <p>Make sure to include an empty request body \{\} if you don't include any collection
      *                 filters in the request.</p>
      *         </note>
      */
@@ -191,6 +211,7 @@ export declare class OpenSearchServerless extends OpenSearchServerlessClient {
     listCollections(args: ListCollectionsCommandInput, cb: (err: any, data?: ListCollectionsCommandOutput) => void): void;
     listCollections(args: ListCollectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCollectionsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns information about configured OpenSearch Serverless security configurations. For more information, see
      *             <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html">SAML
      *                 authentication for Amazon OpenSearch Serverless</a>.</p>
@@ -199,18 +220,21 @@ export declare class OpenSearchServerless extends OpenSearchServerlessClient {
     listSecurityConfigs(args: ListSecurityConfigsCommandInput, cb: (err: any, data?: ListSecurityConfigsCommandOutput) => void): void;
     listSecurityConfigs(args: ListSecurityConfigsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSecurityConfigsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns information about configured OpenSearch Serverless security policies.</p>
      */
     listSecurityPolicies(args: ListSecurityPoliciesCommandInput, options?: __HttpHandlerOptions): Promise<ListSecurityPoliciesCommandOutput>;
     listSecurityPolicies(args: ListSecurityPoliciesCommandInput, cb: (err: any, data?: ListSecurityPoliciesCommandOutput) => void): void;
     listSecurityPolicies(args: ListSecurityPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSecurityPoliciesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns the tags for an OpenSearch Serverless resource. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-collection.html">Tagging Amazon OpenSearch Serverless collections</a>.</p>
      */
     listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
     listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
     listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current
      *             account. For more information, see
      *             <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html">Access Amazon OpenSearch Serverless using an interface endpoint</a>.</p>
@@ -219,18 +243,21 @@ export declare class OpenSearchServerless extends OpenSearchServerlessClient {
     listVpcEndpoints(args: ListVpcEndpointsCommandInput, cb: (err: any, data?: ListVpcEndpointsCommandOutput) => void): void;
     listVpcEndpoints(args: ListVpcEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVpcEndpointsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Associates tags with an OpenSearch Serverless resource. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-collection.html">Tagging Amazon OpenSearch Serverless collections</a>.</p>
      */
     tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
     tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
     tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Removes a tag or set of tags from an OpenSearch Serverless resource. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-collection.html">Tagging Amazon OpenSearch Serverless collections</a>.</p>
      */
     untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
     untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
     untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Updates an OpenSearch Serverless access policy. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html">Data
      *             access control for Amazon OpenSearch Serverless</a>.</p>
      */
@@ -238,6 +265,7 @@ export declare class OpenSearchServerless extends OpenSearchServerlessClient {
     updateAccessPolicy(args: UpdateAccessPolicyCommandInput, cb: (err: any, data?: UpdateAccessPolicyCommandOutput) => void): void;
     updateAccessPolicy(args: UpdateAccessPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAccessPolicyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Update the OpenSearch Serverless settings for the current Amazon Web Services account. For more
      *             information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-overview.html#serverless-scaling">Autoscaling</a>.</p>
      */
@@ -245,12 +273,14 @@ export declare class OpenSearchServerless extends OpenSearchServerlessClient {
     updateAccountSettings(args: UpdateAccountSettingsCommandInput, cb: (err: any, data?: UpdateAccountSettingsCommandOutput) => void): void;
     updateAccountSettings(args: UpdateAccountSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAccountSettingsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Updates an OpenSearch Serverless collection.</p>
      */
     updateCollection(args: UpdateCollectionCommandInput, options?: __HttpHandlerOptions): Promise<UpdateCollectionCommandOutput>;
     updateCollection(args: UpdateCollectionCommandInput, cb: (err: any, data?: UpdateCollectionCommandOutput) => void): void;
     updateCollection(args: UpdateCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCollectionCommandOutput) => void): void;
     /**
+     * @public
      * <p>Updates a security configuration for OpenSearch Serverless. For more information, see
      *             <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html">SAML
      *                 authentication for Amazon OpenSearch Serverless</a>.</p>
@@ -259,6 +289,7 @@ export declare class OpenSearchServerless extends OpenSearchServerlessClient {
     updateSecurityConfig(args: UpdateSecurityConfigCommandInput, cb: (err: any, data?: UpdateSecurityConfigCommandOutput) => void): void;
     updateSecurityConfig(args: UpdateSecurityConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSecurityConfigCommandOutput) => void): void;
     /**
+     * @public
      * <p>Updates an OpenSearch Serverless security policy. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-network.html">Network access
      *             for Amazon OpenSearch Serverless</a> and <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-encryption.html">Encryption at
      *                 rest for Amazon OpenSearch Serverless</a>.</p>
@@ -267,6 +298,7 @@ export declare class OpenSearchServerless extends OpenSearchServerlessClient {
     updateSecurityPolicy(args: UpdateSecurityPolicyCommandInput, cb: (err: any, data?: UpdateSecurityPolicyCommandOutput) => void): void;
     updateSecurityPolicy(args: UpdateSecurityPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSecurityPolicyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Updates an OpenSearch Serverless-managed interface endpoint. For more information, see
      *             <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html">Access Amazon OpenSearch Serverless using an interface endpoint</a>.</p>
      */

package/dist-types/OpenSearchServerlessClient.d.ts

@@ -39,15 +39,24 @@ import { UpdateSecurityConfigCommandInput, UpdateSecurityConfigCommandOutput } f
 import { UpdateSecurityPolicyCommandInput, UpdateSecurityPolicyCommandOutput } from "./commands/UpdateSecurityPolicyCommand";
 import { UpdateVpcEndpointCommandInput, UpdateVpcEndpointCommandOutput } from "./commands/UpdateVpcEndpointCommand";
 import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
+/**
+ * @public
+ */
 export type ServiceInputTypes = BatchGetCollectionCommandInput | BatchGetVpcEndpointCommandInput | CreateAccessPolicyCommandInput | CreateCollectionCommandInput | CreateSecurityConfigCommandInput | CreateSecurityPolicyCommandInput | CreateVpcEndpointCommandInput | DeleteAccessPolicyCommandInput | DeleteCollectionCommandInput | DeleteSecurityConfigCommandInput | DeleteSecurityPolicyCommandInput | DeleteVpcEndpointCommandInput | GetAccessPolicyCommandInput | GetAccountSettingsCommandInput | GetPoliciesStatsCommandInput | GetSecurityConfigCommandInput | GetSecurityPolicyCommandInput | ListAccessPoliciesCommandInput | ListCollectionsCommandInput | ListSecurityConfigsCommandInput | ListSecurityPoliciesCommandInput | ListTagsForResourceCommandInput | ListVpcEndpointsCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateAccessPolicyCommandInput | UpdateAccountSettingsCommandInput | UpdateCollectionCommandInput | UpdateSecurityConfigCommandInput | UpdateSecurityPolicyCommandInput | UpdateVpcEndpointCommandInput;
+/**
+ * @public
+ */
 export type ServiceOutputTypes = BatchGetCollectionCommandOutput | BatchGetVpcEndpointCommandOutput | CreateAccessPolicyCommandOutput | CreateCollectionCommandOutput | CreateSecurityConfigCommandOutput | CreateSecurityPolicyCommandOutput | CreateVpcEndpointCommandOutput | DeleteAccessPolicyCommandOutput | DeleteCollectionCommandOutput | DeleteSecurityConfigCommandOutput | DeleteSecurityPolicyCommandOutput | DeleteVpcEndpointCommandOutput | GetAccessPolicyCommandOutput | GetAccountSettingsCommandOutput | GetPoliciesStatsCommandOutput | GetSecurityConfigCommandOutput | GetSecurityPolicyCommandOutput | ListAccessPoliciesCommandOutput | ListCollectionsCommandOutput | ListSecurityConfigsCommandOutput | ListSecurityPoliciesCommandOutput | ListTagsForResourceCommandOutput | ListVpcEndpointsCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateAccessPolicyCommandOutput | UpdateAccountSettingsCommandOutput | UpdateCollectionCommandOutput | UpdateSecurityConfigCommandOutput | UpdateSecurityPolicyCommandOutput | UpdateVpcEndpointCommandOutput;
+/**
+ * @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
      */
@@ -137,23 +146,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 OpenSearchServerlessClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
 /**
- * The configuration interface of OpenSearchServerlessClient class constructor that set the region, credentials and other options.
+ * @public
+ *
+ *  The configuration interface of OpenSearchServerlessClient class constructor that set the region, credentials and other options.
  */
 export interface OpenSearchServerlessClientConfig extends OpenSearchServerlessClientConfigType {
 }
+/**
+ * @public
+ */
 type OpenSearchServerlessClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
 /**
- * The resolved configuration interface of OpenSearchServerlessClient class. This is resolved and normalized from the {@link OpenSearchServerlessClientConfig | constructor configuration interface}.
+ * @public
+ *
+ *  The resolved configuration interface of OpenSearchServerlessClient class. This is resolved and normalized from the {@link OpenSearchServerlessClientConfig | constructor configuration interface}.
  */
 export interface OpenSearchServerlessClientResolvedConfig extends OpenSearchServerlessClientResolvedConfigType {
 }
 /**
+ * @public
  * <p>Use the Amazon OpenSearch Serverless API to create, configure, and manage OpenSearch Serverless collections and
  *             security policies.</p>
  *         <p>OpenSearch Serverless is an on-demand, pre-provisioned serverless configuration for

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { BatchGetCollectionRequest, BatchGetCollectionResponse } from "../models/models_0";
 import { OpenSearchServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchServerlessClient";
 /**
+ * @public
+ *
  * The input for {@link BatchGetCollectionCommand}.
  */
 export interface BatchGetCollectionCommandInput extends BatchGetCollectionRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link BatchGetCollectionCommand}.
  */
 export interface BatchGetCollectionCommandOutput extends BatchGetCollectionResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Returns attributes for one or more collections, including the collection endpoint and
  *             the OpenSearch Dashboards endpoint. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html">Creating and
  *                 managing Amazon OpenSearch Serverless collections</a>.</p>
@@ -27,6 +32,8 @@ export interface BatchGetCollectionCommandOutput extends BatchGetCollectionRespo
  * const response = await client.send(command);
  * ```
  *
+ * @param BatchGetCollectionCommandInput - {@link BatchGetCollectionCommandInput}
+ * @returns {@link BatchGetCollectionCommandOutput}
  * @see {@link BatchGetCollectionCommandInput} for command's `input` shape.
  * @see {@link BatchGetCollectionCommandOutput} for command's `response` shape.
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
@@ -43,11 +50,20 @@ export interface BatchGetCollectionCommandOutput extends BatchGetCollectionRespo
 export declare class BatchGetCollectionCommand extends $Command<BatchGetCollectionCommandInput, BatchGetCollectionCommandOutput, OpenSearchServerlessClientResolvedConfig> {
     readonly input: BatchGetCollectionCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: BatchGetCollectionCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: OpenSearchServerlessClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchGetCollectionCommandInput, BatchGetCollectionCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { BatchGetVpcEndpointRequest, BatchGetVpcEndpointResponse } from "../models/models_0";
 import { OpenSearchServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchServerlessClient";
 /**
+ * @public
+ *
  * The input for {@link BatchGetVpcEndpointCommand}.
  */
 export interface BatchGetVpcEndpointCommandInput extends BatchGetVpcEndpointRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link BatchGetVpcEndpointCommand}.
  */
 export interface BatchGetVpcEndpointCommandOutput extends BatchGetVpcEndpointResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Returns attributes for one or more VPC endpoints associated with the current account.
  *             For more information, see
  *             <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html">Access Amazon OpenSearch Serverless using an interface endpoint</a>.</p>
@@ -27,6 +32,8 @@ export interface BatchGetVpcEndpointCommandOutput extends BatchGetVpcEndpointRes
  * const response = await client.send(command);
  * ```
  *
+ * @param BatchGetVpcEndpointCommandInput - {@link BatchGetVpcEndpointCommandInput}
+ * @returns {@link BatchGetVpcEndpointCommandOutput}
  * @see {@link BatchGetVpcEndpointCommandInput} for command's `input` shape.
  * @see {@link BatchGetVpcEndpointCommandOutput} for command's `response` shape.
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
@@ -43,11 +50,20 @@ export interface BatchGetVpcEndpointCommandOutput extends BatchGetVpcEndpointRes
 export declare class BatchGetVpcEndpointCommand extends $Command<BatchGetVpcEndpointCommandInput, BatchGetVpcEndpointCommandOutput, OpenSearchServerlessClientResolvedConfig> {
     readonly input: BatchGetVpcEndpointCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: BatchGetVpcEndpointCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: OpenSearchServerlessClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchGetVpcEndpointCommandInput, BatchGetVpcEndpointCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CreateAccessPolicyRequest, CreateAccessPolicyResponse } from "../models/models_0";
 import { OpenSearchServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchServerlessClient";
 /**
+ * @public
+ *
  * The input for {@link CreateAccessPolicyCommand}.
  */
 export interface CreateAccessPolicyCommandInput extends CreateAccessPolicyRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateAccessPolicyCommand}.
  */
 export interface CreateAccessPolicyCommandOutput extends CreateAccessPolicyResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates a data access policy for OpenSearch Serverless. Access policies limit access to collections
  *             and the resources within them, and allow a user to access that data irrespective of the
  *             access mechanism or network source. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html">Data access
@@ -28,6 +33,8 @@ export interface CreateAccessPolicyCommandOutput extends CreateAccessPolicyRespo
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateAccessPolicyCommandInput - {@link CreateAccessPolicyCommandInput}
+ * @returns {@link CreateAccessPolicyCommandOutput}
  * @see {@link CreateAccessPolicyCommandInput} for command's `input` shape.
  * @see {@link CreateAccessPolicyCommandOutput} for command's `response` shape.
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
@@ -49,11 +56,20 @@ export interface CreateAccessPolicyCommandOutput extends CreateAccessPolicyRespo
 export declare class CreateAccessPolicyCommand extends $Command<CreateAccessPolicyCommandInput, CreateAccessPolicyCommandOutput, OpenSearchServerlessClientResolvedConfig> {
     readonly input: CreateAccessPolicyCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateAccessPolicyCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: OpenSearchServerlessClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateAccessPolicyCommandInput, CreateAccessPolicyCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CreateCollectionRequest, CreateCollectionResponse } from "../models/models_0";
 import { OpenSearchServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchServerlessClient";
 /**
+ * @public
+ *
  * The input for {@link CreateCollectionCommand}.
  */
 export interface CreateCollectionCommandInput extends CreateCollectionRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateCollectionCommand}.
  */
 export interface CreateCollectionCommandOutput extends CreateCollectionResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates a new OpenSearch Serverless collection. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html">Creating and
  *                 managing Amazon OpenSearch Serverless collections</a>.</p>
  * @example
@@ -26,6 +31,8 @@ export interface CreateCollectionCommandOutput extends CreateCollectionResponse,
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateCollectionCommandInput - {@link CreateCollectionCommandInput}
+ * @returns {@link CreateCollectionCommandOutput}
  * @see {@link CreateCollectionCommandInput} for command's `input` shape.
  * @see {@link CreateCollectionCommandOutput} for command's `response` shape.
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
@@ -47,11 +54,20 @@ export interface CreateCollectionCommandOutput extends CreateCollectionResponse,
 export declare class CreateCollectionCommand extends $Command<CreateCollectionCommandInput, CreateCollectionCommandOutput, OpenSearchServerlessClientResolvedConfig> {
     readonly input: CreateCollectionCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateCollectionCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: OpenSearchServerlessClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateCollectionCommandInput, CreateCollectionCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CreateSecurityConfigRequest, CreateSecurityConfigResponse } from "../models/models_0";
 import { OpenSearchServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchServerlessClient";
 /**
+ * @public
+ *
  * The input for {@link CreateSecurityConfigCommand}.
  */
 export interface CreateSecurityConfigCommandInput extends CreateSecurityConfigRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateSecurityConfigCommand}.
  */
 export interface CreateSecurityConfigCommandOutput extends CreateSecurityConfigResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Specifies a security configuration for OpenSearch Serverless. For more information, see
  *             <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html">SAML
  *                 authentication for Amazon OpenSearch Serverless</a>. </p>
@@ -27,6 +32,8 @@ export interface CreateSecurityConfigCommandOutput extends CreateSecurityConfigR
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateSecurityConfigCommandInput - {@link CreateSecurityConfigCommandInput}
+ * @returns {@link CreateSecurityConfigCommandOutput}
  * @see {@link CreateSecurityConfigCommandInput} for command's `input` shape.
  * @see {@link CreateSecurityConfigCommandOutput} for command's `response` shape.
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
@@ -48,11 +55,20 @@ export interface CreateSecurityConfigCommandOutput extends CreateSecurityConfigR
 export declare class CreateSecurityConfigCommand extends $Command<CreateSecurityConfigCommandInput, CreateSecurityConfigCommandOutput, OpenSearchServerlessClientResolvedConfig> {
     readonly input: CreateSecurityConfigCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateSecurityConfigCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: OpenSearchServerlessClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateSecurityConfigCommandInput, CreateSecurityConfigCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CreateSecurityPolicyRequest, CreateSecurityPolicyResponse } from "../models/models_0";
 import { OpenSearchServerlessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchServerlessClient";
 /**
+ * @public
+ *
  * The input for {@link CreateSecurityPolicyCommand}.
  */
 export interface CreateSecurityPolicyCommandInput extends CreateSecurityPolicyRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateSecurityPolicyCommand}.
  */
 export interface CreateSecurityPolicyCommandOutput extends CreateSecurityPolicyResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates a security policy to be used by one or more OpenSearch Serverless collections. Security
  *             policies provide access to a collection and its OpenSearch Dashboards endpoint from
  *             public networks or specific VPC endpoints. They also allow you to secure a collection
@@ -30,6 +35,8 @@ export interface CreateSecurityPolicyCommandOutput extends CreateSecurityPolicyR
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateSecurityPolicyCommandInput - {@link CreateSecurityPolicyCommandInput}
+ * @returns {@link CreateSecurityPolicyCommandOutput}
  * @see {@link CreateSecurityPolicyCommandInput} for command's `input` shape.
  * @see {@link CreateSecurityPolicyCommandOutput} for command's `response` shape.
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
@@ -51,11 +58,20 @@ export interface CreateSecurityPolicyCommandOutput extends CreateSecurityPolicyR
 export declare class CreateSecurityPolicyCommand extends $Command<CreateSecurityPolicyCommandInput, CreateSecurityPolicyCommandOutput, OpenSearchServerlessClientResolvedConfig> {
     readonly input: CreateSecurityPolicyCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateSecurityPolicyCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: OpenSearchServerlessClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateSecurityPolicyCommandInput, CreateSecurityPolicyCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }