amazonka-route53-1.4.3: Amazon Route 53 SDK.

Copyright(c) 2013-2016 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 '/Route 53 API version/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.

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 '/Route 53 API version/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.

Instances

Eq ListHealthChecks Source # 
Data ListHealthChecks Source # 

Methods

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

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

toConstr :: ListHealthChecks -> Constr #

dataTypeOf :: ListHealthChecks -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> ListHealthChecks -> ListHealthChecks #

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

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

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

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

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

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

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

Read ListHealthChecks Source # 
Show ListHealthChecks Source # 
Generic ListHealthChecks Source # 
Hashable ListHealthChecks Source # 
NFData ListHealthChecks Source # 

Methods

rnf :: ListHealthChecks -> () #

AWSPager ListHealthChecks Source # 
AWSRequest ListHealthChecks Source # 
ToPath ListHealthChecks Source # 
ToHeaders ListHealthChecks Source # 
ToQuery ListHealthChecks Source # 
type Rep ListHealthChecks Source # 
type Rep ListHealthChecks = D1 (MetaData "ListHealthChecks" "Network.AWS.Route53.ListHealthChecks" "amazonka-route53-1.4.3-GVCZrM1VgYbI4WdWSABHKg" False) (C1 (MetaCons "ListHealthChecks'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_lhcMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_lhcMaxItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))
type Rs ListHealthChecks Source # 

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:

data ListHealthChecksResponse Source #

A complex type that contains the response for the request.

See: listHealthChecksResponse smart constructor.

Instances

Eq ListHealthChecksResponse Source # 
Data ListHealthChecksResponse Source # 

Methods

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

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

toConstr :: ListHealthChecksResponse -> Constr #

dataTypeOf :: ListHealthChecksResponse -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> ListHealthChecksResponse -> ListHealthChecksResponse #

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

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

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

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

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

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

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

Read ListHealthChecksResponse Source # 
Show ListHealthChecksResponse Source # 
Generic ListHealthChecksResponse Source # 
NFData ListHealthChecksResponse Source # 
type Rep ListHealthChecksResponse Source # 
type Rep ListHealthChecksResponse = D1 (MetaData "ListHealthChecksResponse" "Network.AWS.Route53.ListHealthChecks" "amazonka-route53-1.4.3-GVCZrM1VgYbI4WdWSABHKg" False) (C1 (MetaCons "ListHealthChecksResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_lhcrsNextMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_lhcrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)) (S1 (MetaSel (Just Symbol "_lhcrsHealthChecks") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [HealthCheck])))) ((:*:) (S1 (MetaSel (Just Symbol "_lhcrsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_lhcrsIsTruncated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)) (S1 (MetaSel (Just Symbol "_lhcrsMaxItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

Response Lenses

lhcrsNextMarker :: Lens' ListHealthChecksResponse (Maybe Text) Source #

Indicates where to continue listing health checks. If ListHealthChecksResponseIsTruncated> 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 ListHealthChecksResponseIsTruncated> in the response is true. Call ListHealthChecks again and specify the value of ListHealthChecksResponseNextMarker> in the ListHostedZonesRequestMarker> element to get the next page of results.