DescribeSnapshot
Returns information about an enhanced snapshot. To see a list of the snapshots in your account, use ListSnapshots.
Request Syntax
{
"SnapshotName": "string"
}Request Parameters
The request accepts the following data in JSON format.
- SnapshotName
-
The name of the enhanced snapshot. You can retrieve this value using
ListSnapshots.Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[a-zA-Z0-9_.-]+Required: Yes
Response Syntax
{
"SnapshotInfoDetails": {
"RuntimeEnvironment": "string",
"SnapshotArn": "string",
"SnapshotCreationTimestamp": number,
"SnapshotDescription": "string",
"SnapshotEncryptionConfigurationDescription": {
"KeyId": "string",
"KeyType": "string"
},
"SnapshotFormat": "string",
"SnapshotInitiator": "string",
"SnapshotInitiatorOperation": "string",
"SnapshotName": "string",
"SnapshotSizeInBytes": number,
"SnapshotSourceDescription": {
"S3PrefixLocation": {
"BucketARN": "string",
"KeyPrefix": "string"
},
"SourceApplicationDescription": {
"ApplicationCreationTimestamp": number,
"ApplicationName": "string",
"ApplicationVersionId": number
}
},
"SnapshotStatus": "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.
- SnapshotInfoDetails
-
An object containing information about the enhanced snapshot.
Type: SnapshotInfoDetails object
Errors
- InvalidArgumentException
-
The specified input parameter value is not valid.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified application, snapshot, or snapshot operation can't be found.
HTTP Status Code: 400
- UnsupportedOperationException
-
The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
