aws_sdk_ec2/client/

describe_volume_status.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeVolumeStatus`](crate::operation::describe_volume_status::builders::DescribeVolumeStatusFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_volume_status::builders::DescribeVolumeStatusFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`max_results(i32)`](crate::operation::describe_volume_status::builders::DescribeVolumeStatusFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_volume_status::builders::DescribeVolumeStatusFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination">Pagination</a>.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_volume_status::builders::DescribeVolumeStatusFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_volume_status::builders::DescribeVolumeStatusFluentBuilder::set_next_token):<br>required: **false**<br><p>The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</p><br>
    ///   - [`volume_ids(impl Into<String>)`](crate::operation::describe_volume_status::builders::DescribeVolumeStatusFluentBuilder::volume_ids) / [`set_volume_ids(Option<Vec::<String>>)`](crate::operation::describe_volume_status::builders::DescribeVolumeStatusFluentBuilder::set_volume_ids):<br>required: **false**<br><p>The IDs of the volumes.</p> <p>Default: Describes all your volumes.</p><br>
    ///   - [`dry_run(bool)`](crate::operation::describe_volume_status::builders::DescribeVolumeStatusFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::describe_volume_status::builders::DescribeVolumeStatusFluentBuilder::set_dry_run):<br>required: **false**<br><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><br>
    ///   - [`filters(Filter)`](crate::operation::describe_volume_status::builders::DescribeVolumeStatusFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_volume_status::builders::DescribeVolumeStatusFluentBuilder::set_filters):<br>required: **false**<br><p>The filters.</p> <ul>  <li>   <p><code>action.code</code> - The action code for the event (for example, <code>enable-volume-io</code>).</p></li>  <li>   <p><code>action.description</code> - A description of the action.</p></li>  <li>   <p><code>action.event-id</code> - The event ID associated with the action.</p></li>  <li>   <p><code>availability-zone</code> - The Availability Zone of the instance.</p></li>  <li>   <p><code>event.description</code> - A description of the event.</p></li>  <li>   <p><code>event.event-id</code> - The event ID.</p></li>  <li>   <p><code>event.event-type</code> - The event type (for <code>io-enabled</code>: <code>passed</code> | <code>failed</code>; for <code>io-performance</code>: <code>io-performance:degraded</code> | <code>io-performance:severely-degraded</code> | <code>io-performance:stalled</code>).</p></li>  <li>   <p><code>event.not-after</code> - The latest end time for the event.</p></li>  <li>   <p><code>event.not-before</code> - The earliest start time for the event.</p></li>  <li>   <p><code>volume-status.details-name</code> - The cause for <code>volume-status.status</code> (<code>io-enabled</code> | <code>io-performance</code>).</p></li>  <li>   <p><code>volume-status.details-status</code> - The status of <code>volume-status.details-name</code> (for <code>io-enabled</code>: <code>passed</code> | <code>failed</code>; for <code>io-performance</code>: <code>normal</code> | <code>degraded</code> | <code>severely-degraded</code> | <code>stalled</code>).</p></li>  <li>   <p><code>volume-status.status</code> - The status of the volume (<code>ok</code> | <code>impaired</code> | <code>warning</code> | <code>insufficient-data</code>).</p></li> </ul><br>
    /// - On success, responds with [`DescribeVolumeStatusOutput`](crate::operation::describe_volume_status::DescribeVolumeStatusOutput) with field(s):
    ///   - [`next_token(Option<String>)`](crate::operation::describe_volume_status::DescribeVolumeStatusOutput::next_token): <p>The token to include in another request to get the next page of items. This value is <code>null</code> when there are no more items to return.</p>
    ///   - [`volume_statuses(Option<Vec::<VolumeStatusItem>>)`](crate::operation::describe_volume_status::DescribeVolumeStatusOutput::volume_statuses): <p>Information about the status of the volumes.</p>
    /// - On failure, responds with [`SdkError<DescribeVolumeStatusError>`](crate::operation::describe_volume_status::DescribeVolumeStatusError)
    pub fn describe_volume_status(&self) -> crate::operation::describe_volume_status::builders::DescribeVolumeStatusFluentBuilder {
        crate::operation::describe_volume_status::builders::DescribeVolumeStatusFluentBuilder::new(self.handle.clone())
    }
}