DescribeThingRegistrationTask
Describes a bulk thing provisioning task.
Requires permission to access the DescribeThingRegistrationTask action.
Request Syntax
GET /thing-registration-tasks/taskId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- taskId
-
The task ID.
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
{
"creationDate": number,
"failureCount": number,
"inputFileBucket": "string",
"inputFileKey": "string",
"lastModifiedDate": number,
"message": "string",
"percentageProgress": number,
"roleArn": "string",
"status": "string",
"successCount": number,
"taskId": "string",
"templateBody": "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.
- creationDate
-
The task creation date.
Type: Timestamp
- failureCount
-
The number of things that failed to be provisioned.
Type: Integer
- inputFileBucket
-
The S3 bucket that contains the input file.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 256.
Pattern:
[a-zA-Z0-9._-]+ - inputFileKey
-
The input file key.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
[a-zA-Z0-9!_.*'()-\/]+ - lastModifiedDate
-
The date when the task was last modified.
Type: Timestamp
- message
-
The message.
Type: String
Length Constraints: Maximum length of 2048.
- percentageProgress
-
The progress of the bulk provisioning task expressed as a percentage.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
- roleArn
-
The role ARN that grants access to the input file bucket.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
- status
-
The status of the bulk thing provisioning task.
Type: String
Valid Values:
InProgress | Completed | Failed | Cancelled | Cancelling - successCount
-
The number of things successfully provisioned.
Type: Integer
- taskId
-
The task ID.
Type: String
Length Constraints: Maximum length of 40.
- templateBody
-
The task's template.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 10240.
Pattern:
[\s\S]*
Errors
- InternalFailureException
-
An unexpected error has occurred.
- message
-
The message for the exception.
HTTP Status Code: 500
- InvalidRequestException
-
The request is not valid.
- message
-
The message for the exception.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource does not exist.
- message
-
The message for the exception.
HTTP Status Code: 404
- ThrottlingException
-
The rate exceeds the limit.
- message
-
The message for the exception.
HTTP Status Code: 400
- UnauthorizedException
-
You are not authorized to perform this operation.
- message
-
The message for the exception.
HTTP Status Code: 401
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
