ec2_describe_volume_status: Describes the status of the specified volumes

Description Usage Arguments Value Request syntax Examples

View source: R/ec2_operations.R

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 describe_volume_status 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 Monitoring 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 enable_volume_io 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.)

Usage

1
2
ec2_describe_volume_status(Filters, MaxResults, NextToken, VolumeIds,
  DryRun)

Arguments

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).

MaxResults

The maximum number of volume results returned by describe_volume_status 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 describe_volume_status returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

NextToken

The NextToken value to include in a future describe_volume_status 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

The IDs of the volumes.

Default: Describes all your volumes.

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.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
list(
  NextToken = "string",
  VolumeStatuses = list(
    list(
      Actions = list(
        list(
          Code = "string",
          Description = "string",
          EventId = "string",
          EventType = "string"
        )
      ),
      AvailabilityZone = "string",
      OutpostArn = "string",
      Events = list(
        list(
          Description = "string",
          EventId = "string",
          EventType = "string",
          NotAfter = as.POSIXct(
            "2015-01-01"
          ),
          NotBefore = as.POSIXct(
            "2015-01-01"
          ),
          InstanceId = "string"
        )
      ),
      VolumeId = "string",
      VolumeStatus = list(
        Details = list(
          list(
            Name = "io-enabled"|"io-performance",
            Status = "string"
          )
        ),
        Status = "ok"|"impaired"|"insufficient-data"
      ),
      AttachmentStatuses = list(
        list(
          IoPerformance = "string",
          InstanceId = "string"
        )
      )
    )
  )
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
svc$describe_volume_status(
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxResults = 123,
  NextToken = "string",
  VolumeIds = list(
    "string"
  ),
  DryRun = TRUE|FALSE
)

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
## Not run: 
# This example describes the status for the volume
# `vol-1234567890abcdef0`.
svc$describe_volume_status(
  VolumeIds = list(
    "vol-1234567890abcdef0"
  )
)

# This example describes the status for all volumes that are impaired. In
# this example output, there are no impaired volumes.
svc$describe_volume_status(
  Filters = list(
    list(
      Name = "volume-status.status",
      Values = list(
        "impaired"
      )
    )
  )
)

## End(Not run)

paws.compute documentation built on March 7, 2021, 5:10 p.m.