Amazon Elastic Compute Cloud
User Guide (API Version 2013-02-01)
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Go to the Kindle Store to download this guide in Kindle format.Did this page help you?  Yes | No |  Tell us about it...

Amazon EBS API and Command Overview

The following table summarizes the available Amazon EBS commands and corresponding API actions for creating and using Amazon EBS volumes.

Command and API ActionDescription

ec2-attach-volume

AttachVolume

Attaches the specified volume to a specified instance, exposing the volume using the specified device name.

A volume can be attached to only a single instance at any time. The volume and instance must be in the same Availability Zone. The instance must be in the running or stopped state.

ec2-copy-snapshot

CopySnapshot

Copies a point-in-time snapshot of an Amazon Elastic Block Store (Amazon EBS) volume and stores it in Amazon Simple Storage Service (Amazon S3). You can copy the snapshot within the same region or from one region to another. You can use the snapshot to create new Amazon EBS volumes or Amazon Machine Images (AMIs).

ec2-create-snapshot

CreateSnapshot

Creates a snapshot of the volume you specify.

After the snapshot is created, you can use it to create volumes that contain exactly the same data as the original volume.

ec2-create-volume

CreateVolume

Creates a new Amazon EBS volume using the specified size and type, or based on a previously created snapshot.

ec2-delete-disk-image

Deletes a partially or fully uploaded disk image for conversion from Amazon S3.

ec2-delete-snapshot

DeleteSnapshot

Deletes the specified snapshot.

This command does not affect currently running Amazon EBS volumes, regardless of whether they were used to create the snapshot or were derived from the snapshot.

ec2-delete-volume

DeleteVolume

Deletes the specified volume. The command does not delete any snapshots that were created from the volume.

ec2-describe-snapshot-attribute

DescribeSnapshotAttribute

Describes attributes for a snapshot.

ec2-describe-snapshots

DescribeSnapshots

Describes the specified snapshot.

Describes all snapshots, including their source volume, snapshot initiation time, progress (percentage complete), and status (pending, completed, and so on.).

ec2-describe-volumes

DescribeVolumes

Describes your volumes, including size, volume type, source snapshot, Availability Zone, creation time, status (available or in-use). If the volume is in-use, an attachment line shows the volume ID, the instance ID to which the volume is attached, the device name exposed to the instance, its status (attaching, attached, detaching, detached), and when it attached.

ec2-describe-volume-attribute

DescribeVolumeAttribute

Describes an attribute of a volume.

ec2-describe-volume-status

DescribeVolumeStatus

Describes the status of one or more volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes.

ec2-detach-volume

DetachVolume

Detaches the specified volume from the instance it's attached to.

This command does not delete the volume. The volume can be attached to another instance and will have the same data as when it was detached.

ec2-enable-volume-io

EnableVolumeIO

Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.

ec2-import-volume

ImportVolume

Creates a new import volume task using metadata from the specified disk image, and imports the image to Amazon EC2.

ec2-modify-snapshot-attribute

ModifySnapshotAttribute

Modifies permissions for a snapshot (i.e., who can create volumes from the snapshot). You can specify one or more AWS accounts, or specify all to make the snapshot public.

ec2-modify-volume-attribute

ModifyVolumeAttribute

Modifies a volume's attributes to determine whether a volume should be automatically enabled for I/O operations.

ec2-reset-snapshot-attribute

ResetSnapshotAttribute

Resets permission settings for the specified snapshot.