SFN¶
Client¶
- class SFN.Client¶
A low-level client representing AWS Step Functions (SFN)
With Step Functions, you can create workflows, also called state machines, to build distributed applications, automate processes, orchestrate microservices, and create data and machine learning pipelines.
Through the Step Functions API, you can create, list, update, and delete state machines, activities, and other data types. You can start, stop, and redrive your state machines. Your activity workers can send task success, heartbeat, and failure responses.
With API calls, you can also manage other aspects of your workflow, such as tags, versions, and aliases.
For more information about developing solutions with Step Functions, see the Step Functions Developer Guide .
Warning
If you use the Step Functions API actions using Amazon Web Services SDK integrations, make sure the API actions are in camel case and parameter names are in Pascal case. For example, you might use Step Functions API action
startSyncExecutionand specify its parameter asStateMachineArn.import boto3 client = boto3.client('stepfunctions')
These are the available methods:
- can_paginate
- close
- create_activity
- create_state_machine
- create_state_machine_alias
- delete_activity
- delete_state_machine
- delete_state_machine_alias
- delete_state_machine_version
- describe_activity
- describe_execution
- describe_map_run
- describe_state_machine
- describe_state_machine_alias
- describe_state_machine_for_execution
- get_activity_task
- get_execution_history
- get_paginator
- get_waiter
- list_activities
- list_executions
- list_map_runs
- list_state_machine_aliases
- list_state_machine_versions
- list_state_machines
- list_tags_for_resource
- publish_state_machine_version
- redrive_execution
- send_task_failure
- send_task_heartbeat
- send_task_success
- start_execution
- start_sync_execution
- stop_execution
- tag_resource
- test_state
- untag_resource
- update_map_run
- update_state_machine
- update_state_machine_alias
- validate_state_machine_definition
Paginators¶
Paginators are available on a client instance via the get_paginator method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide.
The available paginators are: