
route53
*******


boto.route53.connection
=======================

class class boto.route53.connection.Route53Connection(aws_access_key_id=None, aws_secret_access_key=None, port=None, proxy=None, proxy_port=None, host='route53.amazonaws.com', debug=0, security_token=None, validate_certs=True)

   DefaultHost = 'route53.amazonaws.com'

      The default Route53 API endpoint to connect to.

   Version = '2012-02-29'

      Route53 API version.

   XMLNameSpace = 'https://route53.amazonaws.com/doc/2012-02-29/'

      XML schema for this Route53 API version.

   change_rrsets(hosted_zone_id, xml_body)

      Create or change the authoritative DNS information for this
      Hosted Zone. Returns a Python data structure with information
      about the set of changes, including the Change ID.

      Parameters:
         * **hosted_zone_id** (*str*) -- The unique identifier for the
           Hosted Zone

         * **xml_body** (*str*) -- The list of changes to be made,
           defined in the XML schema defined by the Route53 service.

   create_hosted_zone(domain_name, caller_ref=None, comment='')

      Create a new Hosted Zone.  Returns a Python data structure with
      information about the newly created Hosted Zone.

      Parameters:
         * **domain_name** (*str*) -- The name of the domain. This
           should be a fully-specified domain, and should end with a
           final period as the last label indication.  If you omit the
           final period, Amazon Route 53 assumes the domain is
           relative to the root. This is the name you have registered
           with your DNS registrar. It is also the name you will
           delegate from your registrar to the Amazon Route 53
           delegation servers returned in response to this request.A
           list of strings with the image IDs wanted.

         * **caller_ref** (*str*) -- A unique string that identifies
           the request and that allows failed CreateHostedZone
           requests to be retried without the risk of executing the
           operation twice.  If you don't provide a value for this,
           boto will generate a Type 4 UUID and use that.

         * **comment** (*str*) -- Any comments you want to include
           about the hosted       zone.

   create_zone(name)

      Create a new Hosted Zone.  Returns a Zone object for the newly
      created Hosted Zone.

      Parameters:
         **name** (*str*) -- The name of the domain. This should be a
         fully-specified domain, and should end with a final period as
         the last label indication.  If you omit the final period,
         Amazon Route 53 assumes the domain is relative to the root.
         This is the name you have registered with your DNS registrar.
         It is also the name you will delegate from your registrar to
         the Amazon Route 53 delegation servers returned in response
         to this request.

   delete_hosted_zone(hosted_zone_id)

   get_all_hosted_zones(start_marker=None, zone_list=None)

      Returns a Python data structure with information about all
      Hosted Zones defined for the AWS account.

      Parameters:
         * **start_marker** (*int*) -- start marker to pass when
           fetching additional results after a truncated list

         * **zone_list** (*list*) -- a HostedZones list to prepend to
           results

   get_all_rrsets(hosted_zone_id, type=None, name=None, identifier=None, maxitems=None)

      Retrieve the Resource Record Sets defined for this Hosted Zone.
      Returns the raw XML data returned by the Route53 call.

      Parameters:
         * **hosted_zone_id** (*str*) -- The unique identifier for the
           Hosted Zone

         * **type** (*str*) --

           The type of resource record set to begin the record listing
           from.  Valid choices are:

              * A

              * AAAA

              * CNAME

              * MX

              * NS

              * PTR

              * SOA

              * SPF

              * SRV

              * TXT

           Valid values for weighted resource record sets:

              * A

              * AAAA

              * CNAME

              * TXT

           Valid values for Zone Apex Aliases:

              * A

              * AAAA

         * **name** (*str*) -- The first name in the lexicographic
           ordering of domain names to be retrieved

         * **identifier** (*str*) -- In a hosted zone that includes
           weighted resource record sets (multiple resource record
           sets with the same DNS name and type that are
           differentiated only by SetIdentifier), if results were
           truncated for a given DNS name and type, the value of
           SetIdentifier for the next resource record set that has the
           current DNS name and type

         * **maxitems** (*int*) -- The maximum number of records

   get_change(change_id)

      Get information about a proposed set of changes, as submitted by
      the change_rrsets method. Returns a Python data structure with
      status information about the changes.

      Parameters:
         **change_id** (*str*) -- The unique identifier for the set of
         changes. This ID is returned in the response to the
         change_rrsets method.

   get_hosted_zone(hosted_zone_id)

      Get detailed information about a particular Hosted Zone.

      Parameters:
         **hosted_zone_id** (*str*) -- The unique identifier for the
         Hosted Zone

   get_hosted_zone_by_name(hosted_zone_name)

      Get detailed information about a particular Hosted Zone.

      Parameters:
         **hosted_zone_name** (*str*) -- The fully qualified domain
         name for the Hosted

      Zone

   get_zone(name)

      Returns a Zone object for the specified Hosted Zone.

      Parameters:
         **name** -- The name of the domain. This should be a fully-
         specified domain, and should end with a final period as the
         last label indication.

   get_zones()

      Returns a list of Zone objects, one for each of the Hosted Zones
      defined for the AWS account.

   make_request(action, path, headers=None, data='', params=None)


boto.route53.hostedzone
=======================

class class boto.route53.hostedzone.HostedZone(id=None, name=None, owner=None, version=None, caller_reference=None, config=None)

   endElement(name, value, connection)

   startElement(name, attrs, connection)


boto.route53.record
===================

class class boto.route53.record.Record(name=None, type=None, ttl=600, resource_records=None, alias_hosted_zone_id=None, alias_dns_name=None, identifier=None, weight=None, region=None)

   An individual ResourceRecordSet

   AliasBody = '<AliasTarget>\n        <HostedZoneId>%s</HostedZoneId>\n        <DNSName>%s</DNSName>\n    </AliasTarget>'

   RRRBody = '\n        <SetIdentifier>%(identifier)s</SetIdentifier>\n        <Region>%(region)s</Region>\n    '

   ResourceRecordBody = '<ResourceRecord>\n        <Value>%s</Value>\n    </ResourceRecord>'

   ResourceRecordsBody = '\n        <TTL>%(ttl)s</TTL>\n        <ResourceRecords>\n            %(records)s\n        </ResourceRecords>'

   WRRBody = '\n        <SetIdentifier>%(identifier)s</SetIdentifier>\n        <Weight>%(weight)s</Weight>\n    '

   XMLBody = '<ResourceRecordSet>\n        <Name>%(name)s</Name>\n        <Type>%(type)s</Type>\n        %(weight)s\n        %(body)s\n    </ResourceRecordSet>'

   add_value(value)

      Add a resource record value

   endElement(name, value, connection)

   set_alias(alias_hosted_zone_id, alias_dns_name)

      Make this an alias resource record set

   startElement(name, attrs, connection)

   to_print()

   to_xml()

      Spit this resource record set out as XML

class class boto.route53.record.ResourceRecordSets(connection=None, hosted_zone_id=None, comment=None)

   A list of resource records.

   Variables:
      * **hosted_zone_id** -- The ID of the hosted zone.

      * **comment** -- A comment that will be stored with the change.

      * **changes** -- A list of changes.

   ChangeResourceRecordSetsBody = '<?xml version="1.0" encoding="UTF-8"?>\n    <ChangeResourceRecordSetsRequest xmlns="https://route53.amazonaws.com/doc/2012-02-29/">\n            <ChangeBatch>\n                <Comment>%(comment)s</Comment>\n                <Changes>%(changes)s</Changes>\n            </ChangeBatch>\n        </ChangeResourceRecordSetsRequest>'

   ChangeXML = '<Change>\n        <Action>%(action)s</Action>\n        %(record)s\n    </Change>'

   add_change(action, name, type, ttl=600, alias_hosted_zone_id=None, alias_dns_name=None, identifier=None, weight=None, region=None)

      Add a change request to the set.

      Parameters:
         * **action** (*str*) -- The action to perform
           ('CREATE'|'DELETE')

         * **name** (*str*) -- The name of the domain you want to
           perform the action on.

         * **type** (*str*) --

           The DNS record type.  Valid values are:

           * A

           * AAAA

           * CNAME

           * MX

           * NS

           * PTR

           * SOA

           * SPF

           * SRV

           * TXT

         * **ttl** (*int*) -- The resource record cache time to live
           (TTL), in seconds.

         * **alias_dns_name** (*str*) -- *Alias resource record sets
           only* The value of the hosted zone ID,
           CanonicalHostedZoneNameId, for the LoadBalancer.

         * **alias_hosted_zone_id** (*str*) -- *Alias resource record
           sets only* Information about the domain to which you are
           redirecting traffic.

         * **identifier** (*str*) -- *Weighted and latency-based
           resource record sets only* An identifier that
           differentiates among multiple resource record sets that
           have the same combination of DNS name and type.

         * **weight** (*int*) -- *Weighted resource record sets only*
           Among resource record sets that have the same combination
           of DNS name and type, a value that determines what portion
           of traffic for the current resource record set is routed to
           the associated location

         * **region** (*str*) -- *Latency-based resource record sets
           only* Among resource record sets that have the same
           combination of DNS name and type, a value that determines
           which region this should be associated with for the
           latency-based routing

   add_change_record(action, change)

      Add an existing record to a change set with the specified action

   commit()

      Commit this change

   endElement(name, value, connection)

      Overwritten to also add the NextRecordName and NextRecordType to
      the base object

   to_xml()

      Convert this ResourceRecordSet into XML to be saved via the
      ChangeResourceRecordSetsRequest


boto.route53.exception
======================

exception exception boto.route53.exception.DNSServerError(status, reason, body=None, *args)
