SWF / Paginator / ListOpenWorkflowExecutions
ListOpenWorkflowExecutions#
- class SWF.Paginator.ListOpenWorkflowExecutions#
paginator = client.get_paginator('list_open_workflow_executions')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
SWF.Client.list_open_workflow_executions()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( domain='string', startTimeFilter={ 'oldestDate': datetime(2015, 1, 1), 'latestDate': datetime(2015, 1, 1) }, typeFilter={ 'name': 'string', 'version': 'string' }, tagFilter={ 'tag': 'string' }, reverseOrder=True|False, executionFilter={ 'workflowId': 'string' }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
domain (string) –
[REQUIRED]
The name of the domain that contains the workflow executions to list.
startTimeFilter (dict) –
[REQUIRED]
Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.
oldestDate (datetime) – [REQUIRED]
Specifies the oldest start or close date and time to return.
latestDate (datetime) –
Specifies the latest start or close date and time to return.
typeFilter (dict) –
If specified, only executions of the type specified in the filter are returned.
Note
executionFilter
,typeFilter
andtagFilter
are mutually exclusive. You can specify at most one of these in a request.name (string) – [REQUIRED]
Name of the workflow type.
version (string) –
Version of the workflow type.
tagFilter (dict) –
If specified, only executions that have the matching tag are listed.
Note
executionFilter
,typeFilter
andtagFilter
are mutually exclusive. You can specify at most one of these in a request.tag (string) – [REQUIRED]
Specifies the tag that must be associated with the execution for it to meet the filter criteria.
Tags may only contain unicode letters, digits, whitespace, or these symbols:
_ . : / = + - @
.
reverseOrder (boolean) – 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.executionFilter (dict) –
If specified, only workflow executions matching the workflow ID specified in the filter are returned.
Note
executionFilter
,typeFilter
andtagFilter
are mutually exclusive. You can specify at most one of these in a request.workflowId (string) – [REQUIRED]
The workflowId to pass of match the criteria of this filter.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextToken
will be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextToken
from a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ 'executionInfos': [ { 'execution': { 'workflowId': 'string', 'runId': 'string' }, 'workflowType': { 'name': 'string', 'version': 'string' }, 'startTimestamp': datetime(2015, 1, 1), 'closeTimestamp': datetime(2015, 1, 1), 'executionStatus': 'OPEN'|'CLOSED', 'closeStatus': 'COMPLETED'|'FAILED'|'CANCELED'|'TERMINATED'|'CONTINUED_AS_NEW'|'TIMED_OUT', 'parent': { 'workflowId': 'string', 'runId': 'string' }, 'tagList': [ 'string', ], 'cancelRequested': True|False }, ], 'NextToken': 'string' }
Response Structure
(dict) –
Contains a paginated list of information about workflow executions.
executionInfos (list) –
The list of workflow information structures.
(dict) –
Contains information about a workflow execution.
execution (dict) –
The workflow execution this information is about.
workflowId (string) –
The user defined identifier associated with the workflow execution.
runId (string) –
A system-generated unique identifier for the workflow execution.
workflowType (dict) –
The type of the workflow execution.
name (string) –
The name of the workflow type.
Note
The combination of workflow type name and version must be unique with in a domain.
version (string) –
The version of the workflow type.
Note
The combination of workflow type name and version must be unique with in a domain.
startTimestamp (datetime) –
The time when the execution was started.
closeTimestamp (datetime) –
The time when the workflow execution was closed. Set only if the execution status is CLOSED.
executionStatus (string) –
The current status of the execution.
closeStatus (string) –
If the execution status is closed then this specifies how the execution was closed:
COMPLETED
– the execution was successfully completed.CANCELED
– the execution was canceled.Cancellation allows the implementation to gracefully clean up before the execution is closed.TERMINATED
– the execution was force terminated.FAILED
– the execution failed to complete.TIMED_OUT
– the execution did not complete in the alloted time and was automatically timed out.CONTINUED_AS_NEW
– the execution is logically continued. This means the current execution was completed and a new execution was started to carry on the workflow.
parent (dict) –
If this workflow execution is a child of another execution then contains the workflow execution that started this execution.
workflowId (string) –
The user defined identifier associated with the workflow execution.
runId (string) –
A system-generated unique identifier for the workflow execution.
tagList (list) –
The list of tags associated with the workflow execution. Tags can be used to identify and list workflow executions of interest through the visibility APIs. A workflow execution can have a maximum of 5 tags.
(string) –
cancelRequested (boolean) –
Set to true if a cancellation is requested for this workflow execution.
NextToken (string) –
A token to resume pagination.