@aws-sdk/client-opensearchserverless 3.378.0 → 3.382.0

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

@@ -34,23 +34,28 @@ export declare class ConflictException extends __BaseException {
  */
 export interface CreateAccessPolicyRequest {
     /**
+     * @public
      * <p>The type of policy.</p>
      */
     type: AccessPolicyType | string | undefined;
     /**
+     * @public
      * <p>The name of the policy.</p>
      */
     name: string | undefined;
     /**
+     * @public
      * <p>A description of the policy. Typically used to store information about the permissions
      *             defined in the policy.</p>
      */
     description?: string;
     /**
+     * @public
      * <p>The JSON policy document to use as the content for the policy.</p>
      */
     policy: string | undefined;
     /**
+     * @public
      * <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
      */
     clientToken?: string;
@@ -61,30 +66,37 @@ export interface CreateAccessPolicyRequest {
  */
 export interface AccessPolicyDetail {
     /**
+     * @public
      * <p>The type of access policy.</p>
      */
     type?: AccessPolicyType | string;
     /**
+     * @public
      * <p>The name of the policy.</p>
      */
     name?: string;
     /**
+     * @public
      * <p>The version of the policy.</p>
      */
     policyVersion?: string;
     /**
+     * @public
      * <p>The description of the policy.</p>
      */
     description?: string;
     /**
+     * @public
      * <p>The JSON policy document without any whitespaces.</p>
      */
     policy?: __DocumentType;
     /**
+     * @public
      * <p>The date the policy was created.</p>
      */
     createdDate?: number;
     /**
+     * @public
      * <p>The timestamp of when the policy was last modified.</p>
      */
     lastModifiedDate?: number;
@@ -94,6 +106,7 @@ export interface AccessPolicyDetail {
  */
 export interface CreateAccessPolicyResponse {
     /**
+     * @public
      * <p>Details about the created access policy.</p>
      */
     accessPolicyDetail?: AccessPolicyDetail;
@@ -118,18 +131,22 @@ export declare class ServiceQuotaExceededException extends __BaseException {
     readonly name: "ServiceQuotaExceededException";
     readonly $fault: "client";
     /**
+     * @public
      * Identifier of the resource affected.
      */
     resourceId?: string;
     /**
+     * @public
      * Type of the resource affected.
      */
     resourceType?: string;
     /**
+     * @public
      * Service Quotas requirement to identify originating service.
      */
     serviceCode: string | undefined;
     /**
+     * @public
      * Service Quotas requirement to identify originating quota.
      */
     quotaCode?: string;
@@ -156,14 +173,17 @@ export declare class ValidationException extends __BaseException {
  */
 export interface DeleteAccessPolicyRequest {
     /**
+     * @public
      * <p>The type of policy.</p>
      */
     type: AccessPolicyType | string | undefined;
     /**
+     * @public
      * <p>The name of the policy to delete.</p>
      */
     name: string | undefined;
     /**
+     * @public
      * <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
      */
     clientToken?: string;
@@ -190,10 +210,12 @@ export declare class ResourceNotFoundException extends __BaseException {
  */
 export interface GetAccessPolicyRequest {
     /**
+     * @public
      * <p>Tye type of policy. Currently the only supported value is <code>data</code>.</p>
      */
     type: AccessPolicyType | string | undefined;
     /**
+     * @public
      * <p>The name of the access policy.</p>
      */
     name: string | undefined;
@@ -203,6 +225,7 @@ export interface GetAccessPolicyRequest {
  */
 export interface GetAccessPolicyResponse {
     /**
+     * @public
      * <p>Details about the requested access policy.</p>
      */
     accessPolicyDetail?: AccessPolicyDetail;
@@ -212,14 +235,17 @@ export interface GetAccessPolicyResponse {
  */
 export interface ListAccessPoliciesRequest {
     /**
+     * @public
      * <p>The type of access policy.</p>
      */
     type: AccessPolicyType | string | undefined;
     /**
+     * @public
      * <p>Resource filters (can be collections or indexes) that policies can apply to.</p>
      */
     resource?: string[];
     /**
+     * @public
      * <p>If your initial <code>ListAccessPolicies</code> operation returns a
      *                 <code>nextToken</code>, you can include the returned <code>nextToken</code> in
      *             subsequent <code>ListAccessPolicies</code> operations, which returns results in the next
@@ -227,6 +253,7 @@ export interface ListAccessPoliciesRequest {
      */
     nextToken?: string;
     /**
+     * @public
      * <p>An optional parameter that specifies the maximum number of results to return. You can
      *             use <code>nextToken</code> to get the next page of results. The default is 20.</p>
      */
@@ -238,26 +265,32 @@ export interface ListAccessPoliciesRequest {
  */
 export interface AccessPolicySummary {
     /**
+     * @public
      * <p>The type of access policy. Currently the only available type is <code>data</code>.</p>
      */
     type?: AccessPolicyType | string;
     /**
+     * @public
      * <p>The name of the access policy.</p>
      */
     name?: string;
     /**
+     * @public
      * <p>The version of the policy.</p>
      */
     policyVersion?: string;
     /**
+     * @public
      * <p>The description of the access policy.</p>
      */
     description?: string;
     /**
+     * @public
      * <p>The Epoch time when the access policy was created.</p>
      */
     createdDate?: number;
     /**
+     * @public
      * <p>The date and time when the collection was last modified.</p>
      */
     lastModifiedDate?: number;
@@ -267,10 +300,12 @@ export interface AccessPolicySummary {
  */
 export interface ListAccessPoliciesResponse {
     /**
+     * @public
      * <p>Details about the requested access policies.</p>
      */
     accessPolicySummaries?: AccessPolicySummary[];
     /**
+     * @public
      * <p>When <code>nextToken</code> is returned, there are more results available. The value
      *             of <code>nextToken</code> is a unique pagination token for each page. Make the call
      *             again using the returned token to retrieve the next page.</p>
@@ -282,27 +317,33 @@ export interface ListAccessPoliciesResponse {
  */
 export interface UpdateAccessPolicyRequest {
     /**
+     * @public
      * <p>The type of policy.</p>
      */
     type: AccessPolicyType | string | undefined;
     /**
+     * @public
      * <p>The name of the policy.</p>
      */
     name: string | undefined;
     /**
+     * @public
      * <p>The version of the policy being updated.</p>
      */
     policyVersion: string | undefined;
     /**
+     * @public
      * <p>A description of the policy. Typically used to store information about the permissions
      *             defined in the policy.</p>
      */
     description?: string;
     /**
+     * @public
      * <p>The JSON policy document to use as the content for the policy.</p>
      */
     policy?: string;
     /**
+     * @public
      * <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
      */
     clientToken?: string;
@@ -312,6 +353,7 @@ export interface UpdateAccessPolicyRequest {
  */
 export interface UpdateAccessPolicyResponse {
     /**
+     * @public
      * <p>Details about the updated access policy.</p>
      */
     accessPolicyDetail?: AccessPolicyDetail;
@@ -322,6 +364,7 @@ export interface UpdateAccessPolicyResponse {
  */
 export interface AccessPolicyStats {
     /**
+     * @public
      * <p>The number of data access policies in the current account.</p>
      */
     DataPolicyCount?: number;
@@ -335,10 +378,12 @@ export interface AccessPolicyStats {
  */
 export interface CapacityLimits {
     /**
+     * @public
      * <p>The maximum indexing capacity for collections.</p>
      */
     maxIndexingCapacityInOCU?: number;
     /**
+     * @public
      * <p>The maximum search capacity for collections.</p>
      */
     maxSearchCapacityInOCU?: number;
@@ -349,6 +394,7 @@ export interface CapacityLimits {
  */
 export interface AccountSettingsDetail {
     /**
+     * @public
      * <p>The maximum capacity limits for all OpenSearch Serverless collections, in OpenSearch Compute Units
      *             (OCUs). These limits are used to scale your collections based on the current workload.
      *             For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-scaling.html">Managing
@@ -361,11 +407,13 @@ export interface AccountSettingsDetail {
  */
 export interface BatchGetCollectionRequest {
     /**
+     * @public
      * <p>A list of collection IDs. You can't provide names and IDs in the same request. The ID
      *             is part of the collection endpoint. You can also retrieve it using the <a href="https://docs.aws.amazon.com/opensearch-service/latest/ServerlessAPIReference/API_ListCollections.html">ListCollections</a> API.</p>
      */
     ids?: string[];
     /**
+     * @public
      * <p>A list of collection names. You can't provide names and IDs in the same request.</p>
      */
     names?: string[];
@@ -425,47 +473,58 @@ export type CollectionType = (typeof CollectionType)[keyof typeof CollectionType
  */
 export interface CollectionDetail {
     /**
+     * @public
      * <p>A unique identifier for the collection.</p>
      */
     id?: string;
     /**
+     * @public
      * <p>The name of the collection.</p>
      */
     name?: string;
     /**
+     * @public
      * <p>The current status of the collection.</p>
      */
     status?: CollectionStatus | string;
     /**
+     * @public
      * <p>The type of collection.</p>
      */
     type?: CollectionType | string;
     /**
+     * @public
      * <p>A description of the collection.</p>
      */
     description?: string;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the collection.</p>
      */
     arn?: string;
     /**
+     * @public
      * <p>The ARN of the Amazon Web Services KMS key used to encrypt the collection.</p>
      */
     kmsKeyArn?: string;
     /**
+     * @public
      * <p>The Epoch time when the collection was created.</p>
      */
     createdDate?: number;
     /**
+     * @public
      * <p>The date and time when the collection was last modified.</p>
      */
     lastModifiedDate?: number;
     /**
+     * @public
      * <p>Collection-specific endpoint used to submit index, search, and data upload requests to
      *             an OpenSearch Serverless collection.</p>
      */
     collectionEndpoint?: string;
     /**
+     * @public
      * <p>Collection-specific endpoint used to access OpenSearch Dashboards.</p>
      */
     dashboardEndpoint?: string;
@@ -476,22 +535,26 @@ export interface CollectionDetail {
  */
 export interface CollectionErrorDetail {
     /**
+     * @public
      * <p>If the request contains collection IDs, the response includes the IDs provided in the
      *             request.</p>
      */
     id?: string;
     /**
+     * @public
      * <p>If the request contains collection names, the response includes the names provided in
      *             the request.</p>
      */
     name?: string;
     /**
+     * @public
      * <p>A description of the error. For example, <code>The specified Collection is not
      *                 found.</code>
      *          </p>
      */
     errorMessage?: string;
     /**
+     * @public
      * <p>The error code for the request. For example, <code>NOT_FOUND</code>.</p>
      */
     errorCode?: string;
@@ -501,10 +564,12 @@ export interface CollectionErrorDetail {
  */
 export interface BatchGetCollectionResponse {
     /**
+     * @public
      * <p>Details about each collection.</p>
      */
     collectionDetails?: CollectionDetail[];
     /**
+     * @public
      * <p>Error information for the request.</p>
      */
     collectionErrorDetails?: CollectionErrorDetail[];
@@ -514,6 +579,7 @@ export interface BatchGetCollectionResponse {
  */
 export interface BatchGetVpcEndpointRequest {
     /**
+     * @public
      * <p>A list of VPC endpoint identifiers.</p>
      */
     ids: string[] | undefined;
@@ -550,31 +616,38 @@ export type VpcEndpointStatus = (typeof VpcEndpointStatus)[keyof typeof VpcEndpo
  */
 export interface VpcEndpointDetail {
     /**
+     * @public
      * <p>The unique identifier of the endpoint.</p>
      */
     id?: string;
     /**
+     * @public
      * <p>The name of the endpoint.</p>
      */
     name?: string;
     /**
+     * @public
      * <p>The ID of the VPC from which you access OpenSearch Serverless.</p>
      */
     vpcId?: string;
     /**
+     * @public
      * <p>The ID of the subnets from which you access OpenSearch Serverless.</p>
      */
     subnetIds?: string[];
     /**
+     * @public
      * <p>The unique identifiers of the security groups that define the ports, protocols, and
      *             sources for inbound traffic that you are authorizing into your endpoint.</p>
      */
     securityGroupIds?: string[];
     /**
+     * @public
      * <p>The current status of the endpoint.</p>
      */
     status?: VpcEndpointStatus | string;
     /**
+     * @public
      * <p>The date the endpoint was created.</p>
      */
     createdDate?: number;
@@ -585,14 +658,17 @@ export interface VpcEndpointDetail {
  */
 export interface VpcEndpointErrorDetail {
     /**
+     * @public
      * <p>The unique identifier of the VPC endpoint.</p>
      */
     id?: string;
     /**
+     * @public
      * <p>An error message describing the reason for the failure.</p>
      */
     errorMessage?: string;
     /**
+     * @public
      * <p>The error code for the failed request.</p>
      */
     errorCode?: string;
@@ -602,10 +678,12 @@ export interface VpcEndpointErrorDetail {
  */
 export interface BatchGetVpcEndpointResponse {
     /**
+     * @public
      * <p>Details about the specified VPC endpoint.</p>
      */
     vpcEndpointDetails?: VpcEndpointDetail[];
     /**
+     * @public
      * <p>Error information for a failed request.</p>
      */
     vpcEndpointErrorDetails?: VpcEndpointErrorDetail[];
@@ -616,10 +694,12 @@ export interface BatchGetVpcEndpointResponse {
  */
 export interface Tag {
     /**
+     * @public
      * <p>The key to use in the tag.</p>
      */
     key: string | undefined;
     /**
+     * @public
      * <p>The value of the tag.</p>
      */
     value: string | undefined;
@@ -629,22 +709,27 @@ export interface Tag {
  */
 export interface CreateCollectionRequest {
     /**
+     * @public
      * <p>Name of the collection.</p>
      */
     name: string | undefined;
     /**
+     * @public
      * <p>The type of collection.</p>
      */
     type?: CollectionType | string;
     /**
+     * @public
      * <p>Description of the collection.</p>
      */
     description?: string;
     /**
+     * @public
      * <p>An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.</p>
      */
     tags?: Tag[];
     /**
+     * @public
      * <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
      */
     clientToken?: string;
@@ -655,38 +740,47 @@ export interface CreateCollectionRequest {
  */
 export interface CreateCollectionDetail {
     /**
+     * @public
      * <p>The unique identifier of the collection.</p>
      */
     id?: string;
     /**
+     * @public
      * <p>The name of the collection.</p>
      */
     name?: string;
     /**
+     * @public
      * <p>The current status of the collection.</p>
      */
     status?: CollectionStatus | string;
     /**
+     * @public
      * <p>The type of collection.</p>
      */
     type?: CollectionType | string;
     /**
+     * @public
      * <p>A description of the collection.</p>
      */
     description?: string;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the collection.</p>
      */
     arn?: string;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the KMS key with which to encrypt the collection.</p>
      */
     kmsKeyArn?: string;
     /**
+     * @public
      * <p>The Epoch time when the collection was created.</p>
      */
     createdDate?: number;
     /**
+     * @public
      * <p>The date and time when the collection was last modified.</p>
      */
     lastModifiedDate?: number;
@@ -696,6 +790,7 @@ export interface CreateCollectionDetail {
  */
 export interface CreateCollectionResponse {
     /**
+     * @public
      * <p>Details about the collection.</p>
      */
     createCollectionDetail?: CreateCollectionDetail;
@@ -717,11 +812,13 @@ export declare class OcuLimitExceededException extends __BaseException {
  */
 export interface DeleteCollectionRequest {
     /**
+     * @public
      * <p>The unique identifier of the collection. For example, <code>1iu5usc406kd</code>. The
      *             ID is part of the collection endpoint. You can also retrieve it using the <a href="https://docs.aws.amazon.com/opensearch-service/latest/ServerlessAPIReference/API_ListCollections.html">ListCollections</a> API.</p>
      */
     id: string | undefined;
     /**
+     * @public
      * <p>A unique, case-sensitive identifier to ensure idempotency of the request.</p>
      */
     clientToken?: string;
@@ -732,14 +829,17 @@ export interface DeleteCollectionRequest {
  */
 export interface DeleteCollectionDetail {
     /**
+     * @public
      * <p>The unique identifier of the collection.</p>
      */
     id?: string;
     /**
+     * @public
      * <p>The name of the collection.</p>
      */
     name?: string;
     /**
+     * @public
      * <p>The current status of the collection.</p>
      */
     status?: CollectionStatus | string;
@@ -749,6 +849,7 @@ export interface DeleteCollectionDetail {
  */
 export interface DeleteCollectionResponse {
     /**
+     * @public
      * <p>Details of the deleted collection.</p>
      */
     deleteCollectionDetail?: DeleteCollectionDetail;
@@ -760,10 +861,12 @@ export interface DeleteCollectionResponse {
  */
 export interface CollectionFilters {
     /**
+     * @public
      * <p>The name of the collection.</p>
      */
     name?: string;
     /**
+     * @public
      * <p>The current status of the collection.</p>
      */
     status?: CollectionStatus | string;
@@ -773,16 +876,19 @@ export interface CollectionFilters {
  */
 export interface ListCollectionsRequest {
     /**
+     * @public
      * <p>List of filter names and values that you can use for requests.</p>
      */
     collectionFilters?: CollectionFilters;
     /**
+     * @public
      * <p>If your initial <code>ListCollections</code> operation returns a <code>nextToken</code>,
      *             you can include the returned <code>nextToken</code> in subsequent <code>ListCollections</code> operations,
      *             which returns results in the next page.</p>
      */
     nextToken?: string;
     /**
+     * @public
      * <p>The maximum number of results to return. Default is 20. You can use
      *                 <code>nextToken</code> to get the next page of results.</p>
      */
@@ -794,18 +900,22 @@ export interface ListCollectionsRequest {
  */
 export interface CollectionSummary {
     /**
+     * @public
      * <p>The unique identifier of the collection.</p>
      */
     id?: string;
     /**
+     * @public
      * <p>The name of the collection.</p>
      */
     name?: string;
     /**
+     * @public
      * <p>The current status of the collection.</p>
      */
     status?: CollectionStatus | string;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the collection.</p>
      */
     arn?: string;
@@ -815,10 +925,12 @@ export interface CollectionSummary {
  */
 export interface ListCollectionsResponse {
     /**
+     * @public
      * <p>Details about each collection.</p>
      */
     collectionSummaries?: CollectionSummary[];
     /**
+     * @public
      * <p>When <code>nextToken</code> is returned, there are more results available.
      *             The value of <code>nextToken</code> is a unique pagination token for each page.
      *             Make the call again using the returned token to retrieve the next page.</p>
@@ -830,14 +942,17 @@ export interface ListCollectionsResponse {
  */
 export interface UpdateCollectionRequest {
     /**
+     * @public
      * <p>The unique identifier of the collection.</p>
      */
     id: string | undefined;
     /**
+     * @public
      * <p>A description of the collection.</p>
      */
     description?: string;
     /**
+     * @public
      * <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
      */
     clientToken?: string;
@@ -848,34 +963,42 @@ export interface UpdateCollectionRequest {
  */
 export interface UpdateCollectionDetail {
     /**
+     * @public
      * <p>The unique identifier of the collection.</p>
      */
     id?: string;
     /**
+     * @public
      * <p>The name of the collection.</p>
      */
     name?: string;
     /**
+     * @public
      * <p>The current status of the collection.</p>
      */
     status?: CollectionStatus | string;
     /**
+     * @public
      * <p>The collection type.</p>
      */
     type?: CollectionType | string;
     /**
+     * @public
      * <p>The description of the collection.</p>
      */
     description?: string;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the collection.</p>
      */
     arn?: string;
     /**
+     * @public
      * <p>The date and time when the collection was created.</p>
      */
     createdDate?: number;
     /**
+     * @public
      * <p>The date and time when the collection was last modified.</p>
      */
     lastModifiedDate?: number;
@@ -885,6 +1008,7 @@ export interface UpdateCollectionDetail {
  */
 export interface UpdateCollectionResponse {
     /**
+     * @public
      * <p>Details about the updated collection.</p>
      */
     updateCollectionDetail?: UpdateCollectionDetail;
@@ -896,18 +1020,22 @@ export interface UpdateCollectionResponse {
  */
 export interface SamlConfigOptions {
     /**
+     * @public
      * <p>The XML IdP metadata file generated from your identity provider.</p>
      */
     metadata: string | undefined;
     /**
+     * @public
      * <p>A user attribute for this SAML integration.</p>
      */
     userAttribute?: string;
     /**
+     * @public
      * <p>The group attribute for this SAML integration.</p>
      */
     groupAttribute?: string;
     /**
+     * @public
      * <p>The session timeout, in minutes. Default is 60 minutes (12 hours).</p>
      */
     sessionTimeout?: number;
@@ -931,23 +1059,28 @@ export type SecurityConfigType = (typeof SecurityConfigType)[keyof typeof Securi
  */
 export interface CreateSecurityConfigRequest {
     /**
+     * @public
      * <p>The type of security configuration.</p>
      */
     type: SecurityConfigType | string | undefined;
     /**
+     * @public
      * <p>The name of the security configuration.</p>
      */
     name: string | undefined;
     /**
+     * @public
      * <p>A description of the security configuration.</p>
      */
     description?: string;
     /**
+     * @public
      * <p>Describes SAML options in in the form of a key-value map. This field is required if
      *             you specify <code>saml</code> for the <code>type</code> parameter.</p>
      */
     samlOptions?: SamlConfigOptions;
     /**
+     * @public
      * <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
      */
     clientToken?: string;
@@ -958,30 +1091,37 @@ export interface CreateSecurityConfigRequest {
  */
 export interface SecurityConfigDetail {
     /**
+     * @public
      * <p>The unique identifier of the security configuration.</p>
      */
     id?: string;
     /**
+     * @public
      * <p>The type of security configuration.</p>
      */
     type?: SecurityConfigType | string;
     /**
+     * @public
      * <p>The version of the security configuration.</p>
      */
     configVersion?: string;
     /**
+     * @public
      * <p>The description of the security configuration.</p>
      */
     description?: string;
     /**
+     * @public
      * <p>SAML options for the security configuration in the form of a key-value map.</p>
      */
     samlOptions?: SamlConfigOptions;
     /**
+     * @public
      * <p>The date the configuration was created.</p>
      */
     createdDate?: number;
     /**
+     * @public
      * <p>The timestamp of when the configuration was last modified.</p>
      */
     lastModifiedDate?: number;
@@ -991,6 +1131,7 @@ export interface SecurityConfigDetail {
  */
 export interface CreateSecurityConfigResponse {
     /**
+     * @public
      * <p>Details about the created security configuration. </p>
      */
     securityConfigDetail?: SecurityConfigDetail;
@@ -1018,23 +1159,28 @@ export type SecurityPolicyType = (typeof SecurityPolicyType)[keyof typeof Securi
  */
 export interface CreateSecurityPolicyRequest {
     /**
+     * @public
      * <p>The type of security policy.</p>
      */
     type: SecurityPolicyType | string | undefined;
     /**
+     * @public
      * <p>The name of the policy.</p>
      */
     name: string | undefined;
     /**
+     * @public
      * <p>A description of the policy. Typically used to store information about the permissions
      *             defined in the policy.</p>
      */
     description?: string;
     /**
+     * @public
      * <p>The JSON policy document to use as the content for the new policy.</p>
      */
     policy: string | undefined;
     /**
+     * @public
      * <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
      */
     clientToken?: string;
@@ -1045,30 +1191,37 @@ export interface CreateSecurityPolicyRequest {
  */
 export interface SecurityPolicyDetail {
     /**
+     * @public
      * <p>The type of security policy.</p>
      */
     type?: SecurityPolicyType | string;
     /**
+     * @public
      * <p>The name of the policy.</p>
      */
     name?: string;
     /**
+     * @public
      * <p>The version of the policy.</p>
      */
     policyVersion?: string;
     /**
+     * @public
      * <p>The description of the security policy.</p>
      */
     description?: string;
     /**
+     * @public
      * <p>The JSON policy document without any whitespaces.</p>
      */
     policy?: __DocumentType;
     /**
+     * @public
      * <p>The date the policy was created.</p>
      */
     createdDate?: number;
     /**
+     * @public
      * <p>The timestamp of when the policy was last modified.</p>
      */
     lastModifiedDate?: number;
@@ -1078,6 +1231,7 @@ export interface SecurityPolicyDetail {
  */
 export interface CreateSecurityPolicyResponse {
     /**
+     * @public
      * <p>Details about the created security policy.</p>
      */
     securityPolicyDetail?: SecurityPolicyDetail;
@@ -1087,23 +1241,28 @@ export interface CreateSecurityPolicyResponse {
  */
 export interface CreateVpcEndpointRequest {
     /**
+     * @public
      * <p>The name of the interface endpoint.</p>
      */
     name: string | undefined;
     /**
+     * @public
      * <p>The ID of the VPC from which you'll access OpenSearch Serverless.</p>
      */
     vpcId: string | undefined;
     /**
+     * @public
      * <p>The ID of one or more subnets from which you'll access OpenSearch Serverless.</p>
      */
     subnetIds: string[] | undefined;
     /**
+     * @public
      * <p>The unique identifiers of the security groups that define the ports, protocols, and
      *             sources for inbound traffic that you are authorizing into your endpoint.</p>
      */
     securityGroupIds?: string[];
     /**
+     * @public
      * <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
      */
     clientToken?: string;
@@ -1115,14 +1274,17 @@ export interface CreateVpcEndpointRequest {
  */
 export interface CreateVpcEndpointDetail {
     /**
+     * @public
      * <p>The unique identifier of the endpoint.</p>
      */
     id?: string;
     /**
+     * @public
      * <p>The name of the endpoint.</p>
      */
     name?: string;
     /**
+     * @public
      * <p>The current status in the endpoint creation process.</p>
      */
     status?: VpcEndpointStatus | string;
@@ -1132,6 +1294,7 @@ export interface CreateVpcEndpointDetail {
  */
 export interface CreateVpcEndpointResponse {
     /**
+     * @public
      * <p>Details about the created interface VPC endpoint.</p>
      */
     createVpcEndpointDetail?: CreateVpcEndpointDetail;
@@ -1141,12 +1304,14 @@ export interface CreateVpcEndpointResponse {
  */
 export interface DeleteSecurityConfigRequest {
     /**
+     * @public
      * <p>The security configuration identifier. For SAML the ID will be
      *                 <code>saml/&lt;accountId&gt;/&lt;idpProviderName&gt;</code>. For example,
      *                 <code>saml/123456789123/OKTADev</code>.</p>
      */
     id: string | undefined;
     /**
+     * @public
      * <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
      */
     clientToken?: string;
@@ -1161,14 +1326,17 @@ export interface DeleteSecurityConfigResponse {
  */
 export interface DeleteSecurityPolicyRequest {
     /**
+     * @public
      * <p>The type of policy.</p>
      */
     type: SecurityPolicyType | string | undefined;
     /**
+     * @public
      * <p>The name of the policy to delete.</p>
      */
     name: string | undefined;
     /**
+     * @public
      * <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
      */
     clientToken?: string;
@@ -1183,10 +1351,12 @@ export interface DeleteSecurityPolicyResponse {
  */
 export interface DeleteVpcEndpointRequest {
     /**
+     * @public
      * <p>The VPC endpoint identifier.</p>
      */
     id: string | undefined;
     /**
+     * @public
      * <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
      */
     clientToken?: string;
@@ -1197,14 +1367,17 @@ export interface DeleteVpcEndpointRequest {
  */
 export interface DeleteVpcEndpointDetail {
     /**
+     * @public
      * <p>The unique identifier of the endpoint.</p>
      */
     id?: string;
     /**
+     * @public
      * <p>The name of the endpoint.</p>
      */
     name?: string;
     /**
+     * @public
      * <p>The current status of the endpoint deletion process.</p>
      */
     status?: VpcEndpointStatus | string;
@@ -1214,6 +1387,7 @@ export interface DeleteVpcEndpointDetail {
  */
 export interface DeleteVpcEndpointResponse {
     /**
+     * @public
      * <p>Details about the deleted endpoint.</p>
      */
     deleteVpcEndpointDetail?: DeleteVpcEndpointDetail;
@@ -1228,6 +1402,7 @@ export interface GetAccountSettingsRequest {
  */
 export interface GetAccountSettingsResponse {
     /**
+     * @public
      * <p>OpenSearch Serverless-related details for the current account.</p>
      */
     accountSettingsDetail?: AccountSettingsDetail;
@@ -1243,6 +1418,7 @@ export interface GetPoliciesStatsRequest {
  */
 export interface SecurityConfigStats {
     /**
+     * @public
      * <p>The number of security configurations in the current account.</p>
      */
     SamlConfigCount?: number;
@@ -1253,10 +1429,12 @@ export interface SecurityConfigStats {
  */
 export interface SecurityPolicyStats {
     /**
+     * @public
      * <p>The number of encryption policies in the current account.</p>
      */
     EncryptionPolicyCount?: number;
     /**
+     * @public
      * <p>The number of network policies in the current account.</p>
      */
     NetworkPolicyCount?: number;
@@ -1266,18 +1444,22 @@ export interface SecurityPolicyStats {
  */
 export interface GetPoliciesStatsResponse {
     /**
+     * @public
      * <p>Information about the data access policies in your account.</p>
      */
     AccessPolicyStats?: AccessPolicyStats;
     /**
+     * @public
      * <p>Information about the security policies in your account.</p>
      */
     SecurityPolicyStats?: SecurityPolicyStats;
     /**
+     * @public
      * <p>Information about the security configurations in your account.</p>
      */
     SecurityConfigStats?: SecurityConfigStats;
     /**
+     * @public
      * <p>The total number of OpenSearch Serverless security policies and configurations in your
      *             account.</p>
      */
@@ -1288,6 +1470,7 @@ export interface GetPoliciesStatsResponse {
  */
 export interface GetSecurityConfigRequest {
     /**
+     * @public
      * <p>The unique identifier of the security configuration.</p>
      */
     id: string | undefined;
@@ -1297,6 +1480,7 @@ export interface GetSecurityConfigRequest {
  */
 export interface GetSecurityConfigResponse {
     /**
+     * @public
      * <p>Details of the requested security configuration.</p>
      */
     securityConfigDetail?: SecurityConfigDetail;
@@ -1306,10 +1490,12 @@ export interface GetSecurityConfigResponse {
  */
 export interface GetSecurityPolicyRequest {
     /**
+     * @public
      * <p>The type of security policy.</p>
      */
     type: SecurityPolicyType | string | undefined;
     /**
+     * @public
      * <p>The name of the security policy.</p>
      */
     name: string | undefined;
@@ -1319,6 +1505,7 @@ export interface GetSecurityPolicyRequest {
  */
 export interface GetSecurityPolicyResponse {
     /**
+     * @public
      * <p>Details about the requested security policy.</p>
      */
     securityPolicyDetail?: SecurityPolicyDetail;
@@ -1328,10 +1515,12 @@ export interface GetSecurityPolicyResponse {
  */
 export interface ListSecurityConfigsRequest {
     /**
+     * @public
      * <p>The type of security configuration.</p>
      */
     type: SecurityConfigType | string | undefined;
     /**
+     * @public
      * <p>If your initial <code>ListSecurityConfigs</code> operation returns a
      *                 <code>nextToken</code>, you can include the returned <code>nextToken</code> in
      *             subsequent <code>ListSecurityConfigs</code> operations, which returns results in the
@@ -1339,6 +1528,7 @@ export interface ListSecurityConfigsRequest {
      */
     nextToken?: string;
     /**
+     * @public
      * <p>An optional parameter that specifies the maximum number of results to return. You can
      *             use <code>nextToken</code> to get the next page of results. The default is 20.</p>
      */
@@ -1350,26 +1540,32 @@ export interface ListSecurityConfigsRequest {
  */
 export interface SecurityConfigSummary {
     /**
+     * @public
      * <p>The unique identifier of the security configuration.</p>
      */
     id?: string;
     /**
+     * @public
      * <p>The type of security configuration.</p>
      */
     type?: SecurityConfigType | string;
     /**
+     * @public
      * <p>The version of the security configuration.</p>
      */
     configVersion?: string;
     /**
+     * @public
      * <p>The description of the security configuration.</p>
      */
     description?: string;
     /**
+     * @public
      * <p>The Epoch time when the security configuration was created.</p>
      */
     createdDate?: number;
     /**
+     * @public
      * <p>The timestamp of when the configuration was last modified.</p>
      */
     lastModifiedDate?: number;
@@ -1379,10 +1575,12 @@ export interface SecurityConfigSummary {
  */
 export interface ListSecurityConfigsResponse {
     /**
+     * @public
      * <p>Details about the security configurations in your account.</p>
      */
     securityConfigSummaries?: SecurityConfigSummary[];
     /**
+     * @public
      * <p>When <code>nextToken</code> is returned, there are more results available. The value
      *             of <code>nextToken</code> is a unique pagination token for each page. Make the call
      *             again using the returned token to retrieve the next page.</p>
@@ -1394,14 +1592,17 @@ export interface ListSecurityConfigsResponse {
  */
 export interface ListSecurityPoliciesRequest {
     /**
+     * @public
      * <p>The type of policy.</p>
      */
     type: SecurityPolicyType | string | undefined;
     /**
+     * @public
      * <p>Resource filters (can be collection or indexes) that policies can apply to. </p>
      */
     resource?: string[];
     /**
+     * @public
      * <p>If your initial <code>ListSecurityPolicies</code> operation returns a
      *                 <code>nextToken</code>, you can include the returned <code>nextToken</code> in
      *             subsequent <code>ListSecurityPolicies</code> operations, which returns results in the
@@ -1409,6 +1610,7 @@ export interface ListSecurityPoliciesRequest {
      */
     nextToken?: string;
     /**
+     * @public
      * <p>An optional parameter that specifies the maximum number of results to return. You can
      *             use <code>nextToken</code> to get the next page of results. The default is 20.</p>
      */
@@ -1420,26 +1622,32 @@ export interface ListSecurityPoliciesRequest {
  */
 export interface SecurityPolicySummary {
     /**
+     * @public
      * <p>The type of security policy.</p>
      */
     type?: SecurityPolicyType | string;
     /**
+     * @public
      * <p>The name of the policy.</p>
      */
     name?: string;
     /**
+     * @public
      * <p>The version of the policy.</p>
      */
     policyVersion?: string;
     /**
+     * @public
      * <p>The description of the security policy.</p>
      */
     description?: string;
     /**
+     * @public
      * <p>The date the policy was created.</p>
      */
     createdDate?: number;
     /**
+     * @public
      * <p>The timestamp of when the policy was last modified.</p>
      */
     lastModifiedDate?: number;
@@ -1449,10 +1657,12 @@ export interface SecurityPolicySummary {
  */
 export interface ListSecurityPoliciesResponse {
     /**
+     * @public
      * <p>Details about the security policies in your account.</p>
      */
     securityPolicySummaries?: SecurityPolicySummary[];
     /**
+     * @public
      * <p>When <code>nextToken</code> is returned, there are more results available. The value
      *             of <code>nextToken</code> is a unique pagination token for each page. Make the call
      *             again using the returned token to retrieve the next page.</p>
@@ -1464,6 +1674,7 @@ export interface ListSecurityPoliciesResponse {
  */
 export interface ListTagsForResourceRequest {
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the resource. The resource must be active (not in
      *             the <code>DELETING</code> state), and must be owned by the account ID included in the
      *             request.</p>
@@ -1475,6 +1686,7 @@ export interface ListTagsForResourceRequest {
  */
 export interface ListTagsForResourceResponse {
     /**
+     * @public
      * <p>The tags associated with the resource.</p>
      */
     tags?: Tag[];
@@ -1485,6 +1697,7 @@ export interface ListTagsForResourceResponse {
  */
 export interface VpcEndpointFilters {
     /**
+     * @public
      * <p>The current status of the endpoint.</p>
      */
     status?: VpcEndpointStatus | string;
@@ -1494,12 +1707,14 @@ export interface VpcEndpointFilters {
  */
 export interface ListVpcEndpointsRequest {
     /**
+     * @public
      * <p>Filter the results according to the current status of the VPC endpoint. Possible
      *             statuses are <code>CREATING</code>, <code>DELETING</code>, <code>UPDATING</code>,
      *                 <code>ACTIVE</code>, and <code>FAILED</code>.</p>
      */
     vpcEndpointFilters?: VpcEndpointFilters;
     /**
+     * @public
      * <p>If your initial <code>ListVpcEndpoints</code> operation returns a
      *                 <code>nextToken</code>, you can include the returned <code>nextToken</code> in
      *             subsequent <code>ListVpcEndpoints</code> operations, which returns results in the next
@@ -1507,6 +1722,7 @@ export interface ListVpcEndpointsRequest {
      */
     nextToken?: string;
     /**
+     * @public
      * <p>An optional parameter that specifies the maximum number of results to return. You can
      *             use <code>nextToken</code> to get the next page of results. The default is 20.</p>
      */
@@ -1518,14 +1734,17 @@ export interface ListVpcEndpointsRequest {
  */
 export interface VpcEndpointSummary {
     /**
+     * @public
      * <p>The unique identifier of the endpoint.</p>
      */
     id?: string;
     /**
+     * @public
      * <p>The name of the endpoint.</p>
      */
     name?: string;
     /**
+     * @public
      * <p>The current status of the endpoint.</p>
      */
     status?: VpcEndpointStatus | string;
@@ -1535,10 +1754,12 @@ export interface VpcEndpointSummary {
  */
 export interface ListVpcEndpointsResponse {
     /**
+     * @public
      * <p>Details about each VPC endpoint, including the name and current status.</p>
      */
     vpcEndpointSummaries?: VpcEndpointSummary[];
     /**
+     * @public
      * <p>When <code>nextToken</code> is returned, there are more results available. The value
      *             of <code>nextToken</code> is a unique pagination token for each page. Make the call
      *             again using the returned token to retrieve the next page.</p>
@@ -1550,26 +1771,31 @@ export interface ListVpcEndpointsResponse {
  */
 export interface UpdateSecurityConfigRequest {
     /**
+     * @public
      * <p>The security configuration identifier. For SAML the ID will be
      *                 <code>saml/&lt;accountId&gt;/&lt;idpProviderName&gt;</code>. For example,
      *                 <code>saml/123456789123/OKTADev</code>.</p>
      */
     id: string | undefined;
     /**
+     * @public
      * <p>The version of the security configuration to be updated. You can find the most recent
      *             version of a security configuration using the <code>GetSecurityPolicy</code>
      *             command.</p>
      */
     configVersion: string | undefined;
     /**
+     * @public
      * <p>A description of the security configuration.</p>
      */
     description?: string;
     /**
+     * @public
      * <p>SAML options in in the form of a key-value map.</p>
      */
     samlOptions?: SamlConfigOptions;
     /**
+     * @public
      * <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
      */
     clientToken?: string;
@@ -1579,6 +1805,7 @@ export interface UpdateSecurityConfigRequest {
  */
 export interface UpdateSecurityConfigResponse {
     /**
+     * @public
      * <p>Details about the updated security configuration. </p>
      */
     securityConfigDetail?: SecurityConfigDetail;
@@ -1588,27 +1815,33 @@ export interface UpdateSecurityConfigResponse {
  */
 export interface UpdateSecurityPolicyRequest {
     /**
+     * @public
      * <p>The type of access policy.</p>
      */
     type: SecurityPolicyType | string | undefined;
     /**
+     * @public
      * <p>The name of the policy.</p>
      */
     name: string | undefined;
     /**
+     * @public
      * <p>The version of the policy being updated.</p>
      */
     policyVersion: string | undefined;
     /**
+     * @public
      * <p>A description of the policy. Typically used to store information about the permissions
      *             defined in the policy.</p>
      */
     description?: string;
     /**
+     * @public
      * <p>The JSON policy document to use as the content for the new policy.</p>
      */
     policy?: string;
     /**
+     * @public
      * <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
      */
     clientToken?: string;
@@ -1618,6 +1851,7 @@ export interface UpdateSecurityPolicyRequest {
  */
 export interface UpdateSecurityPolicyResponse {
     /**
+     * @public
      * <p>Details about the updated security policy.</p>
      */
     securityPolicyDetail?: SecurityPolicyDetail;
@@ -1627,12 +1861,14 @@ export interface UpdateSecurityPolicyResponse {
  */
 export interface TagResourceRequest {
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the resource. The resource must be active (not in
      *             the <code>DELETING</code> state), and must be owned by the account ID included in the
      *             request.</p>
      */
     resourceArn: string | undefined;
     /**
+     * @public
      * <p>A list of tags (key-value pairs) to add to the resource. All tag keys in the request
      *             must be unique.</p>
      */
@@ -1648,12 +1884,14 @@ export interface TagResourceResponse {
  */
 export interface UntagResourceRequest {
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the resource to remove tags from. The resource must
      *             be active (not in the <code>DELETING</code> state), and must be owned by the account ID
      *             included in the request.</p>
      */
     resourceArn: string | undefined;
     /**
+     * @public
      * <p>The tag or set of tags to remove from the resource. All tag keys in the request must
      *             be unique.</p>
      */
@@ -1669,6 +1907,7 @@ export interface UntagResourceResponse {
  */
 export interface UpdateAccountSettingsRequest {
     /**
+     * @public
      * <p>The maximum capacity limits for all OpenSearch Serverless collections, in OpenSearch Compute Units
      *             (OCUs). These limits are used to scale your collections based on the current workload.
      *             For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-scaling.html">Managing
@@ -1681,6 +1920,7 @@ export interface UpdateAccountSettingsRequest {
  */
 export interface UpdateAccountSettingsResponse {
     /**
+     * @public
      * <p>OpenSearch Serverless-related settings for the current Amazon Web Services account. </p>
      */
     accountSettingsDetail?: AccountSettingsDetail;
@@ -1690,28 +1930,34 @@ export interface UpdateAccountSettingsResponse {
  */
 export interface UpdateVpcEndpointRequest {
     /**
+     * @public
      * <p>The unique identifier of the interface endpoint to update.</p>
      */
     id: string | undefined;
     /**
+     * @public
      * <p>The ID of one or more subnets to add to the endpoint.</p>
      */
     addSubnetIds?: string[];
     /**
+     * @public
      * <p>The unique identifiers of the subnets to remove from the endpoint.</p>
      */
     removeSubnetIds?: string[];
     /**
+     * @public
      * <p>The unique identifiers of the security groups to add to the endpoint. Security groups
      *             define the ports, protocols, and sources for inbound traffic that you are authorizing
      *             into your endpoint.</p>
      */
     addSecurityGroupIds?: string[];
     /**
+     * @public
      * <p>The unique identifiers of the security groups to remove from the endpoint.</p>
      */
     removeSecurityGroupIds?: string[];
     /**
+     * @public
      * <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
      */
     clientToken?: string;
@@ -1722,27 +1968,33 @@ export interface UpdateVpcEndpointRequest {
  */
 export interface UpdateVpcEndpointDetail {
     /**
+     * @public
      * <p>The unique identifier of the endpoint.</p>
      */
     id?: string;
     /**
+     * @public
      * <p>The name of the endpoint.</p>
      */
     name?: string;
     /**
+     * @public
      * <p>The current status of the endpoint update process.</p>
      */
     status?: VpcEndpointStatus | string;
     /**
+     * @public
      * <p>The ID of the subnets from which you access OpenSearch Serverless.</p>
      */
     subnetIds?: string[];
     /**
+     * @public
      * <p>The unique identifiers of the security groups that define the ports, protocols, and
      *             sources for inbound traffic that you are authorizing into your endpoint.</p>
      */
     securityGroupIds?: string[];
     /**
+     * @public
      * <p>The timestamp of when the endpoint was last modified.</p>
      */
     lastModifiedDate?: number;
@@ -1752,6 +2004,7 @@ export interface UpdateVpcEndpointDetail {
  */
 export interface UpdateVpcEndpointResponse {
     /**
+     * @public
      * <p>Details about the updated VPC endpoint.</p>
      */
     UpdateVpcEndpointDetail?: UpdateVpcEndpointDetail;