IoTWireless / Client / start_single_wireless_device_import_task
start_single_wireless_device_import_task#
- IoTWireless.Client.start_single_wireless_device_import_task(**kwargs)#
Start import task for a single wireless device.
See also: AWS API Documentation
Request Syntax
response = client.start_single_wireless_device_import_task( DestinationName='string', ClientRequestToken='string', DeviceName='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ], Sidewalk={ 'SidewalkManufacturingSn': 'string' } )
- Parameters:
DestinationName (string) –
[REQUIRED]
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.
ClientRequestToken (string) –
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.
This field is autopopulated if not provided.
DeviceName (string) – The name of the wireless device for which an import task is being started.
Tags (list) –
The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.
(dict) –
A simple label consisting of a customer-defined key-value pair
Key (string) – [REQUIRED]
The tag’s key value.
Value (string) – [REQUIRED]
The tag’s value.
Sidewalk (dict) –
[REQUIRED]
The Sidewalk-related parameters for importing a single wireless device.
SidewalkManufacturingSn (string) –
The Sidewalk manufacturing serial number (SMSN) of the device added to the import task.
- Return type:
dict
- Returns:
Response Syntax
{ 'Id': 'string', 'Arn': 'string' }
Response Structure
(dict) –
Id (string) –
The import task ID.
Arn (string) –
The ARN (Amazon Resource Name) of the import task.
Exceptions
IoTWireless.Client.exceptions.ValidationException
IoTWireless.Client.exceptions.AccessDeniedException
IoTWireless.Client.exceptions.ResourceNotFoundException
IoTWireless.Client.exceptions.InternalServerException
IoTWireless.Client.exceptions.ConflictException
IoTWireless.Client.exceptions.ThrottlingException