Network.AWS.Route53.ListHostedZones

To retrieve a list of your public and private hosted zones, send a GET request to the '\/2013-04-01\/hostedzone' resource. The response to this request includes a HostedZones child element for each hosted zone created by the current AWS account.

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. The response includes four values that help navigate from one group of maxitems hosted zones to the next:

• MaxItemsis the value specified for the maxitems parameter in the request that produced the current response.
• If the value of IsTruncated in the response is true, there are more hosted zones associated with the current AWS account.

• NextMarkeris the hosted zone ID of the next hosted zone that is associated with the current AWS account. If you want to list more hosted zones, make another call to ListHostedZones, and specify the value of the NextMarker element in the marker parameter.

  If IsTruncated is false, the NextMarker element is omitted from the response.

• If you're making the second or subsequent call to ListHostedZones, the Marker element matches the value that you specified in the marker parameter in the previous request.

This operation returns paginated results.

Creating a Request

listHostedZones :: ListHostedZones

Creates a value of ListHostedZones with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lhzDelegationSetId
• lhzMarker
• lhzMaxItems

data ListHostedZones

To retrieve a list of your public and private hosted zones, send a GET request to the '\/2013-04-01\/hostedzone' resource. The response to this request includes a HostedZone child element for each hosted zone that was created by the current AWS account.

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. The response includes four values that help you navigate from one group of maxitems hosted zones to the next:

• MaxItems is the value that you specified for the maxitems parameter in the request that produced the current response.

• If the value of IsTruncated in the response is true, there are more hosted zones associated with the current AWS account.

  If IsTruncated is false, this response includes the last hosted zone that is associated with the current account.

• NextMarker is the hosted zone ID of the next hosted zone that is associated with the current AWS account. If you want to list more hosted zones, make another call to ListHostedZones, and specify the value of the NextMarker element in the marker parameter.

  If IsTruncated is false, the NextMarker element is omitted from the response.

• If you're making the second or subsequent call to ListHostedZones, the Marker element matches the value that you specified in the marker parameter in the previous request.

See: listHostedZones smart constructor.

Instances

Eq ListHostedZones

Methods

(==) :: ListHostedZones -> ListHostedZones -> Bool

(/=) :: ListHostedZones -> ListHostedZones -> Bool

Data ListHostedZones

Methods

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

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

toConstr :: ListHostedZones -> Constr

dataTypeOf :: ListHostedZones -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> ListHostedZones -> ListHostedZones

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

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

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

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

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

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

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

Read ListHostedZones

Methods

readsPrec :: Int -> ReadS ListHostedZones

readList :: ReadS [ListHostedZones]

readPrec :: ReadPrec ListHostedZones

readListPrec :: ReadPrec [ListHostedZones]

Show ListHostedZones

Methods

showsPrec :: Int -> ListHostedZones -> ShowS

show :: ListHostedZones -> String

showList :: [ListHostedZones] -> ShowS

Generic ListHostedZones

Associated Types

type Rep ListHostedZones :: * -> *

Methods

from :: ListHostedZones -> Rep ListHostedZones x

to :: Rep ListHostedZones x -> ListHostedZones

Hashable ListHostedZones

Methods

hashWithSalt :: Int -> ListHostedZones -> Int

hash :: ListHostedZones -> Int

NFData ListHostedZones

Methods

rnf :: ListHostedZones -> ()

AWSPager ListHostedZones

Methods

page :: ListHostedZones -> Rs ListHostedZones -> Maybe ListHostedZones

AWSRequest ListHostedZones

Associated Types

type Rs ListHostedZones :: *

Methods

request :: ListHostedZones -> Request ListHostedZones

response :: MonadResource m => Logger -> Service -> Proxy * ListHostedZones -> ClientResponse -> m (Response ListHostedZones)

ToPath ListHostedZones

Methods

toPath :: ListHostedZones -> ByteString

ToHeaders ListHostedZones

Methods

toHeaders :: ListHostedZones -> [Header]

ToQuery ListHostedZones

Methods

toQuery :: ListHostedZones -> QueryString

type Rep ListHostedZones

type Rep ListHostedZones = D1 (MetaData "ListHostedZones" "Network.AWS.Route53.ListHostedZones" "amazonka-route53-1.4.4-KBIXDpJOcpkWbDD9G5tXJ" False) (C1 (MetaCons "ListHostedZones'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_lhzDelegationSetId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_lhzMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_lhzMaxItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

type Rs ListHostedZones

type Rs ListHostedZones = ListHostedZonesResponse

Request Lenses

lhzDelegationSetId :: Lens' ListHostedZones (Maybe Text)

Undocumented member.

lhzMarker :: Lens' ListHostedZones (Maybe Text)

(Optional) If you have more hosted zones than the value of maxitems, ListHostedZones returns only the first maxitems hosted zones. To get the next group of maxitems hosted zones, submit another request to ListHostedZones. For the value of marker, specify the value of the NextMarker element that was returned in the previous response.

Hosted zones are listed in the order in which they were created.

lhzMaxItems :: Lens' ListHostedZones (Maybe Text)

(Optional) The maximum number of hosted zones to be included in the response body for this request. If you have more than maxitems hosted zones, the value of the IsTruncated element in the response is true, and the value of the NextMarker element is the hosted zone ID of the first hosted zone in the next group of maxitems hosted zones.

Destructuring the Response

listHostedZonesResponse

Arguments

:: Int

lhzrsResponseStatus

-> Bool

lhzrsIsTruncated

-> Text

lhzrsMaxItems

-> ListHostedZonesResponse

Creates a value of ListHostedZonesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lhzrsMarker
• lhzrsNextMarker
• lhzrsResponseStatus
• lhzrsHostedZones
• lhzrsIsTruncated
• lhzrsMaxItems

data ListHostedZonesResponse

See: listHostedZonesResponse smart constructor.

Instances

Eq ListHostedZonesResponse

Methods

(==) :: ListHostedZonesResponse -> ListHostedZonesResponse -> Bool

(/=) :: ListHostedZonesResponse -> ListHostedZonesResponse -> Bool

Data ListHostedZonesResponse

Methods

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

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

toConstr :: ListHostedZonesResponse -> Constr

dataTypeOf :: ListHostedZonesResponse -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> ListHostedZonesResponse -> ListHostedZonesResponse

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

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

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

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

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

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

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

Read ListHostedZonesResponse

Methods

readsPrec :: Int -> ReadS ListHostedZonesResponse

readList :: ReadS [ListHostedZonesResponse]

readPrec :: ReadPrec ListHostedZonesResponse

readListPrec :: ReadPrec [ListHostedZonesResponse]

Show ListHostedZonesResponse

Methods

showsPrec :: Int -> ListHostedZonesResponse -> ShowS

show :: ListHostedZonesResponse -> String

showList :: [ListHostedZonesResponse] -> ShowS

Generic ListHostedZonesResponse

Associated Types

type Rep ListHostedZonesResponse :: * -> *

Methods

from :: ListHostedZonesResponse -> Rep ListHostedZonesResponse x

to :: Rep ListHostedZonesResponse x -> ListHostedZonesResponse

NFData ListHostedZonesResponse

Methods

rnf :: ListHostedZonesResponse -> ()

type Rep ListHostedZonesResponse

type Rep ListHostedZonesResponse = D1 (MetaData "ListHostedZonesResponse" "Network.AWS.Route53.ListHostedZones" "amazonka-route53-1.4.4-KBIXDpJOcpkWbDD9G5tXJ" False) (C1 (MetaCons "ListHostedZonesResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_lhzrsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_lhzrsNextMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_lhzrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))) ((:*:) (S1 (MetaSel (Just Symbol "_lhzrsHostedZones") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [HostedZone])) ((:*:) (S1 (MetaSel (Just Symbol "_lhzrsIsTruncated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)) (S1 (MetaSel (Just Symbol "_lhzrsMaxItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

Response Lenses

lhzrsMarker :: Lens' ListHostedZonesResponse (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.

lhzrsNextMarker :: Lens' ListHostedZonesResponse (Maybe Text)

If IsTruncated is true, the value of NextMarker identifies the first hosted zone in the next group of maxitems hosted zones. Call ListHostedZones again and specify the value of NextMarker in the marker parameter.

This element is present only if IsTruncated is true.

lhzrsResponseStatus :: Lens' ListHostedZonesResponse Int

The response status code.

lhzrsHostedZones :: Lens' ListHostedZonesResponse [HostedZone]

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

lhzrsIsTruncated :: Lens' ListHostedZonesResponse Bool

A flag indicating whether there are more hosted zones to be listed. If the response was truncated, you can get the next group of maxitems hosted zones by calling ListHostedZones again and specifying the value of the NextMarker element in the marker parameter.

lhzrsMaxItems :: Lens' ListHostedZonesResponse Text

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