Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateProduct

Creates a product.

A delegated admin is authorized to invoke this command.

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",
   "Description": "string",
   "Distributor": "string",
   "IdempotencyToken": "string",
   "Name": "string",
   "Owner": "string",
   "ProductType": "string",
   "ProvisioningArtifactParameters": { 
      "Description": "string",
      "DisableTemplateValidation": boolean,
      "Info": { 
         "string" : "string" 
      },
      "Name": "string",
      "Type": "string"
   },
   "SourceConnection": { 
      "ConnectionParameters": { 
         "CodeStar": { 
            "ArtifactPath": "string",
            "Branch": "string",
            "ConnectionArn": "string",
            "Repository": "string"
         }
      },
      "Type": "string"
   },
   "SupportDescription": "string",
   "SupportEmail": "string",
   "SupportUrl": "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

Description

The description of the product.

Type: String

Length Constraints: Maximum length of 8191.

Required: No

Distributor

The distributor of the product.

Type: String

Length Constraints: Maximum length of 8191.

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

Name

The name of the product.

Type: String

Length Constraints: Maximum length of 8191.

Required: Yes

Owner

The owner of the product.

Type: String

Length Constraints: Maximum length of 8191.

Required: Yes

ProductType

The type of product.

Type: String

Length Constraints: Maximum length of 8191.

Valid Values: CLOUD_FORMATION_TEMPLATE | MARKETPLACE | TERRAFORM_OPEN_SOURCE | TERRAFORM_CLOUD | EXTERNAL

Required: Yes

ProvisioningArtifactParameters

The configuration of the provisioning artifact.

Type: ProvisioningArtifactProperties object

Required: No

SourceConnection

Specifies connection details for the created product and syncs the product to the connection source artifact. This automatically manages the product's artifacts based on changes to the source. The SourceConnection parameter consists of the following sub-fields.

Type
ConnectionParamters

Type: SourceConnection object

Required: No

SupportDescription

The support information about the product.

Type: String

Length Constraints: Maximum length of 8191.

Required: No

SupportEmail

The contact email for product support.

Type: String

Length Constraints: Maximum length of 254.

Required: No

SupportUrl

The contact URL for product support.

^https?:\/\// / is the pattern used to validate SupportUrl.

Type: String

Length Constraints: Maximum length of 2083.

Required: No

Tags

One or more tags.

Type: Array of Tag objects

Array Members: Maximum number of 20 items.

Required: No

Response Syntax


{
   "ProductViewDetail": { 
      "CreatedTime": number,
      "ProductARN": "string",
      "ProductViewSummary": { 
         "Distributor": "string",
         "HasDefaultPath": boolean,
         "Id": "string",
         "Name": "string",
         "Owner": "string",
         "ProductId": "string",
         "ShortDescription": "string",
         "SupportDescription": "string",
         "SupportEmail": "string",
         "SupportUrl": "string",
         "Type": "string"
      },
      "SourceConnection": { 
         "ConnectionParameters": { 
            "CodeStar": { 
               "ArtifactPath": "string",
               "Branch": "string",
               "ConnectionArn": "string",
               "Repository": "string"
            }
         },
         "LastSync": { 
            "LastSuccessfulSyncProvisioningArtifactId": "string",
            "LastSuccessfulSyncTime": number,
            "LastSyncStatus": "string",
            "LastSyncStatusMessage": "string",
            "LastSyncTime": number
         },
         "Type": "string"
      },
      "Status": "string"
   },
   "ProvisioningArtifactDetail": { 
      "Active": boolean,
      "CreatedTime": number,
      "Description": "string",
      "Guidance": "string",
      "Id": "string",
      "Name": "string",
      "SourceRevision": "string",
      "Type": "string"
   },
   "Tags": [ 
      { 
         "Key": "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.

ProductViewDetail

Information about the product view.

Type: ProductViewDetail object

ProvisioningArtifactDetail

Information about the provisioning artifact.

Type: ProvisioningArtifactDetail object

Tags

Information about the tags associated with the product.

Type: Array of Tag objects

Array Members: Maximum number of 50 items.

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

TagOptionNotMigratedException

An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the AWS Management Console to perform the migration process before retrying the operation.

HTTP Status Code: 400