Skip to content

Describe Instance Status

ec2_describe_instance_status R Documentation

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.

  • 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 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(Filters, InstanceIds, MaxResults,
  NextToken, DryRun, IncludeAllInstances)

Arguments

Filters

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

  • attached-ebs-status.status - The status of the attached EBS volume for the instance (ok | impaired | initializing | insufficient-data | not-applicable).

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.

DryRun

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.

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",
      OutpostArn = "string",
      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"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

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

Examples

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

## End(Not run)