Skip to content

start_single_wireless_device_import_task async

start_single_wireless_device_import_task(
    destination_name: DestinationName,
    sidewalk: SidewalkSingleStartImportInfo,
    *,
    config_overrides: Optional[AsyncIoTWirelessClientConfig] = None,
    client_request_token: Optional[ClientRequestToken] = None,
    device_name: Optional[DeviceName] = None,
    tags: Optional[TagList] = None,
    positioning: Optional[PositioningConfigStatus] = None,
) -> StartSingleWirelessDeviceImportTaskResponse

Start import task for a single wireless device.

Parameters:

  • destination_name (DestinationName) –

    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.

  • device_name (Optional[DeviceName], default: None ) –

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

  • positioning (Optional[PositioningConfigStatus], default: None ) –

    The integration status of the Device Location feature for Sidewalk devices.

  • sidewalk (SidewalkSingleStartImportInfo) –

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

Raises:

Source code in docs_src/capo_iot_wireless/_services/async_io_t_wireless.py
async def start_single_wireless_device_import_task(
    self,
    destination_name: "capo_iot_wireless.types.destination_name.DestinationName",
    sidewalk: "capo_iot_wireless.types.sidewalk_single_start_import_info.SidewalkSingleStartImportInfo",
    *,
    config_overrides: Optional[AsyncIoTWirelessClientConfig] = None,
    client_request_token: Optional[
        "capo_iot_wireless.types.client_request_token.ClientRequestToken"
    ] = None,
    device_name: Optional["capo_iot_wireless.types.device_name.DeviceName"] = None,
    tags: Optional["capo_iot_wireless.types.tag_list.TagList"] = None,
    positioning: Optional[
        "capo_iot_wireless.types.positioning_config_status.PositioningConfigStatus"
    ] = None,
) -> "capo_iot_wireless.types.start_single_wireless_device_import_task_response.StartSingleWirelessDeviceImportTaskResponse":
    """<p>Start import task for a single wireless device.</p>

    Args:
        destination_name: <p>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.</p>
        device_name: <p>The name of the wireless device for which an import task is being started.</p>
        positioning: <p>The integration status of the Device Location feature for Sidewalk devices.</p>
        sidewalk: <p>The Sidewalk-related parameters for importing a single wireless device.</p>

    Raises:
        capo_iot_wireless.errors.access_denied_exception.AccessDeniedException: <p>User does not have permission to perform this action.</p>
        capo_iot_wireless.errors.conflict_exception.ConflictException: <p>Adding, updating, or deleting the resource can cause an inconsistent state.</p>
        capo_iot_wireless.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred while processing a request.</p>
        capo_iot_wireless.errors.resource_not_found_exception.ResourceNotFoundException: <p>Resource does not exist.</p>
        capo_iot_wireless.errors.throttling_exception.ThrottlingException: <p>The request was denied because it exceeded the allowed API request rate.</p>
        capo_iot_wireless.errors.validation_exception.ValidationException: <p>The input did not meet the specified constraints.</p>
        capo_iot_wireless.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_iot_wireless.types.start_single_wireless_device_import_task_request.StartSingleWirelessDeviceImportTaskRequest]",
    ) -> AsyncOperationResponse[
        "capo_iot_wireless.types.start_single_wireless_device_import_task_response.StartSingleWirelessDeviceImportTaskResponse"
    ]:
        import capo_iot_wireless._operations.iotwireless.start_single_wireless_device_import_task

        (
            output,
            http_response,
        ) = await capo_iot_wireless._operations.iotwireless.start_single_wireless_device_import_task.async_start_single_wireless_device_import_task(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartSingleWirelessDeviceImportTask")
    )
    input_: capo_iot_wireless.types.start_single_wireless_device_import_task_request.StartSingleWirelessDeviceImportTaskRequest = {
        "destination_name": destination_name,
        "sidewalk": sidewalk,
    }
    if client_request_token is None:
        client_request_token = str(uuid.uuid4())
    input_["client_request_token"] = client_request_token
    if device_name is not None:
        input_["device_name"] = device_name
    if tags is not None:
        input_["tags"] = tags
    if positioning is not None:
        input_["positioning"] = positioning

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output