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

**************
list_run_tasks
**************



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

  

  Returns a list of tasks and status information within their specified run. Use this operation to monitor runs and to identify which specific tasks have failed.

  

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


  **Request Syntax**
  ::

    response = client.list_run_tasks(
        id='string',
        status='PENDING'|'STARTING'|'RUNNING'|'STOPPING'|'COMPLETED'|'CANCELLED'|'FAILED',
        startingToken='string',
        maxResults=123
    )
    
  :type id: string
  :param id: **[REQUIRED]** 

    The run's ID.

    

  
  :type status: string
  :param status: 

    Filter the list by status.

    

  
  :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 run tasks to return in one page of results.

    

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

    
    ::

      {
          'items': [
              {
                  'taskId': 'string',
                  'status': 'PENDING'|'STARTING'|'RUNNING'|'STOPPING'|'COMPLETED'|'CANCELLED'|'FAILED',
                  'name': 'string',
                  'cpus': 123,
                  'cacheHit': True|False,
                  'cacheS3Uri': 'string',
                  'memory': 123,
                  'creationTime': datetime(2015, 1, 1),
                  'startTime': datetime(2015, 1, 1),
                  'stopTime': datetime(2015, 1, 1),
                  'gpus': 123,
                  'instanceType': 'string'
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        A list of tasks.

        
        

        - *(dict) --* 

          A workflow run task.

          
          

          - **taskId** *(string) --* 

            The task's ID.

            
          

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

            The task's status.

            
          

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

            The task's name.

            
          

          - **cpus** *(integer) --* 

            The task's CPU count.

            
          

          - **cacheHit** *(boolean) --* 

            Set to true if Amazon Web Services HealthOmics found a matching entry in the run cache for this task.

            
          

          - **cacheS3Uri** *(string) --* 

            The S3 URI of the cache location.

            
          

          - **memory** *(integer) --* 

            The task's memory use in gigabyes.

            
          

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

            When the task was created.

            
          

          - **startTime** *(datetime) --* 

            When the task started.

            
          

          - **stopTime** *(datetime) --* 

            When the task stopped.

            
          

          - **gpus** *(integer) --* 

            The number of Graphics Processing Units (GPU) specified for the task.

            
          

          - **instanceType** *(string) --* 

            The instance type for a task.

            
      
    
      

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

  