SFN / Paginator / ListMapRuns

ListMapRuns#

class SFN.Paginator.ListMapRuns#
paginator = client.get_paginator('list_map_runs')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from SFN.Client.list_map_runs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    executionArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • executionArn (string) –

    [REQUIRED]

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

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

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) –

      A token to resume pagination.