GetWirelessDeviceImportTaskCommand

Suggest an Edit

Get information about an import task and count of device onboarding summary information for the import task.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { IoTWirelessClient, GetWirelessDeviceImportTaskCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import
// const { IoTWirelessClient, GetWirelessDeviceImportTaskCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import
const client = new IoTWirelessClient(config);
const input = { // GetWirelessDeviceImportTaskRequest
  Id: "STRING_VALUE", // required
};
const command = new GetWirelessDeviceImportTaskCommand(input);
const response = await client.send(command);
// { // GetWirelessDeviceImportTaskResponse
//   Id: "STRING_VALUE",
//   Arn: "STRING_VALUE",
//   DestinationName: "STRING_VALUE",
//   Sidewalk: { // SidewalkGetStartImportInfo
//     DeviceCreationFileList: [ // DeviceCreationFileList
//       "STRING_VALUE",
//     ],
//     Role: "STRING_VALUE",
//   },
//   CreationTime: new Date("TIMESTAMP"),
//   Status: "INITIALIZING" || "INITIALIZED" || "PENDING" || "COMPLETE" || "FAILED" || "DELETING",
//   StatusReason: "STRING_VALUE",
//   InitializedImportedDeviceCount: Number("long"),
//   PendingImportedDeviceCount: Number("long"),
//   OnboardedImportedDeviceCount: Number("long"),
//   FailedImportedDeviceCount: Number("long"),
// };

GetWirelessDeviceImportTaskCommand Input

See GetWirelessDeviceImportTaskCommandInput for more details

Parameter
Type
Description
Id
Required
string | undefined

The identifier of the import task for which information is requested.

GetWirelessDeviceImportTaskCommand Output

See GetWirelessDeviceImportTaskCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Arn
string | undefined

The ARN (Amazon Resource Name) of the import task.

CreationTime
Date | undefined

The time at which the import task was created.

DestinationName
string | undefined

The name of the destination that's assigned to the wireless devices in the import task.

FailedImportedDeviceCount
number | undefined

The number of devices in the import task that failed to onboard to the import task.

Id
string | undefined

The identifier of the import task for which information is retrieved.

InitializedImportedDeviceCount
number | undefined

The number of devices in the import task that are waiting for the control log to start processing.

OnboardedImportedDeviceCount
number | undefined

The number of devices in the import task that have been onboarded to the import task.

PendingImportedDeviceCount
number | undefined

The number of devices in the import task that are waiting in the import task queue to be onboarded.

Sidewalk
SidewalkGetStartImportInfo | undefined

The Sidewalk-related information about an import task.

Status
ImportTaskStatus | undefined

The import task status.

StatusReason
string | undefined

The reason for the provided status information, such as a validation error that causes the import task to fail.

Throws

Name
Fault
Details
AccessDeniedException
client

User does not have permission to perform this action.

ConflictException
client

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

InternalServerException
server

An unexpected error occurred while processing a request.

ResourceNotFoundException
client

Resource does not exist.

ThrottlingException
client

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

ValidationException
client

The input did not meet the specified constraints.

IoTWirelessServiceException
Base exception class for all service exceptions from IoTWireless service.