|
423 | 423 | {"shape":"InternalServerException"},
|
424 | 424 | {"shape":"ThrottlingException"}
|
425 | 425 | ],
|
426 |
| - "documentation":"<p>Deletes a multicast group if it is not in use by a fuota task.</p>" |
| 426 | + "documentation":"<p>Deletes a multicast group if it is not in use by a FUOTA task.</p>" |
427 | 427 | },
|
428 | 428 | "DeleteNetworkAnalyzerConfiguration":{
|
429 | 429 | "name":"DeleteNetworkAnalyzerConfiguration",
|
|
621 | 621 | {"shape":"ConflictException"},
|
622 | 622 | {"shape":"InternalServerException"}
|
623 | 623 | ],
|
624 |
| - "documentation":"<p>Disassociates a multicast group from a fuota task.</p>" |
| 624 | + "documentation":"<p>Disassociates a multicast group from a FUOTA task.</p>" |
625 | 625 | },
|
626 | 626 | "DisassociateWirelessDeviceFromFuotaTask":{
|
627 | 627 | "name":"DisassociateWirelessDeviceFromFuotaTask",
|
|
798 | 798 | {"shape":"ThrottlingException"},
|
799 | 799 | {"shape":"ValidationException"}
|
800 | 800 | ],
|
801 |
| - "documentation":"<p>Returns current default log levels or log levels by resource types. Based on resource types, log levels can be for wireless device log options or wireless gateway log options.</p>" |
| 801 | + "documentation":"<p>Returns current default log levels or log levels by resource types. Based on the resource type, log levels can be returned for wireless device, wireless gateway, or FUOTA task log options.</p>" |
802 | 802 | },
|
803 | 803 | "GetMetricConfiguration":{
|
804 | 804 | "name":"GetMetricConfiguration",
|
|
994 | 994 | {"shape":"ThrottlingException"},
|
995 | 995 | {"shape":"ValidationException"}
|
996 | 996 | ],
|
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>" |
| 997 | + "documentation":"<p>Fetches the log-level override, if any, for a given resource ID and resource type..</p>" |
998 | 998 | },
|
999 | 999 | "GetResourcePosition":{
|
1000 | 1000 | "name":"GetResourcePosition",
|
|
1315 | 1315 | {"shape":"ResourceNotFoundException"},
|
1316 | 1316 | {"shape":"ThrottlingException"}
|
1317 | 1317 | ],
|
1318 |
| - "documentation":"<p>List all multicast groups associated with a fuota task.</p>" |
| 1318 | + "documentation":"<p>List all multicast groups associated with a FUOTA task.</p>" |
1319 | 1319 | },
|
1320 | 1320 | "ListNetworkAnalyzerConfigurations":{
|
1321 | 1321 | "name":"ListNetworkAnalyzerConfigurations",
|
|
1520 | 1520 | {"shape":"ThrottlingException"},
|
1521 | 1521 | {"shape":"ValidationException"}
|
1522 | 1522 | ],
|
1523 |
| - "documentation":"<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>" |
| 1523 | + "documentation":"<p>Sets the log-level override for a resource ID and resource type. A limit of 200 log level override can be set per account.</p>" |
1524 | 1524 | },
|
1525 | 1525 | "ResetAllResourceLogLevels":{
|
1526 | 1526 | "name":"ResetAllResourceLogLevels",
|
|
1538 | 1538 | {"shape":"ThrottlingException"},
|
1539 | 1539 | {"shape":"ValidationException"}
|
1540 | 1540 | ],
|
1541 |
| - "documentation":"<p>Removes the log-level overrides for all resources; wireless devices, wireless gateways, and fuota tasks.</p>" |
| 1541 | + "documentation":"<p>Removes the log-level overrides for all resources; wireless devices, wireless gateways, and FUOTA tasks.</p>" |
1542 | 1542 | },
|
1543 | 1543 | "ResetResourceLogLevel":{
|
1544 | 1544 | "name":"ResetResourceLogLevel",
|
|
1556 | 1556 | {"shape":"ThrottlingException"},
|
1557 | 1557 | {"shape":"ValidationException"}
|
1558 | 1558 | ],
|
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>" |
| 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>" |
1560 | 1560 | },
|
1561 | 1561 | "SendDataToMulticastGroup":{
|
1562 | 1562 | "name":"SendDataToMulticastGroup",
|
|
1831 | 1831 | {"shape":"ThrottlingException"},
|
1832 | 1832 | {"shape":"ValidationException"}
|
1833 | 1833 | ],
|
1834 |
| - "documentation":"<p>Set default log level, or log levels by resource types. This can be for wireless device log options or wireless gateways log options and is used to control the log messages that'll be displayed in CloudWatch.</p>" |
| 1834 | + "documentation":"<p>Set default log level, or log levels by resource types. This can be for wireless device, wireless gateway, or FUOTA task log options, and is used to control the log messages that'll be displayed in CloudWatch.</p>" |
1835 | 1835 | },
|
1836 | 1836 | "UpdateMetricConfiguration":{
|
1837 | 1837 | "name":"UpdateMetricConfiguration",
|
|
3899 | 3899 | "FactorySupport":{"type":"boolean"},
|
3900 | 3900 | "FileDescriptor":{
|
3901 | 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>", |
| 3902 | + "documentation":"<p>The descriptor is the metadata about the file that is transferred to the device using FUOTA, such as the software version. It is a binary field encoded in base64.</p>", |
3903 | 3903 | "max":332,
|
3904 | 3904 | "pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"
|
3905 | 3905 | },
|
|
3966 | 3966 | },
|
3967 | 3967 | "FuotaTaskEvent":{
|
3968 | 3968 | "type":"string",
|
3969 |
| - "documentation":"<p>The event for a log message, if the log message is tied to a fuota task.</p>", |
| 3969 | + "documentation":"<p>The event for a log message, if the log message is tied to a FUOTA task.</p>", |
3970 | 3970 | "enum":["Fuota"]
|
3971 | 3971 | },
|
3972 | 3972 | "FuotaTaskEventLogOption":{
|
|
3979 | 3979 | "Event":{"shape":"FuotaTaskEvent"},
|
3980 | 3980 | "LogLevel":{"shape":"LogLevel"}
|
3981 | 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>" |
| 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 FUOTA task, the only possible event for a log message is <code>Fuota</code>.</p>" |
3983 | 3983 | },
|
3984 | 3984 | "FuotaTaskEventLogOptionList":{
|
3985 | 3985 | "type":"list",
|
|
4005 | 4005 | "members":{
|
4006 | 4006 | "Type":{
|
4007 | 4007 | "shape":"FuotaTaskType",
|
4008 |
| - "documentation":"<p>The fuota task type.</p>" |
| 4008 | + "documentation":"<p>The FUOTA task type.</p>" |
4009 | 4009 | },
|
4010 | 4010 | "LogLevel":{"shape":"LogLevel"},
|
4011 | 4011 | "Events":{"shape":"FuotaTaskEventLogOptionList"}
|
4012 | 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>" |
| 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 | 4014 | },
|
4015 | 4015 | "FuotaTaskLogOptionList":{
|
4016 | 4016 | "type":"list",
|
4017 | 4017 | "member":{"shape":"FuotaTaskLogOption"},
|
4018 |
| - "documentation":"<p>The list of fuota task log options.</p>" |
| 4018 | + "documentation":"<p>The list of FUOTA task log options.</p>" |
4019 | 4019 | },
|
4020 | 4020 | "FuotaTaskName":{
|
4021 | 4021 | "type":"string",
|
|
4035 | 4035 | },
|
4036 | 4036 | "FuotaTaskType":{
|
4037 | 4037 | "type":"string",
|
4038 |
| - "documentation":"<p>The fuota task type.</p>", |
| 4038 | + "documentation":"<p>The FUOTA task type.</p>", |
4039 | 4039 | "enum":["LoRaWAN"]
|
4040 | 4040 | },
|
4041 | 4041 | "GPST":{"type":"float"},
|
|
4570 | 4570 | },
|
4571 | 4571 | "ResourceType":{
|
4572 | 4572 | "shape":"ResourceType",
|
4573 |
| - "documentation":"<p>The type of the resource, which can be <code>WirelessDevice</code>, <code>WirelessGateway</code> or <code>FuotaTask</code>.</p>", |
| 4573 | + "documentation":"<p>The type of resource, which can be <code>WirelessDevice</code>, <code>WirelessGateway</code>, or <code>FuotaTask</code>.</p>", |
4574 | 4574 | "location":"querystring",
|
4575 | 4575 | "locationName":"resourceType"
|
4576 | 4576 | }
|
|
4618 | 4618 | "members":{
|
4619 | 4619 | "ServiceType":{
|
4620 | 4620 | "shape":"WirelessGatewayServiceType",
|
4621 |
| - "documentation":"<p>The service type for which to get endpoint information about. Can be <code>CUPS</code> for the Configuration and Update Server endpoint, or <code>LNS</code> for the LoRaWAN Network Server endpoint or <code>CLAIM</code> for the global endpoint.</p>", |
| 4621 | + "documentation":"<p>The service type for which to get endpoint information about. Can be <code>CUPS</code> for the Configuration and Update Server endpoint, or <code>LNS</code> for the LoRaWAN Network Server endpoint.</p>", |
4622 | 4622 | "location":"querystring",
|
4623 | 4623 | "locationName":"serviceType"
|
4624 | 4624 | }
|
|
6534 | 6534 | "type":"structure",
|
6535 | 6535 | "required":[
|
6536 | 6536 | "Pci",
|
6537 |
| - "Earfcn", |
6538 |
| - "EutranCid" |
| 6537 | + "Earfcn" |
6539 | 6538 | ],
|
6540 | 6539 | "members":{
|
6541 | 6540 | "Pci":{
|
|
7042 | 7041 | "members":{
|
7043 | 7042 | "GatewayList":{
|
7044 | 7043 | "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>" |
| 7044 | + "documentation":"<p>The list of gateways that you want to use for sending the multicast downlink message. Each downlink message will be sent to all the gateways in the list in the order that you provided. If the gateway list is empty, then AWS IoT Core for LoRaWAN chooses the gateways that were most recently used by the devices to send an uplink message.</p>" |
7046 | 7045 | },
|
7047 | 7046 | "TransmissionInterval":{
|
7048 | 7047 | "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>" |
| 7048 | + "documentation":"<p>The duration of time in milliseconds for which AWS IoT Core for LoRaWAN will wait before transmitting the multicast payload to the next gateway in the list.</p>" |
7050 | 7049 | }
|
7051 | 7050 | },
|
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>" |
| 7051 | + "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 list, with the transmission interval as the time interval between each message.</p>" |
7053 | 7052 | },
|
7054 | 7053 | "PartnerAccountArn":{"type":"string"},
|
7055 | 7054 | "PartnerAccountId":{
|
|
7292 | 7291 | },
|
7293 | 7292 | "ResourceType":{
|
7294 | 7293 | "shape":"ResourceType",
|
7295 |
| - "documentation":"<p>The type of the resource, which can be <code>WirelessDevice</code>, <code>WirelessGateway</code>, or <code>FuotaTask</code>.</p>", |
| 7294 | + "documentation":"<p>The type of resource, which can be <code>WirelessDevice</code>, <code>WirelessGateway</code>, or <code>FuotaTask</code>.</p>", |
7296 | 7295 | "location":"querystring",
|
7297 | 7296 | "locationName":"resourceType"
|
7298 | 7297 | },
|
|
7372 | 7371 | },
|
7373 | 7372 | "ResourceType":{
|
7374 | 7373 | "shape":"ResourceType",
|
7375 |
| - "documentation":"<p>The type of the resource, which can be <code>WirelessDevice</code>, <code>WirelessGateway</code>, or <code>FuotaTask</code>.</p>", |
| 7374 | + "documentation":"<p>The type of resource, which can be <code>WirelessDevice</code>, <code>WirelessGateway</code>, or <code>FuotaTask</code>.</p>", |
7376 | 7375 | "location":"querystring",
|
7377 | 7376 | "locationName":"resourceType"
|
7378 | 7377 | }
|
|
7386 | 7385 | "ResourceId":{"type":"string"},
|
7387 | 7386 | "ResourceIdentifier":{
|
7388 | 7387 | "type":"string",
|
7389 |
| - "documentation":"<p>The identifier of the resource. For a Wireless Device, it is the wireless device ID. For a wireless gateway, it is the wireless gateway ID.</p>", |
| 7388 | + "documentation":"<p>The unique identifier of the resource, which can be the wireless gateway ID, the wireless device ID, or the FUOTA task ID.</p>", |
7390 | 7389 | "max":256
|
7391 | 7390 | },
|
7392 | 7391 | "ResourceNotFoundException":{
|
|
9511 | 9510 | "documentation":"<p>WirelessMetadata object.</p>"
|
9512 | 9511 | }
|
9513 | 9512 | },
|
9514 |
| - "documentation":"<p>AWS IoT Wireless provides bi-directional communication between internet-connected wireless devices and the AWS Cloud. To onboard both LoRaWAN and Sidewalk devices to AWS IoT, use the IoT Wireless API. These wireless devices use the Low Power Wide Area Networking (LPWAN) communication protocol to communicate with AWS IoT.</p> <p>Using the API, you can perform create, read, update, and delete operations for your wireless devices, gateways, destinations, and profiles. After onboarding your devices, you can use the API operations to set log levels and monitor your devices with CloudWatch.</p> <p>You can also use the API operations to create multicast groups and schedule a multicast session for sending a downlink message to devices in the group. By using Firmware Updates Over-The-Air (FUOTA) API operations, you can create a FUOTA task and schedule a session to update the firmware of individual devices or an entire group of devices in a multicast group.</p> <p>To connect to the AWS IoT Wireless Service, use the Service endpoints as described in <a href=\"https://docs.aws.amazon.com/general/latest/gr/iot-lorawan.html#iot-wireless_region\">IoT Wireless Service endpoints</a> in the <i>AWS General Reference</i>.</p>" |
| 9513 | + "documentation":"<p>AWS IoT Wireless provides bi-directional communication between internet-connected wireless devices and the AWS Cloud. To onboard both LoRaWAN and Sidewalk devices to AWS IoT, use the IoT Wireless API. These wireless devices use the Low Power Wide Area Networking (LPWAN) communication protocol to communicate with AWS IoT. </p> <p>Using the API, you can perform create, read, update, and delete operations for your wireless devices, gateways, destinations, and profiles. After onboarding your devices, you can use the API operations to set log levels and monitor your devices with CloudWatch.</p> <p>You can also use the API operations to create multicast groups and schedule a multicast session for sending a downlink message to devices in the group. By using Firmware Updates Over-The-Air (FUOTA) API operations, you can create a FUOTA task and schedule a session to update the firmware of individual devices or an entire group of devices in a multicast group.</p> <p>To connect to the AWS IoT Wireless Service, use the Service endpoints as described in <a href=\"https://docs.aws.amazon.com/general/latest/gr/iot-lorawan.html#iot-wireless_region\">IoT Wireless Service endpoints</a>. You can use both IPv4 and IPv6 protocols to connect to the endpoints and send requests to the AWS IoT Wireless service. For more information, see <a href=\"https://docs.aws.amazon.com/iot-wireless/latest/developerguide/wireless-ipv6-access.html\">Using IPv6 with AWS IoT Wireless</a>.</p>" |
9515 | 9514 | }
|
0 commit comments