Get Health Check Status

route53_get_health_check_status

R Documentation

Gets status of a specified health check¶

Description¶

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.

Usage¶

route53_get_health_check_status(HealthCheckId)

Arguments¶

HealthCheckId

[required] The ID for the health check that you want the current status for. When you created the health check, create_health_check 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 get_health_check_status to get the status of a calculated health check.

Value¶

A list with the following syntax:

list(
  HealthCheckObservations = list(
    list(
      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 = list(
        Status = "string",
        CheckedTime = as.POSIXct(
          "2015-01-01"
        )
      )
    )
  )
)

Request syntax¶

svc$get_health_check_status(
  HealthCheckId = "string"
)