v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-142381,278956.3 KB

Describes a bulk thing provisioning task.

Requires permission to access the DescribeThingRegistrationTask action.

get/thing-registration-tasks/{taskId}

Path parameters

taskIdstring required

The task ID.

Response

Success

taskIdstring

The task ID.

creationDatestring date-time

The task creation date.

lastModifiedDatestring date-time

The date when the task was last modified.

templateBodystring

The task's template.

inputFileBucketstring

The S3 bucket that contains the input file.

inputFileKeystring

The input file key.

roleArnstring

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

status'InProgress' | 'Completed' | 'Failed' | 'Cancelled' | 'Cancelling'

The status of the bulk thing provisioning task.

messagestring

The message.

successCountinteger

The number of things successfully provisioned.

failureCountinteger

The number of things that failed to be provisioned.

percentageProgressinteger

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