- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DeleteGraphSnapshotCommand
Deletes the specifed graph snapshot.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { NeptuneGraphClient, DeleteGraphSnapshotCommand } from "@aws-sdk/client-neptune-graph"; // ES Modules import
// const { NeptuneGraphClient, DeleteGraphSnapshotCommand } = require("@aws-sdk/client-neptune-graph"); // CommonJS import
const client = new NeptuneGraphClient(config);
const input = { // DeleteGraphSnapshotInput
snapshotIdentifier: "STRING_VALUE", // required
};
const command = new DeleteGraphSnapshotCommand(input);
const response = await client.send(command);
// { // DeleteGraphSnapshotOutput
// id: "STRING_VALUE", // required
// name: "STRING_VALUE", // required
// arn: "STRING_VALUE", // required
// sourceGraphId: "STRING_VALUE",
// snapshotCreateTime: new Date("TIMESTAMP"),
// status: "CREATING" || "AVAILABLE" || "DELETING" || "FAILED",
// kmsKeyIdentifier: "STRING_VALUE",
// };
DeleteGraphSnapshotCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
snapshotIdentifier Required | string | undefined | ID of the graph snapshot to be deleted. |
DeleteGraphSnapshotCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
arn Required | string | undefined | The ARN of the graph snapshot. |
id Required | string | undefined | The unique identifier of the graph snapshot. |
name Required | string | undefined | The snapshot name. For example: The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens. Only lowercase letters are allowed. |
kmsKeyIdentifier | string | undefined | The ID of the KMS key used to encrypt and decrypt the snapshot. |
snapshotCreateTime | Date | undefined | The time when the snapshot was created. |
sourceGraphId | string | undefined | The graph identifier for the graph from which the snapshot was created. |
status | SnapshotStatus | undefined | The status of the graph snapshot. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
ConflictException | client | Raised when a conflict is encountered. |
InternalServerException | server | A failure occurred on the server. |
ResourceNotFoundException | client | A specified resource could not be located. |
ThrottlingException | client | The exception was interrupted by throttling. |
ValidationException | client | A resource could not be validated. |
NeptuneGraphServiceException | Base exception class for all service exceptions from NeptuneGraph service. |