describe-instance-status¶

Description¶

Describes the status of the specified instances or all of your instances. By default, only running instances are described, unless you specifically indicate to return the status of all instances.

Instance status includes the following components:

Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status checks for your instances and Troubleshoot instances with failed status checks in the Amazon EC2 User Guide .
Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled events for your instances in the Amazon EC2 User Guide .
Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance lifecycle in the Amazon EC2 User Guide .

Synopsis¶

  describe-instance-status
[--filters <value>]
[--instance-ids <value>]
[--dry-run | --no-dry-run]
[--include-all-instances | --no-include-all-instances]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options¶

--filters (list)

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

(structure)

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

If you specify multiple filters, the filters are joined with an AND , and the request returns only results that match all of the specified filters.

Name -> (string)

The name of the filter. Filter names are case-sensitive.

Values -> (list)

The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR , and the request returns all results that match any of the specified values.

(string)

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--instance-ids (list)

The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

(string)

Syntax:

"string" "string" ...

--dry-run | --no-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 .

--include-all-instances | --no-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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To describe the status of an instance

This example describes the current status of the specified instance.

Command:

aws ec2 describe-instance-status --instance-id i-1234567890abcdef0

Output:

{
    "InstanceStatuses": [
        {
            "InstanceId": "i-1234567890abcdef0",
            "InstanceState": {
                "Code": 16,
                "Name": "running"
            },
            "AvailabilityZone": "us-east-1d",
            "SystemStatus": {
                "Status": "ok",
                "Details": [
                    {
                        "Status": "passed",
                        "Name": "reachability"
                    }
                ]
            },
            "InstanceStatus": {
                "Status": "ok",
                "Details": [
                    {
                        "Status": "passed",
                        "Name": "reachability"
                    }
                ]
            }
        }
    ]
}

Output¶

InstanceStatuses -> (list)

Information about the status of the instances.

(structure)

Describes the status of an instance.

AvailabilityZone -> (string)

The Availability Zone of the instance.

OutpostArn -> (string)

The Amazon Resource Name (ARN) of the Outpost.

Events -> (list)

Any scheduled events associated with the instance.

(structure)

Describes a scheduled event for an instance.

InstanceEventId -> (string)

The ID of the event.

Code -> (string)

The event code.

Description -> (string)

A description of the event.

After a scheduled event is completed, it can still be described for up to a week. If the event has been completed, this description starts with the following text: [Completed].

NotAfter -> (timestamp)

The latest scheduled end time for the event.

NotBefore -> (timestamp)

The earliest scheduled start time for the event.

NotBeforeDeadline -> (timestamp)

The deadline for starting the event.

InstanceId -> (string)

The ID of the instance.

InstanceState -> (structure)

The intended state of the instance. DescribeInstanceStatus requires that an instance be in the running state.

Code -> (integer)

The state of the instance as a 16-bit unsigned integer.

The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.

The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.

The valid values for instance-state-code will all be in the range of the low byte and they are:

0 : pending

16 : running

32 : shutting-down

48 : terminated

64 : stopping

80 : stopped

You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.

Name -> (string)

The current state of the instance.

InstanceStatus -> (structure)

Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.

Details -> (list)

The system instance health or application instance health.

(structure)

Describes the instance status.

ImpairedSince -> (timestamp)

The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.

Name -> (string)

The type of instance status.

Status -> (string)

The status.

Status -> (string)

The status.

SystemStatus -> (structure)

Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.

Details -> (list)

The system instance health or application instance health.

(structure)

Describes the instance status.

ImpairedSince -> (timestamp)

The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.

Name -> (string)

The type of instance status.

Status -> (string)

The status.

Status -> (string)

The status.

NextToken -> (string)

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Table of Contents

Feedback

User Guide