IoT / Client / start_thing_registration_task

start_thing_registration_task

IoT.Client.start_thing_registration_task(**kwargs)

Creates a bulk thing provisioning task.

Requires permission to access the StartThingRegistrationTask action.

See also: AWS API Documentation

Request Syntax

response = client.start_thing_registration_task(
    templateBody='string',
    inputFileBucket='string',
    inputFileKey='string',
    roleArn='string'
)

Parameters:

• templateBody (string) –

  [REQUIRED]

  The provisioning template.

• inputFileBucket (string) –

  [REQUIRED]

  The S3 bucket that contains the input file.

• inputFileKey (string) –

  [REQUIRED]

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

  [REQUIRED]

  The IAM role ARN that grants permission the input file.

Return type:

dict

Returns:

Response Syntax

{
    'taskId': 'string'
}

Response Structure

• (dict) –

  • taskId (string) –

    The bulk thing provisioning task ID.

Exceptions

• IoT.Client.exceptions.InvalidRequestException

• IoT.Client.exceptions.ThrottlingException

• IoT.Client.exceptions.UnauthorizedException

• IoT.Client.exceptions.InternalFailureException