feat(client-iot-wireless): In this release, we add additional capabil…

…ities for the FUOTA which allows user to configure the fragment size, the sending interval and the redundancy ratio of the FUOTA tasks
aws · Feb 23, 2023 · c5c9017 · c5c9017
1 parent cd01113
commit c5c9017
Show file tree

Hide file tree

Showing 15 changed files with 1,231 additions and 631 deletions.
diff --git a/clients/client-iot-wireless/src/IoTWireless.ts b/clients/client-iot-wireless/src/IoTWireless.ts
@@ -505,10 +505,10 @@ import { IoTWirelessClient } from "./IoTWirelessClient";
  * 	        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
+ *          <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
+ *          <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>
@@ -1972,11 +1972,11 @@ export class IoTWireless extends IoTWirelessClient {
    * @deprecated
    *
    * <p>Get the position information for a given resource.</p>
-   *         <important>
+   *          <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>
-   *         </important>
+   *          </important>
    */
   public getPosition(args: GetPositionCommandInput, options?: __HttpHandlerOptions): Promise<GetPositionCommandOutput>;
   public getPosition(args: GetPositionCommandInput, cb: (err: any, data?: GetPositionCommandOutput) => void): void;
@@ -2005,11 +2005,11 @@ export class IoTWireless extends IoTWirelessClient {
    * @deprecated
    *
    * <p>Get position configuration for a given resource.</p>
-   *         <important>
+   *          <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>
-   *         </important>
+   *          </important>
    */
   public getPositionConfiguration(
     args: GetPositionConfigurationCommandInput,
@@ -2139,9 +2139,9 @@ export class IoTWireless extends IoTWirelessClient {
   }
 
   /**
-   * <p>Get the position information for a given wireless device or a wireless gateway resource. The postion
-   *           information uses the <a href="https://gisgeography.com/wgs84-world-geodetic-system/">
-   *           World Geodetic System (WGS84)</a>.</p>
+   * <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>
    */
   public getResourcePosition(
     args: GetResourcePositionCommandInput,
@@ -2754,11 +2754,11 @@ export class IoTWireless extends IoTWirelessClient {
    * @deprecated
    *
    * <p>List position configurations for a given resource, such as positioning solvers.</p>
-   *         <important>
+   *          <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>
-   *         </important>
+   *          </important>
    */
   public listPositionConfigurations(
     args: ListPositionConfigurationsCommandInput,
@@ -2985,10 +2985,10 @@ export class IoTWireless extends IoTWirelessClient {
    * @deprecated
    *
    * <p>Put position configuration for a given resource.</p>
-   *         <important>
+   *          <important>
    *             <p>This action is no longer supported. Calls to update the position configuration
    *                 should use the <a href="https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_UpdateResourcePosition.html">UpdateResourcePosition</a> API operation instead.</p>
-   *         </important>
+   *          </important>
    */
   public putPositionConfiguration(
     args: PutPositionConfigurationCommandInput,
@@ -3634,10 +3634,10 @@ export class IoTWireless extends IoTWirelessClient {
    * @deprecated
    *
    * <p>Update the position information of a resource.</p>
-   *         <important>
+   *          <important>
    *             <p>This action is no longer supported. Calls to update the position information
    *                 should use the <a href="https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_UpdateResourcePosition.html">UpdateResourcePosition</a> API operation instead.</p>
-   *         </important>
+   *          </important>
    */
   public updatePosition(
     args: UpdatePositionCommandInput,
@@ -3701,9 +3701,9 @@ export class IoTWireless extends IoTWirelessClient {
   }
 
   /**
-   * <p>Update the position information of a given wireless device or a wireless gateway resource. The postion
-   *            coordinates are based on the <a href="https://gisgeography.com/wgs84-world-geodetic-system/">
-   *            World Geodetic System (WGS84)</a>.</p>
+   * <p>Update the position information of a given wireless device or a wireless gateway
+   *             resource. The position coordinates are based on the <a href="https://gisgeography.com/wgs84-world-geodetic-system/"> World Geodetic System
+   *                 (WGS84)</a>.</p>
    */
   public updateResourcePosition(
     args: UpdateResourcePositionCommandInput,

diff --git a/clients/client-iot-wireless/src/IoTWirelessClient.ts b/clients/client-iot-wireless/src/IoTWirelessClient.ts
@@ -746,10 +746,10 @@ export interface IoTWirelessClientResolvedConfig extends IoTWirelessClientResolv
  * 	        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
+ *          <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
+ *          <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>

diff --git a/clients/client-iot-wireless/src/commands/GetPositionCommand.ts b/clients/client-iot-wireless/src/commands/GetPositionCommand.ts
@@ -32,11 +32,11 @@ export interface GetPositionCommandOutput extends GetPositionResponse, __Metadat
  * @deprecated
  *
  * <p>Get the position information for a given resource.</p>
- *         <important>
+ *          <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>
- *         </important>
+ *          </important>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-iot-wireless/src/commands/GetPositionConfigurationCommand.ts b/clients/client-iot-wireless/src/commands/GetPositionConfigurationCommand.ts
@@ -32,11 +32,11 @@ export interface GetPositionConfigurationCommandOutput extends GetPositionConfig
  * @deprecated
  *
  * <p>Get position configuration for a given resource.</p>
- *         <important>
+ *          <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>
- *         </important>
+ *          </important>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-iot-wireless/src/commands/GetResourcePositionCommand.ts b/clients/client-iot-wireless/src/commands/GetResourcePositionCommand.ts
@@ -29,9 +29,9 @@ export interface GetResourcePositionCommandInput extends GetResourcePositionRequ
 export interface GetResourcePositionCommandOutput extends GetResourcePositionResponse, __MetadataBearer {}
 
 /**
- * <p>Get the position information for a given wireless device or a wireless gateway resource. The postion
- *           information uses the <a href="https://gisgeography.com/wgs84-world-geodetic-system/">
- *           World Geodetic System (WGS84)</a>.</p>
+ * <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.
  * ```javascript

diff --git a/clients/client-iot-wireless/src/commands/ListPositionConfigurationsCommand.ts b/clients/client-iot-wireless/src/commands/ListPositionConfigurationsCommand.ts
@@ -32,11 +32,11 @@ export interface ListPositionConfigurationsCommandOutput extends ListPositionCon
  * @deprecated
  *
  * <p>List position configurations for a given resource, such as positioning solvers.</p>
- *         <important>
+ *          <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>
- *         </important>
+ *          </important>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-iot-wireless/src/commands/PutPositionConfigurationCommand.ts b/clients/client-iot-wireless/src/commands/PutPositionConfigurationCommand.ts
@@ -32,10 +32,10 @@ export interface PutPositionConfigurationCommandOutput extends PutPositionConfig
  * @deprecated
  *
  * <p>Put position configuration for a given resource.</p>
- *         <important>
+ *          <important>
  *             <p>This action is no longer supported. Calls to update the position configuration
  *                 should use the <a href="https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_UpdateResourcePosition.html">UpdateResourcePosition</a> API operation instead.</p>
- *         </important>
+ *          </important>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-iot-wireless/src/commands/UpdatePositionCommand.ts b/clients/client-iot-wireless/src/commands/UpdatePositionCommand.ts
@@ -32,10 +32,10 @@ export interface UpdatePositionCommandOutput extends UpdatePositionResponse, __M
  * @deprecated
  *
  * <p>Update the position information of a resource.</p>
- *         <important>
+ *          <important>
  *             <p>This action is no longer supported. Calls to update the position information
  *                 should use the <a href="https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_UpdateResourcePosition.html">UpdateResourcePosition</a> API operation instead.</p>
- *         </important>
+ *          </important>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-iot-wireless/src/commands/UpdateResourcePositionCommand.ts b/clients/client-iot-wireless/src/commands/UpdateResourcePositionCommand.ts
@@ -29,9 +29,9 @@ export interface UpdateResourcePositionCommandInput extends UpdateResourcePositi
 export interface UpdateResourcePositionCommandOutput extends UpdateResourcePositionResponse, __MetadataBearer {}
 
 /**
- * <p>Update the position information of a given wireless device or a wireless gateway resource. The postion
- *            coordinates are based on the <a href="https://gisgeography.com/wgs84-world-geodetic-system/">
- *            World Geodetic System (WGS84)</a>.</p>
+ * <p>Update the position information of a given wireless device or a wireless gateway
+ *             resource. The position coordinates are based on 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.
  * ```javascript

diff --git a/clients/client-iot-wireless/src/endpoint/EndpointParameters.ts b/clients/client-iot-wireless/src/endpoint/EndpointParameters.ts
@@ -24,7 +24,7 @@ export const resolveClientEndpointParameters = <T>(
 };
 
 export interface EndpointParameters extends __EndpointParameters {
-  Region: string;
+  Region?: string;
   UseDualStack?: boolean;
   UseFIPS?: boolean;
   Endpoint?: string;

diff --git a/clients/client-iot-wireless/src/endpoint/ruleset.ts b/clients/client-iot-wireless/src/endpoint/ruleset.ts
@@ -6,25 +6,27 @@ import { RuleSetObject } from "@aws-sdk/util-endpoints";
    or see "smithy.rules#endpointRuleSet"
    in codegen/sdk-codegen/aws-models/iot-wireless.json */
 
-const r="fn",
-s="argv",
-t="ref";
-const a=true,
-b=false,
-c="String",
-d="PartitionResult",
-e="tree",
-f="error",
-g="endpoint",
-h={"required":true,"default":false,"type":"Boolean"},
-i={[t]:"Endpoint"},
-j={[r]:"booleanEquals",[s]:[{[t]:"UseFIPS"},true]},
-k={[r]:"booleanEquals",[s]:[{[t]:"UseDualStack"},true]},
+const s="required",
+t="fn",
+u="argv",
+v="ref";
+const a="isSet",
+b="tree",
+c="error",
+d="endpoint",
+e="PartitionResult",
+f="stringEquals",
+g={[s]:false,"type":"String"},
+h={[s]:true,"default":false,"type":"Boolean"},
+i={[v]:"Endpoint"},
+j={[t]:"booleanEquals",[u]:[{[v]:"UseFIPS"},true]},
+k={[t]:"booleanEquals",[u]:[{[v]:"UseDualStack"},true]},
 l={},
-m={[r]:"booleanEquals",[s]:[true,{[r]:"getAttr",[s]:[{[t]:d},"supportsFIPS"]}]},
-n={[r]:"booleanEquals",[s]:[true,{[r]:"getAttr",[s]:[{[t]:d},"supportsDualStack"]}]},
-o=[i],
+m={[v]:"Region"},
+n={[t]:"booleanEquals",[u]:[true,{[t]:"getAttr",[u]:[{[v]:e},"supportsFIPS"]}]},
+o={[t]:"booleanEquals",[u]:[true,{[t]:"getAttr",[u]:[{[v]:e},"supportsDualStack"]}]},
 p=[j],
-q=[k];
-const _data={version:"1.0",parameters:{Region:{required:a,type:c},UseDualStack:h,UseFIPS:h,Endpoint:{required:b,type:c}},rules:[{conditions:[{[r]:"aws.partition",[s]:[{[t]:"Region"}],assign:d}],type:e,rules:[{conditions:[{[r]:"isSet",[s]:o},{[r]:"parseURL",[s]:o,assign:"url"}],type:e,rules:[{conditions:p,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:f},{type:e,rules:[{conditions:q,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:f},{endpoint:{url:i,properties:l,headers:l},type:g}]}]},{conditions:[j,k],type:e,rules:[{conditions:[m,n],type:e,rules:[{endpoint:{url:"https://api.iotwireless-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:l,headers:l},type:g}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:f}]},{conditions:p,type:e,rules:[{conditions:[m],type:e,rules:[{type:e,rules:[{endpoint:{url:"https://api.iotwireless-fips.{Region}.{PartitionResult#dnsSuffix}",properties:l,headers:l},type:g}]}]},{error:"FIPS is enabled but this partition does not support FIPS",type:f}]},{conditions:q,type:e,rules:[{conditions:[n],type:e,rules:[{endpoint:{url:"https://api.iotwireless.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:l,headers:l},type:g}]},{error:"DualStack is enabled but this partition does not support DualStack",type:f}]},{endpoint:{url:"https://api.iotwireless.{Region}.{PartitionResult#dnsSuffix}",properties:l,headers:l},type:g}]}]};
+q=[k],
+r=[m];
+const _data={version:"1.0",parameters:{Region:g,UseDualStack:h,UseFIPS:h,Endpoint:g},rules:[{conditions:[{[t]:a,[u]:[i]}],type:b,rules:[{conditions:p,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:c},{type:b,rules:[{conditions:q,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:c},{endpoint:{url:i,properties:l,headers:l},type:d}]}]},{type:b,rules:[{conditions:[{[t]:a,[u]:r}],type:b,rules:[{conditions:[{[t]:"aws.partition",[u]:r,assign:e}],type:b,rules:[{conditions:[j,k],type:b,rules:[{conditions:[n,o],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://api.iotwireless-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:l,headers:l},type:d}]}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:c}]},{conditions:p,type:b,rules:[{conditions:[n],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://api.iotwireless-fips.{Region}.{PartitionResult#dnsSuffix}",properties:l,headers:l},type:d}]}]},{error:"FIPS is enabled but this partition does not support FIPS",type:c}]},{conditions:q,type:b,rules:[{conditions:[o],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://api.iotwireless.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:l,headers:l},type:d}]}]},{error:"DualStack is enabled but this partition does not support DualStack",type:c}]},{type:b,rules:[{conditions:[{[t]:f,[u]:[m,"ap-northeast-1"]}],endpoint:{url:"https://api.iotwireless.ap-northeast-1.amazonaws.com",properties:l,headers:l},type:d},{conditions:[{[t]:f,[u]:[m,"ap-southeast-2"]}],endpoint:{url:"https://api.iotwireless.ap-southeast-2.amazonaws.com",properties:l,headers:l},type:d},{conditions:[{[t]:f,[u]:[m,"eu-west-1"]}],endpoint:{url:"https://api.iotwireless.eu-west-1.amazonaws.com",properties:l,headers:l},type:d},{conditions:[{[t]:f,[u]:[m,"us-east-1"]}],endpoint:{url:"https://api.iotwireless.us-east-1.amazonaws.com",properties:l,headers:l},type:d},{conditions:[{[t]:f,[u]:[m,"us-west-2"]}],endpoint:{url:"https://api.iotwireless.us-west-2.amazonaws.com",properties:l,headers:l},type:d},{endpoint:{url:"https://api.iotwireless.{Region}.{PartitionResult#dnsSuffix}",properties:l,headers:l},type:d}]}]}]},{error:"Invalid Configuration: Missing Region",type:c}]}]};
 export const ruleSet: RuleSetObject = _data;