Menu
AWS IoT
Developer Guide

ListThingRegistrationTasks

List bulk thing provisioning tasks.

Request syntax:

GET /thing-registration-tasks?maxResults=maxResults&nextToken=nextToken&status=status

URI Request Parameters:

Name

Type

Req?

Description

nextToken

NextToken

no

The token used to get the next set of results, or null if there are no additional results.

maxResults

RegistryMaxResults

no

The maximum number of results to return at one time.

status

Status

no

The status of the bulk thing provisioning task.

Response syntax:

Content-type: application/json { "taskIds": [ "string" ], "nextToken": "string" }

Response Body Parameters:

Name

Type

Req?

Description

taskIds

TaskIdList

no

A list of bulk thing provisioning task IDs.

nextToken

NextToken

no

The token used to get the next set of results, or null if there are no additional results.

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

CLI

Synopsis:

aws iot list-thing-registration-tasks \ [--next-token <value>] \ [--max-results <value>] \ [--status <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "nextToken": "string", "maxResults": "integer", "status": "string" }

cli-input-json fields:

Name

Type

Description

nextToken

string

The token used to get the next set of results, or null if there are no additional results.

maxResults

integer

java class: java.lang.Integer

range- max:250 min:1

The maximum number of results to return at one time.

status

string

enum: InProgress | Completed | Failed | Cancelled | Cancelling

java class: com.amazonaws.iot.common.types.enums.Status

The status of the bulk thing provisioning task.

Output:

{ "taskIds": [ "string" ], "nextToken": "string" }

cli output fields:

Name

Type

Description

taskIds

list

member: TaskId

A list of bulk thing provisioning task IDs.

TaskId

string

length max:40

nextToken

string

The token used to get the next set of results, or null if there are no additional results.

On this page: