StartSingleWirelessDeviceImportTaskCommand

Suggest an Edit

Start import task for a single wireless device.

Example Syntax

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

import { IoTWirelessClient, StartSingleWirelessDeviceImportTaskCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import
// const { IoTWirelessClient, StartSingleWirelessDeviceImportTaskCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import
const client = new IoTWirelessClient(config);
const input = { // StartSingleWirelessDeviceImportTaskRequest
  DestinationName: "STRING_VALUE", // required
  ClientRequestToken: "STRING_VALUE",
  DeviceName: "STRING_VALUE",
  Tags: [ // TagList
    { // Tag
      Key: "STRING_VALUE", // required
      Value: "STRING_VALUE", // required
    },
  ],
  Sidewalk: { // SidewalkSingleStartImportInfo
    SidewalkManufacturingSn: "STRING_VALUE",
  },
};
const command = new StartSingleWirelessDeviceImportTaskCommand(input);
const response = await client.send(command);
// { // StartSingleWirelessDeviceImportTaskResponse
//   Id: "STRING_VALUE",
//   Arn: "STRING_VALUE",
// };

StartSingleWirelessDeviceImportTaskCommand Input

See StartSingleWirelessDeviceImportTaskCommandInput for more details

Parameter
Type
Description
DestinationName
Required
string | undefined

The name of the Sidewalk destination that describes the IoT rule to route messages from the device in the import task that will be onboarded to AWS IoT Wireless.

Sidewalk
Required
SidewalkSingleStartImportInfo | undefined

The Sidewalk-related parameters for importing a single wireless device.

ClientRequestToken
string | undefined

Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests .

DeviceName
string | undefined

The name of the wireless device for which an import task is being started.

Tags
Tag[] | undefined

The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.

StartSingleWirelessDeviceImportTaskCommand Output

See StartSingleWirelessDeviceImportTaskCommandOutput 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.

Id
string | undefined

The import task ID.

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.