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.ServiceCatalog.SearchProducts

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets information about the products to which the caller has access.

Synopsis

data SearchProducts = SearchProducts' {
- acceptLanguage :: Maybe Text
- filters :: Maybe (HashMap ProductViewFilterBy [Text])
- pageSize :: Maybe Natural
- pageToken :: Maybe Text
- sortBy :: Maybe ProductViewSortBy
- sortOrder :: Maybe SortOrder
}
newSearchProducts :: SearchProducts
searchProducts_acceptLanguage :: Lens' SearchProducts (Maybe Text)
searchProducts_filters :: Lens' SearchProducts (Maybe (HashMap ProductViewFilterBy [Text]))
searchProducts_pageSize :: Lens' SearchProducts (Maybe Natural)
searchProducts_pageToken :: Lens' SearchProducts (Maybe Text)
searchProducts_sortBy :: Lens' SearchProducts (Maybe ProductViewSortBy)
searchProducts_sortOrder :: Lens' SearchProducts (Maybe SortOrder)
data SearchProductsResponse = SearchProductsResponse' {
- nextPageToken :: Maybe Text
- productViewAggregations :: Maybe (HashMap Text [ProductViewAggregationValue])
- productViewSummaries :: Maybe [ProductViewSummary]
- httpStatus :: Int
}
newSearchProductsResponse :: Int -> SearchProductsResponse
searchProductsResponse_nextPageToken :: Lens' SearchProductsResponse (Maybe Text)
searchProductsResponse_productViewAggregations :: Lens' SearchProductsResponse (Maybe (HashMap Text [ProductViewAggregationValue]))
searchProductsResponse_productViewSummaries :: Lens' SearchProductsResponse (Maybe [ProductViewSummary])
searchProductsResponse_httpStatus :: Lens' SearchProductsResponse Int

Creating a Request

data SearchProducts Source #

See: newSearchProducts smart constructor.

Constructors

SearchProducts'

Fields

acceptLanguage :: Maybe Text
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
filters :: Maybe (HashMap ProductViewFilterBy [Text])
The search filters. If no search filters are specified, the output includes all products to which the caller has access.
pageSize :: Maybe Natural
The maximum number of items to return with this call.
pageToken :: Maybe Text
The page token for the next set of results. To retrieve the first set of results, use null.
sortBy :: Maybe ProductViewSortBy
The sort field. If no value is specified, the results are not sorted.
sortOrder :: Maybe SortOrder
The sort order. If no value is specified, the results are not sorted.

Instances

Instances details

ToJSON SearchProducts Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProducts Methods toJSON :: SearchProducts -> Value # toEncoding :: SearchProducts -> Encoding # toJSONList :: [SearchProducts] -> Value # toEncodingList :: [SearchProducts] -> Encoding #
ToHeaders SearchProducts Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProducts Methods toHeaders :: SearchProducts -> [Header] #
ToPath SearchProducts Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProducts Methods toPath :: SearchProducts -> ByteString #
ToQuery SearchProducts Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProducts Methods toQuery :: SearchProducts -> QueryString #
AWSRequest SearchProducts Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProducts Associated Types type AWSResponse SearchProducts # Methods request :: (Service -> Service) -> SearchProducts -> Request SearchProducts # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SearchProducts -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SearchProducts))) #
Generic SearchProducts Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProducts Associated Types type Rep SearchProducts :: Type -> Type # Methods from :: SearchProducts -> Rep SearchProducts x # to :: Rep SearchProducts x -> SearchProducts #
Read SearchProducts Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProducts Methods readsPrec :: Int -> ReadS SearchProducts # readList :: ReadS [SearchProducts] # readPrec :: ReadPrec SearchProducts # readListPrec :: ReadPrec [SearchProducts] #
Show SearchProducts Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProducts Methods showsPrec :: Int -> SearchProducts -> ShowS # show :: SearchProducts -> String # showList :: [SearchProducts] -> ShowS #
NFData SearchProducts Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProducts Methods rnf :: SearchProducts -> () #
Eq SearchProducts Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProducts Methods (==) :: SearchProducts -> SearchProducts -> Bool # (/=) :: SearchProducts -> SearchProducts -> Bool #
Hashable SearchProducts Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProducts Methods hashWithSalt :: Int -> SearchProducts -> Int # hash :: SearchProducts -> Int #
type AWSResponse SearchProducts Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProducts type AWSResponse SearchProducts = SearchProductsResponse
type Rep SearchProducts Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProducts type Rep SearchProducts = D1 ('MetaData "SearchProducts" "Amazonka.ServiceCatalog.SearchProducts" "amazonka-servicecatalog-2.0-HQc7wwDA1XY4nlo6issXoI" 'False) (C1 ('MetaCons "SearchProducts'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "acceptLanguage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap ProductViewFilterBy [Text]))) :: S1 ('MetaSel ('Just "pageSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :: (S1 ('MetaSel ('Just "pageToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProductViewSortBy)) :*: S1 ('MetaSel ('Just "sortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortOrder))))))

newSearchProducts :: SearchProducts Source #

Create a value of SearchProducts 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:acceptLanguage:SearchProducts', searchProducts_acceptLanguage - The language code.

en - English (default)
jp - Japanese
zh - Chinese

$sel:filters:SearchProducts', searchProducts_filters - The search filters. If no search filters are specified, the output includes all products to which the caller has access.

$sel:pageSize:SearchProducts', searchProducts_pageSize - The maximum number of items to return with this call.

$sel:pageToken:SearchProducts', searchProducts_pageToken - The page token for the next set of results. To retrieve the first set of results, use null.

$sel:sortBy:SearchProducts', searchProducts_sortBy - The sort field. If no value is specified, the results are not sorted.

$sel:sortOrder:SearchProducts', searchProducts_sortOrder - The sort order. If no value is specified, the results are not sorted.

Request Lenses

searchProducts_acceptLanguage :: Lens' SearchProducts (Maybe Text) Source #

The language code.

en - English (default)
jp - Japanese
zh - Chinese

searchProducts_filters :: Lens' SearchProducts (Maybe (HashMap ProductViewFilterBy [Text])) Source #

The search filters. If no search filters are specified, the output includes all products to which the caller has access.

searchProducts_pageSize :: Lens' SearchProducts (Maybe Natural) Source #

The maximum number of items to return with this call.

searchProducts_pageToken :: Lens' SearchProducts (Maybe Text) Source #

The page token for the next set of results. To retrieve the first set of results, use null.

searchProducts_sortBy :: Lens' SearchProducts (Maybe ProductViewSortBy) Source #

The sort field. If no value is specified, the results are not sorted.

searchProducts_sortOrder :: Lens' SearchProducts (Maybe SortOrder) Source #

The sort order. If no value is specified, the results are not sorted.

Destructuring the Response

data SearchProductsResponse Source #

See: newSearchProductsResponse smart constructor.

Constructors

SearchProductsResponse'
Fields nextPageToken :: Maybe Text The page token to use to retrieve the next set of results. If there are no additional results, this value is null. productViewAggregations :: Maybe (HashMap Text [ProductViewAggregationValue]) The product view aggregations. productViewSummaries :: Maybe [ProductViewSummary] Information about the product views. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic SearchProductsResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProducts Associated Types type Rep SearchProductsResponse :: Type -> Type # Methods from :: SearchProductsResponse -> Rep SearchProductsResponse x # to :: Rep SearchProductsResponse x -> SearchProductsResponse #
Read SearchProductsResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProducts Methods readsPrec :: Int -> ReadS SearchProductsResponse # readList :: ReadS [SearchProductsResponse] # readPrec :: ReadPrec SearchProductsResponse # readListPrec :: ReadPrec [SearchProductsResponse] #
Show SearchProductsResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProducts Methods showsPrec :: Int -> SearchProductsResponse -> ShowS # show :: SearchProductsResponse -> String # showList :: [SearchProductsResponse] -> ShowS #
NFData SearchProductsResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProducts Methods rnf :: SearchProductsResponse -> () #
Eq SearchProductsResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProducts Methods (==) :: SearchProductsResponse -> SearchProductsResponse -> Bool # (/=) :: SearchProductsResponse -> SearchProductsResponse -> Bool #
type Rep SearchProductsResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProducts type Rep SearchProductsResponse = D1 ('MetaData "SearchProductsResponse" "Amazonka.ServiceCatalog.SearchProducts" "amazonka-servicecatalog-2.0-HQc7wwDA1XY4nlo6issXoI" 'False) (C1 ('MetaCons "SearchProductsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextPageToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "productViewAggregations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [ProductViewAggregationValue])))) :: (S1 ('MetaSel ('Just "productViewSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ProductViewSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newSearchProductsResponse Source #

Arguments

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

Create a value of SearchProductsResponse 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:nextPageToken:SearchProductsResponse', searchProductsResponse_nextPageToken - The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

$sel:productViewAggregations:SearchProductsResponse', searchProductsResponse_productViewAggregations - The product view aggregations.

$sel:productViewSummaries:SearchProductsResponse', searchProductsResponse_productViewSummaries - Information about the product views.

$sel:httpStatus:SearchProductsResponse', searchProductsResponse_httpStatus - The response's http status code.

Response Lenses

searchProductsResponse_nextPageToken :: 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.

searchProductsResponse_productViewAggregations :: Lens' SearchProductsResponse (Maybe (HashMap Text [ProductViewAggregationValue])) Source #

The product view aggregations.

searchProductsResponse_productViewSummaries :: Lens' SearchProductsResponse (Maybe [ProductViewSummary]) Source #

Information about the product views.

searchProductsResponse_httpStatus :: Lens' SearchProductsResponse Int Source #

The response's http status code.