Menu
AWS Service Catalog
Developer Guide

DescribeProvisioningParameters

Gets information about the configuration required to provision the specified product using the specified provisioning artifact.

If the output contains a TagOption key with an empty list of values, there is a TagOption conflict for that key. The end user cannot take action to fix the conflict, and launch is not blocked. In subsequent calls to ProvisionProduct, do not include conflicted TagOption keys as tags, or this causes the error "Parameter validation failed: Missing required parameter in Tags[N]:Value". Tag the provisioned product with the value sc-tagoption-conflict-portfolioId-productId.

Request Syntax

{
   "AcceptLanguage": "string",
   "PathId": "string",
   "ProductId": "string",
   "ProvisioningArtifactId": "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

PathId

The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.

Type: String

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

Required: No

ProductId

The product identifier.

Type: String

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

Required: Yes

ProvisioningArtifactId

The identifier of the provisioning artifact.

Type: String

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

Required: Yes

Response Syntax

{
   "ConstraintSummaries": [ 
      { 
         "Description": "string",
         "Type": "string"
      }
   ],
   "ProvisioningArtifactParameters": [ 
      { 
         "DefaultValue": "string",
         "Description": "string",
         "IsNoEcho": boolean,
         "ParameterConstraints": { 
            "AllowedValues": [ "string" ]
         },
         "ParameterKey": "string",
         "ParameterType": "string"
      }
   ],
   "TagOptions": [ 
      { 
         "Key": "string",
         "Values": [ "string" ]
      }
   ],
   "UsageInstructions": [ 
      { 
         "Type": "string",
         "Value": "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.

ConstraintSummaries

Information about the constraints used to provision the product.

Type: Array of ConstraintSummary objects

ProvisioningArtifactParameters

Information about the parameters used to provision the product.

Type: Array of ProvisioningArtifactParameter objects

TagOptions

Information about the TagOptions associated with the resource.

Type: Array of TagOptionSummary objects

UsageInstructions

Any additional metadata specifically related to the provisioning of the product. For example, see the Version field of the CloudFormation template.

Type: Array of UsageInstruction 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

See Also

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