Table Of Contents

Feedback

User Guide

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

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . servicecatalog ]

update-provisioned-product

Description

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 .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

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

Options

--accept-language (string)

The language code.

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

--provisioned-product-name (string)

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

--provisioned-product-id (string)

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

--product-id (string)

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

--product-name (string)

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

--provisioning-artifact-id (string)

The identifier of the provisioning artifact.

--provisioning-artifact-name (string)

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

--path-id (string)

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.

--path-name (string)

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

--provisioning-parameters (list)

The new parameters.

(structure)

The parameter key-value pair used to update a provisioned product.

Key -> (string)

The parameter key.

Value -> (string)

The parameter value.

UsePreviousValue -> (boolean)

If set to true, Value is ignored and the previous parameter value is kept.

Shorthand Syntax:

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

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string",
    "UsePreviousValue": true|false
  }
  ...
]

--provisioning-preferences (structure)

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

StackSetAccounts -> (list)

One or more AWS accounts that will have access to the provisioned product.

Applicable only to a CFN_STACKSET provisioned product type.

The AWS accounts specified should be within the list of accounts in the STACKSET constraint. To get the list of accounts in the STACKSET constraint, use the DescribeProvisioningParameters operation.

If no values are specified, the default value is all accounts from the STACKSET constraint.

(string)

StackSetRegions -> (list)

One or more AWS Regions where the provisioned product will be available.

Applicable only to a CFN_STACKSET provisioned product type.

The specified regions should be within the list of regions from the STACKSET constraint. To get the list of regions in the STACKSET constraint, use the DescribeProvisioningParameters operation.

If no values are specified, the default value is all regions from the STACKSET constraint.

(string)

StackSetFailureToleranceCount -> (integer)

The number of accounts, per region, for which this operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions.

Applicable only to a CFN_STACKSET provisioned product type.

Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage , but not both.

The default value is 0 if no value is specified.

StackSetFailureTolerancePercentage -> (integer)

The percentage of accounts, per region, for which this stack operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions.

When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number.

Applicable only to a CFN_STACKSET provisioned product type.

Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage , but not both.

StackSetMaxConcurrencyCount -> (integer)

The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of StackSetFailureToleranceCount . StackSetMaxConcurrentCount is at most one more than the StackSetFailureToleranceCount .

Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

Applicable only to a CFN_STACKSET provisioned product type.

Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage , but not both.

StackSetMaxConcurrencyPercentage -> (integer)

The maximum percentage of accounts in which to perform this operation at one time.

When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, AWS Service Catalog sets the number as 1 instead.

Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

Applicable only to a CFN_STACKSET provisioned product type.

Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage , but not both.

StackSetOperationType -> (string)

Determines what action AWS Service Catalog performs to a stack set or a stack instance represented by the provisioned product. The default value is UPDATE if nothing is specified.

Applicable only to a CFN_STACKSET provisioned product type.

CREATE

Creates a new stack instance in the stack set represented by the provisioned product. In this case, only new stack instances are created based on accounts and regions; if new ProductId or ProvisioningArtifactID are passed, they will be ignored.

UPDATE

Updates the stack set represented by the provisioned product and also its stack instances.

DELETE

Deletes a stack instance in the stack set represented by the provisioned product.

Shorthand Syntax:

StackSetAccounts=string,string,StackSetRegions=string,string,StackSetFailureToleranceCount=integer,StackSetFailureTolerancePercentage=integer,StackSetMaxConcurrencyCount=integer,StackSetMaxConcurrencyPercentage=integer,StackSetOperationType=string

JSON Syntax:

{
  "StackSetAccounts": ["string", ...],
  "StackSetRegions": ["string", ...],
  "StackSetFailureToleranceCount": integer,
  "StackSetFailureTolerancePercentage": integer,
  "StackSetMaxConcurrencyCount": integer,
  "StackSetMaxConcurrencyPercentage": integer,
  "StackSetOperationType": "CREATE"|"UPDATE"|"DELETE"
}

--tags (list)

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

(structure)

Information about a tag. A tag is a key-value pair. Tags are propagated to the resources created when provisioning a product.

Key -> (string)

The tag key.

Value -> (string)

The value for this key.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--update-token (string)

The idempotency token that uniquely identifies the provisioning update request.

--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. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

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

See 'aws help' for descriptions of global parameters.

Output

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 time stamp of the creation time.

UpdatedTime -> (timestamp)

The time when the record was last updated.

ProvisionedProductType -> (string)

The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET .

RecordType -> (string)

The record type.

  • PROVISION_PRODUCT
  • UPDATE_PROVISIONED_PRODUCT
  • TERMINATE_PROVISIONED_PRODUCT

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.

(structure)

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)

One or more tags.

(structure)

Information about a tag, which is a key-value pair.

Key -> (string)

The key for this tag.

Value -> (string)

The value for this tag.

LaunchRoleArn -> (string)

The ARN of the launch role associated with the provisioned product.