Skip to content

Commit f2bb3e5

Browse files
author
AWS
committed
AWS IoT Wireless Update: 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 ec97191 commit f2bb3e5

File tree

2 files changed

+105
-12
lines changed

2 files changed

+105
-12
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "AWS IoT Wireless",
4+
"contributor": "",
5+
"description": "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."
6+
}

services/iotwireless/src/main/resources/codegen-resources/service-2.json

Lines changed: 99 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -994,7 +994,7 @@
994994
{"shape":"ThrottlingException"},
995995
{"shape":"ValidationException"}
996996
],
997-
"documentation":"<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>"
997+
"documentation":"<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>"
998998
},
999999
"GetResourcePosition":{
10001000
"name":"GetResourcePosition",
@@ -1538,7 +1538,7 @@
15381538
{"shape":"ThrottlingException"},
15391539
{"shape":"ValidationException"}
15401540
],
1541-
"documentation":"<p>Removes the log-level overrides for all resources; both wireless devices and wireless gateways.</p>"
1541+
"documentation":"<p>Removes the log-level overrides for all resources; wireless devices, wireless gateways, and fuota tasks.</p>"
15421542
},
15431543
"ResetResourceLogLevel":{
15441544
"name":"ResetResourceLogLevel",
@@ -1556,7 +1556,7 @@
15561556
{"shape":"ThrottlingException"},
15571557
{"shape":"ValidationException"}
15581558
],
1559-
"documentation":"<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>"
1559+
"documentation":"<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>"
15601560
},
15611561
"SendDataToMulticastGroup":{
15621562
"name":"SendDataToMulticastGroup",
@@ -2770,7 +2770,8 @@
27702770
"Tags":{"shape":"TagList"},
27712771
"RedundancyPercent":{"shape":"RedundancyPercent"},
27722772
"FragmentSizeBytes":{"shape":"FragmentSizeBytes"},
2773-
"FragmentIntervalMS":{"shape":"FragmentIntervalMS"}
2773+
"FragmentIntervalMS":{"shape":"FragmentIntervalMS"},
2774+
"Descriptor":{"shape":"FileDescriptor"}
27742775
}
27752776
},
27762777
"CreateFuotaTaskResponse":{
@@ -3832,6 +3833,7 @@
38323833
"EventNotificationResourceType":{
38333834
"type":"string",
38343835
"enum":[
3836+
"FuotaTask",
38353837
"SidewalkAccount",
38363838
"WirelessDevice",
38373839
"WirelessGateway"
@@ -3895,6 +3897,12 @@
38953897
"min":0
38963898
},
38973899
"FactorySupport":{"type":"boolean"},
3900+
"FileDescriptor":{
3901+
"type":"string",
3902+
"documentation":"<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>",
3903+
"max":332,
3904+
"pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"
3905+
},
38983906
"Fingerprint":{
38993907
"type":"string",
39003908
"max":64,
@@ -3956,6 +3964,28 @@
39563964
"documentation":"<p>The arn of a FUOTA task.</p>",
39573965
"max":128
39583966
},
3967+
"FuotaTaskEvent":{
3968+
"type":"string",
3969+
"documentation":"<p>The event for a log message, if the log message is tied to a fuota task.</p>",
3970+
"enum":["Fuota"]
3971+
},
3972+
"FuotaTaskEventLogOption":{
3973+
"type":"structure",
3974+
"required":[
3975+
"Event",
3976+
"LogLevel"
3977+
],
3978+
"members":{
3979+
"Event":{"shape":"FuotaTaskEvent"},
3980+
"LogLevel":{"shape":"LogLevel"}
3981+
},
3982+
"documentation":"<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>"
3983+
},
3984+
"FuotaTaskEventLogOptionList":{
3985+
"type":"list",
3986+
"member":{"shape":"FuotaTaskEventLogOption"},
3987+
"documentation":"<p>The list of FUOTA task event log options.</p>"
3988+
},
39593989
"FuotaTaskId":{
39603990
"type":"string",
39613991
"documentation":"<p>The ID of a FUOTA task.</p>",
@@ -3966,6 +3996,27 @@
39663996
"member":{"shape":"FuotaTask"},
39673997
"documentation":"<p>Lists the FUOTA tasks registered to your AWS account.</p>"
39683998
},
3999+
"FuotaTaskLogOption":{
4000+
"type":"structure",
4001+
"required":[
4002+
"Type",
4003+
"LogLevel"
4004+
],
4005+
"members":{
4006+
"Type":{
4007+
"shape":"FuotaTaskType",
4008+
"documentation":"<p>The fuota task type.</p>"
4009+
},
4010+
"LogLevel":{"shape":"LogLevel"},
4011+
"Events":{"shape":"FuotaTaskEventLogOptionList"}
4012+
},
4013+
"documentation":"<p>The log options for fuota tasks and can be used to set log levels for a specific type of fuota task.</p>"
4014+
},
4015+
"FuotaTaskLogOptionList":{
4016+
"type":"list",
4017+
"member":{"shape":"FuotaTaskLogOption"},
4018+
"documentation":"<p>The list of fuota task log options.</p>"
4019+
},
39694020
"FuotaTaskName":{
39704021
"type":"string",
39714022
"documentation":"<p>The name of a FUOTA task.</p>",
@@ -3982,6 +4033,11 @@
39824033
"Delete_Waiting"
39834034
]
39844035
},
4036+
"FuotaTaskType":{
4037+
"type":"string",
4038+
"documentation":"<p>The fuota task type.</p>",
4039+
"enum":["LoRaWAN"]
4040+
},
39854041
"GPST":{"type":"float"},
39864042
"GatewayEui":{
39874043
"type":"string",
@@ -4009,6 +4065,11 @@
40094065
},
40104066
"documentation":"<p>Gateway list item object that specifies the frequency and list of gateways for which the downlink message should be sent.</p>"
40114067
},
4068+
"GatewayListMulticast":{
4069+
"type":"list",
4070+
"member":{"shape":"WirelessGatewayId"},
4071+
"max":20
4072+
},
40124073
"GatewayMaxEirp":{
40134074
"type":"float",
40144075
"max":30,
@@ -4157,7 +4218,8 @@
41574218
"CreatedAt":{"shape":"CreatedAt"},
41584219
"RedundancyPercent":{"shape":"RedundancyPercent"},
41594220
"FragmentSizeBytes":{"shape":"FragmentSizeBytes"},
4160-
"FragmentIntervalMS":{"shape":"FragmentIntervalMS"}
4221+
"FragmentIntervalMS":{"shape":"FragmentIntervalMS"},
4222+
"Descriptor":{"shape":"FileDescriptor"}
41614223
}
41624224
},
41634225
"GetLogLevelsByResourceTypesRequest":{
@@ -4170,7 +4232,8 @@
41704232
"members":{
41714233
"DefaultLogLevel":{"shape":"LogLevel"},
41724234
"WirelessGatewayLogOptions":{"shape":"WirelessGatewayLogOptionList"},
4173-
"WirelessDeviceLogOptions":{"shape":"WirelessDeviceLogOptionList"}
4235+
"WirelessDeviceLogOptions":{"shape":"WirelessDeviceLogOptionList"},
4236+
"FuotaTaskLogOptions":{"shape":"FuotaTaskLogOptionList"}
41744237
}
41754238
},
41764239
"GetMetricConfigurationRequest":{
@@ -4507,7 +4570,7 @@
45074570
},
45084571
"ResourceType":{
45094572
"shape":"ResourceType",
4510-
"documentation":"<p>The type of the resource, which can be <code>WirelessDevice</code> or <code>WirelessGateway</code>.</p>",
4573+
"documentation":"<p>The type of the resource, which can be <code>WirelessDevice</code>, <code>WirelessGateway</code> or <code>FuotaTask</code>.</p>",
45114574
"location":"querystring",
45124575
"locationName":"resourceType"
45134576
}
@@ -5155,6 +5218,7 @@
51555218
"enum":[
51565219
"PartnerAccountId",
51575220
"DevEui",
5221+
"FuotaTaskId",
51585222
"GatewayEui",
51595223
"WirelessDeviceId",
51605224
"WirelessGatewayId"
@@ -6253,7 +6317,8 @@
62536317
"type":"structure",
62546318
"members":{
62556319
"RfRegion":{"shape":"SupportedRfRegion"},
6256-
"DlClass":{"shape":"DlClass"}
6320+
"DlClass":{"shape":"DlClass"},
6321+
"ParticipatingGateways":{"shape":"ParticipatingGatewaysMulticast"}
62576322
},
62586323
"documentation":"<p>The LoRaWAN information that is to be used with the multicast group.</p>"
62596324
},
@@ -6263,7 +6328,8 @@
62636328
"RfRegion":{"shape":"SupportedRfRegion"},
62646329
"DlClass":{"shape":"DlClass"},
62656330
"NumberOfDevicesRequested":{"shape":"NumberOfDevicesRequested"},
6266-
"NumberOfDevicesInGroup":{"shape":"NumberOfDevicesInGroup"}
6331+
"NumberOfDevicesInGroup":{"shape":"NumberOfDevicesInGroup"},
6332+
"ParticipatingGateways":{"shape":"ParticipatingGatewaysMulticast"}
62676333
},
62686334
"documentation":"<p>The LoRaWAN information that is to be returned from getting multicast group information.</p>"
62696335
},
@@ -6971,6 +7037,20 @@
69717037
},
69727038
"documentation":"<p>Specify the list of gateways to which you want to send downlink data traffic when the wireless device is running in class B or class C mode.</p>"
69737039
},
7040+
"ParticipatingGatewaysMulticast":{
7041+
"type":"structure",
7042+
"members":{
7043+
"GatewayList":{
7044+
"shape":"GatewayListMulticast",
7045+
"documentation":"<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>"
7046+
},
7047+
"TransmissionInterval":{
7048+
"shape":"TransmissionIntervalMulticast",
7049+
"documentation":"<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>"
7050+
}
7051+
},
7052+
"documentation":"<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>"
7053+
},
69747054
"PartnerAccountArn":{"type":"string"},
69757055
"PartnerAccountId":{
69767056
"type":"string",
@@ -7212,7 +7292,7 @@
72127292
},
72137293
"ResourceType":{
72147294
"shape":"ResourceType",
7215-
"documentation":"<p>The type of the resource, which can be <code>WirelessDevice</code> or <code>WirelessGateway</code>.</p>",
7295+
"documentation":"<p>The type of the resource, which can be <code>WirelessDevice</code>, <code>WirelessGateway</code>, or <code>FuotaTask</code>.</p>",
72167296
"location":"querystring",
72177297
"locationName":"resourceType"
72187298
},
@@ -7292,7 +7372,7 @@
72927372
},
72937373
"ResourceType":{
72947374
"shape":"ResourceType",
7295-
"documentation":"<p>The type of the resource, which can be <code>WirelessDevice</code> or <code>WirelessGateway</code>.</p>",
7375+
"documentation":"<p>The type of the resource, which can be <code>WirelessDevice</code>, <code>WirelessGateway</code>, or <code>FuotaTask</code>.</p>",
72967376
"location":"querystring",
72977377
"locationName":"resourceType"
72987378
}
@@ -8373,6 +8453,11 @@
83738453
"max":604800,
83748454
"min":1
83758455
},
8456+
"TransmissionIntervalMulticast":{
8457+
"type":"integer",
8458+
"max":60000,
8459+
"min":0
8460+
},
83768461
"TransmitMode":{
83778462
"type":"integer",
83788463
"max":1,
@@ -8546,7 +8631,8 @@
85468631
"FirmwareUpdateRole":{"shape":"FirmwareUpdateRole"},
85478632
"RedundancyPercent":{"shape":"RedundancyPercent"},
85488633
"FragmentSizeBytes":{"shape":"FragmentSizeBytes"},
8549-
"FragmentIntervalMS":{"shape":"FragmentIntervalMS"}
8634+
"FragmentIntervalMS":{"shape":"FragmentIntervalMS"},
8635+
"Descriptor":{"shape":"FileDescriptor"}
85508636
}
85518637
},
85528638
"UpdateFuotaTaskResponse":{
@@ -8558,6 +8644,7 @@
85588644
"type":"structure",
85598645
"members":{
85608646
"DefaultLogLevel":{"shape":"LogLevel"},
8647+
"FuotaTaskLogOptions":{"shape":"FuotaTaskLogOptionList"},
85618648
"WirelessDeviceLogOptions":{"shape":"WirelessDeviceLogOptionList"},
85628649
"WirelessGatewayLogOptions":{"shape":"WirelessGatewayLogOptionList"}
85638650
}

0 commit comments

Comments
 (0)