Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateRunGroup

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.

Request Syntax


POST /runGroup/id HTTP/1.1
Content-type: application/json

{
   "maxCpus": number,
   "maxDuration": number,
   "maxGpus": number,
   "maxRuns": number,
   "name": "string"
}

URI Request Parameters

The request uses the following URI parameters.

id

The group's ID.

Length Constraints: Minimum length of 1. Maximum length of 18.

Pattern: [0-9]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

maxCpus

The maximum number of CPUs to use.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100000.

Required: No

maxDuration

A maximum run time for the group in minutes.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100000.

Required: No

maxGpus

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

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100000.

Required: No

maxRuns

The maximum number of concurrent runs for the group.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100000.

Required: No

name

A name for the group.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+

Required: No

Response Syntax


HTTP/1.1 202

Response Elements

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

The request cannot be applied to the target resource in its current state.

HTTP Status Code: 409

InternalServerException

An unexpected error occurred. Try the request again.

HTTP Status Code: 500

RequestTimeoutException

The request timed out.

HTTP Status Code: 408

ResourceNotFoundException

The target resource was not found in the current Region.

HTTP Status Code: 404

ServiceQuotaExceededException

The request exceeds a service quota.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400