SFNClient#
Auto-generated documentation for SFN type annotations stubs module types-aiobotocore-stepfunctions.
SFNClient#
Type annotations and code completion for session.create_client("stepfunctions")
boto3 documentation
SFNClient usage example
from aiobotocore.session import get_session
from types_aiobotocore_stepfunctions.client import SFNClient
session = get_session()
async with session.create_client("stepfunctions") as client:
client: SFNClientExceptions#
aiobotocore client exceptions are generated in runtime.
This class provides code completion for session.create_client("stepfunctions").exceptions structure.
SFNClient.exceptions usage example
async with session.create_client("stepfunctions") as client:
try:
do_something(client)
except (
client.ActivityDoesNotExist,
client.ActivityLimitExceeded,
client.ActivityWorkerLimitExceeded,
client.ClientError,
client.ConflictException,
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.ServiceQuotaExceededException,
client.StateMachineAlreadyExists,
client.StateMachineDeleting,
client.StateMachineDoesNotExist,
client.StateMachineLimitExceeded,
client.StateMachineTypeNotSupported,
client.TaskDoesNotExist,
client.TaskTimedOut,
client.TooManyTags,
client.ValidationException,
) as e:
print(e)SFNClient usage type checking example
from types_aiobotocore_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 session.create_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 session.create_client("stepfunctions").close method.
boto3 documentation
# close method definition
await def close(
self,
) -> None:
...create_activity#
Creates an activity.
Type annotations and code completion for session.create_client("stepfunctions").create_activity method.
boto3 documentation
# create_activity method definition
await def create_activity(
self,
*,
name: str,
tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateActivityOutputTypeDef: # (2)
...# create_activity method usage example with argument unpacking
kwargs: CreateActivityInputRequestTypeDef = { # (1)
"name": ...,
}
parent.create_activity(**kwargs)create_state_machine#
Creates a state machine.
Type annotations and code completion for session.create_client("stepfunctions").create_state_machine method.
boto3 documentation
# create_state_machine method definition
await def create_state_machine(
self,
*,
name: str,
definition: str,
roleArn: str,
type: StateMachineTypeType = ..., # (1)
loggingConfiguration: LoggingConfigurationTypeDef = ..., # (2)
tags: Sequence[TagTypeDef] = ..., # (3)
tracingConfiguration: TracingConfigurationTypeDef = ..., # (4)
publish: bool = ...,
versionDescription: str = ...,
) -> CreateStateMachineOutputTypeDef: # (5)
...- See StateMachineTypeType
- See LoggingConfigurationTypeDef
- See TagTypeDef
- See TracingConfigurationTypeDef
- See CreateStateMachineOutputTypeDef
# create_state_machine method usage example with argument unpacking
kwargs: CreateStateMachineInputRequestTypeDef = { # (1)
"name": ...,
"definition": ...,
"roleArn": ...,
}
parent.create_state_machine(**kwargs)create_state_machine_alias#
Creates an alias for a state machine that points to one or two versions of the same state machine.
Type annotations and code completion for session.create_client("stepfunctions").create_state_machine_alias method.
boto3 documentation
# create_state_machine_alias method definition
await def create_state_machine_alias(
self,
*,
name: str,
routingConfiguration: Sequence[RoutingConfigurationListItemTypeDef], # (1)
description: str = ...,
) -> CreateStateMachineAliasOutputTypeDef: # (2)
...# create_state_machine_alias method usage example with argument unpacking
kwargs: CreateStateMachineAliasInputRequestTypeDef = { # (1)
"name": ...,
"routingConfiguration": ...,
}
parent.create_state_machine_alias(**kwargs)delete_activity#
Deletes an activity.
Type annotations and code completion for session.create_client("stepfunctions").delete_activity method.
boto3 documentation
# delete_activity method definition
await 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)delete_state_machine#
Deletes a state machine.
Type annotations and code completion for session.create_client("stepfunctions").delete_state_machine method.
boto3 documentation
# delete_state_machine method definition
await 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)delete_state_machine_alias#
Deletes a state machine alias_.
Type annotations and code completion for session.create_client("stepfunctions").delete_state_machine_alias method.
boto3 documentation
# delete_state_machine_alias method definition
await def delete_state_machine_alias(
self,
*,
stateMachineAliasArn: str,
) -> Dict[str, Any]:
...# delete_state_machine_alias method usage example with argument unpacking
kwargs: DeleteStateMachineAliasInputRequestTypeDef = { # (1)
"stateMachineAliasArn": ...,
}
parent.delete_state_machine_alias(**kwargs)delete_state_machine_version#
Deletes a state machine version_.
Type annotations and code completion for session.create_client("stepfunctions").delete_state_machine_version method.
boto3 documentation
# delete_state_machine_version method definition
await def delete_state_machine_version(
self,
*,
stateMachineVersionArn: str,
) -> Dict[str, Any]:
...# delete_state_machine_version method usage example with argument unpacking
kwargs: DeleteStateMachineVersionInputRequestTypeDef = { # (1)
"stateMachineVersionArn": ...,
}
parent.delete_state_machine_version(**kwargs)describe_activity#
Describes an activity.
Type annotations and code completion for session.create_client("stepfunctions").describe_activity method.
boto3 documentation
# describe_activity method definition
await def describe_activity(
self,
*,
activityArn: str,
) -> DescribeActivityOutputTypeDef: # (1)
...# describe_activity method usage example with argument unpacking
kwargs: DescribeActivityInputRequestTypeDef = { # (1)
"activityArn": ...,
}
parent.describe_activity(**kwargs)describe_execution#
Provides 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 session.create_client("stepfunctions").describe_execution method.
boto3 documentation
# describe_execution method definition
await def describe_execution(
self,
*,
executionArn: str,
) -> DescribeExecutionOutputTypeDef: # (1)
...# describe_execution method usage example with argument unpacking
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 session.create_client("stepfunctions").describe_map_run method.
boto3 documentation
# describe_map_run method definition
await def describe_map_run(
self,
*,
mapRunArn: str,
) -> DescribeMapRunOutputTypeDef: # (1)
...# describe_map_run method usage example with argument unpacking
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 session.create_client("stepfunctions").describe_state_machine method.
boto3 documentation
# describe_state_machine method definition
await def describe_state_machine(
self,
*,
stateMachineArn: str,
) -> DescribeStateMachineOutputTypeDef: # (1)
...# describe_state_machine method usage example with argument unpacking
kwargs: DescribeStateMachineInputRequestTypeDef = { # (1)
"stateMachineArn": ...,
}
parent.describe_state_machine(**kwargs)describe_state_machine_alias#
Returns details about a state machine alias_.
Type annotations and code completion for session.create_client("stepfunctions").describe_state_machine_alias method.
boto3 documentation
# describe_state_machine_alias method definition
await def describe_state_machine_alias(
self,
*,
stateMachineAliasArn: str,
) -> DescribeStateMachineAliasOutputTypeDef: # (1)
...# describe_state_machine_alias method usage example with argument unpacking
kwargs: DescribeStateMachineAliasInputRequestTypeDef = { # (1)
"stateMachineAliasArn": ...,
}
parent.describe_state_machine_alias(**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 session.create_client("stepfunctions").describe_state_machine_for_execution method.
boto3 documentation
# describe_state_machine_for_execution method definition
await def describe_state_machine_for_execution(
self,
*,
executionArn: str,
) -> DescribeStateMachineForExecutionOutputTypeDef: # (1)
...# describe_state_machine_for_execution method usage example with argument unpacking
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 session.create_client("stepfunctions").generate_presigned_url method.
boto3 documentation
# generate_presigned_url method definition
await 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 session.create_client("stepfunctions").get_activity_task method.
boto3 documentation
# get_activity_task method definition
await def get_activity_task(
self,
*,
activityArn: str,
workerName: str = ...,
) -> GetActivityTaskOutputTypeDef: # (1)
...# get_activity_task method usage example with argument unpacking
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 session.create_client("stepfunctions").get_execution_history method.
boto3 documentation
# get_execution_history method definition
await def get_execution_history(
self,
*,
executionArn: str,
maxResults: int = ...,
reverseOrder: bool = ...,
nextToken: str = ...,
includeExecutionData: bool = ...,
) -> GetExecutionHistoryOutputTypeDef: # (1)
...# get_execution_history method usage example with argument unpacking
kwargs: GetExecutionHistoryInputRequestTypeDef = { # (1)
"executionArn": ...,
}
parent.get_execution_history(**kwargs)list_activities#
Lists the existing activities.
Type annotations and code completion for session.create_client("stepfunctions").list_activities method.
boto3 documentation
# list_activities method definition
await def list_activities(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListActivitiesOutputTypeDef: # (1)
...# list_activities method usage example with argument unpacking
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 session.create_client("stepfunctions").list_executions method.
boto3 documentation
# list_executions method definition
await def list_executions(
self,
*,
stateMachineArn: str = ...,
statusFilter: ExecutionStatusType = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
mapRunArn: str = ...,
) -> ListExecutionsOutputTypeDef: # (2)
...# list_executions method usage example with argument unpacking
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 session.create_client("stepfunctions").list_map_runs method.
boto3 documentation
# list_map_runs method definition
await def list_map_runs(
self,
*,
executionArn: str,
maxResults: int = ...,
nextToken: str = ...,
) -> ListMapRunsOutputTypeDef: # (1)
...# list_map_runs method usage example with argument unpacking
kwargs: ListMapRunsInputRequestTypeDef = { # (1)
"executionArn": ...,
}
parent.list_map_runs(**kwargs)list_state_machine_aliases#
Lists aliases_ for a specified state machine ARN.
Type annotations and code completion for session.create_client("stepfunctions").list_state_machine_aliases method.
boto3 documentation
# list_state_machine_aliases method definition
await def list_state_machine_aliases(
self,
*,
stateMachineArn: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListStateMachineAliasesOutputTypeDef: # (1)
...# list_state_machine_aliases method usage example with argument unpacking
kwargs: ListStateMachineAliasesInputRequestTypeDef = { # (1)
"stateMachineArn": ...,
}
parent.list_state_machine_aliases(**kwargs)list_state_machine_versions#
Lists versions_ for the specified state machine Amazon Resource Name (ARN).
Type annotations and code completion for session.create_client("stepfunctions").list_state_machine_versions method.
boto3 documentation
# list_state_machine_versions method definition
await def list_state_machine_versions(
self,
*,
stateMachineArn: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListStateMachineVersionsOutputTypeDef: # (1)
...# list_state_machine_versions method usage example with argument unpacking
kwargs: ListStateMachineVersionsInputRequestTypeDef = { # (1)
"stateMachineArn": ...,
}
parent.list_state_machine_versions(**kwargs)list_state_machines#
Lists the existing state machines.
Type annotations and code completion for session.create_client("stepfunctions").list_state_machines method.
boto3 documentation
# list_state_machines method definition
await def list_state_machines(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListStateMachinesOutputTypeDef: # (1)
...# list_state_machines method usage example with argument unpacking
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 session.create_client("stepfunctions").list_tags_for_resource method.
boto3 documentation
# list_tags_for_resource method definition
await def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceOutputTypeDef: # (1)
...# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceInputRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)publish_state_machine_version#
Creates a version_ from the current revision of a state machine.
Type annotations and code completion for session.create_client("stepfunctions").publish_state_machine_version method.
boto3 documentation
# publish_state_machine_version method definition
await def publish_state_machine_version(
self,
*,
stateMachineArn: str,
revisionId: str = ...,
description: str = ...,
) -> PublishStateMachineVersionOutputTypeDef: # (1)
...# publish_state_machine_version method usage example with argument unpacking
kwargs: PublishStateMachineVersionInputRequestTypeDef = { # (1)
"stateMachineArn": ...,
}
parent.publish_state_machine_version(**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 session.create_client("stepfunctions").send_task_failure method.
boto3 documentation
# send_task_failure method definition
await 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)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 session.create_client("stepfunctions").send_task_heartbeat method.
boto3 documentation
# send_task_heartbeat method definition
await 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)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 session.create_client("stepfunctions").send_task_success method.
boto3 documentation
# send_task_success method definition
await 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)start_execution#
Starts a state machine execution.
Type annotations and code completion for session.create_client("stepfunctions").start_execution method.
boto3 documentation
# start_execution method definition
await def start_execution(
self,
*,
stateMachineArn: str,
name: str = ...,
input: str = ...,
traceHeader: str = ...,
) -> StartExecutionOutputTypeDef: # (1)
...# start_execution method usage example with argument unpacking
kwargs: StartExecutionInputRequestTypeDef = { # (1)
"stateMachineArn": ...,
}
parent.start_execution(**kwargs)start_sync_execution#
Starts a Synchronous Express state machine execution.
Type annotations and code completion for session.create_client("stepfunctions").start_sync_execution method.
boto3 documentation
# start_sync_execution method definition
await def start_sync_execution(
self,
*,
stateMachineArn: str,
name: str = ...,
input: str = ...,
traceHeader: str = ...,
) -> StartSyncExecutionOutputTypeDef: # (1)
...# start_sync_execution method usage example with argument unpacking
kwargs: StartSyncExecutionInputRequestTypeDef = { # (1)
"stateMachineArn": ...,
}
parent.start_sync_execution(**kwargs)stop_execution#
Stops an execution.
Type annotations and code completion for session.create_client("stepfunctions").stop_execution method.
boto3 documentation
# stop_execution method definition
await def stop_execution(
self,
*,
executionArn: str,
error: str = ...,
cause: str = ...,
) -> StopExecutionOutputTypeDef: # (1)
...# stop_execution method usage example with argument unpacking
kwargs: StopExecutionInputRequestTypeDef = { # (1)
"executionArn": ...,
}
parent.stop_execution(**kwargs)tag_resource#
Add a tag to a Step Functions resource.
Type annotations and code completion for session.create_client("stepfunctions").tag_resource method.
boto3 documentation
# tag_resource method definition
await def tag_resource(
self,
*,
resourceArn: str,
tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...- See TagTypeDef
# tag_resource method usage example with argument unpacking
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 session.create_client("stepfunctions").untag_resource method.
boto3 documentation
# untag_resource method definition
await 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)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 session.create_client("stepfunctions").update_map_run method.
boto3 documentation
# update_map_run method definition
await 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)update_state_machine#
Updates an existing state machine by modifying its definition, roleArn, or
loggingConfiguration.
Type annotations and code completion for session.create_client("stepfunctions").update_state_machine method.
boto3 documentation
# update_state_machine method definition
await def update_state_machine(
self,
*,
stateMachineArn: str,
definition: str = ...,
roleArn: str = ...,
loggingConfiguration: LoggingConfigurationTypeDef = ..., # (1)
tracingConfiguration: TracingConfigurationTypeDef = ..., # (2)
publish: bool = ...,
versionDescription: str = ...,
) -> UpdateStateMachineOutputTypeDef: # (3)
...# update_state_machine method usage example with argument unpacking
kwargs: UpdateStateMachineInputRequestTypeDef = { # (1)
"stateMachineArn": ...,
}
parent.update_state_machine(**kwargs)update_state_machine_alias#
Updates the configuration of an existing state machine
alias_ by modifying its description or routingConfiguration.
Type annotations and code completion for session.create_client("stepfunctions").update_state_machine_alias method.
boto3 documentation
# update_state_machine_alias method definition
await def update_state_machine_alias(
self,
*,
stateMachineAliasArn: str,
description: str = ...,
routingConfiguration: Sequence[RoutingConfigurationListItemTypeDef] = ..., # (1)
) -> UpdateStateMachineAliasOutputTypeDef: # (2)
...# update_state_machine_alias method usage example with argument unpacking
kwargs: UpdateStateMachineAliasInputRequestTypeDef = { # (1)
"stateMachineAliasArn": ...,
}
parent.update_state_machine_alias(**kwargs)__aenter__#
Type annotations and code completion for session.create_client("stepfunctions").__aenter__ method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> SFNClient:
...__aexit__#
Type annotations and code completion for session.create_client("stepfunctions").__aexit__ method.
boto3 documentation
# __aexit__ method definition
await def __aexit__(
self,
exc_type: Any,
exc_val: Any,
exc_tb: Any,
) -> Any:
...get_paginator#
Type annotations and code completion for session.create_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