| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Route53.ListHealthChecks
Description
Retrieve a list of the health checks that are associated with the current Amazon Web Services account.
This operation returns paginated results.
Synopsis
- data ListHealthChecks = ListHealthChecks' {}
- newListHealthChecks :: ListHealthChecks
- listHealthChecks_marker :: Lens' ListHealthChecks (Maybe Text)
- listHealthChecks_maxItems :: Lens' ListHealthChecks (Maybe Text)
- data ListHealthChecksResponse = ListHealthChecksResponse' {
- nextMarker :: Maybe Text
- httpStatus :: Int
- healthChecks :: [HealthCheck]
- marker :: Text
- isTruncated :: Bool
- maxItems :: Text
- newListHealthChecksResponse :: Int -> Text -> Bool -> Text -> ListHealthChecksResponse
- listHealthChecksResponse_nextMarker :: Lens' ListHealthChecksResponse (Maybe Text)
- listHealthChecksResponse_httpStatus :: Lens' ListHealthChecksResponse Int
- listHealthChecksResponse_healthChecks :: Lens' ListHealthChecksResponse [HealthCheck]
- listHealthChecksResponse_marker :: Lens' ListHealthChecksResponse Text
- listHealthChecksResponse_isTruncated :: Lens' ListHealthChecksResponse Bool
- listHealthChecksResponse_maxItems :: Lens' ListHealthChecksResponse Text
Creating a Request
data ListHealthChecks Source #
A request to retrieve a list of the health checks that are associated with the current Amazon Web Services account.
See: newListHealthChecks smart constructor.
Constructors
| ListHealthChecks' | |
Fields
| |
Instances
newListHealthChecks :: ListHealthChecks Source #
Create a value of ListHealthChecks 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:marker:ListHealthChecks', listHealthChecks_marker - If the value of IsTruncated in the previous response was true, you
have more health checks. To get another group, submit another
ListHealthChecks request.
For the value of marker, specify the value of NextMarker from the
previous response, which is the ID of the first health check that Amazon
Route 53 will return if you submit another request.
If the value of IsTruncated in the previous response was false,
there are no more health checks to get.
$sel:maxItems:ListHealthChecks', listHealthChecks_maxItems - The maximum number of health checks that you want ListHealthChecks to
return in response to the current request. Amazon 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 health checks.
Request Lenses
listHealthChecks_marker :: Lens' ListHealthChecks (Maybe Text) Source #
If the value of IsTruncated in the previous response was true, you
have more health checks. To get another group, submit another
ListHealthChecks request.
For the value of marker, specify the value of NextMarker from the
previous response, which is the ID of the first health check that Amazon
Route 53 will return if you submit another request.
If the value of IsTruncated in the previous response was false,
there are no more health checks to get.
listHealthChecks_maxItems :: Lens' ListHealthChecks (Maybe Text) Source #
The maximum number of health checks that you want ListHealthChecks to
return in response to the current request. Amazon 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 health checks.
Destructuring the Response
data ListHealthChecksResponse Source #
A complex type that contains the response to a ListHealthChecks
request.
See: newListHealthChecksResponse smart constructor.
Constructors
| ListHealthChecksResponse' | |
Fields
| |
Instances
newListHealthChecksResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Bool | |
| -> Text | |
| -> ListHealthChecksResponse |
Create a value of ListHealthChecksResponse 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:nextMarker:ListHealthChecksResponse', listHealthChecksResponse_nextMarker - If IsTruncated is true, the value of NextMarker identifies the
first health check that Amazon Route 53 returns if you submit another
ListHealthChecks request and specify the value of NextMarker in the
marker parameter.
$sel:httpStatus:ListHealthChecksResponse', listHealthChecksResponse_httpStatus - The response's http status code.
$sel:healthChecks:ListHealthChecksResponse', listHealthChecksResponse_healthChecks - A complex type that contains one HealthCheck element for each health
check that is associated with the current Amazon Web Services account.
$sel:marker:ListHealthChecks', listHealthChecksResponse_marker - For the second and subsequent calls to ListHealthChecks, Marker is
the value that you specified for the marker parameter in the previous
request.
$sel:isTruncated:ListHealthChecksResponse', listHealthChecksResponse_isTruncated - 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 health
checks by submitting another ListHealthChecks request and specifying
the value of NextMarker in the marker parameter.
$sel:maxItems:ListHealthChecks', listHealthChecksResponse_maxItems - The value that you specified for the maxitems parameter in the call to
ListHealthChecks that produced the current response.
Response Lenses
listHealthChecksResponse_nextMarker :: Lens' ListHealthChecksResponse (Maybe Text) Source #
If IsTruncated is true, the value of NextMarker identifies the
first health check that Amazon Route 53 returns if you submit another
ListHealthChecks request and specify the value of NextMarker in the
marker parameter.
listHealthChecksResponse_httpStatus :: Lens' ListHealthChecksResponse Int Source #
The response's http status code.
listHealthChecksResponse_healthChecks :: Lens' ListHealthChecksResponse [HealthCheck] Source #
A complex type that contains one HealthCheck element for each health
check that is associated with the current Amazon Web Services account.
listHealthChecksResponse_marker :: 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.
listHealthChecksResponse_isTruncated :: 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 health
checks by submitting another ListHealthChecks request and specifying
the value of NextMarker in the marker parameter.
listHealthChecksResponse_maxItems :: Lens' ListHealthChecksResponse Text Source #
The value that you specified for the maxitems parameter in the call to
ListHealthChecks that produced the current response.