Omics / Client / create_run_group

create_run_group

Omics.Client.create_run_group(**kwargs)

You can optionally create a run group to limit the compute resources for the runs that you add to the group.

See also: AWS API Documentation

Request Syntax

response = client.create_run_group(
    name='string',
    maxCpus=123,
    maxRuns=123,
    maxDuration=123,
    tags={
        'string': 'string'
    },
    requestId='string',
    maxGpus=123
)

Parameters:

• name (string) – A name for the group.

• maxCpus (integer) – The maximum number of CPUs that can run concurrently across all active runs in the run group.

• maxRuns (integer) – The maximum number of runs that can be running at the same time.

• maxDuration (integer) – The maximum time for each run (in minutes). If a run exceeds the maximum run time, the run fails automatically.

• tags (dict) –

  Tags for the group.

  • (string) –

    • (string) –

• requestId (string) –

  [REQUIRED]

  To ensure that requests don’t run multiple times, specify a unique ID for each request.

  This field is autopopulated if not provided.

• maxGpus (integer) – The maximum number of GPUs that can run concurrently across all active runs in the run group.

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'id': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

• (dict) –

  • arn (string) –

    The group’s ARN.

  • id (string) –

    The group’s ID.

  • tags (dict) –

    Tags for the run group.

    • (string) –

      • (string) –

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