Skip to main content

volumes_in_recycle_bins

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

Overview

Namevolumes_in_recycle_bins
TypeResource
Idaws.ec2.volumes_in_recycle_bins

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
availability_zonestringThe Availability Zone for the volume.
availability_zone_idstringThe ID of the Availability Zone for the volume.
create_timestringThe time stamp when volume creation was initiated.
iopsintegerThe number of I/O operations per second (IOPS) for the volume.
operatorstringThe service provider that manages the volume.
outpost_arnstringThe ARN of the Outpost on which the volume is stored. For more information, see Amazon EBS volumes on Outposts in the Amazon EBS User Guide.
recycle_bin_enter_timestringThe date and time when the volume entered the Recycle Bin.
recycle_bin_exit_timestringThe date and time when the volume is to be permanently deleted from the Recycle Bin.
sizeintegerThe size of the volume, in GiB.
snapshot_idstringThe snapshot from which the volume was created, if applicable.
source_volume_idstringThe ID of the source volume.
statestringThe state of the volume.
throughputintegerThe throughput that the volume supports, in MiB/s.
volume_idstringThe ID of the volume.
volume_typestringThe volume type.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_volumes_in_recycle_binselectregionVolumeId, DryRun, MaxResults, NextTokenLists one or more volumes that are currently in the Recycle Bin.

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.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)
DryRunbooleanChecks 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.
MaxResultsintegerThe maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. Valid range: 5 - 500
NextTokenstringThe token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
VolumeIdarrayThe IDs of the volumes to list. Omit this parameter to list all of the volumes that are in the Recycle Bin.

SELECT examples

Lists one or more volumes that are currently in the Recycle Bin.

SELECT
availability_zone,
availability_zone_id,
create_time,
iops,
operator,
outpost_arn,
recycle_bin_enter_time,
recycle_bin_exit_time,
size,
snapshot_id,
source_volume_id,
state,
throughput,
volume_id,
volume_type
FROM aws.ec2.volumes_in_recycle_bins
WHERE region = '{{ region }}' -- required
AND VolumeId = '{{ VolumeId }}'
AND DryRun = '{{ DryRun }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
;