Describes the status of the specified instances or all of your instances¶

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.
Application status checks - Amazon EC2 reports application-level health status for instances, indicating whether applications running on the instance are functioning properly.
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.

The Amazon EC2 API follows an eventual consistency model. This means that the result of an API command you run that creates or modifies resources might not be immediately available to all subsequent commands you run. For guidance on how to manage eventual consistency, see Eventual consistency in the Amazon EC2 API in the Amazon EC2 Developer Guide.

The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.

Usage¶

ec2_describe_instance_status(InstanceIds, MaxResults, NextToken,
  IncludeManagedResources, DryRun, Filters, IncludeAllInstances)

Arguments¶

InstanceIds

The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.
MaxResults

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

You cannot specify this parameter and the instance IDs parameter in the same request.
NextToken

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
IncludeManagedResources

Indicates whether to include managed resources in the output. If this parameter is set to true, the output includes resources that are managed by Amazon Web Services services, even if managed resource visibility is set to hidden.
DryRun

Checks whether you have the required permissions for the operation, 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

The filters.
- availability-zone - The Availability Zone of the instance.
- availability-zone-id - The ID of 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).
- operator.managed - A Boolean that indicates whether this is a managed instance.
- operator.principal - The principal that manages the instance. Only valid for managed instances, where managed is true.
- 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).
- attached-ebs-status.status - The status of the attached EBS volume for the instance (ok | impaired | initializing | insufficient-data | not-applicable).
- application-status.status - The application status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).
IncludeAllInstances

When true, includes the health status for all instances. When false, includes the health status for running instances only.

Default: false

Value¶

A list with the following syntax:

list(
  InstanceStatuses = list(
    list(
      AvailabilityZone = "string",
      AvailabilityZoneId = "string",
      OutpostArn = "string",
      Operator = list(
        Managed = TRUE|FALSE,
        Principal = "string",
        HiddenByDefault = TRUE|FALSE
      ),
      Events = list(
        list(
          InstanceEventId = "string",
          Code = "instance-reboot"|"system-reboot"|"system-maintenance"|"instance-retirement"|"instance-stop",
          Description = "string",
          NotAfter = as.POSIXct(
            "2015-01-01"
          ),
          NotBefore = as.POSIXct(
            "2015-01-01"
          ),
          NotBeforeDeadline = as.POSIXct(
            "2015-01-01"
          )
        )
      ),
      InstanceId = "string",
      InstanceState = list(
        Code = 123,
        Name = "pending"|"running"|"shutting-down"|"terminated"|"stopping"|"stopped"
      ),
      InstanceStatus = list(
        Details = list(
          list(
            ImpairedSince = as.POSIXct(
              "2015-01-01"
            ),
            Name = "reachability",
            Status = "passed"|"failed"|"insufficient-data"|"initializing"
          )
        ),
        Status = "ok"|"impaired"|"insufficient-data"|"not-applicable"|"initializing"
      ),
      SystemStatus = list(
        Details = list(
          list(
            ImpairedSince = as.POSIXct(
              "2015-01-01"
            ),
            Name = "reachability",
            Status = "passed"|"failed"|"insufficient-data"|"initializing"
          )
        ),
        Status = "ok"|"impaired"|"insufficient-data"|"not-applicable"|"initializing"
      ),
      AttachedEbsStatus = list(
        Details = list(
          list(
            ImpairedSince = as.POSIXct(
              "2015-01-01"
            ),
            Name = "reachability",
            Status = "passed"|"failed"|"insufficient-data"|"initializing"
          )
        ),
        Status = "ok"|"impaired"|"insufficient-data"|"not-applicable"|"initializing"
      ),
      ApplicationStatus = list(
        Status = "ok"|"impaired"|"insufficient-data"|"not-applicable"|"initializing",
        ImpairedSince = as.POSIXct(
          "2015-01-01"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$describe_instance_status(
  InstanceIds = list(
    "string"
  ),
  MaxResults = 123,
  NextToken = "string",
  IncludeManagedResources = TRUE|FALSE,
  DryRun = TRUE|FALSE,
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  IncludeAllInstances = TRUE|FALSE
)

Examples¶

# This example describes the current status of the specified instance.
svc$describe_instance_status(
  InstanceIds = list(
    "i-1234567890abcdef0"
  )
)