GetAutoSnapshots
Returns the available automatic snapshots for an instance or disk. For more information, see the Amazon Lightsail Developer Guide.
Request Syntax
{
"resourceName": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- resourceName
-
The name of the source instance or disk from which to get automatic snapshot information.
Type: String
Pattern:
\w[\w\-]*\wRequired: Yes
Response Syntax
{
"autoSnapshots": [
{
"createdAt": number,
"date": "string",
"fromAttachedDisks": [
{
"path": "string",
"sizeInGb": number
}
],
"status": "string"
}
],
"resourceName": "string",
"resourceType": "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.
- autoSnapshots
-
An array of objects that describe the automatic snapshots that are available for the specified source instance or disk.
Type: Array of AutoSnapshotDetails objects
- resourceName
-
The name of the source instance or disk for the automatic snapshots.
Type: String
Pattern:
\w[\w\-]*\w - resourceType
-
The resource type of the automatic snapshot. The possible values are
Instance, andDisk.Type: String
Valid Values:
ContainerService | Instance | StaticIp | KeyPair | InstanceSnapshot | Domain | PeeredVpc | LoadBalancer | LoadBalancerTlsCertificate | Disk | DiskSnapshot | RelationalDatabase | RelationalDatabaseSnapshot | ExportSnapshotRecord | CloudFormationStackRecord | Alarm | ContactMethod | Distribution | Certificate | Bucket
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
HTTP Status Code: 400
- InvalidInputException
-
Lightsail throws this exception when user input does not conform to the validation rules of an input field.
Note
Domain and distribution APIs are only available in the N. Virginia (
us-east-1) AWS Region. Please set your AWS Region configuration tous-east-1to create, view, or edit these resources.HTTP Status Code: 400
- NotFoundException
-
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
- OperationFailureException
-
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
- ServiceException
-
A general service exception.
HTTP Status Code: 500
- UnauthenticatedException
-
Lightsail throws this exception when the user has not been authenticated.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
