List Hosted Zones By Name
route53_list_hosted_zones_by_name | R Documentation |
Retrieves a list of your hosted zones in lexicographic order¶
Description¶
Retrieves a list of your hosted zones in lexicographic order. The
response includes a HostedZones
child element for each hosted zone
created by the current Amazon Web Services account.
list_hosted_zones_by_name
sorts hosted zones by name with the labels
reversed. For example:
com.example.www.
Note the trailing dot, which can change the sort order in some circumstances.
If the domain name includes escape characters or Punycode,
list_hosted_zones_by_name
alphabetizes the domain name using the
escaped or Punycoded value, which is the format that Amazon Route 53
saves in its database. For example, to create a hosted zone for
exämple.com, you specify ex\344mple.com for the domain name.
list_hosted_zones_by_name
alphabetizes it as:
com.ex\344mple.
The labels are reversed and alphabetized using the escaped value. For more information about valid domain name formats, including internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide.
Route 53 returns up to 100 items in each response. If you have a lot of
hosted zones, use the MaxItems
parameter to list them in groups of up
to 100. The response includes values that help navigate from one group
of MaxItems
hosted zones to the next:
-
The
DNSName
andHostedZoneId
elements in the response contain the values, if any, specified for thednsname
andhostedzoneid
parameters in the request that produced the current response. -
The
MaxItems
element in the response contains the value, if any, that you 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 Amazon Web Services account.If
IsTruncated
is false, this response includes the last hosted zone that is associated with the current account. TheNextDNSName
element andNextHostedZoneId
elements are omitted from the response. -
The
NextDNSName
andNextHostedZoneId
elements in the response contain the domain name and the hosted zone ID of the next hosted zone that is associated with the current Amazon Web Services account. If you want to list more hosted zones, make another call tolist_hosted_zones_by_name
, and specify the value ofNextDNSName
andNextHostedZoneId
in thednsname
andhostedzoneid
parameters, respectively.
Usage¶
Arguments¶
DNSName
(Optional) For your first request to
list_hosted_zones_by_name
, include thednsname
parameter only if you want to specify the name of the first hosted zone in the response. If you don't include thednsname
parameter, Amazon Route 53 returns all of the hosted zones that were created by the current Amazon Web Services account, in ASCII order. For subsequent requests, include bothdnsname
andhostedzoneid
parameters. Fordnsname
, specify the value ofNextDNSName
from the previous response.HostedZoneId
(Optional) For your first request to
list_hosted_zones_by_name
, do not include thehostedzoneid
parameter.If you have more hosted zones than the value of
maxitems
,list_hosted_zones_by_name
returns only the firstmaxitems
hosted zones. To get the next group ofmaxitems
hosted zones, submit another request tolist_hosted_zones_by_name
and include bothdnsname
andhostedzoneid
parameters. For the value ofhostedzoneid
, specify the value of theNextHostedZoneId
element from the previous response.MaxItems
The maximum number of hosted zones to be included in the response body for this request. If you have more than
maxitems
hosted zones, then the value of theIsTruncated
element in the response is true, and the values ofNextDNSName
andNextHostedZoneId
specify the first hosted zone in the next group ofmaxitems
hosted zones.
Value¶
A list with the following syntax:
list(
HostedZones = list(
list(
Id = "string",
Name = "string",
CallerReference = "string",
Config = list(
Comment = "string",
PrivateZone = TRUE|FALSE
),
ResourceRecordSetCount = 123,
LinkedService = list(
ServicePrincipal = "string",
Description = "string"
)
)
),
DNSName = "string",
HostedZoneId = "string",
IsTruncated = TRUE|FALSE,
NextDNSName = "string",
NextHostedZoneId = "string",
MaxItems = "string"
)