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

Amazonka.Route53Domains.ListPrices

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

data ListPrices = ListPrices' {
- marker :: Maybe Text
- maxItems :: Maybe Int
- tld :: Maybe Text
}
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.

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 Methods toJSON :: ListPrices -> Value # toEncoding :: ListPrices -> Encoding # toJSONList :: [ListPrices] -> Value # toEncodingList :: [ListPrices] -> Encoding #
ToHeaders ListPrices Source #
Instance details Defined in Amazonka.Route53Domains.ListPrices Methods toHeaders :: ListPrices -> [Header] #
ToPath ListPrices Source #
Instance details Defined in Amazonka.Route53Domains.ListPrices Methods toPath :: ListPrices -> ByteString #
ToQuery ListPrices Source #
Instance details Defined in Amazonka.Route53Domains.ListPrices Methods toQuery :: ListPrices -> QueryString #
AWSPager ListPrices Source #
Instance details Defined in Amazonka.Route53Domains.ListPrices Methods page :: ListPrices -> AWSResponse ListPrices -> Maybe ListPrices #
AWSRequest ListPrices Source #
Instance details Defined in Amazonka.Route53Domains.ListPrices Associated Types type AWSResponse ListPrices # Methods request :: (Service -> Service) -> ListPrices -> Request ListPrices # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListPrices -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListPrices))) #
Generic ListPrices Source #
Instance details Defined in Amazonka.Route53Domains.ListPrices Associated Types type Rep ListPrices :: Type -> Type # Methods from :: ListPrices -> Rep ListPrices x # to :: Rep ListPrices x -> ListPrices #
Read ListPrices Source #
Instance details Defined in Amazonka.Route53Domains.ListPrices Methods readsPrec :: Int -> ReadS ListPrices # readList :: ReadS [ListPrices] # readPrec :: ReadPrec ListPrices # readListPrec :: ReadPrec [ListPrices] #
Show ListPrices Source #
Instance details Defined in Amazonka.Route53Domains.ListPrices Methods showsPrec :: Int -> ListPrices -> ShowS # show :: ListPrices -> String # showList :: [ListPrices] -> ShowS #
NFData ListPrices Source #
Instance details Defined in Amazonka.Route53Domains.ListPrices Methods rnf :: ListPrices -> () #
Eq ListPrices Source #
Instance details Defined in Amazonka.Route53Domains.ListPrices Methods (==) :: ListPrices -> ListPrices -> Bool # (/=) :: ListPrices -> ListPrices -> Bool #
Hashable ListPrices Source #
Instance details Defined in Amazonka.Route53Domains.ListPrices Methods hashWithSalt :: Int -> ListPrices -> Int # hash :: ListPrices -> Int #
type AWSResponse ListPrices Source #
Instance details Defined in Amazonka.Route53Domains.ListPrices type AWSResponse ListPrices = ListPricesResponse
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 # Methods from :: ListPricesResponse -> Rep ListPricesResponse x # to :: Rep ListPricesResponse x -> ListPricesResponse #
Read ListPricesResponse Source #
Instance details Defined in Amazonka.Route53Domains.ListPrices Methods readsPrec :: Int -> ReadS ListPricesResponse # readList :: ReadS [ListPricesResponse] # readPrec :: ReadPrec ListPricesResponse # readListPrec :: ReadPrec [ListPricesResponse] #
Show ListPricesResponse Source #
Instance details Defined in Amazonka.Route53Domains.ListPrices Methods showsPrec :: Int -> ListPricesResponse -> ShowS # show :: ListPricesResponse -> String # showList :: [ListPricesResponse] -> ShowS #
NFData ListPricesResponse Source #
Instance details Defined in Amazonka.Route53Domains.ListPrices Methods rnf :: ListPricesResponse -> () #
Eq ListPricesResponse Source #
Instance details Defined in Amazonka.Route53Domains.ListPrices Methods (==) :: ListPricesResponse -> ListPricesResponse -> Bool # (/=) :: ListPricesResponse -> ListPricesResponse -> Bool #
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 #

Arguments

:: Int	`$sel:httpStatus:ListPricesResponse'`
-> ListPricesResponse

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.