servicecatalog_terminate_provisioned_product: Terminates the specified provisioned product

Description Usage Arguments Value Request syntax

View source: R/servicecatalog_operations.R

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.

Usage

1
2
3
servicecatalog_terminate_provisioned_product(ProvisionedProductName,
  ProvisionedProductId, TerminateToken, IgnoreErrors, AcceptLanguage,
  RetainPhysicalResources)

Arguments

ProvisionedProductName

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

ProvisionedProductId

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

TerminateToken

[required] 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.

IgnoreErrors

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

AcceptLanguage

The language code.

  • en - English (default)

  • jp - Japanese

  • zh - Chinese

RetainPhysicalResources

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

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
list(
  RecordDetail = list(
    RecordId = "string",
    ProvisionedProductName = "string",
    Status = "CREATED"|"IN_PROGRESS"|"IN_PROGRESS_IN_ERROR"|"SUCCEEDED"|"FAILED",
    CreatedTime = as.POSIXct(
      "2015-01-01"
    ),
    UpdatedTime = as.POSIXct(
      "2015-01-01"
    ),
    ProvisionedProductType = "string",
    RecordType = "string",
    ProvisionedProductId = "string",
    ProductId = "string",
    ProvisioningArtifactId = "string",
    PathId = "string",
    RecordErrors = list(
      list(
        Code = "string",
        Description = "string"
      )
    ),
    RecordTags = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    LaunchRoleArn = "string"
  )
)

Request syntax

1
2
3
4
5
6
7
8
svc$terminate_provisioned_product(
  ProvisionedProductName = "string",
  ProvisionedProductId = "string",
  TerminateToken = "string",
  IgnoreErrors = TRUE|FALSE,
  AcceptLanguage = "string",
  RetainPhysicalResources = TRUE|FALSE
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.