- 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.
StopFlowCommand
Deactivates the existing flow. For on-demand flows, this operation returns an unsupportedOperationException
error message. For schedule and event-triggered flows, this operation deactivates the flow.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { AppflowClient, StopFlowCommand } from "@aws-sdk/client-appflow"; // ES Modules import
// const { AppflowClient, StopFlowCommand } = require("@aws-sdk/client-appflow"); // CommonJS import
const client = new AppflowClient(config);
const input = { // StopFlowRequest
flowName: "STRING_VALUE", // required
};
const command = new StopFlowCommand(input);
const response = await client.send(command);
// { // StopFlowResponse
// flowArn: "STRING_VALUE",
// flowStatus: "Active" || "Deprecated" || "Deleted" || "Draft" || "Errored" || "Suspended",
// };
StopFlowCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
flowName Required | string | undefined | The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only. |
StopFlowCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
flowArn | string | undefined | The flow's Amazon Resource Name (ARN). |
flowStatus | FlowStatus | undefined | Indicates the current status of the flow. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
ConflictException | client | There was a conflict when processing the request (for example, a flow with the given name already exists within the account. Check for conflicting resource names and try again. |
InternalServerException | server | An internal service error occurred during the processing of your request. Try again later. |
ResourceNotFoundException | client | The resource specified in the request (such as the source or destination connector profile) is not found. |
UnsupportedOperationException | client | The requested operation is not supported for the current flow. |
AppflowServiceException | Base exception class for all service exceptions from Appflow service. |