describe_application_status_checks ¶

def describe_application_status_checks(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    application_status_check_ids: Optional[
        "capo_ec2.types.application_status_check_id_list.ApplicationStatusCheckIdList"
    ] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
    max_results: Optional[
        "capo_ec2.types.describe_application_status_checks_max_results.DescribeApplicationStatusChecksMaxResults"
    ] = None,
    next_token: Optional["capo_ec2.types.string.String"] = None,
    include_all: Optional["capo_ec2.types.boolean.Boolean"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.describe_application_status_checks_result.DescribeApplicationStatusChecksResult":
    """<p>Describes application status checks, including configuration details such as protocol, port, path, thresholds, and associations. Results are paginated. Use the <code>NextToken</code> parameter to retrieve additional results. The following rules apply:</p> <ul> <li> <p>If you do not specify any application status check IDs, all checks in your account are returned.</p> </li> <li> <p>Use <code>DescribeApplicationStatus</code> to see the actual health status of instances.</p> </li> </ul>

    Args:
        application_status_check_ids: <p>The IDs of the application status checks to describe.</p>
        filters: <p>The filters.</p> <ul> <li> <p> <code>aggregation</code> – The aggregation setting. Valid values: <code>included</code> and <code>excluded</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>
        include_all: <p>Specifies whether to include recently deleted application status checks that remain available during the deletion grace period. If you omit this parameter or set it to <code>false</code>, the response includes only active checks.</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 checks
        This example describes the specified application status checks.

        >>> client.describe_application_status_checks(application_status_check_ids=['asc-0123456789abcdef0'])
        To describe application status checks using filters
        This example uses a filter to describe application status checks included in aggregation.

        >>> client.describe_application_status_checks(filters=[{'Name': 'aggregation', 'Values': ['included']}], max_results=10)
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.describe_application_status_checks_request.DescribeApplicationStatusChecksRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.describe_application_status_checks_result.DescribeApplicationStatusChecksResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_application_status_checks

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeApplicationStatusChecks")
    )
    input_: capo_ec2.types.describe_application_status_checks_request.DescribeApplicationStatusChecksRequest = {}
    if application_status_check_ids is not None:
        input_["application_status_check_ids"] = application_status_check_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 include_all is not None:
        input_["include_all"] = include_all
    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