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 |
Gets information about the products to which the caller has access.
Synopsis
- searchProducts :: SearchProducts
- data SearchProducts
- spFilters :: Lens' SearchProducts (HashMap ProductViewFilterBy [Text])
- spSortOrder :: Lens' SearchProducts (Maybe SortOrder)
- spAcceptLanguage :: Lens' SearchProducts (Maybe Text)
- spPageToken :: Lens' SearchProducts (Maybe Text)
- spPageSize :: Lens' SearchProducts (Maybe Natural)
- spSortBy :: Lens' SearchProducts (Maybe ProductViewSortBy)
- searchProductsResponse :: Int -> SearchProductsResponse
- data SearchProductsResponse
- sprsNextPageToken :: Lens' SearchProductsResponse (Maybe Text)
- sprsProductViewAggregations :: Lens' SearchProductsResponse (HashMap Text [ProductViewAggregationValue])
- sprsProductViewSummaries :: Lens' SearchProductsResponse [ProductViewSummary]
- sprsResponseStatus :: Lens' SearchProductsResponse Int
Creating a Request
searchProducts :: SearchProducts Source #
Creates a value of SearchProducts
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
spFilters
- The search filters. If no search filters are specified, the output includes all products to which the caller has access.spSortOrder
- The sort order. If no value is specified, the results are not sorted.spAcceptLanguage
- The language code. *en
- English (default) *jp
- Japanese *zh
- ChinesespPageToken
- The page token for the next set of results. To retrieve the first set of results, use null.spPageSize
- The maximum number of items to return with this call.spSortBy
- The sort field. If no value is specified, the results are not sorted.
data SearchProducts Source #
See: searchProducts
smart constructor.
Instances
Request Lenses
spFilters :: Lens' SearchProducts (HashMap ProductViewFilterBy [Text]) Source #
The search filters. If no search filters are specified, the output includes all products to which the caller has access.
spSortOrder :: Lens' SearchProducts (Maybe SortOrder) Source #
The sort order. If no value is specified, the results are not sorted.
spAcceptLanguage :: Lens' SearchProducts (Maybe Text) Source #
The language code. * en
- English (default) * jp
- Japanese * zh
- Chinese
spPageToken :: Lens' SearchProducts (Maybe Text) Source #
The page token for the next set of results. To retrieve the first set of results, use null.
spPageSize :: Lens' SearchProducts (Maybe Natural) Source #
The maximum number of items to return with this call.
spSortBy :: Lens' SearchProducts (Maybe ProductViewSortBy) Source #
The sort field. If no value is specified, the results are not sorted.
Destructuring the Response
searchProductsResponse Source #
Creates a value of SearchProductsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sprsNextPageToken
- The page token to use to retrieve the next set of results. If there are no additional results, this value is null.sprsProductViewAggregations
- The product view aggregations.sprsProductViewSummaries
- Information about the product views.sprsResponseStatus
- -- | The response status code.
data SearchProductsResponse Source #
See: searchProductsResponse
smart constructor.
Instances
Response Lenses
sprsNextPageToken :: Lens' SearchProductsResponse (Maybe Text) Source #
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
sprsProductViewAggregations :: Lens' SearchProductsResponse (HashMap Text [ProductViewAggregationValue]) Source #
The product view aggregations.
sprsProductViewSummaries :: Lens' SearchProductsResponse [ProductViewSummary] Source #
Information about the product views.
sprsResponseStatus :: Lens' SearchProductsResponse Int Source #
- - | The response status code.