Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Instructs one or more devices to start a task, such as unlocking or rebooting.

Example

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

import { SnowDeviceManagementClient, CreateTaskCommand } from "@aws-sdk/client-snow-device-management"; // ES Modules import
// const { SnowDeviceManagementClient, CreateTaskCommand } = require("@aws-sdk/client-snow-device-management"); // CommonJS import
const client = new SnowDeviceManagementClient(config);
const input = { // CreateTaskInput
targets: [ // TargetList // required
"STRING_VALUE",
],
command: { // Command Union: only one key present
unlock: {},
reboot: {},
},
description: "STRING_VALUE",
tags: { // TagMap
"<keys>": "STRING_VALUE",
},
clientToken: "STRING_VALUE",
};
const command = new CreateTaskCommand(input);
const response = await client.send(command);
// { // CreateTaskOutput
// taskId: "STRING_VALUE",
// taskArn: "STRING_VALUE",
// };

Param

CreateTaskCommandInput

Returns

CreateTaskCommandOutput

See

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

ServiceQuotaExceededException (client fault)

The request would cause a service quota to be exceeded.

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.

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods