Enhanced, asyncio-compatible client for AWS Step Functions.
Project description
sfn_workflow_client
Enhanced, asyncio-compatible client for AWS Step Functions.
Features:
- Trigger new executions
- Query for state machine execution status
- Wait for an execution to complete
- Fetch execution history
Table of Contents:
Installation
sfn_workflow_client requires Python 3.6 or above.
pip install sfn_workflow_client
Guide
from sfn_workflow_client.enums import ExecutionStatus
from sfn_workflow_client.workflow import Workflow
# Initialize a workflow client
workflow = Workflow("my-state-machine")
# Fetch all executions
collection = await workflow.executions.fetch()
# Fetch currently running executions
collection = await workflow.executions.fetch(status=ExecutionStatus.running)
# Start a new execution
execution = await workflow.executions.create().start()
# Start a new execution and wait until it completes (useful for tests)
execution = await workflow.executions.start_sync()
# Find an execution by trace ID (for tests)
execution = await workflow.executions.fetch().find_by_trace_id("abc")
# Fetch the event history of an execution
events = await execution.events.fetch()
Development
To develop sfn_workflow_client, install dependencies and enable the pre-commit hook:
pip install pre-commit tox
pre-commit install
To run functional tests, you need to create an AWS IAM role with permissions to:
- Create/update/delete state machines
- Start/stop executions
Set the following environment variables:
AWS_ACCOUNT_ID
AWS_ACCESS_KEY_ID
AWS_SECRET_ACCESS_KEY
AWS_DEFAULT_REGION
AWS_IAM_ROLE_ARN
To run tests:
tox
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
sfn_workflow_client-1.1.0.tar.gz
(11.1 kB
view hashes)
Built Distribution
Close
Hashes for sfn_workflow_client-1.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d379daf6097d94171364e318e182bd04488f332d1e3ed436b844ae41ecb505bb |
|
MD5 | a64017852d0b2e35d9296df4134a392e |
|
BLAKE2b-256 | 95b393bae5586f1c43c566b9ea0226bbfb045464cbce26fa98fc9cb36f5a50d9 |
Close
Hashes for sfn_workflow_client-1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c818f6187a2683bba8b09d1848d65d3f78b434e2edc9cb5dc12f7bc09abff86d |
|
MD5 | 4a86d0090b874611dcbe8f4c9b7d9b5d |
|
BLAKE2b-256 | 8d5bd89d3bc850361a44f9f1e35b0ee723fe28f86542d3958ff081b06f4eae65 |