Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
Gets information about the provisioned products that meet the specified criteria.
Synopsis
- searchProvisionedProducts :: SearchProvisionedProducts
- data SearchProvisionedProducts
- sppFilters :: Lens' SearchProvisionedProducts (HashMap ProvisionedProductViewFilterBy [Text])
- sppSortOrder :: Lens' SearchProvisionedProducts (Maybe SortOrder)
- sppAcceptLanguage :: Lens' SearchProvisionedProducts (Maybe Text)
- sppAccessLevelFilter :: Lens' SearchProvisionedProducts (Maybe AccessLevelFilter)
- sppPageToken :: Lens' SearchProvisionedProducts (Maybe Text)
- sppPageSize :: Lens' SearchProvisionedProducts (Maybe Natural)
- sppSortBy :: Lens' SearchProvisionedProducts (Maybe Text)
- searchProvisionedProductsResponse :: Int -> SearchProvisionedProductsResponse
- data SearchProvisionedProductsResponse
- srsNextPageToken :: Lens' SearchProvisionedProductsResponse (Maybe Text)
- srsProvisionedProducts :: Lens' SearchProvisionedProductsResponse [ProvisionedProductAttribute]
- srsTotalResultsCount :: Lens' SearchProvisionedProductsResponse (Maybe Int)
- srsResponseStatus :: Lens' SearchProvisionedProductsResponse Int
Creating a Request
searchProvisionedProducts :: SearchProvisionedProducts Source #
Creates a value of SearchProvisionedProducts
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sppFilters
- The search filters. When the key isSearchQuery
, the searchable fields arearn
,createdTime
,id
,lastRecordId
,idempotencyToken
,name
,physicalId
,productId
,provisioningArtifact
,type
,status
,tags
,userArn
, anduserArnSession
. Example:SearchQuery:["status:AVAILABLE"]
sppSortOrder
- The sort order. If no value is specified, the results are not sorted.sppAcceptLanguage
- The language code. *en
- English (default) *jp
- Japanese *zh
- ChinesesppAccessLevelFilter
- The access level to use to obtain results. The default isUser
.sppPageToken
- The page token for the next set of results. To retrieve the first set of results, use null.sppPageSize
- The maximum number of items to return with this call.sppSortBy
- The sort field. If no value is specified, the results are not sorted. The valid values arearn
,id
,name
, andlastRecordId
.
data SearchProvisionedProducts Source #
See: searchProvisionedProducts
smart constructor.
Instances
Request Lenses
sppFilters :: Lens' SearchProvisionedProducts (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
, and userArnSession
. Example: SearchQuery:["status:AVAILABLE"]
sppSortOrder :: Lens' SearchProvisionedProducts (Maybe SortOrder) Source #
The sort order. If no value is specified, the results are not sorted.
sppAcceptLanguage :: Lens' SearchProvisionedProducts (Maybe Text) Source #
The language code. * en
- English (default) * jp
- Japanese * zh
- Chinese
sppAccessLevelFilter :: Lens' SearchProvisionedProducts (Maybe AccessLevelFilter) Source #
The access level to use to obtain results. The default is User
.
sppPageToken :: Lens' SearchProvisionedProducts (Maybe Text) Source #
The page token for the next set of results. To retrieve the first set of results, use null.
sppPageSize :: Lens' SearchProvisionedProducts (Maybe Natural) Source #
The maximum number of items to return with this call.
sppSortBy :: 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
searchProvisionedProductsResponse Source #
Creates a value of SearchProvisionedProductsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
srsNextPageToken
- The page token to use to retrieve the next set of results. If there are no additional results, this value is null.srsProvisionedProducts
- Information about the provisioned products.srsTotalResultsCount
- The number of provisioned products found.srsResponseStatus
- -- | The response status code.
data SearchProvisionedProductsResponse Source #
See: searchProvisionedProductsResponse
smart constructor.
Instances
Response Lenses
srsNextPageToken :: 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.
srsProvisionedProducts :: Lens' SearchProvisionedProductsResponse [ProvisionedProductAttribute] Source #
Information about the provisioned products.
srsTotalResultsCount :: Lens' SearchProvisionedProductsResponse (Maybe Int) Source #
The number of provisioned products found.
srsResponseStatus :: Lens' SearchProvisionedProductsResponse Int Source #
- - | The response status code.