Omics / Client / get_run_group

get_run_group#

Omics.Client.get_run_group(**kwargs)#

Gets information about a workflow run group.

Request Syntax

response = client.get_run_group(
    id='string'
)

Parameters:

id (string) –

[REQUIRED]

The group’s ID.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- arn (string) –
  
  The group’s ARN.
- id (string) –
  
  The group’s ID.
- name (string) –
  
  The group’s name.
- maxCpus (integer) –
  
  The group’s maximum number of CPUs to use.
- maxRuns (integer) –
  
  The maximum number of concurrent runs for the group.
- maxDuration (integer) –
  
  The group’s maximum run time in minutes.
- creationTime (datetime) –
  
  When the group was created.
- tags (dict) –
  
  The group’s tags.
  - (string) –
    - (string) –
- maxGpus (integer) –
  
  The maximum GPUs that can be used by a run group.

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