Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListDevicesForWirelessDeviceImportTask

List the Sidewalk devices in an import task and their onboarding status.

Request Syntax


GET /wireless_device_import_task?id=Id&maxResults=MaxResults&nextToken=NextToken&status=Status HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Id

The identifier of the import task for which wireless devices are listed.

Length Constraints: Maximum length of 256.

Required: Yes

MaxResults

The maximum number of results to return in this operation.

Valid Range: Minimum value of 0. Maximum value of 250.

NextToken

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

Length Constraints: Maximum length of 4096.

Status

The status of the devices in the import task.

Valid Values: INITIALIZED | PENDING | ONBOARDED | FAILED

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "DestinationName": "string",
   "ImportedWirelessDeviceList": [ 
      { 
         "Sidewalk": { 
            "LastUpdateTime": "string",
            "OnboardingStatus": "string",
            "OnboardingStatusReason": "string",
            "SidewalkManufacturingSn": "string"
         }
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

DestinationName

The name of the Sidewalk destination that describes the IoT rule to route messages received from devices in an import task that are onboarded to AWS IoT Wireless.

Type: String

Length Constraints: Maximum length of 128.

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

ImportedWirelessDeviceList

List of wireless devices in an import task and their onboarding status.

Type: Array of ImportedWirelessDevice objects

NextToken

The token to use to get the next set of results, or null if there are no additional results.

Type: String

Length Constraints: Maximum length of 4096.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

User does not have permission to perform this action.

HTTP Status Code: 403

ConflictException

Adding, updating, or deleting the resource can cause an inconsistent state.

HTTP Status Code: 409

InternalServerException

An unexpected error occurred while processing a request.

HTTP Status Code: 500

ResourceNotFoundException

Resource does not exist.

HTTP Status Code: 404

ThrottlingException

The request was denied because it exceeded the allowed API request rate.

HTTP Status Code: 429

ValidationException

The input did not meet the specified constraints.

HTTP Status Code: 400