Skip to content

DescribeEnvironmentHealthResult

Source code in docs_src/capo_elastic_beanstalk/types/describe_environment_health_result.py
class DescribeEnvironmentHealthResult(TypedDict, closed=True):
    environment_name: NotRequired[
        "capo_elastic_beanstalk.types.environment_name.EnvironmentName"
    ]
    """<p>The environment's name.</p>"""
    health_status: NotRequired["capo_elastic_beanstalk.types.string.String"]
    """<p>The <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html">health status</a> of the environment. For example, <code>Ok</code>.</p>"""
    status: NotRequired[
        "capo_elastic_beanstalk.types.environment_health.EnvironmentHealth"
    ]
    """<p>The environment's operational status. <code>Ready</code>, <code>Launching</code>, <code>Updating</code>, <code>Terminating</code>, or <code>Terminated</code>.</p>"""
    color: NotRequired["capo_elastic_beanstalk.types.string.String"]
    """<p>The <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html">health color</a> of the environment.</p>"""
    causes: NotRequired["capo_elastic_beanstalk.types.causes.Causes"]
    """<p>Descriptions of the data that contributed to the environment's current health status.</p>"""
    application_metrics: NotRequired[
        "capo_elastic_beanstalk.types.application_metrics.ApplicationMetrics"
    ]
    """<p>Application request metrics for the environment.</p>"""
    instances_health: NotRequired[
        "capo_elastic_beanstalk.types.instance_health_summary.InstanceHealthSummary"
    ]
    """<p>Summary health information for the instances in the environment.</p>"""
    refreshed_at: NotRequired["capo_elastic_beanstalk.types.refreshed_at.RefreshedAt"]
    """<p>The date and time that the health information was retrieved.</p>"""

application_metrics instance-attribute

application_metrics: NotRequired[ApplicationMetrics]

Application request metrics for the environment.

causes instance-attribute

causes: NotRequired[Causes]

Descriptions of the data that contributed to the environment's current health status.

color instance-attribute

color: NotRequired[String]

The health color of the environment.

environment_name instance-attribute

environment_name: NotRequired[EnvironmentName]

The environment's name.

health_status instance-attribute

health_status: NotRequired[String]

The health status of the environment. For example, Ok.

instances_health instance-attribute

instances_health: NotRequired[InstanceHealthSummary]

Summary health information for the instances in the environment.

refreshed_at instance-attribute

refreshed_at: NotRequired[RefreshedAt]

The date and time that the health information was retrieved.

status instance-attribute

status: NotRequired[EnvironmentHealth]

The environment's operational status. Ready, Launching, Updating, Terminating, or Terminated.