Class: Aws::EC2::Types::DescribeVolumeStatusRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ec2/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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

Returns:

  • (Boolean) 


26794
26795
26796
26797
26798
26799
26800
26801
26802
 
# File 'lib/aws-sdk-ec2/types.rb', line 26794

class DescribeVolumeStatusRequest < Struct.new(
  :filters,
  :max_results,
  :next_token,
  :volume_ids,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#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 (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`).

Returns:



26794
26795
26796
26797
26798
26799
26800
26801
26802
 
# File 'lib/aws-sdk-ec2/types.rb', line 26794

class DescribeVolumeStatusRequest < Struct.new(
  :filters,
  :max_results,
  :next_token,
  :volume_ids,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

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. This value can be between 5 and 1,000; if the value is larger than 1,000, only 1,000 results are returned. If this parameter is not used, then all items are returned. You cannot specify this parameter and the volume IDs parameter in the same request. For more information, see [Pagination].

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

Returns:

  • (Integer) 


26794
26795
26796
26797
26798
26799
26800
26801
26802
 
# File 'lib/aws-sdk-ec2/types.rb', line 26794

class DescribeVolumeStatusRequest < Struct.new(
  :filters,
  :max_results,
  :next_token,
  :volume_ids,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Returns:

  • (String) 


26794
26795
26796
26797
26798
26799
26800
26801
26802
 
# File 'lib/aws-sdk-ec2/types.rb', line 26794

class DescribeVolumeStatusRequest < Struct.new(
  :filters,
  :max_results,
  :next_token,
  :volume_ids,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#volume_ids ⇒ Array<String>

The IDs of the volumes.

Default: Describes all your volumes.

Returns:

  • (Array<String>) 


26794
26795
26796
26797
26798
26799
26800
26801
26802
 
# File 'lib/aws-sdk-ec2/types.rb', line 26794

class DescribeVolumeStatusRequest < Struct.new(
  :filters,
  :max_results,
  :next_token,
  :volume_ids,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end