Note

You are viewing the documentation for an older version of boto (boto2).

Boto3, the next version of Boto, is now stable and recommended for general use. It can be used side-by-side with Boto in the same project, so it is easy to start using Boto3 in your existing projects as well as new projects. Going forward, API updates and all new feature work will be focused on Boto3.

For more information, see the documentation for boto3.

Route 53 Domains

boto.route53.domains

boto.route53.domains.connect_to_region(region_name, **kw_params)
boto.route53.domains.regions()

Get all available regions for the Amazon Route 53 Domains service. :rtype: list :return: A list of boto.regioninfo.RegionInfo

boto.route53.domains.layer1

class boto.route53.domains.layer1.Route53DomainsConnection(**kwargs)
APIVersion = '2014-05-15'
DefaultRegionEndpoint = 'route53domains.us-east-1.amazonaws.com'
DefaultRegionName = 'us-east-1'
ResponseError

alias of JSONResponseError

ServiceName = 'Route53Domains'
TargetPrefix = 'Route53Domains_v20140515'
check_domain_availability(domain_name, idn_lang_code=None)

This operation checks the availability of one domain name. You can access this API without authenticating. Note that if the availability status of a domain is pending, you must submit another request to determine the availability of the domain name.

Parameters:domain_name (string) – The name of a domain.

Type: String

Default: None

Constraints: The domain name can contain only the letters a through z,
the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

Required: Yes

Parameters:idn_lang_code (string) – Reserved for future use.
disable_domain_transfer_lock(domain_name)

This operation removes the transfer lock on the domain (specifically the clientTransferProhibited status) to allow domain transfers. We recommend you refrain from performing this action unless you intend to transfer the domain to a different registrar. Successful submission returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.

Parameters:domain_name (string) – The name of a domain.

Type: String

Default: None

Constraints: The domain name can contain only the letters a through z,
the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

Required: Yes

enable_domain_transfer_lock(domain_name)

This operation sets the transfer lock on the domain (specifically the clientTransferProhibited status) to prevent domain transfers. Successful submission returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.

Parameters:domain_name (string) – The name of a domain.

Type: String

Default: None

Constraints: The domain name can contain only the letters a through z,
the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

Required: Yes

get_domain_detail(domain_name)

This operation returns detailed information about the domain. The domain’s contact information is also returned as part of the output.

Parameters:domain_name (string) – The name of a domain.

Type: String

Default: None

Constraints: The domain name can contain only the letters a through z,
the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

Required: Yes

get_operation_detail(operation_id)

This operation returns the current status of an operation that is not completed.

Parameters:operation_id (string) – The identifier for the operation for which you want to get the status. Amazon Route 53 returned the identifier in the response to the original request.

Type: String

Default: None

Required: Yes

list_domains(marker=None, max_items=None)

This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.

Parameters:marker (string) – For an initial request for a list of domains, omit this element. If the number of domains that are associated with the current AWS account is greater than the value that you specified for MaxItems, you can use Marker to return additional domains. Get the value of NextPageMarker from the previous response, and submit another request that includes the value of NextPageMarker in the Marker element.

Type: String

Default: None

Constraints: The marker must match the value specified in the previous
request.

Required: No

Parameters:max_items (integer) – Number of domains to be returned.

Type: Integer

Default: 20

Constraints: A numeral between 1 and 100.

Required: No

list_operations(marker=None, max_items=None)

This operation returns the operation IDs of operations that are not yet complete.

Parameters:marker (string) – For an initial request for a list of operations, omit this element. If the number of operations that are not yet complete is greater than the value that you specified for MaxItems, you can use Marker to return additional operations. Get the value of NextPageMarker from the previous response, and submit another request that includes the value of NextPageMarker in the Marker element.

Type: String

Default: None

Required: No

Parameters:max_items (integer) – Number of domains to be returned.

Type: Integer

Default: 20

Constraints: A value between 1 and 100.

Required: No

make_request(action, body)
register_domain(domain_name, duration_in_years, admin_contact, registrant_contact, tech_contact, idn_lang_code=None, auto_renew=None, privacy_protect_admin_contact=None, privacy_protect_registrant_contact=None, privacy_protect_tech_contact=None)

This operation registers a domain. Domains are registered by the AWS registrar partner, Gandi. For some top-level domains (TLDs), this operation requires extra parameters.

When you register a domain, Amazon Route 53 does the following:

  • Creates a Amazon Route 53 hosted zone that has the same name as the domain. Amazon Route 53 assigns four name servers to your hosted zone and automatically updates your domain registration with the names of these name servers.
  • Enables autorenew, so your domain registration will renew automatically each year. We’ll notify you in advance of the renewal date so you can choose whether to renew the registration.
  • Optionally enables privacy protection, so WHOIS queries return contact information for our registrar partner, Gandi, instead of the information you entered for registrant, admin, and tech contacts.
  • If registration is successful, returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant is notified by email.
  • Charges your AWS account an amount based on the top-level domain. For more information, see `Amazon Route 53 Pricing`_.
Parameters:domain_name (string) – The name of a domain.

Type: String

Default: None

Constraints: The domain name can contain only the letters a through z,
the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

Required: Yes

Parameters:
  • idn_lang_code (string) – Reserved for future use.
  • duration_in_years (integer) – The number of years the domain will be registered. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain.

Type: Integer

Default: 1

Valid values: Integer from 1 to 10

Required: Yes

Parameters:auto_renew (boolean) – Indicates whether the domain will be automatically renewed ( True) or not ( False). Autorenewal only takes effect after the account is charged.

Type: Boolean

Valid values: True | False

Default: True

Required: No

Parameters:admin_contact (dict) – Provides detailed contact information.

Type: Complex

Children: FirstName, MiddleName, LastName, ContactType,
OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

Required: Yes

Parameters:registrant_contact (dict) – Provides detailed contact information.

Type: Complex

Children: FirstName, MiddleName, LastName, ContactType,
OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

Required: Yes

Parameters:tech_contact (dict) – Provides detailed contact information.

Type: Complex

Children: FirstName, MiddleName, LastName, ContactType,
OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

Required: Yes

Parameters:privacy_protect_admin_contact (boolean) – Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (“who is”) queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

Type: Boolean

Default: True

Valid values: True | False

Required: No

Parameters:privacy_protect_registrant_contact (boolean) – Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (“who is”) queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

Type: Boolean

Default: True

Valid values: True | False

Required: No

Parameters:privacy_protect_tech_contact (boolean) – Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (“who is”) queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

Type: Boolean

Default: True

Valid values: True | False

Required: No

retrieve_domain_auth_code(domain_name)

This operation returns the AuthCode for the domain. To transfer a domain to another registrar, you provide this value to the new registrar.

Parameters:domain_name (string) – The name of a domain.

Type: String

Default: None

Constraints: The domain name can contain only the letters a through z,
the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

Required: Yes

transfer_domain(domain_name, duration_in_years, nameservers, admin_contact, registrant_contact, tech_contact, idn_lang_code=None, auth_code=None, auto_renew=None, privacy_protect_admin_contact=None, privacy_protect_registrant_contact=None, privacy_protect_tech_contact=None)

This operation transfers a domain from another registrar to Amazon Route 53. Domains are registered by the AWS registrar, Gandi upon transfer.

To transfer a domain, you need to meet all the domain transfer criteria, including the following:

  • You must supply nameservers to transfer a domain.
  • You must disable the domain transfer lock (if any) before transferring the domain.
  • A minimum of 60 days must have elapsed since the domain’s registration or last transfer.

We recommend you use the Amazon Route 53 as the DNS service for your domain. You can create a hosted zone in Amazon Route 53 for your current domain before transferring your domain.

Note that upon transfer, the domain duration is extended for a year if not otherwise specified. Autorenew is enabled by default.

If the transfer is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.

Transferring domains charges your AWS account an amount based on the top-level domain. For more information, see `Amazon Route 53 Pricing`_.

Parameters:domain_name (string) – The name of a domain.

Type: String

Default: None

Constraints: The domain name can contain only the letters a through z,
the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

Required: Yes

Parameters:
  • idn_lang_code (string) – Reserved for future use.
  • duration_in_years (integer) – The number of years the domain will be registered. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain.

Type: Integer

Default: 1

Valid values: Integer from 1 to 10

Required: Yes

Parameters:nameservers (list) – Contains details for the host and glue IP addresses.

Type: Complex

Children: GlueIps, Name

Parameters:auth_code (string) – The authorization code for the domain. You get this value from the current registrar.

Type: String

Required: Yes

Parameters:auto_renew (boolean) – Indicates whether the domain will be automatically renewed (true) or not (false). Autorenewal only takes effect after the account is charged.

Type: Boolean

Valid values: True | False

Default: true

Required: No

Parameters:admin_contact (dict) – Provides detailed contact information.

Type: Complex

Children: FirstName, MiddleName, LastName, ContactType,
OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

Required: Yes

Parameters:registrant_contact (dict) – Provides detailed contact information.

Type: Complex

Children: FirstName, MiddleName, LastName, ContactType,
OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

Required: Yes

Parameters:tech_contact (dict) – Provides detailed contact information.

Type: Complex

Children: FirstName, MiddleName, LastName, ContactType,
OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

Required: Yes

Parameters:privacy_protect_admin_contact (boolean) – Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (“who is”) queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

Type: Boolean

Default: True

Valid values: True | False

Required: No

Parameters:privacy_protect_registrant_contact (boolean) – Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (“who is”) queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

Type: Boolean

Default: True

Valid values: True | False

Required: No

Parameters:privacy_protect_tech_contact (boolean) – Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (“who is”) queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

Type: Boolean

Default: True

Valid values: True | False

Required: No

update_domain_contact(domain_name, admin_contact=None, registrant_contact=None, tech_contact=None)

This operation updates the contact information for a particular domain. Information for at least one contact (registrant, administrator, or technical) must be supplied for update.

If the update is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.

Parameters:domain_name (string) – The name of a domain.

Type: String

Default: None

Constraints: The domain name can contain only the letters a through z,
the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

Required: Yes

Parameters:admin_contact (dict) – Provides detailed contact information.

Type: Complex

Children: FirstName, MiddleName, LastName, ContactType,
OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

Required: Yes

Parameters:registrant_contact (dict) – Provides detailed contact information.

Type: Complex

Children: FirstName, MiddleName, LastName, ContactType,
OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

Required: Yes

Parameters:tech_contact (dict) – Provides detailed contact information.

Type: Complex

Children: FirstName, MiddleName, LastName, ContactType,
OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

Required: Yes

update_domain_contact_privacy(domain_name, admin_privacy=None, registrant_privacy=None, tech_privacy=None)

This operation updates the specified domain contact’s privacy setting. When the privacy option is enabled, personal information such as postal or email address is hidden from the results of a public WHOIS query. The privacy services are provided by the AWS registrar, Gandi. For more information, see the `Gandi privacy features`_.

This operation only affects the privacy of the specified contact type (registrant, administrator, or tech). Successful acceptance returns an operation ID that you can use with GetOperationDetail to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.

Parameters:domain_name (string) – The name of a domain.

Type: String

Default: None

Constraints: The domain name can contain only the letters a through z,
the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

Required: Yes

Parameters:admin_privacy (boolean) – Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (“who is”) queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

Type: Boolean

Default: None

Valid values: True | False

Required: No

Parameters:registrant_privacy (boolean) – Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (“who is”) queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

Type: Boolean

Default: None

Valid values: True | False

Required: No

Parameters:tech_privacy (boolean) – Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (“who is”) queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

Type: Boolean

Default: None

Valid values: True | False

Required: No

update_domain_nameservers(domain_name, nameservers)

This operation replaces the current set of name servers for the domain with the specified set of name servers. If you use Amazon Route 53 as your DNS service, specify the four name servers in the delegation set for the hosted zone for the domain.

If successful, this operation returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.

Parameters:domain_name (string) – The name of a domain.

Type: String

Default: None

Constraints: The domain name can contain only the letters a through z,
the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

Required: Yes

Parameters:nameservers (list) – A list of new name servers for the domain.

Type: Complex

Children: Name, GlueIps

Required: Yes

boto.route53.domains.exceptions

exception boto.route53.domains.exceptions.DomainLimitExceeded(status, reason, body=None, *args)
exception boto.route53.domains.exceptions.DuplicateRequest(status, reason, body=None, *args)
exception boto.route53.domains.exceptions.InvalidInput(status, reason, body=None, *args)
exception boto.route53.domains.exceptions.OperationLimitExceeded(status, reason, body=None, *args)
exception boto.route53.domains.exceptions.TLDRulesViolation(status, reason, body=None, *args)
exception boto.route53.domains.exceptions.UnsupportedTLD(status, reason, body=None, *args)