Copyright	(c) 2013-2021 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

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.

Synopsis

Creating a Request

data SearchProvisionedProducts Source #

See: newSearchProvisionedProducts smart constructor.

Constructors

SearchProvisionedProducts'

Fields

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"]
sortOrder :: Maybe SortOrder
The sort order. If no value is specified, the results are not sorted.
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.
pageToken :: Maybe Text
The page token for the next set of results. To retrieve the first set of results, use null.
pageSize :: Maybe Natural
The maximum number of items to return with this call.
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.

Instances

Instances details

Eq SearchProvisionedProducts Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProvisionedProducts Methods (==) :: SearchProvisionedProducts -> SearchProvisionedProducts -> Bool # (/=) :: SearchProvisionedProducts -> SearchProvisionedProducts -> Bool #
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 #
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 #
NFData SearchProvisionedProducts Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProvisionedProducts Methods rnf :: SearchProvisionedProducts -> () #
Hashable SearchProvisionedProducts Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProvisionedProducts Methods hashWithSalt :: Int -> SearchProvisionedProducts -> Int # hash :: SearchProvisionedProducts -> Int #
ToJSON SearchProvisionedProducts Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProvisionedProducts Methods toJSON :: SearchProvisionedProducts -> Value # toEncoding :: SearchProvisionedProducts -> Encoding # toJSONList :: [SearchProvisionedProducts] -> Value # toEncodingList :: [SearchProvisionedProducts] -> Encoding #
AWSRequest SearchProvisionedProducts Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProvisionedProducts Associated Types type AWSResponse SearchProvisionedProducts # Methods request :: SearchProvisionedProducts -> Request SearchProvisionedProducts # response :: MonadResource m => Logger -> Service -> Proxy SearchProvisionedProducts -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SearchProvisionedProducts))) #
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 #
type Rep SearchProvisionedProducts Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProvisionedProducts type Rep SearchProvisionedProducts = D1 ('MetaData "SearchProvisionedProducts" "Amazonka.ServiceCatalog.SearchProvisionedProducts" "libZSservicesZSamazonka-servicecatalogZSamazonka-servicecatalog" 'False) (C1 ('MetaCons "SearchProvisionedProducts'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap ProvisionedProductViewFilterBy [Text]))) :: (S1 ('MetaSel ('Just "sortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortOrder)) :: S1 ('MetaSel ('Just "acceptLanguage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "accessLevelFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AccessLevelFilter)) :: S1 ('MetaSel ('Just "pageToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "pageSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))
type AWSResponse SearchProvisionedProducts Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProvisionedProducts type AWSResponse SearchProvisionedProducts = SearchProvisionedProductsResponse

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: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:sortOrder:SearchProvisionedProducts', searchProvisionedProducts_sortOrder - The sort order. If no value is specified, the results are not sorted.

$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:pageToken:SearchProvisionedProducts', searchProvisionedProducts_pageToken - The page token for the next set of results. To retrieve the first set of results, use null.

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

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

Request Lenses

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_sortOrder :: Lens' SearchProvisionedProducts (Maybe SortOrder) Source #

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

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_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_pageSize :: Lens' SearchProvisionedProducts (Maybe Natural) Source #

The maximum number of items to return with this call.

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.

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

Eq SearchProvisionedProductsResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProvisionedProducts Methods (==) :: SearchProvisionedProductsResponse -> SearchProvisionedProductsResponse -> Bool # (/=) :: SearchProvisionedProductsResponse -> SearchProvisionedProductsResponse -> Bool #
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 #
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 #
NFData SearchProvisionedProductsResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProvisionedProducts Methods rnf :: SearchProvisionedProductsResponse -> () #
type Rep SearchProvisionedProductsResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.SearchProvisionedProducts type Rep SearchProvisionedProductsResponse = D1 ('MetaData "SearchProvisionedProductsResponse" "Amazonka.ServiceCatalog.SearchProvisionedProducts" "libZSservicesZSamazonka-servicecatalogZSamazonka-servicecatalog" '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.