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

AcceptDomainTransferFromAnotherAwsAccount ( array $params = [] )
Accepts the transfer of a domain from another Amazon Web Services account to the currentAmazon Web Services account.
AssociateDelegationSignerToDomain ( array $params = [] )
Creates a delegation signer (DS) record in the registry zone for this domain name.
CancelDomainTransferToAnotherAwsAccount ( array $params = [] )
Cancels the transfer of a domain from the current Amazon Web Services account to another Amazon Web Services account.
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.
DeleteDomain ( array $params = [] )
This operation deletes the specified domain.
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.
DisassociateDelegationSignerFromDomain ( array $params = [] )
Deletes a delegation signer (DS) record in the registry zone for this domain name.
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 Amazon Web Services account.
GetDomainSuggestions ( array $params = [] )
The GetDomainSuggestions operation returns a list of suggested domain names.
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 Amazon Web Services account if no filtering conditions are used.
ListOperations ( array $params = [] )
Returns information about all of the operations that return an operation ID and that have ever been performed on domains that were registered by the current account.
ListPrices ( array $params = [] )
Lists the following prices for either all the TLDs supported by Route 53, or the specified TLD: Registration Transfer Owner change Domain renewal Domain restoration
ListTagsForDomain ( array $params = [] )
This operation returns all of the tags that are associated with the specified domain.
PushDomain ( array $params = [] )
Moves a domain from Amazon Web Services to another registrar.
RegisterDomain ( array $params = [] )
This operation registers a domain.
RejectDomainTransferFromAnotherAwsAccount ( array $params = [] )
Rejects the transfer of a domain from another Amazon Web Services account to the current Amazon Web Services account.
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.
ResendOperationAuthorization ( array $params = [] )
Resend the form of authorization email for this operation.
RetrieveDomainAuthCode ( array $params = [] )
This operation returns the authorization code for the domain.
TransferDomain ( array $params = [] )
Transfers a domain from another registrar to Amazon Route 53.
TransferDomainToAnotherAwsAccount ( array $params = [] )
Transfers a domain from the current Amazon Web Services account to another Amazon Web Services account.
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 Amazon Web Services 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
ListPrices
ViewBilling

Operations

AcceptDomainTransferFromAnotherAwsAccount

$result = $client->acceptDomainTransferFromAnotherAwsAccount([/* ... */]);
$promise = $client->acceptDomainTransferFromAnotherAwsAccountAsync([/* ... */]);

Accepts the transfer of a domain from another Amazon Web Services account to the currentAmazon Web Services account. You initiate a transfer between Amazon Web Services accounts using TransferDomainToAnotherAwsAccount.

If you use the CLI command at accept-domain-transfer-from-another-aws-account, use JSON format as input instead of text because otherwise CLI will throw an error from domain transfer input that includes single quotes.

Use either ListOperations or GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled.

Parameter Syntax

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

Parameter Details

Members

DomainName

Required: Yes
Type: string

The name of the domain that was specified when another Amazon Web Services account submitted a TransferDomainToAnotherAwsAccount request.

Password

Required: Yes
Type: string

The password that was returned by the TransferDomainToAnotherAwsAccount request.

Result Syntax

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

Result Details

Members

OperationId

Type: string

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

Errors

InvalidInput:
The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.
OperationLimitExceeded:
The number of operations or jobs running exceeded the allowed threshold for the account.
DomainLimitExceeded:
The number of domains has exceeded the allowed threshold for the account.
UnsupportedTLD:
Amazon Route 53 does not support this top-level domain (TLD).

AssociateDelegationSignerToDomain

$result = $client->associateDelegationSignerToDomain([/* ... */]);
$promise = $client->associateDelegationSignerToDomainAsync([/* ... */]);

Creates a delegation signer (DS) record in the registry zone for this domain name.

Note that creating DS record at the registry impacts DNSSEC validation of your DNS records. This action may render your domain name unavailable on the internet if the steps are completed in the wrong order, or with incorrect timing. For more information about DNSSEC signing, see Configuring DNSSEC signing in the Route 53 developer guide.

Parameter Syntax

$result = $client->associateDelegationSignerToDomain([
    'DomainName' => '<string>', // REQUIRED
    'SigningAttributes' => [ // REQUIRED
        'Algorithm' => <integer>,
        'Flags' => <integer>,
        'PublicKey' => '<string>',
    ],
]);

Parameter Details

Members

DomainName

Required: Yes
Type: string

The name of the domain.

SigningAttributes

Required: Yes
Type: DnssecSigningAttributes structure

The information about a key, including the algorithm, public key-value, and flags.

Result Syntax

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

Result Details

Members

OperationId

Type: string

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

Errors

DuplicateRequest:
The request is already in progress for the domain.
InvalidInput:
The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.
OperationLimitExceeded:
The number of operations or jobs running exceeded the allowed threshold for the account.
TLDRulesViolation:
The top-level domain does not support this operation.
UnsupportedTLD:
Amazon Route 53 does not support this top-level domain (TLD).
DnssecLimitExceeded:
This error is returned if you call AssociateDelegationSignerToDomain when the specified domain has reached the maximum number of DS records. You can't add any additional DS records unless you delete an existing one first.

CancelDomainTransferToAnotherAwsAccount

$result = $client->cancelDomainTransferToAnotherAwsAccount([/* ... */]);
$promise = $client->cancelDomainTransferToAnotherAwsAccountAsync([/* ... */]);

Cancels the transfer of a domain from the current Amazon Web Services account to another Amazon Web Services account. You initiate a transfer betweenAmazon Web Services accounts using TransferDomainToAnotherAwsAccount.

You must cancel the transfer before the other Amazon Web Services account accepts the transfer using AcceptDomainTransferFromAnotherAwsAccount.

Parameter Syntax

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

Parameter Details

Members

DomainName

Required: Yes
Type: string

The name of the domain for which you want to cancel the transfer to another Amazon Web Services account.

Result Syntax

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

Result Details

Members

OperationId

Type: string

The identifier that TransferDomainToAnotherAwsAccount returned to track the progress of the request. Because the transfer request was canceled, the value is no longer valid, and you can't use GetOperationDetail to query the operation status.

Errors

InvalidInput:
The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.
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).

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

Required: Yes
Type: string

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

The domain name can contain only the following characters:

Letters a through z. Domain names are not case sensitive.
Numbers 0 through 9.
Hyphen (-). You can't specify a hyphen at the beginning or end of a label.
Period (.) to separate the labels in the name, such as the . in example.com.

Internationalized domain names are not supported for some top-level domains. To determine whether the TLD that you want to use supports internationalized domain names, see Domains that You Can Register with Amazon Route 53. For more information, see Formatting Internationalized Domain Names.

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. 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 APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.
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

Required: Yes
Type: string

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

The domain name can contain only the following characters:

Letters a through z. Domain names are not case sensitive.
Numbers 0 through 9.
Hyphen (-). You can't specify a hyphen at the beginning or end of a label.
Period (.) to separate the labels in the name, such as the . in example.com.

Result Syntax

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

Result Details

Members

Transferability

Type: DomainTransferability structure

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

Errors

InvalidInput:
The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.
UnsupportedTLD:
Amazon Route 53 does not support this top-level domain (TLD).

DeleteDomain

$result = $client->deleteDomain([/* ... */]);
$promise = $client->deleteDomainAsync([/* ... */]);

This operation deletes the specified domain. This action is permanent. For more information, see Deleting a domain name registration.

To transfer the domain registration to another registrar, use the transfer process that’s provided by the registrar to which you want to transfer the registration. Otherwise, the following apply:

You can’t get a refund for the cost of a deleted domain registration.
The registry for the top-level domain might hold the domain name for a brief time before releasing it for other users to register (varies by registry).
When the registration has been deleted, we'll send you a confirmation to the registrant contact. The email will come from noreply@domainnameverification.net or noreply@registrar.amazon.com.

Parameter Syntax

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

Parameter Details

Members

DomainName

Required: Yes
Type: string

Name of the domain to be deleted.

Result Syntax

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

Result Details

Members

OperationId

Type: string

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

Errors

InvalidInput:
The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.
DuplicateRequest:
The request is already in progress for the domain.
TLDRulesViolation:
The top-level domain does not support this operation.
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

Required: Yes
Type: string

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

TagsToDelete

Required: Yes
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 APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.
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

Required: Yes
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 APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.
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

Required: Yes
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 query the operation status, use GetOperationDetail.

Errors

InvalidInput:
The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.
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).

DisassociateDelegationSignerFromDomain

$result = $client->disassociateDelegationSignerFromDomain([/* ... */]);
$promise = $client->disassociateDelegationSignerFromDomainAsync([/* ... */]);

Deletes a delegation signer (DS) record in the registry zone for this domain name.

Parameter Syntax

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

Parameter Details

Members

DomainName

Required: Yes
Type: string

Name of the domain.

Id

Required: Yes
Type: string

An internal identification number assigned to each DS record after it’s created. You can retrieve it as part of DNSSEC information returned by GetDomainDetail.

Result Syntax

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

Result Details

Members

OperationId

Type: string

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

Errors

DuplicateRequest:
The request is already in progress for the domain.
InvalidInput:
The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.
OperationLimitExceeded:
The number of operations or jobs running exceeded the allowed threshold for the account.
TLDRulesViolation:
The top-level domain does not support this operation.
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 Amazon Web Services account.

The period during which you can renew a domain name varies by TLD. For a list of TLDs and their renewal policies, see Domains That You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide. Route 53 requires that you renew before the end of the renewal period so we can complete processing before the deadline.

Parameter Syntax

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

Parameter Details

Members

DomainName

Required: Yes
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 APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.
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

Required: Yes
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 APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.
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 APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.
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 Amazon Web Services 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

Required: Yes
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' => 'AC|AD|AE|AF|AG|AI|AL|AM|AN|AO|AQ|AR|AS|AT|AU|AW|AX|AZ|BA|BB|BD|BE|BF|BG|BH|BI|BJ|BL|BM|BN|BO|BQ|BR|BS|BT|BV|BW|BY|BZ|CA|CC|CD|CF|CG|CH|CI|CK|CL|CM|CN|CO|CR|CU|CV|CW|CX|CY|CZ|DE|DJ|DK|DM|DO|DZ|EC|EE|EG|EH|ER|ES|ET|FI|FJ|FK|FM|FO|FR|GA|GB|GD|GE|GF|GG|GH|GI|GL|GM|GN|GP|GQ|GR|GS|GT|GU|GW|GY|HK|HM|HN|HR|HT|HU|ID|IE|IL|IM|IN|IO|IQ|IR|IS|IT|JE|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|MQ|MR|MS|MT|MU|MV|MW|MX|MY|MZ|NA|NC|NE|NF|NG|NI|NL|NO|NP|NR|NU|NZ|OM|PA|PE|PF|PG|PH|PK|PL|PM|PN|PR|PS|PT|PW|PY|QA|RE|RO|RS|RU|RW|SA|SB|SC|SD|SE|SG|SH|SI|SJ|SK|SL|SM|SN|SO|SR|SS|ST|SV|SX|SY|SZ|TC|TD|TF|TG|TH|TJ|TK|TL|TM|TN|TO|TP|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|CA_LEGAL_REPRESENTATIVE|CA_LEGAL_REPRESENTATIVE_CAPACITY|ES_IDENTIFICATION|ES_IDENTIFICATION_TYPE|ES_LEGAL_FORM|FI_BUSINESS_NUMBER|FI_ID_NUMBER|FI_NATIONALITY|FI_ORGANIZATION_TYPE|IT_NATIONALITY|IT_PIN|IT_REGISTRANT_ENTITY_TYPE|RU_PASSPORT_DATA|SE_ID_NUMBER|SG_ID_NUMBER|VAT_NUMBER|UK_CONTACT_TYPE|UK_COMPANY_NUMBER|EU_COUNTRY_OF_CITIZENSHIP|AU_PRIORITY_TOKEN',
                '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>',
    'DnssecKeys' => [
        [
            'Algorithm' => <integer>,
            'Digest' => '<string>',
            'DigestType' => <integer>,
            'Flags' => <integer>,
            'Id' => '<string>',
            'KeyTag' => <integer>,
            'PublicKey' => '<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' => 'AC|AD|AE|AF|AG|AI|AL|AM|AN|AO|AQ|AR|AS|AT|AU|AW|AX|AZ|BA|BB|BD|BE|BF|BG|BH|BI|BJ|BL|BM|BN|BO|BQ|BR|BS|BT|BV|BW|BY|BZ|CA|CC|CD|CF|CG|CH|CI|CK|CL|CM|CN|CO|CR|CU|CV|CW|CX|CY|CZ|DE|DJ|DK|DM|DO|DZ|EC|EE|EG|EH|ER|ES|ET|FI|FJ|FK|FM|FO|FR|GA|GB|GD|GE|GF|GG|GH|GI|GL|GM|GN|GP|GQ|GR|GS|GT|GU|GW|GY|HK|HM|HN|HR|HT|HU|ID|IE|IL|IM|IN|IO|IQ|IR|IS|IT|JE|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|MQ|MR|MS|MT|MU|MV|MW|MX|MY|MZ|NA|NC|NE|NF|NG|NI|NL|NO|NP|NR|NU|NZ|OM|PA|PE|PF|PG|PH|PK|PL|PM|PN|PR|PS|PT|PW|PY|QA|RE|RO|RS|RU|RW|SA|SB|SC|SD|SE|SG|SH|SI|SJ|SK|SL|SM|SN|SO|SR|SS|ST|SV|SX|SY|SZ|TC|TD|TF|TG|TH|TJ|TK|TL|TM|TN|TO|TP|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|CA_LEGAL_REPRESENTATIVE|CA_LEGAL_REPRESENTATIVE_CAPACITY|ES_IDENTIFICATION|ES_IDENTIFICATION_TYPE|ES_LEGAL_FORM|FI_BUSINESS_NUMBER|FI_ID_NUMBER|FI_NATIONALITY|FI_ORGANIZATION_TYPE|IT_NATIONALITY|IT_PIN|IT_REGISTRANT_ENTITY_TYPE|RU_PASSPORT_DATA|SE_ID_NUMBER|SG_ID_NUMBER|VAT_NUMBER|UK_CONTACT_TYPE|UK_COMPANY_NUMBER|EU_COUNTRY_OF_CITIZENSHIP|AU_PRIORITY_TOKEN',
                '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' => 'AC|AD|AE|AF|AG|AI|AL|AM|AN|AO|AQ|AR|AS|AT|AU|AW|AX|AZ|BA|BB|BD|BE|BF|BG|BH|BI|BJ|BL|BM|BN|BO|BQ|BR|BS|BT|BV|BW|BY|BZ|CA|CC|CD|CF|CG|CH|CI|CK|CL|CM|CN|CO|CR|CU|CV|CW|CX|CY|CZ|DE|DJ|DK|DM|DO|DZ|EC|EE|EG|EH|ER|ES|ET|FI|FJ|FK|FM|FO|FR|GA|GB|GD|GE|GF|GG|GH|GI|GL|GM|GN|GP|GQ|GR|GS|GT|GU|GW|GY|HK|HM|HN|HR|HT|HU|ID|IE|IL|IM|IN|IO|IQ|IR|IS|IT|JE|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|MQ|MR|MS|MT|MU|MV|MW|MX|MY|MZ|NA|NC|NE|NF|NG|NI|NL|NO|NP|NR|NU|NZ|OM|PA|PE|PF|PG|PH|PK|PL|PM|PN|PR|PS|PT|PW|PY|QA|RE|RO|RS|RU|RW|SA|SB|SC|SD|SE|SG|SH|SI|SJ|SK|SL|SM|SN|SO|SR|SS|ST|SV|SX|SY|SZ|TC|TD|TF|TG|TH|TJ|TK|TL|TM|TN|TO|TP|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|CA_LEGAL_REPRESENTATIVE|CA_LEGAL_REPRESENTATIVE_CAPACITY|ES_IDENTIFICATION|ES_IDENTIFICATION_TYPE|ES_LEGAL_FORM|FI_BUSINESS_NUMBER|FI_ID_NUMBER|FI_NATIONALITY|FI_ORGANIZATION_TYPE|IT_NATIONALITY|IT_PIN|IT_REGISTRANT_ENTITY_TYPE|RU_PASSPORT_DATA|SE_ID_NUMBER|SG_ID_NUMBER|VAT_NUMBER|UK_CONTACT_TYPE|UK_COMPANY_NUMBER|EU_COUNTRY_OF_CITIZENSHIP|AU_PRIORITY_TOKEN',
                '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 Unix time format and Coordinated Universal time (UTC).

DnsSec

Type: string

Deprecated.

DnssecKeys

Type: Array of DnssecKey structures

A complex type that contains information about the DNSSEC configuration.

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 Unix time format and Coordinated Universal time (UTC).

Nameservers

Type: Array of Nameserver structures

The name servers 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 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 Unix time format and 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 APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.
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.

Parameter Syntax

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

Parameter Details

Members

DomainName

Required: Yes
Type: string

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

The domain name can contain only the following characters:

Letters a through z. Domain names are not case sensitive.
Numbers 0 through 9.
Hyphen (-). You can't specify a hyphen at the beginning or end of a label.
Period (.) to separate the labels in the name, such as the . in example.com.

OnlyAvailable

Required: Yes
Type: boolean

If OnlyAvailable is true, Route 53 returns only domain names that are available. If OnlyAvailable is false, 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

Required: Yes
Type: int

The number of suggested domain names that you want Route 53 to return. Specify a value between 1 and 50.

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 APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.
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

Required: Yes
Type: string

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

Result Syntax

[
    'DomainName' => '<string>',
    'LastUpdatedDate' => <DateTime>,
    'Message' => '<string>',
    'OperationId' => '<string>',
    'Status' => 'SUBMITTED|IN_PROGRESS|ERROR|SUCCESSFUL|FAILED',
    'StatusFlag' => 'PENDING_ACCEPTANCE|PENDING_CUSTOMER_ACTION|PENDING_AUTHORIZATION|PENDING_PAYMENT_VERIFICATION|PENDING_SUPPORT_CASE',
    '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|INTERNAL_TRANSFER_OUT_DOMAIN|INTERNAL_TRANSFER_IN_DOMAIN',
]

Result Details

Members

DomainName

Type: string

The name of a domain.

LastUpdatedDate

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

The date when the operation was last updated.

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.

StatusFlag

Type: string

Lists any outstanding operations that require customer action. Valid values are:

PENDING_ACCEPTANCE: The operation is waiting for acceptance from the account that is receiving the domain.
PENDING_CUSTOMER_ACTION: The operation is waiting for customer action, for example, returning an email.
PENDING_AUTHORIZATION: The operation is waiting for the form of authorization. For more information, see ResendOperationAuthorization.
PENDING_PAYMENT_VERIFICATION: The operation is waiting for the payment method to validate.
PENDING_SUPPORT_CASE: The operation includes a support case and is waiting for its resolution.

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 APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.

ListDomains

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

This operation returns all the domain names registered with Amazon Route 53 for the current Amazon Web Services account if no filtering conditions are used.

Parameter Syntax

$result = $client->listDomains([
    'FilterConditions' => [
        [
            'Name' => 'DomainName|Expiry', // REQUIRED
            'Operator' => 'LE|GE|BEGINS_WITH', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'Marker' => '<string>',
    'MaxItems' => <integer>,
    'SortCondition' => [
        'Name' => 'DomainName|Expiry', // REQUIRED
        'SortOrder' => 'ASC|DESC', // REQUIRED
    ],
]);

Parameter Details

Members

FilterConditions

Type: Array of FilterCondition structures

A complex type that contains information about the filters applied during the ListDomains request. The filter conditions can include domain name and domain expiration.

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 Amazon Web Services 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

SortCondition

Type: SortCondition structure

A complex type that contains information about the requested ordering of domains in the returned list.

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 list 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 APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.

ListOperations

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

Returns information about all of the operations that return an operation ID and that have ever been performed on domains that were registered by the current account.

This command runs only in the us-east-1 Region.

Parameter Syntax

$result = $client->listOperations([
    'Marker' => '<string>',
    'MaxItems' => <integer>,
    'SortBy' => 'SubmittedDate',
    'SortOrder' => 'ASC|DESC',
    'Status' => ['<string>', ...],
    'SubmittedSince' => <integer || string || DateTime>,
    'Type' => ['<string>', ...],
]);

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

SortBy

Type: string

The sort type for returned values.

SortOrder

Type: string

The sort order ofr returned values, either ascending or descending.

Status

Type: Array of strings

The status of the operations.

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 Unix time format and Coordinated Universal time (UTC).

Type

Type: Array of strings

An arrays of the domains operation types.

Result Syntax

[
    'NextPageMarker' => '<string>',
    'Operations' => [
        [
            'DomainName' => '<string>',
            'LastUpdatedDate' => <DateTime>,
            'Message' => '<string>',
            'OperationId' => '<string>',
            'Status' => 'SUBMITTED|IN_PROGRESS|ERROR|SUCCESSFUL|FAILED',
            'StatusFlag' => 'PENDING_ACCEPTANCE|PENDING_CUSTOMER_ACTION|PENDING_AUTHORIZATION|PENDING_PAYMENT_VERIFICATION|PENDING_SUPPORT_CASE',
            '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|INTERNAL_TRANSFER_OUT_DOMAIN|INTERNAL_TRANSFER_IN_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 APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.

ListPrices

$result = $client->listPrices([/* ... */]);
$promise = $client->listPricesAsync([/* ... */]);

Lists the following prices for either all the TLDs supported by Route 53, or the specified TLD:

Registration
Transfer
Owner change
Domain renewal
Domain restoration

Parameter Syntax

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

Parameter Details

Members

Marker

Type: string

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

Used only for all TLDs. If you specify a TLD, don't specify a Marker.

MaxItems

Type: int

Number of Prices to be returned.

Used only for all TLDs. If you specify a TLD, don't specify a MaxItems.

Tld

Type: string

The TLD for which you want to receive the pricing information. For example. .net.

If a Tld value is not provided, a list of prices for all TLDs supported by Route 53 is returned.

Result Syntax

[
    'NextPageMarker' => '<string>',
    'Prices' => [
        [
            'ChangeOwnershipPrice' => [
                'Currency' => '<string>',
                'Price' => <float>,
            ],
            'Name' => '<string>',
            'RegistrationPrice' => [
                'Currency' => '<string>',
                'Price' => <float>,
            ],
            'RenewalPrice' => [
                'Currency' => '<string>',
                'Price' => <float>,
            ],
            'RestorationPrice' => [
                'Currency' => '<string>',
                'Price' => <float>,
            ],
            'TransferPrice' => [
                'Currency' => '<string>',
                'Price' => <float>,
            ],
        ],
        // ...
    ],
]

Result Details

Members

NextPageMarker

Type: string

If there are more prices than you specified for MaxItems in the request, submit another request and include the value of NextPageMarker in the value of Marker.

Used only for all TLDs. If you specify a TLD, don't specify a NextPageMarker.

Prices

Type: Array of DomainPrice structures

A complex type that includes all the pricing information. If you specify a TLD, this array contains only the pricing for that TLD.

Errors

InvalidInput:
The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.
UnsupportedTLD:
Amazon Route 53 does not support this top-level domain (TLD).

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

Required: Yes
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 APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.
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).

PushDomain

$result = $client->pushDomain([/* ... */]);
$promise = $client->pushDomainAsync([/* ... */]);

Moves a domain from Amazon Web Services to another registrar.

Supported actions:

Changes the IPS tags of a .uk domain, and pushes it to transit. Transit means that the domain is ready to be transferred to another registrar.

Parameter Syntax

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

Parameter Details

Members

DomainName

Required: Yes
Type: string

Name of the domain.

Target

Required: Yes
Type: string

New IPS tag for the domain.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidInput:
The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.
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 Route 53 hosted zone that has the same name as the domain. Route 53 assigns four name servers to your hosted zone and automatically updates your domain registration with the names of these name servers.
Enables auto renew, 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 administrative, registrant, and technical contacts.

You must specify the same privacy setting for the administrative, registrant, and technical 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 Amazon Web Services 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' => 'AC|AD|AE|AF|AG|AI|AL|AM|AN|AO|AQ|AR|AS|AT|AU|AW|AX|AZ|BA|BB|BD|BE|BF|BG|BH|BI|BJ|BL|BM|BN|BO|BQ|BR|BS|BT|BV|BW|BY|BZ|CA|CC|CD|CF|CG|CH|CI|CK|CL|CM|CN|CO|CR|CU|CV|CW|CX|CY|CZ|DE|DJ|DK|DM|DO|DZ|EC|EE|EG|EH|ER|ES|ET|FI|FJ|FK|FM|FO|FR|GA|GB|GD|GE|GF|GG|GH|GI|GL|GM|GN|GP|GQ|GR|GS|GT|GU|GW|GY|HK|HM|HN|HR|HT|HU|ID|IE|IL|IM|IN|IO|IQ|IR|IS|IT|JE|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|MQ|MR|MS|MT|MU|MV|MW|MX|MY|MZ|NA|NC|NE|NF|NG|NI|NL|NO|NP|NR|NU|NZ|OM|PA|PE|PF|PG|PH|PK|PL|PM|PN|PR|PS|PT|PW|PY|QA|RE|RO|RS|RU|RW|SA|SB|SC|SD|SE|SG|SH|SI|SJ|SK|SL|SM|SN|SO|SR|SS|ST|SV|SX|SY|SZ|TC|TD|TF|TG|TH|TJ|TK|TL|TM|TN|TO|TP|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|CA_LEGAL_REPRESENTATIVE|CA_LEGAL_REPRESENTATIVE_CAPACITY|ES_IDENTIFICATION|ES_IDENTIFICATION_TYPE|ES_LEGAL_FORM|FI_BUSINESS_NUMBER|FI_ID_NUMBER|FI_NATIONALITY|FI_ORGANIZATION_TYPE|IT_NATIONALITY|IT_PIN|IT_REGISTRANT_ENTITY_TYPE|RU_PASSPORT_DATA|SE_ID_NUMBER|SG_ID_NUMBER|VAT_NUMBER|UK_CONTACT_TYPE|UK_COMPANY_NUMBER|EU_COUNTRY_OF_CITIZENSHIP|AU_PRIORITY_TOKEN', // 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' => 'AC|AD|AE|AF|AG|AI|AL|AM|AN|AO|AQ|AR|AS|AT|AU|AW|AX|AZ|BA|BB|BD|BE|BF|BG|BH|BI|BJ|BL|BM|BN|BO|BQ|BR|BS|BT|BV|BW|BY|BZ|CA|CC|CD|CF|CG|CH|CI|CK|CL|CM|CN|CO|CR|CU|CV|CW|CX|CY|CZ|DE|DJ|DK|DM|DO|DZ|EC|EE|EG|EH|ER|ES|ET|FI|FJ|FK|FM|FO|FR|GA|GB|GD|GE|GF|GG|GH|GI|GL|GM|GN|GP|GQ|GR|GS|GT|GU|GW|GY|HK|HM|HN|HR|HT|HU|ID|IE|IL|IM|IN|IO|IQ|IR|IS|IT|JE|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|MQ|MR|MS|MT|MU|MV|MW|MX|MY|MZ|NA|NC|NE|NF|NG|NI|NL|NO|NP|NR|NU|NZ|OM|PA|PE|PF|PG|PH|PK|PL|PM|PN|PR|PS|PT|PW|PY|QA|RE|RO|RS|RU|RW|SA|SB|SC|SD|SE|SG|SH|SI|SJ|SK|SL|SM|SN|SO|SR|SS|ST|SV|SX|SY|SZ|TC|TD|TF|TG|TH|TJ|TK|TL|TM|TN|TO|TP|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|CA_LEGAL_REPRESENTATIVE|CA_LEGAL_REPRESENTATIVE_CAPACITY|ES_IDENTIFICATION|ES_IDENTIFICATION_TYPE|ES_LEGAL_FORM|FI_BUSINESS_NUMBER|FI_ID_NUMBER|FI_NATIONALITY|FI_ORGANIZATION_TYPE|IT_NATIONALITY|IT_PIN|IT_REGISTRANT_ENTITY_TYPE|RU_PASSPORT_DATA|SE_ID_NUMBER|SG_ID_NUMBER|VAT_NUMBER|UK_CONTACT_TYPE|UK_COMPANY_NUMBER|EU_COUNTRY_OF_CITIZENSHIP|AU_PRIORITY_TOKEN', // 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' => 'AC|AD|AE|AF|AG|AI|AL|AM|AN|AO|AQ|AR|AS|AT|AU|AW|AX|AZ|BA|BB|BD|BE|BF|BG|BH|BI|BJ|BL|BM|BN|BO|BQ|BR|BS|BT|BV|BW|BY|BZ|CA|CC|CD|CF|CG|CH|CI|CK|CL|CM|CN|CO|CR|CU|CV|CW|CX|CY|CZ|DE|DJ|DK|DM|DO|DZ|EC|EE|EG|EH|ER|ES|ET|FI|FJ|FK|FM|FO|FR|GA|GB|GD|GE|GF|GG|GH|GI|GL|GM|GN|GP|GQ|GR|GS|GT|GU|GW|GY|HK|HM|HN|HR|HT|HU|ID|IE|IL|IM|IN|IO|IQ|IR|IS|IT|JE|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|MQ|MR|MS|MT|MU|MV|MW|MX|MY|MZ|NA|NC|NE|NF|NG|NI|NL|NO|NP|NR|NU|NZ|OM|PA|PE|PF|PG|PH|PK|PL|PM|PN|PR|PS|PT|PW|PY|QA|RE|RO|RS|RU|RW|SA|SB|SC|SD|SE|SG|SH|SI|SJ|SK|SL|SM|SN|SO|SR|SS|ST|SV|SX|SY|SZ|TC|TD|TF|TG|TH|TJ|TK|TL|TM|TN|TO|TP|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|CA_LEGAL_REPRESENTATIVE|CA_LEGAL_REPRESENTATIVE_CAPACITY|ES_IDENTIFICATION|ES_IDENTIFICATION_TYPE|ES_LEGAL_FORM|FI_BUSINESS_NUMBER|FI_ID_NUMBER|FI_NATIONALITY|FI_ORGANIZATION_TYPE|IT_NATIONALITY|IT_PIN|IT_REGISTRANT_ENTITY_TYPE|RU_PASSPORT_DATA|SE_ID_NUMBER|SG_ID_NUMBER|VAT_NUMBER|UK_CONTACT_TYPE|UK_COMPANY_NUMBER|EU_COUNTRY_OF_CITIZENSHIP|AU_PRIORITY_TOKEN', // REQUIRED
                'Value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'Fax' => '<string>',
        'FirstName' => '<string>',
        'LastName' => '<string>',
        'OrganizationName' => '<string>',
        'PhoneNumber' => '<string>',
        'State' => '<string>',
        'ZipCode' => '<string>',
    ],
]);

Parameter Details

Members

AdminContact

Required: Yes
Type: ContactDetail structure

Provides detailed contact information. For information about the values that you specify for each element, see ContactDetail.

AutoRenew

Type: boolean

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

Default: true

DomainName

Required: Yes
Type: string

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

The domain name can contain only the following characters:

Letters a through z. Domain names are not case sensitive.
Numbers 0 through 9.
Hyphen (-). You can't specify a hyphen at the beginning or end of a label.
Period (.) to separate the labels in the name, such as the . in example.com.

DurationInYears

Required: Yes
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.

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

Default: true

PrivacyProtectRegistrantContact

Type: boolean

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

Default: true

PrivacyProtectTechContact

Type: boolean

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

Default: true

RegistrantContact

Required: Yes
Type: ContactDetail structure

Provides detailed contact information. For information about the values that you specify for each element, see ContactDetail.

TechContact

Required: Yes
Type: ContactDetail structure

Provides detailed contact information. For information about the values that you specify for each element, see ContactDetail.

Result Syntax

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

Result Details

Members

OperationId

Type: string

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

Errors

InvalidInput:
The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.
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.

RejectDomainTransferFromAnotherAwsAccount

$result = $client->rejectDomainTransferFromAnotherAwsAccount([/* ... */]);
$promise = $client->rejectDomainTransferFromAnotherAwsAccountAsync([/* ... */]);

Rejects the transfer of a domain from another Amazon Web Services account to the current Amazon Web Services account. You initiate a transfer betweenAmazon Web Services accounts using TransferDomainToAnotherAwsAccount.

Parameter Syntax

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

Parameter Details

Members

DomainName

Required: Yes
Type: string

The name of the domain that was specified when another Amazon Web Services account submitted a TransferDomainToAnotherAwsAccount request.

Result Syntax

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

Result Details

Members

OperationId

Type: string

The identifier that TransferDomainToAnotherAwsAccount returned to track the progress of the request. Because the transfer request was rejected, the value is no longer valid, and you can't use GetOperationDetail to query the operation status.

Errors

InvalidInput:
The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.
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).

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 Amazon Web Services 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

Required: Yes
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

Required: Yes
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

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

Errors

InvalidInput:
The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.
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 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 APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.
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).

ResendOperationAuthorization

$result = $client->resendOperationAuthorization([/* ... */]);
$promise = $client->resendOperationAuthorizationAsync([/* ... */]);

Resend the form of authorization email for this operation.

Parameter Syntax

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

Parameter Details

Members

OperationId

Required: Yes
Type: string

Operation ID.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidInput:
The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.

RetrieveDomainAuthCode

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

This operation returns the authorization code 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

Required: Yes
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 APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.
UnsupportedTLD:
Amazon Route 53 does not support this top-level domain (TLD).

TransferDomain

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

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 more information about transferring domains, see the following topics:

For transfer requirements, a detailed procedure, and information about viewing the status of a domain that you're transferring to Route 53, see Transferring Registration for a Domain to Amazon Route 53 in the Amazon Route 53 Developer Guide.
For information about how to transfer a domain from one Amazon Web Services account to another, see TransferDomainToAnotherAwsAccount.
For information about how to transfer a domain to another domain registrar, see Transferring a Domain from Amazon Route 53 to Another Registrar 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 transfer your DNS service to 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' => 'AC|AD|AE|AF|AG|AI|AL|AM|AN|AO|AQ|AR|AS|AT|AU|AW|AX|AZ|BA|BB|BD|BE|BF|BG|BH|BI|BJ|BL|BM|BN|BO|BQ|BR|BS|BT|BV|BW|BY|BZ|CA|CC|CD|CF|CG|CH|CI|CK|CL|CM|CN|CO|CR|CU|CV|CW|CX|CY|CZ|DE|DJ|DK|DM|DO|DZ|EC|EE|EG|EH|ER|ES|ET|FI|FJ|FK|FM|FO|FR|GA|GB|GD|GE|GF|GG|GH|GI|GL|GM|GN|GP|GQ|GR|GS|GT|GU|GW|GY|HK|HM|HN|HR|HT|HU|ID|IE|IL|IM|IN|IO|IQ|IR|IS|IT|JE|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|MQ|MR|MS|MT|MU|MV|MW|MX|MY|MZ|NA|NC|NE|NF|NG|NI|NL|NO|NP|NR|NU|NZ|OM|PA|PE|PF|PG|PH|PK|PL|PM|PN|PR|PS|PT|PW|PY|QA|RE|RO|RS|RU|RW|SA|SB|SC|SD|SE|SG|SH|SI|SJ|SK|SL|SM|SN|SO|SR|SS|ST|SV|SX|SY|SZ|TC|TD|TF|TG|TH|TJ|TK|TL|TM|TN|TO|TP|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|CA_LEGAL_REPRESENTATIVE|CA_LEGAL_REPRESENTATIVE_CAPACITY|ES_IDENTIFICATION|ES_IDENTIFICATION_TYPE|ES_LEGAL_FORM|FI_BUSINESS_NUMBER|FI_ID_NUMBER|FI_NATIONALITY|FI_ORGANIZATION_TYPE|IT_NATIONALITY|IT_PIN|IT_REGISTRANT_ENTITY_TYPE|RU_PASSPORT_DATA|SE_ID_NUMBER|SG_ID_NUMBER|VAT_NUMBER|UK_CONTACT_TYPE|UK_COMPANY_NUMBER|EU_COUNTRY_OF_CITIZENSHIP|AU_PRIORITY_TOKEN', // 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' => 'AC|AD|AE|AF|AG|AI|AL|AM|AN|AO|AQ|AR|AS|AT|AU|AW|AX|AZ|BA|BB|BD|BE|BF|BG|BH|BI|BJ|BL|BM|BN|BO|BQ|BR|BS|BT|BV|BW|BY|BZ|CA|CC|CD|CF|CG|CH|CI|CK|CL|CM|CN|CO|CR|CU|CV|CW|CX|CY|CZ|DE|DJ|DK|DM|DO|DZ|EC|EE|EG|EH|ER|ES|ET|FI|FJ|FK|FM|FO|FR|GA|GB|GD|GE|GF|GG|GH|GI|GL|GM|GN|GP|GQ|GR|GS|GT|GU|GW|GY|HK|HM|HN|HR|HT|HU|ID|IE|IL|IM|IN|IO|IQ|IR|IS|IT|JE|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|MQ|MR|MS|MT|MU|MV|MW|MX|MY|MZ|NA|NC|NE|NF|NG|NI|NL|NO|NP|NR|NU|NZ|OM|PA|PE|PF|PG|PH|PK|PL|PM|PN|PR|PS|PT|PW|PY|QA|RE|RO|RS|RU|RW|SA|SB|SC|SD|SE|SG|SH|SI|SJ|SK|SL|SM|SN|SO|SR|SS|ST|SV|SX|SY|SZ|TC|TD|TF|TG|TH|TJ|TK|TL|TM|TN|TO|TP|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|CA_LEGAL_REPRESENTATIVE|CA_LEGAL_REPRESENTATIVE_CAPACITY|ES_IDENTIFICATION|ES_IDENTIFICATION_TYPE|ES_LEGAL_FORM|FI_BUSINESS_NUMBER|FI_ID_NUMBER|FI_NATIONALITY|FI_ORGANIZATION_TYPE|IT_NATIONALITY|IT_PIN|IT_REGISTRANT_ENTITY_TYPE|RU_PASSPORT_DATA|SE_ID_NUMBER|SG_ID_NUMBER|VAT_NUMBER|UK_CONTACT_TYPE|UK_COMPANY_NUMBER|EU_COUNTRY_OF_CITIZENSHIP|AU_PRIORITY_TOKEN', // 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' => 'AC|AD|AE|AF|AG|AI|AL|AM|AN|AO|AQ|AR|AS|AT|AU|AW|AX|AZ|BA|BB|BD|BE|BF|BG|BH|BI|BJ|BL|BM|BN|BO|BQ|BR|BS|BT|BV|BW|BY|BZ|CA|CC|CD|CF|CG|CH|CI|CK|CL|CM|CN|CO|CR|CU|CV|CW|CX|CY|CZ|DE|DJ|DK|DM|DO|DZ|EC|EE|EG|EH|ER|ES|ET|FI|FJ|FK|FM|FO|FR|GA|GB|GD|GE|GF|GG|GH|GI|GL|GM|GN|GP|GQ|GR|GS|GT|GU|GW|GY|HK|HM|HN|HR|HT|HU|ID|IE|IL|IM|IN|IO|IQ|IR|IS|IT|JE|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|MQ|MR|MS|MT|MU|MV|MW|MX|MY|MZ|NA|NC|NE|NF|NG|NI|NL|NO|NP|NR|NU|NZ|OM|PA|PE|PF|PG|PH|PK|PL|PM|PN|PR|PS|PT|PW|PY|QA|RE|RO|RS|RU|RW|SA|SB|SC|SD|SE|SG|SH|SI|SJ|SK|SL|SM|SN|SO|SR|SS|ST|SV|SX|SY|SZ|TC|TD|TF|TG|TH|TJ|TK|TL|TM|TN|TO|TP|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|CA_LEGAL_REPRESENTATIVE|CA_LEGAL_REPRESENTATIVE_CAPACITY|ES_IDENTIFICATION|ES_IDENTIFICATION_TYPE|ES_LEGAL_FORM|FI_BUSINESS_NUMBER|FI_ID_NUMBER|FI_NATIONALITY|FI_ORGANIZATION_TYPE|IT_NATIONALITY|IT_PIN|IT_REGISTRANT_ENTITY_TYPE|RU_PASSPORT_DATA|SE_ID_NUMBER|SG_ID_NUMBER|VAT_NUMBER|UK_CONTACT_TYPE|UK_COMPANY_NUMBER|EU_COUNTRY_OF_CITIZENSHIP|AU_PRIORITY_TOKEN', // REQUIRED
                'Value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'Fax' => '<string>',
        'FirstName' => '<string>',
        'LastName' => '<string>',
        'OrganizationName' => '<string>',
        'PhoneNumber' => '<string>',
        'State' => '<string>',
        'ZipCode' => '<string>',
    ],
]);

Parameter Details

Members

AdminContact

Required: Yes
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). Auto renewal only takes effect after the account is charged.

Default: true

DomainName

Required: Yes
Type: string

The domain name can contain only the following characters:

Letters a through z. Domain names are not case sensitive.
Numbers 0 through 9.
Hyphen (-). You can't specify a hyphen at the beginning or end of a label.
Period (.) to separate the labels in the name, such as the . in example.com.

DurationInYears

Required: Yes
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

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

Default: true

PrivacyProtectRegistrantContact

Type: boolean

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

Default: true

PrivacyProtectTechContact

Type: boolean

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

Default: true

RegistrantContact

Required: Yes
Type: ContactDetail structure

Provides detailed contact information.

TechContact

Required: Yes
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 query the operation status, use GetOperationDetail.

Errors

InvalidInput:
The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.
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.

TransferDomainToAnotherAwsAccount

$result = $client->transferDomainToAnotherAwsAccount([/* ... */]);
$promise = $client->transferDomainToAnotherAwsAccountAsync([/* ... */]);

Transfers a domain from the current Amazon Web Services account to another Amazon Web Services account. Note the following:

The Amazon Web Services account that you're transferring the domain to must accept the transfer. If the other account doesn't accept the transfer within 3 days, we cancel the transfer. See AcceptDomainTransferFromAnotherAwsAccount.
You can cancel the transfer before the other account accepts it. See CancelDomainTransferToAnotherAwsAccount.
The other account can reject the transfer. See RejectDomainTransferFromAnotherAwsAccount.

When you transfer a domain from one Amazon Web Services account to another, Route 53 doesn't transfer the hosted zone that is associated with the domain. DNS resolution isn't affected if the domain and the hosted zone are owned by separate accounts, so transferring the hosted zone is optional. For information about transferring the hosted zone to another Amazon Web Services account, see Migrating a Hosted Zone to a Different Amazon Web Services Account in the Amazon Route 53 Developer Guide.

Parameter Syntax

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

Parameter Details

Members

AccountId

Required: Yes
Type: string

The account ID of the Amazon Web Services account that you want to transfer the domain to, for example, 111122223333.

DomainName

Required: Yes
Type: string

The name of the domain that you want to transfer from the current Amazon Web Services account to another account.

Result Syntax

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

Result Details

Members

OperationId

Type: string

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

Password

Type: string

To finish transferring a domain to another Amazon Web Services account, the account that the domain is being transferred to must submit an AcceptDomainTransferFromAnotherAwsAccount request. The request must include the value of the Password element that was returned in the TransferDomainToAnotherAwsAccount response.

Errors

InvalidInput:
The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.
OperationLimitExceeded:
The number of operations or jobs running exceeded the allowed threshold for the account.
DuplicateRequest:
The request is already in progress for the domain.
UnsupportedTLD:
Amazon Route 53 does not support this top-level domain (TLD).

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 operation. 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' => 'AC|AD|AE|AF|AG|AI|AL|AM|AN|AO|AQ|AR|AS|AT|AU|AW|AX|AZ|BA|BB|BD|BE|BF|BG|BH|BI|BJ|BL|BM|BN|BO|BQ|BR|BS|BT|BV|BW|BY|BZ|CA|CC|CD|CF|CG|CH|CI|CK|CL|CM|CN|CO|CR|CU|CV|CW|CX|CY|CZ|DE|DJ|DK|DM|DO|DZ|EC|EE|EG|EH|ER|ES|ET|FI|FJ|FK|FM|FO|FR|GA|GB|GD|GE|GF|GG|GH|GI|GL|GM|GN|GP|GQ|GR|GS|GT|GU|GW|GY|HK|HM|HN|HR|HT|HU|ID|IE|IL|IM|IN|IO|IQ|IR|IS|IT|JE|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|MQ|MR|MS|MT|MU|MV|MW|MX|MY|MZ|NA|NC|NE|NF|NG|NI|NL|NO|NP|NR|NU|NZ|OM|PA|PE|PF|PG|PH|PK|PL|PM|PN|PR|PS|PT|PW|PY|QA|RE|RO|RS|RU|RW|SA|SB|SC|SD|SE|SG|SH|SI|SJ|SK|SL|SM|SN|SO|SR|SS|ST|SV|SX|SY|SZ|TC|TD|TF|TG|TH|TJ|TK|TL|TM|TN|TO|TP|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|CA_LEGAL_REPRESENTATIVE|CA_LEGAL_REPRESENTATIVE_CAPACITY|ES_IDENTIFICATION|ES_IDENTIFICATION_TYPE|ES_LEGAL_FORM|FI_BUSINESS_NUMBER|FI_ID_NUMBER|FI_NATIONALITY|FI_ORGANIZATION_TYPE|IT_NATIONALITY|IT_PIN|IT_REGISTRANT_ENTITY_TYPE|RU_PASSPORT_DATA|SE_ID_NUMBER|SG_ID_NUMBER|VAT_NUMBER|UK_CONTACT_TYPE|UK_COMPANY_NUMBER|EU_COUNTRY_OF_CITIZENSHIP|AU_PRIORITY_TOKEN', // REQUIRED
                'Value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'Fax' => '<string>',
        'FirstName' => '<string>',
        'LastName' => '<string>',
        'OrganizationName' => '<string>',
        'PhoneNumber' => '<string>',
        'State' => '<string>',
        'ZipCode' => '<string>',
    ],
    'Consent' => [
        'Currency' => '<string>', // REQUIRED
        'MaxPrice' => <float>, // REQUIRED
    ],
    'DomainName' => '<string>', // REQUIRED
    'RegistrantContact' => [
        'AddressLine1' => '<string>',
        'AddressLine2' => '<string>',
        'City' => '<string>',
        'ContactType' => 'PERSON|COMPANY|ASSOCIATION|PUBLIC_BODY|RESELLER',
        'CountryCode' => 'AC|AD|AE|AF|AG|AI|AL|AM|AN|AO|AQ|AR|AS|AT|AU|AW|AX|AZ|BA|BB|BD|BE|BF|BG|BH|BI|BJ|BL|BM|BN|BO|BQ|BR|BS|BT|BV|BW|BY|BZ|CA|CC|CD|CF|CG|CH|CI|CK|CL|CM|CN|CO|CR|CU|CV|CW|CX|CY|CZ|DE|DJ|DK|DM|DO|DZ|EC|EE|EG|EH|ER|ES|ET|FI|FJ|FK|FM|FO|FR|GA|GB|GD|GE|GF|GG|GH|GI|GL|GM|GN|GP|GQ|GR|GS|GT|GU|GW|GY|HK|HM|HN|HR|HT|HU|ID|IE|IL|IM|IN|IO|IQ|IR|IS|IT|JE|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|MQ|MR|MS|MT|MU|MV|MW|MX|MY|MZ|NA|NC|NE|NF|NG|NI|NL|NO|NP|NR|NU|NZ|OM|PA|PE|PF|PG|PH|PK|PL|PM|PN|PR|PS|PT|PW|PY|QA|RE|RO|RS|RU|RW|SA|SB|SC|SD|SE|SG|SH|SI|SJ|SK|SL|SM|SN|SO|SR|SS|ST|SV|SX|SY|SZ|TC|TD|TF|TG|TH|TJ|TK|TL|TM|TN|TO|TP|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|CA_LEGAL_REPRESENTATIVE|CA_LEGAL_REPRESENTATIVE_CAPACITY|ES_IDENTIFICATION|ES_IDENTIFICATION_TYPE|ES_LEGAL_FORM|FI_BUSINESS_NUMBER|FI_ID_NUMBER|FI_NATIONALITY|FI_ORGANIZATION_TYPE|IT_NATIONALITY|IT_PIN|IT_REGISTRANT_ENTITY_TYPE|RU_PASSPORT_DATA|SE_ID_NUMBER|SG_ID_NUMBER|VAT_NUMBER|UK_CONTACT_TYPE|UK_COMPANY_NUMBER|EU_COUNTRY_OF_CITIZENSHIP|AU_PRIORITY_TOKEN', // 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' => 'AC|AD|AE|AF|AG|AI|AL|AM|AN|AO|AQ|AR|AS|AT|AU|AW|AX|AZ|BA|BB|BD|BE|BF|BG|BH|BI|BJ|BL|BM|BN|BO|BQ|BR|BS|BT|BV|BW|BY|BZ|CA|CC|CD|CF|CG|CH|CI|CK|CL|CM|CN|CO|CR|CU|CV|CW|CX|CY|CZ|DE|DJ|DK|DM|DO|DZ|EC|EE|EG|EH|ER|ES|ET|FI|FJ|FK|FM|FO|FR|GA|GB|GD|GE|GF|GG|GH|GI|GL|GM|GN|GP|GQ|GR|GS|GT|GU|GW|GY|HK|HM|HN|HR|HT|HU|ID|IE|IL|IM|IN|IO|IQ|IR|IS|IT|JE|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|MQ|MR|MS|MT|MU|MV|MW|MX|MY|MZ|NA|NC|NE|NF|NG|NI|NL|NO|NP|NR|NU|NZ|OM|PA|PE|PF|PG|PH|PK|PL|PM|PN|PR|PS|PT|PW|PY|QA|RE|RO|RS|RU|RW|SA|SB|SC|SD|SE|SG|SH|SI|SJ|SK|SL|SM|SN|SO|SR|SS|ST|SV|SX|SY|SZ|TC|TD|TF|TG|TH|TJ|TK|TL|TM|TN|TO|TP|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|CA_LEGAL_REPRESENTATIVE|CA_LEGAL_REPRESENTATIVE_CAPACITY|ES_IDENTIFICATION|ES_IDENTIFICATION_TYPE|ES_LEGAL_FORM|FI_BUSINESS_NUMBER|FI_ID_NUMBER|FI_NATIONALITY|FI_ORGANIZATION_TYPE|IT_NATIONALITY|IT_PIN|IT_REGISTRANT_ENTITY_TYPE|RU_PASSPORT_DATA|SE_ID_NUMBER|SG_ID_NUMBER|VAT_NUMBER|UK_CONTACT_TYPE|UK_COMPANY_NUMBER|EU_COUNTRY_OF_CITIZENSHIP|AU_PRIORITY_TOKEN', // 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.

Consent

Type: Consent structure

Customer's consent for the owner change request.

DomainName

Required: Yes
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 query the operation status, use GetOperationDetail.

Errors

InvalidInput:
The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.
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.

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

This operation affects only the contact information for the specified contact type (administrative, registrant, or technical). 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.

By disabling the privacy service via API, you consent to the publication of the contact information provided for this domain via the public WHOIS database. You certify that you are the registrant of this domain name and have the authority to make this decision. You may withdraw your consent at any time by enabling privacy protection using either UpdateDomainContactPrivacy or the Route 53 console. Enabling privacy protection removes the contact information provided for this domain from the WHOIS database. For more information on our privacy practices, see https://aws.amazon.com/privacy/.

Parameter Syntax

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

Parameter Details

Members

AdminPrivacy

Type: boolean

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

DomainName

Required: Yes
Type: string

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

RegistrantPrivacy

Type: boolean

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

TechPrivacy

Type: boolean

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

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 APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.
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

Required: Yes
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

Required: Yes
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 query the operation status, use GetOperationDetail.

Errors

InvalidInput:
The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.
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

Required: Yes
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 APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.
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 Amazon Web Services 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 Unix time format and 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 Amazon Web Services 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 Unix time format and 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|INTERNAL_TRANSFER_OUT_DOMAIN|INTERNAL_TRANSFER_IN_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 APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.

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

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

Description

Customer's consent for the owner change request.

Members

Currency

Required: Yes
Type: string

Currency for the MaxPrice.

MaxPrice

Required: Yes
Type: double

Maximum amount the customer agreed to accept.

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. Note the following:

If you specify a value other than PERSON, you must also specify a value for OrganizationName.
For some TLDs, the privacy protection available depends on the value that you specify for Contact Type. For the privacy protection settings for your TLD, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide
For .es domains, the value of ContactType must be PERSON for all three contacts.

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.

DnssecKey

Description

Information about the DNSSEC key.

You get this from your DNS provider and then give it to Route 53 (by using AssociateDelegationSignerToDomain) to pass it to the registry to establish the chain of trust.

Members

Algorithm

Type: int

The number of the public key’s cryptographic algorithm according to an IANA assignment.

If Route 53 is your DNS service, set this to 13.

For more information about enabling DNSSEC signing, see Enabling DNSSEC signing and establishing a chain of trust.

Digest

Type: string

The delegation signer digest.

Digest is calculated from the public key provided using specified digest algorithm and this digest is the actual value returned from the registry nameservers as the value of DS records.

DigestType

Type: int

The number of the DS digest algorithm according to an IANA assignment.

For more information, see IANA for DNSSEC Delegation Signer (DS) Resource Record (RR) Type Digest Algorithms.

Flags

Type: int

Defines the type of key. It can be either a KSK (key-signing-key, value 257) or ZSK (zone-signing-key, value 256). Using KSK is always encouraged. Only use ZSK if your DNS provider isn't Route 53 and you don’t have KSK available.

If you have KSK and ZSK keys, always use KSK to create a delegations signer (DS) record. If you have ZSK keys only – use ZSK to create a DS record.

Id

Type: string

An ID assigned to each DS record created by AssociateDelegationSignerToDomain.

KeyTag

Type: int

A numeric identification of the DNSKEY record referred to by this DS record.

PublicKey

Type: string

The base64-encoded public key part of the key pair that is passed to the registry .

DnssecLimitExceeded

Description

This error is returned if you call AssociateDelegationSignerToDomain when the specified domain has reached the maximum number of DS records. You can't add any additional DS records unless you delete an existing one first.

Members

message

Type: string

DnssecSigningAttributes

Description

Information about a delegation signer (DS) record that was created in the registry by AssociateDelegationSignerToDomain.

Members

Algorithm

Type: int

Algorithm which was used to generate the digest from the public key.

Flags

Type: int

If you have KSK and ZSK keys, always use KSK to create a delegations signer (DS) record. If you have ZSK keys only – use ZSK to create a DS record.

PublicKey

Type: string

The base64-encoded public key part of the key pair that is passed to the registry.

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.

DomainPrice

Description

Information about the domain price associated with a TLD.

Members

ChangeOwnershipPrice

Type: PriceWithCurrency structure

The price for changing domain ownership.

Name

Type: string

The name of the TLD for which the prices apply.

RegistrationPrice

Type: PriceWithCurrency structure

The price for domain registration with Route 53.

RenewalPrice

Type: PriceWithCurrency structure

The price for renewing domain registration with Route 53.

RestorationPrice

Type: PriceWithCurrency structure

The price for restoring the domain with Route 53.

TransferPrice

Type: PriceWithCurrency structure

The price for transferring the domain registration to Route 53.

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. 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 Unix time format and 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 Route 53.

Members

Transferable

Type: string

Whether the domain name can be transferred to Route 53.

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

Valid values:

TRANSFERABLE: The domain name can be transferred to Route 53.
UNTRANSFERRABLE: The domain name can't be transferred to Route 53.
DONT_KNOW: Reserved for future use.
DOMAIN_IN_OWN_ACCOUNT: The domain already exists in the current Amazon Web Services account.
DOMAIN_IN_ANOTHER_ACCOUNT: the domain exists in another Amazon Web Services account.
PREMIUM_DOMAIN: Premium domain transfer is not supported.

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

Required: Yes
Type: string

The name of an additional parameter that is required by a top-level domain. Here are the top-level domains that require additional parameters and the names of the parameters that they require:

.com.au and .net.au

AU_ID_NUMBER
AU_ID_TYPE

Valid values include the following:
- ABN (Australian business number)
- ACN (Australian company number)
- TM (Trademark number)

.ca

BRAND_NUMBER
CA_BUSINESS_ENTITY_TYPE

Valid values include the following:
- BANK (Bank)
- COMMERCIAL_COMPANY (Commercial company)
- COMPANY (Company)
- COOPERATION (Cooperation)
- COOPERATIVE (Cooperative)
- COOPRIX (Cooprix)
- CORP (Corporation)
- CREDIT_UNION (Credit union)
- FOMIA (Federation of mutual insurance associations)
- INC (Incorporated)
- LTD (Limited)
- LTEE (Limitée)
- LLC (Limited liability corporation)
- LLP (Limited liability partnership)
- LTE (Lte.)
- MBA (Mutual benefit association)
- MIC (Mutual insurance company)
- NFP (Not-for-profit corporation)
- SA (S.A.)
- SAVINGS_COMPANY (Savings company)
- SAVINGS_UNION (Savings union)
- SARL (Société à responsabilité limitée)
- TRUST (Trust)
- ULC (Unlimited liability corporation)
CA_LEGAL_TYPE

When ContactType is PERSON, valid values include the following:
- ABO (Aboriginal Peoples indigenous to Canada)
- CCT (Canadian citizen)
- LGR (Legal Representative of a Canadian Citizen or Permanent Resident)
- RES (Permanent resident of Canada)
When ContactType is a value other than PERSON, valid values include the following:
- ASS (Canadian unincorporated association)
- CCO (Canadian corporation)
- EDU (Canadian educational institution)
- GOV (Government or government entity in Canada)
- HOP (Canadian Hospital)
- INB (Indian Band recognized by the Indian Act of Canada)
- LAM (Canadian Library, Archive, or Museum)
- MAJ (Her/His Majesty the Queen/King)
- OMK (Official mark registered in Canada)
- PLT (Canadian Political Party)
- PRT (Partnership Registered in Canada)
- TDM (Trademark registered in Canada)
- TRD (Canadian Trade Union)
- TRS (Trust established in Canada)

.es

ES_IDENTIFICATION

The value of ES_IDENTIFICATION depends on the following values:
- The value of ES_LEGAL_FORM
- The value of ES_IDENTIFICATION_TYPE
If ES_LEGAL_FORM is any value other than INDIVIDUAL:
- Specify 1 letter + 8 numbers (CIF [Certificado de Identificación Fiscal])
- Example: B12345678
If ES_LEGAL_FORM is INDIVIDUAL, the value that you specify for ES_IDENTIFICATION depends on the value of ES_IDENTIFICATION_TYPE:
- If ES_IDENTIFICATION_TYPE is DNI_AND_NIF (for Spanish contacts):
  - Specify 8 numbers + 1 letter (DNI [Documento Nacional de Identidad], NIF [Número de Identificación Fiscal])
  - Example: 12345678M
- If ES_IDENTIFICATION_TYPE is NIE (for foreigners with legal residence):
  - Specify 1 letter + 7 numbers + 1 letter ( NIE [Número de Identidad de Extranjero])
  - Example: Y1234567X
- If ES_IDENTIFICATION_TYPE is OTHER (for contacts outside of Spain):
  - Specify a passport number, drivers license number, or national identity card number
ES_IDENTIFICATION_TYPE

Valid values include the following:
- DNI_AND_NIF (For Spanish contacts)
- NIE (For foreigners with legal residence)
- OTHER (For contacts outside of Spain)
ES_LEGAL_FORM

Valid values include the following:
- ASSOCIATION
- CENTRAL_GOVERNMENT_BODY
- CIVIL_SOCIETY
- COMMUNITY_OF_OWNERS
- COMMUNITY_PROPERTY
- CONSULATE
- COOPERATIVE
- DESIGNATION_OF_ORIGIN_SUPERVISORY_COUNCIL
- ECONOMIC_INTEREST_GROUP
- EMBASSY
- ENTITY_MANAGING_NATURAL_AREAS
- FARM_PARTNERSHIP
- FOUNDATION
- GENERAL_AND_LIMITED_PARTNERSHIP
- GENERAL_PARTNERSHIP
- INDIVIDUAL
- LIMITED_COMPANY
- LOCAL_AUTHORITY
- LOCAL_PUBLIC_ENTITY
- MUTUAL_INSURANCE_COMPANY
- NATIONAL_PUBLIC_ENTITY
- ORDER_OR_RELIGIOUS_INSTITUTION
- OTHERS (Only for contacts outside of Spain)
- POLITICAL_PARTY
- PROFESSIONAL_ASSOCIATION
- PUBLIC_LAW_ASSOCIATION
- PUBLIC_LIMITED_COMPANY
- REGIONAL_GOVERNMENT_BODY
- REGIONAL_PUBLIC_ENTITY
- SAVINGS_BANK
- SPANISH_OFFICE
- SPORTS_ASSOCIATION
- SPORTS_FEDERATION
- SPORTS_LIMITED_COMPANY
- TEMPORARY_ALLIANCE_OF_ENTERPRISES
- TRADE_UNION
- WORKER_OWNED_COMPANY
- WORKER_OWNED_LIMITED_COMPANY

.eu

EU_COUNTRY_OF_CITIZENSHIP

.fi

BIRTH_DATE_IN_YYYY_MM_DD
FI_BUSINESS_NUMBER
FI_ID_NUMBER
FI_NATIONALITY

Valid values include the following:
- FINNISH
- NOT_FINNISH
FI_ORGANIZATION_TYPE

Valid values include the following:
- COMPANY
- CORPORATION
- GOVERNMENT
- INSTITUTION
- POLITICAL_PARTY
- PUBLIC_COMMUNITY
- TOWNSHIP

.fr

BIRTH_CITY
BIRTH_COUNTRY
BIRTH_DATE_IN_YYYY_MM_DD
BIRTH_DEPARTMENT: Specify the INSEE code that corresponds with the department where the contact was born. If the contact was born somewhere other than France or its overseas departments, specify 99. For more information, including a list of departments and the corresponding INSEE numbers, see the Wikipedia entry Departments of France.
BRAND_NUMBER

.it

IT_NATIONALITY
IT_PIN
IT_REGISTRANT_ENTITY_TYPE

Valid values include the following:
- FOREIGNERS
- FREELANCE_WORKERS (Freelance workers and professionals)
- ITALIAN_COMPANIES (Italian companies and one-person companies)
- NON_PROFIT_ORGANIZATIONS
- OTHER_SUBJECTS
- PUBLIC_ORGANIZATIONS

.ru

BIRTH_DATE_IN_YYYY_MM_DD
RU_PASSPORT_DATA

.se

BIRTH_COUNTRY
SE_ID_NUMBER

.sg

SG_ID_NUMBER

.uk, .co.uk, .me.uk, and .org.uk

UK_CONTACT_TYPE

Valid values include the following:
- CRC (UK Corporation by Royal Charter)
- FCORP (Non-UK Corporation)
- FIND (Non-UK Individual, representing self)
- FOTHER (Non-UK Entity that does not fit into any other category)
- GOV (UK Government Body)
- IND (UK Individual (representing self))
- IP (UK Industrial/Provident Registered Company)
- LLP (UK Limited Liability Partnership)
- LTD (UK Limited Company)
- OTHER (UK Entity that does not fit into any other category)
- PLC (UK Public Limited Company)
- PTNR (UK Partnership)
- RCHAR (UK Registered Charity)
- SCH (UK School)
- STAT (UK Statutory Body)
- STRA (UK Sole Trader)
UK_COMPANY_NUMBER

In addition, many TLDs require a VAT_NUMBER.

Value

Required: Yes
Type: string

The value that corresponds with the name of an extra parameter.

FilterCondition

Description

Information for the filtering of a list of domains returned by ListDomains.

Members

Name

Required: Yes
Type: string

Name of the field which should be used for filtering the list of domains.

Operator

Required: Yes
Type: string

The operator values for filtering domain names. The values can be:

LE: Less than, or equal to
GE: Greater than, or equal to
BEGINS_WITH: Begins with

Values

Required: Yes
Type: Array of strings

An array of strings presenting values to compare. Only 1 item in the list is currently supported.

InvalidInput

Description

The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.

Members

message

Type: string

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.

Nameserver

Description

Name server 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

Required: Yes
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

DomainName

Type: string

Name of the domain.

LastUpdatedDate

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

The date when the last change was made in Unix time format and Coordinated Universal Time (UTC).

Message

Type: string

Message about the operation.

OperationId

Type: string

Identifier returned to track the requested action.

Status

Type: string

The current status of the requested operation in the system.

StatusFlag

Type: string

Automatically checks whether there are no outstanding operations on domains that need customer attention.

Valid values are:

PENDING_ACCEPTANCE: The operation is waiting for acceptance from the account that is receiving the domain.
PENDING_CUSTOMER_ACTION: The operation is waiting for customer action, for example, returning an email.
PENDING_AUTHORIZATION: The operation is waiting for the form of authorization. For more information, see ResendOperationAuthorization.
PENDING_PAYMENT_VERIFICATION: The operation is waiting for the payment method to validate.
PENDING_SUPPORT_CASE: The operation includes a support case and is waiting for its resolution.

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.

PriceWithCurrency

Description

Currency-specific price information.

Members

Currency

Required: Yes
Type: string

The currency specifier.

Price

Required: Yes
Type: double

The price of a domain, in a specific currency.

SortCondition

Description

Information for sorting a list of domains.

Members

Name

Required: Yes
Type: string

Field to be used for sorting the list of domains. It can be either the name or the expiration for a domain. Note that if filterCondition is used in the same ListDomains call, the field used for sorting has to be the same as the field used for filtering.

SortOrder

Required: Yes
Type: string

The sort order for a list of domains. Either ascending (ASC) or descending (DES).

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

AcceptDomainTransferFromAnotherAwsAccount

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AssociateDelegationSignerToDomain

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CancelDomainTransferToAnotherAwsAccount

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CheckDomainAvailability

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CheckDomainTransferability

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteDomain

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