Skip to content

DescribeInstancesHealthRequest

Source code in docs_src/capo_elastic_beanstalk/types/describe_instances_health_request.py
class DescribeInstancesHealthRequest(TypedDict, closed=True):
    environment_name: NotRequired[
        "capo_elastic_beanstalk.types.environment_name.EnvironmentName"
    ]
    """<p>Specify the Elastic Beanstalk environment by name.</p>"""
    environment_id: NotRequired[
        "capo_elastic_beanstalk.types.environment_id.EnvironmentId"
    ]
    """<p>Specify the Elastic Beanstalk environment by ID.</p>"""
    attribute_names: NotRequired[
        "capo_elastic_beanstalk.types.instances_health_attributes.InstancesHealthAttributes"
    ]
    """<p>Specifies the response elements you wish to receive. To retrieve all attributes, set to <code>All</code>. If no attribute names are specified, returns a list of instances.</p>"""
    next_token: NotRequired["capo_elastic_beanstalk.types.next_token.NextToken"]
    """<p>Specify the pagination token returned by a previous call.</p>"""

attribute_names instance-attribute

attribute_names: NotRequired[InstancesHealthAttributes]

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.

environment_id instance-attribute

environment_id: NotRequired[EnvironmentId]

Specify the Elastic Beanstalk environment by ID.

environment_name instance-attribute

environment_name: NotRequired[EnvironmentName]

Specify the Elastic Beanstalk environment by name.

next_token instance-attribute

next_token: NotRequired[NextToken]

Specify the pagination token returned by a previous call.