Struct aws_sdk_ec2::client::fluent_builders::DescribeVolumeStatus
source · pub struct DescribeVolumeStatus { /* private fields */ }Expand description
Fluent builder constructing a request to DescribeVolumeStatus.
Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event.
The DescribeVolumeStatus operation provides the following information about the specified volumes:
Status: Reflects the current status of the volume. The possible values are ok, impaired , warning, or insufficient-data. If all checks pass, the overall status of the volume is ok. If the check fails, the overall status is impaired. If the status is insufficient-data, then the checks might still be taking place on your volume at the time. We recommend that you retry the request. For more information about volume status, see Monitor the status of your volumes in the Amazon Elastic Compute Cloud User Guide.
Events: Reflect the cause of a volume status and might require you to take action. For example, if your volume returns an impaired status, then the volume event might be potential-data-inconsistency. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and might have inconsistent data.
Actions: Reflect the actions you might have to take in response to an event. For example, if the status of the volume is impaired and the volume event shows potential-data-inconsistency, then the action shows enable-volume-io. This means that you may want to enable the I/O operations for the volume by calling the EnableVolumeIO action and then check the volume for data consistency.
Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the error state (for example, when a volume is incapable of accepting I/O.)
Implementations§
source§impl DescribeVolumeStatus
impl DescribeVolumeStatus
sourcepub async fn customize(
self
) -> Result<CustomizableOperation<DescribeVolumeStatus, AwsResponseRetryClassifier>, SdkError<DescribeVolumeStatusError>>
pub async fn customize(
self
) -> Result<CustomizableOperation<DescribeVolumeStatus, AwsResponseRetryClassifier>, SdkError<DescribeVolumeStatusError>>
Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.
sourcepub async fn send(
self
) -> Result<DescribeVolumeStatusOutput, SdkError<DescribeVolumeStatusError>>
pub async fn send(
self
) -> Result<DescribeVolumeStatusOutput, SdkError<DescribeVolumeStatusError>>
Sends the request and returns the response.
If an error occurs, an SdkError will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn into_paginator(self) -> DescribeVolumeStatusPaginator
pub fn into_paginator(self) -> DescribeVolumeStatusPaginator
Create a paginator for this request
Paginators are used by calling send().await which returns a Stream.
sourcepub fn filters(self, input: Filter) -> Self
pub fn filters(self, input: Filter) -> Self
Appends an item to Filters.
To override the contents of this collection use set_filters.
The filters.
-
action.code- The action code for the event (for example,enable-volume-io). -
action.description- A description of the action. -
action.event-id- The event ID associated with the action. -
availability-zone- The Availability Zone of the instance. -
event.description- A description of the event. -
event.event-id- The event ID. -
event.event-type- The event type (forio-enabled:passed|failed; forio-performance:io-performance:degraded|io-performance:severely-degraded|io-performance:stalled). -
event.not-after- The latest end time for the event. -
event.not-before- The earliest start time for the event. -
volume-status.details-name- The cause forvolume-status.status(io-enabled|io-performance). -
volume-status.details-status- The status ofvolume-status.details-name(forio-enabled:passed|failed; forio-performance:normal|degraded|severely-degraded|stalled). -
volume-status.status- The status of the volume (ok|impaired|warning|insufficient-data).
sourcepub fn set_filters(self, input: Option<Vec<Filter>>) -> Self
pub fn set_filters(self, input: Option<Vec<Filter>>) -> Self
The filters.
-
action.code- The action code for the event (for example,enable-volume-io). -
action.description- A description of the action. -
action.event-id- The event ID associated with the action. -
availability-zone- The Availability Zone of the instance. -
event.description- A description of the event. -
event.event-id- The event ID. -
event.event-type- The event type (forio-enabled:passed|failed; forio-performance:io-performance:degraded|io-performance:severely-degraded|io-performance:stalled). -
event.not-after- The latest end time for the event. -
event.not-before- The earliest start time for the event. -
volume-status.details-name- The cause forvolume-status.status(io-enabled|io-performance). -
volume-status.details-status- The status ofvolume-status.details-name(forio-enabled:passed|failed; forio-performance:normal|degraded|severely-degraded|stalled). -
volume-status.status- The status of the volume (ok|impaired|warning|insufficient-data).
sourcepub fn max_results(self, input: i32) -> Self
pub fn max_results(self, input: i32) -> Self
The maximum number of volume results returned by DescribeVolumeStatus in paginated output. When this parameter is used, the request only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned. If this parameter is not used, then DescribeVolumeStatus returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.
sourcepub fn set_max_results(self, input: Option<i32>) -> Self
pub fn set_max_results(self, input: Option<i32>) -> Self
The maximum number of volume results returned by DescribeVolumeStatus in paginated output. When this parameter is used, the request only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned. If this parameter is not used, then DescribeVolumeStatus returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.
sourcepub fn next_token(self, input: impl Into<String>) -> Self
pub fn next_token(self, input: impl Into<String>) -> Self
The NextToken value to include in a future DescribeVolumeStatus request. When the results of the request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
sourcepub fn set_next_token(self, input: Option<String>) -> Self
pub fn set_next_token(self, input: Option<String>) -> Self
The NextToken value to include in a future DescribeVolumeStatus request. When the results of the request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
sourcepub fn volume_ids(self, input: impl Into<String>) -> Self
pub fn volume_ids(self, input: impl Into<String>) -> Self
Appends an item to VolumeIds.
To override the contents of this collection use set_volume_ids.
The IDs of the volumes.
Default: Describes all your volumes.
sourcepub fn set_volume_ids(self, input: Option<Vec<String>>) -> Self
pub fn set_volume_ids(self, input: Option<Vec<String>>) -> Self
The IDs of the volumes.
Default: Describes all your volumes.
sourcepub fn dry_run(self, input: bool) -> Self
pub fn dry_run(self, input: bool) -> Self
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.
sourcepub fn set_dry_run(self, input: Option<bool>) -> Self
pub fn set_dry_run(self, input: Option<bool>) -> Self
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.
Trait Implementations§
source§impl Clone for DescribeVolumeStatus
impl Clone for DescribeVolumeStatus
source§fn clone(&self) -> DescribeVolumeStatus
fn clone(&self) -> DescribeVolumeStatus
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more