def __init__(self,
workflow,
execution_arn,
start_date,
status,
client=None,
name=None,
stop_date=None):
"""
Args:
workflow (Workflow): Step Functions workflow instance.
execution_arn (str): The Amazon Resource Name (ARN) of the workflow execution.
start_date (datetime.datetime): The date the workflow execution was started.
status (RunStatus): Status of the workflow execution.
client (SFN.Client, optional): boto3 client to use for running and managing the workflow executions on Step Functions. If no client is provided, the boto3 client from the parent workflow will be used. (default: None)
name (str, optional): Name for the workflow execution. (default: None)
stop_date (datetime.datetime, optional): The date the workflow execution was stopped, if applicable. (default: None)
"""
self.name = name
self.workflow = workflow
self.execution_arn = execution_arn
self.start_date = start_date
self.stop_date = stop_date
self.status = status
if client:
self.client = client
append_user_agent_to_client(self.client)
else:
self.client = self.workflow.client
def __init__(self,
name,
definition,
role,
tags=[],
execution_input=None,
timeout_seconds=None,
comment=None,
version=None,
state_machine_arn=None,
format_json=True,
client=None):
"""
Args:
name (str): The name of the workflow. A name must not contain:
* whitespace
* brackets < > { } [ ]
* wildcard characters ? *
* special characters " # % \\ ^ | ~ ` $ & , ; : /
* control characters (U+0000-001F , U+007F-009F )
definition (str): The `Amazon States Language <https://states-language.net/spec.html>`_ definition of the workflow.
role (str): The Amazon Resource Name (ARN) of the IAM role to use for creating, managing, and running the workflow.
tags (list): Tags to be added when creating a workflow. Tags are key-value pairs that can be associated with Step Functions workflows and activities. (default: [])
execution_input (ExecutionInput, optional): Placeholder collection that defines the placeholder variables for the workflow execution. \
This is also used to validate inputs provided when executing the workflow. (default: None)
timeout_seconds (int, optional): The maximum number of seconds an execution of the workflow can run. If it runs longer than the specified time, the workflow run fails with a `States.Timeout` Error Name. (default: None)
comment (str, optional): A human-readable description of the workflow. (default: None)
version (str, optional): The version of the Amazon States Language used in the workflow. (default: None)
state_machine_arn (str, optional): The Amazon Resource Name (ARN) of the workflow. (default: None)
format_json (bool, optional): Boolean flag set to `True` if workflow definition and execution inputs should be prettified for this workflow. `False`, otherwise. (default: True)
client (SFN.Client, optional): boto3 client to use for creating, managing, and running the workflow on Step Functions. If not provided, a default boto3 client for Step Functions will be automatically created and used. (default: None)
"""
self.timeout_seconds = timeout_seconds
self.comment = comment
self.version = version
if isinstance(definition, Graph):
self.definition = definition
else:
self.definition = Graph(definition,
timeout_seconds=self.timeout_seconds,
comment=self.comment,
version=self.version)
self.name = name
self.role = role
self.tags = tags
self.workflow_input = execution_input
if client:
self.client = client
else:
self.client = boto3.client('stepfunctions')
append_user_agent_to_client(self.client)
self.format_json = format_json
self.state_machine_arn = state_machine_arn
def test_append_user_agent_to_client(client):
append_user_agent_to_client(client)
user_agent_suffix = client._client_config.user_agent.split()[-1]
assert user_agent_suffix == "helloworld/9.8.7"