Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListMapRuns

Lists all Map Runs that were started by a given state machine execution. Use this API action to obtain Map Run ARNs, and then call DescribeMapRun to obtain more information, if needed.

Request Syntax


{
   "executionArn": "string",
   "maxResults": number,
   "nextToken": "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.

executionArn

The Amazon Resource Name (ARN) of the execution for which the Map Runs must be listed.

Type: String

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

Required: Yes

maxResults

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 1000.

Required: No

nextToken

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Type: String

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

Required: No

Response Syntax


{
   "mapRuns": [ 
      { 
         "executionArn": "string",
         "mapRunArn": "string",
         "startDate": number,
         "stateMachineArn": "string",
         "stopDate": number
      }
   ],
   "nextToken": "string"
}

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.

mapRuns

An array that lists information related to a Map Run, such as the Amazon Resource Name (ARN) of the Map Run and the ARN of the state machine that started the Map Run.

Type: Array of MapRunListItem objects

nextToken

Type: String

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

Errors

For information about the errors that are common to all actions, see Common Errors.

ExecutionDoesNotExist

The specified execution does not exist.

HTTP Status Code: 400

InvalidArn

The provided Amazon Resource Name (ARN) is not valid.

HTTP Status Code: 400

InvalidToken

The provided token is not valid.

HTTP Status Code: 400