CreateDiskFromSnapshot
Creates a block storage disk from a disk snapshot that can be attached to a Lightsail
instance in the same Availability Zone (e.g., us-east-2a
). The disk is created in
the regional endpoint that you send the HTTP request to. For more information, see
Regions and Availability Zones in Lightsail.
The create disk from snapshot
operation supports tag-based access control
via request tags and resource tags applied to the resource identified by diskSnapshotName.
For
more information, see the Lightsail Dev Guide.
Request Syntax
{ "availabilityZone": "
string
", "diskName": "string
", "diskSnapshotName": "string
", "sizeInGb":number
, "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.
- availabilityZone
-
The Availability Zone where you want to create the disk (e.g.,
us-east-2a
). Choose the same Availability Zone as the Lightsail instance where you want to create the disk.Use the GetRegions operation to list the Availability Zones where Lightsail is currently available.
Type: String
Pattern:
.*\S.*
Required: Yes
- diskName
-
The unique Lightsail disk name (e.g.,
my-disk
).Type: String
Pattern:
\w[\w\-]*\w
Required: Yes
- diskSnapshotName
-
The name of the disk snapshot (e.g.,
my-snapshot
) from which to create the new storage disk.Type: String
Pattern:
\w[\w\-]*\w
Required: Yes
- sizeInGb
-
The size of the disk in GB (e.g.,
32
).Type: Integer
Required: Yes
- tags
-
The tag keys and optional values to add to the resource during create.
To tag a resource after it has been created, see the
tag resource
operation.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 object describing the API operations.
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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-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: