You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Note:

When making an API call, you may pass DescribeVolumeStatusRequest data as a hash:

{
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
  volume_ids: ["String"],
  dry_run: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#dry_runBoolean

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)


16149
16150
16151
16152
16153
16154
16155
16156
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16149

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

#filtersArray<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:



16149
16150
16151
16152
16153
16154
16155
16156
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16149

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

#max_resultsInteger

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 1000; if MaxResults is given a value larger than 1000, only 1000 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.

Returns:

  • (Integer)


16149
16150
16151
16152
16153
16154
16155
16156
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16149

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

#next_tokenString

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.

Returns:

  • (String)


16149
16150
16151
16152
16153
16154
16155
16156
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16149

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

#volume_idsArray<String>

The IDs of the volumes.

Default: Describes all your volumes.

Returns:

  • (Array<String>)


16149
16150
16151
16152
16153
16154
16155
16156
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16149

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