Skip to content

Update Run Group

omics_update_run_group R Documentation

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

Description

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 update_run_group:

  • 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 list_run_groups or get_run_group API operations to verify that the desired changes have been made.

Usage

omics_update_run_group(id, name, maxCpus, maxRuns, maxDuration, maxGpus)

Arguments

id

[required] The group's ID.
name

A name for the group.
maxCpus

The maximum number of CPUs to use.
maxRuns

The maximum number of concurrent runs for the group.
maxDuration

A maximum run time for the group in minutes.
maxGpus

The maximum GPUs that can be used by a run group.

Value

An empty list.

Request syntax

svc$update_run_group(
  id = "string",
  name = "string",
  maxCpus = 123,
  maxRuns = 123,
  maxDuration = 123,
  maxGpus = 123
)