Table Of Contents

Feedback

User Guide

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

[ aws . servicecatalog ]

provision-product

Description

Provisions the specified product.

A provisioned product is a resourced instance of a product. For example, provisioning a product based on a CloudFormation template launches a CloudFormation stack and its underlying resources. You can check the status of this request using DescribeRecord .

If the request contains a tag key with an empty list of values, there is a tag conflict for that key. Do not include conflicted keys as tags, or this causes the error "Parameter validation failed: Missing required parameter in Tags[N ]:Value ".

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

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

Options

--accept-language (string)

The language code.

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

--product-id (string)

The product identifier.

--provisioning-artifact-id (string)

The identifier of the provisioning artifact.

--path-id (string)

The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths .

--provisioned-product-name (string)

A user-friendly name for the provisioned product. This value must be unique for the AWS account and cannot be updated after the product is provisioned.

--provisioning-parameters (list)

Parameters specified by the administrator that are required for provisioning the product.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

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

--tags (list)

One or more tags.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

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

--notification-arns (list)

Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.

Syntax:

"string" "string" ...

--provision-token (string)

An idempotency token that uniquely identifies the provisioning 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 provisioning the product.

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 value is CFN_STACK .

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.