Amazon Route 53 Domains¶
Description¶
Amazon Route 53 API actions let you register domain names and perform related operations.
Usage¶
Arguments¶
-
configOptional configuration of credentials, endpoint, and/or region.
- credentials:
- creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
- creds:
- endpoint: The complete URL to use for the constructed client.
- region: The AWS Region used in instantiating the client.
- close_connection: Immediately close all HTTP connections.
- timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
- s3_force_path_style: Set this to
trueto force the request to use path-style addressing, i.e.http://s3.amazonaws.com/BUCKET/KEY. - sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
- use_dual_stack: Set this to
trueto use the dualstack (IPv4 and IPv6) endpoint for a service, where available, falling back to the regular endpoint when it isn't. Defaults to theAWS_USE_DUALSTACK_ENDPOINTenvironment variable when unset.
- credentials:
-
credentialsOptional credentials shorthand for the config parameter
- creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
- creds:
-
endpointOptional shorthand for complete URL to use for the constructed client.
-
regionOptional shorthand for AWS Region used in instantiating the client.
Value¶
A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.
Service syntax¶
svc <- route53domains(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string",
use_dual_stack = "logical"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
Operations¶
accept_domain_transfer_from_another_aws_account |
Accepts the transfer of a domain from another Amazon Web Services account to the currentAmazon Web Services account |
|---|---|
associate_delegation_signer_to_domain |
Creates a delegation signer (DS) record in the registry zone for this domain name |
cancel_domain_transfer_to_another_aws_account |
Cancels the transfer of a domain from the current Amazon Web Services account to another Amazon Web Services account |
check_domain_availability |
This operation checks the availability of one domain name |
check_domain_transferability |
Checks whether a domain name can be transferred to Amazon Route 53 |
delete_domain |
This operation deletes the specified domain |
delete_tags_for_domain |
This operation deletes the specified tags for a domain |
disable_domain_auto_renew |
This operation disables automatic renewal of domain registration for the specified domain |
disable_domain_transfer_lock |
This operation removes the transfer lock on the domain (specifically the clientTransferProhibited status) to allow domain transfers |
disassociate_delegation_signer_from_domain |
Deletes a delegation signer (DS) record in the registry zone for this domain name |
enable_domain_auto_renew |
This operation configures Amazon Route 53 to automatically renew the specified domain before the domain registration expires |
enable_domain_transfer_lock |
This operation sets the transfer lock on the domain (specifically the clientTransferProhibited status) to prevent domain transfers |
get_contact_reachability_status |
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 |
get_domain_detail |
This operation returns detailed information about a specified domain that is associated with the current Amazon Web Services account |
get_domain_suggestions |
The GetDomainSuggestions operation returns a list of suggested domain names |
get_operation_detail |
This operation returns the current status of an operation that is not completed |
list_domains |
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 |
list_operations |
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 |
list_prices |
Lists the following prices for either all the TLDs supported by RouteĀ 53, or the specified TLD: |
list_tags_for_domain |
This operation returns all of the tags that are associated with the specified domain |
push_domain |
Moves a domain from Amazon Web Services to another registrar |
register_domain |
This operation registers a domain |
reject_domain_transfer_from_another_aws_account |
Rejects the transfer of a domain from another Amazon Web Services account to the current Amazon Web Services account |
renew_domain |
This operation renews a domain for the specified number of years |
resend_contact_reachability_email |
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 |
resend_operation_authorization |
Resend the form of authorization email for this operation |
retrieve_domain_auth_code |
This operation returns the authorization code for the domain |
transfer_domain |
Transfers a domain from another registrar to Amazon Route 53 |
transfer_domain_to_another_aws_account |
Transfers a domain from the current Amazon Web Services account to another Amazon Web Services account |
update_domain_contact |
This operation updates the contact information for a particular domain |
update_domain_contact_privacy |
This operation updates the specified domain contact's privacy setting |
update_domain_nameservers |
This operation replaces the current set of name servers for the domain with the specified set of name servers |
update_tags_for_domain |
This operation adds or updates tags for a specified domain |
view_billing |
Returns all the domain-related billing records for the current Amazon Web Services account for a specified period |