Skip to content

Commit fb3f980

Browse files
author
awstools
committed
feat(client-iot-wireless): Mark EutranCid under LteNmr optional.
1 parent 645466c commit fb3f980

19 files changed

+226
-186
lines changed

‎clients/client-iot-wireless/README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ AWS SDK for JavaScript IoTWireless Client for Node.js, Browser and React Native.
99
<p>AWS IoT Wireless provides bi-directional communication between internet-connected
1010
wireless devices and the AWS Cloud. To onboard both LoRaWAN and Sidewalk devices to AWS
1111
IoT, use the IoT Wireless API. These wireless devices use the Low Power Wide Area
12-
Networking (LPWAN) communication protocol to communicate with AWS IoT.</p>
12+
Networking (LPWAN) communication protocol to communicate with AWS IoT. </p>
1313
<p>Using the API, you can perform create, read, update, and delete operations for your
1414
wireless devices, gateways, destinations, and profiles. After onboarding your devices,
1515
you can use the API operations to set log levels and monitor your devices with
@@ -20,8 +20,11 @@ Firmware Updates Over-The-Air (FUOTA) API operations, you can create a FUOTA tas
2020
schedule a session to update the firmware of individual devices or an entire group of
2121
devices in a multicast group.</p>
2222
<p>To connect to the AWS IoT Wireless Service, use the Service endpoints as described in
23-
<a href="https://docs.aws.amazon.com/general/latest/gr/iot-lorawan.html#iot-wireless_region">IoT Wireless Service
24-
endpoints</a> in the <i>AWS General Reference</i>.</p>
23+
<a href="https://docs.aws.amazon.com/general/latest/gr/iot-lorawan.html#iot-wireless_region">IoT
24+
Wireless Service endpoints</a>. You can use both IPv4 and IPv6 protocols to connect
25+
to the endpoints and send requests to the AWS IoT Wireless service. For more information,
26+
see <a href="https://docs.aws.amazon.com/iot-wireless/latest/developerguide/wireless-ipv6-access.html">Using
27+
IPv6 with AWS IoT Wireless</a>.</p>
2528

2629
## Installing
2730

‎clients/client-iot-wireless/src/IoTWireless.ts

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2550,7 +2550,7 @@ export interface IoTWireless {
25502550
* <p>AWS IoT Wireless provides bi-directional communication between internet-connected
25512551
* wireless devices and the AWS Cloud. To onboard both LoRaWAN and Sidewalk devices to AWS
25522552
* IoT, use the IoT Wireless API. These wireless devices use the Low Power Wide Area
2553-
* Networking (LPWAN) communication protocol to communicate with AWS IoT.</p>
2553+
* Networking (LPWAN) communication protocol to communicate with AWS IoT. </p>
25542554
* <p>Using the API, you can perform create, read, update, and delete operations for your
25552555
* wireless devices, gateways, destinations, and profiles. After onboarding your devices,
25562556
* you can use the API operations to set log levels and monitor your devices with
@@ -2561,8 +2561,11 @@ export interface IoTWireless {
25612561
* schedule a session to update the firmware of individual devices or an entire group of
25622562
* devices in a multicast group.</p>
25632563
* <p>To connect to the AWS IoT Wireless Service, use the Service endpoints as described in
2564-
* <a href="https://docs.aws.amazon.com/general/latest/gr/iot-lorawan.html#iot-wireless_region">IoT Wireless Service
2565-
* endpoints</a> in the <i>AWS General Reference</i>.</p>
2564+
* <a href="https://docs.aws.amazon.com/general/latest/gr/iot-lorawan.html#iot-wireless_region">IoT
2565+
* Wireless Service endpoints</a>. You can use both IPv4 and IPv6 protocols to connect
2566+
* to the endpoints and send requests to the AWS IoT Wireless service. For more information,
2567+
* see <a href="https://docs.aws.amazon.com/iot-wireless/latest/developerguide/wireless-ipv6-access.html">Using
2568+
* IPv6 with AWS IoT Wireless</a>.</p>
25662569
* @public
25672570
*/
25682571
export class IoTWireless extends IoTWirelessClient implements IoTWireless {}

‎clients/client-iot-wireless/src/IoTWirelessClient.ts

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -862,7 +862,7 @@ export interface IoTWirelessClientResolvedConfig extends IoTWirelessClientResolv
862862
* <p>AWS IoT Wireless provides bi-directional communication between internet-connected
863863
* wireless devices and the AWS Cloud. To onboard both LoRaWAN and Sidewalk devices to AWS
864864
* IoT, use the IoT Wireless API. These wireless devices use the Low Power Wide Area
865-
* Networking (LPWAN) communication protocol to communicate with AWS IoT.</p>
865+
* Networking (LPWAN) communication protocol to communicate with AWS IoT. </p>
866866
* <p>Using the API, you can perform create, read, update, and delete operations for your
867867
* wireless devices, gateways, destinations, and profiles. After onboarding your devices,
868868
* you can use the API operations to set log levels and monitor your devices with
@@ -873,8 +873,11 @@ export interface IoTWirelessClientResolvedConfig extends IoTWirelessClientResolv
873873
* schedule a session to update the firmware of individual devices or an entire group of
874874
* devices in a multicast group.</p>
875875
* <p>To connect to the AWS IoT Wireless Service, use the Service endpoints as described in
876-
* <a href="https://docs.aws.amazon.com/general/latest/gr/iot-lorawan.html#iot-wireless_region">IoT Wireless Service
877-
* endpoints</a> in the <i>AWS General Reference</i>.</p>
876+
* <a href="https://docs.aws.amazon.com/general/latest/gr/iot-lorawan.html#iot-wireless_region">IoT
877+
* Wireless Service endpoints</a>. You can use both IPv4 and IPv6 protocols to connect
878+
* to the endpoints and send requests to the AWS IoT Wireless service. For more information,
879+
* see <a href="https://docs.aws.amazon.com/iot-wireless/latest/developerguide/wireless-ipv6-access.html">Using
880+
* IPv6 with AWS IoT Wireless</a>.</p>
878881
* @public
879882
*/
880883
export class IoTWirelessClient extends __Client<

‎clients/client-iot-wireless/src/commands/CreateWirelessGatewayCommand.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,19 +30,19 @@ export interface CreateWirelessGatewayCommandOutput extends CreateWirelessGatewa
3030
/**
3131
* <p>Provisions a wireless gateway.</p>
3232
* <note>
33-
* <p>When provisioning a wireless gateway, you might run into duplication errors
34-
* for the following reasons.</p>
33+
* <p>When provisioning a wireless gateway, you might run into duplication errors for
34+
* the following reasons.</p>
3535
* <ul>
3636
* <li>
3737
* <p>If you specify a <code>GatewayEui</code> value that already exists.</p>
3838
* </li>
3939
* <li>
4040
* <p>If you used a <code>ClientRequestToken</code> with the same parameters
41-
* within the last 10 minutes.</p>
41+
* within the last 10 minutes.</p>
4242
* </li>
4343
* </ul>
44-
* <p>To avoid this error, make sure that you use unique identifiers and parameters
45-
* for each request within the specified time period.</p>
44+
* <p>To avoid this error, make sure that you use unique identifiers and parameters for
45+
* each request within the specified time period.</p>
4646
* </note>
4747
* @example
4848
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-iot-wireless/src/commands/DeleteMulticastGroupCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface DeleteMulticastGroupCommandInput extends DeleteMulticastGroupRe
2828
export interface DeleteMulticastGroupCommandOutput extends DeleteMulticastGroupResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Deletes a multicast group if it is not in use by a fuota task.</p>
31+
* <p>Deletes a multicast group if it is not in use by a FUOTA task.</p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript

‎clients/client-iot-wireless/src/commands/DeleteWirelessGatewayCommand.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,19 +30,19 @@ export interface DeleteWirelessGatewayCommandOutput extends DeleteWirelessGatewa
3030
/**
3131
* <p>Deletes a wireless gateway.</p>
3232
* <note>
33-
* <p>When deleting a wireless gateway, you might run into duplication errors
34-
* for the following reasons.</p>
33+
* <p>When deleting a wireless gateway, you might run into duplication errors for the
34+
* following reasons.</p>
3535
* <ul>
3636
* <li>
3737
* <p>If you specify a <code>GatewayEui</code> value that already exists.</p>
3838
* </li>
3939
* <li>
4040
* <p>If you used a <code>ClientRequestToken</code> with the same parameters
41-
* within the last 10 minutes.</p>
41+
* within the last 10 minutes.</p>
4242
* </li>
4343
* </ul>
44-
* <p>To avoid this error, make sure that you use unique identifiers and parameters
45-
* for each request within the specified time period.</p>
44+
* <p>To avoid this error, make sure that you use unique identifiers and parameters for
45+
* each request within the specified time period.</p>
4646
* </note>
4747
* @example
4848
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-iot-wireless/src/commands/DisassociateMulticastGroupFromFuotaTaskCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ export interface DisassociateMulticastGroupFromFuotaTaskCommandOutput
3737
__MetadataBearer {}
3838

3939
/**
40-
* <p>Disassociates a multicast group from a fuota task.</p>
40+
* <p>Disassociates a multicast group from a FUOTA task.</p>
4141
* @example
4242
* Use a bare-bones client and the command you need to make an API call.
4343
* ```javascript

‎clients/client-iot-wireless/src/commands/GetLogLevelsByResourceTypesCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ export interface GetLogLevelsByResourceTypesCommandOutput
3333
__MetadataBearer {}
3434

3535
/**
36-
* <p>Returns current default log levels or log levels by resource types. Based on resource
37-
* types, log levels can be for wireless device log options or wireless gateway log
38-
* options.</p>
36+
* <p>Returns current default log levels or log levels by resource types. Based on the
37+
* resource type, log levels can be returned for wireless device, wireless gateway, or
38+
* FUOTA task log options.</p>
3939
* @example
4040
* Use a bare-bones client and the command you need to make an API call.
4141
* ```javascript

‎clients/client-iot-wireless/src/commands/GetPositionEstimateCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ export interface GetPositionEstimateCommandOutput extends GetPositionEstimateCom
143143
* { // LteNmrObj
144144
* Pci: Number("int"), // required
145145
* Earfcn: Number("int"), // required
146-
* EutranCid: Number("int"), // required
146+
* EutranCid: Number("int"),
147147
* Rsrp: Number("int"),
148148
* Rsrq: Number("float"),
149149
* },

‎clients/client-iot-wireless/src/commands/GetResourceLogLevelCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ export interface GetResourceLogLevelCommandInput extends GetResourceLogLevelRequ
2828
export interface GetResourceLogLevelCommandOutput extends GetResourceLogLevelResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Fetches the log-level override, if any, for a given resource-ID and resource-type. It
32-
* can be used for a wireless device, wireless gateway or fuota task.</p>
31+
* <p>Fetches the log-level override, if any, for a given resource ID and resource
32+
* type..</p>
3333
* @example
3434
* Use a bare-bones client and the command you need to make an API call.
3535
* ```javascript

‎clients/client-iot-wireless/src/commands/ListMulticastGroupsByFuotaTaskCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ export interface ListMulticastGroupsByFuotaTaskCommandOutput
3333
__MetadataBearer {}
3434

3535
/**
36-
* <p>List all multicast groups associated with a fuota task.</p>
36+
* <p>List all multicast groups associated with a FUOTA task.</p>
3737
* @example
3838
* Use a bare-bones client and the command you need to make an API call.
3939
* ```javascript

‎clients/client-iot-wireless/src/commands/PutResourceLogLevelCommand.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,8 @@ export interface PutResourceLogLevelCommandInput extends PutResourceLogLevelRequ
2828
export interface PutResourceLogLevelCommandOutput extends PutResourceLogLevelResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Sets the log-level override for a resource-ID and resource-type. This option can be
32-
* specified for a wireless gateway or a wireless device. A limit of 200 log level override
33-
* can be set per account.</p>
31+
* <p>Sets the log-level override for a resource ID and resource type. A limit of 200 log
32+
* level override can be set per account.</p>
3433
* @example
3534
* Use a bare-bones client and the command you need to make an API call.
3635
* ```javascript

‎clients/client-iot-wireless/src/commands/ResetAllResourceLogLevelsCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export interface ResetAllResourceLogLevelsCommandOutput extends ResetAllResource
2929

3030
/**
3131
* <p>Removes the log-level overrides for all resources; wireless devices, wireless
32-
* gateways, and fuota tasks.</p>
32+
* gateways, and FUOTA tasks.</p>
3333
* @example
3434
* Use a bare-bones client and the command you need to make an API call.
3535
* ```javascript

‎clients/client-iot-wireless/src/commands/ResetResourceLogLevelCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ export interface ResetResourceLogLevelCommandInput extends ResetResourceLogLevel
2828
export interface ResetResourceLogLevelCommandOutput extends ResetResourceLogLevelResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Removes the log-level override, if any, for a specific resource-ID and resource-type.
32-
* It can be used for a wireless device, a wireless gateway, or a fuota task.</p>
31+
* <p>Removes the log-level override, if any, for a specific resource ID and resource type.
32+
* It can be used for a wireless device, a wireless gateway, or a FUOTA task.</p>
3333
* @example
3434
* Use a bare-bones client and the command you need to make an API call.
3535
* ```javascript

‎clients/client-iot-wireless/src/commands/UpdateLogLevelsByResourceTypesCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ export interface UpdateLogLevelsByResourceTypesCommandOutput
3434

3535
/**
3636
* <p>Set default log level, or log levels by resource types. This can be for wireless
37-
* device log options or wireless gateways log options and is used to control the log
37+
* device, wireless gateway, or FUOTA task log options, and is used to control the log
3838
* messages that'll be displayed in CloudWatch.</p>
3939
* @example
4040
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-iot-wireless/src/index.ts

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
* <p>AWS IoT Wireless provides bi-directional communication between internet-connected
55
* wireless devices and the AWS Cloud. To onboard both LoRaWAN and Sidewalk devices to AWS
66
* IoT, use the IoT Wireless API. These wireless devices use the Low Power Wide Area
7-
* Networking (LPWAN) communication protocol to communicate with AWS IoT.</p>
7+
* Networking (LPWAN) communication protocol to communicate with AWS IoT. </p>
88
* <p>Using the API, you can perform create, read, update, and delete operations for your
99
* wireless devices, gateways, destinations, and profiles. After onboarding your devices,
1010
* you can use the API operations to set log levels and monitor your devices with
@@ -15,8 +15,11 @@
1515
* schedule a session to update the firmware of individual devices or an entire group of
1616
* devices in a multicast group.</p>
1717
* <p>To connect to the AWS IoT Wireless Service, use the Service endpoints as described in
18-
* <a href="https://docs.aws.amazon.com/general/latest/gr/iot-lorawan.html#iot-wireless_region">IoT Wireless Service
19-
* endpoints</a> in the <i>AWS General Reference</i>.</p>
18+
* <a href="https://docs.aws.amazon.com/general/latest/gr/iot-lorawan.html#iot-wireless_region">IoT
19+
* Wireless Service endpoints</a>. You can use both IPv4 and IPv6 protocols to connect
20+
* to the endpoints and send requests to the AWS IoT Wireless service. For more information,
21+
* see <a href="https://docs.aws.amazon.com/iot-wireless/latest/developerguide/wireless-ipv6-access.html">Using
22+
* IPv6 with AWS IoT Wireless</a>.</p>
2023
*
2124
* @packageDocumentation
2225
*/

0 commit comments

Comments
 (0)