DescribeVolumesModifications
Reports the current modification status of EBS volumes.
Current-generation EBS volumes support modification of attributes including type,
size,
and (for io1
volumes) IOPS provisioning while either attached to or detached from
an instance. Following an action from the API or the console to modify a volume, the
status of
the modification may be modifying
, optimizing
,
completed
, or failed
. If a volume has never been modified, then
certain elements of the returned VolumeModification
objects are null.
You can also 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. For more information, see Monitoring Volume Modifications".
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 isUnauthorizedOperation
.Type: Boolean
Required: No
- Filter.N
-
One or more filters. Supported filters:
volume-id
,modification-state
,target-size
,target-iops
,target-volume-type
,original-size
,original-iops
,original-volume-type
,start-time
.Type: Array of Filter objects
Required: No
- MaxResults
-
The maximum number of results (up to a limit of 500) to be returned in a paginated request.
Type: Integer
Required: No
- NextToken
-
The
nextToken
value returned by a previous paginated request.Type: String
Required: No
- VolumeId.N
-
One or more volume IDs for which in-progress modifications will be described.
Type: Array of strings
Required: No
Response Elements
The following elements are returned by the service.
- nextToken
-
Token for pagination, null if there are no more results
Type: String
- requestId
-
The ID of the request.
Type: String
- volumeModificationSet
-
A list of returned VolumeModification objects.
Type: Array of VolumeModification objects
Errors
For information about the errors that are common to all actions, see Common Client Errors.
Examples
Display volume status after modifications to size, type, and IOPS provisioning
Sample Request
https://ec2.amazonaws.com/?Action=DescribeVolumesModifications &VolumeId.1=vol-0123456789EXAMPLE &Version=2016-11-15
Sample Response
<DescribeVolumesModificationsResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> <volumeModificationSet> <item> <targetIops>10000</targetIops> <originalIops>300</originalIops> <modificationState>optimizing</modificationState> <targetSize>200</targetSize> <targetVolumeType>io1</targetVolumeType> <volumeId>vol-0123456789EXAMPLE</volumeId> <progress>40</progress> <startTime>2017-01-19T23:58:04.922Z</startTime> <originalSize>100</originalSize> <originalVolumeType>gp2</originalVolumeType> </item> </volumeModificationSet> </DescribeVolumesModificationsResponse>
Display information about all volumes in a region with a modification state of optimizing or completed.
Sample Request
https://ec2.amazonaws.com/?Action=DescribeVolumesModifications &Filter.1.Value.2=completed &Filter.1.Value.1=optimizing &Version=2016-11-15 &Filter.1.Name=modification-state
Sample Response
<DescribeVolumesModificationsResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>35fdf8d3-6ffa-46dc-8f8e-62fe70bc31a2</requestId> <volumeModificationSet> <item> <targetIops>10000</targetIops> <originalIops>100</originalIops> <modificationState>optimizing</modificationState> <targetSize>2000</targetSize> <targetVolumeType>io1</targetVolumeType> <volumeId>vol-06397e7a0eEXAMPLE</volumeId> <progress>3</progress> <startTime>2017-02-10T23:40:57.612Z</startTime> <originalSize>10</originalSize> <originalVolumeType>gp2</originalVolumeType> </item> <item> <targetIops>10000</targetIops> <originalIops>100</originalIops> <modificationState>completed</modificationState> <targetSize>200</targetSize> <targetVolumeType>io1</targetVolumeType> <volumeId>vol-bEXAMPLE</volumeId> <progress>100</progress> <startTime>2017-02-10T22:50:52.207Z</startTime> <endTime>2017-02-10T22:56:04.823Z</endTime> <originalSize>8</originalSize> <originalVolumeType>gp2</originalVolumeType> </item> </volumeModificationSet> </DescribeVolumesModificationsResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: