StartThingRegistrationTask
Creates a bulk thing provisioning task.
Requires permission to access the StartThingRegistrationTask action.
Request Syntax
POST /thing-registration-tasks HTTP/1.1
Content-type: application/json
{
"inputFileBucket": "string",
"inputFileKey": "string",
"roleArn": "string",
"templateBody": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- 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._-]+Required: Yes
- inputFileKey
-
The name of input file within the S3 bucket. This file contains a newline delimited JSON file. Each line contains the parameter values to provision one device (thing).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
[a-zA-Z0-9!_.*'()-\/]+Required: Yes
- roleArn
-
The IAM role ARN that grants permission the input file.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Required: Yes
- templateBody
-
The provisioning template.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 10240.
Pattern:
[\s\S]*Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"taskId": "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.
- taskId
-
The bulk thing provisioning task ID.
Type: String
Length Constraints: Maximum length of 40.
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
- 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:
