@aws-sdk/client-iot-wireless 3.758.0 → 3.774.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -814,7 +814,7 @@ export interface IoTWireless {
814
814
  * <p>AWS IoT Wireless provides bi-directional communication between internet-connected
815
815
  * wireless devices and the AWS Cloud. To onboard both LoRaWAN and Sidewalk devices to AWS
816
816
  * IoT, use the IoT Wireless API. These wireless devices use the Low Power Wide Area
817
- * Networking (LPWAN) communication protocol to communicate with AWS IoT.</p>
817
+ * Networking (LPWAN) communication protocol to communicate with AWS IoT. </p>
818
818
  * <p>Using the API, you can perform create, read, update, and delete operations for your
819
819
  * wireless devices, gateways, destinations, and profiles. After onboarding your devices,
820
820
  * you can use the API operations to set log levels and monitor your devices with
@@ -825,8 +825,11 @@ export interface IoTWireless {
825
825
  * schedule a session to update the firmware of individual devices or an entire group of
826
826
  * devices in a multicast group.</p>
827
827
  * <p>To connect to the AWS IoT Wireless Service, use the Service endpoints as described in
828
- * <a href="https://docs.aws.amazon.com/general/latest/gr/iot-lorawan.html#iot-wireless_region">IoT Wireless Service
829
- * endpoints</a> in the <i>AWS General Reference</i>.</p>
828
+ * <a href="https://docs.aws.amazon.com/general/latest/gr/iot-lorawan.html#iot-wireless_region">IoT
829
+ * Wireless Service endpoints</a>. You can use both IPv4 and IPv6 protocols to connect
830
+ * to the endpoints and send requests to the AWS IoT Wireless service. For more information,
831
+ * see <a href="https://docs.aws.amazon.com/iot-wireless/latest/developerguide/wireless-ipv6-access.html">Using
832
+ * IPv6 with AWS IoT Wireless</a>.</p>
830
833
  * @public
831
834
  */
832
835
  export declare class IoTWireless extends IoTWirelessClient implements IoTWireless {
@@ -284,7 +284,7 @@ export interface IoTWirelessClientResolvedConfig extends IoTWirelessClientResolv
284
284
  * <p>AWS IoT Wireless provides bi-directional communication between internet-connected
285
285
  * wireless devices and the AWS Cloud. To onboard both LoRaWAN and Sidewalk devices to AWS
286
286
  * IoT, use the IoT Wireless API. These wireless devices use the Low Power Wide Area
287
- * Networking (LPWAN) communication protocol to communicate with AWS IoT.</p>
287
+ * Networking (LPWAN) communication protocol to communicate with AWS IoT. </p>
288
288
  * <p>Using the API, you can perform create, read, update, and delete operations for your
289
289
  * wireless devices, gateways, destinations, and profiles. After onboarding your devices,
290
290
  * you can use the API operations to set log levels and monitor your devices with
@@ -295,8 +295,11 @@ export interface IoTWirelessClientResolvedConfig extends IoTWirelessClientResolv
295
295
  * schedule a session to update the firmware of individual devices or an entire group of
296
296
  * devices in a multicast group.</p>
297
297
  * <p>To connect to the AWS IoT Wireless Service, use the Service endpoints as described in
298
- * <a href="https://docs.aws.amazon.com/general/latest/gr/iot-lorawan.html#iot-wireless_region">IoT Wireless Service
299
- * endpoints</a> in the <i>AWS General Reference</i>.</p>
298
+ * <a href="https://docs.aws.amazon.com/general/latest/gr/iot-lorawan.html#iot-wireless_region">IoT
299
+ * Wireless Service endpoints</a>. You can use both IPv4 and IPv6 protocols to connect
300
+ * to the endpoints and send requests to the AWS IoT Wireless service. For more information,
301
+ * see <a href="https://docs.aws.amazon.com/iot-wireless/latest/developerguide/wireless-ipv6-access.html">Using
302
+ * IPv6 with AWS IoT Wireless</a>.</p>
300
303
  * @public
301
304
  */
302
305
  export declare class IoTWirelessClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, IoTWirelessClientResolvedConfig> {
@@ -29,19 +29,19 @@ declare const CreateWirelessGatewayCommand_base: {
29
29
  /**
30
30
  * <p>Provisions a wireless gateway.</p>
31
31
  * <note>
32
- * <p>When provisioning a wireless gateway, you might run into duplication errors
33
- * for the following reasons.</p>
32
+ * <p>When provisioning a wireless gateway, you might run into duplication errors for
33
+ * the following reasons.</p>
34
34
  * <ul>
35
35
  * <li>
36
36
  * <p>If you specify a <code>GatewayEui</code> value that already exists.</p>
37
37
  * </li>
38
38
  * <li>
39
39
  * <p>If you used a <code>ClientRequestToken</code> with the same parameters
40
- * within the last 10 minutes.</p>
40
+ * within the last 10 minutes.</p>
41
41
  * </li>
42
42
  * </ul>
43
- * <p>To avoid this error, make sure that you use unique identifiers and parameters
44
- * for each request within the specified time period.</p>
43
+ * <p>To avoid this error, make sure that you use unique identifiers and parameters for
44
+ * each request within the specified time period.</p>
45
45
  * </note>
46
46
  * @example
47
47
  * Use a bare-bones client and the command you need to make an API call.
@@ -27,7 +27,7 @@ declare const DeleteMulticastGroupCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes a multicast group if it is not in use by a fuota task.</p>
30
+ * <p>Deletes a multicast group if it is not in use by a FUOTA task.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -24,24 +24,24 @@ export interface DeleteWirelessGatewayCommandOutput extends DeleteWirelessGatewa
24
24
  declare const DeleteWirelessGatewayCommand_base: {
25
25
  new (input: DeleteWirelessGatewayCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteWirelessGatewayCommandInput, DeleteWirelessGatewayCommandOutput, IoTWirelessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
26
  new (__0_0: DeleteWirelessGatewayCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteWirelessGatewayCommandInput, DeleteWirelessGatewayCommandOutput, IoTWirelessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
- getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; /** @internal type navigation helper, not in runtime. */
28
28
  };
29
29
  /**
30
30
  * <p>Deletes a wireless gateway.</p>
31
31
  * <note>
32
- * <p>When deleting a wireless gateway, you might run into duplication errors
33
- * for the following reasons.</p>
32
+ * <p>When deleting a wireless gateway, you might run into duplication errors for the
33
+ * following reasons.</p>
34
34
  * <ul>
35
35
  * <li>
36
36
  * <p>If you specify a <code>GatewayEui</code> value that already exists.</p>
37
37
  * </li>
38
38
  * <li>
39
39
  * <p>If you used a <code>ClientRequestToken</code> with the same parameters
40
- * within the last 10 minutes.</p>
40
+ * within the last 10 minutes.</p>
41
41
  * </li>
42
42
  * </ul>
43
- * <p>To avoid this error, make sure that you use unique identifiers and parameters
44
- * for each request within the specified time period.</p>
43
+ * <p>To avoid this error, make sure that you use unique identifiers and parameters for
44
+ * each request within the specified time period.</p>
45
45
  * </note>
46
46
  * @example
47
47
  * Use a bare-bones client and the command you need to make an API call.
@@ -27,7 +27,7 @@ declare const DisassociateMulticastGroupFromFuotaTaskCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Disassociates a multicast group from a fuota task.</p>
30
+ * <p>Disassociates a multicast group from a FUOTA task.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -27,9 +27,9 @@ declare const GetLogLevelsByResourceTypesCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns current default log levels or log levels by resource types. Based on resource
31
- * types, log levels can be for wireless device log options or wireless gateway log
32
- * options.</p>
30
+ * <p>Returns current default log levels or log levels by resource types. Based on the
31
+ * resource type, log levels can be returned for wireless device, wireless gateway, or
32
+ * FUOTA task log options.</p>
33
33
  * @example
34
34
  * Use a bare-bones client and the command you need to make an API call.
35
35
  * ```javascript
@@ -141,7 +141,7 @@ declare const GetPositionEstimateCommand_base: {
141
141
  * { // LteNmrObj
142
142
  * Pci: Number("int"), // required
143
143
  * Earfcn: Number("int"), // required
144
- * EutranCid: Number("int"), // required
144
+ * EutranCid: Number("int"),
145
145
  * Rsrp: Number("int"),
146
146
  * Rsrq: Number("float"),
147
147
  * },
@@ -27,8 +27,8 @@ declare const GetResourceLogLevelCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Fetches the log-level override, if any, for a given resource-ID and resource-type. It
31
- * can be used for a wireless device, wireless gateway or fuota task.</p>
30
+ * <p>Fetches the log-level override, if any, for a given resource ID and resource
31
+ * type..</p>
32
32
  * @example
33
33
  * Use a bare-bones client and the command you need to make an API call.
34
34
  * ```javascript
@@ -27,7 +27,7 @@ declare const ListMulticastGroupsByFuotaTaskCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>List all multicast groups associated with a fuota task.</p>
30
+ * <p>List all multicast groups associated with a FUOTA task.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -27,9 +27,8 @@ declare const PutResourceLogLevelCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Sets the log-level override for a resource-ID and resource-type. This option can be
31
- * specified for a wireless gateway or a wireless device. A limit of 200 log level override
32
- * can be set per account.</p>
30
+ * <p>Sets the log-level override for a resource ID and resource type. A limit of 200 log
31
+ * level override can be set per account.</p>
33
32
  * @example
34
33
  * Use a bare-bones client and the command you need to make an API call.
35
34
  * ```javascript
@@ -28,7 +28,7 @@ declare const ResetAllResourceLogLevelsCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>Removes the log-level overrides for all resources; wireless devices, wireless
31
- * gateways, and fuota tasks.</p>
31
+ * gateways, and FUOTA tasks.</p>
32
32
  * @example
33
33
  * Use a bare-bones client and the command you need to make an API call.
34
34
  * ```javascript
@@ -27,8 +27,8 @@ declare const ResetResourceLogLevelCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Removes the log-level override, if any, for a specific resource-ID and resource-type.
31
- * It can be used for a wireless device, a wireless gateway, or a fuota task.</p>
30
+ * <p>Removes the log-level override, if any, for a specific resource ID and resource type.
31
+ * It can be used for a wireless device, a wireless gateway, or a FUOTA task.</p>
32
32
  * @example
33
33
  * Use a bare-bones client and the command you need to make an API call.
34
34
  * ```javascript
@@ -28,7 +28,7 @@ declare const UpdateLogLevelsByResourceTypesCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>Set default log level, or log levels by resource types. This can be for wireless
31
- * device log options or wireless gateways log options and is used to control the log
31
+ * device, wireless gateway, or FUOTA task log options, and is used to control the log
32
32
  * messages that'll be displayed in CloudWatch.</p>
33
33
  * @example
34
34
  * Use a bare-bones client and the command you need to make an API call.
@@ -2,7 +2,7 @@
2
2
  * <p>AWS IoT Wireless provides bi-directional communication between internet-connected
3
3
  * wireless devices and the AWS Cloud. To onboard both LoRaWAN and Sidewalk devices to AWS
4
4
  * IoT, use the IoT Wireless API. These wireless devices use the Low Power Wide Area
5
- * Networking (LPWAN) communication protocol to communicate with AWS IoT.</p>
5
+ * Networking (LPWAN) communication protocol to communicate with AWS IoT. </p>
6
6
  * <p>Using the API, you can perform create, read, update, and delete operations for your
7
7
  * wireless devices, gateways, destinations, and profiles. After onboarding your devices,
8
8
  * you can use the API operations to set log levels and monitor your devices with
@@ -13,8 +13,11 @@
13
13
  * schedule a session to update the firmware of individual devices or an entire group of
14
14
  * devices in a multicast group.</p>
15
15
  * <p>To connect to the AWS IoT Wireless Service, use the Service endpoints as described in
16
- * <a href="https://docs.aws.amazon.com/general/latest/gr/iot-lorawan.html#iot-wireless_region">IoT Wireless Service
17
- * endpoints</a> in the <i>AWS General Reference</i>.</p>
16
+ * <a href="https://docs.aws.amazon.com/general/latest/gr/iot-lorawan.html#iot-wireless_region">IoT
17
+ * Wireless Service endpoints</a>. You can use both IPv4 and IPv6 protocols to connect
18
+ * to the endpoints and send requests to the AWS IoT Wireless service. For more information,
19
+ * see <a href="https://docs.aws.amazon.com/iot-wireless/latest/developerguide/wireless-ipv6-access.html">Using
20
+ * IPv6 with AWS IoT Wireless</a>.</p>
18
21
  *
19
22
  * @packageDocumentation
20
23
  */