Skip to content

describe_volumes_modifications

describe_volumes_modifications(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional[Boolean] = None,
    volume_ids: Optional[VolumeIdStringList] = None,
    filters: Optional[FilterList] = None,
    next_token: Optional[String] = None,
    max_results: Optional[Integer] = None,
    include_managed_resources: Optional[Boolean] = None,
) -> DescribeVolumesModificationsResult

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:

  • dry_run (Optional[Boolean], default: 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.

  • volume_ids (Optional[VolumeIdStringList], default: None ) –

    The IDs of the volumes.

  • filters (Optional[FilterList], default: 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.

  • next_token (Optional[String], default: None ) –

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

  • max_results (Optional[Integer], default: None ) –

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

  • include_managed_resources (Optional[Boolean], default: 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.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def describe_volumes_modifications(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    volume_ids: Optional[
        "capo_ec2.types.volume_id_string_list.VolumeIdStringList"
    ] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
    next_token: Optional["capo_ec2.types.string.String"] = None,
    max_results: Optional["capo_ec2.types.integer.Integer"] = None,
    include_managed_resources: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.describe_volumes_modifications_result.DescribeVolumesModificationsResult":
    """<p>Describes the most recent volume modification request for the specified EBS volumes.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/ebs/latest/userguide/monitoring-volume-modifications.html"> Monitor the progress of volume modifications</a> in the <i>Amazon EBS User Guide</i>.</p>

    Args:
        dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
        volume_ids: <p>The IDs of the volumes.</p>
        filters: <p>The filters.</p> <ul> <li> <p> <code>modification-state</code> - The current modification state (modifying | optimizing | completed | failed).</p> </li> <li> <p> <code>original-iops</code> - The original IOPS rate of the volume.</p> </li> <li> <p> <code>original-size</code> - The original size of the volume, in GiB.</p> </li> <li> <p> <code>original-volume-type</code> - The original volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1).</p> </li> <li> <p> <code>originalMultiAttachEnabled</code> - Indicates whether Multi-Attach support was enabled (true | false).</p> </li> <li> <p> <code>start-time</code> - The modification start time.</p> </li> <li> <p> <code>target-iops</code> - The target IOPS rate of the volume.</p> </li> <li> <p> <code>target-size</code> - The target size of the volume, in GiB.</p> </li> <li> <p> <code>target-volume-type</code> - The target volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1).</p> </li> <li> <p> <code>targetMultiAttachEnabled</code> - Indicates whether Multi-Attach support is to be enabled (true | false).</p> </li> <li> <p> <code>volume-id</code> - The ID of the volume.</p> </li> </ul>
        next_token: <p>The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</p>
        max_results: <p>The maximum number of results (up to a limit of 500) to be returned in a paginated request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination">Pagination</a>.</p>
        include_managed_resources: <p>Indicates whether to include managed resources in the output. If this parameter is set to <code>true</code>, the output includes resources that are managed by Amazon Web Services services, even if managed resource visibility is set to hidden.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.describe_volumes_modifications_request.DescribeVolumesModificationsRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.describe_volumes_modifications_result.DescribeVolumesModificationsResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_volumes_modifications

        output, http_response = (
            capo_ec2._operations.amazon_ec2.describe_volumes_modifications.describe_volumes_modifications(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeVolumesModifications")
    )
    input_: capo_ec2.types.describe_volumes_modifications_request.DescribeVolumesModificationsRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if volume_ids is not None:
        input_["volume_ids"] = volume_ids
    if filters is not None:
        input_["filters"] = filters
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if include_managed_resources is not None:
        input_["include_managed_resources"] = include_managed_resources

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output