Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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.)
This operation returns paginated results.
Synopsis
- data DescribeVolumeStatus = DescribeVolumeStatus' {}
- newDescribeVolumeStatus :: DescribeVolumeStatus
- describeVolumeStatus_dryRun :: Lens' DescribeVolumeStatus (Maybe Bool)
- describeVolumeStatus_filters :: Lens' DescribeVolumeStatus (Maybe [Filter])
- describeVolumeStatus_maxResults :: Lens' DescribeVolumeStatus (Maybe Int)
- describeVolumeStatus_nextToken :: Lens' DescribeVolumeStatus (Maybe Text)
- describeVolumeStatus_volumeIds :: Lens' DescribeVolumeStatus (Maybe [Text])
- data DescribeVolumeStatusResponse = DescribeVolumeStatusResponse' {}
- newDescribeVolumeStatusResponse :: Int -> DescribeVolumeStatusResponse
- describeVolumeStatusResponse_nextToken :: Lens' DescribeVolumeStatusResponse (Maybe Text)
- describeVolumeStatusResponse_volumeStatuses :: Lens' DescribeVolumeStatusResponse (Maybe [VolumeStatusItem])
- describeVolumeStatusResponse_httpStatus :: Lens' DescribeVolumeStatusResponse Int
Creating a Request
data DescribeVolumeStatus Source #
See: newDescribeVolumeStatus
smart constructor.
DescribeVolumeStatus' | |
|
Instances
newDescribeVolumeStatus :: DescribeVolumeStatus Source #
Create a value of DescribeVolumeStatus
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dryRun:DescribeVolumeStatus'
, describeVolumeStatus_dryRun
- 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
.
$sel:filters:DescribeVolumeStatus'
, describeVolumeStatus_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
).
$sel:maxResults:DescribeVolumeStatus'
, describeVolumeStatus_maxResults
- 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.
DescribeVolumeStatus
, describeVolumeStatus_nextToken
- 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.
$sel:volumeIds:DescribeVolumeStatus'
, describeVolumeStatus_volumeIds
- The IDs of the volumes.
Default: Describes all your volumes.
Request Lenses
describeVolumeStatus_dryRun :: Lens' DescribeVolumeStatus (Maybe Bool) Source #
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
.
describeVolumeStatus_filters :: Lens' DescribeVolumeStatus (Maybe [Filter]) Source #
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
).
describeVolumeStatus_maxResults :: Lens' DescribeVolumeStatus (Maybe Int) Source #
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.
describeVolumeStatus_nextToken :: Lens' DescribeVolumeStatus (Maybe Text) Source #
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.
describeVolumeStatus_volumeIds :: Lens' DescribeVolumeStatus (Maybe [Text]) Source #
The IDs of the volumes.
Default: Describes all your volumes.
Destructuring the Response
data DescribeVolumeStatusResponse Source #
See: newDescribeVolumeStatusResponse
smart constructor.
DescribeVolumeStatusResponse' | |
|
Instances
newDescribeVolumeStatusResponse Source #
Create a value of DescribeVolumeStatusResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeVolumeStatus
, describeVolumeStatusResponse_nextToken
- The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.
$sel:volumeStatuses:DescribeVolumeStatusResponse'
, describeVolumeStatusResponse_volumeStatuses
- Information about the status of the volumes.
$sel:httpStatus:DescribeVolumeStatusResponse'
, describeVolumeStatusResponse_httpStatus
- The response's http status code.
Response Lenses
describeVolumeStatusResponse_nextToken :: Lens' DescribeVolumeStatusResponse (Maybe Text) Source #
The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.
describeVolumeStatusResponse_volumeStatuses :: Lens' DescribeVolumeStatusResponse (Maybe [VolumeStatusItem]) Source #
Information about the status of the volumes.
describeVolumeStatusResponse_httpStatus :: Lens' DescribeVolumeStatusResponse Int Source #
The response's http status code.