Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Returns a list of all products that match the filter criteria.
This operation returns paginated results.
- getProducts :: GetProducts
- data GetProducts
- gpFilters :: Lens' GetProducts [Filter]
- gpFormatVersion :: Lens' GetProducts (Maybe Text)
- gpNextToken :: Lens' GetProducts (Maybe Text)
- gpServiceCode :: Lens' GetProducts (Maybe Text)
- gpMaxResults :: Lens' GetProducts (Maybe Natural)
- getProductsResponse :: Int -> GetProductsResponse
- data GetProductsResponse
- gprsFormatVersion :: Lens' GetProductsResponse (Maybe Text)
- gprsNextToken :: Lens' GetProductsResponse (Maybe Text)
- gprsPriceList :: Lens' GetProductsResponse [Text]
- gprsResponseStatus :: Lens' GetProductsResponse Int
Creating a Request
getProducts :: GetProducts Source #
Creates a value of GetProducts
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gpFilters
- The list of filters that limit the returned products. only products that match all filters are returned.gpFormatVersion
- The format version that you want the response to be in. Valid values are:aws_v1
gpNextToken
- The pagination token that indicates the next set of results that you want to retrieve.gpServiceCode
- The code for the service whose products you want to retrieve.gpMaxResults
- The maximum number of results to return in the response.
data GetProducts Source #
See: getProducts
smart constructor.
Request Lenses
gpFilters :: Lens' GetProducts [Filter] Source #
The list of filters that limit the returned products. only products that match all filters are returned.
gpFormatVersion :: Lens' GetProducts (Maybe Text) Source #
The format version that you want the response to be in. Valid values are: aws_v1
gpNextToken :: Lens' GetProducts (Maybe Text) Source #
The pagination token that indicates the next set of results that you want to retrieve.
gpServiceCode :: Lens' GetProducts (Maybe Text) Source #
The code for the service whose products you want to retrieve.
gpMaxResults :: Lens' GetProducts (Maybe Natural) Source #
The maximum number of results to return in the response.
Destructuring the Response
Creates a value of GetProductsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gprsFormatVersion
- The format version of the response. For example, aws_v1.gprsNextToken
- The pagination token that indicates the next set of results to retrieve.gprsPriceList
- The list of products that match your filters. The list contains both the product metadata and the price information.gprsResponseStatus
- -- | The response status code.
data GetProductsResponse Source #
See: getProductsResponse
smart constructor.
Response Lenses
gprsFormatVersion :: Lens' GetProductsResponse (Maybe Text) Source #
The format version of the response. For example, aws_v1.
gprsNextToken :: Lens' GetProductsResponse (Maybe Text) Source #
The pagination token that indicates the next set of results to retrieve.
gprsPriceList :: Lens' GetProductsResponse [Text] Source #
The list of products that match your filters. The list contains both the product metadata and the price information.
gprsResponseStatus :: Lens' GetProductsResponse Int Source #
- - | The response status code.