Describe Instance Status
ec2_describe_instance_status(
Filter = NULL,
InstanceId = NULL,
MaxResults = NULL,
NextToken = NULL,
DryRun = NULL,
IncludeAllInstances = NULL,
simplify = TRUE,
others = list(),
print_on_error = aws_get_print_on_error(),
retry_time = aws_get_retry_time(),
network_timeout = aws_get_network_timeout(),
region = aws_get_region()
)Named list where the name is the filter name and the value is the filter's value. The value can be a vector or a list object (see below)[optional]
List. The instance IDs.[optional]
Integer. The maximum number of results to return in a single call.[optional]
Characters. The token for the next page of results[optional]
Logical. Checks whether you have the required permissions for the action, without actually making the request,...[optional]
Logical. When true, includes the health status for all instances.[optional]
Logical. Whether to simplify the result and handle nextToken
in the response[optional]
Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]
Logical. Whether to show an error message when a network error occurs.
Integer. Number of retries for a REST request when encounter the
network issue. If the request has been sent retry_time times but still not
be able to get the response, an error will be thrown.
Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.
Character. The region of the AWS service.
A list object or a character vector
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 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).
The instance IDs.
Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
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.
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.
When true, includes the health status for all instances. When false,
includes the health status for running instances only.
Default: false