Step Functions Jobs: Start Executions

{"URL":["/*.*/awa/pa_view_pa_view_START_EXECUTION_step_functions"],"heroDescriptionIdentifier":"ice_hero_StepFunctions_Start_Executions_Job","customCards":[{"id":"ice_specific_StepFunctions_Start_Executions_Job","title":"Adding Start Executions Job Parameters","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/IG_AWS_STEP/*.*/Agent%20Guide/Content/AWS_StepFunctions/AWS_StepFunctions_StartExecution_Job.htm","languages":["en-us"]},{"id":"ice_RA_Integration_Report","title":"RA / Integration Reports","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/IG_AWS_STEP/*.*/Agent%20Guide/Content/AWS_StepFunctions/AWS_StepFunctions_Jobs_RA_Properties.htm","languages":["en-us"]},{"id":"ice_Start_Executions_script_StepFunctions","title":"Setting Start Executions Job Properties through Scripts","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/IG_AWS_STEP/*.*/Agent%20Guide/Content/AWS_StepFunctions/AWS_StepFunctions_Script.htm","languages":["en-us"]},{"id":"ice_related_information_StepFunctions_Start_Executions_Job","title":"Related Information","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/IG_AWS_STEP/*.*/Agent%20Guide/Content/AWS_StepFunctions/AWS_StepFunctions_StartExecution_Job.htm","languages":["en-us"]}]}

Step Functions Start Execution jobs allow you to start, cancel and restart a State Machine in AWS Step Functions from Automic Automation.

Note:

Restarting allows you to run only the last State Machine execution. For more information, see Canceling and Restarting AWS Step Functions Jobs.

If you want to restart an execution prior to the last one, you need to run a Restart Execution Job. For more information, see AWS Step Functions Jobs: Restart Executions.

This page includes the following:

Defining Step Functions Start Execution Job Properties

To start a Start Execution Job successfully, you have to define all the relevant parameters. Optionally, you can also define other properties and parameters that you want to pass to the integration.

On the Start Execution Job page, you define the parameters relevant to run the job on your AWS Step Functions environment:

  • Connection

    Step Functions Connection object containing the relevant information to connect to the application.

    To search for a Connection object, start typing its name to limit the list of the objects that match your input.

  • State Machine ARN

    ARN of the State Machine that you want to run.

    You can click the browse button to the right of the field to open a picker dialog with all the State Machine ARNs available and select the relevant one.

  • Execution Name (Optional)

    Define the execution name that you want to use for the execution.

  • Payload Type (Optional)

    Allows you to pass arguments created at runtime to Step Functions in JSON format. Select one of the options available:

    • None (default)

      Select this option if you do not want to pass any parameters to AWS Step Functions.

    • JSON

      Use the JSON field to enter the JSON payload definition.

    • File Path

      Use the JSON File Path field to define the path to the JSON file containing the attributes that you want to pass to the application. Make sure that the file is available on the Agent machine (host).

  • Trace Header (Optional)

    The AWS X-Ray trace header that you want to pass to the integration.

See also: