Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

RestoreGraphFromSnapshot

Restores a graph from a snapshot.

Request Syntax


POST /snapshots/snapshotIdentifier/restore HTTP/1.1
Content-type: application/json

{
   "deletionProtection": boolean,
   "graphName": "string",
   "provisionedMemory": number,
   "publicConnectivity": boolean,
   "replicaCount": number,
   "tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request uses the following URI parameters.

snapshotIdentifier

The ID of the snapshot in question.

Pattern: gs-[a-z0-9]{10}

Required: Yes

Request Body

The request accepts the following data in JSON format.

deletionProtection

A value that indicates whether the graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.

Type: Boolean

Required: No

graphName

A name for the new Neptune Analytics graph to be created from the snapshot.

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: (?!g-)[a-z][a-z0-9]*(-[a-z0-9]+)*

Required: Yes

provisionedMemory

The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.

Min = 128

Type: Integer

Valid Range: Minimum value of 128. Maximum value of 24576.

Required: No

publicConnectivity

Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated. (true to enable, or false to disable).

Type: Boolean

Required: No

replicaCount

The number of replicas in other AZs. Min =0, Max = 2, Default =1

Important

Additional charges equivalent to the m-NCUs selected for the graph apply for each replica.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 2.

Required: No

tags

Adds metadata tags to the snapshot. These tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: (?!aws:)[a-zA-Z+-=._:/]+

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "arn": "string",
   "buildNumber": "string",
   "createTime": number,
   "deletionProtection": boolean,
   "endpoint": "string",
   "id": "string",
   "kmsKeyIdentifier": "string",
   "name": "string",
   "provisionedMemory": number,
   "publicConnectivity": boolean,
   "replicaCount": number,
   "sourceSnapshotId": "string",
   "status": "string",
   "statusReason": "string",
   "vectorSearchConfiguration": { 
      "dimension": number
   }
}