[ aws . iot ]

describe-thing-registration-task

Description

Describes a bulk thing provisioning task.

Requires permission to access the DescribeThingRegistrationTask action.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

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

Options

--task-id (string)

The task ID.

--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

taskId -> (string)

The task ID.

creationDate -> (timestamp)

The task creation date.

lastModifiedDate -> (timestamp)

The date when the task was last modified.

templateBody -> (string)

The task’s template.

inputFileBucket -> (string)

The S3 bucket that contains the input file.

inputFileKey -> (string)

The input file key.

roleArn -> (string)

The role ARN that grants access to the input file bucket.

status -> (string)

The status of the bulk thing provisioning task.

message -> (string)

The message.

successCount -> (integer)

The number of things successfully provisioned.

failureCount -> (integer)

The number of things that failed to be provisioned.

percentageProgress -> (integer)

The progress of the bulk provisioning task expressed as a percentage.