Table Of Contents

Feedback

User Guide

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

[ aws . servicecatalog ]

terminate-provisioned-product

Description

Terminates the specified provisioned product.

This operation does not delete any records associated with the provisioned product.

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  terminate-provisioned-product
[--provisioned-product-name <value>]
[--provisioned-product-id <value>]
[--terminate-token <value>]
[--ignore-errors | --no-ignore-errors]
[--accept-language <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--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 cannot specify both ProvisionedProductName and ProvisionedProductId .

--terminate-token (string)

An idempotency token that uniquely identifies the termination request. This token is only valid during the termination process. After the provisioned product is terminated, subsequent requests to terminate the same provisioned product always return ResourceNotFound .

--ignore-errors | --no-ignore-errors (boolean)

If set to true, AWS Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources.

--accept-language (string)

The language code.

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

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

See 'aws help' for descriptions of global parameters.

Output

RecordDetail -> (structure)

Information about the result of this 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 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.