CreateGraphSnapshot
Creates a snapshot of the specific graph.
Request Syntax
POST /snapshots HTTP/1.1
Content-type: application/json
{
"graphIdentifier": "string",
"snapshotName": "string",
"tags": {
"string" : "string"
}
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- graphIdentifier
-
The unique identifier of the Neptune Analytics graph.
Type: String
Pattern:
g-[a-z0-9]{10}Required: Yes
- snapshotName
-
The snapshot name. For example:
my-snapshot-1.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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
(?!gs-)[a-z][a-z0-9]*(-[a-z0-9]+)*Required: Yes
-
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.
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",
"id": "string",
"kmsKeyIdentifier": "string",
"name": "string",
"snapshotCreateTime": number,
"sourceGraphId": "string",
"status": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 201 response.
The following data is returned in JSON format by the service.
- arn
-
The ARN of the snapshot created.
Type: String
- id
-
The ID of the snapshot created.
Type: String
Pattern:
gs-[a-z0-9]{10} - kmsKeyIdentifier
-
The ID of the KMS key used to encrypt and decrypt graph data.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36} - name
-
The name of the snapshot created.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
(?!gs-)[a-z][a-z0-9]*(-[a-z0-9]+)* - snapshotCreateTime
-
The snapshot creation time
Type: Timestamp
- sourceGraphId
-
The Id of the Neptune Analytics graph from which the snapshot is created.
Type: String
Pattern:
g-[a-z0-9]{10} - status
-
The current state of the snapshot.
Type: String
Valid Values:
CREATING | AVAILABLE | DELETING | FAILED
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConflictException
-
Raised when a conflict is encountered.
- message
-
A message describing the problem.
- reason
-
The reason for the conflict exception.
HTTP Status Code: 409
- InternalServerException
-
A failure occurred on the server.
- message
-
A message describing the problem.
HTTP Status Code: 500
- ResourceNotFoundException
-
A specified resource could not be located.
- message
-
A message describing the problem.
HTTP Status Code: 404
- ServiceQuotaExceededException
-
A service quota was exceeded.
- quotaCode
-
Service quota code of the resource for which quota was exceeded.
- resourceId
-
The identifier of the resource that exceeded quota.
- resourceType
-
The type of the resource that exceeded quota. Ex: Graph, Snapshot
- serviceCode
-
The service code that exceeded quota.
HTTP Status Code: 402
- ThrottlingException
-
The exception was interrupted by throttling.
- message
-
A message describing the problem.
HTTP Status Code: 429
- ValidationException
-
A resource could not be validated.
- message
-
A message describing the problem.
- reason
-
The reason that the resource could not be validated.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
