amazonka-route53-domains-2.0: Amazon Route 53 Domains SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Route53Domains.ListPrices

Description

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

  • Registration
  • Transfer
  • Owner change
  • Domain renewal
  • Domain restoration

This operation returns paginated results.

Synopsis

Creating a Request

data ListPrices Source #

See: newListPrices smart constructor.

Constructors

ListPrices' 

Fields

  • marker :: Maybe Text

    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.

  • maxItems :: Maybe Int

    Number of Prices to be returned.

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

  • tld :: Maybe Text

    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.

Instances

Instances details
ToJSON ListPrices Source # 
Instance details

Defined in Amazonka.Route53Domains.ListPrices

ToHeaders ListPrices Source # 
Instance details

Defined in Amazonka.Route53Domains.ListPrices

Methods

toHeaders :: ListPrices -> [Header] #

ToPath ListPrices Source # 
Instance details

Defined in Amazonka.Route53Domains.ListPrices

ToQuery ListPrices Source # 
Instance details

Defined in Amazonka.Route53Domains.ListPrices

AWSPager ListPrices Source # 
Instance details

Defined in Amazonka.Route53Domains.ListPrices

AWSRequest ListPrices Source # 
Instance details

Defined in Amazonka.Route53Domains.ListPrices

Associated Types

type AWSResponse ListPrices #

Generic ListPrices Source # 
Instance details

Defined in Amazonka.Route53Domains.ListPrices

Associated Types

type Rep ListPrices :: Type -> Type #

Read ListPrices Source # 
Instance details

Defined in Amazonka.Route53Domains.ListPrices

Show ListPrices Source # 
Instance details

Defined in Amazonka.Route53Domains.ListPrices

NFData ListPrices Source # 
Instance details

Defined in Amazonka.Route53Domains.ListPrices

Methods

rnf :: ListPrices -> () #

Eq ListPrices Source # 
Instance details

Defined in Amazonka.Route53Domains.ListPrices

Hashable ListPrices Source # 
Instance details

Defined in Amazonka.Route53Domains.ListPrices

type AWSResponse ListPrices Source # 
Instance details

Defined in Amazonka.Route53Domains.ListPrices

type Rep ListPrices Source # 
Instance details

Defined in Amazonka.Route53Domains.ListPrices

type Rep ListPrices = D1 ('MetaData "ListPrices" "Amazonka.Route53Domains.ListPrices" "amazonka-route53-domains-2.0-6iruRSkjgLuDp958hFs0e" 'False) (C1 ('MetaCons "ListPrices'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "maxItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "tld") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListPrices :: ListPrices Source #

Create a value of ListPrices with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:marker:ListPrices', listPrices_marker - 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.

$sel:maxItems:ListPrices', listPrices_maxItems - Number of Prices to be returned.

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

$sel:tld:ListPrices', listPrices_tld - 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.

Request Lenses

listPrices_marker :: Lens' ListPrices (Maybe Text) Source #

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.

listPrices_maxItems :: Lens' ListPrices (Maybe Int) Source #

Number of Prices to be returned.

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

listPrices_tld :: Lens' ListPrices (Maybe Text) Source #

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.

Destructuring the Response

data ListPricesResponse Source #

See: newListPricesResponse smart constructor.

Constructors

ListPricesResponse' 

Fields

  • nextPageMarker :: Maybe Text

    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.

  • prices :: Maybe [DomainPrice]

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

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListPricesResponse Source # 
Instance details

Defined in Amazonka.Route53Domains.ListPrices

Associated Types

type Rep ListPricesResponse :: Type -> Type #

Read ListPricesResponse Source # 
Instance details

Defined in Amazonka.Route53Domains.ListPrices

Show ListPricesResponse Source # 
Instance details

Defined in Amazonka.Route53Domains.ListPrices

NFData ListPricesResponse Source # 
Instance details

Defined in Amazonka.Route53Domains.ListPrices

Methods

rnf :: ListPricesResponse -> () #

Eq ListPricesResponse Source # 
Instance details

Defined in Amazonka.Route53Domains.ListPrices

type Rep ListPricesResponse Source # 
Instance details

Defined in Amazonka.Route53Domains.ListPrices

type Rep ListPricesResponse = D1 ('MetaData "ListPricesResponse" "Amazonka.Route53Domains.ListPrices" "amazonka-route53-domains-2.0-6iruRSkjgLuDp958hFs0e" 'False) (C1 ('MetaCons "ListPricesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextPageMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "prices") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DomainPrice])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListPricesResponse Source #

Create a value of ListPricesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextPageMarker:ListPricesResponse', listPricesResponse_nextPageMarker - 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.

$sel:prices:ListPricesResponse', listPricesResponse_prices - A complex type that includes all the pricing information. If you specify a TLD, this array contains only the pricing for that TLD.

$sel:httpStatus:ListPricesResponse', listPricesResponse_httpStatus - The response's http status code.

Response Lenses

listPricesResponse_nextPageMarker :: Lens' ListPricesResponse (Maybe Text) Source #

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.

listPricesResponse_prices :: Lens' ListPricesResponse (Maybe [DomainPrice]) Source #

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