Struct aws_sdk_route53domains::Client

pub struct Client { /* private fields */ }

Client for Amazon Route 53 Domains

Client for invoking operations on Amazon Route 53 Domains. Each operation on Amazon Route 53 Domains is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_route53domains::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_route53domains::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the AcceptDomainTransferFromAnotherAwsAccount operation has a Client::accept_domain_transfer_from_another_aws_account, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.accept_domain_transfer_from_another_aws_account()
    .domain_name("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn accept_domain_transfer_from_another_aws_account( &self ) -> AcceptDomainTransferFromAnotherAwsAccountFluentBuilder

Constructs a fluent builder for the AcceptDomainTransferFromAnotherAwsAccount operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

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

    
    
  • password(impl Into<String>) / set_password(Option<String>):
    required: true
    

    The password that was returned by the TransferDomainToAnotherAwsAccount request.

    
    
• On success, responds with AcceptDomainTransferFromAnotherAwsAccountOutput with field(s):
  • operation_id(Option<String>):

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

• On failure, responds with SdkError<AcceptDomainTransferFromAnotherAwsAccountError>

impl Client

pub fn associate_delegation_signer_to_domain( &self ) -> AssociateDelegationSignerToDomainFluentBuilder

Constructs a fluent builder for the AssociateDelegationSignerToDomain operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The name of the domain.

    
    
  • signing_attributes(DnssecSigningAttributes) / set_signing_attributes(Option<DnssecSigningAttributes>):
    required: true
    

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

    
    
• On success, responds with AssociateDelegationSignerToDomainOutput with field(s):
  • operation_id(Option<String>):

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

• On failure, responds with SdkError<AssociateDelegationSignerToDomainError>

impl Client

pub fn cancel_domain_transfer_to_another_aws_account( &self ) -> CancelDomainTransferToAnotherAwsAccountFluentBuilder

Constructs a fluent builder for the CancelDomainTransferToAnotherAwsAccount operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

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

    
    
• On success, responds with CancelDomainTransferToAnotherAwsAccountOutput with field(s):
  • operation_id(Option<String>):

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

• On failure, responds with SdkError<CancelDomainTransferToAnotherAwsAccountError>

impl Client

pub fn check_domain_availability(&self) -> CheckDomainAvailabilityFluentBuilder

Constructs a fluent builder for the CheckDomainAvailability operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

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

    The domain name can contain only the following characters:

    • Letters a through z. Domain names are not case sensitive.

    • Numbers 0 through 9.

    • Hyphen (-). You can’t specify a hyphen at the beginning or end of a label.

    • Period (.) to separate the labels in the name, such as the . in example.com.

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

    
    
  • idn_lang_code(impl Into<String>) / set_idn_lang_code(Option<String>):
    required: false
    

    Reserved for future use.

    
    
• On success, responds with CheckDomainAvailabilityOutput with field(s):
  • availability(Option<DomainAvailability>):

    Whether the domain name is available for registering.

    You can register only domains designated as AVAILABLE.

    Valid values:

    AVAILABLE

    The domain name is available.

    AVAILABLE_RESERVED

    The domain name is reserved under specific conditions.

    AVAILABLE_PREORDER

    The domain name is available and can be preordered.

    DONT_KNOW

    The TLD registry didn’t reply with a definitive answer about whether the domain name is available. Route 53 can return this response for a variety of reasons, for example, the registry is performing maintenance. Try again later.

    INVALID_NAME_FOR_TLD

    The TLD isn’t valid. For example, it can contain characters that aren’t allowed.

    PENDING

    The TLD registry didn’t return a response in the expected amount of time. When the response is delayed, it usually takes just a few extra seconds. You can resubmit the request immediately.

    RESERVED

    The domain name has been reserved for another person or organization.

    UNAVAILABLE

    The domain name is not available.

    UNAVAILABLE_PREMIUM

    The domain name is not available.

    UNAVAILABLE_RESTRICTED

    The domain name is forbidden.

• On failure, responds with SdkError<CheckDomainAvailabilityError>

impl Client

pub fn check_domain_transferability( &self ) -> CheckDomainTransferabilityFluentBuilder

Constructs a fluent builder for the CheckDomainTransferability operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

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

    The domain name can contain only the following characters:

    • Letters a through z. Domain names are not case sensitive.

    • Numbers 0 through 9.

    • Hyphen (-). You can’t specify a hyphen at the beginning or end of a label.

    • Period (.) to separate the labels in the name, such as the . in example.com.

    
    
  • auth_code(impl Into<String>) / set_auth_code(Option<String>):
    required: false
    

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

    
    
• On success, responds with CheckDomainTransferabilityOutput with field(s):
  • transferability(Option<DomainTransferability>):

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

  • message(Option<String>):

    Provides an explanation for when a domain can’t be transferred.

• On failure, responds with SdkError<CheckDomainTransferabilityError>

impl Client

pub fn delete_domain(&self) -> DeleteDomainFluentBuilder

Constructs a fluent builder for the DeleteDomain operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    Name of the domain to be deleted.

    
    
• On success, responds with DeleteDomainOutput with field(s):
  • operation_id(Option<String>):

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

• On failure, responds with SdkError<DeleteDomainError>

impl Client

pub fn delete_tags_for_domain(&self) -> DeleteTagsForDomainFluentBuilder

Constructs a fluent builder for the DeleteTagsForDomain operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

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

    
    
  • tags_to_delete(impl Into<String>) / set_tags_to_delete(Option<Vec::<String>>):
    required: true
    

    A list of tag keys to delete.

    
    
• On success, responds with DeleteTagsForDomainOutput
• On failure, responds with SdkError<DeleteTagsForDomainError>

impl Client

pub fn disable_domain_auto_renew(&self) -> DisableDomainAutoRenewFluentBuilder

Constructs a fluent builder for the DisableDomainAutoRenew operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

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

    
    
• On success, responds with DisableDomainAutoRenewOutput
• On failure, responds with SdkError<DisableDomainAutoRenewError>

impl Client

pub fn disable_domain_transfer_lock( &self ) -> DisableDomainTransferLockFluentBuilder

Constructs a fluent builder for the DisableDomainTransferLock operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

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

    
    
• On success, responds with DisableDomainTransferLockOutput with field(s):
  • operation_id(Option<String>):

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

• On failure, responds with SdkError<DisableDomainTransferLockError>

impl Client

pub fn disassociate_delegation_signer_from_domain( &self ) -> DisassociateDelegationSignerFromDomainFluentBuilder

Constructs a fluent builder for the DisassociateDelegationSignerFromDomain operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    Name of the domain.

    
    
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

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

    
    
• On success, responds with DisassociateDelegationSignerFromDomainOutput with field(s):
  • operation_id(Option<String>):

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

• On failure, responds with SdkError<DisassociateDelegationSignerFromDomainError>

impl Client

pub fn enable_domain_auto_renew(&self) -> EnableDomainAutoRenewFluentBuilder

Constructs a fluent builder for the EnableDomainAutoRenew operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

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

    
    
• On success, responds with EnableDomainAutoRenewOutput
• On failure, responds with SdkError<EnableDomainAutoRenewError>

impl Client

pub fn enable_domain_transfer_lock( &self ) -> EnableDomainTransferLockFluentBuilder

Constructs a fluent builder for the EnableDomainTransferLock operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

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

    
    
• On success, responds with EnableDomainTransferLockOutput with field(s):
  • operation_id(Option<String>):

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

• On failure, responds with SdkError<EnableDomainTransferLockError>

impl Client

pub fn get_contact_reachability_status( &self ) -> GetContactReachabilityStatusFluentBuilder

Constructs a fluent builder for the GetContactReachabilityStatus operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: false
    

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

    
    
• On success, responds with GetContactReachabilityStatusOutput with field(s):
  • domain_name(Option<String>):

    The domain name for which you requested the reachability status.

  • status(Option<ReachabilityStatus>):

    Whether the registrant contact has responded. Values include the following:

    PENDING

    We sent the confirmation email and haven’t received a response yet.

    DONE

    We sent the email and got confirmation from the registrant contact.

    EXPIRED

    The time limit expired before the registrant contact responded.

• On failure, responds with SdkError<GetContactReachabilityStatusError>

impl Client

pub fn get_domain_detail(&self) -> GetDomainDetailFluentBuilder

Constructs a fluent builder for the GetDomainDetail operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

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

    
    
• On success, responds with GetDomainDetailOutput with field(s):
  • domain_name(Option<String>):

    The name of a domain.

  • nameservers(Option<Vec::<Nameserver>>):

    The name servers of the domain.

  • auto_renew(Option<bool>):

    Specifies whether the domain registration is set to renew automatically.

  • admin_contact(Option<ContactDetail>):

    Provides details about the domain administrative contact.

  • registrant_contact(Option<ContactDetail>):

    Provides details about the domain registrant.

  • tech_contact(Option<ContactDetail>):

    Provides details about the domain technical contact.

  • admin_privacy(Option<bool>):

    Specifies whether contact information is concealed from WHOIS queries. If the value is true, WHOIS (“who is”) queries return contact information either for Amazon Registrar or for our registrar associate, Gandi. If the value is false, WHOIS queries return the information that you entered for the admin contact.

  • registrant_privacy(Option<bool>):

    Specifies whether contact information is concealed from WHOIS queries. If the value is true, WHOIS (“who is”) queries return contact information either for Amazon Registrar or for our registrar associate, Gandi. If the value is false, WHOIS queries return the information that you entered for the registrant contact (domain owner).

  • tech_privacy(Option<bool>):

    Specifies whether contact information is concealed from WHOIS queries. If the value is true, WHOIS (“who is”) queries return contact information either for Amazon Registrar or for our registrar associate, Gandi. If the value is false, WHOIS queries return the information that you entered for the technical contact.

  • registrar_name(Option<String>):

    Name of the registrar of the domain as identified in the registry.

  • who_is_server(Option<String>):

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

  • registrar_url(Option<String>):

    Web address of the registrar.

  • abuse_contact_email(Option<String>):

    Email address to contact to report incorrect contact information for a domain, to report that the domain is being used to send spam, to report that someone is cybersquatting on a domain name, or report some other type of abuse.

  • abuse_contact_phone(Option<String>):

    Phone number for reporting abuse.

  • registry_domain_id(Option<String>):

    Reserved for future use.

  • creation_date(Option<DateTime>):

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

  • updated_date(Option<DateTime>):

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

  • expiration_date(Option<DateTime>):

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

  • reseller(Option<String>):

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

  • dns_sec(Option<String>):

    Deprecated.

  • status_list(Option<Vec::<String>>):

    An array of domain name status codes, also known as Extensible Provisioning Protocol (EPP) status codes.

    ICANN, the organization that maintains a central database of domain names, has developed a set of domain name status codes that tell you the status of a variety of operations on a domain name, for example, registering a domain name, transferring a domain name to another registrar, renewing the registration for a domain name, and so on. All registrars use this same set of status codes.

    For a current list of domain name status codes and an explanation of what each code means, go to the ICANN website and search for epp status codes. (Search on the ICANN website; web searches sometimes return an old version of the document.)

  • dnssec_keys(Option<Vec::<DnssecKey>>):

    A complex type that contains information about the DNSSEC configuration.

  • billing_contact(Option<ContactDetail>):

    Provides details about the domain billing contact.

  • billing_privacy(Option<bool>):

    Specifies whether contact information is concealed from WHOIS queries. If the value is true, WHOIS (“who is”) queries return contact information either for Amazon Registrar or for our registrar associate, Gandi. If the value is false, WHOIS queries return the information that you entered for the billing contact.

• On failure, responds with SdkError<GetDomainDetailError>

impl Client

pub fn get_domain_suggestions(&self) -> GetDomainSuggestionsFluentBuilder

Constructs a fluent builder for the GetDomainSuggestions operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

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

    The domain name can contain only the following characters:

    • Letters a through z. Domain names are not case sensitive.

    • Numbers 0 through 9.

    • Hyphen (-). You can’t specify a hyphen at the beginning or end of a label.

    • Period (.) to separate the labels in the name, such as the . in example.com.

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

    
    
  • suggestion_count(i32) / set_suggestion_count(Option<i32>):
    required: true
    

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

    
    
  • only_available(bool) / set_only_available(Option<bool>):
    required: true
    

    If OnlyAvailable is true, Route 53 returns only domain names that are available. If OnlyAvailable is false, Route 53 returns domain names without checking whether they’re available to be registered. To determine whether the domain is available, you can call checkDomainAvailability for each suggestion.

    
    
• On success, responds with GetDomainSuggestionsOutput with field(s):
  • suggestions_list(Option<Vec::<DomainSuggestion>>):

    A list of possible domain names. If you specified true for OnlyAvailable in the request, the list contains only domains that are available for registration.

• On failure, responds with SdkError<GetDomainSuggestionsError>

impl Client

pub fn get_operation_detail(&self) -> GetOperationDetailFluentBuilder

Constructs a fluent builder for the GetOperationDetail operation.

• The fluent builder is configurable:
  • operation_id(impl Into<String>) / set_operation_id(Option<String>):
    required: true
    

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

    
    
• On success, responds with GetOperationDetailOutput with field(s):
  • operation_id(Option<String>):

    The identifier for the operation.

  • status(Option<OperationStatus>):

    The current status of the requested operation in the system.

  • message(Option<String>):

    Detailed information on the status including possible errors.

  • domain_name(Option<String>):

    The name of a domain.

  • r#type(Option<OperationType>):

    The type of operation that was requested.

  • submitted_date(Option<DateTime>):

    The date when the request was submitted.

  • last_updated_date(Option<DateTime>):

    The date when the operation was last updated.

  • status_flag(Option<StatusFlag>):

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

    • PENDING_ACCEPTANCE: The operation is waiting for acceptance from the account that is receiving the domain.

    • PENDING_CUSTOMER_ACTION: The operation is waiting for customer action, for example, returning an email.

    • PENDING_AUTHORIZATION: The operation is waiting for the form of authorization. For more information, see ResendOperationAuthorization.

    • PENDING_PAYMENT_VERIFICATION: The operation is waiting for the payment method to validate.

    • PENDING_SUPPORT_CASE: The operation includes a support case and is waiting for its resolution.

• On failure, responds with SdkError<GetOperationDetailError>

impl Client

pub fn list_domains(&self) -> ListDomainsFluentBuilder

Constructs a fluent builder for the ListDomains operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filter_conditions(FilterCondition) / set_filter_conditions(Option<Vec::<FilterCondition>>):
    required: false
    

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

    
    
  • sort_condition(SortCondition) / set_sort_condition(Option<SortCondition>):
    required: false
    

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

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    For an initial request for a list of domains, omit this element. If the number of domains that are associated with the current Amazon Web Services account is greater than the value that you specified for MaxItems, you can use Marker to return additional domains. Get the value of NextPageMarker from the previous response, and submit another request that includes the value of NextPageMarker in the Marker element.

    Constraints: The marker must match the value specified in the previous request.

    
    
  • max_items(i32) / set_max_items(Option<i32>):
    required: false
    

    Number of domains to be returned.

    Default: 20

    
    
• On success, responds with ListDomainsOutput with field(s):
  • domains(Option<Vec::<DomainSummary>>):

    A list of domains.

  • next_page_marker(Option<String>):

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

• On failure, responds with SdkError<ListDomainsError>

impl Client

pub fn list_operations(&self) -> ListOperationsFluentBuilder

Constructs a fluent builder for the ListOperations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • submitted_since(DateTime) / set_submitted_since(Option<DateTime>):
    required: false
    

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

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

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

    
    
  • max_items(i32) / set_max_items(Option<i32>):
    required: false
    

    Number of domains to be returned.

    Default: 20

    
    
  • status(OperationStatus) / set_status(Option<Vec::<OperationStatus>>):
    required: false
    

    The status of the operations.

    
    
  • r#type(OperationType) / set_type(Option<Vec::<OperationType>>):
    required: false
    

    An arrays of the domains operation types.

    
    
  • sort_by(ListOperationsSortAttributeName) / set_sort_by(Option<ListOperationsSortAttributeName>):
    required: false
    

    The sort type for returned values.

    
    
  • sort_order(SortOrder) / set_sort_order(Option<SortOrder>):
    required: false
    

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

    
    
• On success, responds with ListOperationsOutput with field(s):
  • operations(Option<Vec::<OperationSummary>>):

    Lists summaries of the operations.

  • next_page_marker(Option<String>):

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

• On failure, responds with SdkError<ListOperationsError>

impl Client

pub fn list_prices(&self) -> ListPricesFluentBuilder

Constructs a fluent builder for the ListPrices operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • tld(impl Into<String>) / set_tld(Option<String>):
    required: false
    

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

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

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

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

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

    
    
  • max_items(i32) / set_max_items(Option<i32>):
    required: false
    

    Number of Prices to be returned.

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

    
    
• On success, responds with ListPricesOutput with field(s):
  • prices(Option<Vec::<DomainPrice>>):

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

  • next_page_marker(Option<String>):

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

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

• On failure, responds with SdkError<ListPricesError>

impl Client

pub fn list_tags_for_domain(&self) -> ListTagsForDomainFluentBuilder

Constructs a fluent builder for the ListTagsForDomain operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

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

    
    
• On success, responds with ListTagsForDomainOutput with field(s):
  • tag_list(Option<Vec::<Tag>>):

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

• On failure, responds with SdkError<ListTagsForDomainError>

impl Client

pub fn push_domain(&self) -> PushDomainFluentBuilder

Constructs a fluent builder for the PushDomain operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    Name of the domain.

    
    
  • target(impl Into<String>) / set_target(Option<String>):
    required: true
    

    New IPS tag for the domain.

    
    
• On success, responds with PushDomainOutput
• On failure, responds with SdkError<PushDomainError>

impl Client

pub fn register_domain(&self) -> RegisterDomainFluentBuilder

Constructs a fluent builder for the RegisterDomain operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

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

    The domain name can contain only the following characters:

    • Letters a through z. Domain names are not case sensitive.

    • Numbers 0 through 9.

    • Hyphen (-). You can’t specify a hyphen at the beginning or end of a label.

    • Period (.) to separate the labels in the name, such as the . in example.com.

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

    
    
  • idn_lang_code(impl Into<String>) / set_idn_lang_code(Option<String>):
    required: false
    

    Reserved for future use.

    
    
  • duration_in_years(i32) / set_duration_in_years(Option<i32>):
    required: true
    

    The number of years that you want to register the domain for. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain. For the range of valid values for your domain, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide.

    Default: 1

    
    
  • auto_renew(bool) / set_auto_renew(Option<bool>):
    required: false
    

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

    Default: true

    
    
  • admin_contact(ContactDetail) / set_admin_contact(Option<ContactDetail>):
    required: true
    

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

    
    
  • registrant_contact(ContactDetail) / set_registrant_contact(Option<ContactDetail>):
    required: true
    

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

    
    
  • tech_contact(ContactDetail) / set_tech_contact(Option<ContactDetail>):
    required: true
    

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

    
    
  • privacy_protect_admin_contact(bool) / set_privacy_protect_admin_contact(Option<bool>):
    required: false
    

    Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (“who is”) queries return contact information either for Amazon Registrar or for our registrar associate, Gandi. If you specify false, WHOIS queries return the information that you entered for the admin contact.

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

    Default: true

    
    
  • privacy_protect_registrant_contact(bool) / set_privacy_protect_registrant_contact(Option<bool>):
    required: false
    

    Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (“who is”) queries return contact information either for Amazon Registrar or for our registrar associate, Gandi. If you specify false, WHOIS queries return the information that you entered for the registrant contact (the domain owner).

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

    Default: true

    
    
  • privacy_protect_tech_contact(bool) / set_privacy_protect_tech_contact(Option<bool>):
    required: false
    

    Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (“who is”) queries return contact information either for Amazon Registrar or for our registrar associate, Gandi. If you specify false, WHOIS queries return the information that you entered for the technical contact.

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

    Default: true

    
    
  • billing_contact(ContactDetail) / set_billing_contact(Option<ContactDetail>):
    required: false
    

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

    
    
  • privacy_protect_billing_contact(bool) / set_privacy_protect_billing_contact(Option<bool>):
    required: false
    

    Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (“who is”) queries return contact information either for Amazon Registrar or for our registrar associate, Gandi. If you specify false, WHOIS queries return the information that you entered for the billing contact.

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

    
    
• On success, responds with RegisterDomainOutput with field(s):
  • operation_id(Option<String>):

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

• On failure, responds with SdkError<RegisterDomainError>

impl Client

pub fn reject_domain_transfer_from_another_aws_account( &self ) -> RejectDomainTransferFromAnotherAwsAccountFluentBuilder

Constructs a fluent builder for the RejectDomainTransferFromAnotherAwsAccount operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

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

    
    
• On success, responds with RejectDomainTransferFromAnotherAwsAccountOutput with field(s):
  • operation_id(Option<String>):

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

• On failure, responds with SdkError<RejectDomainTransferFromAnotherAwsAccountError>

impl Client

pub fn renew_domain(&self) -> RenewDomainFluentBuilder

Constructs a fluent builder for the RenewDomain operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The name of the domain that you want to renew.

    
    
  • duration_in_years(i32) / set_duration_in_years(Option<i32>):
    required: false
    

    The number of years that you want to renew the domain for. The maximum number of years depends on the top-level domain. For the range of valid values for your domain, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide.

    Default: 1

    
    
  • current_expiry_year(i32) / set_current_expiry_year(Option<i32>):
    required: true
    

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

    
    
• On success, responds with RenewDomainOutput with field(s):
  • operation_id(Option<String>):

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

• On failure, responds with SdkError<RenewDomainError>

impl Client

pub fn resend_contact_reachability_email( &self ) -> ResendContactReachabilityEmailFluentBuilder

Constructs a fluent builder for the ResendContactReachabilityEmail operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: false
    

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

    
    
• On success, responds with ResendContactReachabilityEmailOutput with field(s):
  • domain_name(Option<String>):

    The domain name for which you requested a confirmation email.

  • email_address(Option<String>):

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

  • is_already_verified(Option<bool>):

    True if the email address for the registrant contact has already been verified, and false otherwise. If the email address has already been verified, we don’t send another confirmation email.

• On failure, responds with SdkError<ResendContactReachabilityEmailError>

impl Client

pub fn resend_operation_authorization( &self ) -> ResendOperationAuthorizationFluentBuilder

Constructs a fluent builder for the ResendOperationAuthorization operation.

• The fluent builder is configurable:
  • operation_id(impl Into<String>) / set_operation_id(Option<String>):
    required: true
    

    Operation ID.

    
    
• On success, responds with ResendOperationAuthorizationOutput
• On failure, responds with SdkError<ResendOperationAuthorizationError>

impl Client

pub fn retrieve_domain_auth_code(&self) -> RetrieveDomainAuthCodeFluentBuilder

Constructs a fluent builder for the RetrieveDomainAuthCode operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

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

    
    
• On success, responds with RetrieveDomainAuthCodeOutput with field(s):
  • auth_code(Option<String>):

    The authorization code for the domain.

• On failure, responds with SdkError<RetrieveDomainAuthCodeError>

impl Client

pub fn transfer_domain(&self) -> TransferDomainFluentBuilder

Constructs a fluent builder for the TransferDomain operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

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

    The domain name can contain only the following characters:

    • Letters a through z. Domain names are not case sensitive.

    • Numbers 0 through 9.

    • Hyphen (-). You can’t specify a hyphen at the beginning or end of a label.

    • Period (.) to separate the labels in the name, such as the . in example.com.

    
    
  • idn_lang_code(impl Into<String>) / set_idn_lang_code(Option<String>):
    required: false
    

    Reserved for future use.

    
    
  • duration_in_years(i32) / set_duration_in_years(Option<i32>):
    required: true
    

    The number of years that you want to register the domain for. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain.

    Default: 1

    
    
  • nameservers(Nameserver) / set_nameservers(Option<Vec::<Nameserver>>):
    required: false
    

    Contains details for the host and glue IP addresses.

    
    
  • auth_code(impl Into<String>) / set_auth_code(Option<String>):
    required: false
    

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

    
    
  • auto_renew(bool) / set_auto_renew(Option<bool>):
    required: false
    

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

    Default: true

    
    
  • admin_contact(ContactDetail) / set_admin_contact(Option<ContactDetail>):
    required: true
    

    Provides detailed contact information.

    
    
  • registrant_contact(ContactDetail) / set_registrant_contact(Option<ContactDetail>):
    required: true
    

    Provides detailed contact information.

    
    
  • tech_contact(ContactDetail) / set_tech_contact(Option<ContactDetail>):
    required: true
    

    Provides detailed contact information.

    
    
  • privacy_protect_admin_contact(bool) / set_privacy_protect_admin_contact(Option<bool>):
    required: false
    

    Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (“who is”) queries return contact information for the registrar, the phrase “REDACTED FOR PRIVACY”, or “On behalf of owner.”.

    While some domains may allow different privacy settings per contact, we recommend specifying the same privacy setting for all contacts.

    Default: true

    
    
  • privacy_protect_registrant_contact(bool) / set_privacy_protect_registrant_contact(Option<bool>):
    required: false
    

    Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (“who is”) queries return contact information either for Amazon Registrar or for our registrar associate, Gandi. If you specify false, WHOIS queries return the information that you entered for the registrant contact (domain owner).

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

    Default: true

    
    
  • privacy_protect_tech_contact(bool) / set_privacy_protect_tech_contact(Option<bool>):
    required: false
    

    Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (“who is”) queries return contact information either for Amazon Registrar or for our registrar associate, Gandi. If you specify false, WHOIS queries return the information that you entered for the technical contact.

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

    Default: true

    
    
  • billing_contact(ContactDetail) / set_billing_contact(Option<ContactDetail>):
    required: false
    

    Provides detailed contact information.

    
    
  • privacy_protect_billing_contact(bool) / set_privacy_protect_billing_contact(Option<bool>):
    required: false
    

    Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (“who is”) queries return contact information either for Amazon Registrar or for our registrar associate, Gandi. If you specify false, WHOIS queries return the information that you entered for the billing contact.

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

    
    
• On success, responds with TransferDomainOutput with field(s):
  • operation_id(Option<String>):

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

• On failure, responds with SdkError<TransferDomainError>

impl Client

pub fn transfer_domain_to_another_aws_account( &self ) -> TransferDomainToAnotherAwsAccountFluentBuilder

Constructs a fluent builder for the TransferDomainToAnotherAwsAccount operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

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

    
    
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

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

    
    
• On success, responds with TransferDomainToAnotherAwsAccountOutput with field(s):
  • operation_id(Option<String>):

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

  • password(Option<String>):

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

• On failure, responds with SdkError<TransferDomainToAnotherAwsAccountError>

impl Client

pub fn update_domain_contact(&self) -> UpdateDomainContactFluentBuilder

Constructs a fluent builder for the UpdateDomainContact operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

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

    
    
  • admin_contact(ContactDetail) / set_admin_contact(Option<ContactDetail>):
    required: false
    

    Provides detailed contact information.

    
    
  • registrant_contact(ContactDetail) / set_registrant_contact(Option<ContactDetail>):
    required: false
    

    Provides detailed contact information.

    
    
  • tech_contact(ContactDetail) / set_tech_contact(Option<ContactDetail>):
    required: false
    

    Provides detailed contact information.

    
    
  • consent(Consent) / set_consent(Option<Consent>):
    required: false
    

    Customer’s consent for the owner change request. Required if the domain is not free (consent price is more than $0.00).

    
    
  • billing_contact(ContactDetail) / set_billing_contact(Option<ContactDetail>):
    required: false
    

    Provides detailed contact information.

    
    
• On success, responds with UpdateDomainContactOutput with field(s):
  • operation_id(Option<String>):

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

• On failure, responds with SdkError<UpdateDomainContactError>

impl Client

pub fn update_domain_contact_privacy( &self ) -> UpdateDomainContactPrivacyFluentBuilder

Constructs a fluent builder for the UpdateDomainContactPrivacy operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

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

    
    
  • admin_privacy(bool) / set_admin_privacy(Option<bool>):
    required: false
    

    Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (“who is”) queries return contact information either for Amazon Registrar or for our registrar associate, Gandi. If you specify false, WHOIS queries return the information that you entered for the admin contact.

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

    
    
  • registrant_privacy(bool) / set_registrant_privacy(Option<bool>):
    required: false
    

    Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (“who is”) queries return contact information either for Amazon Registrar or for our registrar associate, Gandi. If you specify false, WHOIS queries return the information that you entered for the registrant contact (domain owner).

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

    
    
  • tech_privacy(bool) / set_tech_privacy(Option<bool>):
    required: false
    

    Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (“who is”) queries return contact information either for Amazon Registrar or for our registrar associate, Gandi. If you specify false, WHOIS queries return the information that you entered for the technical contact.

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

    
    
  • billing_privacy(bool) / set_billing_privacy(Option<bool>):
    required: false
    

    Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (“who is”) queries return contact information either for Amazon Registrar or for our registrar associate, Gandi. If you specify false, WHOIS queries return the information that you entered for the billing contact.

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

    
    
• On success, responds with UpdateDomainContactPrivacyOutput with field(s):
  • operation_id(Option<String>):

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

• On failure, responds with SdkError<UpdateDomainContactPrivacyError>

impl Client

pub fn update_domain_nameservers(&self) -> UpdateDomainNameserversFluentBuilder

Constructs a fluent builder for the UpdateDomainNameservers operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

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

    
    
  • fi_auth_key(impl Into<String>) / set_fi_auth_key(Option<String>):
    required: false
    

    The authorization key for .fi domains

    
    
  • nameservers(Nameserver) / set_nameservers(Option<Vec::<Nameserver>>):
    required: true
    

    A list of new name servers for the domain.

    
    
• On success, responds with UpdateDomainNameserversOutput with field(s):
  • operation_id(Option<String>):

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

• On failure, responds with SdkError<UpdateDomainNameserversError>

impl Client

pub fn update_tags_for_domain(&self) -> UpdateTagsForDomainFluentBuilder

Constructs a fluent builder for the UpdateTagsForDomain operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

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

    
    
  • tags_to_update(Tag) / set_tags_to_update(Option<Vec::<Tag>>):
    required: false
    

    A list of the tag keys and values that you want to add or update. If you specify a key that already exists, the corresponding value will be replaced.

    
    
• On success, responds with UpdateTagsForDomainOutput
• On failure, responds with SdkError<UpdateTagsForDomainError>

impl Client

pub fn view_billing(&self) -> ViewBillingFluentBuilder

Constructs a fluent builder for the ViewBilling operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • start(DateTime) / set_start(Option<DateTime>):
    required: false
    

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

    
    
  • end(DateTime) / set_end(Option<DateTime>):
    required: false
    

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

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    For an initial request for a list of billing records, omit this element. If the number of billing records that are associated with the current Amazon Web Services account during the specified period is greater than the value that you specified for MaxItems, you can use Marker to return additional billing records. Get the value of NextPageMarker from the previous response, and submit another request that includes the value of NextPageMarker in the Marker element.

    Constraints: The marker must match the value of NextPageMarker that was returned in the previous response.

    
    
  • max_items(i32) / set_max_items(Option<i32>):
    required: false
    

    The number of billing records to be returned.

    Default: 20

    
    
• On success, responds with ViewBillingOutput with field(s):
  • next_page_marker(Option<String>):

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

  • billing_records(Option<Vec::<BillingRecord>>):

    A summary of billing records.

• On failure, responds with SdkError<ViewBillingError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.