Omics / Client / list_run_groups

list_run_groups#

Omics.Client.list_run_groups(**kwargs)#

Retrieves a list of run groups.

Request Syntax

response = client.list_run_groups(
    name='string',
    startingToken='string',
    maxResults=123
)

Parameters:

name (string) – The run groups’ name.
startingToken (string) – Specify the pagination token from a previous request to retrieve the next page of results.
maxResults (integer) – The maximum number of run groups to return in one page of results.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'arn': 'string',
            'id': 'string',
            'name': 'string',
            'maxCpus': 123,
            'maxRuns': 123,
            'maxDuration': 123,
            'creationTime': datetime(2015, 1, 1),
            'maxGpus': 123
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- items (list) –
  
  A list of groups.
  - (dict) –
    
    A run group.
    - arn (string) –
      
      The group’s ARN.
    - id (string) –
      
      The group’s ID.
    - name (string) –
      
      The group’s name.
    - maxCpus (integer) –
      
      The group’s maximum CPU count setting.
    - maxRuns (integer) –
      
      The group’s maximum concurrent run setting.
    - maxDuration (integer) –
      
      The group’s maximum duration setting in minutes.
    - creationTime (datetime) –
      
      When the group was created.
    - maxGpus (integer) –
      
      The maximum GPUs that can be used by a run group.
- 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