libZSservicesZSamazonka-route53ZSamazonka-route53
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Route53.GetHealthCheckStatus

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.

Synopsis

Creating a Request

data GetHealthCheckStatus Source #

A request to get the status for a health check.

See: newGetHealthCheckStatus smart constructor.

Constructors

GetHealthCheckStatus' 

Fields

  • healthCheckId :: Text

    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.

Instances

Instances details
Eq GetHealthCheckStatus Source # 
Instance details

Defined in Amazonka.Route53.GetHealthCheckStatus

Read GetHealthCheckStatus Source # 
Instance details

Defined in Amazonka.Route53.GetHealthCheckStatus

Show GetHealthCheckStatus Source # 
Instance details

Defined in Amazonka.Route53.GetHealthCheckStatus

Generic GetHealthCheckStatus Source # 
Instance details

Defined in Amazonka.Route53.GetHealthCheckStatus

Associated Types

type Rep GetHealthCheckStatus :: Type -> Type #

NFData GetHealthCheckStatus Source # 
Instance details

Defined in Amazonka.Route53.GetHealthCheckStatus

Methods

rnf :: GetHealthCheckStatus -> () #

Hashable GetHealthCheckStatus Source # 
Instance details

Defined in Amazonka.Route53.GetHealthCheckStatus

AWSRequest GetHealthCheckStatus Source # 
Instance details

Defined in Amazonka.Route53.GetHealthCheckStatus

Associated Types

type AWSResponse GetHealthCheckStatus #

ToHeaders GetHealthCheckStatus Source # 
Instance details

Defined in Amazonka.Route53.GetHealthCheckStatus

ToPath GetHealthCheckStatus Source # 
Instance details

Defined in Amazonka.Route53.GetHealthCheckStatus

ToQuery GetHealthCheckStatus Source # 
Instance details

Defined in Amazonka.Route53.GetHealthCheckStatus

type Rep GetHealthCheckStatus Source # 
Instance details

Defined in Amazonka.Route53.GetHealthCheckStatus

type Rep GetHealthCheckStatus = D1 ('MetaData "GetHealthCheckStatus" "Amazonka.Route53.GetHealthCheckStatus" "libZSservicesZSamazonka-route53ZSamazonka-route53" 'False) (C1 ('MetaCons "GetHealthCheckStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "healthCheckId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetHealthCheckStatus Source # 
Instance details

Defined in Amazonka.Route53.GetHealthCheckStatus

newGetHealthCheckStatus Source #

Create a value of GetHealthCheckStatus with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:healthCheckId:GetHealthCheckStatus', getHealthCheckStatus_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.

Request Lenses

getHealthCheckStatus_healthCheckId :: Lens' GetHealthCheckStatus Text Source #

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.

Destructuring the Response

data GetHealthCheckStatusResponse Source #

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

See: newGetHealthCheckStatusResponse smart constructor.

Constructors

GetHealthCheckStatusResponse' 

Fields

Instances

Instances details
Eq GetHealthCheckStatusResponse Source # 
Instance details

Defined in Amazonka.Route53.GetHealthCheckStatus

Read GetHealthCheckStatusResponse Source # 
Instance details

Defined in Amazonka.Route53.GetHealthCheckStatus

Show GetHealthCheckStatusResponse Source # 
Instance details

Defined in Amazonka.Route53.GetHealthCheckStatus

Generic GetHealthCheckStatusResponse Source # 
Instance details

Defined in Amazonka.Route53.GetHealthCheckStatus

Associated Types

type Rep GetHealthCheckStatusResponse :: Type -> Type #

NFData GetHealthCheckStatusResponse Source # 
Instance details

Defined in Amazonka.Route53.GetHealthCheckStatus

type Rep GetHealthCheckStatusResponse Source # 
Instance details

Defined in Amazonka.Route53.GetHealthCheckStatus

type Rep GetHealthCheckStatusResponse = D1 ('MetaData "GetHealthCheckStatusResponse" "Amazonka.Route53.GetHealthCheckStatus" "libZSservicesZSamazonka-route53ZSamazonka-route53" 'False) (C1 ('MetaCons "GetHealthCheckStatusResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "healthCheckObservations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [HealthCheckObservation])))

newGetHealthCheckStatusResponse Source #

Create a value of GetHealthCheckStatusResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:GetHealthCheckStatusResponse', getHealthCheckStatusResponse_httpStatus - The response's http status code.

$sel:healthCheckObservations:GetHealthCheckStatusResponse', getHealthCheckStatusResponse_healthCheckObservations - A list that contains one HealthCheckObservation element for each Amazon Route 53 health checker that is reporting a status about the health check endpoint.

Response Lenses

getHealthCheckStatusResponse_healthCheckObservations :: Lens' GetHealthCheckStatusResponse [HealthCheckObservation] Source #

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