:doc:`Omics <../../omics>` / Client / list_workflows

**************
list_workflows
**************



.. py:method:: Omics.Client.list_workflows(**kwargs)

  

  Retrieves a list of existing workflows. You can filter for specific workflows by their name and type. Using the type parameter, specify ``PRIVATE`` to retrieve a list of private workflows or specify ``READY2RUN`` for a list of all Ready2Run workflows. If you do not specify the type of workflow, this operation returns a list of existing workflows.

  

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


  **Request Syntax**
  ::

    response = client.list_workflows(
        type='PRIVATE'|'READY2RUN',
        name='string',
        startingToken='string',
        maxResults=123
    )
    
  :type type: string
  :param type: 

    Filter the list by workflow type.

    

  
  :type name: string
  :param name: 

    Filter the list by workflow name.

    

  
  :type startingToken: string
  :param startingToken: 

    Specify the pagination token from a previous request to retrieve the next page of results.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of workflows to return in one page of results.

    

  
  
  :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 pagination token that's included if more results are available.

        
  
  **Exceptions**
  
  *   :py:class:`Omics.Client.exceptions.InternalServerException`

  
  *   :py:class:`Omics.Client.exceptions.ServiceQuotaExceededException`

  
  *   :py:class:`Omics.Client.exceptions.ThrottlingException`

  
  *   :py:class:`Omics.Client.exceptions.ValidationException`

  
  *   :py:class:`Omics.Client.exceptions.ConflictException`

  
  *   :py:class:`Omics.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`Omics.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`Omics.Client.exceptions.RequestTimeoutException`

  