[ aws . route53 ]

get-health-check-status

Description

Gets status of a specified health check.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-health-check-status
--health-check-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--health-check-id (string)

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.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

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.

(structure)

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 -> (structure)

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 -> (timestamp)

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.