Skip to content

Commit bb06bfb

Browse files
Fix definition parameter to State or Chain (#47)
1 parent 9826214 commit bb06bfb

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

Diff for: src/stepfunctions/workflow/stepfunctions.py

+4-3
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ def __init__(self, name, definition, role, tags=[], execution_input=None, timeou
152152
* wildcard characters ? *
153153
* special characters " # % \\ ^ | ~ ` $ & , ; : /
154154
* control characters (U+0000-001F , U+007F-009F )
155-
definition (str): The `Amazon States Language <https://states-language.net/spec.html>`_ definition of the workflow.
155+
definition (State or Chain): The `Amazon States Language <https://states-language.net/spec.html>`_ definition of the workflow.
156156
role (str): The Amazon Resource Name (ARN) of the IAM role to use for creating, managing, and running the workflow.
157157
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: [])
158158
execution_input (ExecutionInput, optional): Placeholder collection that defines the placeholder variables for the workflow execution. \
@@ -223,8 +223,9 @@ def update(self, definition=None, role=None):
223223
"""
224224
Updates an existing state machine by modifying its definition and/or role. Executions started immediately after calling this method may use the previous definition and role.
225225
226-
definition (str, optional): The `Amazon States Language <https://states-language.net/spec.html>`_ definition to update the workflow with. (default: None)
227-
role (str, optional): The Amazon Resource Name (ARN) of the IAM role to use for creating, managing, and running the workflow. (default: None)
226+
Args:
227+
definition (State or Chain, optional): The `Amazon States Language <https://states-language.net/spec.html>`_ definition to update the workflow with. (default: None)
228+
role (str, optional): The Amazon Resource Name (ARN) of the IAM role to use for creating, managing, and running the workflow. (default: None)
228229
229230
Returns:
230231
str: The state machine definition and/or role updated. If the update fails, None will be returned.

0 commit comments

Comments
 (0)