Menu
Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

CreateSnapshot

Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance.

When a snapshot is created, any AWS Marketplace product codes that are associated with the source volume are propagated to the snapshot.

You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your EBS volume 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 volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is pending.

To create a snapshot for EBS volumes that serve as root devices, you should stop the instance before taking the snapshot.

Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected.

For more information, see Amazon Elastic Block Store and Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

Description

A description for the snapshot.

Type: String

Required: No

DryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Type: Boolean

Required: No

VolumeId

The ID of the EBS volume.

Type: String

Required: Yes

Response Elements

The following elements are returned by the service.

dataEncryptionKeyId

The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by the DescribeSnapshots API operation.

Type: String

description

The description for the snapshot.

Type: String

encrypted

Indicates whether the snapshot is encrypted.

Type: Boolean

kmsKeyId

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.

Type: String

ownerAlias

Value from an Amazon-maintained list (amazon | aws-marketplace | microsoft) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console.

Type: String

ownerId

The AWS account ID of the EBS snapshot owner.

Type: String

progress

The progress of the snapshot, as a percentage.

Type: String

requestId

The ID of the request.

Type: String

snapshotId

The ID of the snapshot. Each snapshot receives a unique identifier when it is created.

Type: String

startTime

The time stamp when the snapshot was initiated.

Type: Timestamp

status

The snapshot state.

Type: String

Valid Values: pending | completed | error

statusMessage

Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper AWS Key Management Service (AWS KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by the DescribeSnapshots API operation.

Type: String

tagSet

Any tags assigned to the snapshot.

Type: Array of Tag objects

volumeId

The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.

Type: String

volumeSize

The size of the volume, in GiB.

Type: Integer

Errors

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

Example

Example

This example creates a snapshot of the volume with the ID vol-1234567890abcdef0.

Sample Request

https://ec2.amazonaws.com/?Action=CreateSnapshot
&VolumeId=vol-1234567890abcdef0
&Description=Daily+Backup
&AUTHPARAMS

Sample Response

<CreateSnapshotResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
  <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>
  <snapshotId>snap-1234567890abcdef0</snapshotId>
  <volumeId>vol-1234567890abcdef0</volumeId>
  <status>pending</status>
  <startTime>YYYY-MM-DDTHH:MM:SS.000Z</startTime>
  <progress>60%</progress>
  <ownerId>111122223333</ownerId>
  <volumeSize>30</volumeSize>
  <description>Daily Backup</description>
</CreateSnapshotResponse>

See Also

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