ListHostedZones¶

class Route53.Paginator.ListHostedZones¶

paginator = client.get_paginator('list_hosted_zones')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from Route53.Client.list_hosted_zones().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    DelegationSetId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

DelegationSetId (string) -- 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.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'HostedZones': [
        {
            'Id': 'string',
            'Name': 'string',
            'CallerReference': 'string',
            'Config': {
                'Comment': 'string',
                'PrivateZone': True|False
            },
            'ResourceRecordSetCount': 123,
            'LinkedService': {
                'ServicePrincipal': 'string',
                'Description': 'string'
            }
        },
    ],
    'Marker': 'string',
    'IsTruncated': True|False,
    'MaxItems': 'string',
    'NextToken': 'string'
}

Response Structure

(dict) --
- HostedZones (list) --
  
  A complex type that contains general information about the hosted zone.
  - (dict) --
    
    A complex type that contains general information about the hosted zone.
    - Id (string) --
      
      The ID that Amazon Route 53 assigned to the hosted zone when you created it.
    - Name (string) --
      
      The name of the domain. For public hosted zones, this is the name that you have registered with your DNS registrar.
      
      For information about how to specify characters other than a-z , 0-9 , and - (hyphen) and how to specify internationalized domain names, see CreateHostedZone.
    - CallerReference (string) --
      
      The value that you specified for CallerReference when you created the hosted zone.
    - Config (dict) --
      
      A complex type that includes the Comment and PrivateZone elements. If you omitted the HostedZoneConfig and Comment elements from the request, the Config and Comment elements don't appear in the response.
      - Comment (string) --
        
        Any comments that you want to include about the hosted zone.
      - PrivateZone (boolean) --
        
        A value that indicates whether this is a private hosted zone.
    - ResourceRecordSetCount (integer) --
      
      The number of resource record sets in the hosted zone.
    - LinkedService (dict) --
      
      If the hosted zone was created by another service, the service that created the hosted zone. When a hosted zone is created by another service, you can't edit or delete it using Route 53.
      - ServicePrincipal (string) --
        
        If the health check or hosted zone was created by another service, the service that created the resource. When a resource is created by another service, you can't edit or delete it using Amazon Route 53.
      - Description (string) --
        
        If the health check or hosted zone was created by another service, an optional description that can be provided by the other service. When a resource is created by another service, you can't edit or delete it using Amazon Route 53.
- Marker (string) --
  
  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.
- IsTruncated (boolean) --
  
  A flag indicating whether there are more hosted zones to be listed. If the response was truncated, you can get more hosted zones by submitting another ListHostedZones request and specifying the value of NextMarker in the marker parameter.
- MaxItems (string) --
  
  The value that you specified for the maxitems parameter in the call to ListHostedZones that produced the current response.
- NextToken (string) --
  
  A token to resume pagination.

Table Of Contents

ListHostedZones¶