Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListProvisionedProductPlans

Lists the plans for the specified provisioned product or all plans to which the user has access.

Request Syntax


{
   "AcceptLanguage": "string",
   "AccessLevelFilter": { 
      "Key": "string",
      "Value": "string"
   },
   "PageSize": number,
   "PageToken": "string",
   "ProvisionProductId": "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 User.

Type: AccessLevelFilter object

Required: No

PageSize

The maximum number of items to return with this call.

Type: Integer

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

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

ProvisionProductId

The product identifier.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[a-zA-Z0-9_\-]*

Required: No

Response Syntax


{
   "NextPageToken": "string",
   "ProvisionedProductPlans": [ 
      { 
         "PlanId": "string",
         "PlanName": "string",
         "PlanType": "string",
         "ProvisioningArtifactId": "string",
         "ProvisionProductId": "string",
         "ProvisionProductName": "string"
      }
   ]
}

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

Length Constraints: Maximum length of 2024.

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

ProvisionedProductPlans

Information about the plans.

Type: Array of ProvisionedProductPlanSummary objects

Errors

InvalidParametersException

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

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 400