CreateDiskSnapshot
Creates a snapshot of a block storage disk. You can use snapshots for backups, to make copies of disks, and to save data before shutting down a Lightsail instance.
You can take a snapshot of an attached disk that is in use; however, snapshots only capture data that has been written to your disk at the time the snapshot command is issued. This may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the disk long enough to take a snapshot, your snapshot should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should unmount the disk from within the Lightsail instance, issue the create disk snapshot command, and then remount the disk to ensure a consistent and complete snapshot. You may remount and use your disk while the snapshot status is pending.
You can also use this operation to create a snapshot of an instance's system volume. You
might want to do this, for example, to recover data from the system volume of a botched
instance or to create a backup of the system volume like you would for a block storage disk.
To create a snapshot of a system volume, just define the instance name
parameter
when issuing the snapshot command, and a snapshot of the defined instance's system volume will
be created. After the snapshot is available, you can create a block storage disk from the
snapshot and attach it to a running instance to access the data on the disk.
The create disk snapshot
operation supports tag-based access control via
request tags. For more information, see the Amazon Lightsail Developer Guide.
Request Syntax
{
"diskName": "string
",
"diskSnapshotName": "string
",
"instanceName": "string
",
"tags": [
{
"key": "string
",
"value": "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.
- diskName
-
The unique name of the source disk (
Disk-Virginia-1
).Note
This parameter cannot be defined together with the
instance name
parameter. Thedisk name
andinstance name
parameters are mutually exclusive.Type: String
Pattern:
\w[\w\-]*\w
Required: No
- diskSnapshotName
-
The name of the destination disk snapshot (
my-disk-snapshot
) based on the source disk.Type: String
Pattern:
\w[\w\-]*\w
Required: Yes
- instanceName
-
The unique name of the source instance (
Amazon_Linux-512MB-Virginia-1
). When this is defined, a snapshot of the instance's system volume is created.Note
This parameter cannot be defined together with the
disk name
parameter. Theinstance name
anddisk name
parameters are mutually exclusive.Type: String
Pattern:
\w[\w\-]*\w
Required: No
-
The tag keys and optional values to add to the resource during create.
Use the
TagResource
action to tag a resource after it's created.Type: Array of Tag objects
Required: No
Response Syntax
{
"operations": [
{
"createdAt": number,
"errorCode": "string",
"errorDetails": "string",
"id": "string",
"isTerminal": boolean,
"location": {
"availabilityZone": "string",
"regionName": "string"
},
"operationDetails": "string",
"operationType": "string",
"resourceName": "string",
"resourceType": "string",
"status": "string",
"statusChangedAt": number
}
]
}
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.
- operations
-
An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
Type: Array of Operation objects
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
- AccountSetupInProgressException
-
Lightsail throws this exception when an account is still in the setup in progress state.
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-1
to 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: