ServiceCatalog / Client / terminate_provisioned_product

terminate_provisioned_product#

ServiceCatalog.Client.terminate_provisioned_product(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.terminate_provisioned_product(
    ProvisionedProductName='string',
    ProvisionedProductId='string',
    TerminateToken='string',
    IgnoreErrors=True|False,
    AcceptLanguage='string',
    RetainPhysicalResources=True|False
)
Parameters:

  • ProvisionedProductName (string) – The name of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId.

  • ProvisionedProductId (string) – The identifier of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId.

  • TerminateToken (string) –

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

    This field is autopopulated if not provided.

  • IgnoreErrors (boolean) – If set to true, Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources.

  • AcceptLanguage (string) –

    The language code.

    • jp - Japanese

    • zh - Chinese

  • RetainPhysicalResources (boolean) – When this boolean parameter is set to true, the TerminateProvisionedProduct 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.

Return type:

dict

Returns:

Response Syntax

{
    'RecordDetail': {
        'RecordId': 'string',
        'ProvisionedProductName': 'string',
        'Status': 'CREATED'|'IN_PROGRESS'|'IN_PROGRESS_IN_ERROR'|'SUCCEEDED'|'FAILED',
        'CreatedTime': datetime(2015, 1, 1),
        'UpdatedTime': datetime(2015, 1, 1),
        'ProvisionedProductType': 'string',
        'RecordType': 'string',
        'ProvisionedProductId': 'string',
        'ProductId': 'string',
        'ProvisioningArtifactId': 'string',
        'PathId': 'string',
        'RecordErrors': [
            {
                'Code': 'string',
                'Description': 'string'
            },
        ],
        'RecordTags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'LaunchRoleArn': 'string'
    }
}

Response Structure

  • (dict) –

    • RecordDetail (dict) –

      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 (datetime) –

        The UTC time stamp of the creation time.

      • UpdatedTime (datetime) –

        The time when the record was last updated.

      • ProvisionedProductType (string) –

        The type of provisioned product. The supported values are CFN_STACK, CFN_STACKSET, TERRAFORM_OPEN_SOURCE, TERRAFORM_CLOUD, and EXTERNAL.

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

        • (dict) –

          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.

        • (dict) –

          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.

Exceptions