Menu
AWS IoT
Developer Guide

StartThingRegistrationTask

StartThingRegistrationTask

Creates a bulk thing provisioning task.

https

Request syntax:

POST /thing-registration-tasks Content-type: application/json { "templateBody": "string", "inputFileBucket": "string", "inputFileKey": "string", "roleArn": "string" }

Request Body Parameters:

Name

Type

Req?

Description

templateBody

TemplateBody

yes

The provisioning template.

inputFileBucket

RegistryS3BucketName

yes

The S3 bucket that contains the input file.

inputFileKey

RegistryS3KeyName

yes

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).

roleArn

RoleArn

yes

The IAM role ARN that grants permission the input file.

Response syntax:

Content-type: application/json { "taskId": "string" }

Response Body Parameters:

Name

Type

Req?

Description

taskId

TaskId

no

The bulk thing provisioning task ID.

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 start-thing-registration-task \ --template-body <value> \ --input-file-bucket <value> \ --input-file-key <value> \ --role-arn <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "templateBody": "string", "inputFileBucket": "string", "inputFileKey": "string", "roleArn": "string" }

cli-input-json fields:

Name

Type

Description

templateBody

string

The provisioning template.

inputFileBucket

string

length- max:256 min:3

pattern: [a-zA-Z0-9._-]+

The S3 bucket that contains the input file.

inputFileKey

string

length- max:1024 min:1

pattern: [a-zA-Z0-9!_.*'()-/]+

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).

roleArn

string

length- max:2048 min:20

The IAM role ARN that grants permission the input file.

Output:

{ "taskId": "string" }

cli output fields:

Name

Type

Description

taskId

string

length- max:40

The bulk thing provisioning task ID.

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.