You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::EC2::Types::DescribeInstanceStatusRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::EC2::Types::DescribeInstanceStatusRequest
- Defined in:
- (unknown)
Overview
When passing DescribeInstanceStatusRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
filters: [
{
name: "String",
values: ["String"],
},
],
instance_ids: ["InstanceId"],
max_results: 1,
next_token: "String",
dry_run: false,
include_all_instances: false,
}
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>
The filters.
-
#include_all_instances ⇒ Boolean
When
true
, includes the health status for all instances. -
#instance_ids ⇒ Array<String>
The 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
.
#filters ⇒ Array<Types::Filter>
The 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.instance-event-id
- The ID of the event whose date and time you are modifying.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
).event.not-before-deadline
- The deadline for starting the 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 used for internal purposes 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 isreachability
(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 isreachability
(passed
|failed
|initializing
|insufficient-data
).system-status.status
- The system status of the instance (ok
|impaired
|initializing
|insufficient-data
|not-applicable
).
#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
#instance_ids ⇒ Array<String>
The instance IDs.
Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
#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.
#next_token ⇒ String
The token to retrieve the next page of results.