Menu
AWS Service Catalog
Developer Guide

ProvisionProduct

Provisions the specified product.

A provisioned product is a resourced instance of a product. For example, provisioning a product based on a CloudFormation template launches a CloudFormation stack and its underlying resources. You can check the status of this request using DescribeRecord.

If the request contains a tag key with an empty list of values, there is a tag conflict for that key. Do not include conflicted keys as tags, or this will cause the error "Parameter validation failed: Missing required parameter in Tags[N]:Value".

Request Syntax

{
   "AcceptLanguage": "string",
   "NotificationArns": [ "string" ],
   "PathId": "string",
   "ProductId": "string",
   "ProvisionedProductName": "string",
   "ProvisioningArtifactId": "string",
   "ProvisioningParameters": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "ProvisionToken": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "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

NotificationArns

Passed to 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

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

ProvisionedProductName

A user-friendly name for the provisioned product. This value must be unique for the AWS 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

The identifier of the provisioning artifact.

Type: String

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

Required: Yes

ProvisioningParameters

Parameters specified by the administrator that are required for provisioning the product.

Type: Array of ProvisioningParameter objects

Required: No

ProvisionToken

An idempotency token that uniquely identifies the provisioning request.

Type: String

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

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

Required: Yes

Tags

The tags to use as provisioning options.

Type: Array of Tag objects

Array Members: Maximum number of 50 items.

Required: No

Response Syntax

{
   "RecordDetail": { 
      "CreatedTime": number,
      "PathId": "string",
      "ProductId": "string",
      "ProvisionedProductId": "string",
      "ProvisionedProductName": "string",
      "ProvisionedProductType": "string",
      "ProvisioningArtifactId": "string",
      "RecordErrors": [ 
         { 
            "Code": "string",
            "Description": "string"
         }
      ],
      "RecordId": "string",
      "RecordTags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "RecordType": "string",
      "Status": "string",
      "UpdatedTime": number
   }
}

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.

RecordDetail

Information about the result of ProvisionProduct.

Type: RecordDetail object

Errors

DuplicateResourceException

The specified resource is a duplicate.

HTTP Status Code: 400

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: