IoTWireless / Client / get_wireless_device_import_task

get_wireless_device_import_task#

IoTWireless.Client.get_wireless_device_import_task(**kwargs)#

Get information about an import task and count of device onboarding summary information for the import task.

See also: AWS API Documentation

Request Syntax

response = client.get_wireless_device_import_task(
    Id='string'
)
Parameters:

Id (string) –

[REQUIRED]

The identifier of the import task for which information is requested.

Return type:

dict

Returns:

Response Syntax

{
    'Id': 'string',
    'Arn': 'string',
    'DestinationName': 'string',
    'Sidewalk': {
        'DeviceCreationFileList': [
            'string',
        ],
        'Role': 'string'
    },
    'CreationTime': datetime(2015, 1, 1),
    'Status': 'INITIALIZING'|'INITIALIZED'|'PENDING'|'COMPLETE'|'FAILED'|'DELETING',
    'StatusReason': 'string',
    'InitializedImportedDeviceCount': 123,
    'PendingImportedDeviceCount': 123,
    'OnboardedImportedDeviceCount': 123,
    'FailedImportedDeviceCount': 123
}

Response Structure

  • (dict) –

    • Id (string) –

      The identifier of the import task for which information is retrieved.

    • Arn (string) –

      The ARN (Amazon Resource Name) of the import task.

    • DestinationName (string) –

      The name of the destination that’s assigned to the wireless devices in the import task.

    • Sidewalk (dict) –

      The Sidewalk-related information about an import task.

      • DeviceCreationFileList (list) –

        List of Sidewalk devices that are added to the import task.

        • (string) –

      • Role (string) –

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

    • CreationTime (datetime) –

      The time at which the import task was created.

    • Status (string) –

      The import task status.

    • StatusReason (string) –

      The reason for the provided status information, such as a validation error that causes the import task to fail.

    • InitializedImportedDeviceCount (integer) –

      The number of devices in the import task that are waiting for the control log to start processing.

    • PendingImportedDeviceCount (integer) –

      The number of devices in the import task that are waiting in the import task queue to be onboarded.

    • OnboardedImportedDeviceCount (integer) –

      The number of devices in the import task that have been onboarded to the import task.

    • FailedImportedDeviceCount (integer) –

      The number of devices in the import task that failed to onboard to the import task.

Exceptions