Omics / Client / list_runs

list_runs#

Omics.Client.list_runs(**kwargs)#

Retrieves a list of runs.

Request Syntax

response = client.list_runs(
    name='string',
    runGroupId='string',
    startingToken='string',
    maxResults=123,
    status='PENDING'|'STARTING'|'RUNNING'|'STOPPING'|'COMPLETED'|'DELETED'|'CANCELLED'|'FAILED'
)

Parameters:

name (string) – Filter the list by run name.
runGroupId (string) – Filter the list by run group ID.
startingToken (string) – Specify the pagination token from a previous request to retrieve the next page of results.
maxResults (integer) – The maximum number of runs to return in one page of results.
status (string) – The status of a run.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'arn': 'string',
            'id': 'string',
            'status': 'PENDING'|'STARTING'|'RUNNING'|'STOPPING'|'COMPLETED'|'DELETED'|'CANCELLED'|'FAILED',
            'workflowId': 'string',
            'name': 'string',
            'priority': 123,
            'storageCapacity': 123,
            'creationTime': datetime(2015, 1, 1),
            'startTime': datetime(2015, 1, 1),
            'stopTime': datetime(2015, 1, 1),
            'storageType': 'STATIC'|'DYNAMIC'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- items (list) –
  
  A list of runs.
  - (dict) –
    
    A workflow run.
    - arn (string) –
      
      The run’s ARN.
    - id (string) –
      
      The run’s ID.
    - status (string) –
      
      The run’s status.
    - workflowId (string) –
      
      The run’s workflow ID.
    - name (string) –
      
      The run’s name.
    - priority (integer) –
      
      The run’s priority.
    - storageCapacity (integer) –
      
      The run’s storage capacity in gibibytes. For dynamic storage, after the run has completed, this value is the maximum amount of storage used during the run.
    - creationTime (datetime) –
      
      When the run was created.
    - startTime (datetime) –
      
      When the run started.
    - stopTime (datetime) –
      
      When the run stopped.
    - storageType (string) –
      
      The run’s storage type.
- nextToken (string) –
  
  A pagination token that’s included if more results are available.

Exceptions

Omics.Client.exceptions.InternalServerException
Omics.Client.exceptions.ServiceQuotaExceededException
Omics.Client.exceptions.ThrottlingException
Omics.Client.exceptions.ValidationException
Omics.Client.exceptions.ConflictException
Omics.Client.exceptions.ResourceNotFoundException
Omics.Client.exceptions.AccessDeniedException
Omics.Client.exceptions.RequestTimeoutException