Skip to content

get_health_check_status

get_health_check_status(
    health_check_id: HealthCheckId,
    *,
    config_overrides: Optional[Route53ClientConfig] = None,
) -> GetHealthCheckStatusResponse

Gets status of a specified health check.

This API is intended for use during development to diagnose behavior. It doesn’t support production use-cases with high query rates that require immediate and actionable responses.

Parameters:

  • health_check_id (HealthCheckId) –

    The ID for the health check that you want the current status for. When you created the health check, CreateHealthCheck returned the ID in the response, in the HealthCheckId element.

    If you want to check the status of a calculated health check, you must use the Amazon Route 53 console or the CloudWatch console. You can't use GetHealthCheckStatus to get the status of a calculated health check.

Raises:

Source code in docs_src/capo_route_53/_services/route53.py
def get_health_check_status(
    self,
    health_check_id: "capo_route_53.types.health_check_id.HealthCheckId",
    *,
    config_overrides: Optional[Route53ClientConfig] = None,
) -> "capo_route_53.types.get_health_check_status_response.GetHealthCheckStatusResponse":
    """<p>Gets status of a specified health check. </p> <important> <p>This API is intended for use during development to diagnose behavior. It doesn’t support production use-cases with high query rates that require immediate and actionable responses.</p> </important>

    Args:
        health_check_id: <p>The ID for the health check that you want the current status for. When you created the health check, <code>CreateHealthCheck</code> returned the ID in the response, in the <code>HealthCheckId</code> element.</p> <note> <p>If you want to check the status of a calculated health check, you must use the Amazon Route 53 console or the CloudWatch console. You can't use <code>GetHealthCheckStatus</code> to get the status of a calculated health check.</p> </note>

    Raises:
        capo_route_53.errors.invalid_input.InvalidInput: <p>The input is not valid.</p>
        capo_route_53.errors.no_such_health_check.NoSuchHealthCheck: <p>No health check exists with the specified ID.</p>
        capo_route_53.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_route_53.types.get_health_check_status_request.GetHealthCheckStatusRequest]",
    ) -> OperationResponse[
        "capo_route_53.types.get_health_check_status_response.GetHealthCheckStatusResponse"
    ]:
        import capo_route_53._operations.aws_dns_v20130401.get_health_check_status

        output, http_response = (
            capo_route_53._operations.aws_dns_v20130401.get_health_check_status.get_health_check_status(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetHealthCheckStatus")
    )
    input_: capo_route_53.types.get_health_check_status_request.GetHealthCheckStatusRequest = {
        "health_check_id": health_check_id
    }

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