- 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.
ListFlowsCommand
Lists all of the flows associated with your account.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { AppflowClient, ListFlowsCommand } from "@aws-sdk/client-appflow"; // ES Modules import
// const { AppflowClient, ListFlowsCommand } = require("@aws-sdk/client-appflow"); // CommonJS import
const client = new AppflowClient(config);
const input = { // ListFlowsRequest
maxResults: Number("int"),
nextToken: "STRING_VALUE",
};
const command = new ListFlowsCommand(input);
const response = await client.send(command);
// { // ListFlowsResponse
// flows: [ // FlowList
// { // FlowDefinition
// flowArn: "STRING_VALUE",
// description: "STRING_VALUE",
// flowName: "STRING_VALUE",
// flowStatus: "Active" || "Deprecated" || "Deleted" || "Draft" || "Errored" || "Suspended",
// sourceConnectorType: "Salesforce" || "Singular" || "Slack" || "Redshift" || "S3" || "Marketo" || "Googleanalytics" || "Zendesk" || "Servicenow" || "Datadog" || "Trendmicro" || "Snowflake" || "Dynatrace" || "Infornexus" || "Amplitude" || "Veeva" || "EventBridge" || "LookoutMetrics" || "Upsolver" || "Honeycode" || "CustomerProfiles" || "SAPOData" || "CustomConnector" || "Pardot",
// sourceConnectorLabel: "STRING_VALUE",
// destinationConnectorType: "Salesforce" || "Singular" || "Slack" || "Redshift" || "S3" || "Marketo" || "Googleanalytics" || "Zendesk" || "Servicenow" || "Datadog" || "Trendmicro" || "Snowflake" || "Dynatrace" || "Infornexus" || "Amplitude" || "Veeva" || "EventBridge" || "LookoutMetrics" || "Upsolver" || "Honeycode" || "CustomerProfiles" || "SAPOData" || "CustomConnector" || "Pardot",
// destinationConnectorLabel: "STRING_VALUE",
// triggerType: "Scheduled" || "Event" || "OnDemand",
// createdAt: new Date("TIMESTAMP"),
// lastUpdatedAt: new Date("TIMESTAMP"),
// createdBy: "STRING_VALUE",
// lastUpdatedBy: "STRING_VALUE",
// tags: { // TagMap
// "<keys>": "STRING_VALUE",
// },
// lastRunExecutionDetails: { // ExecutionDetails
// mostRecentExecutionMessage: "STRING_VALUE",
// mostRecentExecutionTime: new Date("TIMESTAMP"),
// mostRecentExecutionStatus: "InProgress" || "Successful" || "Error" || "CancelStarted" || "Canceled",
// },
// },
// ],
// nextToken: "STRING_VALUE",
// };
ListFlowsCommand Input
See ListFlowsCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
maxResults | number | undefined | Specifies the maximum number of items that should be returned in the result set. |
nextToken | string | undefined | The pagination token for next page of data. |
ListFlowsCommand Output
See ListFlowsCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
flows | FlowDefinition[] | undefined | The list of flows associated with your account. |
nextToken | string | undefined | The pagination token for next page of data. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
InternalServerException | server | An internal service error occurred during the processing of your request. Try again later. |
ValidationException | client | The request has invalid or missing parameters. |
AppflowServiceException | Base exception class for all service exceptions from Appflow service. |