Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeMapRun

Provides information about a Map Run's configuration, progress, and results. If you've redriven a Map Run, this API action also returns information about the redrives of that Map Run. For more information, see Examining Map Run in the AWS Step Functions Developer Guide.

Request Syntax


{
   "mapRunArn": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

mapRunArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2000.

Required: Yes

Response Syntax


{
   "executionArn": "string",
   "executionCounts": { 
      "aborted": number,
      "failed": number,
      "failuresNotRedrivable": number,
      "pending": number,
      "pendingRedrive": number,
      "resultsWritten": number,
      "running": number,
      "succeeded": number,
      "timedOut": number,
      "total": number
   },
   "itemCounts": { 
      "aborted": number,
      "failed": number,
      "failuresNotRedrivable": number,
      "pending": number,
      "pendingRedrive": number,
      "resultsWritten": number,
      "running": number,
      "succeeded": number,
      "timedOut": number,
      "total": number
   },
   "mapRunArn": "string",
   "maxConcurrency": number,
   "redriveCount": number,
   "redriveDate": number,
   "startDate": number,
   "status": "string",
   "stopDate": number,
   "toleratedFailureCount": number,
   "toleratedFailurePercentage": number
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

executionArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

executionCounts

A JSON object that contains information about the total number of child workflow executions for the Map Run, and the count of child workflow executions for each status, such as failed and succeeded.

Type: MapRunExecutionCounts object

itemCounts

A JSON object that contains information about the total number of items, and the item count for each processing status, such as pending and failed.

Type: MapRunItemCounts object

mapRunArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2000.

maxConcurrency

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

Type: Integer

Valid Range: Minimum value of 0.

redriveCount

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

Type: Integer

redriveDate