# CreateProvisionedProductPlan
<a name="API_CreateProvisionedProductPlan"></a>

Creates a plan.

A plan includes the list of resources to be created (when provisioning a new product) or modified (when updating a provisioned product) when the plan is executed.

You can create one plan for each provisioned product. To create a plan for an existing provisioned product, the product status must be AVAILABLE or TAINTED.

To view the resource changes in the change set, use [DescribeProvisionedProductPlan](API_DescribeProvisionedProductPlan.md). To create or modify the provisioned product, use [ExecuteProvisionedProductPlan](API_ExecuteProvisionedProductPlan.md).

## Request Syntax
<a name="API_CreateProvisionedProductPlan_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "IdempotencyToken": "string",
   "NotificationArns": [ "string" ],
   "PathId": "string",
   "PlanName": "string",
   "PlanType": "string",
   "ProductId": "string",
   "ProvisionedProductName": "string",
   "ProvisioningArtifactId": "string",
   "ProvisioningParameters": [ 
      { 
         "Key": "string",
         "UsePreviousValue": boolean,
         "Value": "string"
      }
   ],
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_CreateProvisionedProductPlan_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_CreateProvisionedProductPlan_RequestSyntax) **   <a name="servicecatalog-CreateProvisionedProductPlan-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [IdempotencyToken](#API_CreateProvisionedProductPlan_RequestSyntax) **   <a name="servicecatalog-CreateProvisionedProductPlan-request-IdempotencyToken"></a>
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: Yes

 ** [NotificationArns](#API_CreateProvisionedProductPlan_RequestSyntax) **   <a name="servicecatalog-CreateProvisionedProductPlan-request-NotificationArns"></a>
Passed to Amazon CloudFormation. The SNS topic ARNs to which to publish stack-related events.  
Type: Array of strings  
Array Members: Maximum number of 5 items.  
Length Constraints: Minimum length of 1. Maximum length of 1224.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: No

 ** [PathId](#API_CreateProvisionedProductPlan_RequestSyntax) **   <a name="servicecatalog-CreateProvisionedProductPlan-request-PathId"></a>
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](API_ListLaunchPaths.md).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** [PlanName](#API_CreateProvisionedProductPlan_RequestSyntax) **   <a name="servicecatalog-CreateProvisionedProductPlan-request-PlanName"></a>
The name of the plan.  
Type: String  
Required: Yes

 ** [PlanType](#API_CreateProvisionedProductPlan_RequestSyntax) **   <a name="servicecatalog-CreateProvisionedProductPlan-request-PlanType"></a>
The plan type.  
Type: String  
Valid Values: `CLOUDFORMATION`   
Required: Yes

 ** [ProductId](#API_CreateProvisionedProductPlan_RequestSyntax) **   <a name="servicecatalog-CreateProvisionedProductPlan-request-ProductId"></a>
The product identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

 ** [ProvisionedProductName](#API_CreateProvisionedProductPlan_RequestSyntax) **   <a name="servicecatalog-CreateProvisionedProductPlan-request-ProvisionedProductName"></a>
A user-friendly name for the provisioned product. This value must be unique for the Amazon Web Services account and cannot be updated after the product is provisioned.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9._-]*`   
Required: Yes

 ** [ProvisioningArtifactId](#API_CreateProvisionedProductPlan_RequestSyntax) **   <a name="servicecatalog-CreateProvisionedProductPlan-request-ProvisioningArtifactId"></a>
The identifier of the provisioning artifact.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

 ** [ProvisioningParameters](#API_CreateProvisionedProductPlan_RequestSyntax) **   <a name="servicecatalog-CreateProvisionedProductPlan-request-ProvisioningParameters"></a>
Parameters specified by the administrator that are required for provisioning the product.  
Type: Array of [UpdateProvisioningParameter](API_UpdateProvisioningParameter.md) objects  
Required: No

 ** [Tags](#API_CreateProvisionedProductPlan_RequestSyntax) **   <a name="servicecatalog-CreateProvisionedProductPlan-request-Tags"></a>
One or more tags.  
If the plan is for an existing provisioned product, the product must have a `RESOURCE_UPDATE` constraint with `TagUpdatesOnProvisionedProduct` set to `ALLOWED` to allow tag updates.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Maximum number of 50 items.  
Required: No

## Response Syntax
<a name="API_CreateProvisionedProductPlan_ResponseSyntax"></a>

```
{
   "PlanId": "string",
   "PlanName": "string",
   "ProvisionedProductName": "string",
   "ProvisioningArtifactId": "string",
   "ProvisionProductId": "string"
}
```

## Response Elements
<a name="API_CreateProvisionedProductPlan_ResponseElements"></a>

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

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

 ** [PlanId](#API_CreateProvisionedProductPlan_ResponseSyntax) **   <a name="servicecatalog-CreateProvisionedProductPlan-response-PlanId"></a>
The plan identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*` 

 ** [PlanName](#API_CreateProvisionedProductPlan_ResponseSyntax) **   <a name="servicecatalog-CreateProvisionedProductPlan-response-PlanName"></a>
The name of the plan.  
Type: String

 ** [ProvisionedProductName](#API_CreateProvisionedProductPlan_ResponseSyntax) **   <a name="servicecatalog-CreateProvisionedProductPlan-response-ProvisionedProductName"></a>
The user-friendly name of the provisioned product.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9._-]*` 

 ** [ProvisioningArtifactId](#API_CreateProvisionedProductPlan_ResponseSyntax) **   <a name="servicecatalog-CreateProvisionedProductPlan-response-ProvisioningArtifactId"></a>
The identifier of the provisioning artifact.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*` 

 ** [ProvisionProductId](#API_CreateProvisionedProductPlan_ResponseSyntax) **   <a name="servicecatalog-CreateProvisionedProductPlan-response-ProvisionProductId"></a>
The product identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*` 

## Errors
<a name="API_CreateProvisionedProductPlan_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** InvalidStateException **   
An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_CreateProvisionedProductPlan_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/servicecatalog-2015-12-10/CreateProvisionedProductPlan) 
+  [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/servicecatalog-2015-12-10/CreateProvisionedProductPlan) 
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/servicecatalog-2015-12-10/CreateProvisionedProductPlan) 
+  [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/servicecatalog-2015-12-10/CreateProvisionedProductPlan) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/servicecatalog-2015-12-10/CreateProvisionedProductPlan) 
+  [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/CreateProvisionedProductPlan) 
+  [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/servicecatalog-2015-12-10/CreateProvisionedProductPlan) 
+  [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/servicecatalog-2015-12-10/CreateProvisionedProductPlan) 
+  [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/servicecatalog-2015-12-10/CreateProvisionedProductPlan) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/servicecatalog-2015-12-10/CreateProvisionedProductPlan)