Skip to content

Commit

Permalink
feat(client-iot-wireless): New FuotaTask resource type to enable logg…
Browse files Browse the repository at this point in the history
…ing 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.
  • Loading branch information
awstools committed Nov 14, 2024
1 parent 5528f54 commit 69415e0
Show file tree
Hide file tree
Showing 20 changed files with 524 additions and 122 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ export interface CreateFuotaTaskCommandOutput extends CreateFuotaTaskResponse, _
* RedundancyPercent: Number("int"),
* FragmentSizeBytes: Number("int"),
* FragmentIntervalMS: Number("int"),
* Descriptor: "STRING_VALUE",
* };
* const command = new CreateFuotaTaskCommand(input);
* const response = await client.send(command);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,12 @@ export interface CreateMulticastGroupCommandOutput extends CreateMulticastGroupR
* LoRaWAN: { // LoRaWANMulticast
* RfRegion: "EU868" || "US915" || "AU915" || "AS923-1" || "AS923-2" || "AS923-3" || "AS923-4" || "EU433" || "CN470" || "CN779" || "RU864" || "KR920" || "IN865",
* DlClass: "ClassB" || "ClassC",
* ParticipatingGateways: { // ParticipatingGatewaysMulticast
* GatewayList: [ // GatewayListMulticast
* "STRING_VALUE",
* ],
* TransmissionInterval: Number("int"),
* },
* },
* Tags: [ // TagList
* { // Tag
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ export interface GetFuotaTaskCommandOutput extends GetFuotaTaskResponse, __Metad
* // RedundancyPercent: Number("int"),
* // FragmentSizeBytes: Number("int"),
* // FragmentIntervalMS: Number("int"),
* // Descriptor: "STRING_VALUE",
* // };
*
* ```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,18 @@ export interface GetLogLevelsByResourceTypesCommandOutput
* // ],
* // },
* // ],
* // FuotaTaskLogOptions: [ // FuotaTaskLogOptionList
* // { // FuotaTaskLogOption
* // Type: "LoRaWAN", // required
* // LogLevel: "INFO" || "ERROR" || "DISABLED", // required
* // Events: [ // FuotaTaskEventLogOptionList
* // { // FuotaTaskEventLogOption
* // Event: "Fuota", // required
* // LogLevel: "INFO" || "ERROR" || "DISABLED", // required
* // },
* // ],
* // },
* // ],
* // };
*
* ```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,12 @@ export interface GetMulticastGroupCommandOutput extends GetMulticastGroupRespons
* // DlClass: "ClassB" || "ClassC",
* // NumberOfDevicesRequested: Number("int"),
* // NumberOfDevicesInGroup: Number("int"),
* // ParticipatingGateways: { // ParticipatingGatewaysMulticast
* // GatewayList: [ // GatewayListMulticast
* // "STRING_VALUE",
* // ],
* // TransmissionInterval: Number("int"),
* // },
* // },
* // CreatedAt: new Date("TIMESTAMP"),
* // };
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ export interface GetResourceEventConfigurationCommandOutput
* const client = new IoTWirelessClient(config);
* const input = { // GetResourceEventConfigurationRequest
* Identifier: "STRING_VALUE", // required
* IdentifierType: "PartnerAccountId" || "DevEui" || "GatewayEui" || "WirelessDeviceId" || "WirelessGatewayId", // required
* IdentifierType: "PartnerAccountId" || "DevEui" || "FuotaTaskId" || "GatewayEui" || "WirelessDeviceId" || "WirelessGatewayId", // required
* PartnerType: "Sidewalk",
* };
* const command = new GetResourceEventConfigurationCommand(input);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export interface GetResourceLogLevelCommandOutput extends GetResourceLogLevelRes

/**
* <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>
* can be used for a wireless device, wireless gateway or fuota task.</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,7 @@ export interface ListEventConfigurationsCommandOutput extends ListEventConfigura
* // const { IoTWirelessClient, ListEventConfigurationsCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import
* const client = new IoTWirelessClient(config);
* const input = { // ListEventConfigurationsRequest
* ResourceType: "SidewalkAccount" || "WirelessDevice" || "WirelessGateway", // required
* ResourceType: "FuotaTask" || "SidewalkAccount" || "WirelessDevice" || "WirelessGateway", // required
* MaxResults: Number("int"),
* NextToken: "STRING_VALUE",
* };
Expand All @@ -47,7 +47,7 @@ export interface ListEventConfigurationsCommandOutput extends ListEventConfigura
* // EventConfigurationsList: [ // EventConfigurationsList
* // { // EventConfigurationItem
* // Identifier: "STRING_VALUE",
* // IdentifierType: "PartnerAccountId" || "DevEui" || "GatewayEui" || "WirelessDeviceId" || "WirelessGatewayId",
* // IdentifierType: "PartnerAccountId" || "DevEui" || "FuotaTaskId" || "GatewayEui" || "WirelessDeviceId" || "WirelessGatewayId",
* // PartnerType: "Sidewalk",
* // Events: { // EventNotificationItemConfigurations
* // DeviceRegistrationState: { // DeviceRegistrationStateEventConfiguration
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { IoTWirelessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes
import {
ListNetworkAnalyzerConfigurationsRequest,
ListNetworkAnalyzerConfigurationsResponse,
} from "../models/models_0";
} from "../models/models_1";
import {
de_ListNetworkAnalyzerConfigurationsCommand,
se_ListNetworkAnalyzerConfigurationsCommand,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import {
ListPartnerAccountsRequest,
ListPartnerAccountsResponse,
ListPartnerAccountsResponseFilterSensitiveLog,
} from "../models/models_0";
} from "../models/models_1";
import { de_ListPartnerAccountsCommand, se_ListPartnerAccountsCommand } from "../protocols/Aws_restJson1";

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ export interface ResetAllResourceLogLevelsCommandInput extends ResetAllResourceL
export interface ResetAllResourceLogLevelsCommandOutput extends ResetAllResourceLogLevelsResponse, __MetadataBearer {}

/**
* <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; wireless devices, wireless
* gateways, and fuota tasks.</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 @@ -29,7 +29,7 @@ export interface ResetResourceLogLevelCommandOutput extends ResetResourceLogLeve

/**
* <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>
* It can be used for a wireless device, a wireless gateway, or a fuota task.</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 @@ -47,6 +47,7 @@ export interface UpdateFuotaTaskCommandOutput extends UpdateFuotaTaskResponse, _
* RedundancyPercent: Number("int"),
* FragmentSizeBytes: Number("int"),
* FragmentIntervalMS: Number("int"),
* Descriptor: "STRING_VALUE",
* };
* const command = new UpdateFuotaTaskCommand(input);
* const response = await client.send(command);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,18 @@ export interface UpdateLogLevelsByResourceTypesCommandOutput
* const client = new IoTWirelessClient(config);
* const input = { // UpdateLogLevelsByResourceTypesRequest
* DefaultLogLevel: "INFO" || "ERROR" || "DISABLED",
* FuotaTaskLogOptions: [ // FuotaTaskLogOptionList
* { // FuotaTaskLogOption
* Type: "LoRaWAN", // required
* LogLevel: "INFO" || "ERROR" || "DISABLED", // required
* Events: [ // FuotaTaskEventLogOptionList
* { // FuotaTaskEventLogOption
* Event: "Fuota", // required
* LogLevel: "INFO" || "ERROR" || "DISABLED", // required
* },
* ],
* },
* ],
* WirelessDeviceLogOptions: [ // WirelessDeviceLogOptionList
* { // WirelessDeviceLogOption
* Type: "Sidewalk" || "LoRaWAN", // required
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,12 @@ export interface UpdateMulticastGroupCommandOutput extends UpdateMulticastGroupR
* LoRaWAN: { // LoRaWANMulticast
* RfRegion: "EU868" || "US915" || "AU915" || "AS923-1" || "AS923-2" || "AS923-3" || "AS923-4" || "EU433" || "CN470" || "CN779" || "RU864" || "KR920" || "IN865",
* DlClass: "ClassB" || "ClassC",
* ParticipatingGateways: { // ParticipatingGatewaysMulticast
* GatewayList: [ // GatewayListMulticast
* "STRING_VALUE",
* ],
* TransmissionInterval: Number("int"),
* },
* },
* };
* const command = new UpdateMulticastGroupCommand(input);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ export interface UpdateResourceEventConfigurationCommandOutput
* const client = new IoTWirelessClient(config);
* const input = { // UpdateResourceEventConfigurationRequest
* Identifier: "STRING_VALUE", // required
* IdentifierType: "PartnerAccountId" || "DevEui" || "GatewayEui" || "WirelessDeviceId" || "WirelessGatewayId", // required
* IdentifierType: "PartnerAccountId" || "DevEui" || "FuotaTaskId" || "GatewayEui" || "WirelessDeviceId" || "WirelessGatewayId", // required
* PartnerType: "Sidewalk",
* DeviceRegistrationState: { // DeviceRegistrationStateEventConfiguration
* Sidewalk: { // SidewalkEventNotificationConfigurations
Expand Down
Loading

0 comments on commit 69415e0

Please sign in to comment.