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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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.

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->cancelDomainTransferToAnotherAwsAccount([
    'DomainName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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:

1. You can’t get a refund for the cost of a deleted domain registration.

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

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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,
    'BillingContact' => [
        '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>',
    ],
    'BillingPrivacy' => 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

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

Result Syntax

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

Result Details

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

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|RELEASE_TO_GANDI|TRANSFER_ON_RENEW|RESTORE_DOMAIN',
]

Result Details

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

Result Syntax

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

Result Details

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

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|RELEASE_TO_GANDI|TRANSFER_ON_RENEW|RESTORE_DOMAIN',
        ],
        // ...
    ],
]

Result Details

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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. 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 for the registrar or the phrase "REDACTED FOR PRIVACY", or "On behalf of <domain name> owner." If you don't enable privacy protection, WHOIS queries return the information that you entered for the administrative, registrant, and technical contacts.

  While some domains may allow different privacy settings per contact, we recommend specifying the same privacy setting for all 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,
    'BillingContact' => [
        '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>',
    ],
    'DomainName' => '<string>', // REQUIRED
    'DurationInYears' => <integer>, // REQUIRED
    'IdnLangCode' => '<string>',
    'PrivacyProtectAdminContact' => true || false,
    'PrivacyProtectBillingContact' => 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

Result Syntax

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

Result Details

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.

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->rejectDomainTransferFromAnotherAwsAccount([
    'DomainName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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.

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 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,
    'BillingContact' => [
        '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>',
    ],
    'DomainName' => '<string>', // REQUIRED
    'DurationInYears' => <integer>, // REQUIRED
    'IdnLangCode' => '<string>',
    'Nameservers' => [
        [
            'GlueIps' => ['<string>', ...],
            'Name' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'PrivacyProtectAdminContact' => true || false,
    'PrivacyProtectBillingContact' => 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

Result Syntax

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

Result Details

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.

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->transferDomainToAnotherAwsAccount([
    'AccountId' => '<string>', // REQUIRED
    'DomainName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

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>',
    ],
    'BillingContact' => [
        '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

Result Syntax

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

Result Details

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, your contact information is replaced with contact information for the registrar or with the phrase "REDACTED FOR PRIVACY", or "On behalf of <domain name> owner."

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

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|RELEASE_TO_GANDI|TRANSFER_ON_RENEW|RESTORE_DOMAIN',
            'Price' => <float>,
        ],
        // ...
    ],
    'NextPageMarker' => '<string>',
]

Result Details

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.