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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets information about the provisioned products that meet the specified criteria.

To ensure a complete list of provisioned products and remove duplicate products, use sort-by createdTime.

Here is a CLI example:

aws servicecatalog search-provisioned-products --sort-by createdTime

Synopsis

Creating a Request

data SearchProvisionedProducts Source #

See: newSearchProvisionedProducts smart constructor.

Constructors

SearchProvisionedProducts'

Fields

acceptLanguage :: Maybe Text
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
accessLevelFilter :: Maybe AccessLevelFilter
The access level to use to obtain results. The default is User.
filters :: Maybe (HashMap ProvisionedProductViewFilterBy [Text])
The search filters.
When the key is SearchQuery, the searchable fields are arn, createdTime, id, lastRecordId, idempotencyToken, name, physicalId, productId, provisioningArtifact, type, status, tags, userArn, userArnSession, lastProvisioningRecordId, lastSuccessfulProvisioningRecordId, productName, and provisioningArtifactName.
Example: "SearchQuery":["status:AVAILABLE"]
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 Text
The sort field. If no value is specified, the results are not sorted. The valid values are arn, id, name, and lastRecordId.
sortOrder :: Maybe SortOrder
The sort order. If no value is specified, the results are not sorted.

Instances

Instances details

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

newSearchProvisionedProducts :: SearchProvisionedProducts Source #

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

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

$sel:accessLevelFilter:SearchProvisionedProducts', searchProvisionedProducts_accessLevelFilter - The access level to use to obtain results. The default is User.

$sel:filters:SearchProvisionedProducts', searchProvisionedProducts_filters - The search filters.

When the key is SearchQuery, the searchable fields are arn, createdTime, id, lastRecordId, idempotencyToken, name, physicalId, productId, provisioningArtifact, type, status, tags, userArn, userArnSession, lastProvisioningRecordId, lastSuccessfulProvisioningRecordId, productName, and provisioningArtifactName.

Example: "SearchQuery":["status:AVAILABLE"]

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

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

$sel:sortBy:SearchProvisionedProducts', searchProvisionedProducts_sortBy - The sort field. If no value is specified, the results are not sorted. The valid values are arn, id, name, and lastRecordId.

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

Request Lenses

searchProvisionedProducts_acceptLanguage :: Lens' SearchProvisionedProducts (Maybe Text) Source #

The language code.

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

searchProvisionedProducts_accessLevelFilter :: Lens' SearchProvisionedProducts (Maybe AccessLevelFilter) Source #

The access level to use to obtain results. The default is User.

searchProvisionedProducts_filters :: Lens' SearchProvisionedProducts (Maybe (HashMap ProvisionedProductViewFilterBy [Text])) Source #

The search filters.

When the key is SearchQuery, the searchable fields are arn, createdTime, id, lastRecordId, idempotencyToken, name, physicalId, productId, provisioningArtifact, type, status, tags, userArn, userArnSession, lastProvisioningRecordId, lastSuccessfulProvisioningRecordId, productName, and provisioningArtifactName.

Example: "SearchQuery":["status:AVAILABLE"]

searchProvisionedProducts_pageSize :: Lens' SearchProvisionedProducts (Maybe Natural) Source #

The maximum number of items to return with this call.

searchProvisionedProducts_pageToken :: Lens' SearchProvisionedProducts (Maybe Text) Source #

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

searchProvisionedProducts_sortBy :: Lens' SearchProvisionedProducts (Maybe Text) Source #

The sort field. If no value is specified, the results are not sorted. The valid values are arn, id, name, and lastRecordId.

searchProvisionedProducts_sortOrder :: Lens' SearchProvisionedProducts (Maybe SortOrder) Source #

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

Destructuring the Response

data SearchProvisionedProductsResponse Source #

See: newSearchProvisionedProductsResponse smart constructor.

Constructors

SearchProvisionedProductsResponse'
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. provisionedProducts :: Maybe [ProvisionedProductAttribute] Information about the provisioned products. totalResultsCount :: Maybe Int The number of provisioned products found. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newSearchProvisionedProductsResponse Source #

Arguments

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

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

$sel:provisionedProducts:SearchProvisionedProductsResponse', searchProvisionedProductsResponse_provisionedProducts - Information about the provisioned products.

$sel:totalResultsCount:SearchProvisionedProductsResponse', searchProvisionedProductsResponse_totalResultsCount - The number of provisioned products found.

$sel:httpStatus:SearchProvisionedProductsResponse', searchProvisionedProductsResponse_httpStatus - The response's http status code.

Response Lenses

searchProvisionedProductsResponse_nextPageToken :: Lens' SearchProvisionedProductsResponse (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.

searchProvisionedProductsResponse_provisionedProducts :: Lens' SearchProvisionedProductsResponse (Maybe [ProvisionedProductAttribute]) Source #

Information about the provisioned products.

searchProvisionedProductsResponse_totalResultsCount :: Lens' SearchProvisionedProductsResponse (Maybe Int) Source #

The number of provisioned products found.

searchProvisionedProductsResponse_httpStatus :: Lens' SearchProvisionedProductsResponse Int Source #

The response's http status code.