Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
To retrieve a list of your hosted zones, send a GET
request to the
'2013-04-01\/hostedzone' resource. The response to this request includes
a HostedZones
element with zero, one, or multiple HostedZone
child
elements. By default, the list of hosted zones 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 hosted zone 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: AWS API Reference for ListHostedZones.
This operation returns paginated results.
- listHostedZones :: ListHostedZones
- data ListHostedZones
- lhzDelegationSetId :: Lens' ListHostedZones (Maybe Text)
- lhzMarker :: Lens' ListHostedZones (Maybe Text)
- lhzMaxItems :: Lens' ListHostedZones (Maybe Text)
- listHostedZonesResponse :: Int -> Bool -> Text -> ListHostedZonesResponse
- data ListHostedZonesResponse
- lhzrsMarker :: Lens' ListHostedZonesResponse (Maybe Text)
- lhzrsNextMarker :: Lens' ListHostedZonesResponse (Maybe Text)
- lhzrsResponseStatus :: Lens' ListHostedZonesResponse Int
- lhzrsHostedZones :: Lens' ListHostedZonesResponse [HostedZone]
- lhzrsIsTruncated :: Lens' ListHostedZonesResponse Bool
- lhzrsMaxItems :: Lens' ListHostedZonesResponse Text
Creating a Request
listHostedZones :: ListHostedZones Source
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:
data ListHostedZones Source
To retrieve a list of your hosted zones, send a GET
request to the
'2013-04-01\/hostedzone' resource. The response to this request includes
a HostedZones
element with zero or more HostedZone
child elements.
By default, the list of hosted zones 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
hosted zone that the list begins with. For more information about
listing hosted zones, see
Listing the Hosted Zones for an AWS Account
in the Amazon Route 53 Developer Guide.
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.
See: listHostedZones
smart constructor.
Request Lenses
lhzDelegationSetId :: Lens' ListHostedZones (Maybe Text) Source
Undocumented member.
lhzMarker :: Lens' ListHostedZones (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.
lhzMaxItems :: Lens' ListHostedZones (Maybe Text) Source
Specify the maximum number of hosted zones to return per page of results.
Destructuring the Response
listHostedZonesResponse Source
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:
data ListHostedZonesResponse Source
A complex type that contains the response for the request.
See: listHostedZonesResponse
smart constructor.
Response Lenses
lhzrsMarker :: Lens' ListHostedZonesResponse (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.
lhzrsNextMarker :: Lens' ListHostedZonesResponse (Maybe Text) Source
Indicates where to continue listing hosted zones. If
ListHostedZonesResponse$IsTruncated is true
, make another request to
ListHostedZones
and include the value of the NextMarker
element in
the Marker
element to get the next page of results.
lhzrsResponseStatus :: Lens' ListHostedZonesResponse Int Source
The response status code.
lhzrsHostedZones :: Lens' ListHostedZonesResponse [HostedZone] Source
A complex type that contains information about the hosted zones associated with the current AWS account.
lhzrsIsTruncated :: Lens' ListHostedZonesResponse Bool Source
A flag indicating whether there are more hosted zones 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
lhzrsMaxItems :: Lens' ListHostedZonesResponse Text Source
The maximum number of hosted zones to be included in the response body.
If the number of hosted zones associated with this AWS account exceeds
MaxItems
, the value of ListHostedZonesResponse$IsTruncated in the
response is true
. Call ListHostedZones
again and specify the value
of ListHostedZonesResponse$NextMarker in the
ListHostedZonesRequest$Marker element to get the next page of results.