Skip to content

Commit 7183c42

Browse files
New FuotaTask resource type to enable logging for your FUOTA tasks. A ParticipatingGatewaysforMulticast parameter to choose the list of gateways to receive the multicast downlink message and the transmission interval between them. Descriptor field which will be sent to devices during FUOTA transfer.
1 parent 217b110 commit 7183c42

38 files changed

+1376
-63
lines changed

generator/ServiceModels/iotwireless/iotwireless-2020-11-22.api.json

Lines changed: 76 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2451,7 +2451,8 @@
24512451
"Tags":{"shape":"TagList"},
24522452
"RedundancyPercent":{"shape":"RedundancyPercent"},
24532453
"FragmentSizeBytes":{"shape":"FragmentSizeBytes"},
2454-
"FragmentIntervalMS":{"shape":"FragmentIntervalMS"}
2454+
"FragmentIntervalMS":{"shape":"FragmentIntervalMS"},
2455+
"Descriptor":{"shape":"FileDescriptor"}
24552456
}
24562457
},
24572458
"CreateFuotaTaskResponse":{
@@ -3275,6 +3276,7 @@
32753276
"EventNotificationResourceType":{
32763277
"type":"string",
32773278
"enum":[
3279+
"FuotaTask",
32783280
"SidewalkAccount",
32793281
"WirelessDevice",
32803282
"WirelessGateway"
@@ -3329,6 +3331,11 @@
33293331
"min":0
33303332
},
33313333
"FactorySupport":{"type":"boolean"},
3334+
"FileDescriptor":{
3335+
"type":"string",
3336+
"max":332,
3337+
"pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"
3338+
},
33323339
"Fingerprint":{
33333340
"type":"string",
33343341
"max":64,
@@ -3383,6 +3390,25 @@
33833390
"type":"string",
33843391
"max":128
33853392
},
3393+
"FuotaTaskEvent":{
3394+
"type":"string",
3395+
"enum":["Fuota"]
3396+
},
3397+
"FuotaTaskEventLogOption":{
3398+
"type":"structure",
3399+
"required":[
3400+
"Event",
3401+
"LogLevel"
3402+
],
3403+
"members":{
3404+
"Event":{"shape":"FuotaTaskEvent"},
3405+
"LogLevel":{"shape":"LogLevel"}
3406+
}
3407+
},
3408+
"FuotaTaskEventLogOptionList":{
3409+
"type":"list",
3410+
"member":{"shape":"FuotaTaskEventLogOption"}
3411+
},
33863412
"FuotaTaskId":{
33873413
"type":"string",
33883414
"max":256
@@ -3391,6 +3417,22 @@
33913417
"type":"list",
33923418
"member":{"shape":"FuotaTask"}
33933419
},
3420+
"FuotaTaskLogOption":{
3421+
"type":"structure",
3422+
"required":[
3423+
"Type",
3424+
"LogLevel"
3425+
],
3426+
"members":{
3427+
"Type":{"shape":"FuotaTaskType"},
3428+
"LogLevel":{"shape":"LogLevel"},
3429+
"Events":{"shape":"FuotaTaskEventLogOptionList"}
3430+
}
3431+
},
3432+
"FuotaTaskLogOptionList":{
3433+
"type":"list",
3434+
"member":{"shape":"FuotaTaskLogOption"}
3435+
},
33943436
"FuotaTaskName":{
33953437
"type":"string",
33963438
"max":256
@@ -3405,6 +3447,10 @@
34053447
"Delete_Waiting"
34063448
]
34073449
},
3450+
"FuotaTaskType":{
3451+
"type":"string",
3452+
"enum":["LoRaWAN"]
3453+
},
34083454
"GPST":{"type":"float"},
34093455
"GatewayEui":{
34103456
"type":"string",
@@ -3425,6 +3471,11 @@
34253471
"DownlinkFrequency":{"shape":"DownlinkFrequency"}
34263472
}
34273473
},
3474+
"GatewayListMulticast":{
3475+
"type":"list",
3476+
"member":{"shape":"WirelessGatewayId"},
3477+
"max":20
3478+
},
34283479
"GatewayMaxEirp":{
34293480
"type":"float",
34303481
"max":30,
@@ -3523,7 +3574,8 @@
35233574
"CreatedAt":{"shape":"CreatedAt"},
35243575
"RedundancyPercent":{"shape":"RedundancyPercent"},
35253576
"FragmentSizeBytes":{"shape":"FragmentSizeBytes"},
3526-
"FragmentIntervalMS":{"shape":"FragmentIntervalMS"}
3577+
"FragmentIntervalMS":{"shape":"FragmentIntervalMS"},
3578+
"Descriptor":{"shape":"FileDescriptor"}
35273579
}
35283580
},
35293581
"GetLogLevelsByResourceTypesRequest":{
@@ -3536,7 +3588,8 @@
35363588
"members":{
35373589
"DefaultLogLevel":{"shape":"LogLevel"},
35383590
"WirelessGatewayLogOptions":{"shape":"WirelessGatewayLogOptionList"},
3539-
"WirelessDeviceLogOptions":{"shape":"WirelessDeviceLogOptionList"}
3591+
"WirelessDeviceLogOptions":{"shape":"WirelessDeviceLogOptionList"},
3592+
"FuotaTaskLogOptions":{"shape":"FuotaTaskLogOptionList"}
35403593
}
35413594
},
35423595
"GetMetricConfigurationRequest":{
@@ -4173,6 +4226,7 @@
41734226
"enum":[
41744227
"PartnerAccountId",
41754228
"DevEui",
4229+
"FuotaTaskId",
41764230
"GatewayEui",
41774231
"WirelessDeviceId",
41784232
"WirelessGatewayId"
@@ -4887,7 +4941,8 @@
48874941
"type":"structure",
48884942
"members":{
48894943
"RfRegion":{"shape":"SupportedRfRegion"},
4890-
"DlClass":{"shape":"DlClass"}
4944+
"DlClass":{"shape":"DlClass"},
4945+
"ParticipatingGateways":{"shape":"ParticipatingGatewaysMulticast"}
48914946
}
48924947
},
48934948
"LoRaWANMulticastGet":{
@@ -4896,7 +4951,8 @@
48964951
"RfRegion":{"shape":"SupportedRfRegion"},
48974952
"DlClass":{"shape":"DlClass"},
48984953
"NumberOfDevicesRequested":{"shape":"NumberOfDevicesRequested"},
4899-
"NumberOfDevicesInGroup":{"shape":"NumberOfDevicesInGroup"}
4954+
"NumberOfDevicesInGroup":{"shape":"NumberOfDevicesInGroup"},
4955+
"ParticipatingGateways":{"shape":"ParticipatingGatewaysMulticast"}
49004956
}
49014957
},
49024958
"LoRaWANMulticastMetadata":{
@@ -5386,6 +5442,13 @@
53865442
"TransmissionInterval":{"shape":"TransmissionInterval"}
53875443
}
53885444
},
5445+
"ParticipatingGatewaysMulticast":{
5446+
"type":"structure",
5447+
"members":{
5448+
"GatewayList":{"shape":"GatewayListMulticast"},
5449+
"TransmissionInterval":{"shape":"TransmissionIntervalMulticast"}
5450+
}
5451+
},
53895452
"PartnerAccountArn":{"type":"string"},
53905453
"PartnerAccountId":{
53915454
"type":"string",
@@ -6381,6 +6444,11 @@
63816444
"max":604800,
63826445
"min":1
63836446
},
6447+
"TransmissionIntervalMulticast":{
6448+
"type":"integer",
6449+
"max":60000,
6450+
"min":0
6451+
},
63846452
"TransmitMode":{
63856453
"type":"integer",
63866454
"max":1,
@@ -6509,7 +6577,8 @@
65096577
"FirmwareUpdateRole":{"shape":"FirmwareUpdateRole"},
65106578
"RedundancyPercent":{"shape":"RedundancyPercent"},
65116579
"FragmentSizeBytes":{"shape":"FragmentSizeBytes"},
6512-
"FragmentIntervalMS":{"shape":"FragmentIntervalMS"}
6580+
"FragmentIntervalMS":{"shape":"FragmentIntervalMS"},
6581+
"Descriptor":{"shape":"FileDescriptor"}
65136582
}
65146583
},
65156584
"UpdateFuotaTaskResponse":{
@@ -6521,6 +6590,7 @@
65216590
"type":"structure",
65226591
"members":{
65236592
"DefaultLogLevel":{"shape":"LogLevel"},
6593+
"FuotaTaskLogOptions":{"shape":"FuotaTaskLogOptionList"},
65246594
"WirelessDeviceLogOptions":{"shape":"WirelessDeviceLogOptionList"},
65256595
"WirelessGatewayLogOptions":{"shape":"WirelessGatewayLogOptionList"}
65266596
}

generator/ServiceModels/iotwireless/iotwireless-2020-11-22.docs.json

Lines changed: 73 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
"GetPositionConfiguration": "<p>Get position configuration for a given resource.</p> <important> <p>This action is no longer supported. Calls to retrieve the position configuration should use the <a href=\"https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_GetResourcePosition.html\">GetResourcePosition</a> API operation instead.</p> </important>",
5656
"GetPositionEstimate": "<p>Get estimated position information as a payload in GeoJSON format. The payload measurement data is resolved using solvers that are provided by third-party vendors.</p>",
5757
"GetResourceEventConfiguration": "<p>Get the event configuration for a particular resource identifier.</p>",
58-
"GetResourceLogLevel": "<p>Fetches the log-level override, if any, for a given resource-ID and resource-type. It can be used for a wireless device or a wireless gateway.</p>",
58+
"GetResourceLogLevel": "<p>Fetches the log-level override, if any, for a given resource-ID and resource-type. It can be used for a wireless device, wireless gateway or fuota task.</p>",
5959
"GetResourcePosition": "<p>Get the position information for a given wireless device or a wireless gateway resource. The position information uses the <a href=\"https://gisgeography.com/wgs84-world-geodetic-system/\"> World Geodetic System (WGS84)</a>.</p>",
6060
"GetServiceEndpoint": "<p>Gets the account-specific endpoint for Configuration and Update Server (CUPS) protocol or LoRaWAN Network Server (LNS) connections.</p>",
6161
"GetServiceProfile": "<p>Gets information about a service profile.</p>",
@@ -87,8 +87,8 @@
8787
"ListWirelessGateways": "<p>Lists the wireless gateways registered to your AWS account.</p>",
8888
"PutPositionConfiguration": "<p>Put position configuration for a given resource.</p> <important> <p>This action is no longer supported. Calls to update the position configuration should use the <a href=\"https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_UpdateResourcePosition.html\">UpdateResourcePosition</a> API operation instead.</p> </important>",
8989
"PutResourceLogLevel": "<p>Sets the log-level override for a resource-ID and resource-type. This option can be specified for a wireless gateway or a wireless device. A limit of 200 log level override can be set per account.</p>",
90-
"ResetAllResourceLogLevels": "<p>Removes the log-level overrides for all resources; both wireless devices and wireless gateways.</p>",
91-
"ResetResourceLogLevel": "<p>Removes the log-level override, if any, for a specific resource-ID and resource-type. It can be used for a wireless device or a wireless gateway.</p>",
90+
"ResetAllResourceLogLevels": "<p>Removes the log-level overrides for all resources; wireless devices, wireless gateways, and fuota tasks.</p>",
91+
"ResetResourceLogLevel": "<p>Removes the log-level override, if any, for a specific resource-ID and resource-type. It can be used for a wireless device, a wireless gateway, or a fuota task.</p>",
9292
"SendDataToMulticastGroup": "<p>Sends the specified data to a multicast group.</p>",
9393
"SendDataToWirelessDevice": "<p>Sends a decrypted application data frame to a device.</p>",
9494
"StartBulkAssociateWirelessDeviceWithMulticastGroup": "<p>Starts a bulk association of all qualifying wireless devices with a multicast group.</p>",
@@ -1351,6 +1351,14 @@
13511351
"DakCertificateMetadata$FactorySupport": "<p>Whether factory support has been enabled.</p>"
13521352
}
13531353
},
1354+
"FileDescriptor": {
1355+
"base": "<p>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</p>",
1356+
"refs": {
1357+
"CreateFuotaTaskRequest$Descriptor": null,
1358+
"GetFuotaTaskResponse$Descriptor": null,
1359+
"UpdateFuotaTaskRequest$Descriptor": null
1360+
}
1361+
},
13541362
"Fingerprint": {
13551363
"base": null,
13561364
"refs": {
@@ -1409,6 +1417,24 @@
14091417
"GetFuotaTaskResponse$Arn": null
14101418
}
14111419
},
1420+
"FuotaTaskEvent": {
1421+
"base": "<p>The event for a log message, if the log message is tied to a fuota task.</p>",
1422+
"refs": {
1423+
"FuotaTaskEventLogOption$Event": null
1424+
}
1425+
},
1426+
"FuotaTaskEventLogOption": {
1427+
"base": "<p>The log options for a FUOTA task event and can be used to set log levels for a specific fuota task event.</p> <p>For a LoRaWAN FuotaTask type, possible event for a log message is <code>Fuota</code>.</p>",
1428+
"refs": {
1429+
"FuotaTaskEventLogOptionList$member": null
1430+
}
1431+
},
1432+
"FuotaTaskEventLogOptionList": {
1433+
"base": "<p>The list of FUOTA task event log options.</p>",
1434+
"refs": {
1435+
"FuotaTaskLogOption$Events": null
1436+
}
1437+
},
14121438
"FuotaTaskId": {
14131439
"base": "<p>The ID of a FUOTA task.</p>",
14141440
"refs": {
@@ -1433,6 +1459,19 @@
14331459
"ListFuotaTasksResponse$FuotaTaskList": null
14341460
}
14351461
},
1462+
"FuotaTaskLogOption": {
1463+
"base": "<p>The log options for fuota tasks and can be used to set log levels for a specific type of fuota task.</p>",
1464+
"refs": {
1465+
"FuotaTaskLogOptionList$member": null
1466+
}
1467+
},
1468+
"FuotaTaskLogOptionList": {
1469+
"base": "<p>The list of fuota task log options.</p>",
1470+
"refs": {
1471+
"GetLogLevelsByResourceTypesResponse$FuotaTaskLogOptions": null,
1472+
"UpdateLogLevelsByResourceTypesRequest$FuotaTaskLogOptions": null
1473+
}
1474+
},
14361475
"FuotaTaskName": {
14371476
"base": "<p>The name of a FUOTA task.</p>",
14381477
"refs": {
@@ -1448,6 +1487,12 @@
14481487
"GetFuotaTaskResponse$Status": null
14491488
}
14501489
},
1490+
"FuotaTaskType": {
1491+
"base": "<p>The fuota task type.</p>",
1492+
"refs": {
1493+
"FuotaTaskLogOption$Type": "<p>The fuota task type.</p>"
1494+
}
1495+
},
14511496
"GPST": {
14521497
"base": null,
14531498
"refs": {
@@ -1473,6 +1518,12 @@
14731518
"GatewayList$member": null
14741519
}
14751520
},
1521+
"GatewayListMulticast": {
1522+
"base": null,
1523+
"refs": {
1524+
"ParticipatingGatewaysMulticast$GatewayList": "<p>The list of gateways that you want to use for sending the multicast downlink. Each downlink will be sent to all the gateways in the list with transmission interval between them. If list is empty the gateway list will be dynamically selected similar to the case of no ParticipatingGateways </p>"
1525+
}
1526+
},
14761527
"GatewayMaxEirp": {
14771528
"base": null,
14781529
"refs": {
@@ -2385,6 +2436,8 @@
23852436
"LogLevel": {
23862437
"base": "<p>The log level for a log message. The log levels can be disabled, or set to <code>ERROR</code> to display less verbose logs containing only error information, or to <code>INFO</code> for more detailed logs.</p>",
23872438
"refs": {
2439+
"FuotaTaskEventLogOption$LogLevel": null,
2440+
"FuotaTaskLogOption$LogLevel": null,
23882441
"GetLogLevelsByResourceTypesResponse$DefaultLogLevel": null,
23892442
"GetResourceLogLevelResponse$LogLevel": null,
23902443
"PutResourceLogLevelRequest$LogLevel": null,
@@ -2933,6 +2986,13 @@
29332986
"LoRaWANSendDataToDevice$ParticipatingGateways": "<p>Choose the gateways that you want to use for the downlink data traffic when the wireless device is running in class B or class C mode.</p>"
29342987
}
29352988
},
2989+
"ParticipatingGatewaysMulticast": {
2990+
"base": "<p>Specify the list of gateways to which you want to send the multicast downlink messages. The multicast message will be sent to each gateway in the sequence provided in the list.</p>",
2991+
"refs": {
2992+
"LoRaWANMulticast$ParticipatingGateways": null,
2993+
"LoRaWANMulticastGet$ParticipatingGateways": null
2994+
}
2995+
},
29362996
"PartnerAccountArn": {
29372997
"base": null,
29382998
"refs": {
@@ -3302,9 +3362,9 @@
33023362
"base": null,
33033363
"refs": {
33043364
"ConflictException$ResourceType": "<p>Type of the resource in the conflicting operation.</p>",
3305-
"GetResourceLogLevelRequest$ResourceType": "<p>The type of the resource, which can be <code>WirelessDevice</code> or <code>WirelessGateway</code>.</p>",
3306-
"PutResourceLogLevelRequest$ResourceType": "<p>The type of the resource, which can be <code>WirelessDevice</code> or <code>WirelessGateway</code>.</p>",
3307-
"ResetResourceLogLevelRequest$ResourceType": "<p>The type of the resource, which can be <code>WirelessDevice</code> or <code>WirelessGateway</code>.</p>",
3365+
"GetResourceLogLevelRequest$ResourceType": "<p>The type of the resource, which can be <code>WirelessDevice</code>, <code>WirelessGateway</code> or <code>FuotaTask</code>.</p>",
3366+
"PutResourceLogLevelRequest$ResourceType": "<p>The type of the resource, which can be <code>WirelessDevice</code>, <code>WirelessGateway</code>, or <code>FuotaTask</code>.</p>",
3367+
"ResetResourceLogLevelRequest$ResourceType": "<p>The type of the resource, which can be <code>WirelessDevice</code>, <code>WirelessGateway</code>, or <code>FuotaTask</code>.</p>",
33083368
"ResourceNotFoundException$ResourceType": "<p>Type of the font found resource.</p>"
33093369
}
33103370
},
@@ -3943,6 +4003,12 @@
39434003
"ParticipatingGateways$TransmissionInterval": "<p>The duration of time for which AWS IoT Core for LoRaWAN will wait before transmitting the payload to the next gateway.</p>"
39444004
}
39454005
},
4006+
"TransmissionIntervalMulticast": {
4007+
"base": null,
4008+
"refs": {
4009+
"ParticipatingGatewaysMulticast$TransmissionInterval": "<p>The duration of time for which AWS IoT Core for LoRaWAN will wait before transmitting the multicast payload to the next gateway in the list.</p>"
4010+
}
4011+
},
39464012
"TransmitMode": {
39474013
"base": null,
39484014
"refs": {
@@ -4418,6 +4484,7 @@
44184484
"DisassociateWirelessGatewayFromCertificateRequest$Id": "<p>The ID of the resource to update.</p>",
44194485
"DisassociateWirelessGatewayFromThingRequest$Id": "<p>The ID of the resource to update.</p>",
44204486
"GatewayListItem$GatewayId": "<p>The ID of the wireless gateways that you want to add to the list of gateways when sending downlink messages.</p>",
4487+
"GatewayListMulticast$member": null,
44214488
"GetWirelessGatewayCertificateRequest$Id": "<p>The ID of the resource to get.</p>",
44224489
"GetWirelessGatewayFirmwareInformationRequest$Id": "<p>The ID of the resource to get.</p>",
44234490
"GetWirelessGatewayResponse$Id": "<p>The ID of the wireless gateway.</p>",

0 commit comments

Comments
 (0)