Copyright | (c) 2013-2016 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 public and private hosted zones, send a GET
request to the 2013-04-01hostedzone
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:
MaxItems
is the value specified for themaxitems
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. 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 toListHostedZones
, and specify the value of theNextMarker
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
, theMarker
element matches the value that you specified in themarker
parameter in the previous request.
This operation returns paginated results.
- listHostedZones :: ListHostedZones
- data ListHostedZones
- lhzDelegationSetId :: Lens' ListHostedZones (Maybe ResourceId)
- 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:
lhzDelegationSetId
- 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.lhzMarker
- (Optional) If you have more hosted zones than the value ofmaxitems
,ListHostedZones
returns only the firstmaxitems
hosted zones. To get the next group ofmaxitems
hosted zones, submit another request toListHostedZones
. For the value of marker, specify the value of theNextMarker
element that was returned in the previous response. Hosted zones are listed in the order in which they were created.lhzMaxItems
- (Optional) The maximum number of hosted zones to be included in the response body for this request. If you have more thanmaxitems
hosted zones, the value of theIsTruncated
element in the response istrue
, and the value of theNextMarker
element is the hosted zone ID of the first hosted zone in the next group ofmaxitems
hosted zones.
data ListHostedZones Source #
To retrieve a list of your public and private hosted zones, send a GET
request to the 2013-04-01hostedzone
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 themaxitems
parameter in the request that produced the current response.- If the value of
IsTruncated
in the response istrue
, 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 toListHostedZones
, and specify the value of theNextMarker
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
, theMarker
element matches the value that you specified in themarker
parameter in the previous request.
See: listHostedZones
smart constructor.
Request Lenses
lhzDelegationSetId :: 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.
lhzMarker :: Lens' ListHostedZones (Maybe Text) Source #
(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) Source #
(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 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:
lhzrsMarker
- For the second and subsequent calls toListHostedZones
,Marker
is the value that you specified for the marker parameter in the request that produced the current response.lhzrsNextMarker
- IfIsTruncated
istrue
, the value ofNextMarker
identifies the first hosted zone in the next group ofmaxitems
hosted zones. CallListHostedZones
again and specify the value ofNextMarker
in themarker
parameter. This element is present only ifIsTruncated
istrue
.lhzrsResponseStatus
- -- | The response status code.lhzrsHostedZones
- A complex type that contains general information about the hosted zone.lhzrsIsTruncated
- A flag indicating whether there are more hosted zones to be listed. If the response was truncated, you can get the next group ofmaxitems
hosted zones by callingListHostedZones
again and specifying the value of theNextMarker
element in the marker parameter.lhzrsMaxItems
- The value that you specified for themaxitems
parameter in the call toListHostedZones
that produced the current response.
data ListHostedZonesResponse Source #
See: listHostedZonesResponse
smart constructor.
Response Lenses
lhzrsMarker :: 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.
lhzrsNextMarker :: Lens' ListHostedZonesResponse (Maybe Text) Source #
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 Source #
- - | The response status code.
lhzrsHostedZones :: Lens' ListHostedZonesResponse [HostedZone] Source #
A complex type that contains general information about the hosted zone.
lhzrsIsTruncated :: Lens' ListHostedZonesResponse Bool Source #
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 Source #
The value that you specified for the maxitems
parameter in the call to ListHostedZones
that produced the current response.