Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . ec2 ]

list-volumes-in-recycle-bin

Description

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

See also: AWS API Documentation

Synopsis

  list-volumes-in-recycle-bin
[--volume-ids <value>]
[--dry-run | --no-dry-run]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--volume-ids (list)

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

(string)

Syntax:

"string" "string" ...

--dry-run | --no-dry-run (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 .

--max-results (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

--next-token (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

Volumes -> (list)

Information about the volumes.

(structure)

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 -> (structure)

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 -> (timestamp)

The time stamp when volume creation was initiated.

RecycleBinEnterTime -> (timestamp)

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

RecycleBinExitTime -> (timestamp)

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.