CopySnapshot

Copies a manual snapshot of an instance or disk as another manual snapshot, or copies an automatic snapshot of an instance or disk as a manual snapshot. This operation can also be used to copy a manual or automatic snapshot of an instance or a disk from one AWS Region to another in Amazon Lightsail.

When copying a manual snapshot, be sure to define the source region, source snapshot name, and target snapshot name parameters.

When copying an automatic snapshot, be sure to define the source region, source resource name, target snapshot name, and either the restore date or the use latest restorable auto snapshot parameters.

Request Syntax

{
   "restoreDate": "string",
   "sourceRegion": "string",
   "sourceResourceName": "string",
   "sourceSnapshotName": "string",
   "targetSnapshotName": "string",
   "useLatestRestorableAutoSnapshot": boolean
}

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.

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.

Errors

For information about the errors that are common to all actions, see Common Errors.

Examples

In the following example or examples, the Authorization header contents (AUTHPARAMS) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself.

Copy an automatic snapshot

The following example creates a new manual snapshot named CopiedAutoSnapshot-2019-09-25 as a copy of the existing automatic snapshot named 2019-09-25 from the WordPress-1 instance in the us-west-2 AWS Region.

Sample Request

POST / HTTP/1.1
Host: lightsail.us-west-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: Lightsail_20161128.CopySnapshot
Content-Type: application/x-amz-json-1.1
User-Agent: AGENT
X-Amz-Date: 20190927T194244Z
Authorization: AUTHPARAMS
Content-Length: 150

{
	"sourceResourceName": "WordPress-1",
	"restoreDate": "2019-09-25",
	"targetSnapshotName": "CopiedAutoSnapshot-2019-09-25",
	"sourceRegion": "us-west-2"
}

Sample Response

HTTP/1.1 200 OK
Server: Server
Date: Fri, 27 Sep 2019 19:42:46 GMT
Content-Type: application/x-amz-json-1.1
Content-Length: 380
x-amzn-RequestId: 69449102-9023-431e-8a00-7EXAMPLE6970
Connection: keep-alive

{
	"operations": [{
		"createdAt": 1.56961336589E9,
		"id": "0710de23-b848-4146-887d-ec12093c049d",
		"isTerminal": false,
		"location": {
			"availabilityZone": "all",
			"regionName": "us-west-2"
		},
		"operationDetails": "us-west-2:WordPress-1",
		"operationType": "CopySnapshot",
		"resourceName": "CopiedAutoSnapshot-2019-09-25",
		"resourceType": "InstanceSnapshot",
		"status": "Started",
		"statusChangedAt": 1.56961336589E9
	}]
}

Copy a manual snapshot

The following example creates a new manual snapshot named CopiedManualSnapshot-2019-09-25 as a copy of the existing manual snapshot named WordPress-1-1569608575 in the us-west-2 AWS Region.

Sample Request

POST / HTTP/1.1
Host: lightsail.us-west-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: Lightsail_20161128.CopySnapshot
Content-Type: application/x-amz-json-1.1
User-Agent: AGENT
X-Amz-Date: 20190927T195200Z
Authorization: AUTHPARAMS
Content-Length: 134

{
	"sourceSnapshotName": "WordPress-1-1569608575",
	"targetSnapshotName": "CopiedManualSnapshot-2019-09-25",
	"sourceRegion": "us-west-2"
}

Sample Response

HTTP/1.1 200 OK
Server: Server
Date: Fri, 27 Sep 2019 19:52:01 GMT
Content-Type: application/x-amz-json-1.1
Content-Length: 395
x-amzn-RequestId: 5e3e211b-0afe-439e-bead-8EXAMPLEb3c8
Connection: keep-alive

{
	"operations": [{
		"createdAt": 1.569613921044E9,
		"id": "0d4f2d2a-78ce-44d1-82fe-33588af9afa0",
		"isTerminal": false,
		"location": {
			"availabilityZone": "all",
			"regionName": "us-west-2"
		},
		"operationDetails": "us-west-2:WordPress-1-1569608575",
		"operationType": "CopySnapshot",
		"resourceName": "CopiedManualSnapshot-2019-09-25",
		"resourceType": "InstanceSnapshot",
		"status": "Started",
		"statusChangedAt": 1.569613921044E9
	}]
}

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: