Skip to content

TransferDomainRequest

Source code in docs_src/capo_route_53_domains/types/transfer_domain_request.py
class TransferDomainRequest(TypedDict, closed=True):
    domain_name: "capo_route_53_domains.types.domain_name.DomainName"
    """<p>The name of the domain that you want to transfer to Route 53. The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. For a list of supported TLDs, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html">Domains that You Can Register with Amazon Route 53</a> in the <i>Amazon Route 53 Developer Guide</i>.</p> <p>The domain name can contain only the following characters:</p> <ul> <li> <p>Letters a through z. Domain names are not case sensitive.</p> </li> <li> <p>Numbers 0 through 9.</p> </li> <li> <p>Hyphen (-). You can't specify a hyphen at the beginning or end of a label. </p> </li> <li> <p>Period (.) to separate the labels in the name, such as the <code>.</code> in <code>example.com</code>.</p> </li> </ul>"""
    idn_lang_code: NotRequired["capo_route_53_domains.types.lang_code.LangCode"]
    """<p>Reserved for future use.</p>"""
    duration_in_years: NotRequired[
        "capo_route_53_domains.types.duration_in_years.DurationInYears"
    ]
    """<p>Reserved for future use.</p> <p>Currently, the effect of a domain transfer on the registration period varies by TLD. For information about how transferring a domain affects the expiration date, see the Transfer Term column in the pricing information at <a href="http://aws.amazon.com/route53/pricing/">Amazon Route 53 Pricing</a>.</p> <p>Default: 1</p>"""
    nameservers: NotRequired[
        "capo_route_53_domains.types.nameserver_list.NameserverList"
    ]
    """<p>Contains details for the host and glue IP addresses.</p>"""
    auth_code: NotRequired[
        "capo_route_53_domains.types.domain_auth_code.DomainAuthCode"
    ]
    """<p>The authorization code for the domain. You get this value from the current registrar.</p>"""
    auto_renew: NotRequired["capo_route_53_domains.types.boolean.Boolean"]
    """<p>Indicates whether the domain will be automatically renewed (true) or not (false). Auto renewal only takes effect after the account is charged.</p> <p>Default: true</p>"""
    admin_contact: "capo_route_53_domains.types.contact_detail.ContactDetail"
    """<p>Provides detailed contact information.</p>"""
    registrant_contact: "capo_route_53_domains.types.contact_detail.ContactDetail"
    """<p>Provides detailed contact information.</p>"""
    tech_contact: "capo_route_53_domains.types.contact_detail.ContactDetail"
    """<p>Provides detailed contact information.</p>"""
    privacy_protect_admin_contact: NotRequired[
        "capo_route_53_domains.types.boolean.Boolean"
    ]
    """<p>Whether you want to conceal contact information from WHOIS queries. If you specify <code>true</code>, WHOIS ("who is") queries return contact information for the registrar, the phrase "REDACTED FOR PRIVACY", or "On behalf of <domain name> owner.".</p> <note> <p>While some domains may allow different privacy settings per contact, we recommend specifying the same privacy setting for all contacts.</p> </note> <p>Default: <code>true</code> </p>"""
    privacy_protect_registrant_contact: NotRequired[
        "capo_route_53_domains.types.boolean.Boolean"
    ]
    """<p>Whether you want to conceal contact information from WHOIS queries. If you specify <code>true</code>, WHOIS ("who is") queries return contact information either for Amazon Registrar or for our registrar associate, Gandi. If you specify <code>false</code>, WHOIS queries return the information that you entered for the registrant contact (domain owner).</p> <note> <p>You must specify the same privacy setting for the administrative, billing, registrant, and technical contacts.</p> </note> <p>Default: <code>true</code> </p>"""
    privacy_protect_tech_contact: NotRequired[
        "capo_route_53_domains.types.boolean.Boolean"
    ]
    """<p>Whether you want to conceal contact information from WHOIS queries. If you specify <code>true</code>, WHOIS ("who is") queries return contact information either for Amazon Registrar or for our registrar associate, Gandi. If you specify <code>false</code>, WHOIS queries return the information that you entered for the technical contact.</p> <note> <p>You must specify the same privacy setting for the administrative, billing, registrant, and technical contacts.</p> </note> <p>Default: <code>true</code> </p>"""
    billing_contact: NotRequired[
        "capo_route_53_domains.types.contact_detail.ContactDetail"
    ]
    """<p>Provides detailed contact information.</p>"""
    privacy_protect_billing_contact: NotRequired[
        "capo_route_53_domains.types.boolean.Boolean"
    ]
    """<p> Whether you want to conceal contact information from WHOIS queries. If you specify <code>true</code>, WHOIS ("who is") queries return contact information either for Amazon Registrar or for our registrar associate, Gandi. If you specify <code>false</code>, WHOIS queries return the information that you entered for the billing contact. </p> <note> <p>You must specify the same privacy setting for the administrative, billing, registrant, and technical contacts.</p> </note>"""
    consent: NotRequired["capo_route_53_domains.types.consent.Consent"]
    """<p>Specifies the maximum price that you agree to pay to transfer the domain name to Route 53. This element is required if the domain has registry premium pricing, and optional if the domain is priced at the standard rate for its TLD. If you include it and the transfer price is more than <code>MaxPrice</code>, the request fails.</p>"""

admin_contact instance-attribute

admin_contact: ContactDetail

Provides detailed contact information.

auth_code instance-attribute

auth_code: NotRequired[DomainAuthCode]

The authorization code for the domain. You get this value from the current registrar.

auto_renew instance-attribute

auto_renew: NotRequired[Boolean]

Indicates whether the domain will be automatically renewed (true) or not (false). Auto renewal only takes effect after the account is charged.

Default: true

billing_contact instance-attribute

billing_contact: NotRequired[ContactDetail]

Provides detailed contact information.

consent instance-attribute

consent: NotRequired[Consent]

Specifies the maximum price that you agree to pay to transfer the domain name to Route 53. This element is required if the domain has registry premium pricing, and optional if the domain is priced at the standard rate for its TLD. If you include it and the transfer price is more than MaxPrice, the request fails.

domain_name instance-attribute

domain_name: DomainName

The name of the domain that you want to transfer to Route 53. The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. For a list of supported TLDs, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide.

The domain name can contain only the following characters:

  • Letters a through z. Domain names are not case sensitive.

  • Numbers 0 through 9.

  • Hyphen (-). You can't specify a hyphen at the beginning or end of a label.

  • Period (.) to separate the labels in the name, such as the . in example.com.

duration_in_years instance-attribute

duration_in_years: NotRequired[DurationInYears]

Reserved for future use.

Currently, the effect of a domain transfer on the registration period varies by TLD. For information about how transferring a domain affects the expiration date, see the Transfer Term column in the pricing information at Amazon Route 53 Pricing.

Default: 1

idn_lang_code instance-attribute

idn_lang_code: NotRequired[LangCode]

Reserved for future use.

nameservers instance-attribute

nameservers: NotRequired[NameserverList]

Contains details for the host and glue IP addresses.

privacy_protect_admin_contact instance-attribute

privacy_protect_admin_contact: NotRequired[Boolean]

Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries return contact information for the registrar, the phrase "REDACTED FOR PRIVACY", or "On behalf of owner.".

While some domains may allow different privacy settings per contact, we recommend specifying the same privacy setting for all contacts.

Default: true

privacy_protect_billing_contact instance-attribute

privacy_protect_billing_contact: NotRequired[Boolean]

Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries return contact information either for Amazon Registrar or for our registrar associate, Gandi. If you specify false, WHOIS queries return the information that you entered for the billing contact.

You must specify the same privacy setting for the administrative, billing, registrant, and technical contacts.

privacy_protect_registrant_contact instance-attribute

privacy_protect_registrant_contact: NotRequired[Boolean]

Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries return contact information either for Amazon Registrar or for our registrar associate, Gandi. If you specify false, WHOIS queries return the information that you entered for the registrant contact (domain owner).

You must specify the same privacy setting for the administrative, billing, registrant, and technical contacts.

Default: true

privacy_protect_tech_contact instance-attribute

privacy_protect_tech_contact: NotRequired[Boolean]

Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries return contact information either for Amazon Registrar or for our registrar associate, Gandi. If you specify false, WHOIS queries return the information that you entered for the technical contact.

You must specify the same privacy setting for the administrative, billing, registrant, and technical contacts.

Default: true

registrant_contact instance-attribute

registrant_contact: ContactDetail

Provides detailed contact information.

tech_contact instance-attribute

tech_contact: ContactDetail

Provides detailed contact information.