Skip to content

DomainSuggestion

Source code in docs_src/capo_route_53_domains/types/domain_suggestion.py
class DomainSuggestion(TypedDict, closed=True):
    domain_name: NotRequired["capo_route_53_domains.types.domain_name.DomainName"]
    """<p>A suggested domain name.</p>"""
    availability: NotRequired["capo_route_53_domains.types.string.String"]
    """<p>Specifies whether the domain name is available for registering. This element is populated only if you specified <code>true</code> for <code>OnlyAvailable</code> in the request.</p> <note> <p>You can register only the domains that are 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>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 suggested domain name, in the currency that <code>Currency</code> specifies. This element is populated only if you specified <code>true</code> for <code>OnlyAvailable</code> in the request.</p>"""

availability instance-attribute

availability: NotRequired[String]

Specifies whether the domain name is available for registering. This element is populated only if you specified true for OnlyAvailable in the request.

You can register only the domains that are 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.

domain_name instance-attribute

domain_name: NotRequired[DomainName]

A suggested domain name.

price instance-attribute

price: NotRequired[PriceWithCurrency]

The price to register the suggested domain name, in the currency that Currency specifies. This element is populated only if you specified true for OnlyAvailable in the request.