Skip to content

start_wireless_device_import_task

start_wireless_device_import_task(
    destination_name: DestinationName,
    sidewalk: SidewalkStartImportInfo,
    *,
    config_overrides: Optional[IoTWirelessClientConfig] = None,
    client_request_token: Optional[ClientRequestToken] = None,
    tags: Optional[TagList] = None,
    positioning: Optional[PositioningConfigStatus] = None,
) -> StartWirelessDeviceImportTaskResponse

Start import task for provisioning Sidewalk devices in bulk using an S3 CSV file.

Parameters:

  • destination_name (DestinationName) –

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

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

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

  • sidewalk (SidewalkStartImportInfo) –

    The Sidewalk-related parameters for importing wireless devices that need to be provisioned in bulk.

Raises:

Source code in docs_src/capo_iot_wireless/_services/io_t_wireless.py
def start_wireless_device_import_task(
    self,
    destination_name: "capo_iot_wireless.types.destination_name.DestinationName",
    sidewalk: "capo_iot_wireless.types.sidewalk_start_import_info.SidewalkStartImportInfo",
    *,
    config_overrides: Optional[IoTWirelessClientConfig] = None,
    client_request_token: Optional[
        "capo_iot_wireless.types.client_request_token.ClientRequestToken"
    ] = 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_wireless_device_import_task_response.StartWirelessDeviceImportTaskResponse":
    """<p>Start import task for provisioning Sidewalk devices in bulk using an S3 CSV file.</p>

    Args:
        destination_name: <p>The name of the Sidewalk destination that describes the IoT rule to route messages from the devices in the import task that are onboarded to AWS IoT Wireless.</p>
        positioning: <p>The integration status of the Device Location feature for Sidewalk devices.</p>
        sidewalk: <p>The Sidewalk-related parameters for importing wireless devices that need to be provisioned in bulk.</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.
    """

    def _handler(
        req: "OperationRequest[capo_iot_wireless.types.start_wireless_device_import_task_request.StartWirelessDeviceImportTaskRequest]",
    ) -> OperationResponse[
        "capo_iot_wireless.types.start_wireless_device_import_task_response.StartWirelessDeviceImportTaskResponse"
    ]:
        import capo_iot_wireless._operations.iotwireless.start_wireless_device_import_task

        output, http_response = (
            capo_iot_wireless._operations.iotwireless.start_wireless_device_import_task.start_wireless_device_import_task(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartWirelessDeviceImportTask")
    )
    input_: capo_iot_wireless.types.start_wireless_device_import_task_request.StartWirelessDeviceImportTaskRequest = {
        "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 tags is not None:
        input_["tags"] = tags
    if positioning is not None:
        input_["positioning"] = positioning

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output