CreateRunGroup
You can optionally create a run group to limit the compute resources for the runs that you add to the group.
Request Syntax
POST /runGroup HTTP/1.1
Content-type: application/json
{
"maxCpus": number,
"maxDuration": number,
"maxGpus": number,
"maxRuns": number,
"name": "string",
"requestId": "string",
"tags": {
"string" : "string"
}
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- maxCpus
-
The maximum number of CPUs that can run concurrently across all active runs in the run group.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100000.
Required: No
- maxDuration
-
The maximum time for each run (in minutes). If a run exceeds the maximum run time, the run fails automatically.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100000.
Required: No
- maxGpus
-
The maximum number of GPUs that can run concurrently across all active runs in the run group.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100000.
Required: No
- maxRuns
-
The maximum number of runs that can be running at the same time.
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
- requestId
-
To ensure that requests don't run multiple times, specify a unique ID for each request.
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: Yes
-
Tags for the group.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
Response Syntax
HTTP/1.1 201
Content-type: application/json
{
"arn": "string",
"id": "string",
"tags": {
"string" : "string"
}
}Response Elements
If the action is successful, the service sends back an HTTP 201 response.
The following data is returned in JSON format by the service.
- arn
-
The group's ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
arn:.+ - id
-
The group's ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 18.
Pattern:
[0-9]+ -
Tags for the run group.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
