Skip to content

EC2  >  Operations  >  describe_volumes_modifications

describe_volumes_modifications

Operation

describe_volumes_modifications async

describe_volumes_modifications(request: DescribeVolumesModificationsInput | DescribeVolumesModificationsInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeVolumesModificationsOutput
describe_volumes_modifications(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeVolumesModificationsInputDict]) -> DescribeVolumesModificationsOutput

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.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
DescribeVolumesModificationsOutput

An instance of DescribeVolumesModificationsOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

DescribeVolumesModificationsInput dataclass

Bases: _SerdeShape

Dataclass for DescribeVolumesModificationsInput structure.

Attributes
dry_run class-attribute instance-attribute
dry_run: bool | None = ...

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.

filters class-attribute instance-attribute
filters: list[Filter] | None = ...

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.

include_managed_resources class-attribute instance-attribute
include_managed_resources: bool | None = ...

Indicates whether to include managed resources in the output. If this parameter is set to true, the output includes resources that are managed by Amazon Web Services services, even if managed resource visibility is set to hidden.

max_results class-attribute instance-attribute
max_results: int | None = ...

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

next_token class-attribute instance-attribute
next_token: str | None = ...

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

volume_ids class-attribute instance-attribute
volume_ids: list[str] | None = ...

The IDs of the volumes.

Dictionaries

DescribeVolumesModificationsInputDict

Bases: TypedDict

Dictionary form of DescribeVolumesModificationsInput.

Attributes
dry_run instance-attribute
dry_run: bool | None

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.

filters instance-attribute
filters: Sequence[Filter | FilterDict] | None

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.

include_managed_resources instance-attribute
include_managed_resources: bool | None

Indicates whether to include managed resources in the output. If this parameter is set to true, the output includes resources that are managed by Amazon Web Services services, even if managed resource visibility is set to hidden.

max_results instance-attribute
max_results: int | None

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

next_token instance-attribute
next_token: str | None

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

volume_ids instance-attribute
volume_ids: Sequence[str] | None

The IDs of the volumes.

Output

DescribeVolumesModificationsOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeVolumesModificationsOutput structure.

Attributes

next_token class-attribute instance-attribute
next_token: str | None = ...

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.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

volumes_modifications class-attribute instance-attribute
volumes_modifications: list[VolumeModification] | None = ...

Information about the volume modifications.