Class ListOpenWorkflowExecutionsCommandProtected

Returns a list of open workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

• Use a Resource element with the domain name to limit the action to only specified domains.

• Use an Action element to allow or deny permission to call this action.

• Constrain the following parameters by using a Condition element with the appropriate keys.

  • tagFilter.tag: String constraint. The key is swf:tagFilter.tag.

  • typeFilter.name: String constraint. The key is swf:typeFilter.name.

  • typeFilter.version: String constraint. The key is swf:typeFilter.version.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Example

Use a bare-bones client and the command you need to make an API call.

import { SWFClient, ListOpenWorkflowExecutionsCommand } from "@aws-sdk/client-swf"; // ES Modules import
// const { SWFClient, ListOpenWorkflowExecutionsCommand } = require("@aws-sdk/client-swf"); // CommonJS import
const client = new SWFClient(config);
const input = { // ListOpenWorkflowExecutionsInput
  domain: "STRING_VALUE", // required
  startTimeFilter: { // ExecutionTimeFilter
    oldestDate: new Date("TIMESTAMP"), // required
    latestDate: new Date("TIMESTAMP"),
  },
  typeFilter: { // WorkflowTypeFilter
    name: "STRING_VALUE", // required
    version: "STRING_VALUE",
  },
  tagFilter: { // TagFilter
    tag: "STRING_VALUE", // required
  },
  nextPageToken: "STRING_VALUE",
  maximumPageSize: Number("int"),
  reverseOrder: true || false,
  executionFilter: { // WorkflowExecutionFilter
    workflowId: "STRING_VALUE", // required
  },
};
const command = new ListOpenWorkflowExecutionsCommand(input);
const response = await client.send(command);
// { // WorkflowExecutionInfos
//   executionInfos: [ // WorkflowExecutionInfoList // required
//     { // WorkflowExecutionInfo
//       execution: { // WorkflowExecution
//         workflowId: "STRING_VALUE", // required
//         runId: "STRING_VALUE", // required
//       },
//       workflowType: { // WorkflowType
//         name: "STRING_VALUE", // required
//         version: "STRING_VALUE", // required
//       },
//       startTimestamp: new Date("TIMESTAMP"), // required
//       closeTimestamp: new Date("TIMESTAMP"),
//       executionStatus: "OPEN" || "CLOSED", // required
//       closeStatus: "COMPLETED" || "FAILED" || "CANCELED" || "TERMINATED" || "CONTINUED_AS_NEW" || "TIMED_OUT",
//       parent: {
//         workflowId: "STRING_VALUE", // required
//         runId: "STRING_VALUE", // required
//       },
//       tagList: [ // TagList
//         "STRING_VALUE",
//       ],
//       cancelRequested: true || false,
//     },
//   ],
//   nextPageToken: "STRING_VALUE",
// };

Param

ListOpenWorkflowExecutionsCommandInput

Returns

ListOpenWorkflowExecutionsCommandOutput

See

• ListOpenWorkflowExecutionsCommandInput for command's input shape.
• ListOpenWorkflowExecutionsCommandOutput for command's response shape.
• config for SWFClient's config shape.

Throws

OperationNotPermittedFault (client fault)

Returned when the caller doesn't have sufficient permissions to invoke the action.

Throws

UnknownResourceFault (client fault)

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

Throws

SWFServiceException

Base exception class for all service exceptions from SWF service.