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

Amazonka.EC2.DescribeVolumeStatus

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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' {
- dryRun :: Maybe Bool
- filters :: Maybe [Filter]
- maxResults :: Maybe Int
- nextToken :: Maybe Text
- volumeIds :: Maybe [Text]
}
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' {
- nextToken :: Maybe Text
- volumeStatuses :: Maybe [VolumeStatusItem]
- httpStatus :: Int
}
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.

Constructors

DescribeVolumeStatus'

Fields

dryRun :: Maybe Bool
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 :: Maybe [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 (for io-enabled: passed | failed; for io-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 for volume-status.status (io-enabled | io-performance).
- volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed; for io-performance: normal | degraded | severely-degraded | stalled).
- volume-status.status - The status of the volume (ok | impaired | warning | insufficient-data).
maxResults :: Maybe Int
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.
nextToken :: Maybe Text
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.
volumeIds :: Maybe [Text]
The IDs of the volumes.
Default: Describes all your volumes.

Instances

Instances details

ToHeaders DescribeVolumeStatus Source #
Instance details Defined in Amazonka.EC2.DescribeVolumeStatus Methods toHeaders :: DescribeVolumeStatus -> [Header] #
ToPath DescribeVolumeStatus Source #
Instance details Defined in Amazonka.EC2.DescribeVolumeStatus Methods toPath :: DescribeVolumeStatus -> ByteString #
ToQuery DescribeVolumeStatus Source #
Instance details Defined in Amazonka.EC2.DescribeVolumeStatus Methods toQuery :: DescribeVolumeStatus -> QueryString #
AWSPager DescribeVolumeStatus Source #
Instance details Defined in Amazonka.EC2.DescribeVolumeStatus Methods page :: DescribeVolumeStatus -> AWSResponse DescribeVolumeStatus -> Maybe DescribeVolumeStatus #
AWSRequest DescribeVolumeStatus Source #
Instance details Defined in Amazonka.EC2.DescribeVolumeStatus Associated Types type AWSResponse DescribeVolumeStatus # Methods request :: (Service -> Service) -> DescribeVolumeStatus -> Request DescribeVolumeStatus # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeVolumeStatus -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeVolumeStatus))) #
Generic DescribeVolumeStatus Source #
Instance details Defined in Amazonka.EC2.DescribeVolumeStatus Associated Types type Rep DescribeVolumeStatus :: Type -> Type # Methods from :: DescribeVolumeStatus -> Rep DescribeVolumeStatus x # to :: Rep DescribeVolumeStatus x -> DescribeVolumeStatus #
Read DescribeVolumeStatus Source #
Instance details Defined in Amazonka.EC2.DescribeVolumeStatus Methods readsPrec :: Int -> ReadS DescribeVolumeStatus # readList :: ReadS [DescribeVolumeStatus] # readPrec :: ReadPrec DescribeVolumeStatus # readListPrec :: ReadPrec [DescribeVolumeStatus] #
Show DescribeVolumeStatus Source #
Instance details Defined in Amazonka.EC2.DescribeVolumeStatus Methods showsPrec :: Int -> DescribeVolumeStatus -> ShowS # show :: DescribeVolumeStatus -> String # showList :: [DescribeVolumeStatus] -> ShowS #
NFData DescribeVolumeStatus Source #
Instance details Defined in Amazonka.EC2.DescribeVolumeStatus Methods rnf :: DescribeVolumeStatus -> () #
Eq DescribeVolumeStatus Source #
Instance details Defined in Amazonka.EC2.DescribeVolumeStatus Methods (==) :: DescribeVolumeStatus -> DescribeVolumeStatus -> Bool # (/=) :: DescribeVolumeStatus -> DescribeVolumeStatus -> Bool #
Hashable DescribeVolumeStatus Source #
Instance details Defined in Amazonka.EC2.DescribeVolumeStatus Methods hashWithSalt :: Int -> DescribeVolumeStatus -> Int # hash :: DescribeVolumeStatus -> Int #
type AWSResponse DescribeVolumeStatus Source #
Instance details Defined in Amazonka.EC2.DescribeVolumeStatus type AWSResponse DescribeVolumeStatus = DescribeVolumeStatusResponse
type Rep DescribeVolumeStatus Source #
Instance details Defined in Amazonka.EC2.DescribeVolumeStatus type Rep DescribeVolumeStatus = D1 ('MetaData "DescribeVolumeStatus" "Amazonka.EC2.DescribeVolumeStatus" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeVolumeStatus'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter]))) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "volumeIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))))

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 (for io-enabled: passed | failed; for io-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 for volume-status.status (io-enabled | io-performance).
volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed; for io-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 (for io-enabled: passed | failed; for io-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 for volume-status.status (io-enabled | io-performance).
volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed; for io-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.

Constructors

DescribeVolumeStatusResponse'
Fields nextToken :: Maybe Text The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. volumeStatuses :: Maybe [VolumeStatusItem] Information about the status of the volumes. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeVolumeStatusResponse Source #
Instance details Defined in Amazonka.EC2.DescribeVolumeStatus Associated Types type Rep DescribeVolumeStatusResponse :: Type -> Type # Methods from :: DescribeVolumeStatusResponse -> Rep DescribeVolumeStatusResponse x # to :: Rep DescribeVolumeStatusResponse x -> DescribeVolumeStatusResponse #
Read DescribeVolumeStatusResponse Source #
Instance details Defined in Amazonka.EC2.DescribeVolumeStatus Methods readsPrec :: Int -> ReadS DescribeVolumeStatusResponse # readList :: ReadS [DescribeVolumeStatusResponse] # readPrec :: ReadPrec DescribeVolumeStatusResponse # readListPrec :: ReadPrec [DescribeVolumeStatusResponse] #
Show DescribeVolumeStatusResponse Source #
Instance details Defined in Amazonka.EC2.DescribeVolumeStatus Methods showsPrec :: Int -> DescribeVolumeStatusResponse -> ShowS # show :: DescribeVolumeStatusResponse -> String # showList :: [DescribeVolumeStatusResponse] -> ShowS #
NFData DescribeVolumeStatusResponse Source #
Instance details Defined in Amazonka.EC2.DescribeVolumeStatus Methods rnf :: DescribeVolumeStatusResponse -> () #
Eq DescribeVolumeStatusResponse Source #
Instance details Defined in Amazonka.EC2.DescribeVolumeStatus Methods (==) :: DescribeVolumeStatusResponse -> DescribeVolumeStatusResponse -> Bool # (/=) :: DescribeVolumeStatusResponse -> DescribeVolumeStatusResponse -> Bool #
type Rep DescribeVolumeStatusResponse Source #
Instance details Defined in Amazonka.EC2.DescribeVolumeStatus type Rep DescribeVolumeStatusResponse = D1 ('MetaData "DescribeVolumeStatusResponse" "Amazonka.EC2.DescribeVolumeStatus" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeVolumeStatusResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "volumeStatuses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [VolumeStatusItem])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeVolumeStatusResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeVolumeStatusResponse'`
-> DescribeVolumeStatusResponse

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.