thing_registration_tasks

Creates, updates, deletes, gets or lists a thing_registration_tasks resource.

Overview

Name	thing_registration_tasks
Type	Resource
Id	aws.iot.thing_registration_tasks

Fields

The following fields are returned by SELECT queries:

describe_thing_registration_task

Name	Datatype	Description
creation_date	string (date-time)	The task creation date.
failure_count	integer	The number of things that failed to be provisioned.
input_file_bucket	string	The S3 bucket that contains the input file. (pattern: <code>[a-zA-Z0-9._-]+</code>)
input_file_key	string	The input file key. (pattern: <code>[a-zA-Z0-9!_.*'()-/]+</code>)
last_modified_date	string (date-time)	The date when the task was last modified.
message	string	The message.
percentage_progress	integer	The progress of the bulk provisioning task expressed as a percentage.
role_arn	string	The role ARN that grants access to the input file bucket.
status	string	The status of the bulk thing provisioning task. (InProgress, Completed, Failed, Cancelled, Cancelling)
success_count	integer	The number of things successfully provisioned.
task_id	string	The task ID.
template_body	string	The task's template. (pattern: <code>[\s\S]*</code>)

list_thing_registration_tasks

Name	Datatype	Description
task_id	string	A list of bulk thing provisioning task IDs.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_thing_registration_task	select	task_id, region		Describes a bulk thing provisioning task. Requires permission to access the DescribeThingRegistrationTask action.
list_thing_registration_tasks	select	region	nextToken, maxResults, status	List bulk thing provisioning tasks. Requires permission to access the ListThingRegistrationTasks action.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
task_id	string	The task ID.
maxResults	integer	The maximum number of results to return at one time.
nextToken	string	To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
status	string	The status of the bulk thing provisioning task.

SELECT examples

describe_thing_registration_task

Describes a bulk thing provisioning task. Requires permission to access the DescribeThingRegistrationTask action.

SELECT
creation_date,
failure_count,
input_file_bucket,
input_file_key,
last_modified_date,
message,
percentage_progress,
role_arn,
status,
success_count,
task_id,
template_body
FROM aws.iot.thing_registration_tasks
WHERE task_id = '{{ task_id }}' -- required
AND region = '{{ region }}' -- required
;

list_thing_registration_tasks

List bulk thing provisioning tasks. Requires permission to access the ListThingRegistrationTasks action.

SELECT
task_id
FROM aws.iot.thing_registration_tasks
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
AND status = '{{ status }}'
;