- 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.
UpdateGraphCommand
Updates the configuration of a specified Neptune Analytics graph
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { NeptuneGraphClient, UpdateGraphCommand } from "@aws-sdk/client-neptune-graph"; // ES Modules import
// const { NeptuneGraphClient, UpdateGraphCommand } = require("@aws-sdk/client-neptune-graph"); // CommonJS import
const client = new NeptuneGraphClient(config);
const input = { // UpdateGraphInput
graphIdentifier: "STRING_VALUE", // required
publicConnectivity: true || false,
provisionedMemory: Number("int"),
deletionProtection: true || false,
};
const command = new UpdateGraphCommand(input);
const response = await client.send(command);
// { // UpdateGraphOutput
// id: "STRING_VALUE", // required
// name: "STRING_VALUE", // required
// arn: "STRING_VALUE", // required
// status: "CREATING" || "AVAILABLE" || "DELETING" || "RESETTING" || "UPDATING" || "SNAPSHOTTING" || "FAILED" || "IMPORTING",
// statusReason: "STRING_VALUE",
// createTime: new Date("TIMESTAMP"),
// provisionedMemory: Number("int"),
// endpoint: "STRING_VALUE",
// publicConnectivity: true || false,
// vectorSearchConfiguration: { // VectorSearchConfiguration
// dimension: Number("int"), // required
// },
// replicaCount: Number("int"),
// kmsKeyIdentifier: "STRING_VALUE",
// sourceSnapshotId: "STRING_VALUE",
// deletionProtection: true || false,
// buildNumber: "STRING_VALUE",
// };
UpdateGraphCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
graphIdentifier Required | string | undefined | The unique identifier of the Neptune Analytics graph. |
deletionProtection | boolean | undefined | A value that indicates whether the graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled. |
provisionedMemory | number | undefined | The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Min = 16 |
publicConnectivity | boolean | undefined | Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated. ( |
UpdateGraphCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
arn Required | string | undefined | The ARN associated with the graph. |
id Required | string | undefined | The unique identifier of the graph. |
name Required | string | undefined | The name of the graph. |
buildNumber | string | undefined | The build number of the graph. |
createTime | Date | undefined | The time at which the graph was created. |
deletionProtection | boolean | undefined | If |
endpoint | string | undefined | The graph endpoint. |
kmsKeyIdentifier | string | undefined | The ID of the KMS key used to encrypt and decrypt graph data. |
provisionedMemory | number | undefined | The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph. |
publicConnectivity | boolean | undefined | If |
replicaCount | number | undefined | The number of replicas for the graph. |
sourceSnapshotId | string | undefined | The ID of the snapshot from which the graph was created, if any. |
status | GraphStatus | undefined | The status of the graph. |
statusReason | string | undefined | The reason that the graph has this status. |
vectorSearchConfiguration | VectorSearchConfiguration | undefined | Specifies the number of dimensions for vector embeddings loaded into the graph. Max = 65535 |
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. |