environment_healths

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

Overview

Name	environment_healths
Type	Resource
Id	aws.elasticbeanstalk.environment_healths

Fields

The following fields are returned by SELECT queries:

describe_environment_health

Name	Datatype	Description
environment_name	string	The environment's name.
application_metrics	object	Application request metrics for the environment.
causes	array	Descriptions of the data that contributed to the environment's current health status.
color	string	The health color of the environment.
health_status	string	The health status of the environment. For example, Ok.
instances_health	object	Summary health information for the instances in the environment.
refreshed_at	string	The date and time that the health information was retrieved.
status	string	The environment's operational status. Ready, Launching, Updating, Terminating, or Terminated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_environment_health	select	region	EnvironmentName, EnvironmentId, AttributeNames	Returns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health.

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	Specify the response elements to return. To retrieve all attributes, set to All. If no attribute names are specified, returns the name of the environment.
EnvironmentId	string	Specify the environment by ID. You must specify either this or an EnvironmentName, or both.
EnvironmentName	string	Specify the environment by name. You must specify either this or an EnvironmentName, or both.

SELECT examples

describe_environment_health

Returns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health.

SELECT
environment_name,
application_metrics,
causes,
color,
health_status,
instances_health,
refreshed_at,
status
FROM aws.elasticbeanstalk.environment_healths
WHERE region = '{{ region }}' -- required
AND EnvironmentName = '{{ EnvironmentName }}'
AND EnvironmentId = '{{ EnvironmentId }}'
AND AttributeNames = '{{ AttributeNames }}'
;