Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

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.

jp - Japanese
zh - Chinese

Type: String

Length Constraints: Maximum length of 100.

Required: No

AccessLevelFilter

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

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, provisioningArtifactId, type, status, tags, userArn, userArnSession, lastProvisioningRecordId, lastSuccessfulProvisioningRecordId, productName, and provisioningArtifactName.

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

Length Constraints: Maximum length of 2024.

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",
         "LastProvisioningRecordId": "string",
         "LastRecordId": "string",
         "LastSuccessfulProvisioningRecordId": "string",
         "LaunchRoleArn": "string",
         "Name": "string",
         "PhysicalId": "string",
         "ProductId": "string",
         "ProductName": "string",
         "ProvisioningArtifactId": "string",
         "ProvisioningArtifactName": "string",
         "Status": "string",
         "StatusMessage": "string",
         "Tags": [ 
            { 
               "Key": "string",
               "Value": "string"
            }
         ],
         "Type": "string",
         "UserArn": "string",
         "UserArnSession": "string"
      }
   ],
   "TotalResultsCount": number
}