amazonka-route53-1.4.5: 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

Retrieve a list of your health checks. Send a GET request to the 2013-04-01healthcheck 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.

Synopsis

Creating a Request

listHealthChecks :: ListHealthChecks #

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:

  • lhcMarker - 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 'ListHealthChecksResponse$MaxItems' .
  • lhcMaxItems - 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 'ListHealthChecksResponse$IsTruncated' to true and includes the 'ListHealthChecksResponse$NextMarker' element. To access the second and subsequent pages, you resend the GET ListHealthChecks request, add the 'ListHealthChecksResponse$Marker' parameter to the request, and specify the value of the 'ListHealthChecksResponse$NextMarker' element from the previous response. On the last (sixth) page of the response, which contains only one HealthCheck element: * The value of 'ListHealthChecksResponse$IsTruncated' is false . * 'ListHealthChecksResponse$NextMarker' is omitted.

data ListHealthChecks #

To retrieve a list of your health checks, send a GET request to the 2013-04-01healthcheck 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.

See: listHealthChecks smart constructor.

Instances

Eq ListHealthChecks # 
Data ListHealthChecks # 

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 # 
Show ListHealthChecks # 
Generic ListHealthChecks # 
Hashable ListHealthChecks # 
NFData ListHealthChecks # 

Methods

rnf :: ListHealthChecks -> () #

AWSPager ListHealthChecks # 
AWSRequest ListHealthChecks # 
ToQuery ListHealthChecks # 
ToPath ListHealthChecks # 
ToHeaders ListHealthChecks # 
type Rep ListHealthChecks # 
type Rep ListHealthChecks = D1 (MetaData "ListHealthChecks" "Network.AWS.Route53.ListHealthChecks" "amazonka-route53-1.4.5-1GBIEWLx4PAkG5NoOOGoJ" 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 # 

Request Lenses

lhcMarker :: Lens' ListHealthChecks (Maybe Text) #

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 'ListHealthChecksResponse$MaxItems' .

lhcMaxItems :: Lens' ListHealthChecks (Maybe Text) #

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 'ListHealthChecksResponse$IsTruncated' to true and includes the 'ListHealthChecksResponse$NextMarker' element. To access the second and subsequent pages, you resend the GET ListHealthChecks request, add the 'ListHealthChecksResponse$Marker' parameter to the request, and specify the value of the 'ListHealthChecksResponse$NextMarker' element from the previous response. On the last (sixth) page of the response, which contains only one HealthCheck element: * The value of 'ListHealthChecksResponse$IsTruncated' is false . * 'ListHealthChecksResponse$NextMarker' is omitted.

Destructuring the Response

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:

  • lhcrsNextMarker - 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 - -- | The response status code.
  • lhcrsHealthChecks - A complex type that contains one HealthCheck element for each health check that is associated with the current AWS account.
  • lhcrsMarker - For the second and subsequent calls to ListHealthChecks , Marker is the value that you specified for the marker parameter in the previous request.
  • lhcrsIsTruncated - 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 - The value that you specified for the maxitems parameter in the call to ListHealthChecks that produced the current response.

data ListHealthChecksResponse #

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

See: listHealthChecksResponse smart constructor.

Instances

Eq ListHealthChecksResponse # 
Data ListHealthChecksResponse # 

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 # 
Show ListHealthChecksResponse # 
Generic ListHealthChecksResponse # 
NFData ListHealthChecksResponse # 
type Rep ListHealthChecksResponse # 
type Rep ListHealthChecksResponse = D1 (MetaData "ListHealthChecksResponse" "Network.AWS.Route53.ListHealthChecks" "amazonka-route53-1.4.5-1GBIEWLx4PAkG5NoOOGoJ" False) (C1 (MetaCons "ListHealthChecksResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_lhcrsNextMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_lhcrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (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) #

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 #

  • - | The response status code.

lhcrsHealthChecks :: Lens' ListHealthChecksResponse [HealthCheck] #

A complex type that contains one HealthCheck element for each health check that is associated with the current AWS account.

lhcrsMarker :: Lens' ListHealthChecksResponse Text #

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 #

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 #

The value that you specified for the maxitems parameter in the call to ListHealthChecks that produced the current response.