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.SearchProductsAsAdmin

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets information about the products for the specified portfolio or all products.

This operation returns paginated results.

Synopsis

data SearchProductsAsAdmin = SearchProductsAsAdmin' {
- acceptLanguage :: Maybe Text
- filters :: Maybe (HashMap ProductViewFilterBy [Text])
- pageSize :: Maybe Natural
- pageToken :: Maybe Text
- portfolioId :: Maybe Text
- productSource :: Maybe ProductSource
- sortBy :: Maybe ProductViewSortBy
- sortOrder :: Maybe SortOrder
}
newSearchProductsAsAdmin :: SearchProductsAsAdmin
searchProductsAsAdmin_acceptLanguage :: Lens' SearchProductsAsAdmin (Maybe Text)
searchProductsAsAdmin_filters :: Lens' SearchProductsAsAdmin (Maybe (HashMap ProductViewFilterBy [Text]))
searchProductsAsAdmin_pageSize :: Lens' SearchProductsAsAdmin (Maybe Natural)
searchProductsAsAdmin_pageToken :: Lens' SearchProductsAsAdmin (Maybe Text)
searchProductsAsAdmin_portfolioId :: Lens' SearchProductsAsAdmin (Maybe Text)
searchProductsAsAdmin_productSource :: Lens' SearchProductsAsAdmin (Maybe ProductSource)
searchProductsAsAdmin_sortBy :: Lens' SearchProductsAsAdmin (Maybe ProductViewSortBy)
searchProductsAsAdmin_sortOrder :: Lens' SearchProductsAsAdmin (Maybe SortOrder)
data SearchProductsAsAdminResponse = SearchProductsAsAdminResponse' {
- nextPageToken :: Maybe Text
- productViewDetails :: Maybe [ProductViewDetail]
- httpStatus :: Int
}
newSearchProductsAsAdminResponse :: Int -> SearchProductsAsAdminResponse
searchProductsAsAdminResponse_nextPageToken :: Lens' SearchProductsAsAdminResponse (Maybe Text)
searchProductsAsAdminResponse_productViewDetails :: Lens' SearchProductsAsAdminResponse (Maybe [ProductViewDetail])
searchProductsAsAdminResponse_httpStatus :: Lens' SearchProductsAsAdminResponse Int

Creating a Request

data SearchProductsAsAdmin Source #

See: newSearchProductsAsAdmin smart constructor.

Constructors

SearchProductsAsAdmin'

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 administrator 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.
portfolioId :: Maybe Text
The portfolio identifier.
productSource :: Maybe ProductSource
Access level of the source of the product.
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 SearchProductsAsAdmin Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProductsAsAdmin Methods toJSON :: SearchProductsAsAdmin -> Value # toEncoding :: SearchProductsAsAdmin -> Encoding # toJSONList :: [SearchProductsAsAdmin] -> Value # toEncodingList :: [SearchProductsAsAdmin] -> Encoding #
ToHeaders SearchProductsAsAdmin Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProductsAsAdmin Methods toHeaders :: SearchProductsAsAdmin -> [Header] #
ToPath SearchProductsAsAdmin Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProductsAsAdmin Methods toPath :: SearchProductsAsAdmin -> ByteString #
ToQuery SearchProductsAsAdmin Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProductsAsAdmin Methods toQuery :: SearchProductsAsAdmin -> QueryString #
AWSPager SearchProductsAsAdmin Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProductsAsAdmin Methods page :: SearchProductsAsAdmin -> AWSResponse SearchProductsAsAdmin -> Maybe SearchProductsAsAdmin #
AWSRequest SearchProductsAsAdmin Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProductsAsAdmin Associated Types type AWSResponse SearchProductsAsAdmin # Methods request :: (Service -> Service) -> SearchProductsAsAdmin -> Request SearchProductsAsAdmin # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SearchProductsAsAdmin -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SearchProductsAsAdmin))) #
Generic SearchProductsAsAdmin Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProductsAsAdmin Associated Types type Rep SearchProductsAsAdmin :: Type -> Type # Methods from :: SearchProductsAsAdmin -> Rep SearchProductsAsAdmin x # to :: Rep SearchProductsAsAdmin x -> SearchProductsAsAdmin #
Read SearchProductsAsAdmin Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProductsAsAdmin Methods readsPrec :: Int -> ReadS SearchProductsAsAdmin # readList :: ReadS [SearchProductsAsAdmin] # readPrec :: ReadPrec SearchProductsAsAdmin # readListPrec :: ReadPrec [SearchProductsAsAdmin] #
Show SearchProductsAsAdmin Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProductsAsAdmin Methods showsPrec :: Int -> SearchProductsAsAdmin -> ShowS # show :: SearchProductsAsAdmin -> String # showList :: [SearchProductsAsAdmin] -> ShowS #
NFData SearchProductsAsAdmin Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProductsAsAdmin Methods rnf :: SearchProductsAsAdmin -> () #
Eq SearchProductsAsAdmin Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProductsAsAdmin Methods (==) :: SearchProductsAsAdmin -> SearchProductsAsAdmin -> Bool # (/=) :: SearchProductsAsAdmin -> SearchProductsAsAdmin -> Bool #
Hashable SearchProductsAsAdmin Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProductsAsAdmin Methods hashWithSalt :: Int -> SearchProductsAsAdmin -> Int # hash :: SearchProductsAsAdmin -> Int #
type AWSResponse SearchProductsAsAdmin Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProductsAsAdmin type AWSResponse SearchProductsAsAdmin = SearchProductsAsAdminResponse
type Rep SearchProductsAsAdmin Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProductsAsAdmin type Rep SearchProductsAsAdmin = D1 ('MetaData "SearchProductsAsAdmin" "Amazonka.ServiceCatalog.SearchProductsAsAdmin" "amazonka-servicecatalog-2.0-HQc7wwDA1XY4nlo6issXoI" 'False) (C1 ('MetaCons "SearchProductsAsAdmin'" '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 "portfolioId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "productSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProductSource))) :: (S1 ('MetaSel ('Just "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProductViewSortBy)) :*: S1 ('MetaSel ('Just "sortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortOrder))))))

newSearchProductsAsAdmin :: SearchProductsAsAdmin Source #

Create a value of SearchProductsAsAdmin 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:SearchProductsAsAdmin', searchProductsAsAdmin_acceptLanguage - The language code.

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

$sel:filters:SearchProductsAsAdmin', searchProductsAsAdmin_filters - The search filters. If no search filters are specified, the output includes all products to which the administrator has access.

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

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

SearchProductsAsAdmin, searchProductsAsAdmin_portfolioId - The portfolio identifier.

$sel:productSource:SearchProductsAsAdmin', searchProductsAsAdmin_productSource - Access level of the source of the product.

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

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

Request Lenses

searchProductsAsAdmin_acceptLanguage :: Lens' SearchProductsAsAdmin (Maybe Text) Source #

The language code.

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

searchProductsAsAdmin_filters :: Lens' SearchProductsAsAdmin (Maybe (HashMap ProductViewFilterBy [Text])) Source #

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

searchProductsAsAdmin_pageSize :: Lens' SearchProductsAsAdmin (Maybe Natural) Source #

The maximum number of items to return with this call.

searchProductsAsAdmin_pageToken :: Lens' SearchProductsAsAdmin (Maybe Text) Source #

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

searchProductsAsAdmin_portfolioId :: Lens' SearchProductsAsAdmin (Maybe Text) Source #

The portfolio identifier.

searchProductsAsAdmin_productSource :: Lens' SearchProductsAsAdmin (Maybe ProductSource) Source #

Access level of the source of the product.

searchProductsAsAdmin_sortBy :: Lens' SearchProductsAsAdmin (Maybe ProductViewSortBy) Source #

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

searchProductsAsAdmin_sortOrder :: Lens' SearchProductsAsAdmin (Maybe SortOrder) Source #

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

Destructuring the Response

data SearchProductsAsAdminResponse Source #

See: newSearchProductsAsAdminResponse smart constructor.

Constructors

SearchProductsAsAdminResponse'
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. productViewDetails :: Maybe [ProductViewDetail] Information about the product views. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newSearchProductsAsAdminResponse Source #

Arguments

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

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

$sel:productViewDetails:SearchProductsAsAdminResponse', searchProductsAsAdminResponse_productViewDetails - Information about the product views.

$sel:httpStatus:SearchProductsAsAdminResponse', searchProductsAsAdminResponse_httpStatus - The response's http status code.

Response Lenses

searchProductsAsAdminResponse_nextPageToken :: Lens' SearchProductsAsAdminResponse (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.

searchProductsAsAdminResponse_productViewDetails :: Lens' SearchProductsAsAdminResponse (Maybe [ProductViewDetail]) Source #

Information about the product views.

searchProductsAsAdminResponse_httpStatus :: Lens' SearchProductsAsAdminResponse Int Source #

The response's http status code.