NAME

Paws::Route53Domains - Perl Interface to AWS Amazon Route 53 Domains

SYNOPSIS

  use Paws;

  my $obj = Paws->service('Route53Domains');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

Amazon Route 53 API actions let you register domain names and perform related operations.

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/route53domains-2014-05-15

METHODS

AcceptDomainTransferFromAnotherAwsAccount

DomainName => Str
Password => Str

Each argument is described in detail in: Paws::Route53Domains::AcceptDomainTransferFromAnotherAwsAccount

Returns: a Paws::Route53Domains::AcceptDomainTransferFromAnotherAwsAccountResponse instance

Accepts the transfer of a domain from another AWS account to the current AWS account. You initiate a transfer between AWS accounts using TransferDomainToAnotherAwsAccount (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_TransferDomainToAnotherAwsAccount.html).

Use either ListOperations (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ListOperations.html) or GetOperationDetail (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html) to determine whether the operation succeeded. GetOperationDetail (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html) provides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled.

CancelDomainTransferToAnotherAwsAccount

DomainName => Str

Each argument is described in detail in: Paws::Route53Domains::CancelDomainTransferToAnotherAwsAccount

Returns: a Paws::Route53Domains::CancelDomainTransferToAnotherAwsAccountResponse instance

Cancels the transfer of a domain from the current AWS account to another AWS account. You initiate a transfer between AWS accounts using TransferDomainToAnotherAwsAccount (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_TransferDomainToAnotherAwsAccount.html).

You must cancel the transfer before the other AWS account accepts the transfer using AcceptDomainTransferFromAnotherAwsAccount (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_AcceptDomainTransferFromAnotherAwsAccount.html).

CheckDomainAvailability

DomainName => Str
[IdnLangCode => Str]

Each argument is described in detail in: Paws::Route53Domains::CheckDomainAvailability

Returns: a Paws::Route53Domains::CheckDomainAvailabilityResponse instance

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.

CheckDomainTransferability

DomainName => Str
[AuthCode => Str]

Each argument is described in detail in: Paws::Route53Domains::CheckDomainTransferability

Returns: a Paws::Route53Domains::CheckDomainTransferabilityResponse instance

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

DeleteTagsForDomain

DomainName => Str
TagsToDelete => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::Route53Domains::DeleteTagsForDomain

Returns: a Paws::Route53Domains::DeleteTagsForDomainResponse instance

This operation deletes the specified tags for a domain.

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

DisableDomainAutoRenew

DomainName => Str

Each argument is described in detail in: Paws::Route53Domains::DisableDomainAutoRenew

Returns: a Paws::Route53Domains::DisableDomainAutoRenewResponse instance

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

DisableDomainTransferLock

DomainName => Str

Each argument is described in detail in: Paws::Route53Domains::DisableDomainTransferLock

Returns: a Paws::Route53Domains::DisableDomainTransferLockResponse instance

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.

EnableDomainAutoRenew

DomainName => Str

Each argument is described in detail in: Paws::Route53Domains::EnableDomainAutoRenew

Returns: a Paws::Route53Domains::EnableDomainAutoRenewResponse instance

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

The period during which you can renew a domain name varies by TLD. For a list of TLDs and their renewal policies, see Domains That You Can Register with Amazon Route 53 (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html) 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.

EnableDomainTransferLock

DomainName => Str

Each argument is described in detail in: Paws::Route53Domains::EnableDomainTransferLock

Returns: a Paws::Route53Domains::EnableDomainTransferLockResponse instance

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.

GetContactReachabilityStatus

[DomainName => Str]

Each argument is described in detail in: Paws::Route53Domains::GetContactReachabilityStatus

Returns: a Paws::Route53Domains::GetContactReachabilityStatusResponse instance

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.

GetDomainDetail

DomainName => Str

Each argument is described in detail in: Paws::Route53Domains::GetDomainDetail

Returns: a Paws::Route53Domains::GetDomainDetailResponse instance

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

GetDomainSuggestions

DomainName => Str
OnlyAvailable => Bool
SuggestionCount => Int

Each argument is described in detail in: Paws::Route53Domains::GetDomainSuggestions

Returns: a Paws::Route53Domains::GetDomainSuggestionsResponse instance

The GetDomainSuggestions operation returns a list of suggested domain names.

GetOperationDetail

OperationId => Str

Each argument is described in detail in: Paws::Route53Domains::GetOperationDetail

Returns: a Paws::Route53Domains::GetOperationDetailResponse instance

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

ListDomains

[Marker => Str]
[MaxItems => Int]

Each argument is described in detail in: Paws::Route53Domains::ListDomains

Returns: a Paws::Route53Domains::ListDomainsResponse instance

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

ListOperations

[Marker => Str]
[MaxItems => Int]
[SubmittedSince => Str]

Each argument is described in detail in: Paws::Route53Domains::ListOperations

Returns: a Paws::Route53Domains::ListOperationsResponse instance

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.

ListTagsForDomain

DomainName => Str

Each argument is described in detail in: Paws::Route53Domains::ListTagsForDomain

Returns: a Paws::Route53Domains::ListTagsForDomainResponse instance

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.

RegisterDomain

AdminContact => Paws::Route53Domains::ContactDetail
DomainName => Str
DurationInYears => Int
RegistrantContact => Paws::Route53Domains::ContactDetail
TechContact => Paws::Route53Domains::ContactDetail
[AutoRenew => Bool]
[IdnLangCode => Str]
[PrivacyProtectAdminContact => Bool]
[PrivacyProtectRegistrantContact => Bool]
[PrivacyProtectTechContact => Bool]

Each argument is described in detail in: Paws::Route53Domains::RegisterDomain

Returns: a Paws::Route53Domains::RegisterDomainResponse instance

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 autorenew, so your domain registration will renew automatically each year. We'll notify you in advance of the renewal date so you can choose whether to renew the registration.
Optionally enables privacy protection, so WHOIS queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you don't enable privacy protection, WHOIS queries return the information that you entered for the registrant, admin, and tech contacts.
If registration is successful, returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant is notified by email.
Charges your AWS account an amount based on the top-level domain. For more information, see Amazon Route 53 Pricing (http://aws.amazon.com/route53/pricing/).

RejectDomainTransferFromAnotherAwsAccount

DomainName => Str

Each argument is described in detail in: Paws::Route53Domains::RejectDomainTransferFromAnotherAwsAccount

Returns: a Paws::Route53Domains::RejectDomainTransferFromAnotherAwsAccountResponse instance

Rejects the transfer of a domain from another AWS account to the current AWS account. You initiate a transfer between AWS accounts using TransferDomainToAnotherAwsAccount (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_TransferDomainToAnotherAwsAccount.html).

RenewDomain

CurrentExpiryYear => Int
DomainName => Str
[DurationInYears => Int]

Each argument is described in detail in: Paws::Route53Domains::RenewDomain

Returns: a Paws::Route53Domains::RenewDomainResponse instance

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

We recommend that you renew your domain several weeks before the expiration date. Some TLD registries delete domains before the expiration date if you haven't renewed far enough in advance. For more information about renewing domain registration, see Renewing Registration for a Domain (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-renew.html) in the Amazon Route 53 Developer Guide.

ResendContactReachabilityEmail

[DomainName => Str]

Each argument is described in detail in: Paws::Route53Domains::ResendContactReachabilityEmail

Returns: a Paws::Route53Domains::ResendContactReachabilityEmailResponse instance

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

RetrieveDomainAuthCode

DomainName => Str

Each argument is described in detail in: Paws::Route53Domains::RetrieveDomainAuthCode

Returns: a Paws::Route53Domains::RetrieveDomainAuthCodeResponse instance

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

TransferDomain

AdminContact => Paws::Route53Domains::ContactDetail
DomainName => Str
DurationInYears => Int
RegistrantContact => Paws::Route53Domains::ContactDetail
TechContact => Paws::Route53Domains::ContactDetail
[AuthCode => Str]
[AutoRenew => Bool]
[IdnLangCode => Str]
[Nameservers => ArrayRef[Paws::Route53Domains::Nameserver]]
[PrivacyProtectAdminContact => Bool]
[PrivacyProtectRegistrantContact => Bool]
[PrivacyProtectTechContact => Bool]

Each argument is described in detail in: Paws::Route53Domains::TransferDomain

Returns: a Paws::Route53Domains::TransferDomainResponse instance

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 (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-transfer-to-route-53.html) in the Amazon Route 53 Developer Guide.
For information about how to transfer a domain from one AWS account to another, see TransferDomainToAnotherAwsAccount (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_TransferDomainToAnotherAwsAccount.html).
For information about how to transfer a domain to another domain registrar, see Transferring a Domain from Amazon Route 53 to Another Registrar (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-transfer-from-route-53.html) 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.

TransferDomainToAnotherAwsAccount

AccountId => Str
DomainName => Str

Each argument is described in detail in: Paws::Route53Domains::TransferDomainToAnotherAwsAccount

Returns: a Paws::Route53Domains::TransferDomainToAnotherAwsAccountResponse instance

Transfers a domain from the current AWS account to another AWS account. Note the following:

The AWS 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 (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_AcceptDomainTransferFromAnotherAwsAccount.html).
You can cancel the transfer before the other account accepts it. See CancelDomainTransferToAnotherAwsAccount (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_CancelDomainTransferToAnotherAwsAccount.html).
The other account can reject the transfer. See RejectDomainTransferFromAnotherAwsAccount (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_RejectDomainTransferFromAnotherAwsAccount.html).

When you transfer a domain from one AWS 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 AWS account, see Migrating a Hosted Zone to a Different AWS Account (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/hosted-zones-migrating.html) in the Amazon Route 53 Developer Guide.

UpdateDomainContact

DomainName => Str
[AdminContact => Paws::Route53Domains::ContactDetail]
[RegistrantContact => Paws::Route53Domains::ContactDetail]
[TechContact => Paws::Route53Domains::ContactDetail]

Each argument is described in detail in: Paws::Route53Domains::UpdateDomainContact

Returns: a Paws::Route53Domains::UpdateDomainContactResponse instance

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

If the update is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.

UpdateDomainContactPrivacy

DomainName => Str
[AdminPrivacy => Bool]
[RegistrantPrivacy => Bool]
[TechPrivacy => Bool]

Each argument is described in detail in: Paws::Route53Domains::UpdateDomainContactPrivacy

Returns: a Paws::Route53Domains::UpdateDomainContactPrivacyResponse instance

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

This operation affects only the contact information for the specified contact type (registrant, administrator, or tech). If the request succeeds, Amazon Route 53 returns an operation ID that you can use with GetOperationDetail (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html) 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/ (https://aws.amazon.com/privacy/).

UpdateDomainNameservers

DomainName => Str
Nameservers => ArrayRef[Paws::Route53Domains::Nameserver]
[FIAuthKey => Str]

Each argument is described in detail in: Paws::Route53Domains::UpdateDomainNameservers

Returns: a Paws::Route53Domains::UpdateDomainNameserversResponse instance

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.

UpdateTagsForDomain

DomainName => Str
[TagsToUpdate => ArrayRef[Paws::Route53Domains::Tag]]

Each argument is described in detail in: Paws::Route53Domains::UpdateTagsForDomain

Returns: a Paws::Route53Domains::UpdateTagsForDomainResponse instance

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.

ViewBilling

[End => Str]
[Marker => Str]
[MaxItems => Int]
[Start => Str]

Each argument is described in detail in: Paws::Route53Domains::ViewBilling

Returns: a Paws::Route53Domains::ViewBillingResponse instance

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

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

ListAllDomains(sub { },[Marker => Str, MaxItems => Int])

ListAllDomains([Marker => Str, MaxItems => Int])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Domains, passing the object as the first parameter, and the string 'Domains' as the second parameter

If not, it will return a a Paws::Route53Domains::ListDomainsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllOperations(sub { },[Marker => Str, MaxItems => Int, SubmittedSince => Str])

ListAllOperations([Marker => Str, MaxItems => Int, SubmittedSince => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Operations, passing the object as the first parameter, and the string 'Operations' as the second parameter

If not, it will return a a Paws::Route53Domains::ListOperationsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ViewAllBilling(sub { },[End => Str, Marker => Str, MaxItems => Int, Start => Str])

ViewAllBilling([End => Str, Marker => Str, MaxItems => Int, Start => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - BillingRecords, passing the object as the first parameter, and the string 'BillingRecords' as the second parameter

If not, it will return a a Paws::Route53Domains::ViewBillingResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues

To install Paws, copy and paste the appropriate command in to your terminal.

cpanm

cpanm Paws

CPAN shell

perl -MCPAN -e shell
install Paws

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

SYNOPSIS

DESCRIPTION

METHODS

AcceptDomainTransferFromAnotherAwsAccount

CancelDomainTransferToAnotherAwsAccount

CheckDomainAvailability

CheckDomainTransferability

DeleteTagsForDomain

DisableDomainAutoRenew

DisableDomainTransferLock

EnableDomainAutoRenew

EnableDomainTransferLock

GetContactReachabilityStatus

GetDomainDetail

GetDomainSuggestions

GetOperationDetail

ListDomains

ListOperations

ListTagsForDomain

RegisterDomain

RejectDomainTransferFromAnotherAwsAccount

RenewDomain

ResendContactReachabilityEmail

RetrieveDomainAuthCode

TransferDomain

TransferDomainToAnotherAwsAccount

UpdateDomainContact

UpdateDomainContactPrivacy

UpdateDomainNameservers

UpdateTagsForDomain

ViewBilling

PAGINATORS

ListAllDomains(sub { },[Marker => Str, MaxItems => Int])

ListAllDomains([Marker => Str, MaxItems => Int])

ListAllOperations(sub { },[Marker => Str, MaxItems => Int, SubmittedSince => Str])

ListAllOperations([Marker => Str, MaxItems => Int, SubmittedSince => Str])

ViewAllBilling(sub { },[End => Str, Marker => Str, MaxItems => Int, Start => Str])

ViewAllBilling([End => Str, Marker => Str, MaxItems => Int, Start => Str])

SEE ALSO

BUGS and CONTRIBUTIONS

Module Install Instructions