Menu
AWS IoT
Developer Guide

ListThingRegistrationTaskReports

ListThingRegistrationTaskReports

Information about the thing registration tasks.

https

Request syntax:

GET /thing-registration-tasks/taskId/reports?reportType=reportType&maxResults=maxResults&nextToken=nextToken

URI Request Parameters:

Name

Type

Req?

Description

taskId

TaskId

yes

The id of the task.

reportType

ReportType

yes

The type of task report.

nextToken

NextToken

no

The token to retrieve the next set of results.

maxResults

RegistryMaxResults

no

The maximum number of results to return per request.

Response syntax:

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

Response Body Parameters:

Name

Type

Req?

Description

resourceLinks

S3FileUrlList

no

Links to the task resources.

reportType

ReportType

no

The type of task report.

nextToken

NextToken

no

The token to retrieve the next set of 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-task-reports \ --task-id <value> \ --report-type <value> \ [--next-token <value>] \ [--max-results <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "taskId": "string", "reportType": "string", "nextToken": "string", "maxResults": "integer" }

cli-input-json fields:

Name

Type

Description

taskId

string

length- max:40

The id of the task.

reportType

string

The type of task report.

enum: ERRORS | RESULTS

nextToken

string

The token to retrieve the next set of results.

maxResults

integer

range- max:250 min:1

The maximum number of results to return per request.

Output:

{ "resourceLinks": [ "string" ], "reportType": "string", "nextToken": "string" }

cli output fields:

Name

Type

Description

resourceLinks

list

member: S3FileUrl

Links to the task resources.

reportType

string

The type of task report.

enum: ERRORS | RESULTS

nextToken

string

The token to retrieve the next set of 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.

ThrottlingException

The rate exceeds the limit.

UnauthorizedException

You are not authorized to perform this operation.

InternalFailureException

An unexpected error has occurred.