Skip to content

Commit 0276e59

Browse files
author
awstools
committed
feat(client-iot-wireless): Add Multicast Group support in Network Analyzer Configuration.
1 parent 84ca849 commit 0276e59

30 files changed

+854
-507
lines changed

clients/client-iot-wireless/README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,19 @@
66

77
AWS SDK for JavaScript IoTWireless Client for Node.js, Browser and React Native.
88

9-
<p>AWS IoT Wireless provides bi-directional communication between internet-connected wireless
10-
devices and the AWS Cloud. To onboard both LoRaWAN and Sidewalk devices to AWS IoT, use the
11-
IoT Wireless API. These wireless devices use the Low Power Wide Area Networking (LPWAN)
12-
communication protocol to communicate with AWS IoT.</p>
13-
<p>Using the API, you can perform create, read, update, and delete operations for your wireless
14-
devices, gateways, destinations, and profiles. After onboarding your devices, you
15-
can use the API operations to set log levels and monitor your devices with CloudWatch.</p>
16-
<p>You can also use the API operations to create multicast groups and schedule a multicast session for
17-
sending a downlink message to devices in the group. By using Firmware Updates Over-The-Air
18-
(FUOTA) API operations, you can create a FUOTA task and schedule a session to update the firmware
19-
of individual devices or an entire group of devices in a multicast group.</p>
9+
<p>AWS IoT Wireless provides bi-directional communication between internet-connected
10+
wireless devices and the AWS Cloud. To onboard both LoRaWAN and Sidewalk devices to AWS
11+
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>
13+
<p>Using the API, you can perform create, read, update, and delete operations for your
14+
wireless devices, gateways, destinations, and profiles. After onboarding your devices,
15+
you can use the API operations to set log levels and monitor your devices with
16+
CloudWatch.</p>
17+
<p>You can also use the API operations to create multicast groups and schedule a
18+
multicast session for sending a downlink message to devices in the group. By using
19+
Firmware Updates Over-The-Air (FUOTA) API operations, you can create a FUOTA task and
20+
schedule a session to update the firmware of individual devices or an entire group of
21+
devices in a multicast group.</p>
2022

2123
## Installing
2224

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

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2465,17 +2465,19 @@ export interface IoTWireless {
24652465

24662466
/**
24672467
* @public
2468-
* <p>AWS IoT Wireless provides bi-directional communication between internet-connected wireless
2469-
* devices and the AWS Cloud. To onboard both LoRaWAN and Sidewalk devices to AWS IoT, use the
2470-
* IoT Wireless API. These wireless devices use the Low Power Wide Area Networking (LPWAN)
2471-
* communication protocol to communicate with AWS IoT.</p>
2472-
* <p>Using the API, you can perform create, read, update, and delete operations for your wireless
2473-
* devices, gateways, destinations, and profiles. After onboarding your devices, you
2474-
* can use the API operations to set log levels and monitor your devices with CloudWatch.</p>
2475-
* <p>You can also use the API operations to create multicast groups and schedule a multicast session for
2476-
* sending a downlink message to devices in the group. By using Firmware Updates Over-The-Air
2477-
* (FUOTA) API operations, you can create a FUOTA task and schedule a session to update the firmware
2478-
* of individual devices or an entire group of devices in a multicast group.</p>
2468+
* <p>AWS IoT Wireless provides bi-directional communication between internet-connected
2469+
* wireless devices and the AWS Cloud. To onboard both LoRaWAN and Sidewalk devices to AWS
2470+
* IoT, use the IoT Wireless API. These wireless devices use the Low Power Wide Area
2471+
* Networking (LPWAN) communication protocol to communicate with AWS IoT.</p>
2472+
* <p>Using the API, you can perform create, read, update, and delete operations for your
2473+
* wireless devices, gateways, destinations, and profiles. After onboarding your devices,
2474+
* you can use the API operations to set log levels and monitor your devices with
2475+
* CloudWatch.</p>
2476+
* <p>You can also use the API operations to create multicast groups and schedule a
2477+
* multicast session for sending a downlink message to devices in the group. By using
2478+
* Firmware Updates Over-The-Air (FUOTA) API operations, you can create a FUOTA task and
2479+
* schedule a session to update the firmware of individual devices or an entire group of
2480+
* devices in a multicast group.</p>
24792481
*/
24802482
export class IoTWireless extends IoTWirelessClient implements IoTWireless {}
24812483
createAggregatedClient(commands, IoTWireless);

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

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -814,17 +814,19 @@ export interface IoTWirelessClientResolvedConfig extends IoTWirelessClientResolv
814814

815815
/**
816816
* @public
817-
* <p>AWS IoT Wireless provides bi-directional communication between internet-connected wireless
818-
* devices and the AWS Cloud. To onboard both LoRaWAN and Sidewalk devices to AWS IoT, use the
819-
* IoT Wireless API. These wireless devices use the Low Power Wide Area Networking (LPWAN)
820-
* communication protocol to communicate with AWS IoT.</p>
821-
* <p>Using the API, you can perform create, read, update, and delete operations for your wireless
822-
* devices, gateways, destinations, and profiles. After onboarding your devices, you
823-
* can use the API operations to set log levels and monitor your devices with CloudWatch.</p>
824-
* <p>You can also use the API operations to create multicast groups and schedule a multicast session for
825-
* sending a downlink message to devices in the group. By using Firmware Updates Over-The-Air
826-
* (FUOTA) API operations, you can create a FUOTA task and schedule a session to update the firmware
827-
* of individual devices or an entire group of devices in a multicast group.</p>
817+
* <p>AWS IoT Wireless provides bi-directional communication between internet-connected
818+
* wireless devices and the AWS Cloud. To onboard both LoRaWAN and Sidewalk devices to AWS
819+
* IoT, use the IoT Wireless API. These wireless devices use the Low Power Wide Area
820+
* Networking (LPWAN) communication protocol to communicate with AWS IoT.</p>
821+
* <p>Using the API, you can perform create, read, update, and delete operations for your
822+
* wireless devices, gateways, destinations, and profiles. After onboarding your devices,
823+
* you can use the API operations to set log levels and monitor your devices with
824+
* CloudWatch.</p>
825+
* <p>You can also use the API operations to create multicast groups and schedule a
826+
* multicast session for sending a downlink message to devices in the group. By using
827+
* Firmware Updates Over-The-Air (FUOTA) API operations, you can create a FUOTA task and
828+
* schedule a session to update the firmware of individual devices or an entire group of
829+
* devices in a multicast group.</p>
828830
*/
829831
export class IoTWirelessClient extends __Client<
830832
__HttpHandlerOptions,

clients/client-iot-wireless/src/commands/CreateNetworkAnalyzerConfigurationCommand.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ export interface CreateNetworkAnalyzerConfigurationCommandOutput
5656
* TraceContent: { // TraceContent
5757
* WirelessDeviceFrameInfo: "ENABLED" || "DISABLED",
5858
* LogLevel: "INFO" || "ERROR" || "DISABLED",
59+
* MulticastFrameInfo: "ENABLED" || "DISABLED",
5960
* },
6061
* WirelessDevices: [ // WirelessDeviceList
6162
* "STRING_VALUE",
@@ -71,6 +72,9 @@ export interface CreateNetworkAnalyzerConfigurationCommandOutput
7172
* },
7273
* ],
7374
* ClientRequestToken: "STRING_VALUE",
75+
* MulticastGroups: [ // NetworkAnalyzerMulticastGroupList
76+
* "STRING_VALUE",
77+
* ],
7478
* };
7579
* const command = new CreateNetworkAnalyzerConfigurationCommand(input);
7680
* const response = await client.send(command);

clients/client-iot-wireless/src/commands/DeleteWirelessGatewayTaskDefinitionCommand.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,8 @@ export interface DeleteWirelessGatewayTaskDefinitionCommandOutput
4444

4545
/**
4646
* @public
47-
* <p>Deletes a wireless gateway task definition. Deleting this task definition does not affect tasks that are currently in progress.</p>
47+
* <p>Deletes a wireless gateway task definition. Deleting this task definition does not
48+
* affect tasks that are currently in progress.</p>
4849
* @example
4950
* Use a bare-bones client and the command you need to make an API call.
5051
* ```javascript

clients/client-iot-wireless/src/commands/DisassociateAwsAccountFromPartnerAccountCommand.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,9 @@ export interface DisassociateAwsAccountFromPartnerAccountCommandOutput
4545

4646
/**
4747
* @public
48-
* <p>Disassociates your AWS account from a partner account. If <code>PartnerAccountId</code> and <code>PartnerType</code> are <code>null</code>, disassociates your AWS account from all partner accounts.</p>
48+
* <p>Disassociates your AWS account from a partner account. If
49+
* <code>PartnerAccountId</code> and <code>PartnerType</code> are <code>null</code>,
50+
* disassociates your AWS account from all partner accounts.</p>
4951
* @example
5052
* Use a bare-bones client and the command you need to make an API call.
5153
* ```javascript

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,9 @@ export interface GetLogLevelsByResourceTypesCommandOutput
4141

4242
/**
4343
* @public
44-
* <p>Returns current default log levels or log levels by resource types. Based on resource types, log levels can be
45-
* for wireless device log options or wireless gateway log options.</p>
44+
* <p>Returns current default log levels or log levels by resource types. Based on resource
45+
* types, log levels can be for wireless device log options or wireless gateway log
46+
* options.</p>
4647
* @example
4748
* Use a bare-bones client and the command you need to make an API call.
4849
* ```javascript

clients/client-iot-wireless/src/commands/GetNetworkAnalyzerConfigurationCommand.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ export interface GetNetworkAnalyzerConfigurationCommandOutput
5757
* // TraceContent: { // TraceContent
5858
* // WirelessDeviceFrameInfo: "ENABLED" || "DISABLED",
5959
* // LogLevel: "INFO" || "ERROR" || "DISABLED",
60+
* // MulticastFrameInfo: "ENABLED" || "DISABLED",
6061
* // },
6162
* // WirelessDevices: [ // WirelessDeviceList
6263
* // "STRING_VALUE",
@@ -67,6 +68,9 @@ export interface GetNetworkAnalyzerConfigurationCommandOutput
6768
* // Description: "STRING_VALUE",
6869
* // Arn: "STRING_VALUE",
6970
* // Name: "STRING_VALUE",
71+
* // MulticastGroups: [ // NetworkAnalyzerMulticastGroupList
72+
* // "STRING_VALUE",
73+
* // ],
7074
* // };
7175
*
7276
* ```

clients/client-iot-wireless/src/commands/GetPartnerAccountCommand.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,8 @@ export interface GetPartnerAccountCommandOutput extends GetPartnerAccountRespons
4040

4141
/**
4242
* @public
43-
* <p>Gets information about a partner account. If <code>PartnerAccountId</code> and <code>PartnerType</code> are <code>null</code>, returns all partner accounts.</p>
43+
* <p>Gets information about a partner account. If <code>PartnerAccountId</code> and
44+
* <code>PartnerType</code> are <code>null</code>, returns all partner accounts.</p>
4445
* @example
4546
* Use a bare-bones client and the command you need to make an API call.
4647
* ```javascript

clients/client-iot-wireless/src/commands/GetPositionCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,7 @@ export interface GetPositionCommandOutput extends GetPositionResponse, __Metadat
4141
* <p>Get the position information for a given resource.</p>
4242
* <important>
4343
* <p>This action is no longer supported. Calls to retrieve the position information
44-
* should use the <a href="https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_GetResourcePosition.html">GetResourcePosition</a>
45-
* API operation instead.</p>
44+
* 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>
4645
* </important>
4746
* @example
4847
* Use a bare-bones client and the command you need to make an API call.

clients/client-iot-wireless/src/commands/GetPositionConfigurationCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,7 @@ export interface GetPositionConfigurationCommandOutput extends GetPositionConfig
4141
* <p>Get position configuration for a given resource.</p>
4242
* <important>
4343
* <p>This action is no longer supported. Calls to retrieve the position configuration
44-
* should use the <a href="https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_GetResourcePosition.html">GetResourcePosition</a>
45-
* API operation instead.</p>
44+
* 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>
4645
* </important>
4746
* @example
4847
* Use a bare-bones client and the command you need to make an API call.

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,9 @@ export interface GetPositionEstimateCommandOutput extends GetPositionEstimateRes
3636

3737
/**
3838
* @public
39-
* <p>Get estimated position information as a payload in GeoJSON format. The payload measurement data is
40-
* resolved using solvers that are provided by third-party vendors.</p>
39+
* <p>Get estimated position information as a payload in GeoJSON format. The payload
40+
* measurement data is resolved using solvers that are provided by third-party
41+
* vendors.</p>
4142
* @example
4243
* Use a bare-bones client and the command you need to make an API call.
4344
* ```javascript

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ export interface GetResourceLogLevelCommandOutput extends GetResourceLogLevelRes
3636

3737
/**
3838
* @public
39-
* <p>Fetches the log-level override, if any, for a given resource-ID and resource-type. It can be used for
40-
* a wireless device or a wireless gateway.</p>
39+
* <p>Fetches the log-level override, if any, for a given resource-ID and resource-type. It
40+
* can be used for a wireless device or a wireless gateway.</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/GetResourcePositionCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ export interface GetResourcePositionCommandOutput extends GetResourcePositionRes
3636

3737
/**
3838
* @public
39-
* <p>Get the position information for a given wireless device or a wireless gateway resource.
40-
* The position information uses the <a href="https://gisgeography.com/wgs84-world-geodetic-system/"> World Geodetic System
39+
* <p>Get the position information for a given wireless device or a wireless gateway
40+
* resource. The position information uses the <a href="https://gisgeography.com/wgs84-world-geodetic-system/"> World Geodetic System
4141
* (WGS84)</a>.</p>
4242
* @example
4343
* Use a bare-bones client and the command you need to make an API call.

clients/client-iot-wireless/src/commands/GetServiceEndpointCommand.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,8 @@ export interface GetServiceEndpointCommandOutput extends GetServiceEndpointRespo
3636

3737
/**
3838
* @public
39-
* <p>Gets the account-specific endpoint for Configuration and Update Server (CUPS) protocol or LoRaWAN Network Server (LNS) connections.</p>
39+
* <p>Gets the account-specific endpoint for Configuration and Update Server (CUPS) protocol
40+
* or LoRaWAN Network Server (LNS) connections.</p>
4041
* @example
4142
* Use a bare-bones client and the command you need to make an API call.
4243
* ```javascript

clients/client-iot-wireless/src/commands/GetWirelessGatewayCertificateCommand.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,8 @@ export interface GetWirelessGatewayCertificateCommandOutput
4141

4242
/**
4343
* @public
44-
* <p>Gets the ID of the certificate that is currently associated with a wireless gateway.</p>
44+
* <p>Gets the ID of the certificate that is currently associated with a wireless
45+
* gateway.</p>
4546
* @example
4647
* Use a bare-bones client and the command you need to make an API call.
4748
* ```javascript

clients/client-iot-wireless/src/commands/ListPositionConfigurationsCommand.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,8 @@ export interface ListPositionConfigurationsCommandOutput extends ListPositionCon
4040
*
4141
* <p>List position configurations for a given resource, such as positioning solvers.</p>
4242
* <important>
43-
* <p>This action is no longer supported. Calls to retrieve position information
44-
* should use the <a href="https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_GetResourcePosition.html">GetResourcePosition</a>
45-
* API operation instead.</p>
43+
* <p>This action is no longer supported. Calls to retrieve position information should
44+
* use the <a href="https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_GetResourcePosition.html">GetResourcePosition</a> API operation instead.</p>
4645
* </important>
4746
* @example
4847
* Use a bare-bones client and the command you need to make an API call.

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,9 @@ export interface PutResourceLogLevelCommandOutput extends PutResourceLogLevelRes
3636

3737
/**
3838
* @public
39-
* <p>Sets the log-level override for a resource-ID and resource-type. This option can be specified for a wireless gateway
40-
* or a wireless device. A limit of 200 log level override can be set per account.</p>
39+
* <p>Sets the log-level override for a resource-ID and resource-type. This option can be
40+
* specified for a wireless gateway or a wireless device. A limit of 200 log level override
41+
* can be set per account.</p>
4142
* @example
4243
* Use a bare-bones client and the command you need to make an API call.
4344
* ```javascript

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,8 @@ export interface ResetAllResourceLogLevelsCommandOutput extends ResetAllResource
3636

3737
/**
3838
* @public
39-
* <p>Removes the log-level overrides for all resources; both wireless devices and wireless gateways.</p>
39+
* <p>Removes the log-level overrides for all resources; both wireless devices and wireless
40+
* gateways.</p>
4041
* @example
4142
* Use a bare-bones client and the command you need to make an API call.
4243
* ```javascript

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ export interface ResetResourceLogLevelCommandOutput extends ResetResourceLogLeve
3636

3737
/**
3838
* @public
39-
* <p>Removes the log-level override, if any, for a specific resource-ID and resource-type. It can be used for
40-
* a wireless device or a wireless gateway.</p>
39+
* <p>Removes the log-level override, if any, for a specific resource-ID and resource-type.
40+
* It can be used for a wireless device or a wireless gateway.</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/StartBulkAssociateWirelessDeviceWithMulticastGroupCommand.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,8 @@ export interface StartBulkAssociateWirelessDeviceWithMulticastGroupCommandOutput
4545

4646
/**
4747
* @public
48-
* <p>Starts a bulk association of all qualifying wireless devices with a multicast group.</p>
48+
* <p>Starts a bulk association of all qualifying wireless devices with a multicast
49+
* group.</p>
4950
* @example
5051
* Use a bare-bones client and the command you need to make an API call.
5152
* ```javascript

clients/client-iot-wireless/src/commands/StartBulkDisassociateWirelessDeviceFromMulticastGroupCommand.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,8 @@ export interface StartBulkDisassociateWirelessDeviceFromMulticastGroupCommandOut
4545

4646
/**
4747
* @public
48-
* <p>Starts a bulk disassociatin of all qualifying wireless devices from a multicast group.</p>
48+
* <p>Starts a bulk disassociatin of all qualifying wireless devices from a multicast
49+
* group.</p>
4950
* @example
5051
* Use a bare-bones client and the command you need to make an API call.
5152
* ```javascript

clients/client-iot-wireless/src/commands/TestWirelessDeviceCommand.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,8 @@ export interface TestWirelessDeviceCommandOutput extends TestWirelessDeviceRespo
3636

3737
/**
3838
* @public
39-
* <p>Simulates a provisioned device by sending an uplink data payload of <code>Hello</code>.</p>
39+
* <p>Simulates a provisioned device by sending an uplink data payload of
40+
* <code>Hello</code>.</p>
4041
* @example
4142
* Use a bare-bones client and the command you need to make an API call.
4243
* ```javascript

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,9 @@ export interface UpdateLogLevelsByResourceTypesCommandOutput
4141

4242
/**
4343
* @public
44-
* <p>Set default log level, or log levels by resource types. This can be for wireless device log options or
45-
* wireless gateways log options and is used to control the log messages that'll be displayed in CloudWatch.</p>
44+
* <p>Set default log level, or log levels by resource types. This can be for wireless
45+
* device log options or wireless gateways log options and is used to control the log
46+
* messages that'll be displayed in CloudWatch.</p>
4647
* @example
4748
* Use a bare-bones client and the command you need to make an API call.
4849
* ```javascript

0 commit comments

Comments
 (0)