GetGraphSnapshot
Retrieves a specified graph snapshot.
Request Syntax
GET /snapshots/snapshotIdentifier HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- snapshotIdentifier
-
The ID of the snapshot to retrieve.
Pattern:
gs-[a-z0-9]{10}Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
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 200 response.
The following data is returned in JSON format by the service.
- arn
-
The ARN of the graph snapshot.
Type: String
- id
-
The unique identifier of the graph snapshot.
Type: String
Pattern:
gs-[a-z0-9]{10} - kmsKeyIdentifier
-
The ID of the KMS key used to encrypt and decrypt the snapshot.
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 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]+)* - snapshotCreateTime
-
The time when the snapshot was created.
Type: Timestamp
- sourceGraphId
-
The graph identifier for the graph for which a snapshot is to be created.
Type: String
Pattern:
g-[a-z0-9]{10} - status
-
The status of the graph snapshot.
Type: String
Valid Values:
CREATING | AVAILABLE | DELETING | FAILED
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerException
-
A failure occurred on the server.
HTTP Status Code: 500
- ResourceNotFoundException
-
A specified resource could not be located.
HTTP Status Code: 404
- ThrottlingException
-
The exception was interrupted by throttling.
HTTP Status Code: 429
- ValidationException
-
A 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:
