pub struct Client<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }
Expand description

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.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_route53domains::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
    let shared_config = aws_config::load_from_env().await;
    let config = aws_sdk_route53domains::config::Builder::from(&shared_config)
        .retry_config(RetryConfig::disabled())
        .build();
    let client = aws_sdk_route53domains::Client::from_conf(config);

Implementations

Creates a client with the given service configuration.

Returns the client’s configuration.

Constructs a fluent builder for the AcceptDomainTransferFromAnotherAwsAccount operation.

Constructs a fluent builder for the CancelDomainTransferToAnotherAwsAccount operation.

Constructs a fluent builder for the CheckDomainAvailability operation.

  • The fluent builder is configurable:
  • 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.

      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>

Constructs a fluent builder for the CheckDomainTransferability operation.

Constructs a fluent builder for the DeleteDomain operation.

Constructs a fluent builder for the DeleteTagsForDomain operation.

Constructs a fluent builder for the DisableDomainAutoRenew operation.

Constructs a fluent builder for the DisableDomainTransferLock operation.

Constructs a fluent builder for the EnableDomainAutoRenew operation.

Constructs a fluent builder for the EnableDomainTransferLock operation.

Constructs a fluent builder for the GetContactReachabilityStatus operation.

Constructs a fluent builder for the GetDomainDetail operation.

  • The fluent builder is configurable:
  • On success, responds with GetDomainDetailOutput with field(s):
    • domain_name(Option<String>):

      The name of a domain.

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

      The name 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 (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If the value is false, WHOIS queries return the information that you entered for the admin contact.

    • 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 (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If the value is false, WHOIS queries return the information that you entered for the 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 (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If the value is false, WHOIS queries return the information that you entered for the technical contact.

    • registrar_name(Option<String>):

      Name of the registrar of the domain as identified in the registry. Domains with a .com, .net, or .org TLD are registered by Amazon Registrar. All other domains are registered by our registrar associate, Gandi. The value for domains that are registered by Gandi is “GANDI SAS”.

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

  • On failure, responds with SdkError<GetDomainDetailError>

Constructs a fluent builder for the GetDomainSuggestions operation.

Constructs a fluent builder for the GetOperationDetail operation.

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

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

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>):

      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>):

      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>):

      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>

Constructs a fluent builder for the ListTagsForDomain operation.

Constructs a fluent builder for the RegisterDomain operation.

Constructs a fluent builder for the RejectDomainTransferFromAnotherAwsAccount operation.

Constructs a fluent builder for the RenewDomain operation.

Constructs a fluent builder for the ResendContactReachabilityEmail operation.

Constructs a fluent builder for the RetrieveDomainAuthCode operation.

Constructs a fluent builder for the TransferDomain operation.

Constructs a fluent builder for the TransferDomainToAnotherAwsAccount operation.

Constructs a fluent builder for the UpdateDomainContact operation.

Constructs a fluent builder for the UpdateDomainContactPrivacy operation.

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

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

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

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

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

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

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

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

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

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

      You must specify the same privacy setting for the administrative, 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>

Constructs a fluent builder for the UpdateDomainNameservers operation.

Constructs a fluent builder for the UpdateTagsForDomain operation.

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>):

      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>):

      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>):

      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>):

      The number of billing records to be returned.

      Default: 20

  • On success, responds with ViewBillingOutput with field(s):
  • On failure, responds with SdkError<ViewBillingError>

Creates a client with the given service config and connector override.

Creates a new client from a shared config.

Creates a new client from the service Config.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Performs the conversion.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Performs the conversion.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more