Skip to content
AWS for Query.Farm

aws.elasticbeanstalk.describe_instances_health

Example SQL Queries

SELECT * FROM
aws.elasticbeanstalk.describe_instances_health;

Description

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

Table Definition

Column NameColumn Data Type
attribute_names Input Column

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.

VARCHAR[]
Show child fields
attribute_names[]
environment_id Input Column

Specify the AWS Elastic Beanstalk environment by ID.

VARCHAR
environment_name Input Column

Specify the AWS Elastic Beanstalk environment by name.

VARCHAR
next_token Input Column

Pagination token for the next page of results, if available.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
instance_health_list

Detailed health information about each instance.

The output differs slightly between Linux and Windows environments. There is a difference in the members that are supported under the <CPUUtilization> type.

STRUCT(
    "instance_id" VARCHAR,
    "health_status" VARCHAR,
    "color" VARCHAR,
    "causes" VARCHAR[],
    "launched_at" TIMESTAMP_S,
    "application_metrics" STRUCT(
        "duration" BIGINT,
        "request_count" BIGINT,
        "status_codes" STRUCT(
            "status2xx" BIGINT,
            "status3xx" BIGINT,
            "status4xx" BIGINT,
            "status5xx" BIGINT
        ),
        "latency" STRUCT(
            "p999" DOUBLE,
            "p99" DOUBLE,
            "p95" DOUBLE,
            "p90" DOUBLE,
            "p85" DOUBLE,
            "p75" DOUBLE,
            "p50" DOUBLE,
            "p10" DOUBLE
        )
    ),
    "system" STRUCT(
        "cpu_utilization" STRUCT(
            "user" DOUBLE,
            "nice" DOUBLE,
            "system" DOUBLE,
            "idle" DOUBLE,
            "io_wait" DOUBLE,
            "irq" DOUBLE,
            "soft_irq" DOUBLE,
            "privileged" DOUBLE
        ),
        "load_average" DOUBLE[]
    ),
    "deployment" STRUCT(
        "version_label" VARCHAR,
        "deployment_id" BIGINT,
        "status" VARCHAR,
        "deployment_time" TIMESTAMP_S
    ),
    "availability_zone" VARCHAR,
    "instance_type" VARCHAR
)[]
Show child fields
instance_health_list[]
Show child fields
instance_health_list[].application_metrics

Request metrics from your application.

Show child fields
instance_health_list[].application_metrics.duration

The amount of time that the metrics cover (usually 10 seconds). For example, you might have 5 requests (request_count) within the most recent time slice of 10 seconds (duration).

instance_health_list[].application_metrics.latency

Represents the average latency for the slowest X percent of requests over the last 10 seconds. Latencies are in seconds with one millisecond resolution.

Show child fields
instance_health_list[].application_metrics.latency.p10

The average latency for the slowest 90 percent of requests over the last 10 seconds.

instance_health_list[].application_metrics.latency.p50

The average latency for the slowest 50 percent of requests over the last 10 seconds.

instance_health_list[].application_metrics.latency.p75

The average latency for the slowest 25 percent of requests over the last 10 seconds.

instance_health_list[].application_metrics.latency.p85

The average latency for the slowest 15 percent of requests over the last 10 seconds.

instance_health_list[].application_metrics.latency.p90

The average latency for the slowest 10 percent of requests over the last 10 seconds.

instance_health_list[].application_metrics.latency.p95

The average latency for the slowest 5 percent of requests over the last 10 seconds.

instance_health_list[].application_metrics.latency.p99

The average latency for the slowest 1 percent of requests over the last 10 seconds.

instance_health_list[].application_metrics.latency.p999

The average latency for the slowest 0.1 percent of requests over the last 10 seconds.

instance_health_list[].application_metrics.request_count

Average number of requests handled by the web server per second over the last 10 seconds.

instance_health_list[].application_metrics.status_codes

Represents the percentage of requests over the last 10 seconds that resulted in each type of status code response.

Show child fields
instance_health_list[].application_metrics.status_codes.status2xx

The percentage of requests over the last 10 seconds that resulted in a 2xx (200, 201, etc.) status code.

instance_health_list[].application_metrics.status_codes.status3xx

The percentage of requests over the last 10 seconds that resulted in a 3xx (300, 301, etc.) status code.

instance_health_list[].application_metrics.status_codes.status4xx

The percentage of requests over the last 10 seconds that resulted in a 4xx (400, 401, etc.) status code.

instance_health_list[].application_metrics.status_codes.status5xx

The percentage of requests over the last 10 seconds that resulted in a 5xx (500, 501, etc.) status code.

instance_health_list[].availability_zone

The availability zone in which the instance runs.

instance_health_list[].causes[]
instance_health_list[].color

Represents the color indicator that gives you information about the health of the EC2 instance. For more information, see Health Colors and Statuses.

instance_health_list[].deployment

Information about the most recent deployment to an instance.

Show child fields
instance_health_list[].deployment.deployment_id

The ID of the deployment. This number increases by one each time that you deploy source code or change instance configuration settings.

instance_health_list[].deployment.deployment_time

For in-progress deployments, the time that the deployment started.

For completed deployments, the time that the deployment ended.

instance_health_list[].deployment.status

The status of the deployment:

  • In Progress : The deployment is in progress.

  • Deployed : The deployment succeeded.

  • Failed : The deployment failed.

instance_health_list[].deployment.version_label

The version label of the application version in the deployment.

instance_health_list[].health_status

Returns the health status of the specified instance. For more information, see Health Colors and Statuses.

instance_health_list[].instance_id

The ID of the Amazon EC2 instance.

instance_health_list[].instance_type

The instance's type.

instance_health_list[].launched_at

The time at which the EC2 instance was launched.

instance_health_list[].system

Operating system metrics from the instance.

Show child fields
instance_health_list[].system.cpu_utilization

CPU utilization metrics for the instance.

Show child fields
instance_health_list[].system.cpu_utilization.idle

Percentage of time that the CPU has spent in the Idle state over the last 10 seconds.

instance_health_list[].system.cpu_utilization.io_wait

Available on Linux environments only.

Percentage of time that the CPU has spent in the I/O Wait state over the last 10 seconds.

instance_health_list[].system.cpu_utilization.irq

Available on Linux environments only.

Percentage of time that the CPU has spent in the IRQ state over the last 10 seconds.

instance_health_list[].system.cpu_utilization.nice

Available on Linux environments only.

Percentage of time that the CPU has spent in the Nice state over the last 10 seconds.

instance_health_list[].system.cpu_utilization.privileged

Available on Windows environments only.

Percentage of time that the CPU has spent in the Privileged state over the last 10 seconds.

instance_health_list[].system.cpu_utilization.soft_irq

Available on Linux environments only.

Percentage of time that the CPU has spent in the SoftIRQ state over the last 10 seconds.

instance_health_list[].system.cpu_utilization.system

Available on Linux environments only.

Percentage of time that the CPU has spent in the System state over the last 10 seconds.

instance_health_list[].system.cpu_utilization.user

Percentage of time that the CPU has spent in the User state over the last 10 seconds.

instance_health_list[].system.load_average[]
refreshed_at

The date and time that the health information was retrieved.

TIMESTAMP_S