Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
For information about listing health checks using the Amazon Route 53 console, see Amazon Route 53 Health Checks and DNS Failover.
This operation returns paginated results.
- listHealthChecks :: ListHealthChecks
- data ListHealthChecks
- lhcMarker :: Lens' ListHealthChecks (Maybe Text)
- lhcMaxItems :: Lens' ListHealthChecks (Maybe Text)
- listHealthChecksResponse :: Int -> Text -> Bool -> Text -> ListHealthChecksResponse
- data ListHealthChecksResponse
- lhcrsNextMarker :: Lens' ListHealthChecksResponse (Maybe Text)
- lhcrsResponseStatus :: Lens' ListHealthChecksResponse Int
- lhcrsHealthChecks :: Lens' ListHealthChecksResponse [HealthCheck]
- lhcrsMarker :: Lens' ListHealthChecksResponse Text
- lhcrsIsTruncated :: Lens' ListHealthChecksResponse Bool
- lhcrsMaxItems :: Lens' ListHealthChecksResponse Text
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.
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: listHealthChecks
smart constructor.
Request Lenses
lhcMarker :: Lens' ListHealthChecks (Maybe Text) Source #
If the response to a ListHealthChecks
is more than one page, marker is the health check ID for the first health check on the next page of results. For more information, see ListHealthChecksResponseMaxItems>.
lhcMaxItems :: Lens' ListHealthChecks (Maybe Text) Source #
The maximum number of HealthCheck
elements you want ListHealthChecks
to return on each page of the response body. If the AWS account includes more HealthCheck
elements than the value of maxitems
, the response is broken into pages. Each page contains the number of HealthCheck
elements specified by maxitems
.
For example, suppose you specify '10' for maxitems
and the current AWS account has '51' health checks. In the response, ListHealthChecks
sets ListHealthChecksResponseIsTruncated> to true and includes the ListHealthChecksResponseNextMarker> element. To access the second and subsequent pages, you resend the GET
ListHealthChecks
request, add the ListHealthChecksResponseMarker> parameter to the request, and specify the value of the ListHealthChecksResponseNextMarker> element from the previous response. On the last (sixth) page of the response, which contains only one HealthCheck element:
- The value of ListHealthChecksResponseIsTruncated> is
false
. - ListHealthChecksResponseNextMarker> is omitted.
Destructuring the Response
listHealthChecksResponse Source #
:: Int | |
-> Text | |
-> Bool | |
-> Text | |
-> ListHealthChecksResponse |
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:
data ListHealthChecksResponse Source #
A complex type that contains the response to a ListHealthChecks
request.
See: listHealthChecksResponse
smart constructor.
Response Lenses
lhcrsNextMarker :: Lens' ListHealthChecksResponse (Maybe Text) Source #
If IsTruncated
is true
, the value of NextMarker
identifies the first health check in the next group of maxitems
health checks. Call ListHealthChecks
again and specify the value of NextMarker
in the marker parameter.
lhcrsResponseStatus :: Lens' ListHealthChecksResponse Int Source #
The response status code.
lhcrsHealthChecks :: Lens' ListHealthChecksResponse [HealthCheck] Source #
A complex type that contains one HealthCheck
element for each health check that is associated with the current AWS account.
lhcrsMarker :: Lens' ListHealthChecksResponse Text Source #
For the second and subsequent calls to ListHealthChecks
, Marker
is the value that you specified for the marker parameter in the previous request.
lhcrsIsTruncated :: Lens' ListHealthChecksResponse Bool Source #
A flag that indicates whether there are more health checks to be listed. If the response was truncated, you can get the next group of maxitems
health checks by calling ListHealthChecks
again and specifying the value of the NextMarker
element in the marker parameter.
Valid Values: true
| false
lhcrsMaxItems :: Lens' ListHealthChecksResponse Text Source #
The value that you specified for the maxitems
parameter in the call to ListHealthChecks
that produced the current response.