:doc:`CodeCatalyst <../../codecatalyst>` / Paginator / ListWorkflows

*************
ListWorkflows
*************



.. py:class:: CodeCatalyst.Paginator.ListWorkflows

  ::

    
    paginator = client.get_paginator('list_workflows')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`CodeCatalyst.Client.list_workflows`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/codecatalyst-2022-09-28/ListWorkflows>`_    


    **Request Syntax**
    ::

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

      The name of the space.

      

    
    :type projectName: string
    :param projectName: **[REQUIRED]** 

      The name of the project in the space.

      

    
    :type sortBy: list
    :param sortBy: 

      Information used to sort the items in the returned list.

      

    
      - *(dict) --* 

        Information used to sort workflows in the returned list.

        

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

      
      ::

        {
            'items': [
                {
                    'id': 'string',
                    'name': 'string',
                    'sourceRepositoryName': 'string',
                    'sourceBranchName': 'string',
                    'definition': {
                        'path': 'string'
                    },
                    'createdTime': datetime(2015, 1, 1),
                    'lastUpdatedTime': datetime(2015, 1, 1),
                    'runMode': 'QUEUED'|'PARALLEL'|'SUPERSEDED',
                    'status': 'INVALID'|'ACTIVE'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **items** *(list) --* 

          Information about the workflows in a project.

          
          

          - *(dict) --* 

            Information about a workflow.

            
            

            - **id** *(string) --* 

              The system-generated unique ID of a workflow.

              
            

            - **name** *(string) --* 

              The name of the workflow.

              
            

            - **sourceRepositoryName** *(string) --* 

              The name of the source repository where the workflow definition file is stored.

              
            

            - **sourceBranchName** *(string) --* 

              The name of the branch of the source repository where the workflow definition file is stored.

              
            

            - **definition** *(dict) --* 

              Information about the workflow definition file.

              
              

              - **path** *(string) --* 

                The path to the workflow definition file stored in the source repository for the project, including the file name.

                
          
            

            - **createdTime** *(datetime) --* 

              The date and time the workflow was created, in coordinated universal time (UTC) timestamp format as specified in `RFC 3339 <https://www.rfc-editor.org/rfc/rfc3339#section-5.6>`__

              
            

            - **lastUpdatedTime** *(datetime) --* 

              The date and time the workflow was last updated, in coordinated universal time (UTC) timestamp format as specified in `RFC 3339 <https://www.rfc-editor.org/rfc/rfc3339#section-5.6>`__

              
            

            - **runMode** *(string) --* 

              The run mode of the workflow.

              
            

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

              The status of the workflow.

              
        
      
        

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

          A token to resume pagination.

          
    