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

ModifyVolume

You can modify several parameters of an existing EBS volume, including volume size, volume type, and IOPS capacity. If your EBS volume is attached to a current-generation EC2 instance type, you may be able to apply these changes without stopping the instance or detaching the volume from it. For more information about modifying an EBS volume running Linux, see Modifying the Size, IOPS, or Type of an EBS Volume on Linux. For more information about modifying an EBS volume running Windows, see Modifying the Size, IOPS, or Type of an EBS Volume on Windows.

When you complete a resize operation on your volume, you need to extend the volume's file-system size to take advantage of the new storage capacity. For information about extending a Linux file system, see Extending a Linux File System. For information about extending a Windows file system, see Extending a Windows File System.

You can use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. You can also track the status of a modification using the DescribeVolumesModifications API. For information about tracking status changes using either method, see Monitoring Volume Modifications.

Note

With previous-generation instance types, resizing an EBS volume may require detaching and reattaching the volume or stopping and restarting the instance. For more information about modifying an EBS volume running Linux, see Modifying the Size, IOPS, or Type of an EBS Volume on Linux. For more information about modifying an EBS volume running Windows, see Modifying the Size, IOPS, or Type of an EBS Volume on Windows.

Note

If you reach the maximum volume modification rate per volume limit, you will need to wait at least six hours before applying further modifications to the affected EBS volume.

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.

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

Iops

Target IOPS rate of the volume to be modified.

Only valid for Provisioned IOPS SSD (io1) volumes. For more information about io1 IOPS configuration, see http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html#EBSVolumeTypes_piops.

Default: If no IOPS value is specified, the existing value is retained.

Type: Integer

Required: No

Size

Target size in GiB of the volume to be modified. Target volume size must be greater than or equal to than the existing size of the volume. For information about available EBS volume sizes, see http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html.

Default: If no size is specified, the existing size is retained.

Type: Integer

Required: No

VolumeId

Type: String

Required: Yes

VolumeType

Target EBS volume type of the volume to be modified

The API does not support modifications for volume type standard. You also cannot change the type of a volume to standard.

Default: If no type is specified, the existing type is retained.

Type: String

Valid Values: standard | io1 | gp2 | sc1 | st1

Required: No

Response Elements

The following elements are returned by the service.

requestId

The ID of the request.

Type: String

volumeModification

A VolumeModification object.

Type: VolumeModification object

Errors

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

Example

Modify size, type, and IOPS provisioning of a volume

Sample Request

https://ec2.amazonaws.com/?Action=ModifyVolume &VolumeId=vol-1234567890EXAMPLE &VolumeType=io1 &Iops=10000 &Size=200 &Version=2016-11-15

Sample Response

<ModifyVolumeResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>5jkdf074-37ed-4004-8671-a78ee82bf1cbEXAMPLE</requestId> <volumeModification> <targetIops>10000</targetIops> <originalIops>300</originalIops> <modificationState>modifying</modificationState> <targetSize>200</targetSize> <targetVolumeType>io1</targetVolumeType> <volumeId>vol-1234567890EXAMPLE</volumeId> <progress>0</progress> <startTime>2017-01-19T23:58:04.922Z</startTime> <originalSize>100</originalSize> <originalVolumeType>gp2</originalVolumeType> </volumeModification> </ModifyVolumeResponse>

See Also

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