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

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

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

  • marker :: Maybe Text

    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.

  • maxItems :: Maybe Text

    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.

Instances

Instances details
Eq ListHealthChecks Source # 
Instance details

Defined in Amazonka.Route53.ListHealthChecks

Read ListHealthChecks Source # 
Instance details

Defined in Amazonka.Route53.ListHealthChecks

Show ListHealthChecks Source # 
Instance details

Defined in Amazonka.Route53.ListHealthChecks

Generic ListHealthChecks Source # 
Instance details

Defined in Amazonka.Route53.ListHealthChecks

Associated Types

type Rep ListHealthChecks :: Type -> Type #

NFData ListHealthChecks Source # 
Instance details

Defined in Amazonka.Route53.ListHealthChecks

Methods

rnf :: ListHealthChecks -> () #

Hashable ListHealthChecks Source # 
Instance details

Defined in Amazonka.Route53.ListHealthChecks

AWSPager ListHealthChecks Source # 
Instance details

Defined in Amazonka.Route53.ListHealthChecks

AWSRequest ListHealthChecks Source # 
Instance details

Defined in Amazonka.Route53.ListHealthChecks

Associated Types

type AWSResponse ListHealthChecks #

ToHeaders ListHealthChecks Source # 
Instance details

Defined in Amazonka.Route53.ListHealthChecks

ToPath ListHealthChecks Source # 
Instance details

Defined in Amazonka.Route53.ListHealthChecks

ToQuery ListHealthChecks Source # 
Instance details

Defined in Amazonka.Route53.ListHealthChecks

type Rep ListHealthChecks Source # 
Instance details

Defined in Amazonka.Route53.ListHealthChecks

type Rep ListHealthChecks = D1 ('MetaData "ListHealthChecks" "Amazonka.Route53.ListHealthChecks" "libZSservicesZSamazonka-route53ZSamazonka-route53" 'False) (C1 ('MetaCons "ListHealthChecks'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))
type AWSResponse ListHealthChecks Source # 
Instance details

Defined in Amazonka.Route53.ListHealthChecks

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

  • nextMarker :: Maybe Text

    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.

  • httpStatus :: Int

    The response's http status code.

  • healthChecks :: [HealthCheck]

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

  • marker :: Text

    For the second and subsequent calls to ListHealthChecks, Marker is the value that you specified for the marker parameter in the previous request.

  • isTruncated :: 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 health checks by submitting another ListHealthChecks request and specifying the value of NextMarker in the marker parameter.

  • maxItems :: Text

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

Instances

Instances details
Eq ListHealthChecksResponse Source # 
Instance details

Defined in Amazonka.Route53.ListHealthChecks

Read ListHealthChecksResponse Source # 
Instance details

Defined in Amazonka.Route53.ListHealthChecks

Show ListHealthChecksResponse Source # 
Instance details

Defined in Amazonka.Route53.ListHealthChecks

Generic ListHealthChecksResponse Source # 
Instance details

Defined in Amazonka.Route53.ListHealthChecks

Associated Types

type Rep ListHealthChecksResponse :: Type -> Type #

NFData ListHealthChecksResponse Source # 
Instance details

Defined in Amazonka.Route53.ListHealthChecks

type Rep ListHealthChecksResponse Source # 
Instance details

Defined in Amazonka.Route53.ListHealthChecks

type Rep ListHealthChecksResponse = D1 ('MetaData "ListHealthChecksResponse" "Amazonka.Route53.ListHealthChecks" "libZSservicesZSamazonka-route53ZSamazonka-route53" 'False) (C1 ('MetaCons "ListHealthChecksResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "healthChecks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [HealthCheck]))) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "isTruncated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "maxItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newListHealthChecksResponse Source #

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_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.