instance_status
Creates, updates, deletes, gets or lists an instance_status resource.
Overview
| Name | instance_status |
| Type | Resource |
| Id | aws.ec2.instance_status |
Fields
The following fields are returned by SELECT queries:
- describe_instance_status
| Name | Datatype | Description |
|---|---|---|
application_status | string | Reports impaired functionality that stems from issues with applications running on the instance. |
attached_ebs_status | string | Reports impaired functionality that stems from an attached Amazon EBS volume that is unreachable and unable to complete I/O operations. |
availability_zone | string | The Availability Zone of the instance. |
availability_zone_id | string | The ID of the Availability Zone of the instance. |
events | string | Any scheduled events associated with the instance. |
instance_id | string | The ID of the instance. |
instance_state | string | The intended state of the instance. DescribeInstanceStatus requires that an instance be in the running state. |
instance_status | string | Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability. |
operator | string | The service provider that manages the instance. |
outpost_arn | string | The Amazon Resource Name (ARN) of the Outpost. |
system_status | string | Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_instance_status | select | region | InstanceId, MaxResults, NextToken, IncludeManagedResources, DryRun, Filter, IncludeAllInstances | 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. |
report_instance_status | exec | InstanceId, ReasonCode, region | DryRun, Status, StartTime, EndTime, Description | Submits feedback about the status of an instance. The instance must be in the running state. If your experience with the instance differs from the instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks. Use of this action does not change the value returned by DescribeInstanceStatus. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
InstanceId | array | The instances. |
ReasonCode | array | The reason codes that describe the health state of your instance. instance-stuck-in-state: My instance is stuck in a state. unresponsive: My instance is unresponsive. not-accepting-credentials: My instance is not accepting my credentials. password-not-available: A password is not available for my instance. performance-network: My instance is experiencing performance problems that I believe are network related. performance-instance-store: My instance is experiencing performance problems that I believe are related to the instance stores. performance-ebs-volume: My instance is experiencing performance problems that I believe are related to an EBS volume. performance-other: My instance is experiencing performance problems. other: [explain using the description parameter] |
region | string | AWS region (default: us-east-1) |
Description | string | Descriptive text about the health state of your instance. |
DryRun | boolean | 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. |
EndTime | string (date-time) | The time at which the reported instance health state ended. |
Filter | array | 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 | boolean | When true, includes the health status for all instances. When false, includes the health status for running instances only. Default: false |
IncludeManagedResources | boolean | 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. |
InstanceId | array | The instance IDs. Default: Describes all your instances. Constraints: Maximum 100 explicitly specified instance IDs. |
MaxResults | integer | 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 | string | The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. |
StartTime | string (date-time) | The time at which the reported instance health state began. |
Status | string | The status of all instances listed. |
SELECT examples
- 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 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.
SELECT
application_status,
attached_ebs_status,
availability_zone,
availability_zone_id,
events,
instance_id,
instance_state,
instance_status,
operator,
outpost_arn,
system_status
FROM aws.ec2.instance_status
WHERE region = '{{ region }}' -- required
AND InstanceId = '{{ InstanceId }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND IncludeManagedResources = '{{ IncludeManagedResources }}'
AND DryRun = '{{ DryRun }}'
AND Filter = '{{ Filter }}'
AND IncludeAllInstances = '{{ IncludeAllInstances }}'
;
Lifecycle Methods
- report_instance_status
Submits feedback about the status of an instance. The instance must be in the running state. If your experience with the instance differs from the instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks. Use of this action does not change the value returned by DescribeInstanceStatus.
EXEC aws.ec2.instance_status.report_instance_status
@InstanceId='{{ InstanceId }}' --required,
@ReasonCode='{{ ReasonCode }}' --required,
@region='{{ region }}' --required,
@DryRun={{ DryRun }},
@Status='{{ Status }}',
@StartTime='{{ StartTime }}',
@EndTime='{{ EndTime }}',
@Description='{{ Description }}'
;