instances_healths

Creates, updates, deletes, gets or lists an instances_healths resource.

Overview

Name	instances_healths
Type	Resource
Id	aws.elasticbeanstalk.instances_healths

Fields

The following fields are returned by SELECT queries:

describe_instances_health

Name	Datatype	Description
application_metrics	string	Request metrics from your application.
availability_zone	string	The availability zone in which the instance runs.
causes	string	Represents the causes, which provide more information about the current health status.
color	string	Represents the color indicator that gives you information about the health of the EC2 instance. For more information, see Health Colors and Statuses.
deployment	string	Information about the most recent deployment to an instance.
health_status	string	Returns the health status of the specified instance. For more information, see Health Colors and Statuses.
instance_id	string	The ID of the Amazon EC2 instance.
instance_type	string	The instance's type.
launched_at	string	The time at which the EC2 instance was launched.
system	string	Operating system metrics from the instance.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_instances_health	select	region	EnvironmentName, EnvironmentId, AttributeNames, NextToken	Retrieves detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires enhanced health reporting.

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
region	string	AWS region (default: us-east-1)
AttributeNames	array	Specifies the response elements you wish to receive. To retrieve all attributes, set to All. If no attribute names are specified, returns a list of instances.
EnvironmentId	string	Specify the AWS Elastic Beanstalk environment by ID.
EnvironmentName	string	Specify the AWS Elastic Beanstalk environment by name.
NextToken	string	Specify the pagination token returned by a previous call.

SELECT examples

describe_instances_health

Retrieves detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires enhanced health reporting.

SELECT
application_metrics,
availability_zone,
causes,
color,
deployment,
health_status,
instance_id,
instance_type,
launched_at,
system
FROM aws.elasticbeanstalk.instances_healths
WHERE region = '{{ region }}' -- required
AND EnvironmentName = '{{ EnvironmentName }}'
AND EnvironmentId = '{{ EnvironmentId }}'
AND AttributeNames = '{{ AttributeNames }}'
AND NextToken = '{{ NextToken }}'
;