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	awscc.iotwireless.wireless_device_import_tasks

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
id	string	Id for Wireless Device Import Task, Returned upon successful start.
region	string	AWS region.

For more information, see AWS::IoTWireless::WirelessDeviceImportTask.

Methods

Name	Resource	Accessible by	Required Params
create_resource	wireless_device_import_tasks	INSERT	DestinationName, Sidewalk, region
delete_resource	wireless_device_import_tasks	DELETE	Identifier, region
update_resource	wireless_device_import_tasks	UPDATE	Identifier, PatchDocument, region
list_resources	wireless_device_import_tasks_list_only	SELECT	region
get_resource	wireless_device_import_tasks	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.iotwireless.wireless_device_import_tasks
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all wireless_device_import_tasks in a region.

SELECT
  region,
  id
FROM awscc.iotwireless.wireless_device_import_tasks_list_only
WHERE
  region = '{{ region }}';

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 awscc.iotwireless.wireless_device_import_tasks (
  DestinationName,
  Sidewalk,
  region
)
SELECT
  '{{ destination_name }}',
  '{{ sidewalk }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.iotwireless.wireless_device_import_tasks (
  DestinationName,
  Sidewalk,
  Tags,
  region
)
SELECT
  '{{ destination_name }}',
  '{{ sidewalk }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: destination_name
      value: '{{ destination_name }}'
    - name: sidewalk
      value:
        sidewalk_manufacturing_sn: '{{ sidewalk_manufacturing_sn }}'
        device_creation_file: '{{ device_creation_file }}'
        device_creation_file_list:
          - '{{ device_creation_file_list[0] }}'
        role: '{{ role }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.iotwireless.wireless_device_import_tasks
SET PatchDocument = string('{{ {
    "DestinationName": destination_name,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.iotwireless.wireless_device_import_tasks
WHERE
  Identifier = '{{ id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

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

Create

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

Read

iotwireless:GetWirelessDeviceImportTask,
iotwireless:ListTagsForResource

Update

iotwireless:GetWirelessDeviceImportTask,
iotwireless:UpdateWirelessDeviceImportTask,
iotwireless:TagResource,
iotwireless:UntagResource,
iam:PassRole

Delete

iotwireless:DeleteWirelessDeviceImportTask

List

iotwireless:ListWirelessDeviceImportTasks,
iotwireless:ListTagsForResource