- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DeprecateFlowTemplateCommand
- since: 2022-08-30
Deprecates the specified workflow. This action marks the workflow for deletion. Deprecated flows can't be deployed, but existing deployments will continue to run.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { IoTThingsGraphClient, DeprecateFlowTemplateCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import
// const { IoTThingsGraphClient, DeprecateFlowTemplateCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS import
const client = new IoTThingsGraphClient(config);
const input = { // DeprecateFlowTemplateRequest
id: "STRING_VALUE", // required
};
const command = new DeprecateFlowTemplateCommand(input);
const response = await client.send(command);
// {};
DeprecateFlowTemplateCommand Input
See DeprecateFlowTemplateCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
idRequired | string | undefined | The ID of the workflow to be deleted. The ID should be in the following format. |
DeprecateFlowTemplateCommand Output
See DeprecateFlowTemplateCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| InternalFailureException | server | |
| InvalidRequestException | client | |
| ResourceNotFoundException | client | |
| ThrottlingException | client | |
| IoTThingsGraphServiceException | Base exception class for all service exceptions from IoTThingsGraph service. |