Class DescribeTaskCommandProtected

Checks the metadata for a given task on a device.

Example

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

import { SnowDeviceManagementClient, DescribeTaskCommand } from "@aws-sdk/client-snow-device-management"; // ES Modules import
// const { SnowDeviceManagementClient, DescribeTaskCommand } = require("@aws-sdk/client-snow-device-management"); // CommonJS import
const client = new SnowDeviceManagementClient(config);
const input = { // DescribeTaskInput
  taskId: "STRING_VALUE", // required
};
const command = new DescribeTaskCommand(input);
const response = await client.send(command);
// { // DescribeTaskOutput
//   taskId: "STRING_VALUE",
//   taskArn: "STRING_VALUE",
//   targets: [ // TargetList
//     "STRING_VALUE",
//   ],
//   state: "STRING_VALUE",
//   createdAt: new Date("TIMESTAMP"),
//   lastUpdatedAt: new Date("TIMESTAMP"),
//   completedAt: new Date("TIMESTAMP"),
//   description: "STRING_VALUE",
//   tags: { // TagMap
//     "<keys>": "STRING_VALUE",
//   },
// };

Param

DescribeTaskCommandInput

Returns

DescribeTaskCommandOutput

See

• DescribeTaskCommandInput for command's input shape.
• DescribeTaskCommandOutput for command's response shape.
• config for SnowDeviceManagementClient's config shape.

Throws

AccessDeniedException (client fault)

You don't have sufficient access to perform this action.

Throws

InternalServerException (server fault)

An unexpected error occurred while processing the request.

Throws

ResourceNotFoundException (client fault)

The request references a resource that doesn't exist.

Throws

ThrottlingException (client fault)

The request was denied due to request throttling.

Throws

ValidationException (client fault)

The input fails to satisfy the constraints specified by an Amazon Web Services service.

Throws

SnowDeviceManagementServiceException

Base exception class for all service exceptions from SnowDeviceManagement service.