Menu
AWS Service Catalog
Developer Guide

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" ],
   "SupportDescription": "string",
   "SupportEmail": "string",
   "SupportUrl": "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

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

Required: No

Distributor

The updated distributor of the product.

Type: String

Required: No

Id

The product identifier.

Type: String

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

Required: Yes

Name

The updated product name.

Type: String

Required: No

Owner

The updated owner of the product.

Type: String

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

SupportDescription

The updated support description for the product.

Type: String

Required: No

SupportEmail

The updated support email for the product.

Type: String

Required: No

SupportUrl

The updated support URL for the product.

Type: String

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"
      },
      "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. Please use the AWS console to perform the migration process before retrying the operation.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: