[ aws . snow-device-management ]

describe-task

Description

Checks the metadata for a given task on a device.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-task
--task-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--task-id (string)

The ID of the task to be described.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

completedAt -> (timestamp)

When the task was completed.

createdAt -> (timestamp)

When the CreateTask operation was called.

description -> (string)

The description provided of the task and managed devices.

lastUpdatedAt -> (timestamp)

When the state of the task was last updated.

state -> (string)

The current state of the task.

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)

targets -> (list)

The managed devices that the task was sent to.

(string)

taskArn -> (string)

The Amazon Resource Name (ARN) of the task.

taskId -> (string)

The ID of the task.