AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Get-R53HostedZonesByName-HostedZoneId <String>-DNSName <String>-MaxItem <Int32>-Select <String>-NoAutoIteration <SwitchParameter>-ClientConfig <AmazonRoute53Config>
HostedZones
child element for each hosted zone created by the current AWS account.
ListHostedZonesByName
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, ListHostedZonesByName
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. ListHostedZonesByName
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: DNSName
and HostedZoneId
elements in the response contain the values, if any, specified for the dnsname
and hostedzoneid
parameters in the request that produced the current response. MaxItems
element in the response contains the value, if any, that you specified for the maxitems
parameter in the request that produced the current response. 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. The NextDNSName
element and NextHostedZoneId
elements are omitted from the response. NextDNSName
and NextHostedZoneId
elements in the response contain the domain name and 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 ListHostedZonesByName
, and specify the value of NextDNSName
and NextHostedZoneId
in the dnsname
and hostedzoneid
parameters, respectively. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
ListHostedZonesByName
, include the dnsname
parameter only if you want to specify the name of the first hosted zone in the response. If you don't include the dnsname
parameter, Amazon Route 53 returns all of the hosted zones that were created by the current AWS account, in ASCII order. For subsequent requests, include both dnsname
and hostedzoneid
parameters. For dnsname
, specify the value of NextDNSName
from the previous response.Required? | False |
Position? | Named |
Accept pipeline input? | False |
Aliases | NextToken |
ListHostedZonesByName
, do not include the hostedzoneid
parameter.If you have more hosted zones than the value of maxitems
, ListHostedZonesByName
returns only the first maxitems
hosted zones. To get the next group of maxitems
hosted zones, submit another request to ListHostedZonesByName
and include both dnsname
and hostedzoneid
parameters. For the value of hostedzoneid
, specify the value of the NextHostedZoneId
element from the previous response.Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
maxitems
hosted zones, then the value of the IsTruncated
element in the response is true, and the values of NextDNSName
and NextHostedZoneId
specify the first hosted zone in the next group of maxitems
hosted zones.Required? | False |
Position? | Named |
Accept pipeline input? | False |
Aliases | MaxItems |
Required? | False |
Position? | Named |
Accept pipeline input? | False |
Required? | False |
Position? | Named |
Accept pipeline input? | False |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AK |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AWSProfilesLocation, ProfilesLocation |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | StoredCredentials, AWSProfileName |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | RegionToCall |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SK, SecretAccessKey |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ST |
Get-R53HostedZonesByNameReturns all of your public and private hosted zones in ASCII order by domain name.
Get-R53HostedZonesByName -DnsName example2.comReturns your public and private hosted zones, in ASCII order by domain name, starting at the specified DNS name.
Get-R53HostedZonesByName -MaxItem 1
while ($LastServiceResponse.IsTruncated)
{
$nextPageParams = @{
DnsName=$LastServiceResponse.NextDNSName
HostedZoneId=$LastServiceResponse.NextHostedZoneId
}
Get-R53HostedZonesByName -MaxItem 2 @nextPageParams
}
This example shows how to manually enumerate the hosted zones by first retrieving a single item and then iterating two at a time until all zones have been returned, using marker properties attached to the service response in the $AWSHistory stack after each call.
AWS Tools for PowerShell: 2.x.y.z