Skip to content

Commit

Permalink
feat(client-iot-wireless): Add Multicast Group support in Network Ana…
Browse files Browse the repository at this point in the history
…lyzer Configuration.
  • Loading branch information
awstools committed May 26, 2023
1 parent 84ca849 commit 0276e59
Show file tree
Hide file tree
Showing 30 changed files with 854 additions and 507 deletions.
24 changes: 13 additions & 11 deletions clients/client-iot-wireless/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,19 @@

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

<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>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>

## Installing

Expand Down
24 changes: 13 additions & 11 deletions clients/client-iot-wireless/src/IoTWireless.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2465,17 +2465,19 @@ export interface IoTWireless {

/**
* @public
* <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>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>
*/
export class IoTWireless extends IoTWirelessClient implements IoTWireless {}
createAggregatedClient(commands, IoTWireless);
24 changes: 13 additions & 11 deletions clients/client-iot-wireless/src/IoTWirelessClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -814,17 +814,19 @@ export interface IoTWirelessClientResolvedConfig extends IoTWirelessClientResolv

/**
* @public
* <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>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>
*/
export class IoTWirelessClient extends __Client<
__HttpHandlerOptions,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ export interface CreateNetworkAnalyzerConfigurationCommandOutput
* TraceContent: { // TraceContent
* WirelessDeviceFrameInfo: "ENABLED" || "DISABLED",
* LogLevel: "INFO" || "ERROR" || "DISABLED",
* MulticastFrameInfo: "ENABLED" || "DISABLED",
* },
* WirelessDevices: [ // WirelessDeviceList
* "STRING_VALUE",
Expand All @@ -71,6 +72,9 @@ export interface CreateNetworkAnalyzerConfigurationCommandOutput
* },
* ],
* ClientRequestToken: "STRING_VALUE",
* MulticastGroups: [ // NetworkAnalyzerMulticastGroupList
* "STRING_VALUE",
* ],
* };
* const command = new CreateNetworkAnalyzerConfigurationCommand(input);
* const response = await client.send(command);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@ export interface DeleteWirelessGatewayTaskDefinitionCommandOutput

/**
* @public
* <p>Deletes a wireless gateway task definition. Deleting this task definition does not affect tasks that are currently in progress.</p>
* <p>Deletes a wireless gateway task definition. Deleting this task definition does not
* affect tasks that are currently in progress.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,9 @@ export interface DisassociateAwsAccountFromPartnerAccountCommandOutput

/**
* @public
* <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>
* <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>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,9 @@ export interface GetLogLevelsByResourceTypesCommandOutput

/**
* @public
* <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>
* <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>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ export interface GetNetworkAnalyzerConfigurationCommandOutput
* // TraceContent: { // TraceContent
* // WirelessDeviceFrameInfo: "ENABLED" || "DISABLED",
* // LogLevel: "INFO" || "ERROR" || "DISABLED",
* // MulticastFrameInfo: "ENABLED" || "DISABLED",
* // },
* // WirelessDevices: [ // WirelessDeviceList
* // "STRING_VALUE",
Expand All @@ -67,6 +68,9 @@ export interface GetNetworkAnalyzerConfigurationCommandOutput
* // Description: "STRING_VALUE",
* // Arn: "STRING_VALUE",
* // Name: "STRING_VALUE",
* // MulticastGroups: [ // NetworkAnalyzerMulticastGroupList
* // "STRING_VALUE",
* // ],
* // };
*
* ```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,8 @@ export interface GetPartnerAccountCommandOutput extends GetPartnerAccountRespons

/**
* @public
* <p>Gets information about a partner account. If <code>PartnerAccountId</code> and <code>PartnerType</code> are <code>null</code>, returns all partner accounts.</p>
* <p>Gets information about a partner account. If <code>PartnerAccountId</code> and
* <code>PartnerType</code> are <code>null</code>, returns all partner accounts.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,7 @@ export interface GetPositionCommandOutput extends GetPositionResponse, __Metadat
* <p>Get the position information for a given resource.</p>
* <important>
* <p>This action is no longer supported. Calls to retrieve the position information
* 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>
* 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>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,7 @@ export interface GetPositionConfigurationCommandOutput extends GetPositionConfig
* <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>
* 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>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,9 @@ export interface GetPositionEstimateCommandOutput extends GetPositionEstimateRes

/**
* @public
* <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>
* <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>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ export interface GetResourceLogLevelCommandOutput extends GetResourceLogLevelRes

/**
* @public
* <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>
* <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>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ export interface GetResourcePositionCommandOutput extends GetResourcePositionRes

/**
* @public
* <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
* <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>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,8 @@ export interface GetServiceEndpointCommandOutput extends GetServiceEndpointRespo

/**
* @public
* <p>Gets the account-specific endpoint for Configuration and Update Server (CUPS) protocol or LoRaWAN Network Server (LNS) connections.</p>
* <p>Gets the account-specific endpoint for Configuration and Update Server (CUPS) protocol
* or LoRaWAN Network Server (LNS) connections.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,8 @@ export interface GetWirelessGatewayCertificateCommandOutput

/**
* @public
* <p>Gets the ID of the certificate that is currently associated with a wireless gateway.</p>
* <p>Gets the ID of the certificate that is currently associated with a wireless
* gateway.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,8 @@ export interface ListPositionConfigurationsCommandOutput extends ListPositionCon
*
* <p>List position configurations for a given resource, such as positioning solvers.</p>
* <important>
* <p>This action is no longer supported. Calls to retrieve position information
* 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>
* <p>This action is no longer supported. Calls to retrieve position information 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>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,9 @@ export interface PutResourceLogLevelCommandOutput extends PutResourceLogLevelRes

/**
* @public
* <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>
* <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>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,8 @@ export interface ResetAllResourceLogLevelsCommandOutput extends ResetAllResource

/**
* @public
* <p>Removes the log-level overrides for all resources; both wireless devices and wireless gateways.</p>
* <p>Removes the log-level overrides for all resources; both wireless devices and wireless
* gateways.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ export interface ResetResourceLogLevelCommandOutput extends ResetResourceLogLeve

/**
* @public
* <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>
* <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>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@ export interface StartBulkAssociateWirelessDeviceWithMulticastGroupCommandOutput

/**
* @public
* <p>Starts a bulk association of all qualifying wireless devices with a multicast group.</p>
* <p>Starts a bulk association of all qualifying wireless devices with a multicast
* group.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@ export interface StartBulkDisassociateWirelessDeviceFromMulticastGroupCommandOut

/**
* @public
* <p>Starts a bulk disassociatin of all qualifying wireless devices from a multicast group.</p>
* <p>Starts a bulk disassociatin of all qualifying wireless devices from a multicast
* group.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,8 @@ export interface TestWirelessDeviceCommandOutput extends TestWirelessDeviceRespo

/**
* @public
* <p>Simulates a provisioned device by sending an uplink data payload of <code>Hello</code>.</p>
* <p>Simulates a provisioned device by sending an uplink data payload of
* <code>Hello</code>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,9 @@ export interface UpdateLogLevelsByResourceTypesCommandOutput

/**
* @public
* <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>
* <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>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Loading

0 comments on commit 0276e59

Please sign in to comment.