GetRunTask - HealthOmics API Reference

GetRunTask

Gets information about a workflow run task.

Request Syntax

GET /run/id/task/taskId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

id

The workflow run ID.

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

Pattern: [0-9]+

Required: Yes

taskId

The task'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 { "cpus": number, "creationTime": "string", "failureReason": "string", "gpus": number, "instanceType": "string", "logStream": "string", "memory": number, "name": "string", "startTime": "string", "status": "string", "statusMessage": "string", "stopTime": "string", "taskId": "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.

cpus

The task's CPU usage.

Type: Integer

Valid Range: Minimum value of 1.

creationTime

When the task was created.

Type: Timestamp

failureReason

The reason a task has failed.

Type: String

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

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

gpus

The number of Graphics Processing Units (GPU) specified in the task.

Type: Integer

Valid Range: Minimum value of 0.

instanceType

The instance type for a task.

Type: String

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

logStream

The task's log stream.

Type: String

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

memory

The task's memory use in gigabytes.

Type: Integer

Valid Range: Minimum value of 1.

name

The task's name.

Type: String

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

startTime

The task's start time.

Type: Timestamp

status

The task's status.

Type: String

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

Valid Values: PENDING | STARTING | RUNNING | STOPPING | COMPLETED | CANCELLED | FAILED

statusMessage

The task's status message.

Type: String

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

stopTime

The task's stop time.

Type: Timestamp

taskId

The task's ID.

Type: String

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

Pattern: [0-9]+

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: