Skip to content

list_prices

list_prices(
    *,
    config_overrides: Optional[Route53DomainsClientConfig] = None,
    tld: Optional[TldName] = None,
    marker: Optional[PageMarker] = None,
    max_items: Optional[ListPricesPageMaxItems] = None,
) -> ListPricesResponse

Lists the following prices for either all the TLDs supported by Route 53, or the specified TLD:

  • Registration

  • Transfer

  • Owner change

  • Renewal

  • Restoration

The prices that ListPrices returns are the standard rates for a TLD. ListPrices doesn't return registry premium prices, which apply to individual domain names rather than to a TLD. To get accurate pricing for a specific domain name, including premium prices, call GetDomainPrices.

Parameters:

  • tld (Optional[TldName], default: None ) –

    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 (Optional[PageMarker], default: None ) –

    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 (Optional[ListPricesPageMaxItems], default: None ) –

    Number of Prices to be returned.

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

Raises:

  • InvalidInput –

    The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.

  • UnsupportedTLD –

    Amazon Route 53 does not support this top-level domain (TLD).

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_route_53_domains/_services/route53_domains.py
def list_prices(
    self,
    *,
    config_overrides: Optional[Route53DomainsClientConfig] = None,
    tld: Optional["capo_route_53_domains.types.tld_name.TldName"] = None,
    marker: Optional["capo_route_53_domains.types.page_marker.PageMarker"] = None,
    max_items: Optional[
        "capo_route_53_domains.types.list_prices_page_max_items.ListPricesPageMaxItems"
    ] = None,
) -> "capo_route_53_domains.types.list_prices_response.ListPricesResponse":
    """<p>Lists the following prices for either all the TLDs supported by Route 53, or the specified TLD:</p> <ul> <li> <p>Registration</p> </li> <li> <p>Transfer</p> </li> <li> <p>Owner change</p> </li> <li> <p>Renewal</p> </li> <li> <p>Restoration</p> </li> </ul> <note> <p>The prices that <code>ListPrices</code> returns are the standard rates for a TLD. <code>ListPrices</code> doesn't return registry premium prices, which apply to individual domain names rather than to a TLD. To get accurate pricing for a specific domain name, including premium prices, call <code>GetDomainPrices</code>.</p> </note>

    Args:
        tld: <p>The TLD for which you want to receive the pricing information. For example. <code>.net</code>.</p> <p>If a <code>Tld</code> value is not provided, a list of prices for all TLDs supported by Route 53 is returned.</p>
        marker: <p>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 <code>MaxItems</code>, you can use <code>Marker</code> to return additional prices. Get the value of <code>NextPageMarker</code> from the previous response, and submit another request that includes the value of <code>NextPageMarker</code> in the <code>Marker</code> element. </p> <p>Used only for all TLDs. If you specify a TLD, don't specify a <code>Marker</code>.</p>
        max_items: <p>Number of <code>Prices</code> to be returned.</p> <p>Used only for all TLDs. If you specify a TLD, don't specify a <code>MaxItems</code>.</p>

    Raises:
        capo_route_53_domains.errors.invalid_input.InvalidInput: <p>The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For <code>AcceptDomainTransferFromAnotherAwsAccount</code>, the password might be invalid.</p>
        capo_route_53_domains.errors.unsupported_tld.UnsupportedTLD: <p>Amazon Route 53 does not support this top-level domain (TLD).</p>
        capo_route_53_domains.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_route_53_domains.types.list_prices_request.ListPricesRequest]",
    ) -> OperationResponse[
        "capo_route_53_domains.types.list_prices_response.ListPricesResponse"
    ]:
        import capo_route_53_domains._operations.route53_domains_v20140515.list_prices

        output, http_response = (
            capo_route_53_domains._operations.route53_domains_v20140515.list_prices.list_prices(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListPrices")
    )
    input_: capo_route_53_domains.types.list_prices_request.ListPricesRequest = {}
    if tld is not None:
        input_["tld"] = tld
    if marker is not None:
        input_["marker"] = marker
    if max_items is not None:
        input_["max_items"] = max_items

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output