Execution

class flow_api.execution.Execution(select=None, init=None, by=id, **kwargs)

Base class: Identity

The Execution class represents an execution (flow, connection, or script). Functions from the execution class can be applied on execution objects. Execution objects are created by the following functions from the Cloudomation class: flow(), connect(), script(). It provides functions to set input parameters, run, and get information about the execution.

Do not create execution objects directly, but using System.execution

See the corresponding Resources class at Execution

Parameters

Name	Type	Description
**kwargs
by
init
select		The ID of the execution object this instance operates on

Constants

RESOURCE = execution

Methods

add_role (role, propagate=True)

add_tag (tag)

archive ()

archive_process ()

cancel (message=None)

cancel_process (message=None)

child (name=None, run=True, wait=True, init=None, input_value=None, protect_inputs=None, protect_outputs=None, metadata=None, remote_workspace_name=None, roles=None, orphan=False, unwrapped=False, **kwargs)

clone (init=None, name=None, run=True, wait=True, input_value=None, protect_inputs=None, protect_outputs=None, **kwargs)

connect (connector_name=None, connector_type=None, name=None, run=True, wait=True, init=None, input_value=None, protect_inputs=None, protect_outputs=None, metadata=None, remote_workspace_name=None, roles=None, orphan=False, unwrapped=False, **kwargs)

create_dump (name)

create_savepoint (name)

delete (permanently=False)

delete_process ()

dependency (*args, return_when=ALL_SUCCEEDED, unpause=False, timeout_sec=None)

end (end_status, message='end status set by script')

error (message='error set by script')

exists ()

export ()

flow (flow_name, name=None, run=True, wait=True, init=None, input_value=None, protect_inputs=None, protect_outputs=None, metadata=None, remote_workspace_name=None, roles=None, flow_by='name', orphan=False, unwrapped=False, **kwargs)

get (*fields, default=None)

get_dict (*fields, default=None)

get_identity_created_by ()

get_identity_modified_by ()

get_roles (limit=1000, offset=0, order=None)

get_tags (limit=1000, offset=0, order=None)

ignore (type_=None)

ignore_dependency ()

ignore_lock ()

ignore_response ()

ignore_scheduled ()

load (*fields)

load_dump (id_, by='id')

load_savepoint (id_, by='id')

lock (setting, wait_timeout=60)

log (*args, **kwargs)

message (wait=True, wait_timeout=None, **kwargs)

parent ()

pause (message=None)

pause_process (message=None)

release_lock (setting)

remove_role (role)

remove_savepoints ()

remove_tag (tag)

restore ()

roles (*args, **kwargs)

run (*args, return_when=ALL_SUCCEEDED, wait=True, timeout_sec=None)

run_async (*args, wait_for=None, return_when=ALL_SUCCEEDED)

run_process (*args, return_when=ALL_SUCCEEDED, wait=True, timeout_sec=None)

save (update=None, **kwargs)

schedule (scheduled_for, message=None)

script (script, name=None, run=True, wait=True, init=None, input_value=None, protect_inputs=None, protect_outputs=None, metadata=None, remote_workspace_name=None, roles=None, orphan=False, **kwargs)

set (key, value)

set_output (key=None, value=None, **kwargs)

sleep (delay_sec, message=None)

sleep_until (sleep_until)

success (message='done')

task (connector_type, **kwargs)

using (wrapper_name, **wrapper_kwargs)

wait (return_when=ALL_SUCCEEDED, timeout_sec=None)

wait_for (*args, return_when=ALL_SUCCEEDED, timeout_sec=None)

wait_lock (setting, wait_timeout=60)

wait_status (execution, status, timeout=60)

webhook_html_response (body=None, message='done')

webhook_json_response (body=None, message='done')

webhook_response (status=200, headers=None, body=None, message='done')