Execution

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

Base class: Identity

The Execution class represents an execution (flow, task, 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, task, 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

:py:obj:resources.execution.Execution

Parameters

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

Constants

RESOURCE = execution

Methods

archive ()

cancel (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, vault_secrets=None, roles=None, **kwargs)

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

connect (connection_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, **kwargs)

create_dump (name)

delete ()

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 ()

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, **kwargs)

get (*fields, default=None)

get_dict (*fields, default=None)

get_identity_created_by ()

get_identity_modified_by ()

load (*fields)

load_dump (id_, by='id')

lock (setting, wait_timeout=60)

log (*args, **kwargs)

pause (message=None)

release_lock (setting)

roles ()

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

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

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, **kwargs)

set (key, value)

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

sleep (delay_sec, message=None)

sleep_until (sleep_until)

success (message='done')

task (connection_type, name=None, run=True, wait=True, init=None, input_value=None, protect_inputs=None, protect_outputs=None, metadata=None, remote_workspace_name=None, vault_secrets=None, roles=None, **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')

Connection

File