:doc:`imagebuilder <../../imagebuilder>` / Paginator / ListWorkflowExecutions

**********************
ListWorkflowExecutions
**********************



.. py:class:: imagebuilder.Paginator.ListWorkflowExecutions

  ::

    
    paginator = client.get_paginator('list_workflow_executions')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`imagebuilder.Client.list_workflow_executions`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListWorkflowExecutions>`_    


    **Request Syntax**
    ::

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

      List all workflow runtime instances for the specified image build version resource ARN.

      

    
    :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**

      
      ::

        {
            'requestId': 'string',
            'workflowExecutions': [
                {
                    'workflowBuildVersionArn': 'string',
                    'workflowExecutionId': 'string',
                    'type': 'BUILD'|'TEST'|'DISTRIBUTION',
                    'status': 'PENDING'|'SKIPPED'|'RUNNING'|'COMPLETED'|'FAILED'|'ROLLBACK_IN_PROGRESS'|'ROLLBACK_COMPLETED'|'CANCELLED',
                    'message': 'string',
                    'totalStepCount': 123,
                    'totalStepsSucceeded': 123,
                    'totalStepsFailed': 123,
                    'totalStepsSkipped': 123,
                    'startTime': 'string',
                    'endTime': 'string',
                    'parallelGroup': 'string',
                    'retried': True|False
                },
            ],
            'imageBuildVersionArn': 'string',
            'message': 'string',
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **requestId** *(string) --* 

          The request ID that uniquely identifies this request.

          
        

        - **workflowExecutions** *(list) --* 

          Contains an array of runtime details that represents each time a workflow ran for the requested image build version.

          
          

          - *(dict) --* 

            Metadata that includes details and status from this runtime instance of the workflow.

            
            

            - **workflowBuildVersionArn** *(string) --* 

              The Amazon Resource Name (ARN) of the workflow resource build version that ran.

              
            

            - **workflowExecutionId** *(string) --* 

              Unique identifier that Image Builder assigns to keep track of runtime resources each time it runs a workflow.

              
            

            - **type** *(string) --* 

              Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.

              
            

            - **status** *(string) --* 

              The current runtime status for this workflow.

              
            

            - **message** *(string) --* 

              The runtime output message from the workflow, if applicable.

              
            

            - **totalStepCount** *(integer) --* 

              The total number of steps in the workflow. This should equal the sum of the step counts for steps that succeeded, were skipped, and failed.

              
            

            - **totalStepsSucceeded** *(integer) --* 

              A runtime count for the number of steps in the workflow that ran successfully.

              
            

            - **totalStepsFailed** *(integer) --* 

              A runtime count for the number of steps in the workflow that failed.

              
            

            - **totalStepsSkipped** *(integer) --* 

              A runtime count for the number of steps in the workflow that were skipped.

              
            

            - **startTime** *(string) --* 

              The timestamp when the runtime instance of this workflow started.

              
            

            - **endTime** *(string) --* 

              The timestamp when this runtime instance of the workflow finished.

              
            

            - **parallelGroup** *(string) --* 

              The name of the test group that included the test workflow resource at runtime.

              
            

            - **retried** *(boolean) --* 

              Indicates retry status for this runtime instance of the workflow.

              
        
      
        

        - **imageBuildVersionArn** *(string) --* 

          The resource Amazon Resource Name (ARN) of the image build version for which you requested a list of workflow runtime details.

          
        

        - **message** *(string) --* 

          The output message from the list action, if applicable.

          
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    