Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . servicecatalog ]



Requests updates to the configuration of the specified provisioned product.

If there are tags associated with the object, they cannot be updated or added. Depending on the specific updates requested, this operation can update with no interruption, with some interruption, or replace the provisioned product entirely.

You can check the status of this request using describe-record .

See also: AWS API Documentation


[--accept-language <value>]
[--provisioned-product-name <value>]
[--provisioned-product-id <value>]
[--product-id <value>]
[--provisioning-artifact-id <value>]
[--path-id <value>]
[--provisioning-parameters <value>]
[--update-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--accept-language (string)

The language code.

  • en - English (default)
  • jp - Japanese
  • zh - Chinese

--provisioned-product-name (string)

The updated name of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId .

--provisioned-product-id (string)

The identifier of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId .

--product-id (string)

The identifier of the provisioned product.

--provisioning-artifact-id (string)

The identifier of the provisioning artifact.

--path-id (string)

The new path identifier. This value is optional if the product has a default path, and required if the product has more than one path.

--provisioning-parameters (list)

The new parameters.

Shorthand Syntax:

Key=string,Value=string,UsePreviousValue=boolean ...

JSON Syntax:

    "Key": "string",
    "Value": "string",
    "UsePreviousValue": true|false

--update-token (string)

The idempotency token that uniquely identifies the provisioning update rquest.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.


RecordDetail -> (structure)

Information about the result of the request.

RecordId -> (string)

The identifier of the record.

ProvisionedProductName -> (string)

The user-friendly name of the provisioned product.

Status -> (string)

The status of the provisioned product.

  • CREATED - The request was created but the operation has not started.
  • IN_PROGRESS - The requested operation is in progress.
  • IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback.
  • SUCCEEDED - The requested operation has successfully completed.
  • FAILED - The requested operation has unsuccessfully completed. Investigate using the error messages returned.

CreatedTime -> (timestamp)

The UTC timestamp of the creation time.

UpdatedTime -> (timestamp)

The time when the record was last updated.

ProvisionedProductType -> (string)

The type of provisioned product. The supported value is CFN_STACK .

RecordType -> (string)

The record type for this record.


ProvisionedProductId -> (string)

The identifier of the provisioned product.

ProductId -> (string)

The product identifier.

ProvisioningArtifactId -> (string)

The identifier of the provisioning artifact.

PathId -> (string)

The path identifier.

RecordErrors -> (list)

The errors that occurred while processing the request.


The error code and description resulting from an operation.

Code -> (string)

The numeric value of the error.

Description -> (string)

The description of the error.

RecordTags -> (list)

The tags associated with this record.


A tag associated with the record, stored as a key-value pair.

Key -> (string)

The key for this tag.

Value -> (string)

The value for this tag.