GetMLTaskRunCommand

Suggest an Edit

Gets details for a specific task run on a machine learning transform. Machine learning task runs are asynchronous tasks that Glue runs on your behalf as part of various machine learning workflows. You can check the stats of any task run by calling GetMLTaskRun with the TaskRunID and its parent transform's TransformID.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { GlueClient, GetMLTaskRunCommand } from "@aws-sdk/client-glue"; // ES Modules import
// const { GlueClient, GetMLTaskRunCommand } = require("@aws-sdk/client-glue"); // CommonJS import
const client = new GlueClient(config);
const input = { // GetMLTaskRunRequest
  TransformId: "STRING_VALUE", // required
  TaskRunId: "STRING_VALUE", // required
};
const command = new GetMLTaskRunCommand(input);
const response = await client.send(command);
// { // GetMLTaskRunResponse
//   TransformId: "STRING_VALUE",
//   TaskRunId: "STRING_VALUE",
//   Status: "STARTING" || "RUNNING" || "STOPPING" || "STOPPED" || "SUCCEEDED" || "FAILED" || "TIMEOUT",
//   LogGroupName: "STRING_VALUE",
//   Properties: { // TaskRunProperties
//     TaskType: "EVALUATION" || "LABELING_SET_GENERATION" || "IMPORT_LABELS" || "EXPORT_LABELS" || "FIND_MATCHES",
//     ImportLabelsTaskRunProperties: { // ImportLabelsTaskRunProperties
//       InputS3Path: "STRING_VALUE",
//       Replace: true || false,
//     },
//     ExportLabelsTaskRunProperties: { // ExportLabelsTaskRunProperties
//       OutputS3Path: "STRING_VALUE",
//     },
//     LabelingSetGenerationTaskRunProperties: { // LabelingSetGenerationTaskRunProperties
//       OutputS3Path: "STRING_VALUE",
//     },
//     FindMatchesTaskRunProperties: { // FindMatchesTaskRunProperties
//       JobId: "STRING_VALUE",
//       JobName: "STRING_VALUE",
//       JobRunId: "STRING_VALUE",
//     },
//   },
//   ErrorString: "STRING_VALUE",
//   StartedOn: new Date("TIMESTAMP"),
//   LastModifiedOn: new Date("TIMESTAMP"),
//   CompletedOn: new Date("TIMESTAMP"),
//   ExecutionTime: Number("int"),
// };

GetMLTaskRunCommand Input

See GetMLTaskRunCommandInput for more details

Parameter
Type
Description
TaskRunId
Required
string | undefined

The unique identifier of the task run.

TransformId
Required
string | undefined

The unique identifier of the machine learning transform.

GetMLTaskRunCommand Output

See GetMLTaskRunCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
CompletedOn
Date | undefined

The date and time when this task run was completed.

ErrorString
string | undefined

The error strings that are associated with the task run.

ExecutionTime
number | undefined

The amount of time (in seconds) that the task run consumed resources.

LastModifiedOn
Date | undefined

The date and time when this task run was last modified.

LogGroupName
string | undefined

The names of the log groups that are associated with the task run.

Properties
TaskRunProperties | undefined

The list of properties that are associated with the task run.

StartedOn
Date | undefined

The date and time when this task run started.

Status
TaskStatusType | undefined

The status for this task run.

TaskRunId
string | undefined

The unique run identifier associated with this run.

TransformId
string | undefined

The unique identifier of the task run.

Throws

Name
Fault
Details
EntityNotFoundException
client

A specified entity does not exist

InternalServiceException
server

An internal service error occurred.

InvalidInputException
client

The input provided was not valid.

OperationTimeoutException
client

The operation timed out.

GlueServiceException
Base exception class for all service exceptions from Glue service.