SFNClient
Auto-generated documentation for SFN type annotations stubs module mypy-boto3-stepfunctions.
SFNClient
Type annotations and code completion for boto3.client("stepfunctions")
.
boto3 documentation
from boto3.session import Session
from mypy_boto3_stepfunctions.client import SFNClient
def get_stepfunctions_client() -> SFNClient:
return Session().client("stepfunctions")
Exceptions
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("stepfunctions").exceptions
structure.
client = boto3.client("stepfunctions")
try:
do_something(client)
except (
client.ActivityDoesNotExist,
client.ActivityLimitExceeded,
client.ActivityWorkerLimitExceeded,
client.ClientError,
client.ExecutionAlreadyExists,
client.ExecutionDoesNotExist,
client.ExecutionLimitExceeded,
client.InvalidArn,
client.InvalidDefinition,
client.InvalidExecutionInput,
client.InvalidLoggingConfiguration,
client.InvalidName,
client.InvalidOutput,
client.InvalidToken,
client.InvalidTracingConfiguration,
client.MissingRequiredParameter,
client.ResourceNotFound,
client.StateMachineAlreadyExists,
client.StateMachineDeleting,
client.StateMachineDoesNotExist,
client.StateMachineLimitExceeded,
client.StateMachineTypeNotSupported,
client.TaskDoesNotExist,
client.TaskTimedOut,
client.TooManyTags,
client.ValidationException,
) as e:
print(e)
from mypy_boto3_stepfunctions.client import Exceptions
def handle_error(exc: Exceptions.ActivityDoesNotExist) -> None:
...
Methods
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("stepfunctions").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("stepfunctions").close
method.
boto3 documentation
create_activity
Creates an activity.
Type annotations and code completion for boto3.client("stepfunctions").create_activity
method.
boto3 documentation
def create_activity(
self,
*,
name: str,
tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateActivityOutputTypeDef: # (2)
...
kwargs: CreateActivityInputRequestTypeDef = { # (1)
"name": ...,
}
parent.create_activity(**kwargs)
create_state_machine
Creates a state machine.
Type annotations and code completion for boto3.client("stepfunctions").create_state_machine
method.
boto3 documentation
def create_state_machine(
self,
*,
name: str,
definition: str,
roleArn: str,
type: StateMachineTypeType = ..., # (1)
loggingConfiguration: LoggingConfigurationTypeDef = ..., # (2)
tags: Sequence[TagTypeDef] = ..., # (3)
tracingConfiguration: TracingConfigurationTypeDef = ..., # (4)
) -> CreateStateMachineOutputTypeDef: # (5)
...
- See StateMachineTypeType
- See LoggingConfigurationTypeDef
- See TagTypeDef
- See TracingConfigurationTypeDef
- See CreateStateMachineOutputTypeDef
kwargs: CreateStateMachineInputRequestTypeDef = { # (1)
"name": ...,
"definition": ...,
"roleArn": ...,
}
parent.create_state_machine(**kwargs)
delete_activity
Deletes an activity.
Type annotations and code completion for boto3.client("stepfunctions").delete_activity
method.
boto3 documentation
kwargs: DeleteActivityInputRequestTypeDef = { # (1)
"activityArn": ...,
}
parent.delete_activity(**kwargs)
delete_state_machine
Deletes a state machine.
Type annotations and code completion for boto3.client("stepfunctions").delete_state_machine
method.
boto3 documentation
kwargs: DeleteStateMachineInputRequestTypeDef = { # (1)
"stateMachineArn": ...,
}
parent.delete_state_machine(**kwargs)
describe_activity
Describes an activity.
Type annotations and code completion for boto3.client("stepfunctions").describe_activity
method.
boto3 documentation
def describe_activity(
self,
*,
activityArn: str,
) -> DescribeActivityOutputTypeDef: # (1)
...
kwargs: DescribeActivityInputRequestTypeDef = { # (1)
"activityArn": ...,
}
parent.describe_activity(**kwargs)
describe_execution
Provides all information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata.
Type annotations and code completion for boto3.client("stepfunctions").describe_execution
method.
boto3 documentation
def describe_execution(
self,
*,
executionArn: str,
) -> DescribeExecutionOutputTypeDef: # (1)
...
kwargs: DescribeExecutionInputRequestTypeDef = { # (1)
"executionArn": ...,
}
parent.describe_execution(**kwargs)
describe_map_run
Provides information about a Map Run's configuration, progress, and results.
Type annotations and code completion for boto3.client("stepfunctions").describe_map_run
method.
boto3 documentation
def describe_map_run(
self,
*,
mapRunArn: str,
) -> DescribeMapRunOutputTypeDef: # (1)
...
kwargs: DescribeMapRunInputRequestTypeDef = { # (1)
"mapRunArn": ...,
}
parent.describe_map_run(**kwargs)
describe_state_machine
Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration.
Type annotations and code completion for boto3.client("stepfunctions").describe_state_machine
method.
boto3 documentation
def describe_state_machine(
self,
*,
stateMachineArn: str,
) -> DescribeStateMachineOutputTypeDef: # (1)
...
kwargs: DescribeStateMachineInputRequestTypeDef = { # (1)
"stateMachineArn": ...,
}
parent.describe_state_machine(**kwargs)
describe_state_machine_for_execution
Provides information about a state machine's definition, its execution role ARN, and configuration.
Type annotations and code completion for boto3.client("stepfunctions").describe_state_machine_for_execution
method.
boto3 documentation
def describe_state_machine_for_execution(
self,
*,
executionArn: str,
) -> DescribeStateMachineForExecutionOutputTypeDef: # (1)
...
kwargs: DescribeStateMachineForExecutionInputRequestTypeDef = { # (1)
"executionArn": ...,
}
parent.describe_state_machine_for_execution(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("stepfunctions").generate_presigned_url
method.
boto3 documentation
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_activity_task
Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a running state machine.
Type annotations and code completion for boto3.client("stepfunctions").get_activity_task
method.
boto3 documentation
def get_activity_task(
self,
*,
activityArn: str,
workerName: str = ...,
) -> GetActivityTaskOutputTypeDef: # (1)
...
kwargs: GetActivityTaskInputRequestTypeDef = { # (1)
"activityArn": ...,
}
parent.get_activity_task(**kwargs)
get_execution_history
Returns the history of the specified execution as a list of events.
Type annotations and code completion for boto3.client("stepfunctions").get_execution_history
method.
boto3 documentation
def get_execution_history(
self,
*,
executionArn: str,
maxResults: int = ...,
reverseOrder: bool = ...,
nextToken: str = ...,
includeExecutionData: bool = ...,
) -> GetExecutionHistoryOutputTypeDef: # (1)
...
kwargs: GetExecutionHistoryInputRequestTypeDef = { # (1)
"executionArn": ...,
}
parent.get_execution_history(**kwargs)
list_activities
Lists the existing activities.
Type annotations and code completion for boto3.client("stepfunctions").list_activities
method.
boto3 documentation
def list_activities(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListActivitiesOutputTypeDef: # (1)
...
kwargs: ListActivitiesInputRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_activities(**kwargs)
list_executions
Lists all executions of a state machine or a Map Run.
Type annotations and code completion for boto3.client("stepfunctions").list_executions
method.
boto3 documentation
def list_executions(
self,
*,
stateMachineArn: str = ...,
statusFilter: ExecutionStatusType = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
mapRunArn: str = ...,
) -> ListExecutionsOutputTypeDef: # (2)
...
kwargs: ListExecutionsInputRequestTypeDef = { # (1)
"stateMachineArn": ...,
}
parent.list_executions(**kwargs)
list_map_runs
Lists all Map Runs that were started by a given state machine execution.
Type annotations and code completion for boto3.client("stepfunctions").list_map_runs
method.
boto3 documentation
def list_map_runs(
self,
*,
executionArn: str,
maxResults: int = ...,
nextToken: str = ...,
) -> ListMapRunsOutputTypeDef: # (1)
...
kwargs: ListMapRunsInputRequestTypeDef = { # (1)
"executionArn": ...,
}
parent.list_map_runs(**kwargs)
list_state_machines
Lists the existing state machines.
Type annotations and code completion for boto3.client("stepfunctions").list_state_machines
method.
boto3 documentation
def list_state_machines(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListStateMachinesOutputTypeDef: # (1)
...
kwargs: ListStateMachinesInputRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_state_machines(**kwargs)
list_tags_for_resource
List tags for a given resource.
Type annotations and code completion for boto3.client("stepfunctions").list_tags_for_resource
method.
boto3 documentation
def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceOutputTypeDef: # (1)
...
kwargs: ListTagsForResourceInputRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
send_task_failure
Used by activity workers and task states using the
callback_ pattern to report that the task identified by
the taskToken
failed.
Type annotations and code completion for boto3.client("stepfunctions").send_task_failure
method.
boto3 documentation
def send_task_failure(
self,
*,
taskToken: str,
error: str = ...,
cause: str = ...,
) -> Dict[str, Any]:
...
kwargs: SendTaskFailureInputRequestTypeDef = { # (1)
"taskToken": ...,
}
parent.send_task_failure(**kwargs)
send_task_heartbeat
Used by activity workers and task states using the
callback_ pattern to report to Step Functions that the
task represented by the specified taskToken
is still making progress.
Type annotations and code completion for boto3.client("stepfunctions").send_task_heartbeat
method.
boto3 documentation
kwargs: SendTaskHeartbeatInputRequestTypeDef = { # (1)
"taskToken": ...,
}
parent.send_task_heartbeat(**kwargs)
send_task_success
Used by activity workers and task states using the
callback_ pattern to report that the task identified by
the taskToken
completed successfully.
Type annotations and code completion for boto3.client("stepfunctions").send_task_success
method.
boto3 documentation
def send_task_success(
self,
*,
taskToken: str,
output: str,
) -> Dict[str, Any]:
...
kwargs: SendTaskSuccessInputRequestTypeDef = { # (1)
"taskToken": ...,
"output": ...,
}
parent.send_task_success(**kwargs)
start_execution
Starts a state machine execution.
Type annotations and code completion for boto3.client("stepfunctions").start_execution
method.
boto3 documentation
def start_execution(
self,
*,
stateMachineArn: str,
name: str = ...,
input: str = ...,
traceHeader: str = ...,
) -> StartExecutionOutputTypeDef: # (1)
...
kwargs: StartExecutionInputRequestTypeDef = { # (1)
"stateMachineArn": ...,
}
parent.start_execution(**kwargs)
start_sync_execution
Starts a Synchronous Express state machine execution.
Type annotations and code completion for boto3.client("stepfunctions").start_sync_execution
method.
boto3 documentation
def start_sync_execution(
self,
*,
stateMachineArn: str,
name: str = ...,
input: str = ...,
traceHeader: str = ...,
) -> StartSyncExecutionOutputTypeDef: # (1)
...
kwargs: StartSyncExecutionInputRequestTypeDef = { # (1)
"stateMachineArn": ...,
}
parent.start_sync_execution(**kwargs)
stop_execution
Stops an execution.
Type annotations and code completion for boto3.client("stepfunctions").stop_execution
method.
boto3 documentation
def stop_execution(
self,
*,
executionArn: str,
error: str = ...,
cause: str = ...,
) -> StopExecutionOutputTypeDef: # (1)
...
kwargs: StopExecutionInputRequestTypeDef = { # (1)
"executionArn": ...,
}
parent.stop_execution(**kwargs)
tag_resource
Add a tag to a Step Functions resource.
Type annotations and code completion for boto3.client("stepfunctions").tag_resource
method.
boto3 documentation
def tag_resource(
self,
*,
resourceArn: str,
tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
kwargs: TagResourceInputRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Remove a tag from a Step Functions resource See also: AWS API Documentation.
Type annotations and code completion for boto3.client("stepfunctions").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceInputRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
update_map_run
Updates an in-progress Map Run's configuration to include changes to the settings that control maximum concurrency and Map Run failure.
Type annotations and code completion for boto3.client("stepfunctions").update_map_run
method.
boto3 documentation
def update_map_run(
self,
*,
mapRunArn: str,
maxConcurrency: int = ...,
toleratedFailurePercentage: float = ...,
toleratedFailureCount: int = ...,
) -> Dict[str, Any]:
...
kwargs: UpdateMapRunInputRequestTypeDef = { # (1)
"mapRunArn": ...,
}
parent.update_map_run(**kwargs)
update_state_machine
Updates an existing state machine by modifying its definition
, roleArn
, or
loggingConfiguration
.
Type annotations and code completion for boto3.client("stepfunctions").update_state_machine
method.
boto3 documentation
def update_state_machine(
self,
*,
stateMachineArn: str,
definition: str = ...,
roleArn: str = ...,
loggingConfiguration: LoggingConfigurationTypeDef = ..., # (1)
tracingConfiguration: TracingConfigurationTypeDef = ..., # (2)
) -> UpdateStateMachineOutputTypeDef: # (3)
...
kwargs: UpdateStateMachineInputRequestTypeDef = { # (1)
"stateMachineArn": ...,
}
parent.update_state_machine(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("stepfunctions").get_paginator
method with overloads.
client.get_paginator("get_execution_history")
-> GetExecutionHistoryPaginatorclient.get_paginator("list_activities")
-> ListActivitiesPaginatorclient.get_paginator("list_executions")
-> ListExecutionsPaginatorclient.get_paginator("list_map_runs")
-> ListMapRunsPaginatorclient.get_paginator("list_state_machines")
-> ListStateMachinesPaginator