describe_application_status ¶

def describe_application_status(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    instance_ids: Optional["capo_ec2.types.instance_id_list.InstanceIdList"] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
    max_results: Optional[
        "capo_ec2.types.describe_application_status_max_results.DescribeApplicationStatusMaxResults"
    ] = None,
    next_token: Optional["capo_ec2.types.string.String"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.describe_application_status_result.DescribeApplicationStatusResult":
    """<p>Describes the aggregated application health status for the specified instances. The following rules apply:</p> <ul> <li> <p>The instance-level status is derived from all application status checks with the aggregation setting set to <code>included</code>.</p> </li> <li> <p>Use <code>DescribeApplicationStatusChecks</code> to view the configuration of individual checks.</p> </li> <li> <p>Use <code>EnableApplicationStatusCheckSuppression</code> to temporarily suppress health check results from affecting the instance-level status.</p> </li> </ul>

    Args:
        instance_ids: <p>The IDs of the instances for which to describe application status.</p>
        filters: <p>The filters.</p> <ul> <li> <p> <code>availability-zone-id</code> – The ID of the Availability Zone.</p> </li> <li> <p> <code>status</code> – The instance-level application status. For valid values and their meanings, see <code>ApplicationStatus</code>.</p> </li> </ul>
        max_results: <p>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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination">Pagination</a>.</p>
        next_token: <p>The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</p>
        dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To describe application status for instances
        This example describes the application status for the specified instance.

        >>> client.describe_application_status(instance_ids=['i-0123456789abcdef0'])
        To describe application status using filters
        This example uses a filter to describe impaired application status in a specific Availability Zone.

        >>> client.describe_application_status(filters=[{'Name': 'availability-zone-id', 'Values': ['use1-az1']}, {'Name': 'status', 'Values': ['impaired']}], max_results=10)
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.describe_application_status_request.DescribeApplicationStatusRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.describe_application_status_result.DescribeApplicationStatusResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_application_status

        output, http_response = (
            capo_ec2._operations.amazon_ec2.describe_application_status.describe_application_status(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeApplicationStatus")
    )
    input_: capo_ec2.types.describe_application_status_request.DescribeApplicationStatusRequest = {}
    if instance_ids is not None:
        input_["instance_ids"] = instance_ids
    if filters is not None:
        input_["filters"] = filters
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if dry_run is not None:
        input_["dry_run"] = dry_run

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output