Amazon Elastic Compute Cloud
API Reference (API Version 2014-02-01)
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Did this page help you?  Yes | No |  Tell us about it...

AttachVolume

Description

Attaches an Amazon EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.

For a list of supported device names, see Attaching the Volume to an Instance. Any device names that aren't reserved for instance store volumes can be used for Amazon EBS volumes. For more information, see Amazon EC2 Instance Store in the Amazon Elastic Compute Cloud User Guide.

Note

If a volume has an AWS Marketplace product code:

  • The volume can only be attached to the root device of a stopped instance.

  • You must be subscribed to the AWS Marketplace code that is on the volume.

  • The configuration (instance type, operating system) of the instance must support that specific AWS Marketplace code. For example, you cannot take a volume from a Windows instance and attach it to a Linux instance.

  • AWS Marketplace product codes are copied from the volume to the instance.

For an overview of the AWS Marketplace, see https://aws.amazon.com/marketplace/help/200900000. For details on how to use the AWS Marketplace, see AWS Marketplace.

Request Parameters

VolumeId

The ID of the Amazon EBS volume. The volume and instance must be within the same Availability Zone.

Type: String

Default: None

Required: Yes

InstanceId

The ID of the instance.

Type: String

Default: None

Required: Yes

Device

The device name to expose to the instance (for example, /dev/sdh or xvdh).

Type: String

Default: None

Required: Yes

Response Elements

The following elements are returned in an AttachVolumeResponse element.

requestId

The ID of the request.

Type: xsd:string

volumeId

The ID of the volume.

Type: xsd:string

instanceId

The ID of the instance.

Type: xsd:string

device

The device name.

Type: xsd:string

status

The attachment state of the volume.

Type: xsd:string

Valid values: attaching | attached | detaching | detached

attachTime

The time stamp when the attachment initiated.

Type: xsd:dateTime

Errors

The following are some of the client API errors you might encounter when using this request. For more information about common API errors, see Common Causes of EC2 API Client Errors. For a summary of API error codes, see Client Error Codes.

Examples

Example Request

This example request attaches the volume with the ID vol-1a2b3c4d to the instance with the ID i-1a2b3c4d and exposes it as /dev/sdh.

https://ec2.amazonaws.com/?Action=AttachVolume
&VolumeId=vol-1a2b3c4d
&InstanceId=i-1a2b3c4d
&Device=/dev/sdh
&AUTHPARAMS

Example Response

<AttachVolumeResponse xmlns="http://ec2.amazonaws.com/doc/2014-02-01/">
  <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>
  <volumeId>vol-1a2b3c4d</volumeId>
  <instanceId>i-1a2b3c4d</instanceId>
  <device>/dev/sdh</device>
  <status>attaching</status>
  <attachTime>YYYY-MM-DDTHH:MM:SS.000Z</attachTime>
</AttachVolumeResponse>