Menu
AWS IoT
Developer Guide

DescribeThingRegistrationTask

DescribeThingRegistrationTask

Describes a bulk thing provisioning task.

https

Request syntax:

GET /thing-registration-tasks/taskId

URI Request Parameters:

Name

Type

Req?

Description

taskId

TaskId

yes

The task ID.

Response syntax:

Content-type: application/json { "taskId": "string", "creationDate": "timestamp", "lastModifiedDate": "timestamp", "templateBody": "string", "inputFileBucket": "string", "inputFileKey": "string", "roleArn": "string", "status": "string", "message": "string", "successCount": "integer", "failureCount": "integer", "percentageProgress": "integer" }

Response Body Parameters:

Name

Type

Req?

Description

taskId

TaskId

no

The task ID.

creationDate

CreationDate

no

The task creation date.

lastModifiedDate

LastModifiedDate

no

The date when the task was last modified.

templateBody

TemplateBody

no

The task's template.

inputFileBucket

RegistryS3BucketName

no

The S3 bucket that contains the input file.

inputFileKey

RegistryS3KeyName

no

The input file key.

roleArn

RoleArn

no

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

status

Status

no

The status of the bulk thing provisioning task.

message

ErrorMessage

no

The message.

successCount

Count

no

The number of things successfully provisioned.

failureCount

Count

no

The number of things that failed to be provisioned.

percentageProgress

Percentage

no

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

Errors:

InvalidRequestException

The contents of the request were invalid. For example, this code is returned when an UpdateJobExecution request contains invalid status details. The message contains details about the error.

HTTP response code: 400

ThrottlingException

The rate exceeds the limit.

HTTP response code: 429

UnauthorizedException

You are not authorized to perform this operation.

HTTP response code: 401

InternalFailureException

An unexpected error has occurred.

HTTP response code: 500

ResourceNotFoundException

The specified resource does not exist.

HTTP response code: 404

cli

Synopsis:

aws iot describe-thing-registration-task \ --task-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "taskId": "string" }

cli-input-json fields:

Name

Type

Description

taskId

string

length- max:40

The task ID.

Output:

{ "taskId": "string", "creationDate": "timestamp", "lastModifiedDate": "timestamp", "templateBody": "string", "inputFileBucket": "string", "inputFileKey": "string", "roleArn": "string", "status": "string", "message": "string", "successCount": "integer", "failureCount": "integer", "percentageProgress": "integer" }

cli output fields:

Name

Type

Description

taskId

string

length- max:40

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

length- max:256 min:3

pattern: [a-zA-Z0-9._-]+

The S3 bucket that contains the input file.

inputFileKey

string

length- max:1024 min:1

pattern: [a-zA-Z0-9!_.*'()-/]+

The input file key.

roleArn

string

length- max:2048 min:20

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

status

string

The status of the bulk thing provisioning task.

enum: InProgress | Completed | Failed | Cancelled | Cancelling

message

string

length- max:2048

The message.

successCount

integer

The number of things successfully provisioned.

failureCount

integer

The number of things that failed to be provisioned.

percentageProgress

integer

range- max:100 min:0

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

Errors:

InvalidRequestException

The contents of the request were invalid. For example, this code is returned when an UpdateJobExecution request contains invalid status details. The message contains details about the error.

ThrottlingException

The rate exceeds the limit.

UnauthorizedException

You are not authorized to perform this operation.

InternalFailureException

An unexpected error has occurred.

ResourceNotFoundException

The specified resource does not exist.