wireless_device_import_tasks

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

Overview

Name	wireless_device_import_tasks
Type	Resource
Id	aws.iotwireless.wireless_device_import_tasks

Fields

The following fields are returned by SELECT queries:

get_wireless_device_import_task

Name	Datatype	Description
arn	string	The ARN (Amazon Resource Name) of the import task.
creation_time	string (date-time)	The time at which the import task was created.
destination_name	string	The name of the destination that's assigned to the wireless devices in the import task. (pattern: <code>[a-zA-Z0-9-_]+</code>)
failed_imported_device_count	integer (int64)	The number of devices in the import task that failed to onboard to the import task.
id	string	The identifier of the import task for which information is retrieved.
initialized_imported_device_count	integer (int64)	The number of devices in the import task that are waiting for the control log to start processing.
onboarded_imported_device_count	integer (int64)	The number of devices in the import task that have been onboarded to the import task.
pending_imported_device_count	integer (int64)	The number of devices in the import task that are waiting in the import task queue to be onboarded.
positioning	string	The integration status of the Device Location feature for LoRaWAN and Sidewalk devices. (Enabled, Disabled)
sidewalk	object	The Sidewalk-related information about an import task.
status	string	The import task status. (INITIALIZING, INITIALIZED, PENDING, COMPLETE, FAILED, DELETING)
status_reason	string	The reason for the provided status information, such as a validation error that causes the import task to fail.

list_wireless_device_import_tasks

Name	Datatype	Description
next_token	string	The token to use to get the next set of results, or null if there are no additional results.
wireless_device_import_task_list	array	List of import tasks and summary information of onboarding status of devices in each import task.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_wireless_device_import_task	select	id, region		Get information about an import task and count of device onboarding summary information for the import task.
list_wireless_device_import_tasks	select	region	maxResults, nextToken	List of import tasks and summary information of onboarding status of devices in each import task.
update_wireless_device_import_task	update	id, region		Update an import task to add more devices to the task.
delete_wireless_device_import_task	delete	id, region		Delete an import task.

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
id	string	The unique identifier of the import task to be deleted.
region	string	AWS region (default: us-east-1)
maxResults	integer
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.

SELECT examples

get_wireless_device_import_task

Get information about an import task and count of device onboarding summary information for the import task.

SELECT
arn,
creation_time,
destination_name,
failed_imported_device_count,
id,
initialized_imported_device_count,
onboarded_imported_device_count,
pending_imported_device_count,
positioning,
sidewalk,
status,
status_reason
FROM aws.iotwireless.wireless_device_import_tasks
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

list_wireless_device_import_tasks

List of import tasks and summary information of onboarding status of devices in each import task.

SELECT
next_token,
wireless_device_import_task_list
FROM aws.iotwireless.wireless_device_import_tasks
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

UPDATE examples

update_wireless_device_import_task

Update an import task to add more devices to the task.

UPDATE aws.iotwireless.wireless_device_import_tasks
SET 
Sidewalk = '{{ Sidewalk }}'
WHERE 
id = '{{ id }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_wireless_device_import_task

Delete an import task.

DELETE FROM aws.iotwireless.wireless_device_import_tasks
WHERE id = '{{ id }}' --required
AND region = '{{ region }}' --required
;