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.ConflictException,
    client.exceptions.ExecutionAlreadyExists,
    client.exceptions.ExecutionDoesNotExist,
    client.exceptions.ExecutionLimitExceeded,
    client.exceptions.ExecutionNotRedrivable,
    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.ServiceQuotaExceededException,
    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)
    publish: bool = ...,
    versionDescription: str = ...,
) -> 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

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 boto3.client("stepfunctions").create_state_machine_alias method. boto3 documentation

# create_state_machine_alias method definition

def create_state_machine_alias(
    self,
    *,
    name: str,
    routingConfiguration: Sequence[RoutingConfigurationListItemTypeDef],  # (1)
    description: str = ...,
) -> CreateStateMachineAliasOutputTypeDef:  # (2)
    ...
  1. See RoutingConfigurationListItemTypeDef
  2. See CreateStateMachineAliasOutputTypeDef
# create_state_machine_alias method usage example with argument unpacking

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

parent.create_state_machine_alias(**kwargs)
  1. See CreateStateMachineAliasInputRequestTypeDef

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

delete_state_machine_alias#

Deletes a state machine alias.

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

# delete_state_machine_alias method definition

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)
  1. See DeleteStateMachineAliasInputRequestTypeDef

delete_state_machine_version#

Deletes a state machine version.

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

# delete_state_machine_version method definition

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)
  1. See DeleteStateMachineVersionInputRequestTypeDef

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