Omics / Client / update_run_group

update_run_group

Omics.Client.update_run_group(**kwargs)

Updates the settings of a run group and returns a response with no body if the operation is successful.

You can update the following settings with UpdateRunGroup:

  • Maximum number of CPUs

  • Run time (measured in minutes)

  • Number of GPUs

  • Number of concurrent runs

  • Group name

To confirm that the settings have been successfully updated, use the ListRunGroups or GetRunGroup API operations to verify that the desired changes have been made.

See also: AWS API Documentation

Request Syntax

response = client.update_run_group(
    id='string',
    name='string',
    maxCpus=123,
    maxRuns=123,
    maxDuration=123,
    maxGpus=123
)
Parameters:

  • id (string) –

    [REQUIRED]

    The group’s ID.

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

  • maxCpus (integer) – The maximum number of CPUs to use.

  • maxRuns (integer) – The maximum number of concurrent runs for the group.

  • maxDuration (integer) – A maximum run time for the group in minutes.

  • maxGpus (integer) – The maximum GPUs that can be used by a run group.

Returns:

None

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