Menu
AWS Service Catalog
Developer Guide

SearchProvisionedProducts

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

Request Syntax

{ "AcceptLanguage": "string", "AccessLevelFilter": { "Key": "string", "Value": "string" }, "Filters": { "string" : [ "string" ] }, "PageSize": number, "PageToken": "string", "SortBy": "string", "SortOrder": "string" }

Request Parameters

The request accepts the following data in JSON format.

AcceptLanguage

The language code.

  • en - English (default)

  • jp - Japanese

  • zh - Chinese

Type: String

Required: No

AccessLevelFilter

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

Type: AccessLevelFilter object

Required: No

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, and userArnSession.

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

Type: String to array of strings map

Valid Keys: SearchQuery

Required: No

PageSize

The maximum number of items to return with this call.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 100.

Required: No

PageToken

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

Type: String

Pattern: [\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*

Required: No

SortBy

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

Type: String

Required: No

SortOrder

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

Type: String

Valid Values: ASCENDING | DESCENDING

Required: No

Response Syntax

{ "NextPageToken": "string", "ProvisionedProducts": [ { "Arn": "string", "CreatedTime": number, "Id": "string", "IdempotencyToken": "string", "LastRecordId": "string", "Name": "string", "PhysicalId": "string", "ProductId": "string", "ProvisioningArtifactId": "string", "Status": "string", "StatusMessage": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "Type": "string", "UserArn": "string", "UserArnSession": "string" } ], "TotalResultsCount": number }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextPageToken

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

Type: String

Pattern: [\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*

ProvisionedProducts

Information about the provisioned products.

Type: Array of ProvisionedProductAttribute objects

TotalResultsCount

The number of provisioned products found.

Type: Integer

Errors

InvalidParametersException

One or more parameters provided to the operation are not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: