Skip to content

Describe Volumes Modifications

ec2_describe_volumes_modifications R Documentation

Describes the most recent volume modification request for the specified EBS volumes

Description

Describes the most recent volume modification request for the specified EBS volumes.

For more information, see Monitor the progress of volume modifications in the Amazon EBS User Guide.

Usage

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

Arguments

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.

VolumeIds

The IDs of the volumes.

Filters

The filters.

  • modification-state - The current modification state (modifying | optimizing | completed | failed).

  • original-iops - The original IOPS rate of the volume.

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

  • original-volume-type - The original volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1).

  • originalMultiAttachEnabled - Indicates whether Multi-Attach support was enabled (true | false).

  • start-time - The modification start time.

  • target-iops - The target IOPS rate of the volume.

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

  • target-volume-type - The target volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1).

  • targetMultiAttachEnabled - Indicates whether Multi-Attach support is to be enabled (true | false).

  • volume-id - The ID of the volume.

NextToken

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

MaxResults

The maximum number of results (up to a limit of 500) to be returned in a paginated request. For more information, see Pagination.

Value

A list with the following syntax: 

list(
  VolumesModifications = list(
    list(
      VolumeId = "string",
      ModificationState = "modifying"|"optimizing"|"completed"|"failed",
      StatusMessage = "string",
      TargetSize = 123,
      TargetIops = 123,
      TargetVolumeType = "standard"|"io1"|"io2"|"gp2"|"sc1"|"st1"|"gp3",
      TargetThroughput = 123,
      TargetMultiAttachEnabled = TRUE|FALSE,
      OriginalSize = 123,
      OriginalIops = 123,
      OriginalVolumeType = "standard"|"io1"|"io2"|"gp2"|"sc1"|"st1"|"gp3",
      OriginalThroughput = 123,
      OriginalMultiAttachEnabled = TRUE|FALSE,
      Progress = 123,
      StartTime = as.POSIXct(
        "2015-01-01"
      ),
      EndTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

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