Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

TerminateProvisionedProduct

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

Request Syntax


{
   "AcceptLanguage": "string",
   "IgnoreErrors": boolean,
   "ProvisionedProductId": "string",
   "ProvisionedProductName": "string",
   "RetainPhysicalResources": boolean,
   "TerminateToken": "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

IgnoreErrors

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

Type: Boolean

Required: No

ProvisionedProductId

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

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

RetainPhysicalResources

When this boolean parameter is set to true, the TerminateProvisionedProduct API deletes the AWS Service Catalog provisioned product. However, it does not remove the AWS CloudFormation stack, stack set, or the underlying resources of the deleted provisioned product. The default value is false.

Type: Boolean

Required: No

TerminateToken

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.

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

Type: RecordDetail object

Errors

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 400