@aws-sdk/client-docdb-elastic 3.379.1 → 3.385.0

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

@@ -32,10 +32,12 @@ export declare class ConflictException extends __BaseException {
     readonly name: "ConflictException";
     readonly $fault: "client";
     /**
+     * @public
      * <p>The ID of the resource where there was an access conflict.</p>
      */
     resourceId: string | undefined;
     /**
+     * @public
      * <p>The type of the resource where there was an access conflict.</p>
      */
     resourceType: string | undefined;
@@ -49,6 +51,7 @@ export declare class ConflictException extends __BaseException {
  */
 export interface CreateClusterInput {
     /**
+     * @public
      * <p>The name of the new Elastic DocumentDB cluster. This parameter is stored as
      *       a lowercase string.</p>
      *          <p>
@@ -70,10 +73,12 @@ export interface CreateClusterInput {
      */
     clusterName: string | undefined;
     /**
+     * @public
      * <p>The authentication type for the Elastic DocumentDB cluster.</p>
      */
     authType: Auth | string | undefined;
     /**
+     * @public
      * <p>The name of the Elastic DocumentDB cluster administrator.</p>
      *          <p>
      *             <i>Constraints</i>:</p>
@@ -91,6 +96,7 @@ export interface CreateClusterInput {
      */
     adminUserName: string | undefined;
     /**
+     * @public
      * <p>The password for the Elastic DocumentDB cluster administrator and can
      *       contain any printable ASCII characters.</p>
      *          <p>
@@ -106,23 +112,28 @@ export interface CreateClusterInput {
      */
     adminUserPassword: string | undefined;
     /**
+     * @public
      * <p>The capacity of each shard in the new Elastic DocumentDB cluster.</p>
      */
     shardCapacity: number | undefined;
     /**
+     * @public
      * <p>The number of shards to create in the new Elastic DocumentDB cluster.</p>
      */
     shardCount: number | undefined;
     /**
+     * @public
      * <p>A list of EC2 VPC security groups to associate with the new
      *       Elastic DocumentDB cluster.</p>
      */
     vpcSecurityGroupIds?: string[];
     /**
+     * @public
      * <p>The Amazon EC2 subnet IDs for the new Elastic DocumentDB cluster.</p>
      */
     subnetIds?: string[];
     /**
+     * @public
      * <p>The KMS key identifier to use to encrypt the new Elastic DocumentDB cluster.</p>
      *          <p>The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
      *         encryption key. If you are creating a cluster using the same Amazon account
@@ -134,10 +145,12 @@ export interface CreateClusterInput {
      */
     kmsKeyId?: string;
     /**
+     * @public
      * <p>The client token for the Elastic DocumentDB cluster.</p>
      */
     clientToken?: string;
     /**
+     * @public
      * <p>The weekly time range during which system maintenance can occur,
      *       in Universal Coordinated Time (UTC).</p>
      *          <p>
@@ -152,6 +165,7 @@ export interface CreateClusterInput {
      */
     preferredMaintenanceWindow?: string;
     /**
+     * @public
      * <p>The tags to be assigned to the new Elastic DocumentDB cluster.</p>
      */
     tags?: Record<string, string>;
@@ -181,50 +195,62 @@ export type Status = (typeof Status)[keyof typeof Status];
  */
 export interface Cluster {
     /**
+     * @public
      * <p>The name of the Elastic DocumentDB cluster.</p>
      */
     clusterName: string | undefined;
     /**
+     * @public
      * <p>The arn of the Elastic DocumentDB cluster.</p>
      */
     clusterArn: string | undefined;
     /**
+     * @public
      * <p>The status of the Elastic DocumentDB cluster.</p>
      */
     status: Status | string | undefined;
     /**
+     * @public
      * <p>The URL used to connect to the Elastic DocumentDB cluster.</p>
      */
     clusterEndpoint: string | undefined;
     /**
+     * @public
      * <p>The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).</p>
      */
     createTime: string | undefined;
     /**
+     * @public
      * <p>The name of the Elastic DocumentDB cluster administrator.</p>
      */
     adminUserName: string | undefined;
     /**
+     * @public
      * <p>The authentication type for the Elastic DocumentDB cluster.</p>
      */
     authType: Auth | string | undefined;
     /**
+     * @public
      * <p>The capacity of each shard in the Elastic DocumentDB cluster.</p>
      */
     shardCapacity: number | undefined;
     /**
+     * @public
      * <p>The number of shards in the  Elastic DocumentDB cluster.</p>
      */
     shardCount: number | undefined;
     /**
+     * @public
      * <p>A list of EC2 VPC security groups associated with this cluster.</p>
      */
     vpcSecurityGroupIds: string[] | undefined;
     /**
+     * @public
      * <p>The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.</p>
      */
     subnetIds: string[] | undefined;
     /**
+     * @public
      * <p>The weekly time range during which system maintenance can occur,
      *       in Universal Coordinated Time (UTC).</p>
      *          <p>
@@ -233,6 +259,7 @@ export interface Cluster {
      */
     preferredMaintenanceWindow: string | undefined;
     /**
+     * @public
      * <p>The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.</p>
      */
     kmsKeyId: string | undefined;
@@ -242,6 +269,7 @@ export interface Cluster {
  */
 export interface CreateClusterOutput {
     /**
+     * @public
      * <p>The new Elastic DocumentDB cluster that has been created.</p>
      */
     cluster: Cluster | undefined;
@@ -280,6 +308,7 @@ export declare class ThrottlingException extends __BaseException {
     readonly $fault: "client";
     $retryable: {};
     /**
+     * @public
      * <p>The number of seconds to wait before retrying the operation.</p>
      */
     retryAfterSeconds?: number;
@@ -294,10 +323,12 @@ export declare class ThrottlingException extends __BaseException {
  */
 export interface ValidationExceptionField {
     /**
+     * @public
      * <p>The name of the field where the validation exception occurred.</p>
      */
     name: string | undefined;
     /**
+     * @public
      * <p>An error message describing the validation exception in this field.</p>
      */
     message: string | undefined;
@@ -324,11 +355,13 @@ export declare class ValidationException extends __BaseException {
     readonly name: "ValidationException";
     readonly $fault: "client";
     /**
+     * @public
      * <p>The reason why the validation exception occurred (one of <code>unknownOperation</code>,
      *       <code>cannotParse</code>, <code>fieldValidationFailed</code>, or <code>other</code>).</p>
      */
     reason: ValidationExceptionReason | string | undefined;
     /**
+     * @public
      * <p>A list of the fields in which the validation exception occurred.</p>
      */
     fieldList?: ValidationExceptionField[];
@@ -342,14 +375,17 @@ export declare class ValidationException extends __BaseException {
  */
 export interface CreateClusterSnapshotInput {
     /**
+     * @public
      * <p>The arn of the Elastic DocumentDB cluster that the snapshot will be taken from.</p>
      */
     clusterArn: string | undefined;
     /**
+     * @public
      * <p>The name of the Elastic DocumentDB snapshot.</p>
      */
     snapshotName: string | undefined;
     /**
+     * @public
      * <p>The tags to be assigned to the new Elastic DocumentDB snapshot.</p>
      */
     tags?: Record<string, string>;
@@ -360,42 +396,52 @@ export interface CreateClusterSnapshotInput {
  */
 export interface ClusterSnapshot {
     /**
+     * @public
      * <p>A list of the IDs of subnets associated with the DB cluster snapshot.</p>
      */
     subnetIds: string[] | undefined;
     /**
+     * @public
      * <p>The name of the Elastic DocumentDB snapshot.</p>
      */
     snapshotName: string | undefined;
     /**
+     * @public
      * <p>The arn of the Elastic DocumentDB snapshot</p>
      */
     snapshotArn: string | undefined;
     /**
+     * @public
      * <p>The time when the Elastic DocumentDB snapshot was created in Universal Coordinated Time (UTC).</p>
      */
     snapshotCreationTime: string | undefined;
     /**
+     * @public
      * <p>The arn of the Elastic DocumentDB cluster.</p>
      */
     clusterArn: string | undefined;
     /**
+     * @public
      * <p>The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).</p>
      */
     clusterCreationTime: string | undefined;
     /**
+     * @public
      * <p>The status of the Elastic DocumentDB snapshot.</p>
      */
     status: Status | string | undefined;
     /**
+     * @public
      * <p>A list of the IDs of the VPC security groups associated with the cluster snapshot.</p>
      */
     vpcSecurityGroupIds: string[] | undefined;
     /**
+     * @public
      * <p>The name of the Elastic DocumentDB cluster administrator.</p>
      */
     adminUserName: string | undefined;
     /**
+     * @public
      * <p>The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.</p>
      */
     kmsKeyId: string | undefined;
@@ -405,6 +451,7 @@ export interface ClusterSnapshot {
  */
 export interface CreateClusterSnapshotOutput {
     /**
+     * @public
      * <p>Returns information about the new Elastic DocumentDB snapshot.</p>
      */
     snapshot: ClusterSnapshot | undefined;
@@ -417,10 +464,12 @@ export declare class ResourceNotFoundException extends __BaseException {
     readonly name: "ResourceNotFoundException";
     readonly $fault: "client";
     /**
+     * @public
      * <p>The ID of the resource that could not be located.</p>
      */
     resourceId: string | undefined;
     /**
+     * @public
      * <p>The type of the resource that could not be found.</p>
      */
     resourceType: string | undefined;
@@ -434,6 +483,7 @@ export declare class ResourceNotFoundException extends __BaseException {
  */
 export interface DeleteClusterInput {
     /**
+     * @public
      * <p>The arn of the Elastic DocumentDB cluster that is to be deleted.</p>
      */
     clusterArn: string | undefined;
@@ -443,6 +493,7 @@ export interface DeleteClusterInput {
  */
 export interface DeleteClusterOutput {
     /**
+     * @public
      * <p>Returns information about the newly deleted Elastic DocumentDB cluster.</p>
      */
     cluster: Cluster | undefined;
@@ -452,6 +503,7 @@ export interface DeleteClusterOutput {
  */
 export interface DeleteClusterSnapshotInput {
     /**
+     * @public
      * <p>The arn of the Elastic DocumentDB snapshot that is to be deleted.</p>
      */
     snapshotArn: string | undefined;
@@ -461,6 +513,7 @@ export interface DeleteClusterSnapshotInput {
  */
 export interface DeleteClusterSnapshotOutput {
     /**
+     * @public
      * <p>Returns information about the newly deleted Elastic DocumentDB snapshot.</p>
      */
     snapshot: ClusterSnapshot | undefined;
@@ -470,6 +523,7 @@ export interface DeleteClusterSnapshotOutput {
  */
 export interface GetClusterInput {
     /**
+     * @public
      * <p>The arn of the Elastic DocumentDB cluster.</p>
      */
     clusterArn: string | undefined;
@@ -479,6 +533,7 @@ export interface GetClusterInput {
  */
 export interface GetClusterOutput {
     /**
+     * @public
      * <p>Returns information about a specific Elastic DocumentDB cluster.</p>
      */
     cluster: Cluster | undefined;
@@ -488,6 +543,7 @@ export interface GetClusterOutput {
  */
 export interface GetClusterSnapshotInput {
     /**
+     * @public
      * <p>The arn of the Elastic DocumentDB snapshot.</p>
      */
     snapshotArn: string | undefined;
@@ -497,6 +553,7 @@ export interface GetClusterSnapshotInput {
  */
 export interface GetClusterSnapshotOutput {
     /**
+     * @public
      * <p>Returns information about a specific Elastic DocumentDB snapshot.</p>
      */
     snapshot: ClusterSnapshot | undefined;
@@ -506,10 +563,12 @@ export interface GetClusterSnapshotOutput {
  */
 export interface ListClustersInput {
     /**
+     * @public
      * <p>The nextToken which is used the get the next page of data.</p>
      */
     nextToken?: string;
     /**
+     * @public
      * <p>The maximum number of entries to recieve in the response.</p>
      */
     maxResults?: number;
@@ -520,14 +579,17 @@ export interface ListClustersInput {
  */
 export interface ClusterInList {
     /**
+     * @public
      * <p>The name of the Elastic DocumentDB cluster.</p>
      */
     clusterName: string | undefined;
     /**
+     * @public
      * <p>The arn of the Elastic DocumentDB cluster.</p>
      */
     clusterArn: string | undefined;
     /**
+     * @public
      * <p>The status of the Elastic DocumentDB cluster.</p>
      */
     status: Status | string | undefined;
@@ -537,10 +599,12 @@ export interface ClusterInList {
  */
 export interface ListClustersOutput {
     /**
+     * @public
      * <p>A list of Elastic DocumentDB cluster.</p>
      */
     clusters?: ClusterInList[];
     /**
+     * @public
      * <p>The response will provide a nextToken if there is more data beyond the maxResults.</p>
      *          <p>If there is no more data in the responce, the nextToken will not be returned.</p>
      */
@@ -551,14 +615,17 @@ export interface ListClustersOutput {
  */
 export interface ListClusterSnapshotsInput {
     /**
+     * @public
      * <p>The arn of the Elastic DocumentDB cluster.</p>
      */
     clusterArn?: string;
     /**
+     * @public
      * <p>The nextToken which is used the get the next page of data.</p>
      */
     nextToken?: string;
     /**
+     * @public
      * <p>The maximum number of entries to recieve in the response.</p>
      */
     maxResults?: number;
@@ -569,22 +636,27 @@ export interface ListClusterSnapshotsInput {
  */
 export interface ClusterSnapshotInList {
     /**
+     * @public
      * <p>The name of the Elastic DocumentDB snapshot.</p>
      */
     snapshotName: string | undefined;
     /**
+     * @public
      * <p>The arn of the Elastic DocumentDB snapshot</p>
      */
     snapshotArn: string | undefined;
     /**
+     * @public
      * <p>The arn of the Elastic DocumentDB cluster.</p>
      */
     clusterArn: string | undefined;
     /**
+     * @public
      * <p>The status of the Elastic DocumentDB snapshot.</p>
      */
     status: Status | string | undefined;
     /**
+     * @public
      * <p>The time when the Elastic DocumentDB snapshot was created in Universal Coordinated Time (UTC).</p>
      */
     snapshotCreationTime: string | undefined;
@@ -594,10 +666,12 @@ export interface ClusterSnapshotInList {
  */
 export interface ListClusterSnapshotsOutput {
     /**
+     * @public
      * <p>A list of Elastic DocumentDB snapshots for a specified cluster.</p>
      */
     snapshots?: ClusterSnapshotInList[];
     /**
+     * @public
      * <p>The response will provide a nextToken if there is more data beyond the maxResults.</p>
      *          <p>If there is no more data in the responce, the nextToken will not be returned.</p>
      */
@@ -608,6 +682,7 @@ export interface ListClusterSnapshotsOutput {
  */
 export interface ListTagsForResourceRequest {
     /**
+     * @public
      * <p>The arn of the Elastic DocumentDB resource.</p>
      */
     resourceArn: string | undefined;
@@ -617,6 +692,7 @@ export interface ListTagsForResourceRequest {
  */
 export interface ListTagsForResourceResponse {
     /**
+     * @public
      * <p>The list of tags for the specified Elastic DocumentDB resource.</p>
      */
     tags?: Record<string, string>;
@@ -626,23 +702,28 @@ export interface ListTagsForResourceResponse {
  */
 export interface RestoreClusterFromSnapshotInput {
     /**
+     * @public
      * <p>The name of the Elastic DocumentDB cluster.</p>
      */
     clusterName: string | undefined;
     /**
+     * @public
      * <p>The arn of the Elastic DocumentDB snapshot.</p>
      */
     snapshotArn: string | undefined;
     /**
+     * @public
      * <p>A list of EC2 VPC security groups to associate with the
      *       Elastic DocumentDB cluster.</p>
      */
     vpcSecurityGroupIds?: string[];
     /**
+     * @public
      * <p>The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.</p>
      */
     subnetIds?: string[];
     /**
+     * @public
      * <p>The KMS key identifier to use to encrypt the new Elastic DocumentDB cluster.</p>
      *          <p>The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
      *         encryption key. If you are creating a cluster using the same Amazon account
@@ -654,6 +735,7 @@ export interface RestoreClusterFromSnapshotInput {
      */
     kmsKeyId?: string;
     /**
+     * @public
      * <p>A list of the tag names to be assigned to the restored DB cluster,
      *       in the form of an array of key-value pairs in which the key
      *       is the tag name and the value is the key value.</p>
@@ -665,6 +747,7 @@ export interface RestoreClusterFromSnapshotInput {
  */
 export interface RestoreClusterFromSnapshotOutput {
     /**
+     * @public
      * <p>Returns information about a the restored Elastic DocumentDB cluster.</p>
      */
     cluster: Cluster | undefined;
@@ -674,10 +757,12 @@ export interface RestoreClusterFromSnapshotOutput {
  */
 export interface TagResourceRequest {
     /**
+     * @public
      * <p>The arn of the Elastic DocumentDB resource.</p>
      */
     resourceArn: string | undefined;
     /**
+     * @public
      * <p>The tags to be assigned to the Elastic DocumentDB resource.</p>
      */
     tags: Record<string, string> | undefined;
@@ -692,10 +777,12 @@ export interface TagResourceResponse {
  */
 export interface UntagResourceRequest {
     /**
+     * @public
      * <p>The arn of the Elastic DocumentDB resource.</p>
      */
     resourceArn: string | undefined;
     /**
+     * @public
      * <p>The tag keys to be removed from the Elastic DocumentDB resource.</p>
      */
     tagKeys: string[] | undefined;
@@ -710,31 +797,38 @@ export interface UntagResourceResponse {
  */
 export interface UpdateClusterInput {
     /**
+     * @public
      * <p>The arn of the Elastic DocumentDB cluster.</p>
      */
     clusterArn: string | undefined;
     /**
+     * @public
      * <p>The authentication type for the Elastic DocumentDB cluster.</p>
      */
     authType?: Auth | string;
     /**
+     * @public
      * <p>The capacity of each shard in the Elastic DocumentDB cluster.</p>
      */
     shardCapacity?: number;
     /**
+     * @public
      * <p>The number of shards to create in the Elastic DocumentDB cluster.</p>
      */
     shardCount?: number;
     /**
+     * @public
      * <p>A list of EC2 VPC security groups to associate with the new
      *       Elastic DocumentDB cluster.</p>
      */
     vpcSecurityGroupIds?: string[];
     /**
+     * @public
      * <p>The number of shards to create in the Elastic DocumentDB cluster.</p>
      */
     subnetIds?: string[];
     /**
+     * @public
      * <p>The password for the Elastic DocumentDB cluster administrator. This password can
      *       contain any printable ASCII character except forward slash (/),
      *       double quote ("), or the "at" symbol (@).</p>
@@ -743,10 +837,12 @@ export interface UpdateClusterInput {
      */
     adminUserPassword?: string;
     /**
+     * @public
      * <p>The client token for the Elastic DocumentDB cluster.</p>
      */
     clientToken?: string;
     /**
+     * @public
      * <p>The weekly time range during which system maintenance can occur,
      *       in Universal Coordinated Time (UTC).</p>
      *          <p>
@@ -766,6 +862,7 @@ export interface UpdateClusterInput {
  */
 export interface UpdateClusterOutput {
     /**
+     * @public
      * <p>Returns information about the updated Elastic DocumentDB cluster.</p>
      */
     cluster: Cluster | undefined;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-docdb-elastic",
   "description": "AWS SDK for JavaScript Docdb Elastic Client for Node.js, Browser and React Native",
-  "version": "3.379.1",
+  "version": "3.385.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.379.1",
-    "@aws-sdk/credential-provider-node": "3.379.1",
+    "@aws-sdk/client-sts": "3.385.0",
+    "@aws-sdk/credential-provider-node": "3.385.0",
     "@aws-sdk/middleware-host-header": "3.379.1",
     "@aws-sdk/middleware-logger": "3.378.0",
     "@aws-sdk/middleware-recursion-detection": "3.378.0",
     "@aws-sdk/middleware-signing": "3.379.1",
-    "@aws-sdk/middleware-user-agent": "3.379.1",
+    "@aws-sdk/middleware-user-agent": "3.382.0",
     "@aws-sdk/types": "3.378.0",
-    "@aws-sdk/util-endpoints": "3.378.0",
+    "@aws-sdk/util-endpoints": "3.382.0",
     "@aws-sdk/util-user-agent-browser": "3.378.0",
     "@aws-sdk/util-user-agent-node": "3.378.0",
     "@smithy/config-resolver": "^2.0.1",