:doc:`Omics <../../omics>` / Paginator / ListWorkflows

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



.. py:class:: Omics.Paginator.ListWorkflows

  ::

    
    paginator = client.get_paginator('list_workflows')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          type='PRIVATE'|'READY2RUN',
          name='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type type: string
    :param type: 

      Filter the list by workflow type.

      

    
    :type name: string
    :param name: 

      Filter the list by workflow name.

      

    
    :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': [
                {
                    'arn': 'string',
                    'id': 'string',
                    'name': 'string',
                    'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETED'|'FAILED'|'INACTIVE',
                    'type': 'PRIVATE'|'READY2RUN',
                    'digest': 'string',
                    'creationTime': datetime(2015, 1, 1),
                    'metadata': {
                        'string': 'string'
                    }
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

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

          A list of workflow items.

          
          

          - *(dict) --* 

            A workflow.

            
            

            - **arn** *(string) --* 

              The workflow's ARN.

              
            

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

              The workflow's ID.

              
            

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

              The workflow's name.

              
            

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

              The workflow's status.

              
            

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

              The workflow's type.

              
            

            - **digest** *(string) --* 

              The workflow's digest.

              
            

            - **creationTime** *(datetime) --* 

              When the workflow was created.

              
            

            - **metadata** *(dict) --* 

              Any metadata available for workflow. The information listed may vary depending on the workflow, and there may also be no metadata to return.

              
              

              - *(string) --* 
                

                - *(string) --* 
          
        
        
      
        

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

          A token to resume pagination.

          
    