Copyright | (c) 2013-2017 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 |
Retrieves summary and status information about all products created within the caller's account. If a portfolio ID is provided, this operation retrieves information for only those products that are associated with the specified portfolio.
- searchProductsAsAdmin :: SearchProductsAsAdmin
- data SearchProductsAsAdmin
- spaaPortfolioId :: Lens' SearchProductsAsAdmin (Maybe Text)
- spaaFilters :: Lens' SearchProductsAsAdmin (HashMap ProductViewFilterBy [Text])
- spaaSortOrder :: Lens' SearchProductsAsAdmin (Maybe SortOrder)
- spaaAcceptLanguage :: Lens' SearchProductsAsAdmin (Maybe Text)
- spaaPageToken :: Lens' SearchProductsAsAdmin (Maybe Text)
- spaaPageSize :: Lens' SearchProductsAsAdmin (Maybe Natural)
- spaaProductSource :: Lens' SearchProductsAsAdmin (Maybe ProductSource)
- spaaSortBy :: Lens' SearchProductsAsAdmin (Maybe ProductViewSortBy)
- searchProductsAsAdminResponse :: Int -> SearchProductsAsAdminResponse
- data SearchProductsAsAdminResponse
- spaarsNextPageToken :: Lens' SearchProductsAsAdminResponse (Maybe Text)
- spaarsProductViewDetails :: Lens' SearchProductsAsAdminResponse [ProductViewDetail]
- spaarsResponseStatus :: Lens' SearchProductsAsAdminResponse Int
Creating a Request
searchProductsAsAdmin :: SearchProductsAsAdmin Source #
Creates a value of SearchProductsAsAdmin
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
spaaPortfolioId
- The portfolio identifier.spaaFilters
- The list of filters with which to limit search results. If no search filters are specified, the output is all the products to which the administrator has access.spaaSortOrder
- The sort order specifier. If no value is specified, results are not sorted.spaaAcceptLanguage
- The language code. *en
- English (default) *jp
- Japanese *zh
- ChinesespaaPageToken
- The page token of the first page retrieved. If null, this retrieves the first page of sizePageSize
.spaaPageSize
- The maximum number of items to return in the results. If more results exist than fit in the specifiedPageSize
, the value ofNextPageToken
in the response is non-null.spaaProductSource
- Access level of the source of the product.spaaSortBy
- The sort field specifier. If no value is specified, results are not sorted.
data SearchProductsAsAdmin Source #
See: searchProductsAsAdmin
smart constructor.
Request Lenses
spaaPortfolioId :: Lens' SearchProductsAsAdmin (Maybe Text) Source #
The portfolio identifier.
spaaFilters :: Lens' SearchProductsAsAdmin (HashMap ProductViewFilterBy [Text]) Source #
The list of filters with which to limit search results. If no search filters are specified, the output is all the products to which the administrator has access.
spaaSortOrder :: Lens' SearchProductsAsAdmin (Maybe SortOrder) Source #
The sort order specifier. If no value is specified, results are not sorted.
spaaAcceptLanguage :: Lens' SearchProductsAsAdmin (Maybe Text) Source #
The language code. * en
- English (default) * jp
- Japanese * zh
- Chinese
spaaPageToken :: Lens' SearchProductsAsAdmin (Maybe Text) Source #
The page token of the first page retrieved. If null, this retrieves the first page of size PageSize
.
spaaPageSize :: Lens' SearchProductsAsAdmin (Maybe Natural) Source #
The maximum number of items to return in the results. If more results exist than fit in the specified PageSize
, the value of NextPageToken
in the response is non-null.
spaaProductSource :: Lens' SearchProductsAsAdmin (Maybe ProductSource) Source #
Access level of the source of the product.
spaaSortBy :: Lens' SearchProductsAsAdmin (Maybe ProductViewSortBy) Source #
The sort field specifier. If no value is specified, results are not sorted.
Destructuring the Response
searchProductsAsAdminResponse Source #
Creates a value of SearchProductsAsAdminResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
spaarsNextPageToken
- The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.spaarsProductViewDetails
- List of detailed product view information objects.spaarsResponseStatus
- -- | The response status code.
data SearchProductsAsAdminResponse Source #
See: searchProductsAsAdminResponse
smart constructor.
Response Lenses
spaarsNextPageToken :: Lens' SearchProductsAsAdminResponse (Maybe Text) Source #
The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
spaarsProductViewDetails :: Lens' SearchProductsAsAdminResponse [ProductViewDetail] Source #
List of detailed product view information objects.
spaarsResponseStatus :: Lens' SearchProductsAsAdminResponse Int Source #
- - | The response status code.