ec2_describe_volumes_modifications {aws.ecx}

Describe Volumes Modifications

Description

Describe Volumes Modifications

Usage

ec2_describe_volumes_modifications(
  DryRun = NULL,
  VolumeId = NULL,
  Filter = NULL,
  NextToken = NULL,
  MaxResults = 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

DryRun

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

VolumeId

List. The IDs of the volumes.[optional]

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]

NextToken

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

MaxResults

Integer. The maximum number of results (up to a limit of 500) to be returned in a paginated request.[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

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.

VolumeId

The IDs of the volumes.

Filter

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.

MaxResults

The maximum number of results (up to a limit of 500) to be returned in a paginated request.