volumes_modifications

Creates, updates, deletes, gets or lists a volumes_modifications resource.

Overview

Name	volumes_modifications
Type	Resource
Id	aws.ec2.volumes_modifications

Fields

The following fields are returned by SELECT queries:

describe_volumes_modifications

Name	Datatype	Description
end_time	string	The modification completion or failure time.
modification_state	string	The current modification state.
operator	string	The service provider that manages the resource.
original_iops	integer	The original IOPS rate of the volume.
original_multi_attach_enabled	boolean	The original setting for Amazon EBS Multi-Attach.
original_size	integer	The original size of the volume, in GiB.
original_throughput	integer	The original throughput of the volume, in MiB/s.
original_volume_type	string	The original EBS volume type of the volume.
progress	integer	The modification progress, from 0 to 100 percent complete.
start_time	string	The modification start time.
status_message	string	A status message about the modification progress or failure.
target_iops	integer	The target IOPS rate of the volume.
target_multi_attach_enabled	boolean	The target setting for Amazon EBS Multi-Attach.
target_size	integer	The target size of the volume, in GiB.
target_throughput	integer	The target throughput of the volume, in MiB/s.
target_volume_type	string	The target EBS volume type of the volume.
volume_id	string	The ID of the volume.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_volumes_modifications	select	region	DryRun, VolumeId, Filter, NextToken, MaxResults, IncludeManagedResources	Describes the most recent volume modification request for the specified EBS volumes. For more information, see Monitor the progress of volume modifications in the Amazon EBS User Guide.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
DryRun	boolean	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.
Filter	array	The filters. modification-state - The current modification state (modifying | optimizing | completed | failed). original-iops - The original IOPS rate of the volume. original-size - The original size of the volume, in GiB. original-volume-type - The original volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1). originalMultiAttachEnabled - Indicates whether Multi-Attach support was enabled (true | false). start-time - The modification start time. target-iops - The target IOPS rate of the volume. target-size - The target size of the volume, in GiB. target-volume-type - The target volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1). targetMultiAttachEnabled - Indicates whether Multi-Attach support is to be enabled (true | false). volume-id - The ID of the volume.
IncludeManagedResources	boolean	Indicates whether to include managed resources in the output. If this parameter is set to true, the output includes resources that are managed by Amazon Web Services services, even if managed resource visibility is set to hidden.
MaxResults	integer	The maximum number of results (up to a limit of 500) to be returned in a paginated request. For more information, see Pagination.
NextToken	string	The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
VolumeId	array	The IDs of the volumes.

SELECT examples

describe_volumes_modifications

Describes the most recent volume modification request for the specified EBS volumes. For more information, see Monitor the progress of volume modifications in the Amazon EBS User Guide.

SELECT
end_time,
modification_state,
operator,
original_iops,
original_multi_attach_enabled,
original_size,
original_throughput,
original_volume_type,
progress,
start_time,
status_message,
target_iops,
target_multi_attach_enabled,
target_size,
target_throughput,
target_volume_type,
volume_id
FROM aws.ec2.volumes_modifications
WHERE region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
AND VolumeId = '{{ VolumeId }}'
AND Filter = '{{ Filter }}'
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
AND IncludeManagedResources = '{{ IncludeManagedResources }}'
;