Class: Aws::EC2::Types::DescribeInstanceStatusRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::EC2::Types::DescribeInstanceStatusRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-ec2/types.rb
Overview
When making an API call, you may pass DescribeInstanceStatusRequest data as a hash:
{
filters: [
{
name: "String",
values: ["String"],
},
],
instance_ids: ["String"],
max_results: 1,
next_token: "String",
dry_run: false,
include_all_instances: false,
}
Contains the parameters for DescribeInstanceStatus.
Instance Attribute Summary collapse
-
#dry_run ⇒ Boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
-
#filters ⇒ Array<Types::Filter>
One or more filters.
-
#include_all_instances ⇒ Boolean
When ‘true`, includes the health status for all instances.
-
#instance_ids ⇒ Array<String>
One or more instance IDs.
-
#max_results ⇒ Integer
The maximum number of results to return in a single call.
-
#next_token ⇒ String
The token to retrieve the next page of results.
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`.
7093 7094 7095 7096 7097 7098 7099 7100 7101 |
# File 'lib/aws-sdk-ec2/types.rb', line 7093 class DescribeInstanceStatusRequest < Struct.new( :filters, :instance_ids, :max_results, :next_token, :dry_run, :include_all_instances) include Aws::Structure end |
#filters ⇒ Array<Types::Filter>
One or more filters.
-
‘availability-zone` - The Availability Zone of the instance.
-
‘event.code` - The code for the scheduled event (`instance-reboot` | `system-reboot` | `system-maintenance` | `instance-retirement` | `instance-stop`).
-
‘event.description` - A description of the event.
-
‘event.not-after` - The latest end time for the scheduled event (for example, `2014-09-15T17:15:20.000Z`).
-
‘event.not-before` - The earliest start time for the scheduled event (for example, `2014-09-15T17:15:20.000Z`).
-
‘instance-state-code` - The code for the instance state, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
-
‘instance-state-name` - The state of the instance (`pending` | `running` | `shutting-down` | `terminated` | `stopping` | `stopped`).
-
‘instance-status.reachability` - Filters on instance status where the name is `reachability` (`passed` | `failed` | `initializing` | `insufficient-data`).
-
‘instance-status.status` - The status of the instance (`ok` | `impaired` | `initializing` | `insufficient-data` | `not-applicable`).
-
‘system-status.reachability` - Filters on system status where the name is `reachability` (`passed` | `failed` | `initializing` | `insufficient-data`).
-
‘system-status.status` - The system status of the instance (`ok` | `impaired` | `initializing` | `insufficient-data` | `not-applicable`).
7093 7094 7095 7096 7097 7098 7099 7100 7101 |
# File 'lib/aws-sdk-ec2/types.rb', line 7093 class DescribeInstanceStatusRequest < Struct.new( :filters, :instance_ids, :max_results, :next_token, :dry_run, :include_all_instances) include Aws::Structure end |
#include_all_instances ⇒ Boolean
When ‘true`, includes the health status for all instances. When `false`, includes the health status for running instances only.
Default: ‘false`
7093 7094 7095 7096 7097 7098 7099 7100 7101 |
# File 'lib/aws-sdk-ec2/types.rb', line 7093 class DescribeInstanceStatusRequest < Struct.new( :filters, :instance_ids, :max_results, :next_token, :dry_run, :include_all_instances) include Aws::Structure end |
#instance_ids ⇒ Array<String>
One or more instance IDs.
Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
7093 7094 7095 7096 7097 7098 7099 7100 7101 |
# File 'lib/aws-sdk-ec2/types.rb', line 7093 class DescribeInstanceStatusRequest < Struct.new( :filters, :instance_ids, :max_results, :next_token, :dry_run, :include_all_instances) include Aws::Structure end |
#max_results ⇒ Integer
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned ‘NextToken` value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.
7093 7094 7095 7096 7097 7098 7099 7100 7101 |
# File 'lib/aws-sdk-ec2/types.rb', line 7093 class DescribeInstanceStatusRequest < Struct.new( :filters, :instance_ids, :max_results, :next_token, :dry_run, :include_all_instances) include Aws::Structure end |
#next_token ⇒ String
The token to retrieve the next page of results.
7093 7094 7095 7096 7097 7098 7099 7100 7101 |
# File 'lib/aws-sdk-ec2/types.rb', line 7093 class DescribeInstanceStatusRequest < Struct.new( :filters, :instance_ids, :max_results, :next_token, :dry_run, :include_all_instances) include Aws::Structure end |