ec2_describe_volumes {aws.ecx}

Describe Volumes

Description

Describe Volumes

Usage

ec2_describe_volumes(
  Filter = NULL,
  VolumeId = NULL,
  DryRun = NULL,
  MaxResults = NULL,
  NextToken = NULL,
  simplify = TRUE,
  others = list(),
  print_on_error = aws_get_print_on_error(),
  retry_time = aws_get_retry_time(),
  network_timeout = aws_get_network_timeout(),
  region = aws_get_region()
)

Arguments

Filter

Named list where the name is the filter name and the value is the filter's value. The value can be a vector or a list object (see below)[optional]

VolumeId

List. The volume IDs.[optional]

DryRun

Logical. Checks whether you have the required permissions for the action, without actually making the request,...[optional]

MaxResults

Integer. The maximum number of volume results returned by DescribeVolumes in paginated output.[optional]

NextToken

Characters. The token for the next page of results[optional]

simplify

Logical. Whether to simplify the result and handle nextToken in the response[optional]

others

Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]

print_on_error

Logical. Whether to show an error message when a network error occurs.

retry_time

Integer. Number of retries for a REST request when encounter the network issue. If the request has been sent retry_time times but still not be able to get the response, an error will be thrown.

network_timeout

Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.

region

Character. The region of the AWS service.

Value

A list object or a character vector

Filter

The filters.

• attachment.attach-time - The time stamp when the attachment initiated.

• attachment.delete-on-termination - Whether the volume is deleted on instance termination.

• attachment.device - The device name specified in the block device mapping (for example, ⁠/dev/sda1⁠).

• attachment.instance-id - The ID of the instance the volume is attached to.

• attachment.status - The attachment state (attaching \| attached \| detaching).

• availability-zone - The Availability Zone in which the volume was created.

• create-time - The time stamp when the volume was created.

• encrypted - Indicates whether the volume is encrypted (true \| false)

• multi-attach-enabled - Indicates whether the volume is enabled for Multi-Attach (true \| false)

• fast-restored - Indicates whether the volume was created from a snapshot that is enabled for fast snapshot restore (true \| false).

• size - The size of the volume, in GiB.

• snapshot-id - The snapshot from which the volume was created.

• status - The state of the volume (creating \| available \| ⁠in-use⁠ \| deleting \| deleted \| error).

• tag:\ - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

• volume-id - The volume ID.

• volume-type - The Amazon EBS volume type (gp2 \| gp3 \| io1 \| io2 \| st1 \| sc1\| standard)

VolumeId

The volume IDs.

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 volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes request with the returned NextToken value. This value can be between 5 and 500; if MaxResults is given a value larger than 500, only 500 results are returned. If this parameter is not used, then DescribeVolumes returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.