AWS API Changes

2015/05/07 - Amazon Route 53 - 30 new api methods

DeleteReusableDelegationSet (new)

Link ¶

This action deletes a reusable delegation set. To delete a reusable delegation set, send a DELETE request to the 2013-04-01/delegationset/delegation set ID resource.

Request Syntax

client.delete_reusable_delegation_set(
    Id='string'
)

type Id:

string

param Id:

[REQUIRED]

The ID of the reusable delegation set you want to delete.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

Empty response for the request.

GetHealthCheckStatus (new)

Link ¶

To retrieve the health check status, send a GET request to the 2013-04-01/healthcheck/health check ID/status resource. You can use this call to get a health check's current status.

Request Syntax

client.get_health_check_status(
    HealthCheckId='string'
)

type HealthCheckId:

string

param HealthCheckId:

[REQUIRED]

The ID of the health check for which you want to retrieve the most recent status.

rtype:

dict

returns:

Response Syntax

{
    'HealthCheckObservations': [
        {
            'IPAddress': 'string',
            'StatusReport': {
                'Status': 'string',
                'CheckedTime': datetime(2015, 1, 1)
            }
        },
    ]
}

Response Structure

(dict) --

A complex type that contains information about the status of the specified health check.
- HealthCheckObservations (list) --
  
  A list that contains one HealthCheckObservation element for each Route 53 health checker.
  - (dict) --
    
    A complex type that contains the IP address of a Route 53 health checker and the reason for the health check status.
    - IPAddress (string) --
      
      The IP address of the Route 53 health checker that performed the health check.
    - StatusReport (dict) --
      
      A complex type that contains information about the health check status for the current observation.
      - Status (string) --
        
        The observed health check status.
      - CheckedTime (datetime) --
        
        The date and time the health check status was observed, in the format YYYY-MM-DDThh:mm:ssZ, as specified in the ISO 8601 standard (for example, 2009-11-19T19:37:58Z). The Z after the time indicates that the time is listed in Coordinated Universal Time (UTC), which is synonymous with Greenwich Mean Time in this context.

GetHostedZone (new)

Link ¶

To retrieve the delegation set for a hosted zone, send a GET request to the 2013-04-01/hostedzone/hosted zone ID resource. The delegation set is the four Route 53 name servers that were assigned to the hosted zone when you created it.

Request Syntax

client.get_hosted_zone(
    Id='string'
)

type Id:

string

param Id:

[REQUIRED]

The ID of the hosted zone for which you want to get a list of the name servers in the delegation set.

rtype:

dict

returns:

Response Syntax

{
    'HostedZone': {
        'Id': 'string',
        'Name': 'string',
        'CallerReference': 'string',
        'Config': {
            'Comment': 'string',
            'PrivateZone': True|False
        },
        'ResourceRecordSetCount': 123
    },
    'DelegationSet': {
        'Id': 'string',
        'CallerReference': 'string',
        'NameServers': [
            'string',
        ]
    },
    'VPCs': [
        {
            'VPCRegion': 'us-east-1'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-central-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'sa-east-1'|'cn-north-1',
            'VPCId': 'string'
        },
    ]
}

Response Structure

(dict) --

A complex type containing information about the specified hosted zone.
- HostedZone (dict) --
  
  A complex type that contains the information about the specified hosted zone.
  - Id (string) --
    
    The ID of the specified hosted zone.
  - Name (string) --
    
    The name of the domain. This must be a fully-specified domain, for example, www.example.com. The trailing dot is optional; 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.
    
    This is the name you have registered with your DNS registrar. You should ask your registrar to change the authoritative name servers for your domain to the set of NameServers elements returned in DelegationSet.
  - CallerReference (string) --
    
    A unique string that identifies the request to create the hosted zone.
  - Config (dict) --
    
    A complex type that contains the Comment element.
    - Comment (string) --
      
      An optional comment about your hosted zone. If you don't want to specify a comment, you can omit the HostedZoneConfig and Comment elements from the XML document.
    - PrivateZone (boolean) --
      
      A value that indicates whether this is a private hosted zone. The value is returned in the response; do not specify it in the request.
  - ResourceRecordSetCount (integer) --
    
    Total number of resource record sets in the hosted zone.
- DelegationSet (dict) --
  
  A complex type that contains information about the name servers for the specified hosted zone.
  - Id (string) --
  - CallerReference (string) --
  - NameServers (list) --
    
    A complex type that contains the authoritative name servers for the hosted zone. Use the method provided by your domain registrar to add an NS record to your domain for each NameServer that is assigned to your hosted zone.
    - (string) --
- VPCs (list) --
  
  A complex type that contains information about VPCs associated with the specified hosted zone.
  - (dict) --
    - VPCRegion (string) --
    - VPCId (string) --
      
      A VPC ID

ListHostedZonesByName (new)

Link ¶

To retrieve a list of your hosted zones in lexicographic order, send a GET request to the 2013-04-01/hostedzonesbyname resource. The response to this request includes a HostedZones element with zero or more HostedZone child elements lexicographically ordered by DNS name. By default, the list of hosted zones is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. You can use the DNSName and HostedZoneId parameters to control the hosted zone that the list begins with.

Request Syntax

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

type DNSName:

string

param DNSName:

The first name in the lexicographic ordering of domain names that you want the ListHostedZonesByNameRequest request to list.

If the request returned more than one page of results, submit another request and specify the value of NextDNSName and NextHostedZoneId from the last response in the DNSName and HostedZoneId parameters to get the next page of results.

type HostedZoneId:

string

param HostedZoneId:

type MaxItems:

string

param MaxItems:

Specify the maximum number of hosted zones to return per page of results.

rtype:

dict

returns:

Response Syntax

{
    'HostedZones': [
        {
            'Id': 'string',
            'Name': 'string',
            'CallerReference': 'string',
            'Config': {
                'Comment': 'string',
                'PrivateZone': True|False
            },
            'ResourceRecordSetCount': 123
        },
    ],
    'DNSName': 'string',
    'HostedZoneId': 'string',
    'IsTruncated': True|False,
    'NextDNSName': 'string',
    'NextHostedZoneId': 'string',
    'MaxItems': 'string'
}

Response Structure

(dict) --

A complex type that contains the response for the request.
- HostedZones (list) --
  
  A complex type that contains information about the hosted zones associated with the current AWS account.
  - (dict) --
    
    A complex type that contain information about the specified hosted zone.
    - Id (string) --
      
      The ID of the specified hosted zone.
    - Name (string) --
      
      The name of the domain. This must be a fully-specified domain, for example, www.example.com. The trailing dot is optional; 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.
      
      This is the name you have registered with your DNS registrar. You should ask your registrar to change the authoritative name servers for your domain to the set of NameServers elements returned in DelegationSet.
    - CallerReference (string) --
      
      A unique string that identifies the request to create the hosted zone.
    - Config (dict) --
      
      A complex type that contains the Comment element.
      - Comment (string) --
        
        An optional comment about your hosted zone. If you don't want to specify a comment, you can omit the HostedZoneConfig and Comment elements from the XML document.
      - PrivateZone (boolean) --
        
        A value that indicates whether this is a private hosted zone. The value is returned in the response; do not specify it in the request.
    - ResourceRecordSetCount (integer) --
      
      Total number of resource record sets in the hosted zone.
- DNSName (string) --
  
  The DNSName value sent in the request.
- HostedZoneId (string) --
  
  The HostedZoneId value sent in the request.
- IsTruncated (boolean) --
  
  A flag indicating whether there are more hosted zones to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the NextDNSName and NextHostedZoneId elements.
  
  Valid Values: true | false
- NextDNSName (string) --
  
  If ListHostedZonesByNameResponse$IsTruncated is true, there are more hosted zones associated with the current AWS account. To get the next page of results, make another request to ListHostedZonesByName. Specify the value of ListHostedZonesByNameResponse$NextDNSName in the ListHostedZonesByNameRequest$DNSName element and ListHostedZonesByNameResponse$NextHostedZoneId in the ListHostedZonesByNameRequest$HostedZoneId element.
- NextHostedZoneId (string) --
  
  If ListHostedZonesByNameResponse$IsTruncated is true, there are more hosted zones associated with the current AWS account. To get the next page of results, make another request to ListHostedZonesByName. Specify the value of ListHostedZonesByNameResponse$NextDNSName in the ListHostedZonesByNameRequest$DNSName element and ListHostedZonesByNameResponse$NextHostedZoneId in the ListHostedZonesByNameRequest$HostedZoneId element.
- MaxItems (string) --
  
  The maximum number of hosted zones to be included in the response body. If the number of hosted zones associated with this AWS account exceeds MaxItems, the value of ListHostedZonesByNameResponse$IsTruncated in the response is true. Call ListHostedZonesByName again and specify the value of ListHostedZonesByNameResponse$NextDNSName and ListHostedZonesByNameResponse$NextHostedZoneId elements respectively to get the next page of results.

UpdateHealthCheck (new)

Link ¶

This action updates an existing health check.

To update a health check, send a POST request to the 2013-04-01/healthcheck/health check ID resource. The request body must include an XML document with an UpdateHealthCheckRequest element. The response returns an UpdateHealthCheckResponse element, which contains metadata about the health check.

Request Syntax

client.update_health_check(
    HealthCheckId='string',
    HealthCheckVersion=123,
    IPAddress='string',
    Port=123,
    ResourcePath='string',
    FullyQualifiedDomainName='string',
    SearchString='string',
    FailureThreshold=123
)

type HealthCheckId:

string

param HealthCheckId:

[REQUIRED]

The ID of the health check to update.

type HealthCheckVersion:

integer

param HealthCheckVersion:

Optional. When you specify a health check version, Route 53 compares this value with the current value in the health check, which prevents you from updating the health check when the versions don't match. Using HealthCheckVersion lets you prevent overwriting another change to the health check.

type IPAddress:

string

param IPAddress:

The IP address of the resource that you want to check.