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.Pricing.GetProducts

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of all products that match the filter criteria.

This operation returns paginated results.

Synopsis

data GetProducts = GetProducts' {
- filters :: Maybe [Filter]
- formatVersion :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- serviceCode :: Text
}
newGetProducts :: Text -> GetProducts
getProducts_filters :: Lens' GetProducts (Maybe [Filter])
getProducts_formatVersion :: Lens' GetProducts (Maybe Text)
getProducts_maxResults :: Lens' GetProducts (Maybe Natural)
getProducts_nextToken :: Lens' GetProducts (Maybe Text)
getProducts_serviceCode :: Lens' GetProducts Text
data GetProductsResponse = GetProductsResponse' {
- formatVersion :: Maybe Text
- nextToken :: Maybe Text
- priceList :: Maybe [Text]
- httpStatus :: Int
}
newGetProductsResponse :: Int -> GetProductsResponse
getProductsResponse_formatVersion :: Lens' GetProductsResponse (Maybe Text)
getProductsResponse_nextToken :: Lens' GetProductsResponse (Maybe Text)
getProductsResponse_priceList :: Lens' GetProductsResponse (Maybe [Text])
getProductsResponse_httpStatus :: Lens' GetProductsResponse Int

Creating a Request

data GetProducts Source #

See: newGetProducts smart constructor.

Constructors

GetProducts'

Fields

filters :: Maybe [Filter]
The list of filters that limit the returned products. only products that match all filters are returned.
formatVersion :: Maybe Text
The format version that you want the response to be in.
Valid values are: aws_v1
maxResults :: Maybe Natural
The maximum number of results to return in the response.
nextToken :: Maybe Text
The pagination token that indicates the next set of results that you want to retrieve.
serviceCode :: Text
The code for the service whose products you want to retrieve.

Instances

Instances details

ToJSON GetProducts Source #
Instance details Defined in Amazonka.Pricing.GetProducts Methods toJSON :: GetProducts -> Value # toEncoding :: GetProducts -> Encoding # toJSONList :: [GetProducts] -> Value # toEncodingList :: [GetProducts] -> Encoding #
ToHeaders GetProducts Source #
Instance details Defined in Amazonka.Pricing.GetProducts Methods toHeaders :: GetProducts -> [Header] #
ToPath GetProducts Source #
Instance details Defined in Amazonka.Pricing.GetProducts Methods toPath :: GetProducts -> ByteString #
ToQuery GetProducts Source #
Instance details Defined in Amazonka.Pricing.GetProducts Methods toQuery :: GetProducts -> QueryString #
AWSPager GetProducts Source #
Instance details Defined in Amazonka.Pricing.GetProducts Methods page :: GetProducts -> AWSResponse GetProducts -> Maybe GetProducts #
AWSRequest GetProducts Source #
Instance details Defined in Amazonka.Pricing.GetProducts Associated Types type AWSResponse GetProducts # Methods request :: (Service -> Service) -> GetProducts -> Request GetProducts # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetProducts -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetProducts))) #
Generic GetProducts Source #
Instance details Defined in Amazonka.Pricing.GetProducts Associated Types type Rep GetProducts :: Type -> Type # Methods from :: GetProducts -> Rep GetProducts x # to :: Rep GetProducts x -> GetProducts #
Read GetProducts Source #
Instance details Defined in Amazonka.Pricing.GetProducts Methods readsPrec :: Int -> ReadS GetProducts # readList :: ReadS [GetProducts] # readPrec :: ReadPrec GetProducts # readListPrec :: ReadPrec [GetProducts] #
Show GetProducts Source #
Instance details Defined in Amazonka.Pricing.GetProducts Methods showsPrec :: Int -> GetProducts -> ShowS # show :: GetProducts -> String # showList :: [GetProducts] -> ShowS #
NFData GetProducts Source #
Instance details Defined in Amazonka.Pricing.GetProducts Methods rnf :: GetProducts -> () #
Eq GetProducts Source #
Instance details Defined in Amazonka.Pricing.GetProducts Methods (==) :: GetProducts -> GetProducts -> Bool # (/=) :: GetProducts -> GetProducts -> Bool #
Hashable GetProducts Source #
Instance details Defined in Amazonka.Pricing.GetProducts Methods hashWithSalt :: Int -> GetProducts -> Int # hash :: GetProducts -> Int #
type AWSResponse GetProducts Source #
Instance details Defined in Amazonka.Pricing.GetProducts type AWSResponse GetProducts = GetProductsResponse
type Rep GetProducts Source #
Instance details Defined in Amazonka.Pricing.GetProducts type Rep GetProducts = D1 ('MetaData "GetProducts" "Amazonka.Pricing.GetProducts" "amazonka-pricing-2.0-2qV8x2ufXzQ7VdGqV3aokJ" 'False) (C1 ('MetaCons "GetProducts'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :: S1 ('MetaSel ('Just "formatVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "serviceCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newGetProducts Source #

Arguments

:: Text	`GetProducts`
-> GetProducts

Create a value of GetProducts 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:filters:GetProducts', getProducts_filters - The list of filters that limit the returned products. only products that match all filters are returned.

GetProducts, getProducts_formatVersion - The format version that you want the response to be in.

Valid values are: aws_v1

$sel:maxResults:GetProducts', getProducts_maxResults - The maximum number of results to return in the response.

GetProducts, getProducts_nextToken - The pagination token that indicates the next set of results that you want to retrieve.

GetProducts, getProducts_serviceCode - The code for the service whose products you want to retrieve.

Request Lenses

getProducts_filters :: Lens' GetProducts (Maybe [Filter]) Source #

The list of filters that limit the returned products. only products that match all filters are returned.

getProducts_formatVersion :: Lens' GetProducts (Maybe Text) Source #

The format version that you want the response to be in.

Valid values are: aws_v1

getProducts_maxResults :: Lens' GetProducts (Maybe Natural) Source #

The maximum number of results to return in the response.

getProducts_nextToken :: Lens' GetProducts (Maybe Text) Source #

The pagination token that indicates the next set of results that you want to retrieve.

getProducts_serviceCode :: Lens' GetProducts Text Source #

The code for the service whose products you want to retrieve.

Destructuring the Response

data GetProductsResponse Source #

See: newGetProductsResponse smart constructor.

Constructors

GetProductsResponse'
Fields formatVersion :: Maybe Text The format version of the response. For example, aws_v1. nextToken :: Maybe Text The pagination token that indicates the next set of results to retrieve. priceList :: Maybe [Text] The list of products that match your filters. The list contains both the product metadata and the price information. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetProductsResponse Source #
Instance details Defined in Amazonka.Pricing.GetProducts Associated Types type Rep GetProductsResponse :: Type -> Type # Methods from :: GetProductsResponse -> Rep GetProductsResponse x # to :: Rep GetProductsResponse x -> GetProductsResponse #
Read GetProductsResponse Source #
Instance details Defined in Amazonka.Pricing.GetProducts Methods readsPrec :: Int -> ReadS GetProductsResponse # readList :: ReadS [GetProductsResponse] # readPrec :: ReadPrec GetProductsResponse # readListPrec :: ReadPrec [GetProductsResponse] #
Show GetProductsResponse Source #
Instance details Defined in Amazonka.Pricing.GetProducts Methods showsPrec :: Int -> GetProductsResponse -> ShowS # show :: GetProductsResponse -> String # showList :: [GetProductsResponse] -> ShowS #
NFData GetProductsResponse Source #
Instance details Defined in Amazonka.Pricing.GetProducts Methods rnf :: GetProductsResponse -> () #
Eq GetProductsResponse Source #
Instance details Defined in Amazonka.Pricing.GetProducts Methods (==) :: GetProductsResponse -> GetProductsResponse -> Bool # (/=) :: GetProductsResponse -> GetProductsResponse -> Bool #
type Rep GetProductsResponse Source #
Instance details Defined in Amazonka.Pricing.GetProducts type Rep GetProductsResponse = D1 ('MetaData "GetProductsResponse" "Amazonka.Pricing.GetProducts" "amazonka-pricing-2.0-2qV8x2ufXzQ7VdGqV3aokJ" 'False) (C1 ('MetaCons "GetProductsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "formatVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "priceList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetProductsResponse Source #

Arguments

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

Create a value of GetProductsResponse 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:

GetProducts, getProductsResponse_formatVersion - The format version of the response. For example, aws_v1.

GetProducts, getProductsResponse_nextToken - The pagination token that indicates the next set of results to retrieve.

$sel:priceList:GetProductsResponse', getProductsResponse_priceList - The list of products that match your filters. The list contains both the product metadata and the price information.

$sel:httpStatus:GetProductsResponse', getProductsResponse_httpStatus - The response's http status code.

Response Lenses

getProductsResponse_formatVersion :: Lens' GetProductsResponse (Maybe Text) Source #

The format version of the response. For example, aws_v1.

getProductsResponse_nextToken :: Lens' GetProductsResponse (Maybe Text) Source #

The pagination token that indicates the next set of results to retrieve.

getProductsResponse_priceList :: Lens' GetProductsResponse (Maybe [Text]) Source #

The list of products that match your filters. The list contains both the product metadata and the price information.

getProductsResponse_httpStatus :: Lens' GetProductsResponse Int Source #

The response's http status code.