get_health_check_status

get_health_check_status(**kwargs)

Gets status of a specified health check.

Warning

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.

See also: AWS API Documentation

Request Syntax

response = client.get_health_check_status(
    HealthCheckId='string'
)

Parameters

HealthCheckId (string) --

[REQUIRED]

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.

Note

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.

Return type

dict

Returns

Response Syntax

{
    'HealthCheckObservations': [
        {
            'Region': 'us-east-1'|'us-west-1'|'us-west-2'|'eu-west-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'sa-east-1',
            'IPAddress': 'string',
            'StatusReport': {
                'Status': 'string',
                'CheckedTime': datetime(2015, 1, 1)
            }
        },
    ]
}

Response Structure

• (dict) --

  A complex type that contains the response to a GetHealthCheck request.

  • HealthCheckObservations (list) --

    A list that contains one HealthCheckObservation element for each Amazon Route 53 health checker that is reporting a status about the health check endpoint.

    • (dict) --

      A complex type that contains the last failure reason as reported by one Amazon Route 53 health checker.

      • Region (string) --

        The region of the Amazon Route 53 health checker that provided the status in StatusReport .

      • IPAddress (string) --

        The IP address of the Amazon Route 53 health checker that provided the failure reason in StatusReport .

      • StatusReport (dict) --

        A complex type that contains the last failure reason as reported by one Amazon Route 53 health checker and the time of the failed health check.

        • Status (string) --

          A description of the status of the health check endpoint as reported by one of the Amazon Route 53 health checkers.

        • CheckedTime (datetime) --

          The date and time that the health checker performed the health check in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z represents March 27, 2017 at 17:48:16.751 UTC.

Exceptions

• Route53.Client.exceptions.NoSuchHealthCheck
• Route53.Client.exceptions.InvalidInput