Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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
- data ListPrices = ListPrices' {}
- newListPrices :: ListPrices
- listPrices_marker :: Lens' ListPrices (Maybe Text)
- listPrices_maxItems :: Lens' ListPrices (Maybe Int)
- listPrices_tld :: Lens' ListPrices (Maybe Text)
- data ListPricesResponse = ListPricesResponse' {
- nextPageMarker :: Maybe Text
- prices :: Maybe [DomainPrice]
- httpStatus :: Int
- newListPricesResponse :: Int -> ListPricesResponse
- listPricesResponse_nextPageMarker :: Lens' ListPricesResponse (Maybe Text)
- listPricesResponse_prices :: Lens' ListPricesResponse (Maybe [DomainPrice])
- listPricesResponse_httpStatus :: Lens' ListPricesResponse Int
Creating a Request
data ListPrices Source #
See: newListPrices
smart constructor.
ListPrices' | |
|
Instances
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.
ListPricesResponse' | |
|
Instances
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.
listPricesResponse_httpStatus :: Lens' ListPricesResponse Int Source #
The response's http status code.