Route53Domains / Client / check_domain_transferability

check_domain_transferability#

Route53Domains.Client.check_domain_transferability(**kwargs)#

Checks whether a domain name can be transferred to Amazon Route 53.

See also: AWS API Documentation

Request Syntax

response = client.check_domain_transferability(
    DomainName='string',
    AuthCode='string'
)
Parameters:

  • DomainName (string) –

    [REQUIRED]

    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.

  • AuthCode (string) – If the registrar for the top-level domain (TLD) requires an authorization code to transfer the domain, the code that you got from the current registrar for the domain.

Return type:

dict

Returns:

Response Syntax

{
    'Transferability': {
        'Transferable': 'TRANSFERABLE'|'UNTRANSFERABLE'|'DONT_KNOW'|'DOMAIN_IN_OWN_ACCOUNT'|'DOMAIN_IN_ANOTHER_ACCOUNT'|'PREMIUM_DOMAIN'
    },
    'Message': 'string'
}

Response Structure

  • (dict) –

    The CheckDomainTransferability response includes the following elements.

    • Transferability (dict) –

      A complex type that contains information about whether the specified domain can be transferred to Route 53.

      • Transferable (string) –

        Whether the domain name can be transferred to Route 53.

        Note

        You can transfer only domains that have a value of TRANSFERABLE or Transferable.

        Valid values:

        TRANSFERABLE

        The domain name can be transferred to Route 53.

        UNTRANSFERRABLE

        The domain name can’t be transferred to Route 53.

        DONT_KNOW

        Reserved for future use.

        DOMAIN_IN_OWN_ACCOUNT

        The domain already exists in the current Amazon Web Services account.

        DOMAIN_IN_ANOTHER_ACCOUNT

        the domain exists in another Amazon Web Services account.

        PREMIUM_DOMAIN

        Premium domain transfer is not supported.

    • Message (string) –

      Provides an explanation for when a domain can’t be transferred.

Exceptions

  • Route53Domains.Client.exceptions.InvalidInput

  • Route53Domains.Client.exceptions.UnsupportedTLD