ProvisionProduct
Provisions the specified product.
A provisioned product is a resourced instance of a product. For example, provisioning a product that's based on an AWS CloudFormation template launches an AWS 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's a tag conflict for that key. Don't include conflicted keys as tags, or this will cause the error "Parameter validation failed: Missing required parameter in Tags[N]:Value".
Note
When provisioning a product that's been added to a portfolio, you must grant your user, group, or role access to the portfolio. For more information, see Granting users access in the Service Catalog User Guide.
Request Syntax
{
"AcceptLanguage": "string",
"NotificationArns": [ "string" ],
"PathId": "string",
"PathName": "string",
"ProductId": "string",
"ProductName": "string",
"ProvisionedProductName": "string",
"ProvisioningArtifactId": "string",
"ProvisioningArtifactName": "string",
"ProvisioningParameters": [
{
"Key": "string",
"Value": "string"
}
],
"ProvisioningPreferences": {
"StackSetAccounts": [ "string" ],
"StackSetFailureToleranceCount": number,
"StackSetFailureTolerancePercentage": number,
"StackSetMaxConcurrencyCount": number,
"StackSetMaxConcurrencyPercentage": number,
"StackSetRegions": [ "string" ]
},
"ProvisionToken": "string",
"Tags": [
{
"Key": "string",
"Value": "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
-
- NotificationArns
-
Passed to AWS 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. 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 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
- 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. 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
- ProvisioningParameters
-
Parameters specified by the administrator that are required for provisioning the product.
Type: Array of ProvisioningParameter objects
Required: No
- ProvisioningPreferences
-
An object that contains information about the provisioning preferences for a stack set.
Type: ProvisioningPreferences object
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
-
One or more tags.
Type: Array of Tag objects
Array Members: Maximum number of 50 items.
Required: No
Response Syntax
{
"RecordDetail": {
"CreatedTime": number,
"LaunchRoleArn": "string",
"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 provisioning the product.
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:
