AWS::IoTWireless::WirelessDeviceImportTask - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

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 Amazon 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

Maximum: 128

Pattern: [a-zA-Z0-9-_]+

Update requires: No interruption

Sidewalk

The Sidewalk-related information of the wireless device import task.

Required: Yes

Type: Sidewalk

Update requires: No interruption

Tags

Adds to or modifies the tags of the given resource. Tags are metadata that you can use to manage a resource.

Required: No

Type: List of Tag

Maximum: 200

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Reffunction, Refreturns 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

Property description not available.

Status

The status of a wireless device import task. The status can be INITIALIZING, INITIALIZED, PENDING, COMPLETE, FAILED, or DELETING.

StatusReason

The reason that provides additional information about the import task status.