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 in lexicographic order, send a
GET
request to the '2013-04-01\/hostedzonesbyname' resource. The
response to this request includes a HostedZones
element with zero or
more HostedZone
child elements lexicographically ordered by DNS name.
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 DNSName
and HostedZoneId
parameters 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 ListHostedZonesByName.
- listHostedZonesByName :: ListHostedZonesByName
- data ListHostedZonesByName
- lhzbnHostedZoneId :: Lens' ListHostedZonesByName (Maybe Text)
- lhzbnMaxItems :: Lens' ListHostedZonesByName (Maybe Text)
- lhzbnDNSName :: Lens' ListHostedZonesByName (Maybe Text)
- listHostedZonesByNameResponse :: Int -> Bool -> Text -> ListHostedZonesByNameResponse
- data ListHostedZonesByNameResponse
- lhzbnrsHostedZoneId :: Lens' ListHostedZonesByNameResponse (Maybe Text)
- lhzbnrsNextHostedZoneId :: Lens' ListHostedZonesByNameResponse (Maybe Text)
- lhzbnrsDNSName :: Lens' ListHostedZonesByNameResponse (Maybe Text)
- lhzbnrsNextDNSName :: Lens' ListHostedZonesByNameResponse (Maybe Text)
- lhzbnrsResponseStatus :: Lens' ListHostedZonesByNameResponse Int
- lhzbnrsHostedZones :: Lens' ListHostedZonesByNameResponse [HostedZone]
- lhzbnrsIsTruncated :: Lens' ListHostedZonesByNameResponse Bool
- lhzbnrsMaxItems :: Lens' ListHostedZonesByNameResponse Text
Creating a Request
listHostedZonesByName :: ListHostedZonesByName Source
Creates a value of ListHostedZonesByName
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ListHostedZonesByName Source
To retrieve a list of your hosted zones in lexicographic order, send a
GET
request to the '2013-04-01\/hostedzonesbyname' resource. The
response to this request includes a HostedZones
element with zero or
more HostedZone
child elements lexicographically ordered by DNS name.
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 DNSName
and HostedZoneId
parameters 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.
See: listHostedZonesByName
smart constructor.
Request Lenses
lhzbnHostedZoneId :: Lens' ListHostedZonesByName (Maybe Text) Source
If the request returned more than one page of results, submit another
request and specify the value of NextDNSName
and NextHostedZoneId
from the last response in the DNSName
and HostedZoneId
parameters to
get the next page of results.
lhzbnMaxItems :: Lens' ListHostedZonesByName (Maybe Text) Source
Specify the maximum number of hosted zones to return per page of results.
lhzbnDNSName :: Lens' ListHostedZonesByName (Maybe Text) Source
The first name in the lexicographic ordering of domain names that you
want the ListHostedZonesByNameRequest
request to list.
If the request returned more than one page of results, submit another
request and specify the value of NextDNSName
and NextHostedZoneId
from the last response in the DNSName
and HostedZoneId
parameters to
get the next page of results.
Destructuring the Response
listHostedZonesByNameResponse Source
:: Int | |
-> Bool | |
-> Text | |
-> ListHostedZonesByNameResponse |
Creates a value of ListHostedZonesByNameResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ListHostedZonesByNameResponse Source
A complex type that contains the response for the request.
See: listHostedZonesByNameResponse
smart constructor.
Response Lenses
lhzbnrsHostedZoneId :: Lens' ListHostedZonesByNameResponse (Maybe Text) Source
The HostedZoneId
value sent in the request.
lhzbnrsNextHostedZoneId :: Lens' ListHostedZonesByNameResponse (Maybe Text) Source
If ListHostedZonesByNameResponse$IsTruncated is true
, there are more
hosted zones associated with the current AWS account. To get the next
page of results, make another request to ListHostedZonesByName
.
Specify the value of ListHostedZonesByNameResponse$NextDNSName in the
ListHostedZonesByNameRequest$DNSName element and
ListHostedZonesByNameResponse$NextHostedZoneId in the
ListHostedZonesByNameRequest$HostedZoneId element.
lhzbnrsDNSName :: Lens' ListHostedZonesByNameResponse (Maybe Text) Source
The DNSName
value sent in the request.
lhzbnrsNextDNSName :: Lens' ListHostedZonesByNameResponse (Maybe Text) Source
If ListHostedZonesByNameResponse$IsTruncated is true
, there are more
hosted zones associated with the current AWS account. To get the next
page of results, make another request to ListHostedZonesByName
.
Specify the value of ListHostedZonesByNameResponse$NextDNSName in the
ListHostedZonesByNameRequest$DNSName element and
ListHostedZonesByNameResponse$NextHostedZoneId in the
ListHostedZonesByNameRequest$HostedZoneId element.
lhzbnrsResponseStatus :: Lens' ListHostedZonesByNameResponse Int Source
The response status code.
lhzbnrsHostedZones :: Lens' ListHostedZonesByNameResponse [HostedZone] Source
A complex type that contains information about the hosted zones associated with the current AWS account.
lhzbnrsIsTruncated :: Lens' ListHostedZonesByNameResponse 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 NextDNSName
and NextHostedZoneId
elements.
Valid Values: true
| false
lhzbnrsMaxItems :: Lens' ListHostedZonesByNameResponse 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 ListHostedZonesByNameResponse$IsTruncated in
the response is true
. Call ListHostedZonesByName
again and specify
the value of ListHostedZonesByNameResponse$NextDNSName and
ListHostedZonesByNameResponse$NextHostedZoneId elements respectively to
get the next page of results.