Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1737274251.5 KB

Provides information about a Map Run's configuration, progress, and results. If you've <a href="https://docs.aws.amazon.com/step-functions/latest/dg/redrive-map-run.html">redriven</a> a Map Run, this API action also returns information about the redrives of that Map Run. For more information, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-examine-map-run.html">Examining Map Run</a> in the <i>Step Functions Developer Guide</i>.

post/#X-Amz-Target=AWSStepFunctions.DescribeMapRun

Headers

X-Amz-Target'AWSStepFunctions.DescribeMapRun' required

Request body

mapRunArnstring required

The Amazon Resource Name (ARN) that identifies a Map Run.

Response

Success

mapRunArnstring required

The Amazon Resource Name (ARN) that identifies a Map Run.

executionArnstring required

The Amazon Resource Name (ARN) that identifies the execution in which the Map Run was started.

status'RUNNING' | 'SUCCEEDED' | 'FAILED' | 'ABORTED' required

The current status of the Map Run.

startDatestring date-time required

The date when the Map Run was started.

stopDatestring date-time

The date when the Map Run was stopped.

maxConcurrencyinteger required

The maximum number of child workflow executions configured to run in parallel for the Map Run at the same time.

toleratedFailurePercentagenumber float required

The maximum percentage of failed child workflow executions before the Map Run fails.

toleratedFailureCountinteger required

The maximum number of failed child workflow executions before the Map Run fails.

redriveCountinteger

The number of times you've redriven a Map Run. If you have not yet redriven a Map Run, the <code>redriveCount</code> is 0. This count is only updated if you successfully redrive a Map Run.

redriveDatestring date-time

The date a Map Run was last redriven. If you have not yet redriven a Map Run, the <code>redriveDate</code> is null.