@aws-sdk/client-docdb-elastic 3.775.0 → 3.777.0

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

@@ -87,6 +87,7 @@ declare const ApplyPendingMaintenanceActionCommand_base: {
  * @throws {@link DocDBElasticServiceException}
  * <p>Base exception class for all service exceptions from DocDBElastic service.</p>
  *
+ *
  * @public
  */
 export declare class ApplyPendingMaintenanceActionCommand extends ApplyPendingMaintenanceActionCommand_base {

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

@@ -97,6 +97,40 @@ declare const CopyClusterSnapshotCommand_base: {
  * @throws {@link DocDBElasticServiceException}
  * <p>Base exception class for all service exceptions from DocDBElastic service.</p>
  *
+ *
+ * @example Basic Copy Cluster Snapshot Example
+ * ```javascript
+ * // update applied
+ * const input = {
+ *   snapshotArn: "arn:aws:docdb-elastic:us-east-1:$AWS_ACCOUNT_ID:cluster-snapshot/$SOURCE_SNAPSHOT_ID",
+ *   targetSnapshotName: "sampleSnapshotName"
+ * };
+ * const command = new CopyClusterSnapshotCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   snapshot: {
+ *     adminUserName: "sampleAdminUser",
+ *     clusterArn: "arn:aws:docdb-elastic:us-east-1:$AWS_ACCOUNT_ID:cluster/$CLUSTER_ID",
+ *     clusterCreationTime: "2000-01-01T00:00:00.000Z",
+ *     kmsKeyId: "AWS_OWNED_KMS_KEY",
+ *     snapshotArn: "arn:aws:docdb-elastic:us-east-1:$AWS_ACCOUNT_ID:cluster-snapshot/$TARGET_SNAPSHOT_ID",
+ *     snapshotCreationTime: "2000-01-01T00:00:00.000Z",
+ *     snapshotName: "sampleSnapshotName",
+ *     snapshotType: "MANUAL",
+ *     status: "ACTIVE",
+ *     subnetIds: [
+ *       "subnetId1",
+ *       "subnetId2"
+ *     ],
+ *     vpcSecurityGroupIds: [
+ *       "vpcSgId1, vpcSgId2"
+ *     ]
+ *   }
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class CopyClusterSnapshotCommand extends CopyClusterSnapshotCommand_base {

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

@@ -120,6 +120,7 @@ declare const CreateClusterCommand_base: {
  * @throws {@link DocDBElasticServiceException}
  * <p>Base exception class for all service exceptions from DocDBElastic service.</p>
  *
+ *
  * @public
  */
 export declare class CreateClusterCommand extends CreateClusterCommand_base {

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

@@ -95,6 +95,7 @@ declare const CreateClusterSnapshotCommand_base: {
  * @throws {@link DocDBElasticServiceException}
  * <p>Base exception class for all service exceptions from DocDBElastic service.</p>
  *
+ *
  * @public
  */
 export declare class CreateClusterSnapshotCommand extends CreateClusterSnapshotCommand_base {

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

@@ -100,6 +100,7 @@ declare const DeleteClusterCommand_base: {
  * @throws {@link DocDBElasticServiceException}
  * <p>Base exception class for all service exceptions from DocDBElastic service.</p>
  *
+ *
  * @public
  */
 export declare class DeleteClusterCommand extends DeleteClusterCommand_base {

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

@@ -88,6 +88,7 @@ declare const DeleteClusterSnapshotCommand_base: {
  * @throws {@link DocDBElasticServiceException}
  * <p>Base exception class for all service exceptions from DocDBElastic service.</p>
  *
+ *
  * @public
  */
 export declare class DeleteClusterSnapshotCommand extends DeleteClusterSnapshotCommand_base {

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

@@ -97,6 +97,7 @@ declare const GetClusterCommand_base: {
  * @throws {@link DocDBElasticServiceException}
  * <p>Base exception class for all service exceptions from DocDBElastic service.</p>
  *
+ *
  * @public
  */
 export declare class GetClusterCommand extends GetClusterCommand_base {

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

@@ -85,6 +85,7 @@ declare const GetClusterSnapshotCommand_base: {
  * @throws {@link DocDBElasticServiceException}
  * <p>Base exception class for all service exceptions from DocDBElastic service.</p>
  *
+ *
  * @public
  */
 export declare class GetClusterSnapshotCommand extends GetClusterSnapshotCommand_base {

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

@@ -84,6 +84,7 @@ declare const GetPendingMaintenanceActionCommand_base: {
  * @throws {@link DocDBElasticServiceException}
  * <p>Base exception class for all service exceptions from DocDBElastic service.</p>
  *
+ *
  * @public
  */
 export declare class GetPendingMaintenanceActionCommand extends GetPendingMaintenanceActionCommand_base {

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

@@ -78,6 +78,7 @@ declare const ListClusterSnapshotsCommand_base: {
  * @throws {@link DocDBElasticServiceException}
  * <p>Base exception class for all service exceptions from DocDBElastic service.</p>
  *
+ *
  * @public
  */
 export declare class ListClusterSnapshotsCommand extends ListClusterSnapshotsCommand_base {

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

@@ -74,6 +74,7 @@ declare const ListClustersCommand_base: {
  * @throws {@link DocDBElasticServiceException}
  * <p>Base exception class for all service exceptions from DocDBElastic service.</p>
  *
+ *
  * @public
  */
 export declare class ListClustersCommand extends ListClustersCommand_base {

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

@@ -82,6 +82,7 @@ declare const ListPendingMaintenanceActionsCommand_base: {
  * @throws {@link DocDBElasticServiceException}
  * <p>Base exception class for all service exceptions from DocDBElastic service.</p>
  *
+ *
  * @public
  */
 export declare class ListPendingMaintenanceActionsCommand extends ListPendingMaintenanceActionsCommand_base {

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

@@ -68,6 +68,7 @@ declare const ListTagsForResourceCommand_base: {
  * @throws {@link DocDBElasticServiceException}
  * <p>Base exception class for all service exceptions from DocDBElastic service.</p>
  *
+ *
  * @public
  */
 export declare class ListTagsForResourceCommand extends ListTagsForResourceCommand_base {

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

@@ -116,6 +116,7 @@ declare const RestoreClusterFromSnapshotCommand_base: {
  * @throws {@link DocDBElasticServiceException}
  * <p>Base exception class for all service exceptions from DocDBElastic service.</p>
  *
+ *
  * @public
  */
 export declare class RestoreClusterFromSnapshotCommand extends RestoreClusterFromSnapshotCommand_base {

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

@@ -97,6 +97,45 @@ declare const StartClusterCommand_base: {
  * @throws {@link DocDBElasticServiceException}
  * <p>Base exception class for all service exceptions from DocDBElastic service.</p>
  *
+ *
+ * @example Basic Start Cluster Example
+ * ```javascript
+ * // update applied
+ * const input = {
+ *   clusterArn: "arn:aws:docdb-elastic:us-east-1:$AWS_ACCOUNT_ID:cluster/$CLUSTER_ID"
+ * };
+ * const command = new StartClusterCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   cluster: {
+ *     adminUserName: "sampleAdminUser",
+ *     authType: "PLAIN_TEXT",
+ *     backupRetentionPeriod: 1,
+ *     clusterArn: "arn:aws:docdb-elastic:us-east-1:$AWS_ACCOUNT_ID:cluster/$CLUSTER_ID",
+ *     clusterEndpoint: "sampleClusterName.us-east-1.docdb-elastic.amazonaws.com",
+ *     clusterName: "sampleClusterName",
+ *     createTime: "2000-01-01T00:00:00.000Z",
+ *     kmsKeyId: "AWS_OWNED_KMS_KEY",
+ *     preferredBackupWindow: "01:00-01:30",
+ *     preferredMaintenanceWindow: "mon:00:00-mon:00:30",
+ *     shardCapacity: 2,
+ *     shardCount: 2,
+ *     shardInstanceCount: 1,
+ *     shards:     [],
+ *     status: "STARTING",
+ *     subnetIds: [
+ *       "subnetId1",
+ *       "subnetId2"
+ *     ],
+ *     vpcSecurityGroupIds: [
+ *       "vpcSgId1, vpcSgId2"
+ *     ]
+ *   }
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class StartClusterCommand extends StartClusterCommand_base {

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

@@ -98,6 +98,45 @@ declare const StopClusterCommand_base: {
  * @throws {@link DocDBElasticServiceException}
  * <p>Base exception class for all service exceptions from DocDBElastic service.</p>
  *
+ *
+ * @example Basic Stop Cluster Example
+ * ```javascript
+ * // update applied
+ * const input = {
+ *   clusterArn: "arn:aws:docdb-elastic:us-east-1:$AWS_ACCOUNT_ID:cluster/$CLUSTER_ID"
+ * };
+ * const command = new StopClusterCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   cluster: {
+ *     adminUserName: "sampleAdminUser",
+ *     authType: "PLAIN_TEXT",
+ *     backupRetentionPeriod: 1,
+ *     clusterArn: "arn:aws:docdb-elastic:us-east-1:$AWS_ACCOUNT_ID:cluster/$CLUSTER_ID",
+ *     clusterEndpoint: "sampleClusterName.us-east-1.docdb-elastic.amazonaws.com",
+ *     clusterName: "sampleClusterName",
+ *     createTime: "2000-01-01T00:00:00.000Z",
+ *     kmsKeyId: "AWS_OWNED_KMS_KEY",
+ *     preferredBackupWindow: "01:00-01:30",
+ *     preferredMaintenanceWindow: "mon:00:00-mon:00:30",
+ *     shardCapacity: 2,
+ *     shardCount: 2,
+ *     shardInstanceCount: 1,
+ *     shards:     [],
+ *     status: "STOPPING",
+ *     subnetIds: [
+ *       "subnetId1",
+ *       "subnetId2"
+ *     ],
+ *     vpcSecurityGroupIds: [
+ *       "vpcSgId1, vpcSgId2"
+ *     ]
+ *   }
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class StopClusterCommand extends StopClusterCommand_base {

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

@@ -67,6 +67,7 @@ declare const TagResourceCommand_base: {
  * @throws {@link DocDBElasticServiceException}
  * <p>Base exception class for all service exceptions from DocDBElastic service.</p>
  *
+ *
  * @public
  */
 export declare class TagResourceCommand extends TagResourceCommand_base {

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

@@ -67,6 +67,7 @@ declare const UntagResourceCommand_base: {
  * @throws {@link DocDBElasticServiceException}
  * <p>Base exception class for all service exceptions from DocDBElastic service.</p>
  *
+ *
  * @public
  */
 export declare class UntagResourceCommand extends UntagResourceCommand_base {

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

@@ -116,6 +116,7 @@ declare const UpdateClusterCommand_base: {
  * @throws {@link DocDBElasticServiceException}
  * <p>Base exception class for all service exceptions from DocDBElastic service.</p>
  *
+ *
  * @public
  */
 export declare class UpdateClusterCommand extends UpdateClusterCommand_base {

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.775.0",
+  "version": "3.777.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "node ../../scripts/compilation/inline client-docdb-elastic",
@@ -21,7 +21,7 @@
     "@aws-crypto/sha256-browser": "5.2.0",
     "@aws-crypto/sha256-js": "5.2.0",
     "@aws-sdk/core": "3.775.0",
-    "@aws-sdk/credential-provider-node": "3.775.0",
+    "@aws-sdk/credential-provider-node": "3.777.0",
     "@aws-sdk/middleware-host-header": "3.775.0",
     "@aws-sdk/middleware-logger": "3.775.0",
     "@aws-sdk/middleware-recursion-detection": "3.775.0",