Omics / Client / list_run_tasks
list_run_tasks#
- Omics.Client.list_run_tasks(**kwargs)#
Retrieves a list of tasks for a run.
See also: AWS API Documentation
Request Syntax
response = client.list_run_tasks( id='string', status='PENDING'|'STARTING'|'RUNNING'|'STOPPING'|'COMPLETED'|'CANCELLED'|'FAILED', startingToken='string', maxResults=123 )
- Parameters:
id (string) –
[REQUIRED]
The run’s ID.
status (string) – Filter the list by status.
startingToken (string) – Specify the pagination token from a previous request to retrieve the next page of results.
maxResults (integer) – The maximum number of run tasks to return in one page of results.
- Return type:
dict
- Returns:
Response Syntax
{ 'items': [ { 'taskId': 'string', 'status': 'PENDING'|'STARTING'|'RUNNING'|'STOPPING'|'COMPLETED'|'CANCELLED'|'FAILED', 'name': 'string', 'cpus': 123, '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.
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
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