SFN#
Client#
- class SFN.Client#
A low-level client representing AWS Step Functions (SFN)
Step Functions coordinates the components of distributed applications and microservices using visual workflows.
You can use Step Functions to build applications from individual components, each of which performs a discrete function, or task, allowing you to scale and change applications quickly. Step Functions provides a console that helps visualize the components of your application as a series of steps. Step Functions automatically triggers and tracks each step, and retries steps when there are errors, so your application executes predictably and in the right order every time. Step Functions logs the state of each step, so you can quickly diagnose and debug any issues.
Step Functions manages operations and underlying infrastructure to ensure your application is available at any scale. You can run tasks on Amazon Web Services, your own servers, or any system that has access to Amazon Web Services. You can access and use Step Functions using the console, the Amazon Web Services SDKs, or an HTTP API. For more information about 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 could use Step Functions API action
startSyncExecutionand specify its parameter asStateMachineArn.client = session.create_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
Client Exceptions#
Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
- ActivityAlreadyExists
- ActivityDoesNotExist
- ActivityLimitExceeded
- ActivityWorkerLimitExceeded
- ConflictException
- ExecutionAlreadyExists
- ExecutionDoesNotExist
- ExecutionLimitExceeded
- ExecutionNotRedrivable
- InvalidArn
- InvalidDefinition
- InvalidEncryptionConfiguration
- InvalidExecutionInput
- InvalidLoggingConfiguration
- InvalidName
- InvalidOutput
- InvalidToken
- InvalidTracingConfiguration
- KmsAccessDeniedException
- KmsInvalidStateException
- KmsThrottlingException
- MissingRequiredParameter
- ResourceNotFound
- ServiceQuotaExceededException
- StateMachineAlreadyExists
- StateMachineDeleting
- StateMachineDoesNotExist
- StateMachineLimitExceeded
- StateMachineTypeNotSupported
- TaskDoesNotExist
- TaskTimedOut
- TooManyTags
- ValidationException
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: