- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
GetRunTaskCommand
Gets information about a workflow run task.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { OmicsClient, GetRunTaskCommand } from "@aws-sdk/client-omics"; // ES Modules import
// const { OmicsClient, GetRunTaskCommand } = require("@aws-sdk/client-omics"); // CommonJS import
const client = new OmicsClient(config);
const input = { // GetRunTaskRequest
id: "STRING_VALUE", // required
taskId: "STRING_VALUE", // required
};
const command = new GetRunTaskCommand(input);
const response = await client.send(command);
// { // GetRunTaskResponse
// taskId: "STRING_VALUE",
// status: "STRING_VALUE",
// name: "STRING_VALUE",
// cpus: Number("int"),
// cacheHit: true || false,
// cacheS3Uri: "STRING_VALUE",
// memory: Number("int"),
// creationTime: new Date("TIMESTAMP"),
// startTime: new Date("TIMESTAMP"),
// stopTime: new Date("TIMESTAMP"),
// statusMessage: "STRING_VALUE",
// logStream: "STRING_VALUE",
// gpus: Number("int"),
// instanceType: "STRING_VALUE",
// failureReason: "STRING_VALUE",
// };
GetRunTaskCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
id Required | string | undefined | The workflow run ID. |
taskId Required | string | undefined | The task's ID. |
GetRunTaskCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
cacheHit | boolean | undefined | Set to true if AWS HealthOmics found a matching entry in the run cache for this task. |
cacheS3Uri | string | undefined | The S3 URI of the cache location. |
cpus | number | undefined | The task's CPU usage. |
creationTime | Date | undefined | When the task was created. |
failureReason | string | undefined | The reason a task has failed. |
gpus | number | undefined | The number of Graphics Processing Units (GPU) specified in the task. |
instanceType | string | undefined | The instance type for a task. |
logStream | string | undefined | The task's log stream. |
memory | number | undefined | The task's memory use in gigabytes. |
name | string | undefined | The task's name. |
startTime | Date | undefined | The task's start time. |
status | TaskStatus | undefined | The task's status. |
statusMessage | string | undefined | The task's status message. |
stopTime | Date | undefined | The task's stop time. |
taskId | string | undefined | The task's ID. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | You do not have sufficient access to perform this action. |
ConflictException | client | The request cannot be applied to the target resource in its current state. |
InternalServerException | server | An unexpected error occurred. Try the request again. |
RequestTimeoutException | client | The request timed out. |
ResourceNotFoundException | client | The target resource was not found in the current Region. |
ServiceQuotaExceededException | client | The request exceeds a service quota. |
ThrottlingException | client | The request was denied due to request throttling. |
ValidationException | client | The input fails to satisfy the constraints specified by an AWS service. |
OmicsServiceException | Base exception class for all service exceptions from Omics service. |