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

GetRunGroup

Gets information about a workflow run group.

Request Syntax


GET /runGroup/id HTTP/1.1

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 does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "creationTime": "string",
   "id": "string",
   "maxCpus": number,
   "maxDuration": number,
   "maxGpus": number,
   "maxRuns": number,
   "name": "string",
   "tags": { 
      "string" : "string" 
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 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:.+

creationTime

When the group was created.

Type: Timestamp

id

The group's ID.

Type: String

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

Pattern: [0-9]+

maxCpus

The group's maximum number of CPUs to use.

Type: Integer

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

maxDuration

The group's maximum run time in minutes.

Type: Integer

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

maxGpus

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

Type: Integer

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

maxRuns

The maximum number of concurrent runs for the group.

Type: Integer

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

name

The group's name.

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}]+

tags

The group's tags.

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