EC2 / Client / list_volumes_in_recycle_bin

list_volumes_in_recycle_bin

EC2.Client.list_volumes_in_recycle_bin(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_volumes_in_recycle_bin(
    VolumeIds=[
        'string',
    ],
    DryRun=True|False,
    MaxResults=123,
    NextToken='string'
)

Parameters:

• VolumeIds (list) –

  The IDs of the volumes to list. Omit this parameter to list all of the volumes that are in the Recycle Bin.

  • (string) –

• 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.

• MaxResults (integer) –

  The 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

• NextToken (string) – The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Return type:

dict

Returns:

Response Syntax

{
    'Volumes': [
        {
            'VolumeId': 'string',
            'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
            'State': 'creating'|'available'|'in-use'|'deleting'|'deleted'|'error',
            'Size': 123,
            'Iops': 123,
            'Throughput': 123,
            'OutpostArn': 'string',
            'AvailabilityZone': 'string',
            'AvailabilityZoneId': 'string',
            'SourceVolumeId': 'string',
            'SnapshotId': 'string',
            'Operator': {
                'Managed': True|False,
                'Principal': 'string'
            },
            'CreateTime': datetime(2015, 1, 1),
            'RecycleBinEnterTime': datetime(2015, 1, 1),
            'RecycleBinExitTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • Volumes (list) –

    Information about the volumes.

    • (dict) –

      Information about a volume that is currently in the Recycle Bin.

      • VolumeId (string) –

        The ID of the volume.

      • VolumeType (string) –

        The volume type.

      • State (string) –

        The state of the volume.

      • Size (integer) –

        The size of the volume, in GiB.

      • Iops (integer) –

        The number of I/O operations per second (IOPS) for the volume.

      • Throughput (integer) –

        The throughput that the volume supports, in MiB/s.

      • OutpostArn (string) –

        The 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.

      • AvailabilityZone (string) –

        The Availability Zone for the volume.

      • AvailabilityZoneId (string) –

        The ID of the Availability Zone for the volume.

      • SourceVolumeId (string) –

        The ID of the source volume.

      • SnapshotId (string) –

        The snapshot from which the volume was created, if applicable.

      • Operator (dict) –

        The service provider that manages the volume.

        • Managed (boolean) –

          If true, the resource is managed by a service provider.

        • Principal (string) –

          If managed is true, then the principal is returned. The principal is the service provider that manages the resource.

      • CreateTime (datetime) –

        The time stamp when volume creation was initiated.

      • RecycleBinEnterTime (datetime) –

        The date and time when the volume entered the Recycle Bin.

      • RecycleBinExitTime (datetime) –

        The date and time when the volume is to be permanently deleted from the Recycle Bin.

  • NextToken (string) –

    The token to include in another request to get the next page of items. This value is null when there are no more items to return.