Network.AWS.Route53.GetHealthCheckStatus

Gets status of a specified health check. Send a GET request to the '/2013-04-01/healthcheck/health check ID/status' resource. You can use this call to get a health check's current status.

Creating a Request

getHealthCheckStatus

Arguments

:: Text

ghcsHealthCheckId

-> GetHealthCheckStatus

Creates a value of GetHealthCheckStatus with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ghcsHealthCheckId

data GetHealthCheckStatus

A complex type that contains information about the request to get health check status for a health check.

See: getHealthCheckStatus smart constructor.

Instances

Eq GetHealthCheckStatus

Methods

(==) :: GetHealthCheckStatus -> GetHealthCheckStatus -> Bool

(/=) :: GetHealthCheckStatus -> GetHealthCheckStatus -> Bool

Data GetHealthCheckStatus

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetHealthCheckStatus -> c GetHealthCheckStatus

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetHealthCheckStatus

toConstr :: GetHealthCheckStatus -> Constr

dataTypeOf :: GetHealthCheckStatus -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetHealthCheckStatus)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetHealthCheckStatus)

gmapT :: (forall b. Data b => b -> b) -> GetHealthCheckStatus -> GetHealthCheckStatus

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetHealthCheckStatus -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetHealthCheckStatus -> r

gmapQ :: (forall d. Data d => d -> u) -> GetHealthCheckStatus -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetHealthCheckStatus -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetHealthCheckStatus -> m GetHealthCheckStatus

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetHealthCheckStatus -> m GetHealthCheckStatus

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetHealthCheckStatus -> m GetHealthCheckStatus

Read GetHealthCheckStatus

Methods

readsPrec :: Int -> ReadS GetHealthCheckStatus

readList :: ReadS [GetHealthCheckStatus]

readPrec :: ReadPrec GetHealthCheckStatus

readListPrec :: ReadPrec [GetHealthCheckStatus]

Show GetHealthCheckStatus

Methods

showsPrec :: Int -> GetHealthCheckStatus -> ShowS

show :: GetHealthCheckStatus -> String

showList :: [GetHealthCheckStatus] -> ShowS

Generic GetHealthCheckStatus

Associated Types

type Rep GetHealthCheckStatus :: * -> *

Methods

from :: GetHealthCheckStatus -> Rep GetHealthCheckStatus x

to :: Rep GetHealthCheckStatus x -> GetHealthCheckStatus

Hashable GetHealthCheckStatus

Methods

hashWithSalt :: Int -> GetHealthCheckStatus -> Int

hash :: GetHealthCheckStatus -> Int

NFData GetHealthCheckStatus

Methods

rnf :: GetHealthCheckStatus -> ()

AWSRequest GetHealthCheckStatus

Associated Types

type Rs GetHealthCheckStatus :: *

Methods

request :: GetHealthCheckStatus -> Request GetHealthCheckStatus

response :: MonadResource m => Logger -> Service -> Proxy * GetHealthCheckStatus -> ClientResponse -> m (Response GetHealthCheckStatus)

ToPath GetHealthCheckStatus

Methods

toPath :: GetHealthCheckStatus -> ByteString

ToHeaders GetHealthCheckStatus

Methods

toHeaders :: GetHealthCheckStatus -> [Header]

ToQuery GetHealthCheckStatus

Methods

toQuery :: GetHealthCheckStatus -> QueryString

type Rep GetHealthCheckStatus

type Rep GetHealthCheckStatus = D1 (MetaData "GetHealthCheckStatus" "Network.AWS.Route53.GetHealthCheckStatus" "amazonka-route53-1.4.4-KBIXDpJOcpkWbDD9G5tXJ" True) (C1 (MetaCons "GetHealthCheckStatus'" PrefixI True) (S1 (MetaSel (Just Symbol "_ghcsHealthCheckId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

type Rs GetHealthCheckStatus

type Rs GetHealthCheckStatus = GetHealthCheckStatusResponse

Request Lenses

ghcsHealthCheckId :: Lens' GetHealthCheckStatus Text

If you want Amazon Route 53 to return this resource record set in response to a DNS query only when a health check is passing, include the HealthCheckId element and specify the ID of the applicable health check.

Amazon Route 53 determines whether a resource record set is healthy by periodically sending a request to the endpoint that is specified in the health check. If that endpoint returns an HTTP status code of 2xx or 3xx, the endpoint is healthy. If the endpoint returns an HTTP status code of 400 or greater, or if the endpoint doesn't respond for a certain amount of time, Amazon Route 53 considers the endpoint unhealthy and also considers the resource record set unhealthy.

The HealthCheckId element is only useful when Amazon Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Amazon Route 53 to base the choice in part on the status of a health check. Configuring health checks only makes sense in the following configurations:

• You're checking the health of the resource record sets in a weighted, latency, geolocation, or failover resource record set, and you specify health check IDs for all of the resource record sets. If the health check for one resource record set specifies an endpoint that is not healthy, Amazon Route 53 stops responding to queries using the value for that resource record set.

• You set EvaluateTargetHealth to true for the resource record sets in an alias, weighted alias, latency alias, geolocation alias, or failover alias resource record set, and you specify health check IDs for all of the resource record sets that are referenced by the alias resource record sets. For more information about this configuration, see EvaluateTargetHealth.

  Amazon Route 53 doesn't check the health of the endpoint specified in the resource record set, for example, the endpoint specified by the IP address in the Value element. When you add a HealthCheckId element to a resource record set, Amazon Route 53 checks the health of the endpoint that you specified in the health check.

For geolocation resource record sets, if an endpoint is unhealthy, Amazon Route 53 looks for a resource record set for the larger, associated geographic region. For example, suppose you have resource record sets for a state in the United States, for the United States, for North America, and for all locations. If the endpoint for the state resource record set is unhealthy, Amazon Route 53 checks the resource record sets for the United States, for North America, and for all locations (a resource record set for which the value of CountryCode is *), in that order, until it finds a resource record set for which the endpoint is healthy.

If your health checks specify the endpoint only by domain name, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as 'us-east-1-www.example.com'), not the name of the resource record sets (example.com).

In this configuration, if you create a health check for which the value of FullyQualifiedDomainName matches the name of the resource record sets and then associate the health check with those resource record sets, health check results will be unpredictable.

Destructuring the Response

getHealthCheckStatusResponse

Arguments

:: Int

ghcsrsResponseStatus

-> GetHealthCheckStatusResponse

Creates a value of GetHealthCheckStatusResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ghcsrsResponseStatus
• ghcsrsHealthCheckObservations

data GetHealthCheckStatusResponse

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

See: getHealthCheckStatusResponse smart constructor.

Instances

Eq GetHealthCheckStatusResponse

Methods

(==) :: GetHealthCheckStatusResponse -> GetHealthCheckStatusResponse -> Bool

(/=) :: GetHealthCheckStatusResponse -> GetHealthCheckStatusResponse -> Bool

Data GetHealthCheckStatusResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetHealthCheckStatusResponse -> c GetHealthCheckStatusResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetHealthCheckStatusResponse

toConstr :: GetHealthCheckStatusResponse -> Constr

dataTypeOf :: GetHealthCheckStatusResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetHealthCheckStatusResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetHealthCheckStatusResponse)

gmapT :: (forall b. Data b => b -> b) -> GetHealthCheckStatusResponse -> GetHealthCheckStatusResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetHealthCheckStatusResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetHealthCheckStatusResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> GetHealthCheckStatusResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetHealthCheckStatusResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetHealthCheckStatusResponse -> m GetHealthCheckStatusResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetHealthCheckStatusResponse -> m GetHealthCheckStatusResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetHealthCheckStatusResponse -> m GetHealthCheckStatusResponse

Read GetHealthCheckStatusResponse

Methods

readsPrec :: Int -> ReadS GetHealthCheckStatusResponse

readList :: ReadS [GetHealthCheckStatusResponse]

readPrec :: ReadPrec GetHealthCheckStatusResponse

readListPrec :: ReadPrec [GetHealthCheckStatusResponse]

Show GetHealthCheckStatusResponse

Methods

showsPrec :: Int -> GetHealthCheckStatusResponse -> ShowS

show :: GetHealthCheckStatusResponse -> String

showList :: [GetHealthCheckStatusResponse] -> ShowS

Generic GetHealthCheckStatusResponse

Associated Types

type Rep GetHealthCheckStatusResponse :: * -> *

Methods

from :: GetHealthCheckStatusResponse -> Rep GetHealthCheckStatusResponse x

to :: Rep GetHealthCheckStatusResponse x -> GetHealthCheckStatusResponse

NFData GetHealthCheckStatusResponse

Methods

rnf :: GetHealthCheckStatusResponse -> ()

type Rep GetHealthCheckStatusResponse

type Rep GetHealthCheckStatusResponse = D1 (MetaData "GetHealthCheckStatusResponse" "Network.AWS.Route53.GetHealthCheckStatus" "amazonka-route53-1.4.4-KBIXDpJOcpkWbDD9G5tXJ" False) (C1 (MetaCons "GetHealthCheckStatusResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ghcsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)) (S1 (MetaSel (Just Symbol "_ghcsrsHealthCheckObservations") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [HealthCheckObservation]))))

Response Lenses

ghcsrsResponseStatus :: Lens' GetHealthCheckStatusResponse Int

The response status code.

ghcsrsHealthCheckObservations :: Lens' GetHealthCheckStatusResponse [HealthCheckObservation]

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