SFN / Client / redrive_execution

redrive_execution#

SFN.Client.redrive_execution(**kwargs)#

Restarts unsuccessful executions of Standard workflows that didn’t complete successfully in the last 14 days. These include failed, aborted, or timed out executions. When you redrive an execution, it continues the failed execution from the unsuccessful step and uses the same input. Step Functions preserves the results and execution history of the successful steps, and doesn’t rerun these steps when you redrive an execution. Redriven executions use the same state machine definition and execution ARN as the original execution attempt.

For workflows that include an Inline Map or Parallel state, RedriveExecution API action reschedules and redrives only the iterations and branches that failed or aborted.

To redrive a workflow that includes a Distributed Map state whose Map Run failed, you must redrive the parent workflow. The parent workflow redrives all the unsuccessful states, including a failed Map Run. If a Map Run was not started in the original execution attempt, the redriven parent workflow starts the Map Run.

Note

This API action is not supported by EXPRESS state machines.

However, you can restart the unsuccessful executions of Express child workflows in a Distributed Map by redriving its Map Run. When you redrive a Map Run, the Express child workflows are rerun using the StartExecution API action. For more information, see Redriving Map Runs.

You can redrive executions if your original execution meets the following conditions:

  • The execution status isn’t SUCCEEDED.

  • Your workflow execution has not exceeded the redrivable period of 14 days. Redrivable period refers to the time during which you can redrive a given execution. This period starts from the day a state machine completes its execution.

  • The workflow execution has not exceeded the maximum open time of one year. For more information about state machine quotas, see Quotas related to state machine executions.

  • The execution event history count is less than 24,999. Redriven executions append their event history to the existing event history. Make sure your workflow execution contains less than 24,999 events to accommodate the ExecutionRedriven history event and at least one other history event.

See also: AWS API Documentation

Request Syntax

response = client.redrive_execution(
    executionArn='string',
    clientToken='string'
)
Parameters:

  • executionArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the execution to be redriven.

  • clientToken (string) –

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency. The API will return idempotent responses for the last 10 client tokens used to successfully redrive the execution. These client tokens are valid for up to 15 minutes after they are first used.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'redriveDate': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • redriveDate (datetime) –

      The date the execution was last redriven.

Exceptions

  • SFN.Client.exceptions.ExecutionDoesNotExist

  • SFN.Client.exceptions.ExecutionNotRedrivable

  • SFN.Client.exceptions.ExecutionLimitExceeded

  • SFN.Client.exceptions.InvalidArn