AWS::IoTWireless::WirelessDeviceImportTask
Information about an import task for wireless devices. When creating the resource,
either create a single wireless device import task using the Sidewalk manufacturing serial
number (SMSN) of the wireless device, or create an import task for multiple devices by
specifying both the DeviceCreationFile
and the Role
.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::IoTWireless::WirelessDeviceImportTask", "Properties" : { "DestinationName" :
String
, "Sidewalk" :Sidewalk
, "Tags" :[ Tag, ... ]
} }
YAML
Type: AWS::IoTWireless::WirelessDeviceImportTask Properties: DestinationName:
String
Sidewalk:Sidewalk
Tags:- Tag
Properties
DestinationName
-
The name of the destination that describes the IoT rule to route messages from the Sidewalk devices in the import task to other applications.
Required: Yes
Type: String
Pattern:
[a-zA-Z0-9-_]+
Maximum:
128
Update requires: No interruption
Sidewalk
-
The Sidewalk-related information of the wireless device import task.
Required: Yes
Type: Sidewalk
Update requires: No interruption
-
Adds to or modifies the tags of the given resource. Tags are metadata that you can use to manage a resource.
Required: No
Type: Array of Tag
Minimum:
0
Maximum:
200
Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the wireless device import task.
Fn::GetAtt
Arn
-
The ARN (Amazon Resource Name) of the import task.
CreationDate
-
The date and time at which the wireless device import task was created.
FailedImportedDevicesCount
-
The summary information of count of wireless devices that failed to onboard to the import task.
Id
-
The import task ID.
InitializedImportedDevicesCount
-
The summary information of count of wireless devices that are waiting for the control log to be added to an import task.
OnboardedImportedDevicesCount
-
The summary information of count of wireless devices that have been onboarded to the import task.
PendingImportedDevicesCount
-
The summary information of count of wireless devices that are waiting in the queue to be onboarded to the import task.
Sidewalk.DeviceCreationFileList
-
List of Sidewalk devices that are added to the import task.
Status
-
The status of a wireless device import task. The status can be
INITIALIZING
,INITIALIZED
,PENDING
,COMPLETE
,FAILED
, orDELETING
. StatusReason
-
The reason that provides additional information about the import task status.