Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

CreateProvisioningArtifact

Creates a provisioning artifact (also known as a version) for the specified product.

You cannot create a provisioning artifact for a product that was shared with you.

The user or role that performs this operation must have the cloudformation:GetTemplate IAM policy permission. This policy permission is required when using the ImportFromPhysicalId template source in the information data section.

Request Syntax


{
   "AcceptLanguage": "string",
   "IdempotencyToken": "string",
   "Parameters": { 
      "Description": "string",
      "DisableTemplateValidation": boolean,
      "Info": { 
         "string" : "string" 
      },
      "Name": "string",
      "Type": "string"
   },
   "ProductId": "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

IdempotencyToken

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

Parameters

The configuration for the provisioning artifact.

Type: ProvisioningArtifactProperties object

Required: Yes

ProductId

The product identifier.

Type: String

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

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

Required: Yes

Response Syntax


{
   "Info": { 
      "string" : "string" 
   },
   "ProvisioningArtifactDetail": { 
      "Active": boolean,
      "CreatedTime": number,
      "Description": "string",
      "Guidance": "string",
      "Id": "string",
      "Name": "string",
      "SourceRevision": "string",
      "Type": "string"
   },
   "Status": "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.

Info

Specify the template source with one of the following options, but not both. Keys accepted: [ LoadTemplateFromURL, ImportFromPhysicalId ].

Use the URL of the AWS CloudFormation template in Amazon S3 or GitHub in JSON format.

LoadTemplateFromURL

Use the URL of the AWS CloudFormation template in Amazon S3 or GitHub in JSON format.

ImportFromPhysicalId

Use the physical id of the resource that contains the template; currently supports AWS CloudFormation stack ARN.

Type: String to string map

Map Entries: Maximum number of 100 items.

ProvisioningArtifactDetail

Information about the provisioning artifact.

Type: ProvisioningArtifactDetail object

Status

The status of the current request.

Type: String

Valid Values: AVAILABLE | CREATING | FAILED

Errors

InvalidParametersException

One or more parameters provided to the operation are not valid.

HTTP Status Code: 400

LimitExceededException

The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 400

Examples

To create a provisioning artifact

The following shows an example JSON request.

Sample Request


{
   "AcceptLanguage": "en",
   "ProductId": "prod-mjpjbit3pzuqi",
   "Parameters":
   {
      "Name": "Version-2",
      "Description": "my-test-2",
      "Info":
      {
         "LoadTemplateFromURL": "https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/..." ,
      },
      "Type": "CLOUD_FORMATION_TEMPLATE"
      "IdempotencyToken": "my-test-token-2"
   }
}