Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateProvisionedProduct

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 DescribeRecord.

Request Syntax


{
   "AcceptLanguage": "string",
   "PathId": "string",
   "PathName": "string",
   "ProductId": "string",
   "ProductName": "string",
   "ProvisionedProductId": "string",
   "ProvisionedProductName": "string",
   "ProvisioningArtifactId": "string",
   "ProvisioningArtifactName": "string",
   "ProvisioningParameters": [ 
      { 
         "Key": "string",
         "UsePreviousValue": boolean,
         "Value": "string"
      }
   ],
   "ProvisioningPreferences": { 
      "StackSetAccounts": [ "string" ],
      "StackSetFailureToleranceCount": number,
      "StackSetFailureTolerancePercentage": number,
      "StackSetMaxConcurrencyCount": number,
      "StackSetMaxConcurrencyPercentage": number,
      "StackSetOperationType": "string",
      "StackSetRegions": [ "string" ]
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "UpdateToken": "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

PathId

The path identifier. This value is optional if the product has a default path, and required if the product has more than one path. You must provide the name or ID, but not both.

Type: String

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

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

Required: No

PathName

The name of the path. You must provide the name or ID, but not both.

Type: String

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

Required: No

ProductId

The identifier of the product. You must provide the name or ID, but not both.

Type: String

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

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

Required: No

ProductName

The name of the product. You must provide the name or ID, but not both.

Type: String

Length Constraints: Maximum length of 8191.

Required: No

ProvisionedProductId

The identifier of the provisioned product. You must provide the name or ID, but not both.

Type: String

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

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

Required: No

ProvisionedProductName

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

Type: String

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

Pattern: [a-zA-Z0-9][a-zA-Z0-9._-]{0,127}|arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Required: No

ProvisioningArtifactId

The identifier of the provisioning artifact.

Type: String

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

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

Required: No

ProvisioningArtifactName

The name of the provisioning artifact. You must provide the name or ID, but not both.

Type: String

Length Constraints: Maximum length of 8192.

Required: No

ProvisioningParameters

The new parameters.

Type: Array of UpdateProvisioningParameter objects

Required: No

ProvisioningPreferences

An object that contains information about the provisioning preferences for a stack set.

Type: UpdateProvisioningPreferences object

Required: No

Tags

One or more tags. Requires the product to have RESOURCE_UPDATE constraint with TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates.

Type: Array of Tag objects

Array Members: Maximum number of 50 items.

Required: No

UpdateToken

The idempotency token that uniquely identifies the provisioning update request.

Type: String

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

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

Required: Yes

Response Syntax


{
   "RecordDetail": { 
      "CreatedTime": number,
      "LaunchRoleArn": "string",
      "PathId": "string",
      "ProductId": "string",
      "ProvisionedProductId": "string",
      "ProvisionedProductName": "string",
      "ProvisionedProductType": "string",
      "ProvisioningArtifactId": "string",
      "RecordErrors": [ 
         { 
            "Code": "string",
            "Description": "string"
         }
      ],
      "RecordId": "string",
      "RecordTags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "RecordType": "string",
      "Status": "string",
      "UpdatedTime": number
   }
}

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.

RecordDetail

Information about the result of the request.

Type: RecordDetail object

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