Skip to content

CheckDomainAvailabilityResponse

Source code in docs_src/capo_route_53_domains/types/check_domain_availability_response.py 
12
13
14
15
16
17
18
19
20
class CheckDomainAvailabilityResponse(TypedDict, closed=True):
    availability: NotRequired[
        "capo_route_53_domains.types.domain_availability.DomainAvailability"
    ]
    """<p>Whether the domain name is available for registering.</p> <note> <p>You can register only domains designated as <code>AVAILABLE</code>.</p> </note> <p>Valid values:</p> <dl> <dt>AVAILABLE</dt> <dd> <p>The domain name is available.</p> </dd> <dt>AVAILABLE_RESERVED</dt> <dd> <p>The domain name is reserved under specific conditions.</p> </dd> <dt>AVAILABLE_PREORDER</dt> <dd> <p>The domain name is available and can be preordered.</p> </dd> <dt>DONT_KNOW</dt> <dd> <p>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.</p> </dd> <dt>INVALID_NAME_FOR_TLD</dt> <dd> <p>The TLD isn't valid. For example, it can contain characters that aren't allowed.</p> </dd> <dt>PENDING</dt> <dd> <p>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.</p> </dd> <dt>RESERVED</dt> <dd> <p>The domain name has been reserved for another person or organization.</p> </dd> <dt>UNAVAILABLE</dt> <dd> <p>The domain name is not available.</p> </dd> <dt>UNAVAILABLE_PREMIUM</dt> <dd> <p>The domain name is not available.</p> </dd> <dt>UNAVAILABLE_RESTRICTED</dt> <dd> <p>The domain name is forbidden.</p> </dd> </dl>"""
    price: NotRequired[
        "capo_route_53_domains.types.price_with_currency.PriceWithCurrency"
    ]
    """<p>The price to register the domain name, in the currency that <code>Currency</code> specifies. If the domain has registry premium pricing, this price is different from the standard rate for the TLD that <code>ListPrices</code> returns. Use <code>PriceType</code> to determine which rate applies.</p> <p>This element is returned only when <code>Availability</code> is <code>AVAILABLE</code>.</p>"""

availability instance-attribute 

availability: NotRequired[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.

price instance-attribute 

price: NotRequired[PriceWithCurrency]

The price to register the domain name, in the currency that Currency specifies. If the domain has registry premium pricing, this price is different from the standard rate for the TLD that ListPrices returns. Use PriceType to determine which rate applies.

This element is returned only when Availability is AVAILABLE.