IoTWireless / Client / get_fuota_task

get_fuota_task

IoTWireless.Client.get_fuota_task(**kwargs)

Gets information about a FUOTA task.

See also: AWS API Documentation

Request Syntax

response = client.get_fuota_task(
    Id='string'
)

Parameters:

Id (string) –

[REQUIRED]

The ID of a FUOTA task.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'Id': 'string',
    'Status': 'Pending'|'FuotaSession_Waiting'|'In_FuotaSession'|'FuotaDone'|'Delete_Waiting',
    'Name': 'string',
    'Description': 'string',
    'LoRaWAN': {
        'RfRegion': 'string',
        'StartTime': datetime(2015, 1, 1)
    },
    'FirmwareUpdateImage': 'string',
    'FirmwareUpdateRole': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'RedundancyPercent': 123,
    'FragmentSizeBytes': 123,
    'FragmentIntervalMS': 123,
    'Descriptor': 'string'
}

Response Structure

• (dict) –

  • Arn (string) –

    The arn of a FUOTA task.

  • Id (string) –

    The ID of a FUOTA task.

  • Status (string) –

    The status of a FUOTA task.

  • Name (string) –

    The name of a FUOTA task.

  • Description (string) –

    The description of the new resource.

  • LoRaWAN (dict) –

    The LoRaWAN information returned from getting a FUOTA task.

    • RfRegion (string) –

      The frequency band (RFRegion) value.

    • StartTime (datetime) –

      Start time of a FUOTA task.

  • FirmwareUpdateImage (string) –

    The S3 URI points to a firmware update image that is to be used with a FUOTA task.

  • FirmwareUpdateRole (string) –

    The firmware update role that is to be used with a FUOTA task.

  • CreatedAt (datetime) –

    Created at timestamp for the resource.

  • RedundancyPercent (integer) –

    The percentage of the added fragments that are redundant. For example, if the size of the firmware image file is 100 bytes and the fragment size is 10 bytes, with RedundancyPercent set to 50(%), the final number of encoded fragments is (100 / 10) + (100 / 10 * 50%) = 15.

  • FragmentSizeBytes (integer) –

    The size of each fragment in bytes. This parameter is supported only for FUOTA tasks with multicast groups.

  • FragmentIntervalMS (integer) –

    The interval for sending fragments in milliseconds, rounded to the nearest second.

    Note

    This interval only determines the timing for when the Cloud sends down the fragments to yor device. There can be a delay for when your device will receive these fragments. This delay depends on the device’s class and the communication delay with the cloud.

  • Descriptor (string) –

    The Descriptor specifies some metadata about the File being transferred using FUOTA e.g. the software version. It is sent transparently to the device. It is a binary field encoded in base64

Exceptions

• IoTWireless.Client.exceptions.ValidationException

• IoTWireless.Client.exceptions.ResourceNotFoundException

• IoTWireless.Client.exceptions.AccessDeniedException

• IoTWireless.Client.exceptions.InternalServerException

• IoTWireless.Client.exceptions.ThrottlingException