wireless_device_import_tasks

Creates, updates, deletes or gets a wireless_device_import_task resource or lists wireless_device_import_tasks in a region

Overview

Name	wireless_device_import_tasks
Type	Resource
Description	Wireless Device Import Tasks
Id	aws.iotwireless.wireless_device_import_tasks

Fields

Name	Datatype	Description
id	string	Id for Wireless Device Import Task, Returned upon successful start.
arn	string	Arn for Wireless Device Import Task, Returned upon successful start.
destination_name	string	Destination Name for import task
creation_date	string	CreationDate for import task
sidewalk	object	sidewalk contain file for created device and role
status	string	Status for import task
status_reason	string	StatusReason for import task
initialized_imported_devices_count	integer	Initialized Imported Devices Count
pending_imported_devices_count	integer	Pending Imported Devices Count
onboarded_imported_devices_count	integer	Onboarded Imported Devices Count
failed_imported_devices_count	integer	Failed Imported Devices Count
tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	DestinationName, Sidewalk, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all wireless_device_import_tasks in a region.

SELECT
region,
id,
arn,
destination_name,
creation_date,
sidewalk,
status,
status_reason,
initialized_imported_devices_count,
pending_imported_devices_count,
onboarded_imported_devices_count,
failed_imported_devices_count,
tags
FROM aws.iotwireless.wireless_device_import_tasks
WHERE region = 'us-east-1';

Gets all properties from an individual wireless_device_import_task.

SELECT
region,
id,
arn,
destination_name,
creation_date,
sidewalk,
status,
status_reason,
initialized_imported_devices_count,
pending_imported_devices_count,
onboarded_imported_devices_count,
failed_imported_devices_count,
tags
FROM aws.iotwireless.wireless_device_import_tasks
WHERE region = 'us-east-1' AND data__Identifier = '<Id>';

INSERT example

Use the following StackQL query and manifest file to create a new wireless_device_import_task resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.iotwireless.wireless_device_import_tasks (
 DestinationName,
 Sidewalk,
 region
)
SELECT 
'{{ DestinationName }}',
 '{{ Sidewalk }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.iotwireless.wireless_device_import_tasks (
 DestinationName,
 Sidewalk,
 Tags,
 region
)
SELECT 
 '{{ DestinationName }}',
 '{{ Sidewalk }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: wireless_device_import_task
    props:
      - name: DestinationName
        value: '{{ DestinationName }}'
      - name: Sidewalk
        value:
          SidewalkManufacturingSn: '{{ SidewalkManufacturingSn }}'
          DeviceCreationFile: '{{ DeviceCreationFile }}'
          DeviceCreationFileList:
            - '{{ DeviceCreationFileList[0] }}'
          Role: '{{ Role }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.iotwireless.wireless_device_import_tasks
WHERE data__Identifier = '<Id>'
AND region = 'us-east-1';

Permissions

To operate on the wireless_device_import_tasks resource, the following permissions are required:

Create

iotwireless:StartWirelessDeviceImportTask,
iotwireless:StartSingleWirelessDeviceImportTask,
iotwireless:TagResource,
iotwireless:ListTagsForResource,
iam:PassRole

Read

iotwireless:GetWirelessDeviceImportTask,
iotwireless:ListTagsForResource

Update

iotwireless:UpdateWirelessDeviceImportTask,
iotwireless:UntagResource,
iotwireless:ListTagsForResource,
iam:PassRole

Delete

iotwireless:DeleteWirelessDeviceImportTask

List

iotwireless:ListWirelessDeviceImportTasks,
iotwireless:ListTagsForResource