Amazon Route 53

2025/11/25 - Amazon Route 53 - 1 new 5 updated api methods

Changes  Adds support for new route53 feature: accelerated recovery.

UpdateHostedZoneFeatures (new) Link ¶

Updates the features configuration for a hosted zone. This operation allows you to enable or disable specific features for your hosted zone, such as accelerated recovery.

Accelerated recovery enables you to update DNS records in your public hosted zone even when the us-east-1 region is unavailable.

See also: AWS API Documentation

Request Syntax

client.update_hosted_zone_features(
    HostedZoneId='string',
    EnableAcceleratedRecovery=True|False
)
type HostedZoneId:

string

param HostedZoneId:

[REQUIRED]

The ID of the hosted zone for which you want to update features. This is the unique identifier for your hosted zone.

type EnableAcceleratedRecovery:

boolean

param EnableAcceleratedRecovery:

Specifies whether to enable accelerated recovery for the hosted zone. Set to true to enable accelerated recovery, or false to disable it.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

CreateHostedZone (updated) Link ¶
Changes (response)
{'HostedZone': {'Features': {'AcceleratedRecoveryStatus': 'ENABLING | '
                                                          'ENABLE_FAILED | '
                                                          'ENABLING_HOSTED_ZONE_LOCKED '
                                                          '| ENABLED | '
                                                          'DISABLING | '
                                                          'DISABLE_FAILED | '
                                                          'DISABLED | '
                                                          'DISABLING_HOSTED_ZONE_LOCKED',
                             'FailureReasons': {'AcceleratedRecovery': 'string'}}}}

Creates a new public or private hosted zone. You create records in a public hosted zone to define how you want to route traffic on the internet for a domain, such as example.com, and its subdomains (apex.example.com, acme.example.com). You create records in a private hosted zone to define how you want to route traffic for a domain and its subdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs).

For more information about charges for hosted zones, see Amazon Route 53 Pricing.

Note the following:

  • You can't create a hosted zone for a top-level domain (TLD) such as .com.

  • For public hosted zones, Route 53 automatically creates a default SOA record and four NS records for the zone. For more information about SOA and NS records, see NS and SOA Records that Route 53 Creates for a Hosted Zone in the Amazon Route 53 Developer Guide. If you want to use the same name servers for multiple public hosted zones, you can optionally associate a reusable delegation set with the hosted zone. See the DelegationSetId element.

  • If your domain is registered with a registrar other than Route 53, you must update the name servers with your registrar to make Route 53 the DNS service for the domain. For more information, see Migrating DNS Service for an Existing Domain to Amazon Route 53 in the Amazon Route 53 Developer Guide.

When you submit a CreateHostedZone request, the initial status of the hosted zone is PENDING. For public hosted zones, this means that the NS and SOA records are not yet available on all Route 53 DNS servers. When the NS and SOA records are available, the status of the zone changes to INSYNC.

The CreateHostedZone request requires the caller to have an ec2:DescribeVpcs permission.

See also: AWS API Documentation

Request Syntax

client.create_hosted_zone(
    Name='string',
    VPC={
        'VPCRegion': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'eu-central-2'|'ap-east-1'|'me-south-1'|'us-gov-west-1'|'us-gov-east-1'|'us-iso-east-1'|'us-iso-west-1'|'us-isob-east-1'|'me-central-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-southeast-3'|'ap-south-1'|'ap-south-2'|'ap-northeast-1'|'ap-northeast-2'|'ap-northeast-3'|'eu-north-1'|'sa-east-1'|'ca-central-1'|'cn-north-1'|'cn-northwest-1'|'af-south-1'|'eu-south-1'|'eu-south-2'|'ap-southeast-4'|'il-central-1'|'ca-west-1'|'ap-southeast-5'|'mx-central-1'|'us-isof-south-1'|'us-isof-east-1'|'ap-southeast-7'|'ap-east-2'|'eu-isoe-west-1'|'ap-southeast-6'|'us-isob-west-1',
        'VPCId': 'string'
    },
    CallerReference='string',
    HostedZoneConfig={
        'Comment': 'string',
        'PrivateZone': True|False
    },
    DelegationSetId='string'
)
type Name:

string

param Name:

[REQUIRED]

The name of the domain. Specify a fully qualified domain name, for example, www.example.com. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.

If you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Route 53, change the name servers for your domain to the set of NameServers that CreateHostedZone returns in DelegationSet.

type VPC:

dict

param VPC:

(Private hosted zones only) A complex type that contains information about the Amazon VPC that you're associating with this hosted zone.

You can specify only one Amazon VPC when you create a private hosted zone. If you are associating a VPC with a hosted zone with this request, the paramaters VPCId and VPCRegion are also required.

To associate additional Amazon VPCs with the hosted zone, use AssociateVPCWithHostedZone after you create a hosted zone.

  • VPCRegion (string) --

    (Private hosted zones only) The region that an Amazon VPC was created in.

  • VPCId (string) --

    (Private hosted zones only) The ID of an Amazon VPC.

type CallerReference:

string

param CallerReference:

[REQUIRED]

A unique string that identifies the request and that allows failed CreateHostedZone requests to be retried without the risk of executing the operation twice. You must use a unique CallerReference string every time you submit a CreateHostedZone request. CallerReference can be any unique string, for example, a date/time stamp.

type HostedZoneConfig:

dict

param HostedZoneConfig:

(Optional) A complex type that contains the following optional values:

  • For public and private hosted zones, an optional comment

  • For private hosted zones, an optional PrivateZone element

If you don't specify a comment or the PrivateZone element, omit HostedZoneConfig and the other elements.

  • 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.

type DelegationSetId:

string

param DelegationSetId:

If you want to associate a reusable delegation set with this hosted zone, the ID that Amazon Route 53 assigned to the reusable delegation set when you created it. For more information about reusable delegation sets, see CreateReusableDelegationSet.

If you are using a reusable delegation set to create a public hosted zone for a subdomain, make sure that the parent hosted zone doesn't use one or more of the same name servers. If you have overlapping nameservers, the operation will cause a ConflictingDomainsExist error.

rtype:

dict

returns:

Response Syntax

{
    'HostedZone': {
        'Id': 'string',
        'Name': 'string',
        'CallerReference': 'string',
        'Config': {
            'Comment': 'string',
            'PrivateZone': True|False
        },
        'ResourceRecordSetCount': 123,
        'LinkedService': {
            'ServicePrincipal': 'string',
            'Description': 'string'
        },
        'Features': {
            'AcceleratedRecoveryStatus': 'ENABLING'|'ENABLE_FAILED'|'ENABLING_HOSTED_ZONE_LOCKED'|'ENABLED'|'DISABLING'|'DISABLE_FAILED'|'DISABLED'|'DISABLING_HOSTED_ZONE_LOCKED',
            'FailureReasons': {
                'AcceleratedRecovery': 'string'
            }
        }
    },
    'ChangeInfo': {
        'Id': 'string',
        'Status': 'PENDING'|'INSYNC',
        'SubmittedAt': datetime(2015, 1, 1),
        'Comment': 'string'
    },
    'DelegationSet': {
        'Id': 'string',
        'CallerReference': 'string',
        'NameServers': [
            'string',
        ]
    },
    'VPC': {
        'VPCRegion': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'eu-central-2'|'ap-east-1'|'me-south-1'|'us-gov-west-1'|'us-gov-east-1'|'us-iso-east-1'|'us-iso-west-1'|'us-isob-east-1'|'me-central-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-southeast-3'|'ap-south-1'|'ap-south-2'|'ap-northeast-1'|'ap-northeast-2'|'ap-northeast-3'|'eu-north-1'|'sa-east-1'|'ca-central-1'|'cn-north-1'|'cn-northwest-1'|'af-south-1'|'eu-south-1'|'eu-south-2'|'ap-southeast-4'|'il-central-1'|'ca-west-1'|'ap-southeast-5'|'mx-central-1'|'us-isof-south-1'|'us-isof-east-1'|'ap-southeast-7'|'ap-east-2'|'eu-isoe-west-1'|'ap-southeast-6'|'us-isob-west-1',
        'VPCId': 'string'
    },
    'Location': 'string'
}

Response Structure

  • (dict) --

    A complex type containing the response information for the hosted zone.

    • HostedZone (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.

      • Features (dict) --

        The features configuration for the hosted zone, including accelerated recovery settings and status information.

        • AcceleratedRecoveryStatus (string) --

          The current status of accelerated recovery for the hosted zone.

        • FailureReasons (dict) --

          Information about any failures that occurred when attempting to enable or configure features for the hosted zone.

          • AcceleratedRecovery (string) --

            The reason why accelerated recovery failed to be enabled or disabled for the hosted zone, if applicable.

    • ChangeInfo (dict) --

      A complex type that contains information about the CreateHostedZone request.

      • Id (string) --

        This element contains an ID that you use when performing a GetChange action to get detailed information about the change.

      • Status (string) --

        The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.

      • SubmittedAt (datetime) --

        The date and time that the change request was submitted in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z represents March 27, 2017 at 17:48:16.751 UTC.

      • Comment (string) --

        A comment you can provide.

    • DelegationSet (dict) --

      A complex type that describes the name servers for this hosted zone.

      • Id (string) --

        The ID that Amazon Route 53 assigns to a reusable delegation set.

      • CallerReference (string) --

        The value that you specified for CallerReference when you created the reusable delegation set.

      • NameServers (list) --

        A complex type that contains a list of the authoritative name servers for a hosted zone or for a reusable delegation set.

        • (string) --

    • VPC (dict) --

      A complex type that contains information about an Amazon VPC that you associated with this hosted zone.

      • VPCRegion (string) --

        (Private hosted zones only) The region that an Amazon VPC was created in.

      • VPCId (string) --

        (Private hosted zones only) The ID of an Amazon VPC.

    • Location (string) --

      The unique URL representing the new hosted zone.

GetHostedZone (updated) Link ¶
Changes (response)
{'HostedZone': {'Features': {'AcceleratedRecoveryStatus': 'ENABLING | '
                                                          'ENABLE_FAILED | '
                                                          'ENABLING_HOSTED_ZONE_LOCKED '
                                                          '| ENABLED | '
                                                          'DISABLING | '
                                                          'DISABLE_FAILED | '
                                                          'DISABLED | '
                                                          'DISABLING_HOSTED_ZONE_LOCKED',
                             'FailureReasons': {'AcceleratedRecovery': 'string'}}}}

Gets information about a specified hosted zone including the four name servers assigned to the hosted zone.

returns the VPCs associated with the specified hosted zone and does not reflect the VPC associations by Route 53 Profiles. To get the associations to a Profile, call the ListProfileAssociations API.

See also: AWS API Documentation

Request Syntax

client.get_hosted_zone(
    Id='string'
)
type Id:

string

param Id:

[REQUIRED]

The ID of the hosted zone that you want to get information about.

rtype:

dict

returns:

Response Syntax

{
    'HostedZone': {
        'Id': 'string',
        'Name': 'string',
        'CallerReference': 'string',
        'Config': {
            'Comment': 'string',
            'PrivateZone': True|False
        },
        'ResourceRecordSetCount': 123,
        'LinkedService': {
            'ServicePrincipal': 'string',
            'Description': 'string'
        },
        'Features': {
            'AcceleratedRecoveryStatus': 'ENABLING'|'ENABLE_FAILED'|'ENABLING_HOSTED_ZONE_LOCKED'|'ENABLED'|'DISABLING'|'DISABLE_FAILED'|'DISABLED'|'DISABLING_HOSTED_ZONE_LOCKED',
            'FailureReasons': {
                'AcceleratedRecovery': 'string'
            }
        }
    },
    'DelegationSet': {
        'Id': 'string',
        'CallerReference': 'string',
        'NameServers': [
            'string',
        ]
    },
    'VPCs': [
        {
            'VPCRegion': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'eu-central-2'|'ap-east-1'|'me-south-1'|'us-gov-west-1'|'us-gov-east-1'|'us-iso-east-1'|'us-iso-west-1'|'us-isob-east-1'|'me-central-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-southeast-3'|'ap-south-1'|'ap-south-2'|'ap-northeast-1'|'ap-northeast-2'|'ap-northeast-3'|'eu-north-1'|'sa-east-1'|'ca-central-1'|'cn-north-1'|'cn-northwest-1'|'af-south-1'|'eu-south-1'|'eu-south-2'|'ap-southeast-4'|'il-central-1'|'ca-west-1'|'ap-southeast-5'|'mx-central-1'|'us-isof-south-1'|'us-isof-east-1'|'ap-southeast-7'|'ap-east-2'|'eu-isoe-west-1'|'ap-southeast-6'|'us-isob-west-1',
            'VPCId': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    A complex type that contain the response to a GetHostedZone request.

    • HostedZone (dict) --

      A complex type that contains general information about the specified 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.

      • Features (dict) --

        The features configuration for the hosted zone, including accelerated recovery settings and status information.

        • AcceleratedRecoveryStatus (string) --

          The current status of accelerated recovery for the hosted zone.

        • FailureReasons (dict) --

          Information about any failures that occurred when attempting to enable or configure features for the hosted zone.

          • AcceleratedRecovery (string) --

            The reason why accelerated recovery failed to be enabled or disabled for the hosted zone, if applicable.

    • DelegationSet (dict) --

      A complex type that lists the Amazon Route 53 name servers for the specified hosted zone.

      • Id (string) --

        The ID that Amazon Route 53 assigns to a reusable delegation set.

      • CallerReference (string) --

        The value that you specified for CallerReference when you created the reusable delegation set.

      • NameServers (list) --

        A complex type that contains a list of the authoritative name servers for a hosted zone or for a reusable delegation set.

        • (string) --

    • VPCs (list) --

      A complex type that contains information about the VPCs that are associated with the specified hosted zone.

      • (dict) --

        (Private hosted zones only) A complex type that contains information about an Amazon VPC.

        If you associate a private hosted zone with an Amazon VPC when you make a CreateHostedZone request, the following parameters are also required.

        • VPCRegion (string) --

          (Private hosted zones only) The region that an Amazon VPC was created in.

        • VPCId (string) --

          (Private hosted zones only) The ID of an Amazon VPC.

ListHostedZones (updated) Link ¶
Changes (response)
{'HostedZones': {'Features': {'AcceleratedRecoveryStatus': 'ENABLING | '
                                                           'ENABLE_FAILED | '
                                                           'ENABLING_HOSTED_ZONE_LOCKED '
                                                           '| ENABLED | '
                                                           'DISABLING | '
                                                           'DISABLE_FAILED | '
                                                           'DISABLED | '
                                                           'DISABLING_HOSTED_ZONE_LOCKED',
                              'FailureReasons': {'AcceleratedRecovery': 'string'}}}}

Retrieves a list of the public and private hosted zones that are associated with the current Amazon Web Services account. The response includes a HostedZones child element for each hosted zone.

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.

See also: AWS API Documentation

Request Syntax

client.list_hosted_zones(
    Marker='string',
    MaxItems='string',
    DelegationSetId='string',
    HostedZoneType='PrivateHostedZone'
)
type Marker:

string

param Marker:

If the value of IsTruncated in the previous response was true, you have more hosted zones. To get more hosted zones, submit another ListHostedZones request.

For the value of marker, specify the value of NextMarker from the previous response, which is the ID of the first hosted zone that Amazon Route 53 will return if you submit another request.

If the value of IsTruncated in the previous response was false, there are no more hosted zones to get.

type MaxItems:

string

param MaxItems:

(Optional) The maximum number of hosted zones that you want Amazon Route 53 to return. If you have more than maxitems hosted zones, the value of IsTruncated in the response is true, and the value of NextMarker is the hosted zone ID of the first hosted zone that Route 53 will return if you submit another request.

type DelegationSetId:

string

param DelegationSetId:

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.

type HostedZoneType:

string

param HostedZoneType:

(Optional) Specifies if the hosted zone is private.

rtype:

dict

returns:

Response Syntax

{
    'HostedZones': [
        {
            'Id': 'string',
            'Name': 'string',
            'CallerReference': 'string',
            'Config': {
                'Comment': 'string',
                'PrivateZone': True|False
            },
            'ResourceRecordSetCount': 123,
            'LinkedService': {
                'ServicePrincipal': 'string',
                'Description': 'string'
            },
            'Features': {
                'AcceleratedRecoveryStatus': 'ENABLING'|'ENABLE_FAILED'|'ENABLING_HOSTED_ZONE_LOCKED'|'ENABLED'|'DISABLING'|'DISABLE_FAILED'|'DISABLED'|'DISABLING_HOSTED_ZONE_LOCKED',
                'FailureReasons': {
                    'AcceleratedRecovery': 'string'
                }
            }
        },
    ],
    'Marker': 'string',
    'IsTruncated': True|False,
    'NextMarker': 'string',
    'MaxItems': '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.

        • Features (dict) --

          The features configuration for the hosted zone, including accelerated recovery settings and status information.

          • AcceleratedRecoveryStatus (string) --

            The current status of accelerated recovery for the hosted zone.

          • FailureReasons (dict) --

            Information about any failures that occurred when attempting to enable or configure features for the hosted zone.

            • AcceleratedRecovery (string) --

              The reason why accelerated recovery failed to be enabled or disabled for the hosted zone, if applicable.

    • 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.

    • NextMarker (string) --

      If IsTruncated is true, the value of NextMarker identifies the first hosted zone in the next group of hosted zones. Submit another ListHostedZones request, and specify the value of NextMarker from the response in the marker parameter.

      This element is present only if IsTruncated is true.

    • MaxItems (string) --

      The value that you specified for the maxitems parameter in the call to ListHostedZones that produced the current response.

ListHostedZonesByName (updated) Link ¶
Changes (response)
{'HostedZones': {'Features': {'AcceleratedRecoveryStatus': 'ENABLING | '
                                                           'ENABLE_FAILED | '
                                                           'ENABLING_HOSTED_ZONE_LOCKED '
                                                           '| ENABLED | '
                                                           'DISABLING | '
                                                           'DISABLE_FAILED | '
                                                           'DISABLED | '
                                                           'DISABLING_HOSTED_ZONE_LOCKED',
                              'FailureReasons': {'AcceleratedRecovery': 'string'}}}}

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.

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 ex344mple.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:

  • The 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.

  • The 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.

  • 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. The NextDNSName element and NextHostedZoneId elements are omitted from the response.

  • The 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 Amazon Web Services 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.

See also: AWS API Documentation

Request Syntax

client.list_hosted_zones_by_name(
    DNSName='string',
    HostedZoneId='string',
    MaxItems='string'
)
type DNSName:

string

param DNSName:

(Optional) For your first request to 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 Amazon Web Services account, in ASCII order. For subsequent requests, include both dnsname and hostedzoneid parameters. For dnsname, specify the value of NextDNSName from the previous response.

type HostedZoneId:

string

param HostedZoneId:

(Optional) For your first request to 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.

type MaxItems:

string

param 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 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.

rtype:

dict

returns:

Response Syntax

{
    'HostedZones': [
        {
            'Id': 'string',
            'Name': 'string',
            'CallerReference': 'string',
            'Config': {
                'Comment': 'string',
                'PrivateZone': True|False
            },
            'ResourceRecordSetCount': 123,
            'LinkedService': {
                'ServicePrincipal': 'string',
                'Description': 'string'
            },
            'Features': {
                'AcceleratedRecoveryStatus': 'ENABLING'|'ENABLE_FAILED'|'ENABLING_HOSTED_ZONE_LOCKED'|'ENABLED'|'DISABLING'|'DISABLE_FAILED'|'DISABLED'|'DISABLING_HOSTED_ZONE_LOCKED',
                'FailureReasons': {
                    'AcceleratedRecovery': 'string'
                }
            }
        },
    ],
    'DNSName': 'string',
    'HostedZoneId': 'string',
    'IsTruncated': True|False,
    'NextDNSName': 'string',
    'NextHostedZoneId': 'string',
    'MaxItems': 'string'
}

Response Structure

  • (dict) --

    A complex type that contains the response information for the request.

    • 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.

        • Features (dict) --

          The features configuration for the hosted zone, including accelerated recovery settings and status information.

          • AcceleratedRecoveryStatus (string) --

            The current status of accelerated recovery for the hosted zone.

          • FailureReasons (dict) --

            Information about any failures that occurred when attempting to enable or configure features for the hosted zone.

            • AcceleratedRecovery (string) --

              The reason why accelerated recovery failed to be enabled or disabled for the hosted zone, if applicable.

    • DNSName (string) --

      For the second and subsequent calls to ListHostedZonesByName, DNSName is the value that you specified for the dnsname parameter in the request that produced the current response.

    • HostedZoneId (string) --

      The ID that Amazon Route 53 assigned to the hosted zone when you created it.

    • IsTruncated (boolean) --

      A flag that indicates 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 ListHostedZonesByName again and specifying the values of NextDNSName and NextHostedZoneId elements in the dnsname and hostedzoneid parameters.

    • NextDNSName (string) --

      If IsTruncated is true, the value of NextDNSName is the name of the first hosted zone in the next group of maxitems hosted zones. Call ListHostedZonesByName again and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.

      This element is present only if IsTruncated is true.

    • NextHostedZoneId (string) --

      If IsTruncated is true, the value of NextHostedZoneId identifies the first hosted zone in the next group of maxitems hosted zones. Call ListHostedZonesByName again and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.

      This element is present only if IsTruncated is true.

    • MaxItems (string) --

      The value that you specified for the maxitems parameter in the call to ListHostedZonesByName that produced the current response.

UpdateHostedZoneComment (updated) Link ¶
Changes (response)
{'HostedZone': {'Features': {'AcceleratedRecoveryStatus': 'ENABLING | '
                                                          'ENABLE_FAILED | '
                                                          'ENABLING_HOSTED_ZONE_LOCKED '
                                                          '| ENABLED | '
                                                          'DISABLING | '
                                                          'DISABLE_FAILED | '
                                                          'DISABLED | '
                                                          'DISABLING_HOSTED_ZONE_LOCKED',
                             'FailureReasons': {'AcceleratedRecovery': 'string'}}}}

Updates the comment for a specified hosted zone.

See also: AWS API Documentation

Request Syntax

client.update_hosted_zone_comment(
    Id='string',
    Comment='string'
)
type Id:

string

param Id:

[REQUIRED]

The ID for the hosted zone that you want to update the comment for.

type Comment:

string

param Comment:

The new comment for the hosted zone. If you don't specify a value for Comment, Amazon Route 53 deletes the existing value of the Comment element, if any.

rtype:

dict

returns:

Response Syntax

{
    'HostedZone': {
        'Id': 'string',
        'Name': 'string',
        'CallerReference': 'string',
        'Config': {
            'Comment': 'string',
            'PrivateZone': True|False
        },
        'ResourceRecordSetCount': 123,
        'LinkedService': {
            'ServicePrincipal': 'string',
            'Description': 'string'
        },
        'Features': {
            'AcceleratedRecoveryStatus': 'ENABLING'|'ENABLE_FAILED'|'ENABLING_HOSTED_ZONE_LOCKED'|'ENABLED'|'DISABLING'|'DISABLE_FAILED'|'DISABLED'|'DISABLING_HOSTED_ZONE_LOCKED',
            'FailureReasons': {
                'AcceleratedRecovery': 'string'
            }
        }
    }
}

Response Structure

  • (dict) --

    A complex type that contains the response to the UpdateHostedZoneComment request.

    • HostedZone (dict) --

      A complex type that contains the response to the UpdateHostedZoneComment request.

      • 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.

      • Features (dict) --

        The features configuration for the hosted zone, including accelerated recovery settings and status information.

        • AcceleratedRecoveryStatus (string) --

          The current status of accelerated recovery for the hosted zone.

        • FailureReasons (dict) --

          Information about any failures that occurred when attempting to enable or configure features for the hosted zone.

          • AcceleratedRecovery (string) --

            The reason why accelerated recovery failed to be enabled or disabled for the hosted zone, if applicable.