DeleteClusterSnapshotCommand

Delete an elastic cluster snapshot.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DocDBElasticClient, DeleteClusterSnapshotCommand } from "@aws-sdk/client-docdb-elastic"; // ES Modules import
// const { DocDBElasticClient, DeleteClusterSnapshotCommand } = require("@aws-sdk/client-docdb-elastic"); // CommonJS import
const client = new DocDBElasticClient(config);
const input = { // DeleteClusterSnapshotInput
  snapshotArn: "STRING_VALUE", // required
};
const command = new DeleteClusterSnapshotCommand(input);
const response = await client.send(command);
// { // DeleteClusterSnapshotOutput
//   snapshot: { // ClusterSnapshot
//     subnetIds: [ // StringList // required
//       "STRING_VALUE",
//     ],
//     snapshotName: "STRING_VALUE", // required
//     snapshotArn: "STRING_VALUE", // required
//     snapshotCreationTime: "STRING_VALUE", // required
//     clusterArn: "STRING_VALUE", // required
//     clusterCreationTime: "STRING_VALUE", // required
//     status: "STRING_VALUE", // required
//     vpcSecurityGroupIds: [ // required
//       "STRING_VALUE",
//     ],
//     adminUserName: "STRING_VALUE", // required
//     kmsKeyId: "STRING_VALUE", // required
//     snapshotType: "STRING_VALUE",
//   },
// };

DeleteClusterSnapshotCommand Input

Parameter
Type
Description
snapshotArn
Required
string | undefined

The ARN identifier of the elastic cluster snapshot that is to be deleted.

DeleteClusterSnapshotCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
snapshot
Required
ClusterSnapshot | undefined

Returns information about the newly deleted elastic cluster snapshot.

Throws

Name
Fault
Details
AccessDeniedException
client

An exception that occurs when there are not sufficient permissions to perform an action.

ConflictException
client

There was an access conflict.

InternalServerException
server

There was an internal server error.

ResourceNotFoundException
client

The specified resource could not be located.

ThrottlingException
client

ThrottlingException will be thrown when request was denied due to request throttling.

ValidationException
client

A structure defining a validation exception.

DocDBElasticServiceException
Base exception class for all service exceptions from DocDBElastic service.