You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::EC2::Types::DescribeVolumeStatusRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::EC2::Types::DescribeVolumeStatusRequest
- Defined in:
- (unknown)
Overview
When passing DescribeVolumeStatusRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
filters: [
{
name: "String",
values: ["String"],
},
],
max_results: 1,
next_token: "String",
volume_ids: ["VolumeId"],
dry_run: false,
}
Instance Attribute Summary collapse
-
#dry_run ⇒ Boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
-
#filters ⇒ Array<Types::Filter>
The filters.
-
#max_results ⇒ Integer
The maximum number of volume results returned by
DescribeVolumeStatus
in paginated output. -
#next_token ⇒ String
The
NextToken
value to include in a futureDescribeVolumeStatus
request. -
#volume_ids ⇒ Array<String>
The IDs of the volumes.
Instance Attribute Details
#dry_run ⇒ Boolean
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 ⇒ Array<Types::Filter>
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
).
#max_results ⇒ Integer
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 1000; if MaxResults
is given a value
larger than 1000, only 1000 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.
#next_token ⇒ String
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.
#volume_ids ⇒ Array<String>
The IDs of the volumes.
Default: Describes all your volumes.