AWS SDK for PHP 3.x

Client: Aws\Route53Domains\Route53DomainsClient

Service ID: route53domains

Version: 2014-05-15

This page describes the parameters and results for the operations of the Amazon Route 53 Domains (2014-05-15), and shows how to use the Aws\Route53Domains\Route53DomainsClient object to call the described operations. This documentation is specific to the 2014-05-15 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CheckDomainAvailability ( array $params = [] )
This operation checks the availability of one domain name.
CheckDomainTransferability ( array $params = [] )
Checks whether a domain name can be transferred to Amazon Route 53.
DeleteTagsForDomain ( array $params = [] )
This operation deletes the specified tags for a domain.
DisableDomainAutoRenew ( array $params = [] )
This operation disables automatic renewal of domain registration for the specified domain.
DisableDomainTransferLock ( array $params = [] )
This operation removes the transfer lock on the domain (specifically the clientTransferProhibited status) to allow domain transfers.
EnableDomainAutoRenew ( array $params = [] )
This operation configures Amazon Route 53 to automatically renew the specified domain before the domain registration expires.
EnableDomainTransferLock ( array $params = [] )
This operation sets the transfer lock on the domain (specifically the clientTransferProhibited status) to prevent domain transfers.
GetContactReachabilityStatus ( array $params = [] )
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.
GetDomainDetail ( array $params = [] )
This operation returns detailed information about a specified domain that is associated with the current AWS account.
GetDomainSuggestions ( array $params = [] )
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).
GetOperationDetail ( array $params = [] )
This operation returns the current status of an operation that is not completed.
ListDomains ( array $params = [] )
This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.
ListOperations ( array $params = [] )
This operation returns the operation IDs of operations that are not yet complete.
ListTagsForDomain ( array $params = [] )
This operation returns all of the tags that are associated with the specified domain.
RegisterDomain ( array $params = [] )
This operation registers a domain.
RenewDomain ( array $params = [] )
This operation renews a domain for the specified number of years.
ResendContactReachabilityEmail ( array $params = [] )
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.
RetrieveDomainAuthCode ( array $params = [] )
This operation returns the AuthCode for the domain.
TransferDomain ( array $params = [] )
This operation transfers a domain from another registrar to Amazon Route 53.
UpdateDomainContact ( array $params = [] )
This operation updates the contact information for a particular domain.
UpdateDomainContactPrivacy ( array $params = [] )
This operation updates the specified domain contact's privacy setting.
UpdateDomainNameservers ( array $params = [] )
This operation replaces the current set of name servers for the domain with the specified set of name servers.
UpdateTagsForDomain ( array $params = [] )
This operation adds or updates tags for a specified domain.
ViewBilling ( array $params = [] )
Returns all the domain-related billing records for the current AWS account for a specified period

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListDomains
ListOperations

Operations

CheckDomainAvailability

$result = $client->checkDomainAvailability([/* ... */]);
$promise = $client->checkDomainAvailabilityAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->checkDomainAvailability([
    'DomainName' => '<string>', // REQUIRED
    'IdnLangCode' => '<string>',
]);

Parameter Details

Members

DomainName

Type: string

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

Type: string

Reserved for future use.

Result Syntax

[
    'Availability' => 'AVAILABLE|AVAILABLE_RESERVED|AVAILABLE_PREORDER|UNAVAILABLE|UNAVAILABLE_PREMIUM|UNAVAILABLE_RESTRICTED|RESERVED|DONT_KNOW',
]

Result Details

Members

Availability

Type: string

Whether the domain name is available for registering.

You can register only 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.

Errors

InvalidInput:
The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an operation that is already completed. For a domain name, it might not be a valid domain name or belong to the requester account.
UnsupportedTLD:
Amazon Route 53 does not support this top-level domain (TLD).

CheckDomainTransferability

$result = $client->checkDomainTransferability([/* ... */]);
$promise = $client->checkDomainTransferabilityAsync([/* ... */]);

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

Parameter Syntax

$result = $client->checkDomainTransferability([
    'AuthCode' => '<string>',
    'DomainName' => '<string>', // REQUIRED
]);

Parameter Details

Members

AuthCode

Type: string

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

DomainName

Type: string

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.

Result Syntax

[
    'Transferability' => [
        'Transferable' => 'TRANSFERABLE|UNTRANSFERABLE|DONT_KNOW',
    ],
]

Result Details

Members

Transferability

Type: DomainTransferability structure

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

Errors

InvalidInput:
The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an operation that is already completed. For a domain name, it might not be a valid domain name or belong to the requester account.
UnsupportedTLD:
Amazon Route 53 does not support this top-level domain (TLD).

DeleteTagsForDomain

$result = $client->deleteTagsForDomain([/* ... */]);
$promise = $client->deleteTagsForDomainAsync([/* ... */]);

This operation deletes the specified tags for a domain.

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

Parameter Syntax

$result = $client->deleteTagsForDomain([
    'DomainName' => '<string>', // REQUIRED
    'TagsToDelete' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

DomainName

Type: string

The domain for which you want to delete one or more tags.

TagsToDelete

Type: Array of strings

A list of tag keys to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidInput:
The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an operation that is already completed. For a domain name, it might not be a valid domain name or belong to the requester account.
OperationLimitExceeded:
The number of operations or jobs running exceeded the allowed threshold for the account.
UnsupportedTLD:
Amazon Route 53 does not support this top-level domain (TLD).

DisableDomainAutoRenew

$result = $client->disableDomainAutoRenew([/* ... */]);
$promise = $client->disableDomainAutoRenewAsync([/* ... */]);

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

Parameter Syntax

$result = $client->disableDomainAutoRenew([
    'DomainName' => '<string>', // REQUIRED
]);

Parameter Details

Members

DomainName

Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidInput:
The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an operation that is already completed. For a domain name, it might not be a valid domain name or belong to the requester account.
UnsupportedTLD:
Amazon Route 53 does not support this top-level domain (TLD).

DisableDomainTransferLock

$result = $client->disableDomainTransferLock([/* ... */]);
$promise = $client->disableDomainTransferLockAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->disableDomainTransferLock([
    'DomainName' => '<string>', // REQUIRED
]);

Parameter Details

Members

DomainName

Type: string

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

Result Syntax

[
    'OperationId' => '<string>',
]

Result Details

Members

OperationId

Type: string

Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

Errors

InvalidInput:
The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an operation that is already completed. For a domain name, it might not be a valid domain name or belong to the requester account.
DuplicateRequest:
The request is already in progress for the domain.
TLDRulesViolation:
The top-level domain does not support this operation.
OperationLimitExceeded:
The number of operations or jobs running exceeded the allowed threshold for the account.
UnsupportedTLD:
Amazon Route 53 does not support this top-level domain (TLD).

EnableDomainAutoRenew

$result = $client->enableDomainAutoRenew([/* ... */]);
$promise = $client->enableDomainAutoRenewAsync([/* ... */]);

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 associate, Gandi. Amazon 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.

Parameter Syntax

$result = $client->enableDomainAutoRenew([
    'DomainName' => '<string>', // REQUIRED
]);

Parameter Details

Members

DomainName

Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidInput:
The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an operation that is already completed. For a domain name, it might not be a valid domain name or belong to the requester account.
UnsupportedTLD:
Amazon Route 53 does not support this top-level domain (TLD).
TLDRulesViolation:
The top-level domain does not support this operation.

EnableDomainTransferLock

$result = $client->enableDomainTransferLock([/* ... */]);
$promise = $client->enableDomainTransferLockAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->enableDomainTransferLock([
    'DomainName' => '<string>', // REQUIRED
]);

Parameter Details

Members

DomainName

Type: string

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

Result Syntax

[
    'OperationId' => '<string>',
]

Result Details

Members

OperationId

Type: string

Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

Errors

InvalidInput:
The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an operation that is already completed. For a domain name, it might not be a valid domain name or belong to the requester account.
DuplicateRequest:
The request is already in progress for the domain.
TLDRulesViolation:
The top-level domain does not support this operation.
OperationLimitExceeded:
The number of operations or jobs running exceeded the allowed threshold for the account.
UnsupportedTLD:
Amazon Route 53 does not support this top-level domain (TLD).

GetContactReachabilityStatus

$result = $client->getContactReachabilityStatus([/* ... */]);
$promise = $client->getContactReachabilityStatusAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getContactReachabilityStatus([
    'domainName' => '<string>',
]);

Parameter Details

Members

domainName

Type: string

The name of the domain for which you want to know whether the registrant contact has confirmed that the email address is valid.

Result Syntax

[
    'domainName' => '<string>',
    'status' => 'PENDING|DONE|EXPIRED',
]

Result Details

Members

domainName

Type: string

The domain name for which you requested the reachability status.

status

Type: 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.

Errors

InvalidInput:
The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an operation that is already completed. For a domain name, it might not be a valid domain name or belong to the requester account.
OperationLimitExceeded:
The number of operations or jobs running exceeded the allowed threshold for the account.
UnsupportedTLD:
Amazon Route 53 does not support this top-level domain (TLD).

GetDomainDetail

$result = $client->getDomainDetail([/* ... */]);
$promise = $client->getDomainDetailAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getDomainDetail([
    'DomainName' => '<string>', // REQUIRED
]);

Parameter Details

Members

DomainName

Type: string

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

Result Syntax

[
    'AbuseContactEmail' => '<string>',
    'AbuseContactPhone' => '<string>',
    'AdminContact' => [
        'AddressLine1' => '<string>',
        'AddressLine2' => '<string>',
        'City' => '<string>',
        'ContactType' => 'PERSON|COMPANY|ASSOCIATION|PUBLIC_BODY|RESELLER',
        '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',
        'Email' => '<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|FI_NATIONALITY|FI_ORGANIZATION_TYPE|IT_PIN|IT_REGISTRANT_ENTITY_TYPE|RU_PASSPORT_DATA|SE_ID_NUMBER|SG_ID_NUMBER|VAT_NUMBER|UK_CONTACT_TYPE|UK_COMPANY_NUMBER',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Fax' => '<string>',
        'FirstName' => '<string>',
        'LastName' => '<string>',
        'OrganizationName' => '<string>',
        'PhoneNumber' => '<string>',
        'State' => '<string>',
        'ZipCode' => '<string>',
    ],
    'AdminPrivacy' => true || false,
    'AutoRenew' => true || false,
    'CreationDate' => <DateTime>,
    'DnsSec' => '<string>',
    'DomainName' => '<string>',
    'ExpirationDate' => <DateTime>,
    'Nameservers' => [
        [
            'GlueIps' => ['<string>', ...],
            'Name' => '<string>',
        ],
        // ...
    ],
    'RegistrantContact' => [
        'AddressLine1' => '<string>',
        'AddressLine2' => '<string>',
        'City' => '<string>',
        'ContactType' => 'PERSON|COMPANY|ASSOCIATION|PUBLIC_BODY|RESELLER',
        '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',
        'Email' => '<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|FI_NATIONALITY|FI_ORGANIZATION_TYPE|IT_PIN|IT_REGISTRANT_ENTITY_TYPE|RU_PASSPORT_DATA|SE_ID_NUMBER|SG_ID_NUMBER|VAT_NUMBER|UK_CONTACT_TYPE|UK_COMPANY_NUMBER',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Fax' => '<string>',
        'FirstName' => '<string>',
        'LastName' => '<string>',
        'OrganizationName' => '<string>',
        'PhoneNumber' => '<string>',
        'State' => '<string>',
        'ZipCode' => '<string>',
    ],
    'RegistrantPrivacy' => true || false,
    'RegistrarName' => '<string>',
    'RegistrarUrl' => '<string>',
    'RegistryDomainId' => '<string>',
    'Reseller' => '<string>',
    'StatusList' => ['<string>', ...],
    'TechContact' => [
        'AddressLine1' => '<string>',
        'AddressLine2' => '<string>',
        'City' => '<string>',
        'ContactType' => 'PERSON|COMPANY|ASSOCIATION|PUBLIC_BODY|RESELLER',
        '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',
        'Email' => '<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|FI_NATIONALITY|FI_ORGANIZATION_TYPE|IT_PIN|IT_REGISTRANT_ENTITY_TYPE|RU_PASSPORT_DATA|SE_ID_NUMBER|SG_ID_NUMBER|VAT_NUMBER|UK_CONTACT_TYPE|UK_COMPANY_NUMBER',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Fax' => '<string>',
        'FirstName' => '<string>',
        'LastName' => '<string>',
        'OrganizationName' => '<string>',
        'PhoneNumber' => '<string>',
        'State' => '<string>',
        'ZipCode' => '<string>',
    ],
    'TechPrivacy' => true || false,
    'UpdatedDate' => <DateTime>,
    'WhoIsServer' => '<string>',
]

Result Details

Members

AbuseContactEmail

Type: 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

Type: string

Phone number for reporting abuse.

AdminContact

Type: ContactDetail structure

Provides details about the domain administrative contact.

AdminPrivacy

Type: boolean

Specifies whether contact information is concealed from WHOIS queries. If the value is true, WHOIS ("who is") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If the value is false, WHOIS queries return the information that you entered for the admin contact.

AutoRenew

Type: boolean

Specifies whether the domain registration is set to renew automatically.

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date when the domain was created as found in the response to a WHOIS query. The date and time is in Coordinated Universal time (UTC).

DnsSec

Type: string

Reserved for future use.

DomainName

Type: string

The name of a domain.

ExpirationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date when the registration for the domain is set to expire. The date and time is in Coordinated Universal time (UTC).

Nameservers

Type: Array of Nameserver structures

The name of the domain.

RegistrantContact

Type: ContactDetail structure

Provides details about the domain registrant.

RegistrantPrivacy

Type: boolean

RegistrarName

Type: string

Name of the registrar of the domain as identified in the registry. Domains with a .com, .net, or .org TLD are registered by Amazon Registrar. All other domains are registered by our registrar associate, Gandi. The value for domains that are registered by Gandi is "GANDI SAS".

RegistrarUrl

Type: string

Web address of the registrar.

RegistryDomainId

Type: string

Reserved for future use.

Reseller

Type: string

Reseller of the domain. Domains registered or transferred using Amazon Route 53 domains will have "Amazon" as the reseller.

StatusList

Type: Array of strings

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.)

TechContact

Type: ContactDetail structure

Provides details about the domain technical contact.

TechPrivacy

Type: boolean

UpdatedDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The last updated date of the domain as found in the response to a WHOIS query. The date and time is in Coordinated Universal time (UTC).

WhoIsServer

Type: string

The fully qualified name of the WHOIS server that can answer the WHOIS query for the domain.

Errors

InvalidInput:
The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an operation that is already completed. For a domain name, it might not be a valid domain name or belong to the requester account.
UnsupportedTLD:
Amazon Route 53 does not support this top-level domain (TLD).

GetDomainSuggestions

$result = $client->getDomainSuggestions([/* ... */]);
$promise = $client->getDomainSuggestionsAsync([/* ... */]);

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).

Parameter Syntax

$result = $client->getDomainSuggestions([
    'DomainName' => '<string>', // REQUIRED
    'OnlyAvailable' => true || false, // REQUIRED
    'SuggestionCount' => <integer>, // REQUIRED
]);

Parameter Details

Members

DomainName

Type: string

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.

OnlyAvailable

Type: boolean

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.

SuggestionCount

Type: int

The number of suggested domain names that you want Amazon Route 53 to return.

Result Syntax

[
    'SuggestionsList' => [
        [
            'Availability' => '<string>',
            'DomainName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

SuggestionsList

Type: Array of DomainSuggestion structures

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.

Errors

InvalidInput:
The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an operation that is already completed. For a domain name, it might not be a valid domain name or belong to the requester account.
UnsupportedTLD:
Amazon Route 53 does not support this top-level domain (TLD).

GetOperationDetail

$result = $client->getOperationDetail([/* ... */]);
$promise = $client->getOperationDetailAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getOperationDetail([
    'OperationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

OperationId

Type: string

The identifier for the operation for which you want to get the status. Amazon Route 53 returned the identifier in the response to the original request.

Result Syntax

[
    'DomainName' => '<string>',
    'Message' => '<string>',
    'OperationId' => '<string>',
    'Status' => 'SUBMITTED|IN_PROGRESS|ERROR|SUCCESSFUL|FAILED',
    'SubmittedDate' => <DateTime>,
    'Type' => 'REGISTER_DOMAIN|DELETE_DOMAIN|TRANSFER_IN_DOMAIN|UPDATE_DOMAIN_CONTACT|UPDATE_NAMESERVER|CHANGE_PRIVACY_PROTECTION|DOMAIN_LOCK|ENABLE_AUTORENEW|DISABLE_AUTORENEW|ADD_DNSSEC|REMOVE_DNSSEC|EXPIRE_DOMAIN|TRANSFER_OUT_DOMAIN|CHANGE_DOMAIN_OWNER|RENEW_DOMAIN|PUSH_DOMAIN',
]

Result Details

Members

DomainName

Type: string

The name of a domain.

Message

Type: string

Detailed information on the status including possible errors.

OperationId

Type: string

The identifier for the operation.

Status

Type: string

The current status of the requested operation in the system.

SubmittedDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date when the request was submitted.

Type

Type: string

The type of operation that was requested.

Errors

InvalidInput:
The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an operation that is already completed. For a domain name, it might not be a valid domain name or belong to the requester account.

ListDomains

$result = $client->listDomains([/* ... */]);
$promise = $client->listDomainsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listDomains([
    'Marker' => '<string>',
    'MaxItems' => <integer>,
]);

Parameter Details

Members

Marker

Type: 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

Type: int

Number of domains to be returned.

Default: 20

Result Syntax

[
    'Domains' => [
        [
            'AutoRenew' => true || false,
            'DomainName' => '<string>',
            'Expiry' => <DateTime>,
            'TransferLock' => true || false,
        ],
        // ...
    ],
    'NextPageMarker' => '<string>',
]

Result Details

Members

Domains

Type: Array of DomainSummary structures

A summary of domains.

NextPageMarker

Type: 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.

Errors

InvalidInput:
The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an operation that is already completed. For a domain name, it might not be a valid domain name or belong to the requester account.

ListOperations

$result = $client->listOperations([/* ... */]);
$promise = $client->listOperationsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listOperations([
    'Marker' => '<string>',
    'MaxItems' => <integer>,
    'SubmittedSince' => <integer || string || DateTime>,
]);

Parameter Details

Members

Marker

Type: 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

Type: int

Number of domains to be returned.

Default: 20

SubmittedSince

Type: timestamp (string|DateTime or anything parsable by strtotime)

An optional parameter that lets you get information about all the operations that you submitted after a specified date and time. Specify the date and time in Coordinated Universal time (UTC).

Result Syntax

[
    'NextPageMarker' => '<string>',
    'Operations' => [
        [
            'OperationId' => '<string>',
            'Status' => 'SUBMITTED|IN_PROGRESS|ERROR|SUCCESSFUL|FAILED',
            'SubmittedDate' => <DateTime>,
            'Type' => 'REGISTER_DOMAIN|DELETE_DOMAIN|TRANSFER_IN_DOMAIN|UPDATE_DOMAIN_CONTACT|UPDATE_NAMESERVER|CHANGE_PRIVACY_PROTECTION|DOMAIN_LOCK|ENABLE_AUTORENEW|DISABLE_AUTORENEW|ADD_DNSSEC|REMOVE_DNSSEC|EXPIRE_DOMAIN|TRANSFER_OUT_DOMAIN|CHANGE_DOMAIN_OWNER|RENEW_DOMAIN|PUSH_DOMAIN',
        ],
        // ...
    ],
]

Result Details

Members

NextPageMarker

Type: 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.

Operations

Type: Array of OperationSummary structures

Lists summaries of the operations.

Errors

InvalidInput:
The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an operation that is already completed. For a domain name, it might not be a valid domain name or belong to the requester account.

ListTagsForDomain

$result = $client->listTagsForDomain([/* ... */]);
$promise = $client->listTagsForDomainAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->listTagsForDomain([
    'DomainName' => '<string>', // REQUIRED
]);

Parameter Details

Members

DomainName

Type: string

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

Result Syntax

[
    'TagList' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

TagList

Type: Array of Tag structures

A list of the tags that are associated with the specified domain.

Errors

InvalidInput:
The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an operation that is already completed. For a domain name, it might not be a valid domain name or belong to the requester account.
OperationLimitExceeded:
The number of operations or jobs running exceeded the allowed threshold for the account.
UnsupportedTLD:
Amazon Route 53 does not support this top-level domain (TLD).

RegisterDomain

$result = $client->registerDomain([/* ... */]);
$promise = $client->registerDomainAsync([/* ... */]);

This operation registers a domain. Domains are registered either by Amazon Registrar (for .com, .net, and .org domains) or by our registrar associate, Gandi (for all other domains). 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 either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you don't enable privacy protection, WHOIS queries return the information that you entered for the 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.

Parameter Syntax

$result = $client->registerDomain([
    'AdminContact' => [ // REQUIRED
        'AddressLine1' => '<string>',
        'AddressLine2' => '<string>',
        'City' => '<string>',
        'ContactType' => 'PERSON|COMPANY|ASSOCIATION|PUBLIC_BODY|RESELLER',
        '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',
        'Email' => '<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|FI_NATIONALITY|FI_ORGANIZATION_TYPE|IT_PIN|IT_REGISTRANT_ENTITY_TYPE|RU_PASSPORT_DATA|SE_ID_NUMBER|SG_ID_NUMBER|VAT_NUMBER|UK_CONTACT_TYPE|UK_COMPANY_NUMBER', // REQUIRED
                'Value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'Fax' => '<string>',
        'FirstName' => '<string>',
        'LastName' => '<string>',
        'OrganizationName' => '<string>',
        'PhoneNumber' => '<string>',
        'State' => '<string>',
        'ZipCode' => '<string>',
    ],
    'AutoRenew' => true || false,
    'DomainName' => '<string>', // REQUIRED
    'DurationInYears' => <integer>, // REQUIRED
    'IdnLangCode' => '<string>',
    'PrivacyProtectAdminContact' => true || false,
    'PrivacyProtectRegistrantContact' => true || false,
    'PrivacyProtectTechContact' => true || false,
    'RegistrantContact' => [ // REQUIRED
        'AddressLine1' => '<string>',
        'AddressLine2' => '<string>',
        'City' => '<string>',
        'ContactType' => 'PERSON|COMPANY|ASSOCIATION|PUBLIC_BODY|RESELLER',
        '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',
        'Email' => '<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|FI_NATIONALITY|FI_ORGANIZATION_TYPE|IT_PIN|IT_REGISTRANT_ENTITY_TYPE|RU_PASSPORT_DATA|SE_ID_NUMBER|SG_ID_NUMBER|VAT_NUMBER|UK_CONTACT_TYPE|UK_COMPANY_NUMBER', // REQUIRED
                'Value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'Fax' => '<string>',
        'FirstName' => '<string>',
        'LastName' => '<string>',
        'OrganizationName' => '<string>',
        'PhoneNumber' => '<string>',
        'State' => '<string>',
        'ZipCode' => '<string>',
    ],
    'TechContact' => [ // REQUIRED
        'AddressLine1' => '<string>',
        'AddressLine2' => '<string>',
        'City' => '<string>',
        'ContactType' => 'PERSON|COMPANY|ASSOCIATION|PUBLIC_BODY|RESELLER',
        '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',
        'Email' => '<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|FI_NATIONALITY|FI_ORGANIZATION_TYPE|IT_PIN|IT_REGISTRANT_ENTITY_TYPE|RU_PASSPORT_DATA|SE_ID_NUMBER|SG_ID_NUMBER|VAT_NUMBER|UK_CONTACT_TYPE|UK_COMPANY_NUMBER', // REQUIRED
                'Value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'Fax' => '<string>',
        'FirstName' => '<string>',
        'LastName' => '<string>',
        'OrganizationName' => '<string>',
        'PhoneNumber' => '<string>',
        'State' => '<string>',
        'ZipCode' => '<string>',
    ],
]);

Parameter Details

Members

AdminContact

Type: ContactDetail structure

Provides detailed contact information.

AutoRenew

Type: boolean

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

Default: true

DomainName

Type: string

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.

DurationInYears

Type: int

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

IdnLangCode

Type: string

Reserved for future use.

PrivacyProtectAdminContact

Type: boolean

Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you specify false, WHOIS queries return the information that you entered for the admin contact.

Default: true

PrivacyProtectRegistrantContact

Type: boolean

Default: true

PrivacyProtectTechContact

Type: boolean

Default: true

RegistrantContact

Type: ContactDetail structure

Provides detailed contact information.

TechContact

Type: ContactDetail structure

Provides detailed contact information.

Result Syntax

[
    'OperationId' => '<string>',
]

Result Details

Members

OperationId

Type: string

Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

Errors

InvalidInput:
The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an operation that is already completed. For a domain name, it might not be a valid domain name or belong to the requester account.
UnsupportedTLD:
Amazon Route 53 does not support this top-level domain (TLD).
DuplicateRequest:
The request is already in progress for the domain.
TLDRulesViolation:
The top-level domain does not support this operation.
DomainLimitExceeded:
The number of domains has exceeded the allowed threshold for the account.
OperationLimitExceeded:
The number of operations or jobs running exceeded the allowed threshold for the account.

RenewDomain

$result = $client->renewDomain([/* ... */]);
$promise = $client->renewDomainAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->renewDomain([
    'CurrentExpiryYear' => <integer>, // REQUIRED
    'DomainName' => '<string>', // REQUIRED
    'DurationInYears' => <integer>,
]);

Parameter Details

Members

CurrentExpiryYear

Type: int

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

DomainName

Type: string

The name of the domain that you want to renew.

DurationInYears

Type: int

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

Result Syntax

[
    'OperationId' => '<string>',
]

Result Details

Members

OperationId

Type: string

The identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

Errors

InvalidInput:
The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an operation that is already completed. For a domain name, it might not be a valid domain name or belong to the requester account.
UnsupportedTLD:
Amazon Route 53 does not support this top-level domain (TLD).
DuplicateRequest:
The request is already in progress for the domain.
TLDRulesViolation:
The top-level domain does not support this operation.
OperationLimitExceeded:
The number of operations or jobs running exceeded the allowed threshold for the account.

ResendContactReachabilityEmail

$result = $client->resendContactReachabilityEmail([/* ... */]);
$promise = $client->resendContactReachabilityEmailAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->resendContactReachabilityEmail([
    'domainName' => '<string>',
]);

Parameter Details

Members

domainName

Type: string

The name of the domain for which you want Amazon Route 53 to resend a confirmation email to the registrant contact.

Result Syntax

[
    'domainName' => '<string>',
    'emailAddress' => '<string>',
    'isAlreadyVerified' => true || false,
]

Result Details

Members

domainName

Type: string

The domain name for which you requested a confirmation email.

emailAddress

Type: string

The email address for the registrant contact at the time that we sent the verification email.

isAlreadyVerified

Type: 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.

Errors

InvalidInput:
The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an operation that is already completed. For a domain name, it might not be a valid domain name or belong to the requester account.
OperationLimitExceeded:
The number of operations or jobs running exceeded the allowed threshold for the account.
UnsupportedTLD:
Amazon Route 53 does not support this top-level domain (TLD).

RetrieveDomainAuthCode

$result = $client->retrieveDomainAuthCode([/* ... */]);
$promise = $client->retrieveDomainAuthCodeAsync([/* ... */]);

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

Parameter Syntax

$result = $client->retrieveDomainAuthCode([
    'DomainName' => '<string>', // REQUIRED
]);

Parameter Details

Members

DomainName

Type: string

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

Result Syntax

[
    'AuthCode' => '<string>',
]

Result Details

Members

AuthCode

Type: string

The authorization code for the domain.

Errors

InvalidInput:
The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an operation that is already completed. For a domain name, it might not be a valid domain name or belong to the requester account.
UnsupportedTLD:
Amazon Route 53 does not support this top-level domain (TLD).

TransferDomain

$result = $client->transferDomain([/* ... */]);
$promise = $client->transferDomainAsync([/* ... */]);

This operation transfers a domain from another registrar to Amazon Route 53. When the transfer is complete, the domain is registered either with Amazon Registrar (for .com, .net, and .org domains) or with our registrar associate, Gandi (for all other TLDs).

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.

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.

Parameter Syntax

$result = $client->transferDomain([
    'AdminContact' => [ // REQUIRED
        'AddressLine1' => '<string>',
        'AddressLine2' => '<string>',
        'City' => '<string>',
        'ContactType' => 'PERSON|COMPANY|ASSOCIATION|PUBLIC_BODY|RESELLER',
        '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',
        'Email' => '<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|FI_NATIONALITY|FI_ORGANIZATION_TYPE|IT_PIN|IT_REGISTRANT_ENTITY_TYPE|RU_PASSPORT_DATA|SE_ID_NUMBER|SG_ID_NUMBER|VAT_NUMBER|UK_CONTACT_TYPE|UK_COMPANY_NUMBER', // REQUIRED
                'Value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'Fax' => '<string>',
        'FirstName' => '<string>',
        'LastName' => '<string>',
        'OrganizationName' => '<string>',
        'PhoneNumber' => '<string>',
        'State' => '<string>',
        'ZipCode' => '<string>',
    ],
    'AuthCode' => '<string>',
    'AutoRenew' => true || false,
    'DomainName' => '<string>', // REQUIRED
    'DurationInYears' => <integer>, // REQUIRED
    'IdnLangCode' => '<string>',
    'Nameservers' => [
        [
            'GlueIps' => ['<string>', ...],
            'Name' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'PrivacyProtectAdminContact' => true || false,
    'PrivacyProtectRegistrantContact' => true || false,
    'PrivacyProtectTechContact' => true || false,
    'RegistrantContact' => [ // REQUIRED
        'AddressLine1' => '<string>',
        'AddressLine2' => '<string>',
        'City' => '<string>',
        'ContactType' => 'PERSON|COMPANY|ASSOCIATION|PUBLIC_BODY|RESELLER',
        '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',
        'Email' => '<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|FI_NATIONALITY|FI_ORGANIZATION_TYPE|IT_PIN|IT_REGISTRANT_ENTITY_TYPE|RU_PASSPORT_DATA|SE_ID_NUMBER|SG_ID_NUMBER|VAT_NUMBER|UK_CONTACT_TYPE|UK_COMPANY_NUMBER', // REQUIRED
                'Value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'Fax' => '<string>',
        'FirstName' => '<string>',
        'LastName' => '<string>',
        'OrganizationName' => '<string>',
        'PhoneNumber' => '<string>',
        'State' => '<string>',
        'ZipCode' => '<string>',
    ],
    'TechContact' => [ // REQUIRED
        'AddressLine1' => '<string>',
        'AddressLine2' => '<string>',
        'City' => '<string>',
        'ContactType' => 'PERSON|COMPANY|ASSOCIATION|PUBLIC_BODY|RESELLER',
        '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',
        'Email' => '<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|FI_NATIONALITY|FI_ORGANIZATION_TYPE|IT_PIN|IT_REGISTRANT_ENTITY_TYPE|RU_PASSPORT_DATA|SE_ID_NUMBER|SG_ID_NUMBER|VAT_NUMBER|UK_CONTACT_TYPE|UK_COMPANY_NUMBER', // REQUIRED
                'Value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'Fax' => '<string>',
        'FirstName' => '<string>',
        'LastName' => '<string>',
        'OrganizationName' => '<string>',
        'PhoneNumber' => '<string>',
        'State' => '<string>',
        'ZipCode' => '<string>',
    ],
]);

Parameter Details

Members

AdminContact

Type: ContactDetail structure

Provides detailed contact information.

AuthCode

Type: string

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

AutoRenew

Type: boolean

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

Default: true

DomainName

Type: string

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.

DurationInYears

Type: int

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

IdnLangCode

Type: string

Reserved for future use.

Nameservers

Type: Array of Nameserver structures

Contains details for the host and glue IP addresses.

PrivacyProtectAdminContact

Type: boolean

Default: true

PrivacyProtectRegistrantContact

Type: boolean

Default: true

PrivacyProtectTechContact

Type: boolean

Default: true

RegistrantContact

Type: ContactDetail structure

Provides detailed contact information.

TechContact

Type: ContactDetail structure

Provides detailed contact information.

Result Syntax

[
    'OperationId' => '<string>',
]

Result Details

Members

OperationId

Type: string

Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

Errors

InvalidInput:
The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an operation that is already completed. For a domain name, it might not be a valid domain name or belong to the requester account.
UnsupportedTLD:
Amazon Route 53 does not support this top-level domain (TLD).
DuplicateRequest:
The request is already in progress for the domain.
TLDRulesViolation:
The top-level domain does not support this operation.
DomainLimitExceeded:
The number of domains has exceeded the allowed threshold for the account.
OperationLimitExceeded:
The number of operations or jobs running exceeded the allowed threshold for the account.

UpdateDomainContact

$result = $client->updateDomainContact([/* ... */]);
$promise = $client->updateDomainContactAsync([/* ... */]);

This operation updates the contact information for a particular domain. You must specify information for at least one contact: registrant, administrator, or technical.

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.

Parameter Syntax

$result = $client->updateDomainContact([
    'AdminContact' => [
        'AddressLine1' => '<string>',
        'AddressLine2' => '<string>',
        'City' => '<string>',
        'ContactType' => 'PERSON|COMPANY|ASSOCIATION|PUBLIC_BODY|RESELLER',
        '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',
        'Email' => '<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|FI_NATIONALITY|FI_ORGANIZATION_TYPE|IT_PIN|IT_REGISTRANT_ENTITY_TYPE|RU_PASSPORT_DATA|SE_ID_NUMBER|SG_ID_NUMBER|VAT_NUMBER|UK_CONTACT_TYPE|UK_COMPANY_NUMBER', // REQUIRED
                'Value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'Fax' => '<string>',
        'FirstName' => '<string>',
        'LastName' => '<string>',
        'OrganizationName' => '<string>',
        'PhoneNumber' => '<string>',
        'State' => '<string>',
        'ZipCode' => '<string>',
    ],
    'DomainName' => '<string>', // REQUIRED
    'RegistrantContact' => [
        'AddressLine1' => '<string>',
        'AddressLine2' => '<string>',
        'City' => '<string>',
        'ContactType' => 'PERSON|COMPANY|ASSOCIATION|PUBLIC_BODY|RESELLER',
        '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',
        'Email' => '<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|FI_NATIONALITY|FI_ORGANIZATION_TYPE|IT_PIN|IT_REGISTRANT_ENTITY_TYPE|RU_PASSPORT_DATA|SE_ID_NUMBER|SG_ID_NUMBER|VAT_NUMBER|UK_CONTACT_TYPE|UK_COMPANY_NUMBER', // REQUIRED
                'Value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'Fax' => '<string>',
        'FirstName' => '<string>',
        'LastName' => '<string>',
        'OrganizationName' => '<string>',
        'PhoneNumber' => '<string>',
        'State' => '<string>',
        'ZipCode' => '<string>',
    ],
    'TechContact' => [
        'AddressLine1' => '<string>',
        'AddressLine2' => '<string>',
        'City' => '<string>',
        'ContactType' => 'PERSON|COMPANY|ASSOCIATION|PUBLIC_BODY|RESELLER',
        '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',
        'Email' => '<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|FI_NATIONALITY|FI_ORGANIZATION_TYPE|IT_PIN|IT_REGISTRANT_ENTITY_TYPE|RU_PASSPORT_DATA|SE_ID_NUMBER|SG_ID_NUMBER|VAT_NUMBER|UK_CONTACT_TYPE|UK_COMPANY_NUMBER', // REQUIRED
                'Value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'Fax' => '<string>',
        'FirstName' => '<string>',
        'LastName' => '<string>',
        'OrganizationName' => '<string>',
        'PhoneNumber' => '<string>',
        'State' => '<string>',
        'ZipCode' => '<string>',
    ],
]);

Parameter Details

Members

AdminContact

Type: ContactDetail structure

Provides detailed contact information.

DomainName

Type: string

The name of the domain that you want to update contact information for.

RegistrantContact

Type: ContactDetail structure

Provides detailed contact information.

TechContact

Type: ContactDetail structure

Provides detailed contact information.

Result Syntax

[
    'OperationId' => '<string>',
]

Result Details

Members

OperationId

Type: string

Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

Errors

InvalidInput:
The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an operation that is already completed. For a domain name, it might not be a valid domain name or belong to the requester account.
DuplicateRequest:
The request is already in progress for the domain.
TLDRulesViolation:
The top-level domain does not support this operation.
OperationLimitExceeded:
The number of operations or jobs running exceeded the allowed threshold for the account.
UnsupportedTLD:
Amazon Route 53 does not support this top-level domain (TLD).

UpdateDomainContactPrivacy

$result = $client->updateDomainContactPrivacy([/* ... */]);
$promise = $client->updateDomainContactPrivacyAsync([/* ... */]);

This operation updates the specified domain contact's privacy setting. When privacy protection is enabled, contact information such as email address is replaced either with contact information for Amazon Registrar (for .com, .net, and .org domains) or with contact information for our registrar associate, Gandi.

This operation affects only the contact information for the specified contact type (registrant, administrator, or tech). If the request succeeds, Amazon Route 53 returns an operation ID that you can use with GetOperationDetail to track the progress and completion of the action. If the request doesn't complete successfully, the domain registrant will be notified by email.

Parameter Syntax

$result = $client->updateDomainContactPrivacy([
    'AdminPrivacy' => true || false,
    'DomainName' => '<string>', // REQUIRED
    'RegistrantPrivacy' => true || false,
    'TechPrivacy' => true || false,
]);

Parameter Details

Members

AdminPrivacy

Type: boolean

DomainName

Type: string

The name of the domain that you want to update the privacy setting for.

RegistrantPrivacy

Type: boolean

TechPrivacy

Type: boolean

Result Syntax

[
    'OperationId' => '<string>',
]

Result Details

Members

OperationId

Type: string

Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

Errors

InvalidInput:
The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an operation that is already completed. For a domain name, it might not be a valid domain name or belong to the requester account.
DuplicateRequest:
The request is already in progress for the domain.
TLDRulesViolation:
The top-level domain does not support this operation.
OperationLimitExceeded:
The number of operations or jobs running exceeded the allowed threshold for the account.
UnsupportedTLD:
Amazon Route 53 does not support this top-level domain (TLD).

UpdateDomainNameservers

$result = $client->updateDomainNameservers([/* ... */]);
$promise = $client->updateDomainNameserversAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateDomainNameservers([
    'DomainName' => '<string>', // REQUIRED
    'FIAuthKey' => '<string>',
    'Nameservers' => [ // REQUIRED
        [
            'GlueIps' => ['<string>', ...],
            'Name' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

DomainName

Type: string

The name of the domain that you want to change name servers for.

FIAuthKey

Type: string

The authorization key for .fi domains

Nameservers

Type: Array of Nameserver structures

A list of new name servers for the domain.

Result Syntax

[
    'OperationId' => '<string>',
]

Result Details

Members

OperationId

Type: string

Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

Errors

InvalidInput:
The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an operation that is already completed. For a domain name, it might not be a valid domain name or belong to the requester account.
DuplicateRequest:
The request is already in progress for the domain.
TLDRulesViolation:
The top-level domain does not support this operation.
OperationLimitExceeded:
The number of operations or jobs running exceeded the allowed threshold for the account.
UnsupportedTLD:
Amazon Route 53 does not support this top-level domain (TLD).

UpdateTagsForDomain

$result = $client->updateTagsForDomain([/* ... */]);
$promise = $client->updateTagsForDomainAsync([/* ... */]);

This operation adds or updates tags for a specified domain.

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

Parameter Syntax

$result = $client->updateTagsForDomain([
    'DomainName' => '<string>', // REQUIRED
    'TagsToUpdate' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members

DomainName

Type: string

The domain for which you want to add or update tags.

TagsToUpdate

Type: Array of Tag structures

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidInput:
The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an operation that is already completed. For a domain name, it might not be a valid domain name or belong to the requester account.
OperationLimitExceeded:
The number of operations or jobs running exceeded the allowed threshold for the account.
UnsupportedTLD:
Amazon Route 53 does not support this top-level domain (TLD).

ViewBilling

$result = $client->viewBilling([/* ... */]);
$promise = $client->viewBillingAsync([/* ... */]);

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

Parameter Syntax

$result = $client->viewBilling([
    'End' => <integer || string || DateTime>,
    'Marker' => '<string>',
    'MaxItems' => <integer>,
    'Start' => <integer || string || DateTime>,
]);

Parameter Details

Members

End

Type: timestamp (string|DateTime or anything parsable by strtotime)

The end date and time for the time period for which you want a list of billing records. Specify the date and time in Coordinated Universal time (UTC).

Marker

Type: 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

Type: int

The number of billing records to be returned.

Default: 20

Start

Type: timestamp (string|DateTime or anything parsable by strtotime)

The beginning date and time for the time period for which you want a list of billing records. Specify the date and time in Coordinated Universal time (UTC).

Result Syntax

[
    'BillingRecords' => [
        [
            'BillDate' => <DateTime>,
            'DomainName' => '<string>',
            'InvoiceId' => '<string>',
            'Operation' => 'REGISTER_DOMAIN|DELETE_DOMAIN|TRANSFER_IN_DOMAIN|UPDATE_DOMAIN_CONTACT|UPDATE_NAMESERVER|CHANGE_PRIVACY_PROTECTION|DOMAIN_LOCK|ENABLE_AUTORENEW|DISABLE_AUTORENEW|ADD_DNSSEC|REMOVE_DNSSEC|EXPIRE_DOMAIN|TRANSFER_OUT_DOMAIN|CHANGE_DOMAIN_OWNER|RENEW_DOMAIN|PUSH_DOMAIN',
            'Price' => <float>,
        ],
        // ...
    ],
    'NextPageMarker' => '<string>',
]

Result Details

Members

BillingRecords

Type: Array of BillingRecord structures

A summary of billing records.

NextPageMarker

Type: 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.

Errors

InvalidInput:
The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an operation that is already completed. For a domain name, it might not be a valid domain name or belong to the requester account.

Shapes

BillingRecord

Description

Information for one billing record.

Members

BillDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date that the operation was billed, in Unix format.

DomainName

Type: 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.

InvoiceId

Type: string

The ID of the invoice that is associated with the billing record.

Operation

Type: string

The operation that you were charged for.

Price

Type: double

The price that you were charged for the operation, in US dollars.

Example value: 12.0

ContactDetail

Description

ContactDetail includes the following elements.

Members

AddressLine1

Type: string

First line of the contact's address.

AddressLine2

Type: string

Second line of contact's address, if any.

City

Type: string

The city of the contact's address.

ContactType

Type: 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.

CountryCode

Type: string

Code for the country of the contact's address.

Email

Type: string

Email address of the contact.

ExtraParams

Type: Array of ExtraParam structures

A list of name-value pairs for parameters required by certain top-level domains.

Fax

Type: 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".

FirstName

Type: string

First name of contact.

LastName

Type: string

Last name of contact.

OrganizationName

Type: string

Name of the organization for contact types other than PERSON.

PhoneNumber

Type: 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".

State

Type: string

The state or province of the contact's city.

ZipCode

Type: string

The zip or postal code of the contact's address.

DomainLimitExceeded

Description

The number of domains has exceeded the allowed threshold for the account.

Members

message

Type: string

The number of domains has exceeded the allowed threshold for the account.

DomainSuggestion

Description

Information about one suggested domain name.

Members

Availability

Type: string

Whether the domain name is available for registering.

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.

DomainName

Type: string

A suggested domain name.

DomainSummary

Description

Summary information about one domain.

Members

AutoRenew

Type: boolean

Indicates whether the domain is automatically renewed upon expiration.

DomainName

Type: string

The name of the domain that the summary information applies to.

Expiry

Type: timestamp (string|DateTime or anything parsable by strtotime)

Expiration date of the domain in Coordinated Universal Time (UTC).

TransferLock

Type: boolean

Indicates whether a domain is locked from unauthorized transfer to another party.

DomainTransferability

Description

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

Members

Transferable

Type: string

Whether the domain name can be transferred to Amazon Route 53.

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

Valid values:

TRANSFERABLE: The domain name can be transferred to Amazon Route 53.
UNTRANSFERRABLE: The domain name can't be transferred to Amazon Route 53.
DONT_KNOW: Reserved for future use.

DuplicateRequest

Description

The request is already in progress for the domain.

Members

message

Type: string

The request is already in progress for the domain.

ExtraParam

Description

ExtraParam includes the following elements.

Members

Name

Type: string

Name of the additional parameter required by the top-level domain. Here are the top-level domains that require additional parameters and which parameters they require:

.com.au and .net.au: AU_ID_NUMBER and AU_ID_TYPE
.ca: BRAND_NUMBER, CA_LEGAL_TYPE, and CA_BUSINESS_ENTITY_TYPE
.es: ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, and ES_LEGAL_FORM
.fi: BIRTH_DATE_IN_YYYY_MM_DD, FI_BUSINESS_NUMBER, FI_ID_NUMBER, FI_NATIONALITY, and FI_ORGANIZATION_TYPE
.fr: BRAND_NUMBER, BIRTH_DEPARTMENT, BIRTH_DATE_IN_YYYY_MM_DD, BIRTH_COUNTRY, and BIRTH_CITY
.it: BIRTH_COUNTRY, IT_PIN, and IT_REGISTRANT_ENTITY_TYPE
.ru: BIRTH_DATE_IN_YYYY_MM_DD and RU_PASSPORT_DATA
.se: BIRTH_COUNTRY and SE_ID_NUMBER
.sg: SG_ID_NUMBER
.co.uk, .me.uk, and .org.uk: UK_CONTACT_TYPE and UK_COMPANY_NUMBER

In addition, many TLDs require VAT_NUMBER.

Value

Type: string

Values corresponding to the additional parameter names required by some top-level domains.

InvalidInput

Description

The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an operation that is already completed. For a domain name, it might not be a valid domain name or belong to the requester account.

Members

message

Type: string

Nameserver

Description

Nameserver includes the following elements.

Members

GlueIps

Type: Array of strings

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.

Name

Type: string

The fully qualified host name of the name server.

Constraint: Maximum 255 characters

OperationLimitExceeded

Description

The number of operations or jobs running exceeded the allowed threshold for the account.

Members

message

Type: string

The number of operations or jobs running exceeded the allowed threshold for the account.

OperationSummary

Description

OperationSummary includes the following elements.

Members

OperationId

Type: string

Identifier returned to track the requested action.

Status

Type: string

The current status of the requested operation in the system.

SubmittedDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date when the request was submitted.

Type

Type: string

Type of the action requested.

TLDRulesViolation

Description

The top-level domain does not support this operation.

Members

message

Type: string

The top-level domain does not support this operation.

UnsupportedTLD

Description

Amazon Route 53 does not support this top-level domain (TLD).

Members

message

Type: string

Amazon Route 53 does not support this top-level domain (TLD).

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

Amazon Route 53 Domains 2014-05-15

Operation Summary

Paginators

Operations

CheckDomainAvailability

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CheckDomainTransferability

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteTagsForDomain

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DisableDomainAutoRenew

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DisableDomainTransferLock

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

EnableDomainAutoRenew

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

EnableDomainTransferLock

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetContactReachabilityStatus

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetDomainDetail

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetDomainSuggestions