Network.AWS.ServiceCatalog.SearchProducts

Returns a paginated list all of the Products objects to which the caller has access.

The output of this operation can be used as input for other operations, such as DescribeProductView.

Creating a Request

searchProducts :: SearchProducts

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
• spSortOrder
• spAcceptLanguage
• spPageToken
• spPageSize
• spSortBy

data SearchProducts

See: searchProducts smart constructor.

Instances

Eq SearchProducts

Methods

(==) :: SearchProducts -> SearchProducts -> Bool

(/=) :: SearchProducts -> SearchProducts -> Bool

Data SearchProducts

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SearchProducts -> c SearchProducts

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SearchProducts

toConstr :: SearchProducts -> Constr

dataTypeOf :: SearchProducts -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SearchProducts)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SearchProducts)

gmapT :: (forall b. Data b => b -> b) -> SearchProducts -> SearchProducts

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SearchProducts -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SearchProducts -> r

gmapQ :: (forall d. Data d => d -> u) -> SearchProducts -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SearchProducts -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SearchProducts -> m SearchProducts

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SearchProducts -> m SearchProducts

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SearchProducts -> m SearchProducts

Read SearchProducts

Methods

readsPrec :: Int -> ReadS SearchProducts

readList :: ReadS [SearchProducts]

readPrec :: ReadPrec SearchProducts

readListPrec :: ReadPrec [SearchProducts]

Show SearchProducts

Methods

showsPrec :: Int -> SearchProducts -> ShowS

show :: SearchProducts -> String

showList :: [SearchProducts] -> ShowS

Generic SearchProducts

Associated Types

type Rep SearchProducts :: * -> *

Methods

from :: SearchProducts -> Rep SearchProducts x

to :: Rep SearchProducts x -> SearchProducts

Hashable SearchProducts

Methods

hashWithSalt :: Int -> SearchProducts -> Int

hash :: SearchProducts -> Int

NFData SearchProducts

Methods

rnf :: SearchProducts -> ()

AWSRequest SearchProducts

Associated Types

type Rs SearchProducts :: *

Methods

request :: SearchProducts -> Request SearchProducts

response :: MonadResource m => Logger -> Service -> Proxy * SearchProducts -> ClientResponse -> m (Response SearchProducts)

ToPath SearchProducts

Methods

toPath :: SearchProducts -> ByteString

ToHeaders SearchProducts

Methods

toHeaders :: SearchProducts -> [Header]

ToQuery SearchProducts

Methods

toQuery :: SearchProducts -> QueryString

ToJSON SearchProducts

Methods

toJSON :: SearchProducts -> Value

toEncoding :: SearchProducts -> Encoding

type Rep SearchProducts

type Rep SearchProducts = D1 (MetaData "SearchProducts" "Network.AWS.ServiceCatalog.SearchProducts" "amazonka-servicecatalog-1.4.4-PICdIZm2P59GYKQo9iwNE" False) (C1 (MetaCons "SearchProducts'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_spFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map ProductViewFilterBy [Text])))) ((:*:) (S1 (MetaSel (Just Symbol "_spSortOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe SortOrder))) (S1 (MetaSel (Just Symbol "_spAcceptLanguage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_spPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_spPageSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_spSortBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ProductViewSortBy)))))))

type Rs SearchProducts

type Rs SearchProducts = SearchProductsResponse

Request Lenses

spFilters :: Lens' SearchProducts (HashMap ProductViewFilterBy [Text])

(Optional) 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 calling user has access.

spSortOrder :: Lens' SearchProducts (Maybe SortOrder)

(Optional) The sort order specifier. If no value is specified, results are not sorted.

spAcceptLanguage :: Lens' SearchProducts (Maybe Text)

Optional language code. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

spPageToken :: Lens' SearchProducts (Maybe Text)

The page token of the first page retrieve. If null, this retrieves the first page of size PageSize.

spPageSize :: Lens' SearchProducts (Maybe Natural)

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.

spSortBy :: Lens' SearchProducts (Maybe ProductViewSortBy)

(Optional) The sort field specifier. If no value is specified, results are not sorted.

Destructuring the Response

searchProductsResponse

Arguments

:: Int

sprsResponseStatus

-> SearchProductsResponse

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
• sprsProductViewAggregations
• sprsProductViewSummaries
• sprsResponseStatus

data SearchProductsResponse

See: searchProductsResponse smart constructor.

Instances

Eq SearchProductsResponse

Methods

(==) :: SearchProductsResponse -> SearchProductsResponse -> Bool

(/=) :: SearchProductsResponse -> SearchProductsResponse -> Bool

Data SearchProductsResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SearchProductsResponse -> c SearchProductsResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SearchProductsResponse

toConstr :: SearchProductsResponse -> Constr

dataTypeOf :: SearchProductsResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SearchProductsResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SearchProductsResponse)

gmapT :: (forall b. Data b => b -> b) -> SearchProductsResponse -> SearchProductsResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SearchProductsResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SearchProductsResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> SearchProductsResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SearchProductsResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SearchProductsResponse -> m SearchProductsResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SearchProductsResponse -> m SearchProductsResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SearchProductsResponse -> m SearchProductsResponse

Read SearchProductsResponse

Methods

readsPrec :: Int -> ReadS SearchProductsResponse

readList :: ReadS [SearchProductsResponse]

readPrec :: ReadPrec SearchProductsResponse

readListPrec :: ReadPrec [SearchProductsResponse]

Show SearchProductsResponse

Methods

showsPrec :: Int -> SearchProductsResponse -> ShowS

show :: SearchProductsResponse -> String

showList :: [SearchProductsResponse] -> ShowS

Generic SearchProductsResponse

Associated Types

type Rep SearchProductsResponse :: * -> *

Methods

from :: SearchProductsResponse -> Rep SearchProductsResponse x

to :: Rep SearchProductsResponse x -> SearchProductsResponse

NFData SearchProductsResponse

Methods

rnf :: SearchProductsResponse -> ()

type Rep SearchProductsResponse

type Rep SearchProductsResponse = D1 (MetaData "SearchProductsResponse" "Network.AWS.ServiceCatalog.SearchProducts" "amazonka-servicecatalog-1.4.4-PICdIZm2P59GYKQo9iwNE" False) (C1 (MetaCons "SearchProductsResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_sprsNextPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_sprsProductViewAggregations") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text [ProductViewAggregationValue]))))) ((:*:) (S1 (MetaSel (Just Symbol "_sprsProductViewSummaries") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [ProductViewSummary]))) (S1 (MetaSel (Just Symbol "_sprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

sprsNextPageToken :: Lens' SearchProductsResponse (Maybe Text)

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.

sprsProductViewAggregations :: Lens' SearchProductsResponse (HashMap Text [ProductViewAggregationValue])

A list of the product view aggregation value objects.

sprsProductViewSummaries :: Lens' SearchProductsResponse [ProductViewSummary]

A list of the product view summary objects.

sprsResponseStatus :: Lens' SearchProductsResponse Int

The response status code.