Route53Domains ¶

Table of Contents

Route53Domains
- Client
- Paginators

Client ¶

class Route53Domains.Client¶

A low-level client representing Amazon Route 53 Domains:

client = session.create_client('route53domains')

These are the available methods:

can_paginate(operation_name)¶

Check if an operation can be paginated.

Parameters:	operation_name (string) – The operation name. This is the same name as the method name on the client. For example, if the method name is `create_foo`, and you’d normally invoke the operation as `client.create_foo(**kwargs)`, if the `create_foo` operation can be paginated, you can use the call `client.get_paginator("create_foo")`.
Returns:	`True` if the operation can be paginated, `False` otherwise.

check_domain_availability(**kwargs)¶

This operation checks the availability of one domain name. Note that if the availability status of a domain is pending, you must submit another request to determine the availability of the domain name.

See also: AWS API Documentation

Request Syntax

response = client.check_domain_availability(
    DomainName='string',
    IdnLangCode='string'
)

Parameters:

DomainName (string) –
[REQUIRED]

The name of the domain that you want to get availability for.

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.
IdnLangCode (string) – Reserved for future use.

Return type:

dict

Returns:

Response Syntax

{
    'Availability': 'AVAILABLE'|'AVAILABLE_RESERVED'|'AVAILABLE_PREORDER'|'UNAVAILABLE'|'UNAVAILABLE_PREMIUM'|'UNAVAILABLE_RESTRICTED'|'RESERVED'|'DONT_KNOW'
}

Response Structure

(dict) –

The CheckDomainAvailability response includes the following elements.
- Availability (string) –
  
  Whether the domain name is available for registering.
  
  Note
  
  You can only register domains designated as AVAILABLE .
  
  Valid values:
  
  AVAILABLE
  
  The domain name is available.
  
  AVAILABLE_RESERVED
  
  The domain name is reserved under specific conditions.
  
  AVAILABLE_PREORDER
  
  The domain name is available and can be preordered.
  
  DONT_KNOW
  
  The TLD registry didn’t reply with a definitive answer about whether the domain name is available. Amazon Route 53 can return this response for a variety of reasons, for example, the registry is performing maintenance. Try again later.
  
  PENDING
  
  The TLD registry didn’t return a response in the expected amount of time. When the response is delayed, it usually takes just a few extra seconds. You can resubmit the request immediately.
  
  RESERVED
  
  The domain name has been reserved for another person or organization.
  
  UNAVAILABLE
  
  The domain name is not available.
  
  UNAVAILABLE_PREMIUM
  
  The domain name is not available.
  
  UNAVAILABLE_RESTRICTED
  
  The domain name is forbidden.

delete_tags_for_domain(**kwargs)¶

This operation deletes the specified tags for a domain.

All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations.

See also: AWS API Documentation

Request Syntax

response = client.delete_tags_for_domain(
    DomainName='string',
    TagsToDelete=[
        'string',
    ]
)

Parameters:

DomainName (string) –
[REQUIRED]

The domain for which you want to delete one or more tags.
TagsToDelete (list) –
[REQUIRED]

A list of tag keys to delete.
- (string) –

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

(dict) –

disable_domain_auto_renew(**kwargs)¶

This operation disables automatic renewal of domain registration for the specified domain.

See also: AWS API Documentation

Request Syntax

response = client.disable_domain_auto_renew(
    DomainName='string'
)

Parameters:

DomainName (string) –

[REQUIRED]

The name of the domain that you want to disable automatic renewal for.

Return type: dict

Returns:

Response Syntax

{}

Response Structure

(dict) –

disable_domain_transfer_lock(**kwargs)¶

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.

See also: AWS API Documentation

Request Syntax

response = client.disable_domain_transfer_lock(
    DomainName='string'
)

Parameters:

DomainName (string) –

[REQUIRED]

The name of the domain that you want to remove the transfer lock for.

Return type: dict

Returns:

Response Syntax

{
    'OperationId': 'string'
}

Response Structure

(dict) –
The DisableDomainTransferLock response includes the following element.
- OperationId (string) –
  Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail .

enable_domain_auto_renew(**kwargs)¶

This operation configures Amazon Route 53 to automatically renew the specified domain before the domain registration expires. The cost of renewing your domain registration is billed to your AWS account.

The period during which you can renew a domain name varies by TLD. For a list of TLDs and their renewal policies, see “Renewal, restoration, and deletion times” on the website for our registrar partner, Gandi. Route 53 requires that you renew before the end of the renewal period that is listed on the Gandi website so we can complete processing before the deadline.

See also: AWS API Documentation

Request Syntax

response = client.enable_domain_auto_renew(
    DomainName='string'
)

Parameters:

DomainName (string) –

[REQUIRED]

The name of the domain that you want to enable automatic renewal for.

Return type: dict

Returns:

Response Syntax

{}

Response Structure

(dict) –

enable_domain_transfer_lock(**kwargs)¶

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.

See also: AWS API Documentation

Request Syntax

response = client.enable_domain_transfer_lock(
    DomainName='string'
)

Parameters:

DomainName (string) –

[REQUIRED]

The name of the domain that you want to set the transfer lock for.

Return type: dict

Returns:

Response Syntax

{
    'OperationId': 'string'
}

Response Structure

(dict) –
The EnableDomainTransferLock response includes the following elements.
- OperationId (string) –
  Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)¶

Generate a presigned url given a client, its method, and arguments

Parameters:

ClientMethod (string) – The client method to presign for
Params (dict) – The parameters normally passed to ClientMethod.
ExpiresIn (int) – The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
HttpMethod (string) – The http method to use on the generated url. By default, the http method is whatever is used in the method’s model.

Returns:

The presigned url

get_contact_reachability_status(**kwargs)¶

For operations that require confirmation that the email address for the registrant contact is valid, such as registering a new domain, this operation returns information about whether the registrant contact has responded.

If you want us to resend the email, use the ResendContactReachabilityEmail operation.

See also: AWS API Documentation

Request Syntax

response = client.get_contact_reachability_status(
    domainName='string'
)

Parameters: domainName (string) – The name of the domain for which you want to know whether the registrant contact has confirmed that the email address is valid.

Return type: dict

Returns:

Response Syntax

{
    'domainName': 'string',
    'status': 'PENDING'|'DONE'|'EXPIRED'
}

Response Structure

(dict) –
- domainName (string) –
  The domain name for which you requested the reachability status.
- status (string) –
  Whether the registrant contact has responded. Values include the following:
  
  PENDING
  
  We sent the confirmation email and haven’t received a response yet.
  
  DONE
  
  We sent the email and got confirmation from the registrant contact.
  
  EXPIRED
  
  The time limit expired before the registrant contact responded.

get_domain_detail(**kwargs)¶

This operation returns detailed information about a specified domain that is associated with the current AWS account. Contact information for the domain is also returned as part of the output.

See also: AWS API Documentation

Request Syntax

response = client.get_domain_detail(
    DomainName='string'
)

Parameters:

DomainName (string) –

[REQUIRED]

The name of the domain that you want to get detailed information about.

Return type: dict

Returns:

Response Syntax

{
    'DomainName': 'string',
    'Nameservers': [
        {
            'Name': 'string',
            'GlueIps': [
                'string',
            ]
        },
    ],
    'AutoRenew': True|False,
    'AdminContact': {
        'FirstName': 'string',
        'LastName': 'string',
        'ContactType': 'PERSON'|'COMPANY'|'ASSOCIATION'|'PUBLIC_BODY'|'RESELLER',
        'OrganizationName': 'string',
        'AddressLine1': 'string',
        'AddressLine2': 'string',
        'City': 'string',
        'State': 'string',
        'CountryCode': 'AD'|'AE'|'AF'|'AG'|'AI'|'AL'|'AM'|'AN'|'AO'|'AQ'|'AR'|'AS'|'AT'|'AU'|'AW'|'AZ'|'BA'|'BB'|'BD'|'BE'|'BF'|'BG'|'BH'|'BI'|'BJ'|'BL'|'BM'|'BN'|'BO'|'BR'|'BS'|'BT'|'BW'|'BY'|'BZ'|'CA'|'CC'|'CD'|'CF'|'CG'|'CH'|'CI'|'CK'|'CL'|'CM'|'CN'|'CO'|'CR'|'CU'|'CV'|'CX'|'CY'|'CZ'|'DE'|'DJ'|'DK'|'DM'|'DO'|'DZ'|'EC'|'EE'|'EG'|'ER'|'ES'|'ET'|'FI'|'FJ'|'FK'|'FM'|'FO'|'FR'|'GA'|'GB'|'GD'|'GE'|'GH'|'GI'|'GL'|'GM'|'GN'|'GQ'|'GR'|'GT'|'GU'|'GW'|'GY'|'HK'|'HN'|'HR'|'HT'|'HU'|'ID'|'IE'|'IL'|'IM'|'IN'|'IQ'|'IR'|'IS'|'IT'|'JM'|'JO'|'JP'|'KE'|'KG'|'KH'|'KI'|'KM'|'KN'|'KP'|'KR'|'KW'|'KY'|'KZ'|'LA'|'LB'|'LC'|'LI'|'LK'|'LR'|'LS'|'LT'|'LU'|'LV'|'LY'|'MA'|'MC'|'MD'|'ME'|'MF'|'MG'|'MH'|'MK'|'ML'|'MM'|'MN'|'MO'|'MP'|'MR'|'MS'|'MT'|'MU'|'MV'|'MW'|'MX'|'MY'|'MZ'|'NA'|'NC'|'NE'|'NG'|'NI'|'NL'|'NO'|'NP'|'NR'|'NU'|'NZ'|'OM'|'PA'|'PE'|'PF'|'PG'|'PH'|'PK'|'PL'|'PM'|'PN'|'PR'|'PT'|'PW'|'PY'|'QA'|'RO'|'RS'|'RU'|'RW'|'SA'|'SB'|'SC'|'SD'|'SE'|'SG'|'SH'|'SI'|'SK'|'SL'|'SM'|'SN'|'SO'|'SR'|'ST'|'SV'|'SY'|'SZ'|'TC'|'TD'|'TG'|'TH'|'TJ'|'TK'|'TL'|'TM'|'TN'|'TO'|'TR'|'TT'|'TV'|'TW'|'TZ'|'UA'|'UG'|'US'|'UY'|'UZ'|'VA'|'VC'|'VE'|'VG'|'VI'|'VN'|'VU'|'WF'|'WS'|'YE'|'YT'|'ZA'|'ZM'|'ZW',
        'ZipCode': 'string',
        'PhoneNumber': 'string',
        'Email': 'string',
        'Fax': 'string',
        'ExtraParams': [
            {
                'Name': 'DUNS_NUMBER'|'BRAND_NUMBER'|'BIRTH_DEPARTMENT'|'BIRTH_DATE_IN_YYYY_MM_DD'|'BIRTH_COUNTRY'|'BIRTH_CITY'|'DOCUMENT_NUMBER'|'AU_ID_NUMBER'|'AU_ID_TYPE'|'CA_LEGAL_TYPE'|'CA_BUSINESS_ENTITY_TYPE'|'ES_IDENTIFICATION'|'ES_IDENTIFICATION_TYPE'|'ES_LEGAL_FORM'|'FI_BUSINESS_NUMBER'|'FI_ID_NUMBER'|'IT_PIN'|'RU_PASSPORT_DATA'|'SE_ID_NUMBER'|'SG_ID_NUMBER'|'VAT_NUMBER',
                'Value': 'string'
            },
        ]
    },
    'RegistrantContact': {
        'FirstName': 'string',
        'LastName': 'string',
        'ContactType': 'PERSON'|'COMPANY'|'ASSOCIATION'|'PUBLIC_BODY'|'RESELLER',
        'OrganizationName': 'string',
        'AddressLine1': 'string',
        'AddressLine2': 'string',
        'City': 'string',
        'State': 'string',
        'CountryCode': 'AD'|'AE'|'AF'|'AG'|'AI'|'AL'|'AM'|'AN'|'AO'|'AQ'|'AR'|'AS'|'AT'|'AU'|'AW'|'AZ'|'BA'|'BB'|'BD'|'BE'|'BF'|'BG'|'BH'|'BI'|'BJ'|'BL'|'BM'|'BN'|'BO'|'BR'|'BS'|'BT'|'BW'|'BY'|'BZ'|'CA'|'CC'|'CD'|'CF'|'CG'|'CH'|'CI'|'CK'|'CL'|'CM'|'CN'|'CO'|'CR'|'CU'|'CV'|'CX'|'CY'|'CZ'|'DE'|'DJ'|'DK'|'DM'|'DO'|'DZ'|'EC'|'EE'|'EG'|'ER'|'ES'|'ET'|'FI'|'FJ'|'FK'|'FM'|'FO'|'FR'|'GA'|'GB'|'GD'|'GE'|'GH'|'GI'|'GL'|'GM'|'GN'|'GQ'|'GR'|'GT'|'GU'|'GW'|'GY'|'HK'|'HN'|'HR'|'HT'|'HU'|'ID'|'IE'|'IL'|'IM'|'IN'|'IQ'|'IR'|'IS'|'IT'|'JM'|'JO'|'JP'|'KE'|'KG'|'KH'|'KI'|'KM'|'KN'|'KP'|'KR'|'KW'|'KY'|'KZ'|'LA'|'LB'|'LC'|'LI'|'LK'|'LR'|'LS'|'LT'|'LU'|'LV'|'LY'|'MA'|'MC'|'MD'|'ME'|'MF'|'MG'|'MH'|'MK'|'ML'|'MM'|'MN'|'MO'|'MP'|'MR'|'MS'|'MT'|'MU'|'MV'|'MW'|'MX'|'MY'|'MZ'|'NA'|'NC'|'NE'|'NG'|'NI'|'NL'|'NO'|'NP'|'NR'|'NU'|'NZ'|'OM'|'PA'|'PE'|'PF'|'PG'|'PH'|'PK'|'PL'|'PM'|'PN'|'PR'|'PT'|'PW'|'PY'|'QA'|'RO'|'RS'|'RU'|'RW'|'SA'|'SB'|'SC'|'SD'|'SE'|'SG'|'SH'|'SI'|'SK'|'SL'|'SM'|'SN'|'SO'|'SR'|'ST'|'SV'|'SY'|'SZ'|'TC'|'TD'|'TG'|'TH'|'TJ'|'TK'|'TL'|'TM'|'TN'|'TO'|'TR'|'TT'|'TV'|'TW'|'TZ'|'UA'|'UG'|'US'|'UY'|'UZ'|'VA'|'VC'|'VE'|'VG'|'VI'|'VN'|'VU'|'WF'|'WS'|'YE'|'YT'|'ZA'|'ZM'|'ZW',
        'ZipCode': 'string',
        'PhoneNumber': 'string',
        'Email': 'string',
        'Fax': 'string',
        'ExtraParams': [
            {
                'Name': 'DUNS_NUMBER'|'BRAND_NUMBER'|'BIRTH_DEPARTMENT'|'BIRTH_DATE_IN_YYYY_MM_DD'|'BIRTH_COUNTRY'|'BIRTH_CITY'|'DOCUMENT_NUMBER'|'AU_ID_NUMBER'|'AU_ID_TYPE'|'CA_LEGAL_TYPE'|'CA_BUSINESS_ENTITY_TYPE'|'ES_IDENTIFICATION'|'ES_IDENTIFICATION_TYPE'|'ES_LEGAL_FORM'|'FI_BUSINESS_NUMBER'|'FI_ID_NUMBER'|'IT_PIN'|'RU_PASSPORT_DATA'|'SE_ID_NUMBER'|'SG_ID_NUMBER'|'VAT_NUMBER',
                'Value': 'string'
            },
        ]
    },
    'TechContact': {
        'FirstName': 'string',
        'LastName': 'string',
        'ContactType': 'PERSON'|'COMPANY'|'ASSOCIATION'|'PUBLIC_BODY'|'RESELLER',
        'OrganizationName': 'string',
        'AddressLine1': 'string',
        'AddressLine2': 'string',
        'City': 'string',
        'State': 'string',
        'CountryCode': 'AD'|'AE'|'AF'|'AG'|'AI'|'AL'|'AM'|'AN'|'AO'|'AQ'|'AR'|'AS'|'AT'|'AU'|'AW'|'AZ'|'BA'|'BB'|'BD'|'BE'|'BF'|'BG'|'BH'|'BI'|'BJ'|'BL'|'BM'|'BN'|'BO'|'BR'|'BS'|'BT'|'BW'|'BY'|'BZ'|'CA'|'CC'|'CD'|'CF'|'CG'|'CH'|'CI'|'CK'|'CL'|'CM'|'CN'|'CO'|'CR'|'CU'|'CV'|'CX'|'CY'|'CZ'|'DE'|'DJ'|'DK'|'DM'|'DO'|'DZ'|'EC'|'EE'|'EG'|'ER'|'ES'|'ET'|'FI'|'FJ'|'FK'|'FM'|'FO'|'FR'|'GA'|'GB'|'GD'|'GE'|'GH'|'GI'|'GL'|'GM'|'GN'|'GQ'|'GR'|'GT'|'GU'|'GW'|'GY'|'HK'|'HN'|'HR'|'HT'|'HU'|'ID'|'IE'|'IL'|'IM'|'IN'|'IQ'|'IR'|'IS'|'IT'|'JM'|'JO'|'JP'|'KE'|'KG'|'KH'|'KI'|'KM'|'KN'|'KP'|'KR'|'KW'|'KY'|'KZ'|'LA'|'LB'|'LC'|'LI'|'LK'|'LR'|'LS'|'LT'|'LU'|'LV'|'LY'|'MA'|'MC'|'MD'|'ME'|'MF'|'MG'|'MH'|'MK'|'ML'|'MM'|'MN'|'MO'|'MP'|'MR'|'MS'|'MT'|'MU'|'MV'|'MW'|'MX'|'MY'|'MZ'|'NA'|'NC'|'NE'|'NG'|'NI'|'NL'|'NO'|'NP'|'NR'|'NU'|'NZ'|'OM'|'PA'|'PE'|'PF'|'PG'|'PH'|'PK'|'PL'|'PM'|'PN'|'PR'|'PT'|'PW'|'PY'|'QA'|'RO'|'RS'|'RU'|'RW'|'SA'|'SB'|'SC'|'SD'|'SE'|'SG'|'SH'|'SI'|'SK'|'SL'|'SM'|'SN'|'SO'|'SR'|'ST'|'SV'|'SY'|'SZ'|'TC'|'TD'|'TG'|'TH'|'TJ'|'TK'|'TL'|'TM'|'TN'|'TO'|'TR'|'TT'|'TV'|'TW'|'TZ'|'UA'|'UG'|'US'|'UY'|'UZ'|'VA'|'VC'|'VE'|'VG'|'VI'|'VN'|'VU'|'WF'|'WS'|'YE'|'YT'|'ZA'|'ZM'|'ZW',
        'ZipCode': 'string',
        'PhoneNumber': 'string',
        'Email': 'string',
        'Fax': 'string',
        'ExtraParams': [
            {
                'Name': 'DUNS_NUMBER'|'BRAND_NUMBER'|'BIRTH_DEPARTMENT'|'BIRTH_DATE_IN_YYYY_MM_DD'|'BIRTH_COUNTRY'|'BIRTH_CITY'|'DOCUMENT_NUMBER'|'AU_ID_NUMBER'|'AU_ID_TYPE'|'CA_LEGAL_TYPE'|'CA_BUSINESS_ENTITY_TYPE'|'ES_IDENTIFICATION'|'ES_IDENTIFICATION_TYPE'|'ES_LEGAL_FORM'|'FI_BUSINESS_NUMBER'|'FI_ID_NUMBER'|'IT_PIN'|'RU_PASSPORT_DATA'|'SE_ID_NUMBER'|'SG_ID_NUMBER'|'VAT_NUMBER',
                'Value': 'string'
            },
        ]
    },
    'AdminPrivacy': True|False,
    'RegistrantPrivacy': True|False,
    'TechPrivacy': True|False,
    'RegistrarName': 'string',
    'WhoIsServer': 'string',
    'RegistrarUrl': 'string',
    'AbuseContactEmail': 'string',
    'AbuseContactPhone': 'string',
    'RegistryDomainId': 'string',
    'CreationDate': datetime(2015, 1, 1),
    'UpdatedDate': datetime(2015, 1, 1),
    'ExpirationDate': datetime(2015, 1, 1),
    'Reseller': 'string',
    'DnsSec': 'string',
    'StatusList': [
        'string',
    ]
}

Response Structure

(dict) –
The GetDomainDetail response includes the following elements.
- DomainName (string) –
  The name of a domain.
- Nameservers (list) –
  The name of the domain.
  - (dict) –
    Nameserver includes the following elements.
    - Name (string) –
      The fully qualified host name of the name server.
      
      Constraint: Maximum 255 characters
    - GlueIps (list) –
      Glue IP address of a name server entry. Glue IP addresses are required only when the name of the name server is a subdomain of the domain. For example, if your domain is example.com and the name server for the domain is ns.example.com, you need to specify the IP address for ns.example.com.
      
      Constraints: The list can contain only one IPv4 and one IPv6 address.
      - (string) –
- AutoRenew (boolean) –
  Specifies whether the domain registration is set to renew automatically.
- AdminContact (dict) –
  Provides details about the domain administrative contact.
  - FirstName (string) –
    First name of contact.
  - LastName (string) –
    Last name of contact.
  - ContactType (string) –
    Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON , you must enter an organization name, and you can’t enable privacy protection for the contact.
  - OrganizationName (string) –
    Name of the organization for contact types other than PERSON .
  - AddressLine1 (string) –
    First line of the contact’s address.
  - AddressLine2 (string) –
    Second line of contact’s address, if any.
  - City (string) –
    The city of the contact’s address.
  - State (string) –
    The state or province of the contact’s city.
  - CountryCode (string) –
    Code for the country of the contact’s address.
  - ZipCode (string) –
    The zip or postal code of the contact’s address.
  - PhoneNumber (string) –
    The phone number of the contact.
    
    Constraints: Phone number must be specified in the format “+[country dialing code].[number including any area code]”. For example, a US phone number might appear as "+1.1234567890" .
  - Email (string) –
    Email address of the contact.
  - Fax (string) –
    Fax number of the contact.
    
    Constraints: Phone number must be specified in the format “+[country dialing code].[number including any area code]”. For example, a US phone number might appear as "+1.1234567890" .
  - ExtraParams (list) –
    A list of name-value pairs for parameters required by certain top-level domains.
    - (dict) –
      ExtraParam includes the following elements.
      - Name (string) –
        Name of the additional parameter required by the top-level domain.
      - Value (string) –
        Values corresponding to the additional parameter names required by some top-level domains.
- RegistrantContact (dict) –
  Provides details about the domain registrant.
  - FirstName (string) –
    First name of contact.
  - LastName (string) –
    Last name of contact.
  - ContactType (string) –
    Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON , you must enter an organization name, and you can’t enable privacy protection for the contact.
  - OrganizationName (string) –
    Name of the organization for contact types other than PERSON .
  - AddressLine1 (string) –
    First line of the contact’s address.
  - AddressLine2 (string) –
    Second line of contact’s address, if any.
  - City (string) –
    The city of the contact’s address.
  - State (string) –
    The state or province of the contact’s city.
  - CountryCode (string) –
    Code for the country of the contact’s address.
  - ZipCode (string) –
    The zip or postal code of the contact’s address.
  - PhoneNumber (string) –
    The phone number of the contact.
    
    Constraints: Phone number must be specified in the format “+[country dialing code].[number including any area code]”. For example, a US phone number might appear as "+1.1234567890" .
  - Email (string) –
    Email address of the contact.
  - Fax (string) –
    Fax number of the contact.
    
    Constraints: Phone number must be specified in the format “+[country dialing code].[number including any area code]”. For example, a US phone number might appear as "+1.1234567890" .
  - ExtraParams (list) –
    A list of name-value pairs for parameters required by certain top-level domains.
    - (dict) –
      ExtraParam includes the following elements.
      - Name (string) –
        Name of the additional parameter required by the top-level domain.
      - Value (string) –
        Values corresponding to the additional parameter names required by some top-level domains.
- TechContact (dict) –
  Provides details about the domain technical contact.
  - FirstName (string) –
    First name of contact.
  - LastName (string) –
    Last name of contact.
  - ContactType (string) –
    Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON , you must enter an organization name, and you can’t enable privacy protection for the contact.
  - OrganizationName (string) –
    Name of the organization for contact types other than PERSON .
  - AddressLine1 (string) –
    First line of the contact’s address.
  - AddressLine2 (string) –
    Second line of contact’s address, if any.
  - City (string) –
    The city of the contact’s address.
  - State (string) –
    The state or province of the contact’s city.
  - CountryCode (string) –
    Code for the country of the contact’s address.
  - ZipCode (string) –
    The zip or postal code of the contact’s address.
  - PhoneNumber (string) –
    The phone number of the contact.
    
    Constraints: Phone number must be specified in the format “+[country dialing code].[number including any area code]”. For example, a US phone number might appear as "+1.1234567890" .
  - Email (string) –
    Email address of the contact.
  - Fax (string) –
    Fax number of the contact.
    
    Constraints: Phone number must be specified in the format “+[country dialing code].[number including any area code]”. For example, a US phone number might appear as "+1.1234567890" .
  - ExtraParams (list) –
    A list of name-value pairs for parameters required by certain top-level domains.
    - (dict) –
      ExtraParam includes the following elements.
      - Name (string) –
        Name of the additional parameter required by the top-level domain.
      - Value (string) –
        Values corresponding to the additional parameter names required by some top-level domains.
- AdminPrivacy (boolean) –
  Specifies whether contact information for the admin contact is concealed from WHOIS queries. If the value is true , WHOIS (“who is”) queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
- RegistrantPrivacy (boolean) –
  Specifies whether contact information for the registrant contact is concealed from WHOIS queries. If the value is true , WHOIS (“who is”) queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
- TechPrivacy (boolean) –
  Specifies whether contact information for the tech contact is concealed from WHOIS queries. If the value is true , WHOIS (“who is”) queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
- RegistrarName (string) –
  Name of the registrar of the domain as identified in the registry. Amazon Route 53 domains are registered by registrar Gandi. The value is "GANDI SAS" .
- WhoIsServer (string) –
  The fully qualified name of the WHOIS server that can answer the WHOIS query for the domain.
- RegistrarUrl (string) –
  Web address of the registrar.
- AbuseContactEmail (string) –
  Email address to contact to report incorrect contact information for a domain, to report that the domain is being used to send spam, to report that someone is cybersquatting on a domain name, or report some other type of abuse.
- AbuseContactPhone (string) –
  Phone number for reporting abuse.
- RegistryDomainId (string) –
  Reserved for future use.
- CreationDate (datetime) –
  The date when the domain was created as found in the response to a WHOIS query. The date format is Unix time.
- UpdatedDate (datetime) –
  The last updated date of the domain as found in the response to a WHOIS query. The date format is Unix time.
- ExpirationDate (datetime) –
  The date when the registration for the domain is set to expire. The date format is Unix time.
- Reseller (string) –
  Reseller of the domain. Domains registered or transferred using Amazon Route 53 domains will have "Amazon" as the reseller.
- DnsSec (string) –
  Reserved for future use.
- StatusList (list) –
  An array of domain name status codes, also known as Extensible Provisioning Protocol (EPP) status codes.
  
  ICANN, the organization that maintains a central database of domain names, has developed a set of domain name status codes that tell you the status of a variety of operations on a domain name, for example, registering a domain name, transferring a domain name to another registrar, renewing the registration for a domain name, and so on. All registrars use this same set of status codes.
  
  For a current list of domain name status codes and an explanation of what each code means, go to the ICANN website and search for epp status codes . (Search on the ICANN website; web searches sometimes return an old version of the document.)
  - (string) –

get_domain_suggestions(**kwargs)¶

The GetDomainSuggestions operation returns a list of suggested domain names given a string, which can either be a domain name or simply a word or phrase (without spaces).

See also: AWS API Documentation

Request Syntax

response = client.get_domain_suggestions(
    DomainName='string',
    SuggestionCount=123,
    OnlyAvailable=True|False
)

Parameters:

DomainName (string) –
[REQUIRED]

A domain name that you want to use as the basis for a list of possible domain names. The domain name must contain a top-level domain (TLD), such as .com, that Amazon Route 53 supports. For a list of TLDs, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide .
SuggestionCount (integer) –
[REQUIRED]

The number of suggested domain names that you want Amazon Route 53 to return.
OnlyAvailable (boolean) –
[REQUIRED]

If OnlyAvailable is true , Amazon Route 53 returns only domain names that are available. If OnlyAvailable is false , Amazon Route 53 returns domain names without checking whether they’re available to be registered. To determine whether the domain is available, you can call checkDomainAvailability for each suggestion.

Return type:

dict

Returns:

Response Syntax

{
    'SuggestionsList': [
        {
            'DomainName': 'string',
            'Availability': 'string'
        },
    ]
}

Response Structure

(dict) –
- SuggestionsList (list) –
  
  A list of possible domain names. If you specified true for OnlyAvailable in the request, the list contains only domains that are available for registration.
  - (dict) –
    
    Information about one suggested domain name.
    - DomainName (string) –
      
      A suggested domain name.
    - Availability (string) –
      
      Whether the domain name is available for registering.
      
      Note
      
      You can register only the domains that are designated as AVAILABLE .
      
      Valid values:
      
      AVAILABLE
      
      The domain name is available.
      
      AVAILABLE_RESERVED
      
      The domain name is reserved under specific conditions.
      
      AVAILABLE_PREORDER
      
      The domain name is available and can be preordered.
      
      DONT_KNOW
      
      The TLD registry didn’t reply with a definitive answer about whether the domain name is available. Amazon Route 53 can return this response for a variety of reasons, for example, the registry is performing maintenance. Try again later.
      
      PENDING
      
      The TLD registry didn’t return a response in the expected amount of time. When the response is delayed, it usually takes just a few extra seconds. You can resubmit the request immediately.
      
      RESERVED
      
      The domain name has been reserved for another person or organization.
      
      UNAVAILABLE
      
      The domain name is not available.
      
      UNAVAILABLE_PREMIUM
      
      The domain name is not available.
      
      UNAVAILABLE_RESTRICTED
      
      The domain name is forbidden.

get_operation_detail(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

response = client.get_operation_detail(
    OperationId='string'
)

Parameters:

OperationId (string) –

[REQUIRED]

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.

Return type: dict

Returns:

Response Syntax

{
    'OperationId': 'string',
    'Status': 'SUBMITTED'|'IN_PROGRESS'|'ERROR'|'SUCCESSFUL'|'FAILED',
    'Message': 'string',
    'DomainName': 'string',
    'Type': 'REGISTER_DOMAIN'|'DELETE_DOMAIN'|'TRANSFER_IN_DOMAIN'|'UPDATE_DOMAIN_CONTACT'|'UPDATE_NAMESERVER'|'CHANGE_PRIVACY_PROTECTION'|'DOMAIN_LOCK',
    'SubmittedDate': datetime(2015, 1, 1)
}

Response Structure

(dict) –
The GetOperationDetail response includes the following elements.
- OperationId (string) –
  The identifier for the operation.
- Status (string) –
  The current status of the requested operation in the system.
- Message (string) –
  Detailed information on the status including possible errors.
- DomainName (string) –
  The name of a domain.
- Type (string) –
  The type of operation that was requested.
- SubmittedDate (datetime) –
  The date when the request was submitted.

get_paginator(operation_name)¶

Create a paginator for an operation.

Parameters:	operation_name (string) – The operation name. This is the same name as the method name on the client. For example, if the method name is `create_foo`, and you’d normally invoke the operation as `client.create_foo(**kwargs)`, if the `create_foo` operation can be paginated, you can use the call `client.get_paginator("create_foo")`.
Raises:	OperationNotPageableError – Raised if the operation is not pageable. You can use the `client.can_paginate` method to check if an operation is pageable.
Return type:	L{botocore.paginate.Paginator}
Returns:	A paginator object.

get_waiter(waiter_name)¶

list_domains(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

response = client.list_domains(
    Marker='string',
    MaxItems=123
)

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.

Constraints: The marker must match the value specified in the previous request.
MaxItems (integer) –
Number of domains to be returned.

Default: 20

Return type:

dict

Returns:

Response Syntax

{
    'Domains': [
        {
            'DomainName': 'string',
            'AutoRenew': True|False,
            'TransferLock': True|False,
            'Expiry': datetime(2015, 1, 1)
        },
    ],
    'NextPageMarker': 'string'
}

Response Structure

(dict) –

The ListDomains response includes the following elements.
- Domains (list) –
  
  A summary of domains.
  - (dict) –
    
    Summary information about one domain.
    - DomainName (string) –
      
      The name of the domain that the summary information applies to.
    - AutoRenew (boolean) –
      
      Indicates whether the domain is automatically renewed upon expiration.
    - TransferLock (boolean) –
      
      Indicates whether a domain is locked from unauthorized transfer to another party.
    - Expiry (datetime) –
      
      Expiration date of the domain in Coordinated Universal Time (UTC).
- NextPageMarker (string) –
  
  If there are more domains than you specified for MaxItems in the request, submit another request and include the value of NextPageMarker in the value of Marker .

list_operations(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

response = client.list_operations(
    Marker='string',
    MaxItems=123
)

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.
MaxItems (integer) –
Number of domains to be returned.

Default: 20

Return type:

dict

Returns:

Response Syntax

{
    'Operations': [
        {
            'OperationId': 'string',
            'Status': 'SUBMITTED'|'IN_PROGRESS'|'ERROR'|'SUCCESSFUL'|'FAILED',
            'Type': 'REGISTER_DOMAIN'|'DELETE_DOMAIN'|'TRANSFER_IN_DOMAIN'|'UPDATE_DOMAIN_CONTACT'|'UPDATE_NAMESERVER'|'CHANGE_PRIVACY_PROTECTION'|'DOMAIN_LOCK',
            'SubmittedDate': datetime(2015, 1, 1)
        },
    ],
    'NextPageMarker': 'string'
}

Response Structure

(dict) –

The ListOperations response includes the following elements.
- Operations (list) –
  
  Lists summaries of the operations.
  - (dict) –
    
    OperationSummary includes the following elements.
    - OperationId (string) –
      
      Identifier returned to track the requested action.
    - Status (string) –
      
      The current status of the requested operation in the system.
    - Type (string) –
      
      Type of the action requested.
    - SubmittedDate (datetime) –
      
      The date when the request was submitted.
- NextPageMarker (string) –
  
  If there are more operations than you specified for MaxItems in the request, submit another request and include the value of NextPageMarker in the value of Marker .

list_tags_for_domain(**kwargs)¶

This operation returns all of the tags that are associated with the specified domain.

All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_domain(
    DomainName='string'
)

Parameters:

DomainName (string) –

[REQUIRED]

The domain for which you want to get a list of tags.

Return type: dict

Returns:

Response Syntax

{
    'TagList': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

(dict) –
The ListTagsForDomain response includes the following elements.
- TagList (list) –
  A list of the tags that are associated with the specified domain.
  - (dict) –
    Each tag includes the following elements.
    - Key (string) –
      The key (name) of a tag.
      
      Valid values: A-Z, a-z, 0-9, space, “.:/=+-@”
      
      Constraints: Each key can be 1-128 characters long.
    - Value (string) –
      The value of a tag.
      
      Valid values: A-Z, a-z, 0-9, space, “.:/=+-@”
      
      Constraints: Each value can be 0-256 characters long.

register_domain(**kwargs)¶

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 .

See also: AWS API Documentation

Request Syntax

response = client.register_domain(
    DomainName='string',
    IdnLangCode='string',
    DurationInYears=123,
    AutoRenew=True|False,
    AdminContact={
        'FirstName': 'string',
        'LastName': 'string',
        'ContactType': 'PERSON'|'COMPANY'|'ASSOCIATION'|'PUBLIC_BODY'|'RESELLER',
        'OrganizationName': 'string',
        'AddressLine1': 'string',
        'AddressLine2': 'string',
        'City': 'string',
        'State': 'string',
        'CountryCode': 'AD'|'AE'|'AF'|'AG'|'AI'|'AL'|'AM'|'AN'|'AO'|'AQ'|'AR'|'AS'|'AT'|'AU'|'AW'|'AZ'|'BA'|'BB'|'BD'|'BE'|'BF'|'BG'|'BH'|'BI'|'BJ'|'BL'|'BM'|'BN'|'BO'|'BR'|'BS'|'BT'|'BW'|'BY'|'BZ'|'CA'|'CC'|'CD'|'CF'|'CG'|'CH'|'CI'|'CK'|'CL'|'CM'|'CN'|'CO'|'CR'|'CU'|'CV'|'CX'|'CY'|'CZ'|'DE'|'DJ'|'DK'|'DM'|'DO'|'DZ'|'EC'|'EE'|'EG'|'ER'|'ES'|'ET'|'FI'|'FJ'|'FK'|'FM'|'FO'|'FR'|'GA'|'GB'|'GD'|'GE'|'GH'|'GI'|'GL'|'GM'|'GN'|'GQ'|'GR'|'GT'|'GU'|'GW'|'GY'|'HK'|'HN'|'HR'|'HT'|'HU'|'ID'|'IE'|'IL'|'IM'|'IN'|'IQ'|'IR'|'IS'|'IT'|'JM'|'JO'|'JP'|'KE'|'KG'|'KH'|'KI'|'KM'|'KN'|'KP'|'KR'|'KW'|'KY'|'KZ'|'LA'|'LB'|'LC'|'LI'|'LK'|'LR'|'LS'|'LT'|'LU'|'LV'|'LY'|'MA'|'MC'|'MD'|'ME'|'MF'|'MG'|'MH'|'MK'|'ML'|'MM'|'MN'|'MO'|'MP'|'MR'|'MS'|'MT'|'MU'|'MV'|'MW'|'MX'|'MY'|'MZ'|'NA'|'NC'|'NE'|'NG'|'NI'|'NL'|'NO'|'NP'|'NR'|'NU'|'NZ'|'OM'|'PA'|'PE'|'PF'|'PG'|'PH'|'PK'|'PL'|'PM'|'PN'|'PR'|'PT'|'PW'|'PY'|'QA'|'RO'|'RS'|'RU'|'RW'|'SA'|'SB'|'SC'|'SD'|'SE'|'SG'|'SH'|'SI'|'SK'|'SL'|'SM'|'SN'|'SO'|'SR'|'ST'|'SV'|'SY'|'SZ'|'TC'|'TD'|'TG'|'TH'|'TJ'|'TK'|'TL'|'TM'|'TN'|'TO'|'TR'|'TT'|'TV'|'TW'|'TZ'|'UA'|'UG'|'US'|'UY'|'UZ'|'VA'|'VC'|'VE'|'VG'|'VI'|'VN'|'VU'|'WF'|'WS'|'YE'|'YT'|'ZA'|'ZM'|'ZW',
        'ZipCode': 'string',
        'PhoneNumber': 'string',
        'Email': 'string',
        'Fax': 'string',
        'ExtraParams': [
            {
                'Name': 'DUNS_NUMBER'|'BRAND_NUMBER'|'BIRTH_DEPARTMENT'|'BIRTH_DATE_IN_YYYY_MM_DD'|'BIRTH_COUNTRY'|'BIRTH_CITY'|'DOCUMENT_NUMBER'|'AU_ID_NUMBER'|'AU_ID_TYPE'|'CA_LEGAL_TYPE'|'CA_BUSINESS_ENTITY_TYPE'|'ES_IDENTIFICATION'|'ES_IDENTIFICATION_TYPE'|'ES_LEGAL_FORM'|'FI_BUSINESS_NUMBER'|'FI_ID_NUMBER'|'IT_PIN'|'RU_PASSPORT_DATA'|'SE_ID_NUMBER'|'SG_ID_NUMBER'|'VAT_NUMBER',
                'Value': 'string'
            },
        ]
    },
    RegistrantContact={
        'FirstName': 'string',
        'LastName': 'string',
        'ContactType': 'PERSON'|'COMPANY'|'ASSOCIATION'|'PUBLIC_BODY'|'RESELLER',
        'OrganizationName': 'string',
        'AddressLine1': 'string',
        'AddressLine2': 'string',
        'City': 'string',
        'State': 'string',
        'CountryCode': 'AD'|'AE'|'AF'|'AG'|'AI'|'AL'|'AM'|'AN'|'AO'|'AQ'|'AR'|'AS'|'AT'|'AU'|'AW'|'AZ'|'BA'|'BB'|'BD'|'BE'|'BF'|'BG'|'BH'|'BI'|'BJ'|'BL'|'BM'|'BN'|'BO'|'BR'|'BS'|'BT'|'BW'|'BY'|'BZ'|'CA'|'CC'|'CD'|'CF'|'CG'|'CH'|'CI'|'CK'|'CL'|'CM'|'CN'|'CO'|'CR'|'CU'|'CV'|'CX'|'CY'|'CZ'|'DE'|'DJ'|'DK'|'DM'|'DO'|'DZ'|'EC'|'EE'|'EG'|'ER'|'ES'|'ET'|'FI'|'FJ'|'FK'|'FM'|'FO'|'FR'|'GA'|'GB'|'GD'|'GE'|'GH'|'GI'|'GL'|'GM'|'GN'|'GQ'|'GR'|'GT'|'GU'|'GW'|'GY'|'HK'|'HN'|'HR'|'HT'|'HU'|'ID'|'IE'|'IL'|'IM'|'IN'|'IQ'|'IR'|'IS'|'IT'|'JM'|'JO'|'JP'|'KE'|'KG'|'KH'|'KI'|'KM'|'KN'|'KP'|'KR'|'KW'|'KY'|'KZ'|'LA'|'LB'|'LC'|'LI'|'LK'|'LR'|'LS'|'LT'|'LU'|'LV'|'LY'|'MA'|'MC'|'MD'|'ME'|'MF'|'MG'|'MH'|'MK'|'ML'|'MM'|'MN'|'MO'|'MP'|'MR'|'MS'|'MT'|'MU'|'MV'|'MW'|'MX'|'MY'|'MZ'|'NA'|'NC'|'NE'|'NG'|'NI'|'NL'|'NO'|'NP'|'NR'|'NU'|'NZ'|'OM'|'PA'|'PE'|'PF'|'PG'|'PH'|'PK'|'PL'|'PM'|'PN'|'PR'|'PT'|'PW'|'PY'|'QA'|'RO'|'RS'|'RU'|'RW'|'SA'|'SB'|'SC'|'SD'|'SE'|'SG'|'SH'|'SI'|'SK'|'SL'|'SM'|'SN'|'SO'|'SR'|'ST'|'SV'|'SY'|'SZ'|'TC'|'TD'|'TG'|'TH'|'TJ'|'TK'|'TL'|'TM'|'TN'|'TO'|'TR'|'TT'|'TV'|'TW'|'TZ'|'UA'|'UG'|'US'|'UY'|'UZ'|'VA'|'VC'|'VE'|'VG'|'VI'|'VN'|'VU'|'WF'|'WS'|'YE'|'YT'|'ZA'|'ZM'|'ZW',
        'ZipCode': 'string',
        'PhoneNumber': 'string',
        'Email': 'string',
        'Fax': 'string',
        'ExtraParams': [
            {
                'Name': 'DUNS_NUMBER'|'BRAND_NUMBER'|'BIRTH_DEPARTMENT'|'BIRTH_DATE_IN_YYYY_MM_DD'|'BIRTH_COUNTRY'|'BIRTH_CITY'|'DOCUMENT_NUMBER'|'AU_ID_NUMBER'|'AU_ID_TYPE'|'CA_LEGAL_TYPE'|'CA_BUSINESS_ENTITY_TYPE'|'ES_IDENTIFICATION'|'ES_IDENTIFICATION_TYPE'|'ES_LEGAL_FORM'|'FI_BUSINESS_NUMBER'|'FI_ID_NUMBER'|'IT_PIN'|'RU_PASSPORT_DATA'|'SE_ID_NUMBER'|'SG_ID_NUMBER'|'VAT_NUMBER',
                'Value': 'string'
            },
        ]
    },
    TechContact={
        'FirstName': 'string',
        'LastName': 'string',
        'ContactType': 'PERSON'|'COMPANY'|'ASSOCIATION'|'PUBLIC_BODY'|'RESELLER',
        'OrganizationName': 'string',
        'AddressLine1': 'string',
        'AddressLine2': 'string',
        'City': 'string',
        'State': 'string',
        'CountryCode': 'AD'|'AE'|'AF'|'AG'|'AI'|'AL'|'AM'|'AN'|'AO'|'AQ'|'AR'|'AS'|'AT'|'AU'|'AW'|'AZ'|'BA'|'BB'|'BD'|'BE'|'BF'|'BG'|'BH'|'BI'|'BJ'|'BL'|'BM'|'BN'|'BO'|'BR'|'BS'|'BT'|'BW'|'BY'|'BZ'|'CA'|'CC'|'CD'|'CF'|'CG'|'CH'|'CI'|'CK'|'CL'|'CM'|'CN'|'CO'|'CR'|'CU'|'CV'|'CX'|'CY'|'CZ'|'DE'|'DJ'|'DK'|'DM'|'DO'|'DZ'|'EC'|'EE'|'EG'|'ER'|'ES'|'ET'|'FI'|'FJ'|'FK'|'FM'|'FO'|'FR'|'GA'|'GB'|'GD'|'GE'|'GH'|'GI'|'GL'|'GM'|'GN'|'GQ'|'GR'|'GT'|'GU'|'GW'|'GY'|'HK'|'HN'|'HR'|'HT'|'HU'|'ID'|'IE'|'IL'|'IM'|'IN'|'IQ'|'IR'|'IS'|'IT'|'JM'|'JO'|'JP'|'KE'|'KG'|'KH'|'KI'|'KM'|'KN'|'KP'|'KR'|'KW'|'KY'|'KZ'|'LA'|'LB'|'LC'|'LI'|'LK'|'LR'|'LS'|'LT'|'LU'|'LV'|'LY'|'MA'|'MC'|'MD'|'ME'|'MF'|'MG'|'MH'|'MK'|'ML'|'MM'|'MN'|'MO'|'MP'|'MR'|'MS'|'MT'|'MU'|'MV'|'MW'|'MX'|'MY'|'MZ'|'NA'|'NC'|'NE'|'NG'|'NI'|'NL'|'NO'|'NP'|'NR'|'NU'|'NZ'|'OM'|'PA'|'PE'|'PF'|'PG'|'PH'|'PK'|'PL'|'PM'|'PN'|'PR'|'PT'|'PW'|'PY'|'QA'|'RO'|'RS'|'RU'|'RW'|'SA'|'SB'|'SC'|'SD'|'SE'|'SG'|'SH'|'SI'|'SK'|'SL'|'SM'|'SN'|'SO'|'SR'|'ST'|'SV'|'SY'|'SZ'|'TC'|'TD'|'TG'|'TH'|'TJ'|'TK'|'TL'|'TM'|'TN'|'TO'|'TR'|'TT'|'TV'|'TW'|'TZ'|'UA'|'UG'|'US'|'UY'|'UZ'|'VA'|'VC'|'VE'|'VG'|'VI'|'VN'|'VU'|'WF'|'WS'|'YE'|'YT'|'ZA'|'ZM'|'ZW',
        'ZipCode': 'string',
        'PhoneNumber': 'string',
        'Email': 'string',
        'Fax': 'string',
        'ExtraParams': [
            {
                'Name': 'DUNS_NUMBER'|'BRAND_NUMBER'|'BIRTH_DEPARTMENT'|'BIRTH_DATE_IN_YYYY_MM_DD'|'BIRTH_COUNTRY'|'BIRTH_CITY'|'DOCUMENT_NUMBER'|'AU_ID_NUMBER'|'AU_ID_TYPE'|'CA_LEGAL_TYPE'|'CA_BUSINESS_ENTITY_TYPE'|'ES_IDENTIFICATION'|'ES_IDENTIFICATION_TYPE'|'ES_LEGAL_FORM'|'FI_BUSINESS_NUMBER'|'FI_ID_NUMBER'|'IT_PIN'|'RU_PASSPORT_DATA'|'SE_ID_NUMBER'|'SG_ID_NUMBER'|'VAT_NUMBER',
                'Value': 'string'
            },
        ]
    },
    PrivacyProtectAdminContact=True|False,
    PrivacyProtectRegistrantContact=True|False,
    PrivacyProtectTechContact=True|False
)

Parameters:

DomainName (string) –
[REQUIRED]

The domain name that you want to register.

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.
IdnLangCode (string) – Reserved for future use.
DurationInYears (integer) –
[REQUIRED]

The number of years that you want to register the domain for. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain. For the range of valid values for your domain, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide .

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

Default: true
AdminContact (dict) –
[REQUIRED]

Provides detailed contact information.
- FirstName (string) –
  First name of contact.
- LastName (string) –
  Last name of contact.
- ContactType (string) –
  Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON , you must enter an organization name, and you can’t enable privacy protection for the contact.
- OrganizationName (string) –
  Name of the organization for contact types other than PERSON .
- AddressLine1 (string) –
  First line of the contact’s address.
- AddressLine2 (string) –
  Second line of contact’s address, if any.
- City (string) –
  The city of the contact’s address.
- State (string) –
  The state or province of the contact’s city.
- CountryCode (string) –
  Code for the country of the contact’s address.
- ZipCode (string) –
  The zip or postal code of the contact’s address.
- PhoneNumber (string) –
  The phone number of the contact.
  
  Constraints: Phone number must be specified in the format “+[country dialing code].[number including any area code]”. For example, a US phone number might appear as "+1.1234567890" .
- Email (string) –
  Email address of the contact.
- Fax (string) –
  Fax number of the contact.
  
  Constraints: Phone number must be specified in the format “+[country dialing code].[number including any area code]”. For example, a US phone number might appear as "+1.1234567890" .
- ExtraParams (list) –
  A list of name-value pairs for parameters required by certain top-level domains.
  - (dict) –
    ExtraParam includes the following elements.
    - Name (string) – [REQUIRED]
      Name of the additional parameter required by the top-level domain.
    - Value (string) – [REQUIRED]
      Values corresponding to the additional parameter names required by some top-level domains.
RegistrantContact (dict) –
[REQUIRED]

Provides detailed contact information.
- FirstName (string) –
  First name of contact.
- LastName (string) –
  Last name of contact.
- ContactType (string) –
  Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON , you must enter an organization name, and you can’t enable privacy protection for the contact.
- OrganizationName (string) –
  Name of the organization for contact types other than PERSON .
- AddressLine1 (string) –
  First line of the contact’s address.
- AddressLine2 (string) –
  Second line of contact’s address, if any.
- City (string) –
  The city of the contact’s address.
- State (string) –
  The state or province of the contact’s city.
- CountryCode (string) –
  Code for the country of the contact’s address.
- ZipCode (string) –
  The zip or postal code of the contact’s address.
- PhoneNumber (string) –
  The phone number of the contact.
  
  Constraints: Phone number must be specified in the format “+[country dialing code].[number including any area code]”. For example, a US phone number might appear as "+1.1234567890" .
- Email (string) –
  Email address of the contact.
- Fax (string) –
  Fax number of the contact.
  
  Constraints: Phone number must be specified in the format “+[country dialing code].[number including any area code]”. For example, a US phone number might appear as "+1.1234567890" .
- ExtraParams (list) –
  A list of name-value pairs for parameters required by certain top-level domains.
  - (dict) –
    ExtraParam includes the following elements.
    - Name (string) – [REQUIRED]
      Name of the additional parameter required by the top-level domain.
    - Value (string) – [REQUIRED]
      Values corresponding to the additional parameter names required by some top-level domains.
TechContact (dict) –
[REQUIRED]

Provides detailed contact information.
- FirstName (string) –
  First name of contact.
- LastName (string) –
  Last name of contact.
- ContactType (string) –
  Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON , you must enter an organization name, and you can’t enable privacy protection for the contact.
- OrganizationName (string) –
  Name of the organization for contact types other than PERSON .
- AddressLine1 (string) –
  First line of the contact’s address.
- AddressLine2 (string) –
  Second line of contact’s address, if any.
- City (string) –
  The city of the contact’s address.
- State (string) –
  The state or province of the contact’s city.
- CountryCode (string) –
  Code for the country of the contact’s address.
- ZipCode (string) –
  The zip or postal code of the contact’s address.
- PhoneNumber (string) –
  The phone number of the contact.
  
  Constraints: Phone number must be specified in the format “+[country dialing code].[number including any area code]”. For example, a US phone number might appear as "+1.1234567890" .
- Email (string) –
  Email address of the contact.
- Fax (string) –
  Fax number of the contact.
  
  Constraints: Phone number must be specified in the format “+[country dialing code].[number including any area code]”. For example, a US phone number might appear as "+1.1234567890" .
- ExtraParams (list) –
  A list of name-value pairs for parameters required by certain top-level domains.
  - (dict) –
    ExtraParam includes the following elements.
    - Name (string) – [REQUIRED]
      Name of the additional parameter required by the top-level domain.
    - Value (string) – [REQUIRED]
      Values corresponding to the additional parameter names required by some top-level domains.
PrivacyProtectAdminContact (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.

Default: true
PrivacyProtectRegistrantContact (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.

Default: true
PrivacyProtectTechContact (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.

Default: true

Return type:

dict

Returns:

Response Syntax

{
    'OperationId': 'string'
}

Response Structure

(dict) –

The RegisterDomain response includes the following element.
- OperationId (string) –
  
  Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail .

renew_domain(**kwargs)¶

This operation renews a domain for the specified number of years. The cost of renewing your domain is billed to your AWS account.

We recommend that you renew your domain several weeks before the expiration date. Some TLD registries delete domains before the expiration date if you haven’t renewed far enough in advance. For more information about renewing domain registration, see Renewing Registration for a Domain in the Amazon Route 53 Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.renew_domain(
    DomainName='string',
    DurationInYears=123,
    CurrentExpiryYear=123
)

Parameters:

DomainName (string) –
[REQUIRED]

The name of the domain that you want to renew.
DurationInYears (integer) –
The number of years that you want to renew the domain for. The maximum number of years depends on the top-level domain. For the range of valid values for your domain, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide .

Default: 1
CurrentExpiryYear (integer) –
[REQUIRED]

The year when the registration for the domain is set to expire. This value must match the current expiration date for the domain.

Return type:

dict

Returns:

Response Syntax

{
    'OperationId': 'string'
}

Response Structure

(dict) –
- OperationId (string) –
  
  The identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail .

resend_contact_reachability_email(**kwargs)¶

For operations that require confirmation that the email address for the registrant contact is valid, such as registering a new domain, this operation resends the confirmation email to the current email address for the registrant contact.

See also: AWS API Documentation

Request Syntax

response = client.resend_contact_reachability_email(
    domainName='string'
)

Parameters: domainName (string) – The name of the domain for which you want Amazon Route 53 to resend a confirmation email to the registrant contact.

Return type: dict

Returns:

Response Syntax

{
    'domainName': 'string',
    'emailAddress': 'string',
    'isAlreadyVerified': True|False
}

Response Structure

(dict) –
- domainName (string) –
  The domain name for which you requested a confirmation email.
- emailAddress (string) –
  The email address for the registrant contact at the time that we sent the verification email.
- isAlreadyVerified (boolean) –
  
  True if the email address for the registrant contact has already been verified, and false otherwise. If the email address has already been verified, we don’t send another confirmation email.

retrieve_domain_auth_code(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

response = client.retrieve_domain_auth_code(
    DomainName='string'
)

Parameters:

DomainName (string) –

[REQUIRED]

The name of the domain that you want to get an authorization code for.

Return type: dict

Returns:

Response Syntax

{
    'AuthCode': 'string'
}

Response Structure

(dict) –
The RetrieveDomainAuthCode response includes the following element.
- AuthCode (string) –
  The authorization code for the domain.

transfer_domain(**kwargs)¶

This operation transfers a domain from another registrar to Amazon Route 53. When the transfer is complete, the domain is registered with the AWS registrar partner, Gandi.

For transfer requirements, a detailed procedure, and information about viewing the status of a domain transfer, see Transferring Registration for a Domain to Amazon Route 53 in the Amazon Route 53 Developer Guide .

If the registrar for your domain is also the DNS service provider for the domain, we highly recommend that you consider transferring your DNS service to Amazon Route 53 or to another DNS service provider before you transfer your registration. Some registrars provide free DNS service when you purchase a domain registration. When you transfer the registration, the previous registrar will not renew your domain registration and could end your DNS service at any time.

Warning

If the registrar for your domain is also the DNS service provider for the domain and you don’t transfer DNS service to another provider, your website, email, and the web applications associated with the domain might become unavailable.

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 transfer doesn’t complete successfully, the domain registrant will be notified by email.

See also: AWS API Documentation

Request Syntax

response = client.transfer_domain(
    DomainName='string',
    IdnLangCode='string',
    DurationInYears=123,
    Nameservers=[
        {
            'Name': 'string',
            'GlueIps': [
                'string',
            ]
        },
    ],
    AuthCode='string',
    AutoRenew=True|False,
    AdminContact={
        'FirstName': 'string',
        'LastName': 'string',
        'ContactType': 'PERSON'|'COMPANY'|'ASSOCIATION'|'PUBLIC_BODY'|'RESELLER',
        'OrganizationName': 'string',
        'AddressLine1': 'string',
        'AddressLine2': 'string',
        'City': 'string',
        'State': 'string',
        'CountryCode': 'AD'|'AE'|'AF'|'AG'|'AI'|'AL'|'AM'|'AN'|'AO'|'AQ'|'AR'|'AS'|'AT'|'AU'|'AW'|'AZ'|'BA'|'BB'|'BD'|'BE'|'BF'|'BG'|'BH'|'BI'|'BJ'|'BL'|'BM'|'BN'|'BO'|'BR'|'BS'|'BT'|'BW'|'BY'|'BZ'|'CA'|'CC'|'CD'|'CF'|'CG'|'CH'|'CI'|'CK'|'CL'|'CM'|'CN'|'CO'|'CR'|'CU'|'CV'|'CX'|'CY'|'CZ'|'DE'|'DJ'|'DK'|'DM'|'DO'|'DZ'|'EC'|'EE'|'EG'|'ER'|'ES'|'ET'|'FI'|'FJ'|'FK'|'FM'|'FO'|'FR'|'GA'|'GB'|'GD'|'GE'|'GH'|'GI'|'GL'|'GM'|'GN'|'GQ'|'GR'|'GT'|'GU'|'GW'|'GY'|'HK'|'HN'|'HR'|'HT'|'HU'|'ID'|'IE'|'IL'|'IM'|'IN'|'IQ'|'IR'|'IS'|'IT'|'JM'|'JO'|'JP'|'KE'|'KG'|'KH'|'KI'|'KM'|'KN'|'KP'|'KR'|'KW'|'KY'|'KZ'|'LA'|'LB'|'LC'|'LI'|'LK'|'LR'|'LS'|'LT'|'LU'|'LV'|'LY'|'MA'|'MC'|'MD'|'ME'|'MF'|'MG'|'MH'|'MK'|'ML'|'MM'|'MN'|'MO'|'MP'|'MR'|'MS'|'MT'|'MU'|'MV'|'MW'|'MX'|'MY'|'MZ'|'NA'|'NC'|'NE'|'NG'|'NI'|'NL'|'NO'|'NP'|'NR'|'NU'|'NZ'|'OM'|'PA'|'PE'|'PF'|'PG'|'PH'|'PK'|'PL'|'PM'|'PN'|'PR'|'PT'|'PW'|'PY'|'QA'|'RO'|'RS'|'RU'|'RW'|'SA'|'SB'|'SC'|'SD'|'SE'|'SG'|'SH'|'SI'|'SK'|'SL'|'SM'|'SN'|'SO'|'SR'|'ST'|'SV'|'SY'|'SZ'|'TC'|'TD'|'TG'|'TH'|'TJ'|'TK'|'TL'|'TM'|'TN'|'TO'|'TR'|'TT'|'TV'|'TW'|'TZ'|'UA'|'UG'|'US'|'UY'|'UZ'|'VA'|'VC'|'VE'|'VG'|'VI'|'VN'|'VU'|'WF'|'WS'|'YE'|'YT'|'ZA'|'ZM'|'ZW',
        'ZipCode': 'string',
        'PhoneNumber': 'string',
        'Email': 'string',
        'Fax': 'string',
        'ExtraParams': [
            {
                'Name': 'DUNS_NUMBER'|'BRAND_NUMBER'|'BIRTH_DEPARTMENT'|'BIRTH_DATE_IN_YYYY_MM_DD'|'BIRTH_COUNTRY'|'BIRTH_CITY'|'DOCUMENT_NUMBER'|'AU_ID_NUMBER'|'AU_ID_TYPE'|'CA_LEGAL_TYPE'|'CA_BUSINESS_ENTITY_TYPE'|'ES_IDENTIFICATION'|'ES_IDENTIFICATION_TYPE'|'ES_LEGAL_FORM'|'FI_BUSINESS_NUMBER'|'FI_ID_NUMBER'|'IT_PIN'|'RU_PASSPORT_DATA'|'SE_ID_NUMBER'|'SG_ID_NUMBER'|'VAT_NUMBER',
                'Value': 'string'
            },
        ]
    },
    RegistrantContact={
        'FirstName': 'string',
        'LastName': 'string',
        'ContactType': 'PERSON'|'COMPANY'|'ASSOCIATION'|'PUBLIC_BODY'|'RESELLER',
        'OrganizationName': 'string',
        'AddressLine1': 'string',
        'AddressLine2': 'string',
        'City': 'string',
        'State': 'string',
        'CountryCode': 'AD'|'AE'|'AF'|'AG'|'AI'|'AL'|'AM'|'AN'|'AO'|'AQ'|'AR'|'AS'|'AT'|'AU'|'AW'|'AZ'|'BA'|'BB'|'BD'|'BE'|'BF'|'BG'|'BH'|'BI'|'BJ'|'BL'|'BM'|'BN'|'BO'|'BR'|'BS'|'BT'|'BW'|'BY'|'BZ'|'CA'|'CC'|'CD'|'CF'|'CG'|'CH'|'CI'|'CK'|'CL'|'CM'|'CN'|'CO'|'CR'|'CU'|'CV'|'CX'|'CY'|'CZ'|'DE'|'DJ'|'DK'|'DM'|'DO'|'DZ'|'EC'|'EE'|'EG'|'ER'|'ES'|'ET'|'FI'|'FJ'|'FK'|'FM'|'FO'|'FR'|'GA'|'GB'|'GD'|'GE'|'GH'|'GI'|'GL'|'GM'|'GN'|'GQ'|'GR'|'GT'|'GU'|'GW'|'GY'|'HK'|'HN'|'HR'|'HT'|'HU'|'ID'|'IE'|'IL'|'IM'|'IN'|'IQ'|'IR'|'IS'|'IT'|'JM'|'JO'|'JP'|'KE'|'KG'|'KH'|'KI'|'KM'|'KN'|'KP'|'KR'|'KW'|'KY'|'KZ'|'LA'|'LB'|'LC'|'LI'|'LK'|'LR'|'LS'|'LT'|'LU'|'LV'|'LY'|'MA'|'MC'|'MD'|'ME'|'MF'|'MG'|'MH'|'MK'|'ML'|'MM'|'MN'|'MO'|'MP'|'MR'|'MS'|'MT'|'MU'|'MV'|'MW'|'MX'|'MY'|'MZ'|'NA'|'NC'|'NE'|'NG'|'NI'|'NL'|'NO'|'NP'|'NR'|'NU'|'NZ'|'OM'|'PA'|'PE'|'PF'|'PG'|'PH'|'PK'|'PL'|'PM'|'PN'|'PR'|'PT'|'PW'|'PY'|'QA'|'RO'|'RS'|'RU'|'RW'|'SA'|'SB'|'SC'|'SD'|'SE'|'SG'|'SH'|'SI'|'SK'|'SL'|'SM'|'SN'|'SO'|'SR'|'ST'|'SV'|'SY'|'SZ'|'TC'|'TD'|'TG'|'TH'|'TJ'|'TK'|'TL'|'TM'|'TN'|'TO'|'TR'|'TT'|'TV'|'TW'|'TZ'|'UA'|'UG'|'US'|'UY'|'UZ'|'VA'|'VC'|'VE'|'VG'|'VI'|'VN'|'VU'|'WF'|'WS'|'YE'|'YT'|'ZA'|'ZM'|'ZW',
        'ZipCode': 'string',
        'PhoneNumber': 'string',
        'Email': 'string',
        'Fax': 'string',
        'ExtraParams': [
            {
                'Name': 'DUNS_NUMBER'|'BRAND_NUMBER'|'BIRTH_DEPARTMENT'|'BIRTH_DATE_IN_YYYY_MM_DD'|'BIRTH_COUNTRY'|'BIRTH_CITY'|'DOCUMENT_NUMBER'|'AU_ID_NUMBER'|'AU_ID_TYPE'|'CA_LEGAL_TYPE'|'CA_BUSINESS_ENTITY_TYPE'|'ES_IDENTIFICATION'|'ES_IDENTIFICATION_TYPE'|'ES_LEGAL_FORM'|'FI_BUSINESS_NUMBER'|'FI_ID_NUMBER'|'IT_PIN'|'RU_PASSPORT_DATA'|'SE_ID_NUMBER'|'SG_ID_NUMBER'|'VAT_NUMBER',
                'Value': 'string'
            },
        ]
    },
    TechContact={
        'FirstName': 'string',
        'LastName': 'string',
        'ContactType': 'PERSON'|'COMPANY'|'ASSOCIATION'|'PUBLIC_BODY'|'RESELLER',
        'OrganizationName': 'string',
        'AddressLine1': 'string',
        'AddressLine2': 'string',
        'City': 'string',
        'State': 'string',
        'CountryCode': 'AD'|'AE'|'AF'|'AG'|'AI'|'AL'|'AM'|'AN'|'AO'|'AQ'|'AR'|'AS'|'AT'|'AU'|'AW'|'AZ'|'BA'|'BB'|'BD'|'BE'|'BF'|'BG'|'BH'|'BI'|'BJ'|'BL'|'BM'|'BN'|'BO'|'BR'|'BS'|'BT'|'BW'|'BY'|'BZ'|'CA'|'CC'|'CD'|'CF'|'CG'|'CH'|'CI'|'CK'|'CL'|'CM'|'CN'|'CO'|'CR'|'CU'|'CV'|'CX'|'CY'|'CZ'|'DE'|'DJ'|'DK'|'DM'|'DO'|'DZ'|'EC'|'EE'|'EG'|'ER'|'ES'|'ET'|'FI'|'FJ'|'FK'|'FM'|'FO'|'FR'|'GA'|'GB'|'GD'|'GE'|'GH'|'GI'|'GL'|'GM'|'GN'|'GQ'|'GR'|'GT'|'GU'|'GW'|'GY'|'HK'|'HN'|'HR'|'HT'|'HU'|'ID'|'IE'|'IL'|'IM'|'IN'|'IQ'|'IR'|'IS'|'IT'|'JM'|'JO'|'JP'|'KE'|'KG'|'KH'|'KI'|'KM'|'KN'|'KP'|'KR'|'KW'|'KY'|'KZ'|'LA'|'LB'|'LC'|'LI'|'LK'|'LR'|'LS'|'LT'|'LU'|'LV'|'LY'|'MA'|'MC'|'MD'|'ME'|'MF'|'MG'|'MH'|'MK'|'ML'|'MM'|'MN'|'MO'|'MP'|'MR'|'MS'|'MT'|'MU'|'MV'|'MW'|'MX'|'MY'|'MZ'|'NA'|'NC'|'NE'|'NG'|'NI'|'NL'|'NO'|'NP'|'NR'|'NU'|'NZ'|'OM'|'PA'|'PE'|'PF'|'PG'|'PH'|'PK'|'PL'|'PM'|'PN'|'PR'|'PT'|'PW'|'PY'|'QA'|'RO'|'RS'|'RU'|'RW'|'SA'|'SB'|'SC'|'SD'|'SE'|'SG'|'SH'|'SI'|'SK'|'SL'|'SM'|'SN'|'SO'|'SR'|'ST'|'SV'|'SY'|'SZ'|'TC'|'TD'|'TG'|'TH'|'TJ'|'TK'|'TL'|'TM'|'TN'|'TO'|'TR'|'TT'|'TV'|'TW'|'TZ'|'UA'|'UG'|'US'|'UY'|'UZ'|'VA'|'VC'|'VE'|'VG'|'VI'|'VN'|'VU'|'WF'|'WS'|'YE'|'YT'|'ZA'|'ZM'|'ZW',
        'ZipCode': 'string',
        'PhoneNumber': 'string',
        'Email': 'string',
        'Fax': 'string',
        'ExtraParams': [
            {
                'Name': 'DUNS_NUMBER'|'BRAND_NUMBER'|'BIRTH_DEPARTMENT'|'BIRTH_DATE_IN_YYYY_MM_DD'|'BIRTH_COUNTRY'|'BIRTH_CITY'|'DOCUMENT_NUMBER'|'AU_ID_NUMBER'|'AU_ID_TYPE'|'CA_LEGAL_TYPE'|'CA_BUSINESS_ENTITY_TYPE'|'ES_IDENTIFICATION'|'ES_IDENTIFICATION_TYPE'|'ES_LEGAL_FORM'|'FI_BUSINESS_NUMBER'|'FI_ID_NUMBER'|'IT_PIN'|'RU_PASSPORT_DATA'|'SE_ID_NUMBER'|'SG_ID_NUMBER'|'VAT_NUMBER',
                'Value': 'string'
            },
        ]
    },
    PrivacyProtectAdminContact=True|False,
    PrivacyProtectRegistrantContact=True|False,
    PrivacyProtectTechContact=True|False
)

Parameters:

DomainName (string) –
[REQUIRED]

The name of the domain that you want to transfer to Amazon Route 53.

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.
IdnLangCode (string) – Reserved for future use.
DurationInYears (integer) –
[REQUIRED]

The number of years that you want to register the domain for. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain.

Default: 1
Nameservers (list) –
Contains details for the host and glue IP addresses.
- (dict) –
  Nameserver includes the following elements.
  - Name (string) – [REQUIRED]
    The fully qualified host name of the name server.
    
    Constraint: Maximum 255 characters
  - GlueIps (list) –
    Glue IP address of a name server entry. Glue IP addresses are required only when the name of the name server is a subdomain of the domain. For example, if your domain is example.com and the name server for the domain is ns.example.com, you need to specify the IP address for ns.example.com.
    
    Constraints: The list can contain only one IPv4 and one IPv6 address.
    - (string) –
AuthCode (string) – The authorization code for the domain. You get this value from the current registrar.
AutoRenew (boolean) –
Indicates whether the domain will be automatically renewed (true) or not (false). Autorenewal only takes effect after the account is charged.

Default: true
AdminContact (dict) –
[REQUIRED]

Provides detailed contact information.
- FirstName (string) –
  First name of contact.
- LastName (string) –
  Last name of contact.
- ContactType (string) –
  Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON , you must enter an organization name, and you can’t enable privacy protection for the contact.
- OrganizationName (string) –
  Name of the organization for contact types other than PERSON .
- AddressLine1 (string) –
  First line of the contact’s address.
- AddressLine2 (string) –
  Second line of contact’s address, if any.
- City (string) –
  The city of the contact’s address.
- State (string) –
  The state or province of the contact’s city.
- CountryCode (string) –
  Code for the country of the contact’s address.
- ZipCode (string) –
  The zip or postal code of the contact’s address.
- PhoneNumber (string) –
  The phone number of the contact.
  
  Constraints: Phone number must be specified in the format “+[country dialing code].[number including any area code]”. For example, a US phone number might appear as "+1.1234567890" .
- Email (string) –
  Email address of the contact.
- Fax (string) –
  Fax number of the contact.
  
  Constraints: Phone number must be specified in the format “+[country dialing code].[number including any area code]”. For example, a US phone number might appear as "+1.1234567890" .
- ExtraParams (list) –
  A list of name-value pairs for parameters required by certain top-level domains.
  - (dict) –
    ExtraParam includes the following elements.
    - Name (string) – [REQUIRED]
      Name of the additional parameter required by the top-level domain.
    - Value (string) – [REQUIRED]
      Values corresponding to the additional parameter names required by some top-level domains.
RegistrantContact (dict) –
[REQUIRED]

Provides detailed contact information.
- FirstName (string) –
  First name of contact.
- LastName (string) –
  Last name of contact.
- ContactType (string) –
  Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON , you must enter an organization name, and you can’t enable privacy protection for the contact.
- OrganizationName (string) –
  Name of the organization for contact types other than PERSON .
- AddressLine1 (string) –
  First line of the contact’s address.
- AddressLine2 (string) –
  Second line of contact’s address, if any.
- City (string) –
  The city of the contact’s address.
- State (string) –
  The state or province of the contact’s city.
- CountryCode (string) –
  Code for the country of the contact’s address.
- ZipCode (string) –
  The zip or postal code of the contact’s address.
- PhoneNumber (string) –
  The phone number of the contact.
  
  Constraints: Phone number must be specified in the format “+[country dialing code].[number including any area code]”. For example, a US phone number might appear as "+1.1234567890" .
- Email (string) –
  Email address of the contact.
- Fax (string) –
  Fax number of the contact.
  
  Constraints: Phone number must be specified in the format “+[country dialing code].[number including any area code]”. For example, a US phone number might appear as "+1.1234567890" .
- ExtraParams (list) –
  A list of name-value pairs for parameters required by certain top-level domains.
  - (dict) –
    ExtraParam includes the following elements.
    - Name (string) – [REQUIRED]
      Name of the additional parameter required by the top-level domain.
    - Value (string) – [REQUIRED]
      Values corresponding to the additional parameter names required by some top-level domains.
TechContact (dict) –
[REQUIRED]

Provides detailed contact information.
- FirstName (string) –
  First name of contact.
- LastName (string) –
  Last name of contact.
- ContactType (string) –
  Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON , you must enter an organization name, and you can’t enable privacy protection for the contact.
- OrganizationName (string) –
  Name of the organization for contact types other than PERSON .
- AddressLine1 (string) –
  First line of the contact’s address.
- AddressLine2 (string) –
  Second line of contact’s address, if any.
- City (string) –
  The city of the contact’s address.
- State (string) –
  The state or province of the contact’s city.
- CountryCode (string) –
  Code for the country of the contact’s address.
- ZipCode (string) –
  The zip or postal code of the contact’s address.
- PhoneNumber (string) –
  The phone number of the contact.
  
  Constraints: Phone number must be specified in the format “+[country dialing code].[number including any area code]”. For example, a US phone number might appear as "+1.1234567890" .
- Email (string) –
  Email address of the contact.
- Fax (string) –
  Fax number of the contact.
  
  Constraints: Phone number must be specified in the format “+[country dialing code].[number including any area code]”. For example, a US phone number might appear as "+1.1234567890" .
- ExtraParams (list) –
  A list of name-value pairs for parameters required by certain top-level domains.
  - (dict) –
    ExtraParam includes the following elements.
    - Name (string) – [REQUIRED]
      Name of the additional parameter required by the top-level domain.
    - Value (string) – [REQUIRED]
      Values corresponding to the additional parameter names required by some top-level domains.
PrivacyProtectAdminContact (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.

Default: true
PrivacyProtectRegistrantContact (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.

Default: true
PrivacyProtectTechContact (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.

Default: true

Return type:

dict

Returns:

Response Syntax

{
    'OperationId': 'string'
}

Response Structure

(dict) –

The TranserDomain response includes the following element.
- OperationId (string) –
  
  Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail .

update_domain_contact(**kwargs)¶

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.

See also: AWS API Documentation

Request Syntax

response = client.update_domain_contact(
    DomainName='string',
    AdminContact={
        'FirstName': 'string',
        'LastName': 'string',
        'ContactType': 'PERSON'|'COMPANY'|'ASSOCIATION'|'PUBLIC_BODY'|'RESELLER',
        'OrganizationName': 'string',
        'AddressLine1': 'string',
        'AddressLine2': 'string',
        'City': 'string',
        'State': 'string',
        'CountryCode': 'AD'|'AE'|'AF'|'AG'|'AI'|'AL'|'AM'|'AN'|'AO'|'AQ'|'AR'|'AS'|'AT'|'AU'|'AW'|'AZ'|'BA'|'BB'|'BD'|'BE'|'BF'|'BG'|'BH'|'BI'|'BJ'|'BL'|'BM'|'BN'|'BO'|'BR'|'BS'|'BT'|'BW'|'BY'|'BZ'|'CA'|'CC'|'CD'|'CF'|'CG'|'CH'|'CI'|'CK'|'CL'|'CM'|'CN'|'CO'|'CR'|'CU'|'CV'|'CX'|'CY'|'CZ'|'DE'|'DJ'|'DK'|'DM'|'DO'|'DZ'|'EC'|'EE'|'EG'|'ER'|'ES'|'ET'|'FI'|'FJ'|'FK'|'FM'|'FO'|'FR'|'GA'|'GB'|'GD'|'GE'|'GH'|'GI'|'GL'|'GM'|'GN'|'GQ'|'GR'|'GT'|'GU'|'GW'|'GY'|'HK'|'HN'|'HR'|'HT'|'HU'|'ID'|'IE'|'IL'|'IM'|'IN'|'IQ'|'IR'|'IS'|'IT'|'JM'|'JO'|'JP'|'KE'|'KG'|'KH'|'KI'|'KM'|'KN'|'KP'|'KR'|'KW'|'KY'|'KZ'|'LA'|'LB'|'LC'|'LI'|'LK'|'LR'|'LS'|'LT'|'LU'|'LV'|'LY'|'MA'|'MC'|'MD'|'ME'|'MF'|'MG'|'MH'|'MK'|'ML'|'MM'|'MN'|'MO'|'MP'|'MR'|'MS'|'MT'|'MU'|'MV'|'MW'|'MX'|'MY'|'MZ'|'NA'|'NC'|'NE'|'NG'|'NI'|'NL'|'NO'|'NP'|'NR'|'NU'|'NZ'|'OM'|'PA'|'PE'|'PF'|'PG'|'PH'|'PK'|'PL'|'PM'|'PN'|'PR'|'PT'|'PW'|'PY'|'QA'|'RO'|'RS'|'RU'|'RW'|'SA'|'SB'|'SC'|'SD'|'SE'|'SG'|'SH'|'SI'|'SK'|'SL'|'SM'|'SN'|'SO'|'SR'|'ST'|'SV'|'SY'|'SZ'|'TC'|'TD'|'TG'|'TH'|'TJ'|'TK'|'TL'|'TM'|'TN'|'TO'|'TR'|'TT'|'TV'|'TW'|'TZ'|'UA'|'UG'|'US'|'UY'|'UZ'|'VA'|'VC'|'VE'|'VG'|'VI'|'VN'|'VU'|'WF'|'WS'|'YE'|'YT'|'ZA'|'ZM'|'ZW',
        'ZipCode': 'string',
        'PhoneNumber': 'string',
        'Email': 'string',
        'Fax': 'string',
        'ExtraParams': [
            {
                'Name': 'DUNS_NUMBER'|'BRAND_NUMBER'|'BIRTH_DEPARTMENT'|'BIRTH_DATE_IN_YYYY_MM_DD'|'BIRTH_COUNTRY'|'BIRTH_CITY'|'DOCUMENT_NUMBER'|'AU_ID_NUMBER'|'AU_ID_TYPE'|'CA_LEGAL_TYPE'|'CA_BUSINESS_ENTITY_TYPE'|'ES_IDENTIFICATION'|'ES_IDENTIFICATION_TYPE'|'ES_LEGAL_FORM'|'FI_BUSINESS_NUMBER'|'FI_ID_NUMBER'|'IT_PIN'|'RU_PASSPORT_DATA'|'SE_ID_NUMBER'|'SG_ID_NUMBER'|'VAT_NUMBER',
                'Value': 'string'
            },
        ]
    },
    RegistrantContact={
        'FirstName': 'string',
        'LastName': 'string',
        'ContactType': 'PERSON'|'COMPANY'|'ASSOCIATION'|'PUBLIC_BODY'|'RESELLER',
        'OrganizationName': 'string',
        'AddressLine1': 'string',
        'AddressLine2': 'string',
        'City': 'string',
        'State': 'string',
        'CountryCode': 'AD'|'AE'|'AF'|'AG'|'AI'|'AL'|'AM'|'AN'|'AO'|'AQ'|'AR'|'AS'|'AT'|'AU'|'AW'|'AZ'|'BA'|'BB'|'BD'|'BE'|'BF'|'BG'|'BH'|'BI'|'BJ'|'BL'|'BM'|'BN'|'BO'|'BR'|'BS'|'BT'|'BW'|'BY'|'BZ'|'CA'|'CC'|'CD'|'CF'|'CG'|'CH'|'CI'|'CK'|'CL'|'CM'|'CN'|'CO'|'CR'|'CU'|'CV'|'CX'|'CY'|'CZ'|'DE'|'DJ'|'DK'|'DM'|'DO'|'DZ'|'EC'|'EE'|'EG'|'ER'|'ES'|'ET'|'FI'|'FJ'|'FK'|'FM'|'FO'|'FR'|'GA'|'GB'|'GD'|'GE'|'GH'|'GI'|'GL'|'GM'|'GN'|'GQ'|'GR'|'GT'|'GU'|'GW'|'GY'|'HK'|'HN'|'HR'|'HT'|'HU'|'ID'|'IE'|'IL'|'IM'|'IN'|'IQ'|'IR'|'IS'|'IT'|'JM'|'JO'|'JP'|'KE'|'KG'|'KH'|'KI'|'KM'|'KN'|'KP'|'KR'|'KW'|'KY'|'KZ'|'LA'|'LB'|'LC'|'LI'|'LK'|'LR'|'LS'|'LT'|'LU'|'LV'|'LY'|'MA'|'MC'|'MD'|'ME'|'MF'|'MG'|'MH'|'MK'|'ML'|'MM'|'MN'|'MO'|'MP'|'MR'|'MS'|'MT'|'MU'|'MV'|'MW'|'MX'|'MY'|'MZ'|'NA'|'NC'|'NE'|'NG'|'NI'|'NL'|'NO'|'NP'|'NR'|'NU'|'NZ'|'OM'|'PA'|'PE'|'PF'|'PG'|'PH'|'PK'|'PL'|'PM'|'PN'|'PR'|'PT'|'PW'|'PY'|'QA'|'RO'|'RS'|'RU'|'RW'|'SA'|'SB'|'SC'|'SD'|'SE'|'SG'|'SH'|'SI'|'SK'|'SL'|'SM'|'SN'|'SO'|'SR'|'ST'|'SV'|'SY'|'SZ'|'TC'|'TD'|'TG'|'TH'|'TJ'|'TK'|'TL'|'TM'|'TN'|'TO'|'TR'|'TT'|'TV'|'TW'|'TZ'|'UA'|'UG'|'US'|'UY'|'UZ'|'VA'|'VC'|'VE'|'VG'|'VI'|'VN'|'VU'|'WF'|'WS'|'YE'|'YT'|'ZA'|'ZM'|'ZW',
        'ZipCode': 'string',
        'PhoneNumber': 'string',
        'Email': 'string',
        'Fax': 'string',
        'ExtraParams': [
            {
                'Name': 'DUNS_NUMBER'|'BRAND_NUMBER'|'BIRTH_DEPARTMENT'|'BIRTH_DATE_IN_YYYY_MM_DD'|'BIRTH_COUNTRY'|'BIRTH_CITY'|'DOCUMENT_NUMBER'|'AU_ID_NUMBER'|'AU_ID_TYPE'|'CA_LEGAL_TYPE'|'CA_BUSINESS_ENTITY_TYPE'|'ES_IDENTIFICATION'|'ES_IDENTIFICATION_TYPE'|'ES_LEGAL_FORM'|'FI_BUSINESS_NUMBER'|'FI_ID_NUMBER'|'IT_PIN'|'RU_PASSPORT_DATA'|'SE_ID_NUMBER'|'SG_ID_NUMBER'|'VAT_NUMBER',
                'Value': 'string'
            },
        ]
    },
    TechContact={
        'FirstName': 'string',
        'LastName': 'string',
        'ContactType': 'PERSON'|'COMPANY'|'ASSOCIATION'|'PUBLIC_BODY'|'RESELLER',
        'OrganizationName': 'string',
        'AddressLine1': 'string',
        'AddressLine2': 'string',
        'City': 'string',
        'State': 'string',
        'CountryCode': 'AD'|'AE'|'AF'|'AG'|'AI'|'AL'|'AM'|'AN'|'AO'|'AQ'|'AR'|'AS'|'AT'|'AU'|'AW'|'AZ'|'BA'|'BB'|'BD'|'BE'|'BF'|'BG'|'BH'|'BI'|'BJ'|'BL'|'BM'|'BN'|'BO'|'BR'|'BS'|'BT'|'BW'|'BY'|'BZ'|'CA'|'CC'|'CD'|'CF'|'CG'|'CH'|'CI'|'CK'|'CL'|'CM'|'CN'|'CO'|'CR'|'CU'|'CV'|'CX'|'CY'|'CZ'|'DE'|'DJ'|'DK'|'DM'|'DO'|'DZ'|'EC'|'EE'|'EG'|'ER'|'ES'|'ET'|'FI'|'FJ'|'FK'|'FM'|'FO'|'FR'|'GA'|'GB'|'GD'|'GE'|'GH'|'GI'|'GL'|'GM'|'GN'|'GQ'|'GR'|'GT'|'GU'|'GW'|'GY'|'HK'|'HN'|'HR'|'HT'|'HU'|'ID'|'IE'|'IL'|'IM'|'IN'|'IQ'|'IR'|'IS'|'IT'|'JM'|'JO'|'JP'|'KE'|'KG'|'KH'|'KI'|'KM'|'KN'|'KP'|'KR'|'KW'|'KY'|'KZ'|'LA'|'LB'|'LC'|'LI'|'LK'|'LR'|'LS'|'LT'|'LU'|'LV'|'LY'|'MA'|'MC'|'MD'|'ME'|'MF'|'MG'|'MH'|'MK'|'ML'|'MM'|'MN'|'MO'|'MP'|'MR'|'MS'|'MT'|'MU'|'MV'|'MW'|'MX'|'MY'|'MZ'|'NA'|'NC'|'NE'|'NG'|'NI'|'NL'|'NO'|'NP'|'NR'|'NU'|'NZ'|'OM'|'PA'|'PE'|'PF'|'PG'|'PH'|'PK'|'PL'|'PM'|'PN'|'PR'|'PT'|'PW'|'PY'|'QA'|'RO'|'RS'|'RU'|'RW'|'SA'|'SB'|'SC'|'SD'|'SE'|'SG'|'SH'|'SI'|'SK'|'SL'|'SM'|'SN'|'SO'|'SR'|'ST'|'SV'|'SY'|'SZ'|'TC'|'TD'|'TG'|'TH'|'TJ'|'TK'|'TL'|'TM'|'TN'|'TO'|'TR'|'TT'|'TV'|'TW'|'TZ'|'UA'|'UG'|'US'|'UY'|'UZ'|'VA'|'VC'|'VE'|'VG'|'VI'|'VN'|'VU'|'WF'|'WS'|'YE'|'YT'|'ZA'|'ZM'|'ZW',
        'ZipCode': 'string',
        'PhoneNumber': 'string',
        'Email': 'string',
        'Fax': 'string',
        'ExtraParams': [
            {
                'Name': 'DUNS_NUMBER'|'BRAND_NUMBER'|'BIRTH_DEPARTMENT'|'BIRTH_DATE_IN_YYYY_MM_DD'|'BIRTH_COUNTRY'|'BIRTH_CITY'|'DOCUMENT_NUMBER'|'AU_ID_NUMBER'|'AU_ID_TYPE'|'CA_LEGAL_TYPE'|'CA_BUSINESS_ENTITY_TYPE'|'ES_IDENTIFICATION'|'ES_IDENTIFICATION_TYPE'|'ES_LEGAL_FORM'|'FI_BUSINESS_NUMBER'|'FI_ID_NUMBER'|'IT_PIN'|'RU_PASSPORT_DATA'|'SE_ID_NUMBER'|'SG_ID_NUMBER'|'VAT_NUMBER',
                'Value': 'string'
            },
        ]
    }
)

Parameters:

DomainName (string) –
[REQUIRED]

The name of the domain that you want to update contact information for.
AdminContact (dict) –
Provides detailed contact information.
- FirstName (string) –
  First name of contact.
- LastName (string) –
  Last name of contact.
- ContactType (string) –
  Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON , you must enter an organization name, and you can’t enable privacy protection for the contact.
- OrganizationName (string) –
  Name of the organization for contact types other than PERSON .
- AddressLine1 (string) –
  First line of the contact’s address.
- AddressLine2 (string) –
  Second line of contact’s address, if any.
- City (string) –
  The city of the contact’s address.
- State (string) –
  The state or province of the contact’s city.
- CountryCode (string) –
  Code for the country of the contact’s address.
- ZipCode (string) –
  The zip or postal code of the contact’s address.
- PhoneNumber (string) –
  The phone number of the contact.
  
  Constraints: Phone number must be specified in the format “+[country dialing code].[number including any area code]”. For example, a US phone number might appear as "+1.1234567890" .
- Email (string) –
  Email address of the contact.
- Fax (string) –
  Fax number of the contact.
  
  Constraints: Phone number must be specified in the format “+[country dialing code].[number including any area code]”. For example, a US phone number might appear as "+1.1234567890" .
- ExtraParams (list) –
  A list of name-value pairs for parameters required by certain top-level domains.
  - (dict) –
    ExtraParam includes the following elements.
    - Name (string) – [REQUIRED]
      Name of the additional parameter required by the top-level domain.
    - Value (string) – [REQUIRED]
      Values corresponding to the additional parameter names required by some top-level domains.
RegistrantContact (dict) –
Provides detailed contact information.
- FirstName (string) –
  First name of contact.
- LastName (string) –
  Last name of contact.
- ContactType (string) –
  Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON , you must enter an organization name, and you can’t enable privacy protection for the contact.
- OrganizationName (string) –
  Name of the organization for contact types other than PERSON .
- AddressLine1 (string) –
  First line of the contact’s address.
- AddressLine2 (string) –
  Second line of contact’s address, if any.
- City (string) –
  The city of the contact’s address.
- State (string) –
  The state or province of the contact’s city.
- CountryCode (string) –
  Code for the country of the contact’s address.
- ZipCode (string) –
  The zip or postal code of the contact’s address.
- PhoneNumber (string) –
  The phone number of the contact.
  
  Constraints: Phone number must be specified in the format “+[country dialing code].[number including any area code]”. For example, a US phone number might appear as "+1.1234567890" .
- Email (string) –
  Email address of the contact.
- Fax (string) –
  Fax number of the contact.
  
  Constraints: Phone number must be specified in the format “+[country dialing code].[number including any area code]”. For example, a US phone number might appear as "+1.1234567890" .
- ExtraParams (list) –
  A list of name-value pairs for parameters required by certain top-level domains.
  - (dict) –
    ExtraParam includes the following elements.
    - Name (string) – [REQUIRED]
      Name of the additional parameter required by the top-level domain.
    - Value (string) – [REQUIRED]
      Values corresponding to the additional parameter names required by some top-level domains.
TechContact (dict) –
Provides detailed contact information.
- FirstName (string) –
  First name of contact.
- LastName (string) –
  Last name of contact.
- ContactType (string) –
  Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON , you must enter an organization name, and you can’t enable privacy protection for the contact.
- OrganizationName (string) –
  Name of the organization for contact types other than PERSON .
- AddressLine1 (string) –
  First line of the contact’s address.
- AddressLine2 (string) –
  Second line of contact’s address, if any.
- City (string) –
  The city of the contact’s address.
- State (string) –
  The state or province of the contact’s city.
- CountryCode (string) –
  Code for the country of the contact’s address.
- ZipCode (string) –
  The zip or postal code of the contact’s address.
- PhoneNumber (string) –
  The phone number of the contact.
  
  Constraints: Phone number must be specified in the format “+[country dialing code].[number including any area code]”. For example, a US phone number might appear as "+1.1234567890" .
- Email (string) –
  Email address of the contact.
- Fax (string) –
  Fax number of the contact.
  
  Constraints: Phone number must be specified in the format “+[country dialing code].[number including any area code]”. For example, a US phone number might appear as "+1.1234567890" .
- ExtraParams (list) –
  A list of name-value pairs for parameters required by certain top-level domains.
  - (dict) –
    ExtraParam includes the following elements.
    - Name (string) – [REQUIRED]
      Name of the additional parameter required by the top-level domain.
    - Value (string) – [REQUIRED]
      Values corresponding to the additional parameter names required by some top-level domains.

Return type:

dict

Returns:

Response Syntax

{
    'OperationId': 'string'
}

Response Structure

(dict) –

The UpdateDomainContact response includes the following element.
- OperationId (string) –
  
  Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail .

update_domain_contact_privacy(**kwargs)¶

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.

See also: AWS API Documentation

Request Syntax

response = client.update_domain_contact_privacy(
    DomainName='string',
    AdminPrivacy=True|False,
    RegistrantPrivacy=True|False,
    TechPrivacy=True|False
)

Parameters:

DomainName (string) –
[REQUIRED]

The name of the domain that you want to update the privacy setting for.
AdminPrivacy (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.
RegistrantPrivacy (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.
TechPrivacy (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.

Return type:

dict

Returns:

Response Syntax

{
    'OperationId': 'string'
}

Response Structure

(dict) –

The UpdateDomainContactPrivacy response includes the following element.
- OperationId (string) –
  
  Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

update_domain_nameservers(**kwargs)¶

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.

See also: AWS API Documentation

Request Syntax

response = client.update_domain_nameservers(
    DomainName='string',
    FIAuthKey='string',
    Nameservers=[
        {
            'Name': 'string',
            'GlueIps': [
                'string',
            ]
        },
    ]
)

Parameters:

DomainName (string) –
[REQUIRED]

The name of the domain that you want to change name servers for.
FIAuthKey (string) – The authorization key for .fi domains
Nameservers (list) –
[REQUIRED]

A list of new name servers for the domain.
- (dict) –
  Nameserver includes the following elements.
  - Name (string) – [REQUIRED]
    The fully qualified host name of the name server.
    
    Constraint: Maximum 255 characters
  - GlueIps (list) –
    Glue IP address of a name server entry. Glue IP addresses are required only when the name of the name server is a subdomain of the domain. For example, if your domain is example.com and the name server for the domain is ns.example.com, you need to specify the IP address for ns.example.com.
    
    Constraints: The list can contain only one IPv4 and one IPv6 address.
    - (string) –

Return type:

dict

Returns:

Response Syntax

{
    'OperationId': 'string'
}

Response Structure

(dict) –

The UpdateDomainNameservers response includes the following element.
- OperationId (string) –
  
  Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail .

update_tags_for_domain(**kwargs)¶

This operation adds or updates tags for a specified domain.

All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations.

See also: AWS API Documentation

Request Syntax

response = client.update_tags_for_domain(
    DomainName='string',
    TagsToUpdate=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

DomainName (string) –
[REQUIRED]

The domain for which you want to add or update tags.
TagsToUpdate (list) –
A list of the tag keys and values that you want to add or update. If you specify a key that already exists, the corresponding value will be replaced.
- (dict) –
  Each tag includes the following elements.
  - Key (string) –
    The key (name) of a tag.
    
    Valid values: A-Z, a-z, 0-9, space, “.:/=+-@”
    
    Constraints: Each key can be 1-128 characters long.
  - Value (string) –
    The value of a tag.
    
    Valid values: A-Z, a-z, 0-9, space, “.:/=+-@”
    
    Constraints: Each value can be 0-256 characters long.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

(dict) –

view_billing(**kwargs)¶

Returns all the domain-related billing records for the current AWS account for a specified period

See also: AWS API Documentation

Request Syntax

response = client.view_billing(
    Start=datetime(2015, 1, 1),
    End=datetime(2015, 1, 1),
    Marker='string',
    MaxItems=123
)

Parameters:

Start (datetime) – The beginning date and time for the time period for which you want a list of billing records. Specify the date in Unix time format.
End (datetime) – The end date and time for the time period for which you want a list of billing records. Specify the date in Unix time format.
Marker (string) –
For an initial request for a list of billing records, omit this element. If the number of billing records that are associated with the current AWS account during the specified period is greater than the value that you specified for MaxItems , you can use Marker to return additional billing records. Get the value of NextPageMarker from the previous response, and submit another request that includes the value of NextPageMarker in the Marker element.

Constraints: The marker must match the value of NextPageMarker that was returned in the previous response.
MaxItems (integer) –
The number of billing records to be returned.

Default: 20

Return type:

dict

Returns:

Response Syntax

{
    'NextPageMarker': 'string',
    'BillingRecords': [
        {
            'DomainName': 'string',
            'Operation': 'REGISTER_DOMAIN'|'DELETE_DOMAIN'|'TRANSFER_IN_DOMAIN'|'UPDATE_DOMAIN_CONTACT'|'UPDATE_NAMESERVER'|'CHANGE_PRIVACY_PROTECTION'|'DOMAIN_LOCK',
            'InvoiceId': 'string',
            'BillDate': datetime(2015, 1, 1),
            'Price': 123.0
        },
    ]
}

Response Structure

(dict) –

The ViewBilling response includes the following elements.
- NextPageMarker (string) –
  
  If there are more billing records than you specified for MaxItems in the request, submit another request and include the value of NextPageMarker in the value of Marker .
- BillingRecords (list) –
  
  A summary of billing records.
  - (dict) –
    
    Information for one billing record.
    - DomainName (string) –
      
      The name of the domain that the billing record applies to. If the domain name contains characters other than a-z, 0-9, and - (hyphen), such as an internationalized domain name, then this value is in Punycode. For more information, see DNS Domain Name Format in the Amazon Route 53 Developer Guidezzz .
    - Operation (string) –
      
      The operation that you were charged for.
    - InvoiceId (string) –
      
      The ID of the invoice that is associated with the billing record.
    - BillDate (datetime) –
      
      The date that the operation was billed, in Unix format.
    - Price (float) –
      
      The price that you were charged for the operation, in US dollars.
      
      Example value: 12.0

Paginators ¶

The available paginators are:

Route53Domains.Paginator.ListDomains
Route53Domains.Paginator.ListOperations

class Route53Domains.Paginator.ListDomains¶

paginator = client.get_paginator('list_domains')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from Route53Domains.Client.list_domains().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken from a previous response.

Return type: dict

Returns:

Response Syntax

{
    'Domains': [
        {
            'DomainName': 'string',
            'AutoRenew': True|False,
            'TransferLock': True|False,
            'Expiry': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
The ListDomains response includes the following elements.
- Domains (list) –
  A summary of domains.
  - (dict) –
    Summary information about one domain.
    - DomainName (string) –
      The name of the domain that the summary information applies to.
    - AutoRenew (boolean) –
      Indicates whether the domain is automatically renewed upon expiration.
    - TransferLock (boolean) –
      Indicates whether a domain is locked from unauthorized transfer to another party.
    - Expiry (datetime) –
      Expiration date of the domain in Coordinated Universal Time (UTC).
- NextToken (string) –
  A token to resume pagination.

class Route53Domains.Paginator.ListOperations¶

paginator = client.get_paginator('list_operations')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from Route53Domains.Client.list_operations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken from a previous response.

Return type: dict

Returns:

Response Syntax

{
    'Operations': [
        {
            'OperationId': 'string',
            'Status': 'SUBMITTED'|'IN_PROGRESS'|'ERROR'|'SUCCESSFUL'|'FAILED',
            'Type': 'REGISTER_DOMAIN'|'DELETE_DOMAIN'|'TRANSFER_IN_DOMAIN'|'UPDATE_DOMAIN_CONTACT'|'UPDATE_NAMESERVER'|'CHANGE_PRIVACY_PROTECTION'|'DOMAIN_LOCK',
            'SubmittedDate': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
The ListOperations response includes the following elements.
- Operations (list) –
  Lists summaries of the operations.
  - (dict) –
    OperationSummary includes the following elements.
    - OperationId (string) –
      Identifier returned to track the requested action.
    - Status (string) –
      The current status of the requested operation in the system.
    - Type (string) –
      Type of the action requested.
    - SubmittedDate (datetime) –
      The date when the request was submitted.
- NextToken (string) –
  A token to resume pagination.

Table Of Contents

Contents

Route53Domains¶

Client¶

Paginators¶

Route53Domains ¶

Client ¶

Paginators ¶