Skip to content

EC2  >  Operations  >  describe_application_status

describe_application_status

Operation

describe_application_status async 

describe_application_status(input: DescribeApplicationStatusInput, plugins: list[Plugin] | None = None) -> DescribeApplicationStatusOutput

Describes the aggregated application health status for the specified instances. The following rules apply:

  • The instance-level status is derived from all application status checks with the aggregation setting set to included.

  • Use DescribeApplicationStatusChecks to view the configuration of individual checks.

  • Use EnableApplicationStatusCheckSuppression to temporarily suppress health check results from affecting the instance-level status.

Parameters:

Name Type Description Default
input DescribeApplicationStatusInput

An instance of DescribeApplicationStatusInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
DescribeApplicationStatusOutput

An instance of DescribeApplicationStatusOutput.

Input

DescribeApplicationStatusInput dataclass

Bases: _SerdeShape

Dataclass for DescribeApplicationStatusInput structure.

Attributes

dry_run class-attribute instance-attribute 
dry_run: bool | None = ...

Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

filters class-attribute instance-attribute 
filters: list[Filter] | None = ...

The filters.

  • availability-zone-id -- The ID of the Availability Zone.

  • status -- The instance-level application status. For valid values and their meanings, see ApplicationStatus.

instance_ids class-attribute instance-attribute 
instance_ids: list[str] | None = ...

The IDs of the instances for which to describe application status.

max_results class-attribute instance-attribute 
max_results: int | None = ...

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

next_token class-attribute instance-attribute 
next_token: str | None = ...

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Output

DescribeApplicationStatusOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeApplicationStatusOutput structure.

Attributes

application_statuses class-attribute instance-attribute 
application_statuses: ApplicationStatusesResponseType | None = ...

The application statuses for the specified instances.

next_token class-attribute instance-attribute 
next_token: str | None = ...

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.