Skip to content

SFNClient#

Index > SFN > 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

# SFNClient usage example

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.

# Exceptions.exceptions usage example

client = boto3.client("stepfunctions")

try:
    do_something(client)
except (
    client.exceptions.ActivityDoesNotExist,
    client.exceptions.ActivityLimitExceeded,
    client.exceptions.ActivityWorkerLimitExceeded,
    client.exceptions.ClientError,
    client.exceptions.ExecutionAlreadyExists,
    client.exceptions.ExecutionDoesNotExist,
    client.exceptions.ExecutionLimitExceeded,
    client.exceptions.InvalidArn,
    client.exceptions.InvalidDefinition,
    client.exceptions.InvalidExecutionInput,
    client.exceptions.InvalidLoggingConfiguration,
    client.exceptions.InvalidName,
    client.exceptions.InvalidOutput,
    client.exceptions.InvalidToken,
    client.exceptions.InvalidTracingConfiguration,
    client.exceptions.MissingRequiredParameter,
    client.exceptions.ResourceNotFound,
    client.exceptions.StateMachineAlreadyExists,
    client.exceptions.StateMachineDeleting,
    client.exceptions.StateMachineDoesNotExist,
    client.exceptions.StateMachineLimitExceeded,
    client.exceptions.StateMachineTypeNotSupported,
    client.exceptions.TaskDoesNotExist,
    client.exceptions.TaskTimedOut,
    client.exceptions.TooManyTags,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

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

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("stepfunctions").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_activity#

Creates an activity.

Type annotations and code completion for boto3.client("stepfunctions").create_activity method. boto3 documentation

# create_activity method definition

def create_activity(
    self,
    *,
    name: str,
    tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateActivityOutputTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateActivityOutputTypeDef 
# create_activity method usage example with argument unpacking

kwargs: CreateActivityInputRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_activity(**kwargs)
  1. See CreateActivityInputRequestTypeDef

create_state_machine#

Creates a state machine.

Type annotations and code completion for boto3.client("stepfunctions").create_state_machine method. boto3 documentation

# create_state_machine method definition

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)
    ...
  1. See StateMachineTypeType
  2. See LoggingConfigurationTypeDef
  3. See TagTypeDef
  4. See TracingConfigurationTypeDef
  5. See CreateStateMachineOutputTypeDef 
# create_state_machine method usage example with argument unpacking

kwargs: CreateStateMachineInputRequestTypeDef = {  # (1)
    "name": ...,
    "definition": ...,
    "roleArn": ...,
}

parent.create_state_machine(**kwargs)
  1. See CreateStateMachineInputRequestTypeDef

delete_activity#

Deletes an activity.

Type annotations and code completion for boto3.client("stepfunctions").delete_activity method. boto3 documentation

# delete_activity method definition

def delete_activity(
    self,
    *,
    activityArn: str,
) -> Dict[str, Any]:
    ...
# delete_activity method usage example with argument unpacking

kwargs: DeleteActivityInputRequestTypeDef = {  # (1)
    "activityArn": ...,
}

parent.delete_activity(**kwargs)
  1. See DeleteActivityInputRequestTypeDef

delete_state_machine#

Deletes a state machine.

Type annotations and code completion for boto3.client("stepfunctions").delete_state_machine method. boto3 documentation

# delete_state_machine method definition

def delete_state_machine(
    self,
    *,
    stateMachineArn: str,
) -> Dict[str, Any]:
    ...
# delete_state_machine method usage example with argument unpacking

kwargs: DeleteStateMachineInputRequestTypeDef = {  # (1)
    "stateMachineArn": ...,
}

parent.delete_state_machine(**kwargs)
  1. See DeleteStateMachineInputRequestTypeDef

describe_activity#

Describes an activity.

Type annotations and code completion for boto3.client("stepfunctions").describe_activity method. boto3 documentation

# describe_activity method definition

def describe_activity(
    self,
    *,
    activityArn: str,
) -> DescribeActivityOutputTypeDef:  # (1)
    ...
  1. See DescribeActivityOutputTypeDef 
# describe_activity method usage example with argument unpacking

kwargs: DescribeActivityInputRequestTypeDef = {  # (1)
    "activityArn": ...,
}

parent.describe_activity(**kwargs)
  1. See DescribeActivityInputRequestTypeDef

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

# describe_execution method definition

def describe_execution(
    self,
    *,
    executionArn: str,
) -> DescribeExecutionOutputTypeDef:  # (1)
    ...
  1. See DescribeExecutionOutputTypeDef 
# describe_execution method usage example with argument unpacking

kwargs: DescribeExecutionInputRequestTypeDef = {  # (1)
    "executionArn": ...,
}

parent.describe_execution(**kwargs)
  1. See DescribeExecutionInputRequestTypeDef

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

# describe_map_run method definition

def describe_map_run(
    self,
    *,
    mapRunArn: str,
) -> DescribeMapRunOutputTypeDef:  # (1)
    ...
  1. See DescribeMapRunOutputTypeDef 
# describe_map_run method usage example with argument unpacking

kwargs: DescribeMapRunInputRequestTypeDef = {  # (1)
    "mapRunArn": ...,
}

parent.describe_map_run(**kwargs)
  1. See DescribeMapRunInputRequestTypeDef

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

# describe_state_machine method definition

def describe_state_machine(
    self,
    *,
    stateMachineArn: str,
) -> DescribeStateMachineOutputTypeDef:  # (1)
    ...
  1. See DescribeStateMachineOutputTypeDef 
# describe_state_machine method usage example with argument unpacking

kwargs: DescribeStateMachineInputRequestTypeDef = {  # (1)
    "stateMachineArn": ...,
}

parent.describe_state_machine(**kwargs)
  1. See DescribeStateMachineInputRequestTypeDef

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

# describe_state_machine_for_execution method definition

def describe_state_machine_for_execution(
    self,
    *,
    executionArn: str,
) -> DescribeStateMachineForExecutionOutputTypeDef:  # (1)
    ...
  1. See DescribeStateMachineForExecutionOutputTypeDef 
# describe_state_machine_for_execution method usage example with argument unpacking

kwargs: DescribeStateMachineForExecutionInputRequestTypeDef = {  # (1)
    "executionArn": ...,
}

parent.describe_state_machine_for_execution(**kwargs)
  1. See DescribeStateMachineForExecutionInputRequestTypeDef

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

# generate_presigned_url method definition

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

# get_activity_task method definition

def get_activity_task(
    self,
    *,
    activityArn: str,
    workerName: str = ...,
) -> GetActivityTaskOutputTypeDef:  # (1)
    ...
  1. See GetActivityTaskOutputTypeDef 
# get_activity_task method usage example with argument unpacking

kwargs: GetActivityTaskInputRequestTypeDef = {  # (1)
    "activityArn": ...,
}

parent.get_activity_task(**kwargs)
  1. See GetActivityTaskInputRequestTypeDef

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

# get_execution_history method definition

def get_execution_history(
    self,
    *,
    executionArn: str,
    maxResults: int = ...,
    reverseOrder: bool = ...,
    nextToken: str = ...,
    includeExecutionData: bool = ...,
) -> GetExecutionHistoryOutputTypeDef:  # (1)
    ...
  1. See GetExecutionHistoryOutputTypeDef 
# get_execution_history method usage example with argument unpacking

kwargs: GetExecutionHistoryInputRequestTypeDef = {  # (1)
    "executionArn": ...,
}

parent.get_execution_history(**kwargs)
  1. See GetExecutionHistoryInputRequestTypeDef

list_activities#

Lists the existing activities.

Type annotations and code completion for boto3.client("stepfunctions").list_activities method. boto3 documentation

# list_activities method definition

def list_activities(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListActivitiesOutputTypeDef:  # (1)
    ...
  1. See ListActivitiesOutputTypeDef 
# list_activities method usage example with argument unpacking

kwargs: ListActivitiesInputRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_activities(**kwargs)
  1. See ListActivitiesInputRequestTypeDef

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

# list_executions method definition

def list_executions(
    self,
    *,
    stateMachineArn: str = ...,
    statusFilter: ExecutionStatusType = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
    mapRunArn: str = ...,
) -> ListExecutionsOutputTypeDef:  # (2)
    ...
  1. See ExecutionStatusType
  2. See ListExecutionsOutputTypeDef 
# list_executions method usage example with argument unpacking

kwargs: ListExecutionsInputRequestTypeDef = {  # (1)
    "stateMachineArn": ...,
}

parent.list_executions(**kwargs)
  1. See ListExecutionsInputRequestTypeDef

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

# list_map_runs method definition

def list_map_runs(
    self,
    *,
    executionArn: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListMapRunsOutputTypeDef:  # (1)
    ...
  1. See ListMapRunsOutputTypeDef 
# list_map_runs method usage example with argument unpacking

kwargs: ListMapRunsInputRequestTypeDef = {  # (1)
    "executionArn": ...,
}

parent.list_map_runs(**kwargs)
  1. See ListMapRunsInputRequestTypeDef

list_state_machines#

Lists the existing state machines.

Type annotations and code completion for boto3.client("stepfunctions").list_state_machines method. boto3 documentation

# list_state_machines method definition

def list_state_machines(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListStateMachinesOutputTypeDef:  # (1)
    ...
  1. See ListStateMachinesOutputTypeDef 
# list_state_machines method usage example with argument unpacking

kwargs: ListStateMachinesInputRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_state_machines(**kwargs)
  1. See ListStateMachinesInputRequestTypeDef

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceOutputTypeDef:  # (1)
    ...
  1. See ListTagsForResourceOutputTypeDef 
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceInputRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceInputRequestTypeDef

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

# send_task_failure method definition

def send_task_failure(
    self,
    *,
    taskToken: str,
    error: str = ...,
    cause: str = ...,
) -> Dict[str, Any]:
    ...
# send_task_failure method usage example with argument unpacking

kwargs: SendTaskFailureInputRequestTypeDef = {  # (1)
    "taskToken": ...,
}

parent.send_task_failure(**kwargs)
  1. See SendTaskFailureInputRequestTypeDef

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

# send_task_heartbeat method definition

def send_task_heartbeat(
    self,
    *,
    taskToken: str,
) -> Dict[str, Any]:
    ...
# send_task_heartbeat method usage example with argument unpacking

kwargs: SendTaskHeartbeatInputRequestTypeDef = {  # (1)
    "taskToken": ...,
}

parent.send_task_heartbeat(**kwargs)
  1. See SendTaskHeartbeatInputRequestTypeDef

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

# send_task_success method definition

def send_task_success(
    self,
    *,
    taskToken: str,
    output: str,
) -> Dict[str, Any]:
    ...
# send_task_success method usage example with argument unpacking

kwargs: SendTaskSuccessInputRequestTypeDef = {  # (1)
    "taskToken": ...,
    "output": ...,
}

parent.send_task_success(**kwargs)
  1. See SendTaskSuccessInputRequestTypeDef

start_execution#

Starts a state machine execution.

Type annotations and code completion for boto3.client("stepfunctions").start_execution method. boto3 documentation

# start_execution method definition

def start_execution(
    self,
    *,
    stateMachineArn: str,
    name: str = ...,
    input: str = ...,
    traceHeader: str = ...,
) -> StartExecutionOutputTypeDef:  # (1)
    ...
  1. See StartExecutionOutputTypeDef 
# start_execution method usage example with argument unpacking

kwargs: StartExecutionInputRequestTypeDef = {  # (1)
    "stateMachineArn": ...,
}

parent.start_execution(**kwargs)
  1. See StartExecutionInputRequestTypeDef

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

# start_sync_execution method definition

def start_sync_execution(
    self,
    *,
    stateMachineArn: str,
    name: str = ...,
    input: str = ...,
    traceHeader: str = ...,
) -> StartSyncExecutionOutputTypeDef:  # (1)
    ...
  1. See StartSyncExecutionOutputTypeDef 
# start_sync_execution method usage example with argument unpacking

kwargs: StartSyncExecutionInputRequestTypeDef = {  # (1)
    "stateMachineArn": ...,
}

parent.start_sync_execution(**kwargs)
  1. See StartSyncExecutionInputRequestTypeDef

stop_execution#

Stops an execution.

Type annotations and code completion for boto3.client("stepfunctions").stop_execution method. boto3 documentation

# stop_execution method definition

def stop_execution(
    self,
    *,
    executionArn: str,
    error: str = ...,
    cause: str = ...,
) -> StopExecutionOutputTypeDef:  # (1)
    ...
  1. See StopExecutionOutputTypeDef 
# stop_execution method usage example with argument unpacking

kwargs: StopExecutionInputRequestTypeDef = {  # (1)
    "executionArn": ...,
}

parent.stop_execution(**kwargs)
  1. See StopExecutionInputRequestTypeDef

tag_resource#

Add a tag to a Step Functions resource.

Type annotations and code completion for boto3.client("stepfunctions").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See TagTypeDef 
# tag_resource method usage example with argument unpacking

kwargs: TagResourceInputRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceInputRequestTypeDef

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceInputRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceInputRequestTypeDef

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

# update_map_run method definition

def update_map_run(
    self,
    *,
    mapRunArn: str,
    maxConcurrency: int = ...,
    toleratedFailurePercentage: float = ...,
    toleratedFailureCount: int = ...,
) -> Dict[str, Any]:
    ...
# update_map_run method usage example with argument unpacking

kwargs: UpdateMapRunInputRequestTypeDef = {  # (1)
    "mapRunArn": ...,
}

parent.update_map_run(**kwargs)
  1. See UpdateMapRunInputRequestTypeDef

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

# update_state_machine method definition

def update_state_machine(
    self,
    *,
    stateMachineArn: str,
    definition: str = ...,
    roleArn: str = ...,
    loggingConfiguration: LoggingConfigurationTypeDef = ...,  # (1)
    tracingConfiguration: TracingConfigurationTypeDef = ...,  # (2)
) -> UpdateStateMachineOutputTypeDef:  # (3)
    ...
  1. See LoggingConfigurationTypeDef
  2. See TracingConfigurationTypeDef
  3. See UpdateStateMachineOutputTypeDef 
# update_state_machine method usage example with argument unpacking

kwargs: UpdateStateMachineInputRequestTypeDef = {  # (1)
    "stateMachineArn": ...,
}

parent.update_state_machine(**kwargs)
  1. See UpdateStateMachineInputRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("stepfunctions").get_paginator method with overloads.