@aws-sdk/client-docdb-elastic 3.523.0 → 3.529.0

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

@@ -26,7 +26,7 @@ declare const DeleteClusterCommand_base: {
 };
 /**
  * @public
- * <p>Delete a Elastic DocumentDB cluster.</p>
+ * <p>Delete an elastic cluster.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -57,6 +57,16 @@ declare const DeleteClusterCommand_base: {
  * //     ],
  * //     preferredMaintenanceWindow: "STRING_VALUE", // required
  * //     kmsKeyId: "STRING_VALUE", // required
+ * //     shards: [ // ShardList
+ * //       { // Shard
+ * //         shardId: "STRING_VALUE", // required
+ * //         createTime: "STRING_VALUE", // required
+ * //         status: "STRING_VALUE", // required
+ * //       },
+ * //     ],
+ * //     backupRetentionPeriod: Number("int"),
+ * //     preferredBackupWindow: "STRING_VALUE",
+ * //     shardInstanceCount: Number("int"),
  * //   },
  * // };
  *

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

@@ -26,7 +26,7 @@ declare const DeleteClusterSnapshotCommand_base: {
 };
 /**
  * @public
- * <p>Delete a Elastic DocumentDB snapshot.</p>
+ * <p>Delete an elastic cluster snapshot.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -54,6 +54,7 @@ declare const DeleteClusterSnapshotCommand_base: {
  * //     ],
  * //     adminUserName: "STRING_VALUE", // required
  * //     kmsKeyId: "STRING_VALUE", // required
+ * //     snapshotType: "STRING_VALUE",
  * //   },
  * // };
  *

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

@@ -26,7 +26,7 @@ declare const GetClusterCommand_base: {
 };
 /**
  * @public
- * <p>Returns information about a specific Elastic DocumentDB cluster.</p>
+ * <p>Returns information about a specific elastic cluster.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -57,6 +57,16 @@ declare const GetClusterCommand_base: {
  * //     ],
  * //     preferredMaintenanceWindow: "STRING_VALUE", // required
  * //     kmsKeyId: "STRING_VALUE", // required
+ * //     shards: [ // ShardList
+ * //       { // Shard
+ * //         shardId: "STRING_VALUE", // required
+ * //         createTime: "STRING_VALUE", // required
+ * //         status: "STRING_VALUE", // required
+ * //       },
+ * //     ],
+ * //     backupRetentionPeriod: Number("int"),
+ * //     preferredBackupWindow: "STRING_VALUE",
+ * //     shardInstanceCount: Number("int"),
  * //   },
  * // };
  *

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

@@ -26,7 +26,7 @@ declare const GetClusterSnapshotCommand_base: {
 };
 /**
  * @public
- * <p>Returns information about a specific Elastic DocumentDB snapshot</p>
+ * <p>Returns information about a specific elastic cluster snapshot</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -54,6 +54,7 @@ declare const GetClusterSnapshotCommand_base: {
  * //     ],
  * //     adminUserName: "STRING_VALUE", // required
  * //     kmsKeyId: "STRING_VALUE", // required
+ * //     snapshotType: "STRING_VALUE",
  * //   },
  * // };
  *

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

@@ -26,7 +26,7 @@ declare const ListClusterSnapshotsCommand_base: {
 };
 /**
  * @public
- * <p>Returns information about Elastic DocumentDB snapshots for a specified cluster.</p>
+ * <p>Returns information about snapshots for a specified elastic cluster.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -37,6 +37,7 @@ declare const ListClusterSnapshotsCommand_base: {
  *   clusterArn: "STRING_VALUE",
  *   nextToken: "STRING_VALUE",
  *   maxResults: Number("int"),
+ *   snapshotType: "STRING_VALUE",
  * };
  * const command = new ListClusterSnapshotsCommand(input);
  * const response = await client.send(command);

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

@@ -26,7 +26,7 @@ declare const ListClustersCommand_base: {
 };
 /**
  * @public
- * <p>Returns information about provisioned Elastic DocumentDB clusters.</p>
+ * <p>Returns information about provisioned Amazon DocumentDB elastic clusters.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -26,7 +26,7 @@ declare const ListTagsForResourceCommand_base: {
 };
 /**
  * @public
- * <p>Lists all tags on a Elastic DocumentDB resource</p>
+ * <p>Lists all tags on a elastic cluster resource</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -26,7 +26,7 @@ declare const RestoreClusterFromSnapshotCommand_base: {
 };
 /**
  * @public
- * <p>Restores a Elastic DocumentDB cluster from a snapshot.</p>
+ * <p>Restores an elastic cluster from a snapshot.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -46,6 +46,8 @@ declare const RestoreClusterFromSnapshotCommand_base: {
  *   tags: { // TagMap
  *     "<keys>": "STRING_VALUE",
  *   },
+ *   shardCapacity: Number("int"),
+ *   shardInstanceCount: Number("int"),
  * };
  * const command = new RestoreClusterFromSnapshotCommand(input);
  * const response = await client.send(command);
@@ -68,6 +70,16 @@ declare const RestoreClusterFromSnapshotCommand_base: {
  * //     ],
  * //     preferredMaintenanceWindow: "STRING_VALUE", // required
  * //     kmsKeyId: "STRING_VALUE", // required
+ * //     shards: [ // ShardList
+ * //       { // Shard
+ * //         shardId: "STRING_VALUE", // required
+ * //         createTime: "STRING_VALUE", // required
+ * //         status: "STRING_VALUE", // required
+ * //       },
+ * //     ],
+ * //     backupRetentionPeriod: Number("int"),
+ * //     preferredBackupWindow: "STRING_VALUE",
+ * //     shardInstanceCount: Number("int"),
  * //   },
  * // };
  *

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

@@ -0,0 +1,101 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { DocDBElasticClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBElasticClient";
+import { StartClusterInput, StartClusterOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link StartClusterCommand}.
+ */
+export interface StartClusterCommandInput extends StartClusterInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link StartClusterCommand}.
+ */
+export interface StartClusterCommandOutput extends StartClusterOutput, __MetadataBearer {
+}
+declare const StartClusterCommand_base: {
+    new (input: StartClusterCommandInput): import("@smithy/smithy-client").CommandImpl<StartClusterCommandInput, StartClusterCommandOutput, DocDBElasticClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * @public
+ * <p>Restarts the stopped elastic cluster that is specified by <code>clusterARN</code>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { DocDBElasticClient, StartClusterCommand } from "@aws-sdk/client-docdb-elastic"; // ES Modules import
+ * // const { DocDBElasticClient, StartClusterCommand } = require("@aws-sdk/client-docdb-elastic"); // CommonJS import
+ * const client = new DocDBElasticClient(config);
+ * const input = { // StartClusterInput
+ *   clusterArn: "STRING_VALUE", // required
+ * };
+ * const command = new StartClusterCommand(input);
+ * const response = await client.send(command);
+ * // { // StartClusterOutput
+ * //   cluster: { // Cluster
+ * //     clusterName: "STRING_VALUE", // required
+ * //     clusterArn: "STRING_VALUE", // required
+ * //     status: "STRING_VALUE", // required
+ * //     clusterEndpoint: "STRING_VALUE", // required
+ * //     createTime: "STRING_VALUE", // required
+ * //     adminUserName: "STRING_VALUE", // required
+ * //     authType: "STRING_VALUE", // required
+ * //     shardCapacity: Number("int"), // required
+ * //     shardCount: Number("int"), // required
+ * //     vpcSecurityGroupIds: [ // StringList // required
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     subnetIds: [ // required
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     preferredMaintenanceWindow: "STRING_VALUE", // required
+ * //     kmsKeyId: "STRING_VALUE", // required
+ * //     shards: [ // ShardList
+ * //       { // Shard
+ * //         shardId: "STRING_VALUE", // required
+ * //         createTime: "STRING_VALUE", // required
+ * //         status: "STRING_VALUE", // required
+ * //       },
+ * //     ],
+ * //     backupRetentionPeriod: Number("int"),
+ * //     preferredBackupWindow: "STRING_VALUE",
+ * //     shardInstanceCount: Number("int"),
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param StartClusterCommandInput - {@link StartClusterCommandInput}
+ * @returns {@link StartClusterCommandOutput}
+ * @see {@link StartClusterCommandInput} for command's `input` shape.
+ * @see {@link StartClusterCommandOutput} for command's `response` shape.
+ * @see {@link DocDBElasticClientResolvedConfig | config} for DocDBElasticClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>An exception that occurs when there are not sufficient permissions to perform an action.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>There was an internal server error.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource could not be located.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>ThrottlingException will be thrown when request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>A structure defining a validation exception.</p>
+ *
+ * @throws {@link DocDBElasticServiceException}
+ * <p>Base exception class for all service exceptions from DocDBElastic service.</p>
+ *
+ */
+export declare class StartClusterCommand extends StartClusterCommand_base {
+}

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

@@ -0,0 +1,102 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { DocDBElasticClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBElasticClient";
+import { StopClusterInput, StopClusterOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link StopClusterCommand}.
+ */
+export interface StopClusterCommandInput extends StopClusterInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link StopClusterCommand}.
+ */
+export interface StopClusterCommandOutput extends StopClusterOutput, __MetadataBearer {
+}
+declare const StopClusterCommand_base: {
+    new (input: StopClusterCommandInput): import("@smithy/smithy-client").CommandImpl<StopClusterCommandInput, StopClusterCommandOutput, DocDBElasticClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * @public
+ * <p>Stops the running elastic cluster that is specified by <code>clusterArn</code>.
+ *       The elastic cluster must be in the <i>available</i> state. </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { DocDBElasticClient, StopClusterCommand } from "@aws-sdk/client-docdb-elastic"; // ES Modules import
+ * // const { DocDBElasticClient, StopClusterCommand } = require("@aws-sdk/client-docdb-elastic"); // CommonJS import
+ * const client = new DocDBElasticClient(config);
+ * const input = { // StopClusterInput
+ *   clusterArn: "STRING_VALUE", // required
+ * };
+ * const command = new StopClusterCommand(input);
+ * const response = await client.send(command);
+ * // { // StopClusterOutput
+ * //   cluster: { // Cluster
+ * //     clusterName: "STRING_VALUE", // required
+ * //     clusterArn: "STRING_VALUE", // required
+ * //     status: "STRING_VALUE", // required
+ * //     clusterEndpoint: "STRING_VALUE", // required
+ * //     createTime: "STRING_VALUE", // required
+ * //     adminUserName: "STRING_VALUE", // required
+ * //     authType: "STRING_VALUE", // required
+ * //     shardCapacity: Number("int"), // required
+ * //     shardCount: Number("int"), // required
+ * //     vpcSecurityGroupIds: [ // StringList // required
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     subnetIds: [ // required
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     preferredMaintenanceWindow: "STRING_VALUE", // required
+ * //     kmsKeyId: "STRING_VALUE", // required
+ * //     shards: [ // ShardList
+ * //       { // Shard
+ * //         shardId: "STRING_VALUE", // required
+ * //         createTime: "STRING_VALUE", // required
+ * //         status: "STRING_VALUE", // required
+ * //       },
+ * //     ],
+ * //     backupRetentionPeriod: Number("int"),
+ * //     preferredBackupWindow: "STRING_VALUE",
+ * //     shardInstanceCount: Number("int"),
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param StopClusterCommandInput - {@link StopClusterCommandInput}
+ * @returns {@link StopClusterCommandOutput}
+ * @see {@link StopClusterCommandInput} for command's `input` shape.
+ * @see {@link StopClusterCommandOutput} for command's `response` shape.
+ * @see {@link DocDBElasticClientResolvedConfig | config} for DocDBElasticClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>An exception that occurs when there are not sufficient permissions to perform an action.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>There was an internal server error.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource could not be located.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>ThrottlingException will be thrown when request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>A structure defining a validation exception.</p>
+ *
+ * @throws {@link DocDBElasticServiceException}
+ * <p>Base exception class for all service exceptions from DocDBElastic service.</p>
+ *
+ */
+export declare class StopClusterCommand extends StopClusterCommand_base {
+}

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

@@ -26,7 +26,7 @@ declare const TagResourceCommand_base: {
 };
 /**
  * @public
- * <p>Adds metadata tags to a Elastic DocumentDB resource</p>
+ * <p>Adds metadata tags to an elastic cluster resource</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -26,7 +26,7 @@ declare const UntagResourceCommand_base: {
 };
 /**
  * @public
- * <p>Removes metadata tags to a Elastic DocumentDB resource</p>
+ * <p>Removes metadata tags from an elastic cluster resource</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -26,8 +26,8 @@ declare const UpdateClusterCommand_base: {
 };
 /**
  * @public
- * <p>Modifies a Elastic DocumentDB cluster. This includes updating admin-username/password,
- *     upgrading API version setting up a backup window and maintenance window</p>
+ * <p>Modifies an elastic cluster. This includes updating admin-username/password,
+ *     upgrading the API version, and setting up a backup window and maintenance window</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -48,6 +48,9 @@ declare const UpdateClusterCommand_base: {
  *   adminUserPassword: "STRING_VALUE",
  *   clientToken: "STRING_VALUE",
  *   preferredMaintenanceWindow: "STRING_VALUE",
+ *   backupRetentionPeriod: Number("int"),
+ *   preferredBackupWindow: "STRING_VALUE",
+ *   shardInstanceCount: Number("int"),
  * };
  * const command = new UpdateClusterCommand(input);
  * const response = await client.send(command);
@@ -70,6 +73,16 @@ declare const UpdateClusterCommand_base: {
  * //     ],
  * //     preferredMaintenanceWindow: "STRING_VALUE", // required
  * //     kmsKeyId: "STRING_VALUE", // required
+ * //     shards: [ // ShardList
+ * //       { // Shard
+ * //         shardId: "STRING_VALUE", // required
+ * //         createTime: "STRING_VALUE", // required
+ * //         status: "STRING_VALUE", // required
+ * //       },
+ * //     ],
+ * //     backupRetentionPeriod: Number("int"),
+ * //     preferredBackupWindow: "STRING_VALUE",
+ * //     shardInstanceCount: Number("int"),
  * //   },
  * // };
  *

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

@@ -1,3 +1,4 @@
+export * from "./CopyClusterSnapshotCommand";
 export * from "./CreateClusterCommand";
 export * from "./CreateClusterSnapshotCommand";
 export * from "./DeleteClusterCommand";
@@ -8,6 +9,8 @@ export * from "./ListClusterSnapshotsCommand";
 export * from "./ListClustersCommand";
 export * from "./ListTagsForResourceCommand";
 export * from "./RestoreClusterFromSnapshotCommand";
+export * from "./StartClusterCommand";
+export * from "./StopClusterCommand";
 export * from "./TagResourceCommand";
 export * from "./UntagResourceCommand";
 export * from "./UpdateClusterCommand";

package/dist-types/index.d.ts

@@ -1,5 +1,19 @@
 /**
- * <p>The new Amazon Elastic DocumentDB service endpoint.</p>
+ * <fullname>Amazon DocumentDB elastic clusters</fullname>
+ *          <p>Amazon DocumentDB elastic-clusters support workloads with millions of reads/writes per second and petabytes of storage capacity.
+ *       Amazon DocumentDB elastic clusters also simplify how developers interact with Amazon DocumentDB elastic-clusters by eliminating the need to choose, manage or upgrade instances.</p>
+ *          <p>Amazon DocumentDB elastic-clusters were created to:</p>
+ *          <ul>
+ *             <li>
+ *                <p>provide a solution for customers looking for a database that provides virtually limitless scale with rich query capabilities and MongoDB API compatibility.</p>
+ *             </li>
+ *             <li>
+ *                <p>give customers higher connection limits, and to reduce downtime from patching.</p>
+ *             </li>
+ *             <li>
+ *                <p>continue investing in a cloud-native, elastic, and class leading architecture for JSON workloads.</p>
+ *             </li>
+ *          </ul>
  *
  * @packageDocumentation
  */