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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves a list of the public and private hosted zones that are associated with the current Amazon Web Services account. The response includes a HostedZones child element for each hosted zone.

Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of hosted zones, you can use the maxitems parameter to list them in groups of up to 100.

This operation returns paginated results.

Synopsis

data ListHostedZones = ListHostedZones' {
- delegationSetId :: Maybe ResourceId
- marker :: Maybe Text
- maxItems :: Maybe Text
}
newListHostedZones :: ListHostedZones
listHostedZones_delegationSetId :: Lens' ListHostedZones (Maybe ResourceId)
listHostedZones_marker :: Lens' ListHostedZones (Maybe Text)
listHostedZones_maxItems :: Lens' ListHostedZones (Maybe Text)
data ListHostedZonesResponse = ListHostedZonesResponse' {
- marker :: Maybe Text
- nextMarker :: Maybe Text
- httpStatus :: Int
- hostedZones :: [HostedZone]
- isTruncated :: Bool
- maxItems :: Text
}
newListHostedZonesResponse :: Int -> Bool -> Text -> ListHostedZonesResponse
listHostedZonesResponse_marker :: Lens' ListHostedZonesResponse (Maybe Text)
listHostedZonesResponse_nextMarker :: Lens' ListHostedZonesResponse (Maybe Text)
listHostedZonesResponse_httpStatus :: Lens' ListHostedZonesResponse Int
listHostedZonesResponse_hostedZones :: Lens' ListHostedZonesResponse [HostedZone]
listHostedZonesResponse_isTruncated :: Lens' ListHostedZonesResponse Bool
listHostedZonesResponse_maxItems :: Lens' ListHostedZonesResponse Text

Creating a Request

data ListHostedZones Source #

A request to retrieve a list of the public and private hosted zones that are associated with the current Amazon Web Services account.

See: newListHostedZones smart constructor.

Constructors

ListHostedZones'

Fields

delegationSetId :: Maybe ResourceId
If you're using reusable delegation sets and you want to list all of the hosted zones that are associated with a reusable delegation set, specify the ID of that reusable delegation set.
marker :: Maybe Text
If the value of IsTruncated in the previous response was true, you have more hosted zones. To get more hosted zones, submit another ListHostedZones request.
For the value of marker, specify the value of NextMarker from the previous response, which is the ID of the first hosted zone 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 hosted zones to get.
maxItems :: Maybe Text
(Optional) The maximum number of hosted zones that you want Amazon Route 53 to return. If you have more than maxitems hosted zones, the value of IsTruncated in the response is true, and the value of NextMarker is the hosted zone ID of the first hosted zone that Route 53 will return if you submit another request.

Instances

Instances details

Eq ListHostedZones Source #
Instance details Defined in Amazonka.Route53.ListHostedZones Methods (==) :: ListHostedZones -> ListHostedZones -> Bool # (/=) :: ListHostedZones -> ListHostedZones -> Bool #
Read ListHostedZones Source #
Instance details Defined in Amazonka.Route53.ListHostedZones Methods readsPrec :: Int -> ReadS ListHostedZones # readList :: ReadS [ListHostedZones] # readPrec :: ReadPrec ListHostedZones # readListPrec :: ReadPrec [ListHostedZones] #
Show ListHostedZones Source #
Instance details Defined in Amazonka.Route53.ListHostedZones Methods showsPrec :: Int -> ListHostedZones -> ShowS # show :: ListHostedZones -> String # showList :: [ListHostedZones] -> ShowS #
Generic ListHostedZones Source #
Instance details Defined in Amazonka.Route53.ListHostedZones Associated Types type Rep ListHostedZones :: Type -> Type # Methods from :: ListHostedZones -> Rep ListHostedZones x # to :: Rep ListHostedZones x -> ListHostedZones #
NFData ListHostedZones Source #
Instance details Defined in Amazonka.Route53.ListHostedZones Methods rnf :: ListHostedZones -> () #
Hashable ListHostedZones Source #
Instance details Defined in Amazonka.Route53.ListHostedZones Methods hashWithSalt :: Int -> ListHostedZones -> Int # hash :: ListHostedZones -> Int #
AWSPager ListHostedZones Source #
Instance details Defined in Amazonka.Route53.ListHostedZones Methods page :: ListHostedZones -> AWSResponse ListHostedZones -> Maybe ListHostedZones #
AWSRequest ListHostedZones Source #
Instance details Defined in Amazonka.Route53.ListHostedZones Associated Types type AWSResponse ListHostedZones # Methods request :: ListHostedZones -> Request ListHostedZones # response :: MonadResource m => Logger -> Service -> Proxy ListHostedZones -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListHostedZones))) #
ToHeaders ListHostedZones Source #
Instance details Defined in Amazonka.Route53.ListHostedZones Methods toHeaders :: ListHostedZones -> [Header] #
ToPath ListHostedZones Source #
Instance details Defined in Amazonka.Route53.ListHostedZones Methods toPath :: ListHostedZones -> ByteString #
ToQuery ListHostedZones Source #
Instance details Defined in Amazonka.Route53.ListHostedZones Methods toQuery :: ListHostedZones -> QueryString #
type Rep ListHostedZones Source #
Instance details Defined in Amazonka.Route53.ListHostedZones type Rep ListHostedZones = D1 ('MetaData "ListHostedZones" "Amazonka.Route53.ListHostedZones" "libZSservicesZSamazonka-route53ZSamazonka-route53" 'False) (C1 ('MetaCons "ListHostedZones'" 'PrefixI 'True) (S1 ('MetaSel ('Just "delegationSetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceId)) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))
type AWSResponse ListHostedZones Source #
Instance details Defined in Amazonka.Route53.ListHostedZones type AWSResponse ListHostedZones = ListHostedZonesResponse

newListHostedZones :: ListHostedZones Source #

Create a value of ListHostedZones 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:delegationSetId:ListHostedZones', listHostedZones_delegationSetId - If you're using reusable delegation sets and you want to list all of the hosted zones that are associated with a reusable delegation set, specify the ID of that reusable delegation set.

$sel:marker:ListHostedZones', listHostedZones_marker - If the value of IsTruncated in the previous response was true, you have more hosted zones. To get more hosted zones, submit another ListHostedZones request.

For the value of marker, specify the value of NextMarker from the previous response, which is the ID of the first hosted zone 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 hosted zones to get.

$sel:maxItems:ListHostedZones', listHostedZones_maxItems - (Optional) The maximum number of hosted zones that you want Amazon Route 53 to return. If you have more than maxitems hosted zones, the value of IsTruncated in the response is true, and the value of NextMarker is the hosted zone ID of the first hosted zone that Route 53 will return if you submit another request.

Request Lenses

listHostedZones_delegationSetId :: Lens' ListHostedZones (Maybe ResourceId) Source #

If you're using reusable delegation sets and you want to list all of the hosted zones that are associated with a reusable delegation set, specify the ID of that reusable delegation set.

listHostedZones_marker :: Lens' ListHostedZones (Maybe Text) Source #

If the value of IsTruncated in the previous response was true, you have more hosted zones. To get more hosted zones, submit another ListHostedZones request.

For the value of marker, specify the value of NextMarker from the previous response, which is the ID of the first hosted zone 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 hosted zones to get.

listHostedZones_maxItems :: Lens' ListHostedZones (Maybe Text) Source #

(Optional) The maximum number of hosted zones that you want Amazon Route 53 to return. If you have more than maxitems hosted zones, the value of IsTruncated in the response is true, and the value of NextMarker is the hosted zone ID of the first hosted zone that Route 53 will return if you submit another request.

Destructuring the Response

data ListHostedZonesResponse Source #

See: newListHostedZonesResponse smart constructor.

Constructors

ListHostedZonesResponse'

Fields

marker :: Maybe Text
For the second and subsequent calls to ListHostedZones, Marker is the value that you specified for the marker parameter in the request that produced the current response.
nextMarker :: Maybe Text
If IsTruncated is true, the value of NextMarker identifies the first hosted zone in the next group of hosted zones. Submit another ListHostedZones request, and specify the value of NextMarker from the response in the marker parameter.
This element is present only if IsTruncated is true.
httpStatus :: Int
The response's http status code.
hostedZones :: [HostedZone]
A complex type that contains general information about the hosted zone.
isTruncated :: Bool
A flag indicating whether there are more hosted zones to be listed. If the response was truncated, you can get more hosted zones by submitting another ListHostedZones 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 ListHostedZones that produced the current response.

Instances

Instances details

Eq ListHostedZonesResponse Source #
Instance details Defined in Amazonka.Route53.ListHostedZones Methods (==) :: ListHostedZonesResponse -> ListHostedZonesResponse -> Bool # (/=) :: ListHostedZonesResponse -> ListHostedZonesResponse -> Bool #
Read ListHostedZonesResponse Source #
Instance details Defined in Amazonka.Route53.ListHostedZones Methods readsPrec :: Int -> ReadS ListHostedZonesResponse # readList :: ReadS [ListHostedZonesResponse] # readPrec :: ReadPrec ListHostedZonesResponse # readListPrec :: ReadPrec [ListHostedZonesResponse] #
Show ListHostedZonesResponse Source #
Instance details Defined in Amazonka.Route53.ListHostedZones Methods showsPrec :: Int -> ListHostedZonesResponse -> ShowS # show :: ListHostedZonesResponse -> String # showList :: [ListHostedZonesResponse] -> ShowS #
Generic ListHostedZonesResponse Source #
Instance details Defined in Amazonka.Route53.ListHostedZones Associated Types type Rep ListHostedZonesResponse :: Type -> Type # Methods from :: ListHostedZonesResponse -> Rep ListHostedZonesResponse x # to :: Rep ListHostedZonesResponse x -> ListHostedZonesResponse #
NFData ListHostedZonesResponse Source #
Instance details Defined in Amazonka.Route53.ListHostedZones Methods rnf :: ListHostedZonesResponse -> () #
type Rep ListHostedZonesResponse Source #
Instance details Defined in Amazonka.Route53.ListHostedZones type Rep ListHostedZonesResponse = D1 ('MetaData "ListHostedZonesResponse" "Amazonka.Route53.ListHostedZones" "libZSservicesZSamazonka-route53ZSamazonka-route53" 'False) (C1 ('MetaCons "ListHostedZonesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "nextMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) :: (S1 ('MetaSel ('Just "hostedZones") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [HostedZone]) :: (S1 ('MetaSel ('Just "isTruncated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "maxItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newListHostedZonesResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListHostedZonesResponse'`
-> Bool	`$sel:isTruncated:ListHostedZonesResponse'`
-> Text	`$sel:maxItems:ListHostedZones'`
-> ListHostedZonesResponse

Create a value of ListHostedZonesResponse 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:ListHostedZones', listHostedZonesResponse_marker - For the second and subsequent calls to ListHostedZones, Marker is the value that you specified for the marker parameter in the request that produced the current response.

$sel:nextMarker:ListHostedZonesResponse', listHostedZonesResponse_nextMarker - If IsTruncated is true, the value of NextMarker identifies the first hosted zone in the next group of hosted zones. Submit another ListHostedZones request, and specify the value of NextMarker from the response in the marker parameter.

This element is present only if IsTruncated is true.

$sel:httpStatus:ListHostedZonesResponse', listHostedZonesResponse_httpStatus - The response's http status code.

$sel:hostedZones:ListHostedZonesResponse', listHostedZonesResponse_hostedZones - A complex type that contains general information about the hosted zone.

$sel:isTruncated:ListHostedZonesResponse', listHostedZonesResponse_isTruncated - A flag indicating whether there are more hosted zones to be listed. If the response was truncated, you can get more hosted zones by submitting another ListHostedZones request and specifying the value of NextMarker in the marker parameter.

$sel:maxItems:ListHostedZones', listHostedZonesResponse_maxItems - The value that you specified for the maxitems parameter in the call to ListHostedZones that produced the current response.

Response Lenses

listHostedZonesResponse_marker :: Lens' ListHostedZonesResponse (Maybe Text) Source #

For the second and subsequent calls to ListHostedZones, Marker is the value that you specified for the marker parameter in the request that produced the current response.

listHostedZonesResponse_nextMarker :: Lens' ListHostedZonesResponse (Maybe Text) Source #

If IsTruncated is true, the value of NextMarker identifies the first hosted zone in the next group of hosted zones. Submit another ListHostedZones request, and specify the value of NextMarker from the response in the marker parameter.

This element is present only if IsTruncated is true.

listHostedZonesResponse_httpStatus :: Lens' ListHostedZonesResponse Int Source #

The response's http status code.

listHostedZonesResponse_hostedZones :: Lens' ListHostedZonesResponse [HostedZone] Source #

A complex type that contains general information about the hosted zone.

listHostedZonesResponse_isTruncated :: Lens' ListHostedZonesResponse Bool Source #

A flag indicating whether there are more hosted zones to be listed. If the response was truncated, you can get more hosted zones by submitting another ListHostedZones request and specifying the value of NextMarker in the marker parameter.

listHostedZonesResponse_maxItems :: Lens' ListHostedZonesResponse Text Source #

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