aws-sdk-iotwireless 1.29.0 → 1.31.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-iotwireless/client.rb +432 -12
- data/lib/aws-sdk-iotwireless/client_api.rb +321 -0
- data/lib/aws-sdk-iotwireless/endpoint_parameters.rb +0 -3
- data/lib/aws-sdk-iotwireless/endpoint_provider.rb +27 -24
- data/lib/aws-sdk-iotwireless/endpoints.rb +112 -0
- data/lib/aws-sdk-iotwireless/plugins/endpoints.rb +16 -0
- data/lib/aws-sdk-iotwireless/types.rb +711 -16
- data/lib/aws-sdk-iotwireless.rb +1 -1
- metadata +2 -2
@@ -676,6 +676,10 @@ module Aws::IoTWireless
|
|
676
676
|
# **A suitable default value is auto-generated.** You should normally
|
677
677
|
# not need to pass this option.**
|
678
678
|
#
|
679
|
+
# @option params [Types::SidewalkCreateDeviceProfile] :sidewalk
|
680
|
+
# The Sidewalk-related information for creating the Sidewalk device
|
681
|
+
# profile.
|
682
|
+
#
|
679
683
|
# @return [Types::CreateDeviceProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
680
684
|
#
|
681
685
|
# * {Types::CreateDeviceProfileResponse#arn #arn} => String
|
@@ -713,6 +717,8 @@ module Aws::IoTWireless
|
|
713
717
|
# },
|
714
718
|
# ],
|
715
719
|
# client_request_token: "ClientRequestToken",
|
720
|
+
# sidewalk: {
|
721
|
+
# },
|
716
722
|
# })
|
717
723
|
#
|
718
724
|
# @example Response structure
|
@@ -758,6 +764,23 @@ module Aws::IoTWireless
|
|
758
764
|
# The tag to attach to the specified resource. Tags are metadata that
|
759
765
|
# you can use to manage a resource.
|
760
766
|
#
|
767
|
+
# @option params [Integer] :redundancy_percent
|
768
|
+
# The percentage of added redundant fragments. For example, if firmware
|
769
|
+
# file is 100 bytes and fragment size is 10 bytes, with
|
770
|
+
# `RedundancyPercent` set to 50(%), the final number of encoded
|
771
|
+
# fragments is (100 / 10) + (100 / 10 * 50%) = 15.
|
772
|
+
#
|
773
|
+
# @option params [Integer] :fragment_size_bytes
|
774
|
+
# The size of each fragment in bytes. Currently only supported in fuota
|
775
|
+
# tasks with multicast groups.
|
776
|
+
#
|
777
|
+
# @option params [Integer] :fragment_interval_ms
|
778
|
+
# The interval of sending fragments in milliseconds. Currently the
|
779
|
+
# interval will be rounded to the nearest second. Note that this
|
780
|
+
# interval only controls the timing when the cloud sends the fragments
|
781
|
+
# down. The actual delay of receiving fragments at device side depends
|
782
|
+
# on the device's class and the communication delay with the cloud.
|
783
|
+
#
|
761
784
|
# @return [Types::CreateFuotaTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
762
785
|
#
|
763
786
|
# * {Types::CreateFuotaTaskResponse#arn #arn} => String
|
@@ -770,7 +793,7 @@ module Aws::IoTWireless
|
|
770
793
|
# description: "Description",
|
771
794
|
# client_request_token: "ClientRequestToken",
|
772
795
|
# lo_ra_wan: {
|
773
|
-
# rf_region: "EU868", # accepts EU868, US915, AU915, AS923-1
|
796
|
+
# rf_region: "EU868", # accepts EU868, US915, AU915, AS923-1, AS923-2, AS923-3, AS923-4, EU433, CN470, CN779, RU864, KR920, IN865
|
774
797
|
# },
|
775
798
|
# firmware_update_image: "FirmwareUpdateImage", # required
|
776
799
|
# firmware_update_role: "FirmwareUpdateRole", # required
|
@@ -780,6 +803,9 @@ module Aws::IoTWireless
|
|
780
803
|
# value: "TagValue", # required
|
781
804
|
# },
|
782
805
|
# ],
|
806
|
+
# redundancy_percent: 1,
|
807
|
+
# fragment_size_bytes: 1,
|
808
|
+
# fragment_interval_ms: 1,
|
783
809
|
# })
|
784
810
|
#
|
785
811
|
# @example Response structure
|
@@ -830,7 +856,7 @@ module Aws::IoTWireless
|
|
830
856
|
# description: "Description",
|
831
857
|
# client_request_token: "ClientRequestToken",
|
832
858
|
# lo_ra_wan: { # required
|
833
|
-
# rf_region: "EU868", # accepts EU868, US915, AU915, AS923-1
|
859
|
+
# rf_region: "EU868", # accepts EU868, US915, AU915, AS923-1, AS923-2, AS923-3, AS923-4, EU433, CN470, CN779, RU864, KR920, IN865
|
834
860
|
# dl_class: "ClassB", # accepts ClassB, ClassC
|
835
861
|
# },
|
836
862
|
# tags: [
|
@@ -1015,6 +1041,10 @@ module Aws::IoTWireless
|
|
1015
1041
|
# FPort values for the GNSS, stream, and ClockSync functions of the
|
1016
1042
|
# positioning information.
|
1017
1043
|
#
|
1044
|
+
# @option params [Types::SidewalkCreateWirelessDevice] :sidewalk
|
1045
|
+
# The device configuration information to use to create the Sidewalk
|
1046
|
+
# device.
|
1047
|
+
#
|
1018
1048
|
# @return [Types::CreateWirelessDeviceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1019
1049
|
#
|
1020
1050
|
# * {Types::CreateWirelessDeviceResponse#arn #arn} => String
|
@@ -1085,6 +1115,9 @@ module Aws::IoTWireless
|
|
1085
1115
|
# },
|
1086
1116
|
# ],
|
1087
1117
|
# positioning: "Enabled", # accepts Enabled, Disabled
|
1118
|
+
# sidewalk: {
|
1119
|
+
# device_profile_id: "DeviceProfileId",
|
1120
|
+
# },
|
1088
1121
|
# })
|
1089
1122
|
#
|
1090
1123
|
# @example Response structure
|
@@ -1446,6 +1479,26 @@ module Aws::IoTWireless
|
|
1446
1479
|
req.send_request(options)
|
1447
1480
|
end
|
1448
1481
|
|
1482
|
+
# Delete an import task.
|
1483
|
+
#
|
1484
|
+
# @option params [required, String] :id
|
1485
|
+
# The unique identifier of the import task to be deleted.
|
1486
|
+
#
|
1487
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1488
|
+
#
|
1489
|
+
# @example Request syntax with placeholder values
|
1490
|
+
#
|
1491
|
+
# resp = client.delete_wireless_device_import_task({
|
1492
|
+
# id: "ImportTaskId", # required
|
1493
|
+
# })
|
1494
|
+
#
|
1495
|
+
# @overload delete_wireless_device_import_task(params = {})
|
1496
|
+
# @param [Hash] params ({})
|
1497
|
+
def delete_wireless_device_import_task(params = {}, options = {})
|
1498
|
+
req = build_request(:delete_wireless_device_import_task, params)
|
1499
|
+
req.send_request(options)
|
1500
|
+
end
|
1501
|
+
|
1449
1502
|
# Deletes a wireless gateway.
|
1450
1503
|
#
|
1451
1504
|
# @option params [required, String] :id
|
@@ -1507,6 +1560,32 @@ module Aws::IoTWireless
|
|
1507
1560
|
req.send_request(options)
|
1508
1561
|
end
|
1509
1562
|
|
1563
|
+
# Deregister a wireless device from AWS IoT Wireless.
|
1564
|
+
#
|
1565
|
+
# @option params [required, String] :identifier
|
1566
|
+
# The identifier of the wireless device to deregister from AWS IoT
|
1567
|
+
# Wireless.
|
1568
|
+
#
|
1569
|
+
# @option params [String] :wireless_device_type
|
1570
|
+
# The type of wireless device to deregister from AWS IoT Wireless, which
|
1571
|
+
# can be `LoRaWAN` or `Sidewalk`.
|
1572
|
+
#
|
1573
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1574
|
+
#
|
1575
|
+
# @example Request syntax with placeholder values
|
1576
|
+
#
|
1577
|
+
# resp = client.deregister_wireless_device({
|
1578
|
+
# identifier: "Identifier", # required
|
1579
|
+
# wireless_device_type: "Sidewalk", # accepts Sidewalk, LoRaWAN
|
1580
|
+
# })
|
1581
|
+
#
|
1582
|
+
# @overload deregister_wireless_device(params = {})
|
1583
|
+
# @param [Hash] params ({})
|
1584
|
+
def deregister_wireless_device(params = {}, options = {})
|
1585
|
+
req = build_request(:deregister_wireless_device, params)
|
1586
|
+
req.send_request(options)
|
1587
|
+
end
|
1588
|
+
|
1510
1589
|
# Disassociates your AWS account from a partner account. If
|
1511
1590
|
# `PartnerAccountId` and `PartnerType` are `null`, disassociates your
|
1512
1591
|
# AWS account from all partner accounts.
|
@@ -1713,6 +1792,7 @@ module Aws::IoTWireless
|
|
1713
1792
|
# * {Types::GetDeviceProfileResponse#name #name} => String
|
1714
1793
|
# * {Types::GetDeviceProfileResponse#id #id} => String
|
1715
1794
|
# * {Types::GetDeviceProfileResponse#lo_ra_wan #lo_ra_wan} => Types::LoRaWANDeviceProfile
|
1795
|
+
# * {Types::GetDeviceProfileResponse#sidewalk #sidewalk} => Types::SidewalkGetDeviceProfile
|
1716
1796
|
#
|
1717
1797
|
# @example Request syntax with placeholder values
|
1718
1798
|
#
|
@@ -1745,6 +1825,14 @@ module Aws::IoTWireless
|
|
1745
1825
|
# resp.lo_ra_wan.rf_region #=> String
|
1746
1826
|
# resp.lo_ra_wan.supports_join #=> Boolean
|
1747
1827
|
# resp.lo_ra_wan.supports_32_bit_f_cnt #=> Boolean
|
1828
|
+
# resp.sidewalk.application_server_public_key #=> String
|
1829
|
+
# resp.sidewalk.qualification_status #=> Boolean
|
1830
|
+
# resp.sidewalk.dak_certificate_metadata #=> Array
|
1831
|
+
# resp.sidewalk.dak_certificate_metadata[0].certificate_id #=> String
|
1832
|
+
# resp.sidewalk.dak_certificate_metadata[0].max_allowed_signature #=> Integer
|
1833
|
+
# resp.sidewalk.dak_certificate_metadata[0].factory_support #=> Boolean
|
1834
|
+
# resp.sidewalk.dak_certificate_metadata[0].ap_id #=> String
|
1835
|
+
# resp.sidewalk.dak_certificate_metadata[0].device_type_id #=> String
|
1748
1836
|
#
|
1749
1837
|
# @overload get_device_profile(params = {})
|
1750
1838
|
# @param [Hash] params ({})
|
@@ -1794,6 +1882,9 @@ module Aws::IoTWireless
|
|
1794
1882
|
# * {Types::GetFuotaTaskResponse#firmware_update_image #firmware_update_image} => String
|
1795
1883
|
# * {Types::GetFuotaTaskResponse#firmware_update_role #firmware_update_role} => String
|
1796
1884
|
# * {Types::GetFuotaTaskResponse#created_at #created_at} => Time
|
1885
|
+
# * {Types::GetFuotaTaskResponse#redundancy_percent #redundancy_percent} => Integer
|
1886
|
+
# * {Types::GetFuotaTaskResponse#fragment_size_bytes #fragment_size_bytes} => Integer
|
1887
|
+
# * {Types::GetFuotaTaskResponse#fragment_interval_ms #fragment_interval_ms} => Integer
|
1797
1888
|
#
|
1798
1889
|
# @example Request syntax with placeholder values
|
1799
1890
|
#
|
@@ -1813,6 +1904,9 @@ module Aws::IoTWireless
|
|
1813
1904
|
# resp.firmware_update_image #=> String
|
1814
1905
|
# resp.firmware_update_role #=> String
|
1815
1906
|
# resp.created_at #=> Time
|
1907
|
+
# resp.redundancy_percent #=> Integer
|
1908
|
+
# resp.fragment_size_bytes #=> Integer
|
1909
|
+
# resp.fragment_interval_ms #=> Integer
|
1816
1910
|
#
|
1817
1911
|
# @overload get_fuota_task(params = {})
|
1818
1912
|
# @param [Hash] params ({})
|
@@ -1882,7 +1976,7 @@ module Aws::IoTWireless
|
|
1882
1976
|
# resp.name #=> String
|
1883
1977
|
# resp.description #=> String
|
1884
1978
|
# resp.status #=> String
|
1885
|
-
# resp.lo_ra_wan.rf_region #=> String, one of "EU868", "US915", "AU915", "AS923-1"
|
1979
|
+
# resp.lo_ra_wan.rf_region #=> String, one of "EU868", "US915", "AU915", "AS923-1", "AS923-2", "AS923-3", "AS923-4", "EU433", "CN470", "CN779", "RU864", "KR920", "IN865"
|
1886
1980
|
# resp.lo_ra_wan.dl_class #=> String, one of "ClassB", "ClassC"
|
1887
1981
|
# resp.lo_ra_wan.number_of_devices_requested #=> Integer
|
1888
1982
|
# resp.lo_ra_wan.number_of_devices_in_group #=> Integer
|
@@ -2118,7 +2212,7 @@ module Aws::IoTWireless
|
|
2118
2212
|
#
|
2119
2213
|
# @option params [Time,DateTime,Date,Integer,String] :timestamp
|
2120
2214
|
# Optional information that specifies the time when the position
|
2121
|
-
# information will be resolved. It uses the
|
2215
|
+
# information will be resolved. It uses the Unix timestamp format. If
|
2122
2216
|
# not specified, the time at which the request was received will be
|
2123
2217
|
# used.
|
2124
2218
|
#
|
@@ -2367,7 +2461,7 @@ module Aws::IoTWireless
|
|
2367
2461
|
end
|
2368
2462
|
|
2369
2463
|
# Get the position information for a given wireless device or a wireless
|
2370
|
-
# gateway resource. The
|
2464
|
+
# gateway resource. The position information uses the [ World Geodetic
|
2371
2465
|
# System (WGS84)][1].
|
2372
2466
|
#
|
2373
2467
|
#
|
@@ -2376,8 +2470,8 @@ module Aws::IoTWireless
|
|
2376
2470
|
#
|
2377
2471
|
# @option params [required, String] :resource_identifier
|
2378
2472
|
# The identifier of the resource for which position information is
|
2379
|
-
# retrieved. It can be the wireless device ID or the wireless gateway
|
2380
|
-
# depending on the resource type.
|
2473
|
+
# retrieved. It can be the wireless device ID or the wireless gateway
|
2474
|
+
# ID, depending on the resource type.
|
2381
2475
|
#
|
2382
2476
|
# @option params [required, String] :resource_type
|
2383
2477
|
# The type of resource for which position information is retrieved,
|
@@ -2563,6 +2657,12 @@ module Aws::IoTWireless
|
|
2563
2657
|
# resp.sidewalk.device_certificates #=> Array
|
2564
2658
|
# resp.sidewalk.device_certificates[0].signing_alg #=> String, one of "Ed25519", "P256r1"
|
2565
2659
|
# resp.sidewalk.device_certificates[0].value #=> String
|
2660
|
+
# resp.sidewalk.private_keys #=> Array
|
2661
|
+
# resp.sidewalk.private_keys[0].signing_alg #=> String, one of "Ed25519", "P256r1"
|
2662
|
+
# resp.sidewalk.private_keys[0].value #=> String
|
2663
|
+
# resp.sidewalk.device_profile_id #=> String
|
2664
|
+
# resp.sidewalk.certificate_id #=> String
|
2665
|
+
# resp.sidewalk.status #=> String, one of "PROVISIONED", "REGISTERED", "ACTIVATED", "UNKNOWN"
|
2566
2666
|
# resp.positioning #=> String, one of "Enabled", "Disabled"
|
2567
2667
|
#
|
2568
2668
|
# @overload get_wireless_device(params = {})
|
@@ -2572,6 +2672,55 @@ module Aws::IoTWireless
|
|
2572
2672
|
req.send_request(options)
|
2573
2673
|
end
|
2574
2674
|
|
2675
|
+
# Get information about an import task and count of device onboarding
|
2676
|
+
# summary information for the import task.
|
2677
|
+
#
|
2678
|
+
# @option params [required, String] :id
|
2679
|
+
# The identifier of the import task for which information is requested.
|
2680
|
+
#
|
2681
|
+
# @return [Types::GetWirelessDeviceImportTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2682
|
+
#
|
2683
|
+
# * {Types::GetWirelessDeviceImportTaskResponse#id #id} => String
|
2684
|
+
# * {Types::GetWirelessDeviceImportTaskResponse#arn #arn} => String
|
2685
|
+
# * {Types::GetWirelessDeviceImportTaskResponse#destination_name #destination_name} => String
|
2686
|
+
# * {Types::GetWirelessDeviceImportTaskResponse#sidewalk #sidewalk} => Types::SidewalkGetStartImportInfo
|
2687
|
+
# * {Types::GetWirelessDeviceImportTaskResponse#creation_time #creation_time} => Time
|
2688
|
+
# * {Types::GetWirelessDeviceImportTaskResponse#status #status} => String
|
2689
|
+
# * {Types::GetWirelessDeviceImportTaskResponse#status_reason #status_reason} => String
|
2690
|
+
# * {Types::GetWirelessDeviceImportTaskResponse#initialized_imported_device_count #initialized_imported_device_count} => Integer
|
2691
|
+
# * {Types::GetWirelessDeviceImportTaskResponse#pending_imported_device_count #pending_imported_device_count} => Integer
|
2692
|
+
# * {Types::GetWirelessDeviceImportTaskResponse#onboarded_imported_device_count #onboarded_imported_device_count} => Integer
|
2693
|
+
# * {Types::GetWirelessDeviceImportTaskResponse#failed_imported_device_count #failed_imported_device_count} => Integer
|
2694
|
+
#
|
2695
|
+
# @example Request syntax with placeholder values
|
2696
|
+
#
|
2697
|
+
# resp = client.get_wireless_device_import_task({
|
2698
|
+
# id: "ImportTaskId", # required
|
2699
|
+
# })
|
2700
|
+
#
|
2701
|
+
# @example Response structure
|
2702
|
+
#
|
2703
|
+
# resp.id #=> String
|
2704
|
+
# resp.arn #=> String
|
2705
|
+
# resp.destination_name #=> String
|
2706
|
+
# resp.sidewalk.device_creation_file_list #=> Array
|
2707
|
+
# resp.sidewalk.device_creation_file_list[0] #=> String
|
2708
|
+
# resp.sidewalk.role #=> String
|
2709
|
+
# resp.creation_time #=> Time
|
2710
|
+
# resp.status #=> String, one of "INITIALIZING", "INITIALIZED", "PENDING", "COMPLETE", "FAILED", "DELETING"
|
2711
|
+
# resp.status_reason #=> String
|
2712
|
+
# resp.initialized_imported_device_count #=> Integer
|
2713
|
+
# resp.pending_imported_device_count #=> Integer
|
2714
|
+
# resp.onboarded_imported_device_count #=> Integer
|
2715
|
+
# resp.failed_imported_device_count #=> Integer
|
2716
|
+
#
|
2717
|
+
# @overload get_wireless_device_import_task(params = {})
|
2718
|
+
# @param [Hash] params ({})
|
2719
|
+
def get_wireless_device_import_task(params = {}, options = {})
|
2720
|
+
req = build_request(:get_wireless_device_import_task, params)
|
2721
|
+
req.send_request(options)
|
2722
|
+
end
|
2723
|
+
|
2575
2724
|
# Gets operating information about a wireless device.
|
2576
2725
|
#
|
2577
2726
|
# @option params [required, String] :wireless_device_id
|
@@ -2883,6 +3032,10 @@ module Aws::IoTWireless
|
|
2883
3032
|
# @option params [Integer] :max_results
|
2884
3033
|
# The maximum number of results to return in this operation.
|
2885
3034
|
#
|
3035
|
+
# @option params [String] :device_profile_type
|
3036
|
+
# A filter to list only device profiles that use this type, which can be
|
3037
|
+
# `LoRaWAN` or `Sidewalk`.
|
3038
|
+
#
|
2886
3039
|
# @return [Types::ListDeviceProfilesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2887
3040
|
#
|
2888
3041
|
# * {Types::ListDeviceProfilesResponse#next_token #next_token} => String
|
@@ -2895,6 +3048,7 @@ module Aws::IoTWireless
|
|
2895
3048
|
# resp = client.list_device_profiles({
|
2896
3049
|
# next_token: "NextToken",
|
2897
3050
|
# max_results: 1,
|
3051
|
+
# device_profile_type: "Sidewalk", # accepts Sidewalk, LoRaWAN
|
2898
3052
|
# })
|
2899
3053
|
#
|
2900
3054
|
# @example Response structure
|
@@ -2912,6 +3066,56 @@ module Aws::IoTWireless
|
|
2912
3066
|
req.send_request(options)
|
2913
3067
|
end
|
2914
3068
|
|
3069
|
+
# List the Sidewalk devices in an import task and their onboarding
|
3070
|
+
# status.
|
3071
|
+
#
|
3072
|
+
# @option params [required, String] :id
|
3073
|
+
# The identifier of the import task for which wireless devices are
|
3074
|
+
# listed.
|
3075
|
+
#
|
3076
|
+
# @option params [Integer] :max_results
|
3077
|
+
# The maximum number of results to return in this operation.
|
3078
|
+
#
|
3079
|
+
# @option params [String] :next_token
|
3080
|
+
# To retrieve the next set of results, the `nextToken` value from a
|
3081
|
+
# previous response; otherwise `null` to receive the first set of
|
3082
|
+
# results.
|
3083
|
+
#
|
3084
|
+
# @option params [String] :status
|
3085
|
+
# The status of the devices in the import task.
|
3086
|
+
#
|
3087
|
+
# @return [Types::ListDevicesForWirelessDeviceImportTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3088
|
+
#
|
3089
|
+
# * {Types::ListDevicesForWirelessDeviceImportTaskResponse#next_token #next_token} => String
|
3090
|
+
# * {Types::ListDevicesForWirelessDeviceImportTaskResponse#destination_name #destination_name} => String
|
3091
|
+
# * {Types::ListDevicesForWirelessDeviceImportTaskResponse#imported_wireless_device_list #imported_wireless_device_list} => Array<Types::ImportedWirelessDevice>
|
3092
|
+
#
|
3093
|
+
# @example Request syntax with placeholder values
|
3094
|
+
#
|
3095
|
+
# resp = client.list_devices_for_wireless_device_import_task({
|
3096
|
+
# id: "ImportTaskId", # required
|
3097
|
+
# max_results: 1,
|
3098
|
+
# next_token: "NextToken",
|
3099
|
+
# status: "INITIALIZED", # accepts INITIALIZED, PENDING, ONBOARDED, FAILED
|
3100
|
+
# })
|
3101
|
+
#
|
3102
|
+
# @example Response structure
|
3103
|
+
#
|
3104
|
+
# resp.next_token #=> String
|
3105
|
+
# resp.destination_name #=> String
|
3106
|
+
# resp.imported_wireless_device_list #=> Array
|
3107
|
+
# resp.imported_wireless_device_list[0].sidewalk.sidewalk_manufacturing_sn #=> String
|
3108
|
+
# resp.imported_wireless_device_list[0].sidewalk.onboarding_status #=> String, one of "INITIALIZED", "PENDING", "ONBOARDED", "FAILED"
|
3109
|
+
# resp.imported_wireless_device_list[0].sidewalk.onboarding_status_reason #=> String
|
3110
|
+
# resp.imported_wireless_device_list[0].sidewalk.last_update_time #=> Time
|
3111
|
+
#
|
3112
|
+
# @overload list_devices_for_wireless_device_import_task(params = {})
|
3113
|
+
# @param [Hash] params ({})
|
3114
|
+
def list_devices_for_wireless_device_import_task(params = {}, options = {})
|
3115
|
+
req = build_request(:list_devices_for_wireless_device_import_task, params)
|
3116
|
+
req.send_request(options)
|
3117
|
+
end
|
3118
|
+
|
2915
3119
|
# List event configurations where at least one event topic has been
|
2916
3120
|
# enabled.
|
2917
3121
|
#
|
@@ -3335,6 +3539,53 @@ module Aws::IoTWireless
|
|
3335
3539
|
req.send_request(options)
|
3336
3540
|
end
|
3337
3541
|
|
3542
|
+
# List wireless devices that have been added to an import task.
|
3543
|
+
#
|
3544
|
+
# @option params [Integer] :max_results
|
3545
|
+
# The maximum number of results to return in this operation.
|
3546
|
+
#
|
3547
|
+
# @option params [String] :next_token
|
3548
|
+
# To retrieve the next set of results, the `nextToken` value from a
|
3549
|
+
# previous response; otherwise `null` to receive the first set of
|
3550
|
+
# results.
|
3551
|
+
#
|
3552
|
+
# @return [Types::ListWirelessDeviceImportTasksResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3553
|
+
#
|
3554
|
+
# * {Types::ListWirelessDeviceImportTasksResponse#next_token #next_token} => String
|
3555
|
+
# * {Types::ListWirelessDeviceImportTasksResponse#wireless_device_import_task_list #wireless_device_import_task_list} => Array<Types::WirelessDeviceImportTask>
|
3556
|
+
#
|
3557
|
+
# @example Request syntax with placeholder values
|
3558
|
+
#
|
3559
|
+
# resp = client.list_wireless_device_import_tasks({
|
3560
|
+
# max_results: 1,
|
3561
|
+
# next_token: "NextToken",
|
3562
|
+
# })
|
3563
|
+
#
|
3564
|
+
# @example Response structure
|
3565
|
+
#
|
3566
|
+
# resp.next_token #=> String
|
3567
|
+
# resp.wireless_device_import_task_list #=> Array
|
3568
|
+
# resp.wireless_device_import_task_list[0].id #=> String
|
3569
|
+
# resp.wireless_device_import_task_list[0].arn #=> String
|
3570
|
+
# resp.wireless_device_import_task_list[0].destination_name #=> String
|
3571
|
+
# resp.wireless_device_import_task_list[0].sidewalk.device_creation_file_list #=> Array
|
3572
|
+
# resp.wireless_device_import_task_list[0].sidewalk.device_creation_file_list[0] #=> String
|
3573
|
+
# resp.wireless_device_import_task_list[0].sidewalk.role #=> String
|
3574
|
+
# resp.wireless_device_import_task_list[0].creation_time #=> Time
|
3575
|
+
# resp.wireless_device_import_task_list[0].status #=> String, one of "INITIALIZING", "INITIALIZED", "PENDING", "COMPLETE", "FAILED", "DELETING"
|
3576
|
+
# resp.wireless_device_import_task_list[0].status_reason #=> String
|
3577
|
+
# resp.wireless_device_import_task_list[0].initialized_imported_device_count #=> Integer
|
3578
|
+
# resp.wireless_device_import_task_list[0].pending_imported_device_count #=> Integer
|
3579
|
+
# resp.wireless_device_import_task_list[0].onboarded_imported_device_count #=> Integer
|
3580
|
+
# resp.wireless_device_import_task_list[0].failed_imported_device_count #=> Integer
|
3581
|
+
#
|
3582
|
+
# @overload list_wireless_device_import_tasks(params = {})
|
3583
|
+
# @param [Hash] params ({})
|
3584
|
+
def list_wireless_device_import_tasks(params = {}, options = {})
|
3585
|
+
req = build_request(:list_wireless_device_import_tasks, params)
|
3586
|
+
req.send_request(options)
|
3587
|
+
end
|
3588
|
+
|
3338
3589
|
# Lists the wireless devices registered to your AWS account.
|
3339
3590
|
#
|
3340
3591
|
# @option params [Integer] :max_results
|
@@ -3403,6 +3654,8 @@ module Aws::IoTWireless
|
|
3403
3654
|
# resp.wireless_device_list[0].sidewalk.device_certificates #=> Array
|
3404
3655
|
# resp.wireless_device_list[0].sidewalk.device_certificates[0].signing_alg #=> String, one of "Ed25519", "P256r1"
|
3405
3656
|
# resp.wireless_device_list[0].sidewalk.device_certificates[0].value #=> String
|
3657
|
+
# resp.wireless_device_list[0].sidewalk.device_profile_id #=> String
|
3658
|
+
# resp.wireless_device_list[0].sidewalk.status #=> String, one of "PROVISIONED", "REGISTERED", "ACTIVATED", "UNKNOWN"
|
3406
3659
|
# resp.wireless_device_list[0].fuota_device_status #=> String, one of "Initial", "Package_Not_Supported", "FragAlgo_unsupported", "Not_enough_memory", "FragIndex_unsupported", "Wrong_descriptor", "SessionCnt_replay", "MissingFrag", "MemoryError", "MICError", "Successful"
|
3407
3660
|
# resp.wireless_device_list[0].multicast_device_status #=> String
|
3408
3661
|
# resp.wireless_device_list[0].mc_group_id #=> Integer
|
@@ -3863,6 +4116,127 @@ module Aws::IoTWireless
|
|
3863
4116
|
req.send_request(options)
|
3864
4117
|
end
|
3865
4118
|
|
4119
|
+
# Start import task for a single wireless device.
|
4120
|
+
#
|
4121
|
+
# @option params [required, String] :destination_name
|
4122
|
+
# The name of the Sidewalk destination that describes the IoT rule to
|
4123
|
+
# route messages from the device in the import task that will be
|
4124
|
+
# onboarded to AWS IoT Wireless.
|
4125
|
+
#
|
4126
|
+
# @option params [String] :client_request_token
|
4127
|
+
# Each resource must have a unique client request token. If you try to
|
4128
|
+
# create a new resource with the same token as a resource that already
|
4129
|
+
# exists, an exception occurs. If you omit this value, AWS SDKs will
|
4130
|
+
# automatically generate a unique client request.
|
4131
|
+
#
|
4132
|
+
# **A suitable default value is auto-generated.** You should normally
|
4133
|
+
# not need to pass this option.**
|
4134
|
+
#
|
4135
|
+
# @option params [String] :device_name
|
4136
|
+
# The name of the wireless device for which an import task is being
|
4137
|
+
# started.
|
4138
|
+
#
|
4139
|
+
# @option params [Array<Types::Tag>] :tags
|
4140
|
+
# The tag to attach to the specified resource. Tags are metadata that
|
4141
|
+
# you can use to manage a resource.
|
4142
|
+
#
|
4143
|
+
# @option params [required, Types::SidewalkSingleStartImportInfo] :sidewalk
|
4144
|
+
# The Sidewalk-related parameters for importing a single wireless
|
4145
|
+
# device.
|
4146
|
+
#
|
4147
|
+
# @return [Types::StartSingleWirelessDeviceImportTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4148
|
+
#
|
4149
|
+
# * {Types::StartSingleWirelessDeviceImportTaskResponse#id #id} => String
|
4150
|
+
# * {Types::StartSingleWirelessDeviceImportTaskResponse#arn #arn} => String
|
4151
|
+
#
|
4152
|
+
# @example Request syntax with placeholder values
|
4153
|
+
#
|
4154
|
+
# resp = client.start_single_wireless_device_import_task({
|
4155
|
+
# destination_name: "DestinationName", # required
|
4156
|
+
# client_request_token: "ClientRequestToken",
|
4157
|
+
# device_name: "DeviceName",
|
4158
|
+
# tags: [
|
4159
|
+
# {
|
4160
|
+
# key: "TagKey", # required
|
4161
|
+
# value: "TagValue", # required
|
4162
|
+
# },
|
4163
|
+
# ],
|
4164
|
+
# sidewalk: { # required
|
4165
|
+
# sidewalk_manufacturing_sn: "SidewalkManufacturingSn",
|
4166
|
+
# },
|
4167
|
+
# })
|
4168
|
+
#
|
4169
|
+
# @example Response structure
|
4170
|
+
#
|
4171
|
+
# resp.id #=> String
|
4172
|
+
# resp.arn #=> String
|
4173
|
+
#
|
4174
|
+
# @overload start_single_wireless_device_import_task(params = {})
|
4175
|
+
# @param [Hash] params ({})
|
4176
|
+
def start_single_wireless_device_import_task(params = {}, options = {})
|
4177
|
+
req = build_request(:start_single_wireless_device_import_task, params)
|
4178
|
+
req.send_request(options)
|
4179
|
+
end
|
4180
|
+
|
4181
|
+
# Start import task for provisioning Sidewalk devices in bulk using an
|
4182
|
+
# S3 CSV file.
|
4183
|
+
#
|
4184
|
+
# @option params [required, String] :destination_name
|
4185
|
+
# The name of the Sidewalk destination that describes the IoT rule to
|
4186
|
+
# route messages from the devices in the import task that are onboarded
|
4187
|
+
# to AWS IoT Wireless.
|
4188
|
+
#
|
4189
|
+
# @option params [String] :client_request_token
|
4190
|
+
# Each resource must have a unique client request token. If you try to
|
4191
|
+
# create a new resource with the same token as a resource that already
|
4192
|
+
# exists, an exception occurs. If you omit this value, AWS SDKs will
|
4193
|
+
# automatically generate a unique client request.
|
4194
|
+
#
|
4195
|
+
# **A suitable default value is auto-generated.** You should normally
|
4196
|
+
# not need to pass this option.**
|
4197
|
+
#
|
4198
|
+
# @option params [Array<Types::Tag>] :tags
|
4199
|
+
# The tag to attach to the specified resource. Tags are metadata that
|
4200
|
+
# you can use to manage a resource.
|
4201
|
+
#
|
4202
|
+
# @option params [required, Types::SidewalkStartImportInfo] :sidewalk
|
4203
|
+
# The Sidewalk-related parameters for importing wireless devices that
|
4204
|
+
# need to be provisioned in bulk.
|
4205
|
+
#
|
4206
|
+
# @return [Types::StartWirelessDeviceImportTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4207
|
+
#
|
4208
|
+
# * {Types::StartWirelessDeviceImportTaskResponse#id #id} => String
|
4209
|
+
# * {Types::StartWirelessDeviceImportTaskResponse#arn #arn} => String
|
4210
|
+
#
|
4211
|
+
# @example Request syntax with placeholder values
|
4212
|
+
#
|
4213
|
+
# resp = client.start_wireless_device_import_task({
|
4214
|
+
# destination_name: "DestinationName", # required
|
4215
|
+
# client_request_token: "ClientRequestToken",
|
4216
|
+
# tags: [
|
4217
|
+
# {
|
4218
|
+
# key: "TagKey", # required
|
4219
|
+
# value: "TagValue", # required
|
4220
|
+
# },
|
4221
|
+
# ],
|
4222
|
+
# sidewalk: { # required
|
4223
|
+
# device_creation_file: "DeviceCreationFile",
|
4224
|
+
# role: "Role",
|
4225
|
+
# },
|
4226
|
+
# })
|
4227
|
+
#
|
4228
|
+
# @example Response structure
|
4229
|
+
#
|
4230
|
+
# resp.id #=> String
|
4231
|
+
# resp.arn #=> String
|
4232
|
+
#
|
4233
|
+
# @overload start_wireless_device_import_task(params = {})
|
4234
|
+
# @param [Hash] params ({})
|
4235
|
+
def start_wireless_device_import_task(params = {}, options = {})
|
4236
|
+
req = build_request(:start_wireless_device_import_task, params)
|
4237
|
+
req.send_request(options)
|
4238
|
+
end
|
4239
|
+
|
3866
4240
|
# Adds a tag to a resource.
|
3867
4241
|
#
|
3868
4242
|
# @option params [required, String] :resource_arn
|
@@ -4062,6 +4436,23 @@ module Aws::IoTWireless
|
|
4062
4436
|
# @option params [String] :firmware_update_role
|
4063
4437
|
# The firmware update role that is to be used with a FUOTA task.
|
4064
4438
|
#
|
4439
|
+
# @option params [Integer] :redundancy_percent
|
4440
|
+
# The percentage of added redundant fragments. For example, if firmware
|
4441
|
+
# file is 100 bytes and fragment size is 10 bytes, with
|
4442
|
+
# `RedundancyPercent` set to 50(%), the final number of encoded
|
4443
|
+
# fragments is (100 / 10) + (100 / 10 * 50%) = 15.
|
4444
|
+
#
|
4445
|
+
# @option params [Integer] :fragment_size_bytes
|
4446
|
+
# The size of each fragment in bytes. Currently only supported in fuota
|
4447
|
+
# tasks with multicast groups.
|
4448
|
+
#
|
4449
|
+
# @option params [Integer] :fragment_interval_ms
|
4450
|
+
# The interval of sending fragments in milliseconds. Currently the
|
4451
|
+
# interval will be rounded to the nearest second. Note that this
|
4452
|
+
# interval only controls the timing when the cloud sends the fragments
|
4453
|
+
# down. The actual delay of receiving fragments at device side depends
|
4454
|
+
# on the device's class and the communication delay with the cloud.
|
4455
|
+
#
|
4065
4456
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4066
4457
|
#
|
4067
4458
|
# @example Request syntax with placeholder values
|
@@ -4071,10 +4462,13 @@ module Aws::IoTWireless
|
|
4071
4462
|
# name: "FuotaTaskName",
|
4072
4463
|
# description: "Description",
|
4073
4464
|
# lo_ra_wan: {
|
4074
|
-
# rf_region: "EU868", # accepts EU868, US915, AU915, AS923-1
|
4465
|
+
# rf_region: "EU868", # accepts EU868, US915, AU915, AS923-1, AS923-2, AS923-3, AS923-4, EU433, CN470, CN779, RU864, KR920, IN865
|
4075
4466
|
# },
|
4076
4467
|
# firmware_update_image: "FirmwareUpdateImage",
|
4077
4468
|
# firmware_update_role: "FirmwareUpdateRole",
|
4469
|
+
# redundancy_percent: 1,
|
4470
|
+
# fragment_size_bytes: 1,
|
4471
|
+
# fragment_interval_ms: 1,
|
4078
4472
|
# })
|
4079
4473
|
#
|
4080
4474
|
# @overload update_fuota_task(params = {})
|
@@ -4162,7 +4556,7 @@ module Aws::IoTWireless
|
|
4162
4556
|
# name: "MulticastGroupName",
|
4163
4557
|
# description: "Description",
|
4164
4558
|
# lo_ra_wan: {
|
4165
|
-
# rf_region: "EU868", # accepts EU868, US915, AU915, AS923-1
|
4559
|
+
# rf_region: "EU868", # accepts EU868, US915, AU915, AS923-1, AS923-2, AS923-3, AS923-4, EU433, CN470, CN779, RU864, KR920, IN865
|
4166
4560
|
# dl_class: "ClassB", # accepts ClassB, ClassC
|
4167
4561
|
# },
|
4168
4562
|
# })
|
@@ -4371,7 +4765,7 @@ module Aws::IoTWireless
|
|
4371
4765
|
end
|
4372
4766
|
|
4373
4767
|
# Update the position information of a given wireless device or a
|
4374
|
-
# wireless gateway resource. The
|
4768
|
+
# wireless gateway resource. The position coordinates are based on the [
|
4375
4769
|
# World Geodetic System (WGS84)][1].
|
4376
4770
|
#
|
4377
4771
|
#
|
@@ -4380,7 +4774,7 @@ module Aws::IoTWireless
|
|
4380
4774
|
#
|
4381
4775
|
# @option params [required, String] :resource_identifier
|
4382
4776
|
# The identifier of the resource for which position information is
|
4383
|
-
# updated. It can be the wireless device ID or the wireless gateway ID
|
4777
|
+
# updated. It can be the wireless device ID or the wireless gateway ID,
|
4384
4778
|
# depending on the resource type.
|
4385
4779
|
#
|
4386
4780
|
# @option params [required, String] :resource_type
|
@@ -4478,6 +4872,32 @@ module Aws::IoTWireless
|
|
4478
4872
|
req.send_request(options)
|
4479
4873
|
end
|
4480
4874
|
|
4875
|
+
# Update an import task to add more devices to the task.
|
4876
|
+
#
|
4877
|
+
# @option params [required, String] :id
|
4878
|
+
# The identifier of the import task to be updated.
|
4879
|
+
#
|
4880
|
+
# @option params [required, Types::SidewalkUpdateImportInfo] :sidewalk
|
4881
|
+
# The Sidewalk-related parameters of the import task to be updated.
|
4882
|
+
#
|
4883
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4884
|
+
#
|
4885
|
+
# @example Request syntax with placeholder values
|
4886
|
+
#
|
4887
|
+
# resp = client.update_wireless_device_import_task({
|
4888
|
+
# id: "ImportTaskId", # required
|
4889
|
+
# sidewalk: { # required
|
4890
|
+
# device_creation_file: "DeviceCreationFile",
|
4891
|
+
# },
|
4892
|
+
# })
|
4893
|
+
#
|
4894
|
+
# @overload update_wireless_device_import_task(params = {})
|
4895
|
+
# @param [Hash] params ({})
|
4896
|
+
def update_wireless_device_import_task(params = {}, options = {})
|
4897
|
+
req = build_request(:update_wireless_device_import_task, params)
|
4898
|
+
req.send_request(options)
|
4899
|
+
end
|
4900
|
+
|
4481
4901
|
# Updates properties of a wireless gateway.
|
4482
4902
|
#
|
4483
4903
|
# @option params [required, String] :id
|
@@ -4530,7 +4950,7 @@ module Aws::IoTWireless
|
|
4530
4950
|
params: params,
|
4531
4951
|
config: config)
|
4532
4952
|
context[:gem_name] = 'aws-sdk-iotwireless'
|
4533
|
-
context[:gem_version] = '1.
|
4953
|
+
context[:gem_version] = '1.31.0'
|
4534
4954
|
Seahorse::Client::Request.new(handlers, context)
|
4535
4955
|
end
|
4536
4956
|
|