create_fuota_task

IoTWireless.Client.create_fuota_task(**kwargs)

Creates a FUOTA task.

See also: AWS API Documentation

Request Syntax

response = client.create_fuota_task(
    Name='string',
    Description='string',
    ClientRequestToken='string',
    LoRaWAN={
        'RfRegion': 'EU868'|'US915'|'AU915'|'AS923-1'
    },
    FirmwareUpdateImage='string',
    FirmwareUpdateRole='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    RedundancyPercent=123,
    FragmentSizeBytes=123,
    FragmentIntervalMS=123
)

Parameters

• Name (string) -- The name of a FUOTA task.
• Description (string) -- The description of the new resource.
• ClientRequestToken (string) --

  Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

  This field is autopopulated if not provided.

• LoRaWAN (dict) --

  The LoRaWAN information used with a FUOTA task.

  • RfRegion (string) --

    Supported RfRegions

• FirmwareUpdateImage (string) --

  [REQUIRED]

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

• FirmwareUpdateRole (string) --

  [REQUIRED]

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

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

• RedundancyPercent (integer) -- The percentage of added redundant fragments. For example, if firmware file is 100 bytes and 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. Currently only supported in fuota tasks with multicast groups.
• FragmentIntervalMS (integer) -- The interval of sending fragments in milliseconds. Currently the interval will be rounded to the nearest second. Note that this interval only controls the timing when the cloud sends the fragments down. The actual delay of receiving fragments at device side depends on the device's class and the communication delay with the cloud.

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'Id': 'string'
}

Response Structure

• (dict) --

  • Arn (string) --

    The arn of a FUOTA task.

  • Id (string) --

    The ID of a FUOTA task.

Exceptions

• IoTWireless.Client.exceptions.ValidationException
• IoTWireless.Client.exceptions.ResourceNotFoundException
• IoTWireless.Client.exceptions.AccessDeniedException
• IoTWireless.Client.exceptions.ConflictException
• IoTWireless.Client.exceptions.InternalServerException
• IoTWireless.Client.exceptions.ThrottlingException