Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateProduct

Updates the specified product.

Request Syntax


{
   "AcceptLanguage": "string",
   "AddTags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "Description": "string",
   "Distributor": "string",
   "Id": "string",
   "Name": "string",
   "Owner": "string",
   "RemoveTags": [ "string" ],
   "SourceConnection": { 
      "ConnectionParameters": { 
         "CodeStar": { 
            "ArtifactPath": "string",
            "Branch": "string",
            "ConnectionArn": "string",
            "Repository": "string"
         }
      },
      "Type": "string"
   },
   "SupportDescription": "string",
   "SupportEmail": "string",
   "SupportUrl": "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

AddTags

The tags to add to the product.

Type: Array of Tag objects

Array Members: Maximum number of 20 items.

Required: No

Description

The updated description of the product.

Type: String

Length Constraints: Maximum length of 8191.

Required: No

Distributor

The updated distributor of the product.

Type: String

Length Constraints: Maximum length of 8191.

Required: No

Id

The product identifier.

Type: String

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

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

Required: Yes

Name

The updated product name.

Type: String

Length Constraints: Maximum length of 8191.

Required: No

Owner

The updated owner of the product.

Type: String

Length Constraints: Maximum length of 8191.

Required: No

RemoveTags

The tags to remove from the product.

Type: Array of strings

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

Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Required: No

SourceConnection

Specifies connection details for the updated 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 updated support description for the product.

Type: String

Length Constraints: Maximum length of 8191.

Required: No

SupportEmail

The updated support email for the product.

Type: String

Length Constraints: Maximum length of 254.

Required: No

SupportUrl

The updated support URL for the product.

Type: String

Length Constraints: Maximum length of 2083.

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"
   },
   "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

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

ResourceNotFoundException

The specified resource was not found.

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