- 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.
CreateGraphSnapshotCommand
Creates a snapshot of the specific graph.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { NeptuneGraphClient, CreateGraphSnapshotCommand } from "@aws-sdk/client-neptune-graph"; // ES Modules import
// const { NeptuneGraphClient, CreateGraphSnapshotCommand } = require("@aws-sdk/client-neptune-graph"); // CommonJS import
const client = new NeptuneGraphClient(config);
const input = { // CreateGraphSnapshotInput
graphIdentifier: "STRING_VALUE", // required
snapshotName: "STRING_VALUE", // required
tags: { // TagMap
"<keys>": "STRING_VALUE",
},
};
const command = new CreateGraphSnapshotCommand(input);
const response = await client.send(command);
// { // CreateGraphSnapshotOutput
// 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",
// };
CreateGraphSnapshotCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
graphIdentifier Required | string | undefined | The unique identifier of the Neptune Analytics graph. |
snapshotName 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. |
tags | Record<string, string> | undefined | Adds metadata tags to the new graph. These tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy. |
CreateGraphSnapshotCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
arn Required | string | undefined | The ARN of the snapshot created. |
id Required | string | undefined | The ID of the snapshot created. |
name Required | string | undefined | The name of the snapshot created. |
kmsKeyIdentifier | string | undefined | The ID of the KMS key used to encrypt and decrypt graph data. |
snapshotCreateTime | Date | undefined | The snapshot creation time |
sourceGraphId | string | undefined | The Id of the Neptune Analytics graph from which the snapshot is created. |
status | SnapshotStatus | undefined | The current state of the 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. |
ServiceQuotaExceededException | client | A service quota was exceeded. |
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. |