Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . snow-device-management ]

create-task

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-task
[--client-token <value>]
--command <value>
[--description <value>]
[--tags <value>]
--targets <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--client-token (string)

A token ensuring that the action is called only once with the specified details.

--command (structure)

The task to be performed. Only one task is executed on a device at a time.

reboot -> (structure)

Reboots the device.

unlock -> (structure)

Unlocks the device.

Shorthand Syntax:

reboot={},unlock={}

JSON Syntax:

{
  "reboot": {

  },
  "unlock": {

  }
}

--description (string)

A description of the task and its targets.

--tags (map)

Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--targets (list)

A list of managed device IDs.

(string)

Syntax:

"string" "string" ...

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

taskArn -> (string)

The Amazon Resource Name (ARN) of the task that you created.

taskId -> (string)

The ID of the task that you created.