Omics / Client / list_batch

list_batch¶

Omics.Client.list_batch(**kwargs)¶

Returns a list of run batches in your account, with optional filtering by status, name, or run group. Results are paginated. Only one filter per call is supported.

Request Syntax

response = client.list_batch(
    maxItems=123,
    startingToken='string',
    status='PENDING'|'SUBMITTING'|'INPROGRESS'|'STOPPING'|'CANCELLED'|'FAILED'|'PROCESSED'|'RUNS_DELETING'|'RUNS_DELETED',
    name='string',
    runGroupId='string'
)

Parameters:

maxItems (integer) – The maximum number of batches to return. If not specified, defaults to 100.
startingToken (string) – A pagination token returned from a prior ListBatch call.
status (string) – Filter batches by status.
name (string) – Filter batches by name.
runGroupId (string) – Filter batches by run group ID.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'id': 'string',
            'name': 'string',
            'status': 'PENDING'|'SUBMITTING'|'INPROGRESS'|'STOPPING'|'CANCELLED'|'FAILED'|'PROCESSED'|'RUNS_DELETING'|'RUNS_DELETED',
            'createdAt': datetime(2015, 1, 1),
            'totalRuns': 123,
            'workflowId': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- items (list) –
  
  A list of batch summary objects. See BatchListItem.
  - (dict) –
    
    A summary of a batch returned by ListBatch.
    - id (string) –
      
      The batch identifier.
    - name (string) –
      
      The batch name.
    - status (string) –
      
      The current batch status.
    - createdAt (datetime) –
      
      The timestamp when the batch was created.
    - totalRuns (integer) –
      
      The total number of runs in the batch.
    - workflowId (string) –
      
      The identifier of the workflow used for the batch.
- nextToken (string) –
  
  A pagination token to retrieve the next page of results. Absent when no further results are available.

Exceptions

Omics.Client.exceptions.InternalServerException
Omics.Client.exceptions.ThrottlingException
Omics.Client.exceptions.ValidationException
Omics.Client.exceptions.AccessDeniedException
Omics.Client.exceptions.RequestTimeoutException