Toggle Light / Dark / Auto color theme

Toggle table of contents sidebar

state_machine

State Machine management module

class aws_stepfunction.state_machine.StateMachine(name: str, workflow: Workflow, role_arn: str, type: Optional[str] = 'STANDARD', logging_configuration: Optional[dict] = None, tracing_configuration: Optional[dict] = None, tags: Optional[dict] = None)

Represent an instance of State Machine in AWS Console.

Parameters

• name –

• workflow – Workflow

• role_arn –

• type –

• logging_configuration –

• tracing_configuration –

• tags –

exists(bsm: boto_session_manager.manager.BotoSesManager) → bool

Check if the state machine exists.

create(bsm: boto_session_manager.manager.BotoSesManager)

Reference:

• https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/stepfunctions.html#SFN.Client.create_state_machine

update(bsm: boto_session_manager.manager.BotoSesManager)

Reference:

• https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/stepfunctions.html#SFN.Client.update_state_machine

delete(bsm: boto_session_manager.manager.BotoSesManager)

Reference:

• https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/stepfunctions.html#SFN.Client.delete_state_machine

execute(bsm: boto_session_manager.manager.BotoSesManager, payload: Optional[dict] = None, name: Optional[str] = None, sync: bool = False, trace_header: Optional[str] = None)

Execute state machine with custom payload.

Parameters

• payload – custom payload in python dictionary

• name – the execution name, recommend to leave it empty and let step function to generate an uuid for you.

• sync – if true, you need to wait for the execution to finish otherwise, it returns immediately, and you can check the status in the console

Reference:

• https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/stepfunctions.html#SFN.Client.start_execution

• https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/stepfunctions.html#SFN.Client.start_sync_execution