amazonka-route53-1.3.3: Amazon Route 53 SDK.

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

Network.AWS.Route53.ListHealthChecks

Contents

Description

To retrieve a list of your health checks, send a GET request to the '2013-04-01\/healthcheck' resource. The response to this request includes a HealthChecks element with zero, one, or multiple HealthCheck child elements. By default, the list of health checks is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. You can use the Marker parameter to control the health check that the list begins with.

Amazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value greater than 100, Amazon Route 53 returns only the first 100.

See: AWS API Reference for ListHealthChecks.

This operation returns paginated results.

Synopsis

Creating a Request

listHealthChecks :: ListHealthChecks Source

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

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

data ListHealthChecks Source

To retrieve a list of your health checks, send a GET request to the '2013-04-01\/healthcheck' resource. The response to this request includes a HealthChecks element with zero or more HealthCheck child elements. By default, the list of health checks is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. You can use the Marker parameter to control the health check that the list begins with.

Route 53 returns a maximum of 100 items. If you set MaxItems to a value greater than 100, Route 53 returns only the first 100.

See: listHealthChecks smart constructor.

Request Lenses

lhcMarker :: Lens' ListHealthChecks (Maybe Text) Source

If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.

lhcMaxItems :: Lens' ListHealthChecks (Maybe Text) Source

Specify the maximum number of health checks to return per page of results.

Destructuring the Response

listHealthChecksResponse Source

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

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

Response Lenses

lhcrsNextMarker :: Lens' ListHealthChecksResponse (Maybe Text) Source

Indicates where to continue listing health checks. If ListHealthChecksResponse$IsTruncated is true, make another request to ListHealthChecks and include the value of the NextMarker element in the Marker element to get the next page of results.

lhcrsHealthChecks :: Lens' ListHealthChecksResponse [HealthCheck] Source

A complex type that contains information about the health checks associated with the current AWS account.

lhcrsMarker :: Lens' ListHealthChecksResponse Text Source

If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.

lhcrsIsTruncated :: Lens' ListHealthChecksResponse Bool Source

A flag indicating whether there are more health checks to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the Marker element.

Valid Values: true | false

lhcrsMaxItems :: Lens' ListHealthChecksResponse Text Source

The maximum number of health checks to be included in the response body. If the number of health checks associated with this AWS account exceeds MaxItems, the value of ListHealthChecksResponse$IsTruncated in the response is true. Call ListHealthChecks again and specify the value of ListHealthChecksResponse$NextMarker in the ListHostedZonesRequest$Marker element to get the next page of results.