SFN / Client / list_map_runs

list_map_runs#

SFN.Client.list_map_runs(**kwargs)#

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

response = client.list_map_runs(
    executionArn='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

executionArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the execution for which the Map Runs must be listed.
maxResults (integer) –
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.
nextToken (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'mapRuns': [
        {
            'executionArn': 'string',
            'mapRunArn': 'string',
            'stateMachineArn': 'string',
            'startDate': datetime(2015, 1, 1),
            'stopDate': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- mapRuns (list) –
  
  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.
  - (dict) –
    
    Contains details about a specific Map Run.
    - executionArn (string) –
      
      The executionArn of the execution from which the Map Run was started.
    - mapRunArn (string) –
      
      The Amazon Resource Name (ARN) of the Map Run.
    - stateMachineArn (string) –
      
      The Amazon Resource Name (ARN) of the executed state machine.
    - startDate (datetime) –
      
      The date on which the Map Run started.
    - stopDate (datetime) –
      
      The date on which the Map Run stopped.
- nextToken (string) –
  
  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.

Exceptions

SFN.Client.exceptions.ExecutionDoesNotExist
SFN.Client.exceptions.InvalidArn
SFN.Client.exceptions.InvalidToken