Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdatePortfolio

Updates the specified portfolio.

You cannot update a product that was shared with you.

Request Syntax


{
   "AcceptLanguage": "string",
   "AddTags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "Description": "string",
   "DisplayName": "string",
   "Id": "string",
   "ProviderName": "string",
   "RemoveTags": [ "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.

Type: Array of Tag objects

Array Members: Maximum number of 20 items.

Required: No

Description

The updated description of the portfolio.

Type: String

Length Constraints: Maximum length of 2000.

Required: No

DisplayName

The name to use for display purposes.

Type: String

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

Required: No

Id

The portfolio identifier.

Type: String

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

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

Required: Yes

ProviderName

The updated name of the portfolio provider.

Type: String

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

Required: No

RemoveTags

The tags to remove.

Type: Array of strings

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

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

Required: No

Response Syntax


{
   "PortfolioDetail": { 
      "ARN": "string",
      "CreatedTime": number,
      "Description": "string",
      "DisplayName": "string",
      "Id": "string",
      "ProviderName": "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.

PortfolioDetail

Information about the portfolio.

Type: PortfolioDetail object

Tags

Information about the tags associated with the portfolio.

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

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 Amazon Web Services Management Console to perform the migration process before retrying the operation.

HTTP Status Code: 400