describe_volume_status¶
Operation¶
describe_volume_status
async
¶
describe_volume_status(request: DescribeVolumeStatusInput | DescribeVolumeStatusInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeVolumeStatusOutput
describe_volume_status(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeVolumeStatusInputDict]) -> DescribeVolumeStatusOutput
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 EBS 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 and then check the volume for data
consistency. For more information, see Work with an impaired EBS
volume.
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.)
Note
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
DescribeVolumeStatusOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
DescribeVolumeStatusInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeVolumeStatusInput structure.
Attributes¶
dry_run
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
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
class-attribute
instance-attribute
¶
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. -
attachment-status.instance-id- The ID of the instance that the volume is attached to. -
attachment-status.io-performance- The I/O performance status of the volume's attachment to the instance. -
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).
include_managed_resources
class-attribute
instance-attribute
¶
include_managed_resources: bool | None = ...
Indicates whether to include managed resources in the output. If this
parameter is set to true, the output includes resources that are
managed by Amazon Web Services services, even if managed resource
visibility is set to hidden.
max_results
class-attribute
instance-attribute
¶
max_results: int | None = ...
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 Pagination.
Dictionaries¶
DescribeVolumeStatusInputDict
¶
Bases: TypedDict
Dictionary form of DescribeVolumeStatusInput.
Attributes¶
dry_run
instance-attribute
¶
dry_run: bool | None
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
instance-attribute
¶
filters: Sequence[Filter | FilterDict] | None
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. -
attachment-status.instance-id- The ID of the instance that the volume is attached to. -
attachment-status.io-performance- The I/O performance status of the volume's attachment to the instance. -
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).
include_managed_resources
instance-attribute
¶
include_managed_resources: bool | None
Indicates whether to include managed resources in the output. If this
parameter is set to true, the output includes resources that are
managed by Amazon Web Services services, even if managed resource
visibility is set to hidden.
max_results
instance-attribute
¶
max_results: int | None
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 Pagination.
Output¶
DescribeVolumeStatusOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeVolumeStatusOutput structure.
Attributes¶
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
The token to include in another request to get the next page of items.
This value is null when there are no more items to return.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
volume_statuses
class-attribute
instance-attribute
¶
volume_statuses: list[VolumeStatusItem] | None = ...
Information about the status of the volumes.