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-0.4.0.tar.gz
(11.7 kB
view hashes)
Built Distribution
Close
Hashes for sfn_workflow_client-0.4.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5c8b03e0f8bd4da60f1145abcec05c43d680ee870c4ec7254fa9f33273b62aaf |
|
MD5 | 1f17245a0f0d51d7bce7e55178960141 |
|
BLAKE2b-256 | 76a43251b032c281bbe2b766cfa3b5a9830655d65dfa80a5a630504ad5eb1639 |
Close
Hashes for sfn_workflow_client-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9e76456c1ae7d8354ee087efaf746fe31b351a3800eb0b02598be26727c034b8 |
|
MD5 | a3a9ea8d1cf96da27c287ee4fa49ed94 |
|
BLAKE2b-256 | 54f36128eb8fdc136ad17cbe1f0a29a4858c550ed936902aca23d8108240744e |