Class GetHealthCheckStatusCommandProtected

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.

Example

Use a bare-bones client and the command you need to make an API call.

import { Route53Client, GetHealthCheckStatusCommand } from "@aws-sdk/client-route-53"; // ES Modules import
// const { Route53Client, GetHealthCheckStatusCommand } = require("@aws-sdk/client-route-53"); // CommonJS import
const client = new Route53Client(config);
const input = { // GetHealthCheckStatusRequest
  HealthCheckId: "STRING_VALUE", // required
};
const command = new GetHealthCheckStatusCommand(input);
const response = await client.send(command);
// { // GetHealthCheckStatusResponse
//   HealthCheckObservations: [ // HealthCheckObservations // required
//     { // HealthCheckObservation
//       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_VALUE",
//       StatusReport: { // StatusReport
//         Status: "STRING_VALUE",
//         CheckedTime: new Date("TIMESTAMP"),
//       },
//     },
//   ],
// };

Param

GetHealthCheckStatusCommandInput

Returns

GetHealthCheckStatusCommandOutput

See

• GetHealthCheckStatusCommandInput for command's input shape.
• GetHealthCheckStatusCommandOutput for command's response shape.
• config for Route53Client's config shape.

Throws

InvalidInput (client fault)

The input is not valid.

Throws

NoSuchHealthCheck (client fault)

No health check exists with the specified ID.

Throws

Route53ServiceException

Base exception class for all service exceptions from Route53 service.