> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blinkops.com/llms.txt
> Use this file to discover all available pages before exploring further.
# EC2 Describe Instance Status
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](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-system-instance-status-check.html) and [Troubleshooting instances with failed status checks](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstances.html) 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](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html) 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](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html) in the *Amazon EC2 User Guide*.
External Documentation
To learn more, visit the [AWS documentation](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstanceStatus.html).
## Basic Parameters
| Parameter | Description |
| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| AWS Region(s) | Enter the desired AWS Region(s).
To execute the action in multiple regions, provide a comma-separated list.
For example: `us-east-1,eu-west-2`.
If you wish to run the action in all available regions, use the asterisk symbol (`*`) instead. |
| Include All Instances | When `true`, includes the health status for all instances. When `false`, includes the health status for running instances only.
Default: `false`. |
| Instance IDs | The instance IDs.
Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs. |
## Advanced Parameters
| Parameter | Description | | | | | | | | | | | | | | | | | | | | | | | |
| -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------------ | --------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------- | ----------------- | -------------------------------------------------------------------------------------------------- | ------------- | ----------------- | ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ----------------- | ------------------------------------------------------------------------------------------------------- | ------------- | ----------------- | ---------------------- | ------------------ |
| Disable XML To JSON Auto Convert | When checked, XML responses are not automatically converted into JSON format. | | | | | | | | | | | | | | | | | | | | | | | |
| Dry Run | 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`. | | | | | | | | | | | | | | | | | | | | | | | |
| 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`). |
| Max Results | 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. | | | | | | | | | | | | | | | | | | | | | | | |
| Next Token | The token to retrieve the next page of results. | | | | | | | | | | | | | | | | | | | | | | | |
## Example Output
```json theme={"dark"}
{
"InstanceStatuses": [
{
"AvailabilityZone": "us-east-1d",
"InstanceId": "i-1234567890abcdef0",
"InstanceState": {
"Code": 16,
"Name": "running"
},
"InstanceStatus": {
"Details": [
{
"Name": "reachability",
"Status": "passed"
}
],
"Status": "ok"
},
"SystemStatus": {
"Details": [
{
"Name": "reachability",
"Status": "passed"
}
],
"Status": "ok"
}
}
]
}
```
## Workflow Library Example
[Ec2 Describe Instance Status with Aws and Send Results Via Email](https://library.blinkops.com/workflows/ec2-describe-instance-status-with-aws-and-send-results-via-email)
Preview this Workflow on desktop