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.
The Amazon Resource Name (ARN) that identifies a Map Run.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2000.
Required: Yes
{
"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.
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.
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
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
The Amazon Resource Name (ARN) that identifies a Map Run.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2000.
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.
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
The date a Map Run was last redriven. If you have not yet redriven a Map Run, the redriveDate
is null.
Type: Timestamp
The date when the Map Run was started.
Type: Timestamp
The current status of the Map Run.
Type: String
Valid Values: RUNNING | SUCCEEDED | FAILED | ABORTED
The date when the Map Run was stopped.
Type: Timestamp
The maximum number of failed child workflow executions before the Map Run fails.
Type: Long
Valid Range: Minimum value of 0.
The maximum percentage of failed child workflow executions before the Map Run fails.
Type: Float
Valid Range: Minimum value of 0. Maximum value of 100.
For information about the errors that are common to all actions, see Common Errors.
The provided Amazon Resource Name (ARN) is not valid.
HTTP Status Code: 400
Could not find the referenced resource.
HTTP Status Code: 400
For more information about using this API in one of the language-specific AWS SDKs, see the following:
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4