- 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.
UpdateTaskCommand
Updates a task.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { DeadlineClient, UpdateTaskCommand } from "@aws-sdk/client-deadline"; // ES Modules import
// const { DeadlineClient, UpdateTaskCommand } = require("@aws-sdk/client-deadline"); // CommonJS import
const client = new DeadlineClient(config);
const input = { // UpdateTaskRequest
clientToken: "STRING_VALUE",
targetRunStatus: "READY" || "FAILED" || "SUCCEEDED" || "CANCELED" || "SUSPENDED" || "PENDING", // required
farmId: "STRING_VALUE", // required
queueId: "STRING_VALUE", // required
jobId: "STRING_VALUE", // required
stepId: "STRING_VALUE", // required
taskId: "STRING_VALUE", // required
};
const command = new UpdateTaskCommand(input);
const response = await client.send(command);
// {};
UpdateTaskCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
farmId Required | string | undefined | The farm ID to update. |
jobId Required | string | undefined | The job ID to update. |
queueId Required | string | undefined | The queue ID to update. |
stepId Required | string | undefined | The step ID to update. |
targetRunStatus Required | TaskTargetRunStatus | undefined | The run status with which to start the task. |
taskId Required | string | undefined | The task ID to update. |
clientToken | string | undefined | The unique token which the server uses to recognize retries of the same request. |
UpdateTaskCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | You don't have permission to perform the action. |
ConflictException | client | Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time. |
InternalServerErrorException | server | Deadline Cloud can't process your request right now. Try again later. |
ResourceNotFoundException | client | The requested resource can't be found. |
ThrottlingException | client | Your request exceeded a request rate quota. |
ValidationException | client | The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. |
DeadlineServiceException | Base exception class for all service exceptions from Deadline service. |