ListThingRegistrationTaskReports - AWS IoT

ListThingRegistrationTaskReports

Information about the thing registration tasks.

Request Syntax

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

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of results to return per request.

Valid Range: Minimum value of 1. Maximum value of 250.

nextToken

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

reportType

The type of task report.

Valid Values: ERRORS | RESULTS

Required: Yes

taskId

The id of the task.

Length Constraints: Maximum length of 40.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

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

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

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

Type: String

reportType

The type of task report.

Type: String

Valid Values: ERRORS | RESULTS

Links to the task resources.

Type: Array of strings

Length Constraints: Maximum length of 65535.

Errors

InternalFailureException

An unexpected error has occurred.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 400

UnauthorizedException

You are not authorized to perform this operation.

HTTP Status Code: 401

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: