DescribeInstanceStatusRequest Class

Container for the parameters to the DescribeInstanceStatus operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.EC2.AmazonEC2Request
      Amazon.EC2.Model.DescribeInstanceStatusRequest

Namespace: Amazon.EC2.Model
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z

Syntax

public class DescribeInstanceStatusRequest : AmazonEC2Request
         IAmazonWebServiceRequest

The DescribeInstanceStatusRequest type exposes the following members

Constructors

	Name	Description
	DescribeInstanceStatusRequest()

Properties

Name	Type	Description
Filters	System.Collections.Generic.List<Amazon.EC2.Model.Filter>	Gets and sets the property 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`).
IncludeAllInstances	System.Boolean	Gets and sets the property IncludeAllInstances. When `true`, includes the health status for all instances. When `false`, includes the health status for running instances only. Default: `false`
InstanceIds	System.Collections.Generic.List<System.String>	Gets and sets the property InstanceIds. The instance IDs. Default: Describes all your instances. Constraints: Maximum 100 explicitly specified instance IDs.
MaxResults	System.Int32	Gets and sets the property 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	System.String	Gets and sets the property NextToken. The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Examples

This example describes the current status of the specified instance.

To describe the status of an instance


var client = new AmazonEC2Client();
var response = client.DescribeInstanceStatus(new DescribeInstanceStatusRequest 
{
    InstanceIds = new List<string> {
        "i-1234567890abcdef0"
    }
});

List<InstanceStatus> instanceStatuses = response.InstanceStatuses;

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5