IoTWireless / Client / start_wireless_device_import_task

start_wireless_device_import_task#

IoTWireless.Client.start_wireless_device_import_task(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.start_wireless_device_import_task(
    DestinationName='string',
    ClientRequestToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    Sidewalk={
        'DeviceCreationFile': 'string',
        'Role': 'string'
    }
)
Parameters:

  • DestinationName (string) –

    [REQUIRED]

    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.

  • 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.

  • 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 wireless devices that need to be provisioned in bulk.

    • DeviceCreationFile (string) –

      The CSV file contained in an S3 bucket that’s used for adding devices to an import task.

    • Role (string) –

      The IAM role that allows AWS IoT Wireless to access the CSV file in the S3 bucket.

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