listOpenWorkflowExecutions method

Future<WorkflowExecutionInfos> listOpenWorkflowExecutions({ required String domain, required ExecutionTimeFilter startTimeFilter, WorkflowExecutionFilter? executionFilter, int? maximumPageSize, String? nextPageToken, bool? reverseOrder, TagFilter? tagFilter, WorkflowTypeFilter? typeFilter, })

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

May throw UnknownResourceFault. May throw OperationNotPermittedFault.

Parameter domain : The name of the domain that contains the workflow executions to list.

Parameter startTimeFilter : Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.

Parameter executionFilter : If specified, only workflow executions matching the workflow ID specified in the filter are returned.

Parameter maximumPageSize : The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

Parameter nextPageToken : If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".

The configured maximumPageSize determines how many results can be returned in a single call.

Parameter reverseOrder : When set to true, returns the results in reverse order. By default the results are returned in descending order of the start time of the executions.

Parameter tagFilter : If specified, only executions that have the matching tag are listed.

Parameter typeFilter : If specified, only executions of the type specified in the filter are returned.

Implementation

Future<WorkflowExecutionInfos> listOpenWorkflowExecutions({
  required String domain,
  required ExecutionTimeFilter startTimeFilter,
  WorkflowExecutionFilter? executionFilter,
  int? maximumPageSize,
  String? nextPageToken,
  bool? reverseOrder,
  TagFilter? tagFilter,
  WorkflowTypeFilter? typeFilter,
}) async {
  ArgumentError.checkNotNull(domain, 'domain');
  _s.validateStringLength(
    'domain',
    domain,
    1,
    256,
    isRequired: true,
  );
  ArgumentError.checkNotNull(startTimeFilter, 'startTimeFilter');
  _s.validateNumRange(
    'maximumPageSize',
    maximumPageSize,
    0,
    1000,
  );
  _s.validateStringLength(
    'nextPageToken',
    nextPageToken,
    0,
    2048,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.0',
    'X-Amz-Target': 'SimpleWorkflowService.ListOpenWorkflowExecutions'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'domain': domain,
      'startTimeFilter': startTimeFilter,
      if (executionFilter != null) 'executionFilter': executionFilter,
      if (maximumPageSize != null) 'maximumPageSize': maximumPageSize,
      if (nextPageToken != null) 'nextPageToken': nextPageToken,
      if (reverseOrder != null) 'reverseOrder': reverseOrder,
      if (tagFilter != null) 'tagFilter': tagFilter,
      if (typeFilter != null) 'typeFilter': typeFilter,
    },
  );

  return WorkflowExecutionInfos.fromJson(jsonResponse.body);
}