Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

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",
   "PathName": "string",
   "ProductId": "string",
   "ProductName": "string",
   "ProvisioningArtifactId": "string",
   "ProvisioningArtifactName": "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

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. You must provide the name or ID, but not both.

Type: String

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

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

Required: No

PathName

The name of the path. You must provide the name or ID, but not both.

Type: String

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

Required: No

ProductId

The product identifier. You must provide the product name or ID, but not both.

Type: String

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

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

Required: No

ProductName

The name of the product. You must provide the name or ID, but not both.

Type: String

Length Constraints: Maximum length of 8191.

Required: No

ProvisioningArtifactId

The identifier of the provisioning artifact. You must provide the name or ID, but not both.

Type: String

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

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

Required: No

ProvisioningArtifactName

The name of the provisioning artifact. You must provide the name or ID, but not both.

Type: String

Length Constraints: Maximum length of 8192.

Required: No

Response Syntax


{
   "ConstraintSummaries": [ 
      { 
         "Description": "string",
         "Type": "string"
      }
   ],
   "ProvisioningArtifactOutputKeys": [ 
      { 
         "Description": "string",
         "Key": "string"
      }
   ],
   "ProvisioningArtifactOutputs": [ 
      { 
         "Description": "string",
         "Key": "string"
      }
   ],
   "ProvisioningArtifactParameters": [ 
      { 
         "DefaultValue": "string",
         "Description": "string",
         "IsNoEcho": boolean,
         "ParameterConstraints": { 
            "AllowedPattern": "string",
            "AllowedValues": [ "string" ],
            "ConstraintDescription": "string",
            "MaxLength": "string",
            "MaxValue": "string",
            "MinLength": "string",
            "MinValue": "string"
         },
         "ParameterKey": "string",
         "ParameterType": "string"
      }
   ],
   "ProvisioningArtifactPreferences": { 
      "StackSetAccounts": [ "string" ],
      "StackSetRegions": [ "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

ProvisioningArtifactOutputKeys

A list of the keys and descriptions of the outputs. These outputs can be referenced from a provisioned product launched from this provisioning artifact.

Type: Array of ProvisioningArtifactOutput objects

Array Members: Maximum number of 60 items.

ProvisioningArtifactOutputs

This parameter has been deprecated.

The output of the provisioning artifact.

Type: Array of ProvisioningArtifactOutput objects

Array Members: Maximum number of 60 items.

ProvisioningArtifactParameters

Information about the parameters used to provision the product.

Type: Array of ProvisioningArtifactParameter objects

ProvisioningArtifactPreferences

An object that contains information about preferences, such as Regions and accounts, for the provisioning artifact.

Type: ProvisioningArtifactPreferences object

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 AWS 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