:doc:`MWAAServerless <../../mwaa-serverless>` / Paginator / ListWorkflowRuns

****************
ListWorkflowRuns
****************



.. py:class:: MWAAServerless.Paginator.ListWorkflowRuns

  ::

    
    paginator = client.get_paginator('list_workflow_runs')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`MWAAServerless.Client.list_workflow_runs`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/ListWorkflowRuns>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          WorkflowArn='string',
          WorkflowVersion='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type WorkflowArn: string
    :param WorkflowArn: **[REQUIRED]** 

      The Amazon Resource Name (ARN) of the workflow for which you want a list of runs.

      

    
    :type WorkflowVersion: string
    :param WorkflowVersion: 

      Optional. The specific version of the workflow for which you want a list of runs. If not specified, runs for all versions are returned.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'WorkflowRuns': [
                {
                    'RunId': 'string',
                    'WorkflowArn': 'string',
                    'WorkflowVersion': 'string',
                    'RunType': 'ON_DEMAND'|'SCHEDULED',
                    'RunDetailSummary': {
                        'Status': 'STARTING'|'QUEUED'|'RUNNING'|'SUCCESS'|'FAILED'|'TIMEOUT'|'STOPPING'|'STOPPED',
                        'CreatedOn': datetime(2015, 1, 1),
                        'StartedAt': datetime(2015, 1, 1),
                        'EndedAt': datetime(2015, 1, 1)
                    }
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **WorkflowRuns** *(list) --* 

          A list of workflow run summaries for the specified workflow.

          
          

          - *(dict) --* 

            Summary information about a workflow run, including basic identification and status information.

            
            

            - **RunId** *(string) --* 

              The unique identifier of the workflow run.

              
            

            - **WorkflowArn** *(string) --* 

              The Amazon Resource Name (ARN) of the workflow that contains this run.

              
            

            - **WorkflowVersion** *(string) --* 

              The version of the workflow used for this run.

              
            

            - **RunType** *(string) --* 

              The type of workflow run.

              
            

            - **RunDetailSummary** *(dict) --* 

              Summary details about the workflow run execution.

              
              

              - **Status** *(string) --* 

                The current status of the workflow run.

                
              

              - **CreatedOn** *(datetime) --* 

                The timestamp when the workflow run was created, in ISO 8601 date-time format.

                
              

              - **StartedAt** *(datetime) --* 

                The timestamp when the workflow run started execution, in ISO 8601 date-time format.

                
              

              - **EndedAt** *(datetime) --* 

                The timestamp when the workflow run completed execution, in ISO 8601 date-time format. This value is null if the run is not complete.

                
          
        
      
    