paws.compute (version 0.1.12)

ec2_describe_volumes: Describes the specified EBS volumes or all of your EBS volumes

Description

Describes the specified EBS volumes or all of your EBS volumes.

If you are describing a long list of volumes, we recommend that you paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent describe_volumes request to retrieve the remaining results.

For more information about EBS volumes, see Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide.

Usage

ec2_describe_volumes(Filters, VolumeIds, DryRun, MaxResults, NextToken)

Value

A list with the following syntax:

list(
  Volumes = list(
    list(
      Attachments = list(
        list(
          AttachTime = as.POSIXct(
            "2015-01-01"
          ),
          Device = "string",
          InstanceId = "string",
          State = "attaching"|"attached"|"detaching"|"detached"|"busy",
          VolumeId = "string",
          DeleteOnTermination = TRUE|FALSE
        )
      ),
      AvailabilityZone = "string",
      CreateTime = as.POSIXct(
        "2015-01-01"
      ),
      Encrypted = TRUE|FALSE,
      KmsKeyId = "string",
      OutpostArn = "string",
      Size = 123,
      SnapshotId = "string",
      State = "creating"|"available"|"in-use"|"deleting"|"deleted"|"error",
      VolumeId = "string",
      Iops = 123,
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      VolumeType = "standard"|"io1"|"io2"|"gp2"|"sc1"|"st1"|"gp3",
      FastRestored = TRUE|FALSE,
      MultiAttachEnabled = TRUE|FALSE,
      Throughput = 123
    )
  ),
  NextToken = "string"
)

Arguments

Filters

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:<key> - 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)

VolumeIds

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 describe_volumes in paginated output. When this parameter is used, describe_volumes 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 describe_volumes 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 describe_volumes returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

NextToken

The NextToken value returned from a previous paginated describe_volumes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

Request syntax

svc$describe_volumes(
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  VolumeIds = list(
    "string"
  ),
  DryRun = TRUE|FALSE,
  MaxResults = 123,
  NextToken = "string"
)

Examples

if (FALSE) {
# This example describes all of your volumes in the default region.
svc$describe_volumes()

# This example describes all volumes that are both attached to the
# instance with the ID i-1234567890abcdef0 and set to delete when the
# instance terminates.
svc$describe_volumes(
  Filters = list(
    list(
      Name = "attachment.instance-id",
      Values = list(
        "i-1234567890abcdef0"
      )
    ),
    list(
      Name = "attachment.delete-on-termination",
      Values = list(
        "true"
      )
    )
  )
)
}