Skip to content

List Volumes In Recycle Bin

ec2_list_volumes_in_recycle_bin R Documentation

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

Description

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

Usage

ec2_list_volumes_in_recycle_bin(VolumeIds, DryRun, MaxResults,
  NextToken)

Arguments

VolumeIds

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

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.

MaxResults

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

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Value

A list with the following syntax:

list(
  Volumes = list(
    list(
      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 = list(
        Managed = TRUE|FALSE,
        Principal = "string",
        HiddenByDefault = TRUE|FALSE
      ),
      CreateTime = as.POSIXct(
        "2015-01-01"
      ),
      RecycleBinEnterTime = as.POSIXct(
        "2015-01-01"
      ),
      RecycleBinExitTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_volumes_in_recycle_bin(
  VolumeIds = list(
    "string"
  ),
  DryRun = TRUE|FALSE,
  MaxResults = 123,
  NextToken = "string"
)