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
@@ -377,7 +377,7 @@ module Aws::IoTWireless
|
|
377
377
|
# @return [Float]
|
378
378
|
#
|
379
379
|
# @!attribute [rw] base_lng
|
380
|
-
# CDMA base station
|
380
|
+
# CDMA base station longitude in degrees.
|
381
381
|
# @return [Float]
|
382
382
|
#
|
383
383
|
# @!attribute [rw] cdma_nmr
|
@@ -588,11 +588,17 @@ module Aws::IoTWireless
|
|
588
588
|
# not need to pass this option.
|
589
589
|
# @return [String]
|
590
590
|
#
|
591
|
+
# @!attribute [rw] sidewalk
|
592
|
+
# The Sidewalk-related information for creating the Sidewalk device
|
593
|
+
# profile.
|
594
|
+
# @return [Types::SidewalkCreateDeviceProfile]
|
595
|
+
#
|
591
596
|
class CreateDeviceProfileRequest < Struct.new(
|
592
597
|
:name,
|
593
598
|
:lo_ra_wan,
|
594
599
|
:tags,
|
595
|
-
:client_request_token
|
600
|
+
:client_request_token,
|
601
|
+
:sidewalk)
|
596
602
|
SENSITIVE = []
|
597
603
|
include Aws::Structure
|
598
604
|
end
|
@@ -648,6 +654,26 @@ module Aws::IoTWireless
|
|
648
654
|
# you can use to manage a resource.
|
649
655
|
# @return [Array<Types::Tag>]
|
650
656
|
#
|
657
|
+
# @!attribute [rw] redundancy_percent
|
658
|
+
# The percentage of added redundant fragments. For example, if
|
659
|
+
# firmware file is 100 bytes and fragment size is 10 bytes, with
|
660
|
+
# `RedundancyPercent` set to 50(%), the final number of encoded
|
661
|
+
# fragments is (100 / 10) + (100 / 10 * 50%) = 15.
|
662
|
+
# @return [Integer]
|
663
|
+
#
|
664
|
+
# @!attribute [rw] fragment_size_bytes
|
665
|
+
# The size of each fragment in bytes. Currently only supported in
|
666
|
+
# fuota tasks with multicast groups.
|
667
|
+
# @return [Integer]
|
668
|
+
#
|
669
|
+
# @!attribute [rw] fragment_interval_ms
|
670
|
+
# The interval of sending fragments in milliseconds. Currently the
|
671
|
+
# interval will be rounded to the nearest second. Note that this
|
672
|
+
# interval only controls the timing when the cloud sends the fragments
|
673
|
+
# down. The actual delay of receiving fragments at device side depends
|
674
|
+
# on the device's class and the communication delay with the cloud.
|
675
|
+
# @return [Integer]
|
676
|
+
#
|
651
677
|
class CreateFuotaTaskRequest < Struct.new(
|
652
678
|
:name,
|
653
679
|
:description,
|
@@ -655,7 +681,10 @@ module Aws::IoTWireless
|
|
655
681
|
:lo_ra_wan,
|
656
682
|
:firmware_update_image,
|
657
683
|
:firmware_update_role,
|
658
|
-
:tags
|
684
|
+
:tags,
|
685
|
+
:redundancy_percent,
|
686
|
+
:fragment_size_bytes,
|
687
|
+
:fragment_interval_ms)
|
659
688
|
SENSITIVE = []
|
660
689
|
include Aws::Structure
|
661
690
|
end
|
@@ -883,6 +912,11 @@ module Aws::IoTWireless
|
|
883
912
|
# positioning information.
|
884
913
|
# @return [String]
|
885
914
|
#
|
915
|
+
# @!attribute [rw] sidewalk
|
916
|
+
# The device configuration information to use to create the Sidewalk
|
917
|
+
# device.
|
918
|
+
# @return [Types::SidewalkCreateWirelessDevice]
|
919
|
+
#
|
886
920
|
class CreateWirelessDeviceRequest < Struct.new(
|
887
921
|
:type,
|
888
922
|
:name,
|
@@ -891,7 +925,8 @@ module Aws::IoTWireless
|
|
891
925
|
:client_request_token,
|
892
926
|
:lo_ra_wan,
|
893
927
|
:tags,
|
894
|
-
:positioning
|
928
|
+
:positioning,
|
929
|
+
:sidewalk)
|
895
930
|
SENSITIVE = []
|
896
931
|
include Aws::Structure
|
897
932
|
end
|
@@ -1048,6 +1083,40 @@ module Aws::IoTWireless
|
|
1048
1083
|
include Aws::Structure
|
1049
1084
|
end
|
1050
1085
|
|
1086
|
+
# The device attestation key (DAK) information.
|
1087
|
+
#
|
1088
|
+
# @!attribute [rw] certificate_id
|
1089
|
+
# The certificate ID for the DAK.
|
1090
|
+
# @return [String]
|
1091
|
+
#
|
1092
|
+
# @!attribute [rw] max_allowed_signature
|
1093
|
+
# The maximum number of signatures that the DAK can sign. A value of
|
1094
|
+
# `-1` indicates that there's no device limit.
|
1095
|
+
# @return [Integer]
|
1096
|
+
#
|
1097
|
+
# @!attribute [rw] factory_support
|
1098
|
+
# Whether factory support has been enabled.
|
1099
|
+
# @return [Boolean]
|
1100
|
+
#
|
1101
|
+
# @!attribute [rw] ap_id
|
1102
|
+
# The advertised product ID (APID) that's used for pre-production and
|
1103
|
+
# production applications.
|
1104
|
+
# @return [String]
|
1105
|
+
#
|
1106
|
+
# @!attribute [rw] device_type_id
|
1107
|
+
# The device type ID that's used for prototyping applications.
|
1108
|
+
# @return [String]
|
1109
|
+
#
|
1110
|
+
class DakCertificateMetadata < Struct.new(
|
1111
|
+
:certificate_id,
|
1112
|
+
:max_allowed_signature,
|
1113
|
+
:factory_support,
|
1114
|
+
:ap_id,
|
1115
|
+
:device_type_id)
|
1116
|
+
SENSITIVE = []
|
1117
|
+
include Aws::Structure
|
1118
|
+
end
|
1119
|
+
|
1051
1120
|
# @!attribute [rw] name
|
1052
1121
|
# The name of the resource to delete.
|
1053
1122
|
# @return [String]
|
@@ -1145,6 +1214,18 @@ module Aws::IoTWireless
|
|
1145
1214
|
|
1146
1215
|
class DeleteServiceProfileResponse < Aws::EmptyStructure; end
|
1147
1216
|
|
1217
|
+
# @!attribute [rw] id
|
1218
|
+
# The unique identifier of the import task to be deleted.
|
1219
|
+
# @return [String]
|
1220
|
+
#
|
1221
|
+
class DeleteWirelessDeviceImportTaskRequest < Struct.new(
|
1222
|
+
:id)
|
1223
|
+
SENSITIVE = []
|
1224
|
+
include Aws::Structure
|
1225
|
+
end
|
1226
|
+
|
1227
|
+
class DeleteWirelessDeviceImportTaskResponse < Aws::EmptyStructure; end
|
1228
|
+
|
1148
1229
|
# @!attribute [rw] id
|
1149
1230
|
# The ID of the resource to delete.
|
1150
1231
|
# @return [String]
|
@@ -1193,6 +1274,25 @@ module Aws::IoTWireless
|
|
1193
1274
|
|
1194
1275
|
class DeleteWirelessGatewayTaskResponse < Aws::EmptyStructure; end
|
1195
1276
|
|
1277
|
+
# @!attribute [rw] identifier
|
1278
|
+
# The identifier of the wireless device to deregister from AWS IoT
|
1279
|
+
# Wireless.
|
1280
|
+
# @return [String]
|
1281
|
+
#
|
1282
|
+
# @!attribute [rw] wireless_device_type
|
1283
|
+
# The type of wireless device to deregister from AWS IoT Wireless,
|
1284
|
+
# which can be `LoRaWAN` or `Sidewalk`.
|
1285
|
+
# @return [String]
|
1286
|
+
#
|
1287
|
+
class DeregisterWirelessDeviceRequest < Struct.new(
|
1288
|
+
:identifier,
|
1289
|
+
:wireless_device_type)
|
1290
|
+
SENSITIVE = []
|
1291
|
+
include Aws::Structure
|
1292
|
+
end
|
1293
|
+
|
1294
|
+
class DeregisterWirelessDeviceResponse < Aws::EmptyStructure; end
|
1295
|
+
|
1196
1296
|
# Describes a destination.
|
1197
1297
|
#
|
1198
1298
|
# @!attribute [rw] arn
|
@@ -1633,11 +1733,16 @@ module Aws::IoTWireless
|
|
1633
1733
|
# Information about the device profile.
|
1634
1734
|
# @return [Types::LoRaWANDeviceProfile]
|
1635
1735
|
#
|
1736
|
+
# @!attribute [rw] sidewalk
|
1737
|
+
# Information about the Sidewalk parameters in the device profile.
|
1738
|
+
# @return [Types::SidewalkGetDeviceProfile]
|
1739
|
+
#
|
1636
1740
|
class GetDeviceProfileResponse < Struct.new(
|
1637
1741
|
:arn,
|
1638
1742
|
:name,
|
1639
1743
|
:id,
|
1640
|
-
:lo_ra_wan
|
1744
|
+
:lo_ra_wan,
|
1745
|
+
:sidewalk)
|
1641
1746
|
SENSITIVE = []
|
1642
1747
|
include Aws::Structure
|
1643
1748
|
end
|
@@ -1725,6 +1830,26 @@ module Aws::IoTWireless
|
|
1725
1830
|
# Created at timestamp for the resource.
|
1726
1831
|
# @return [Time]
|
1727
1832
|
#
|
1833
|
+
# @!attribute [rw] redundancy_percent
|
1834
|
+
# The percentage of added redundant fragments. For example, if
|
1835
|
+
# firmware file is 100 bytes and fragment size is 10 bytes, with
|
1836
|
+
# `RedundancyPercent` set to 50(%), the final number of encoded
|
1837
|
+
# fragments is (100 / 10) + (100 / 10 * 50%) = 15.
|
1838
|
+
# @return [Integer]
|
1839
|
+
#
|
1840
|
+
# @!attribute [rw] fragment_size_bytes
|
1841
|
+
# The size of each fragment in bytes. Currently only supported in
|
1842
|
+
# fuota tasks with multicast groups.
|
1843
|
+
# @return [Integer]
|
1844
|
+
#
|
1845
|
+
# @!attribute [rw] fragment_interval_ms
|
1846
|
+
# The interval of sending fragments in milliseconds. Currently the
|
1847
|
+
# interval will be rounded to the nearest second. Note that this
|
1848
|
+
# interval only controls the timing when the cloud sends the fragments
|
1849
|
+
# down. The actual delay of receiving fragments at device side depends
|
1850
|
+
# on the device's class and the communication delay with the cloud.
|
1851
|
+
# @return [Integer]
|
1852
|
+
#
|
1728
1853
|
class GetFuotaTaskResponse < Struct.new(
|
1729
1854
|
:arn,
|
1730
1855
|
:id,
|
@@ -1734,7 +1859,10 @@ module Aws::IoTWireless
|
|
1734
1859
|
:lo_ra_wan,
|
1735
1860
|
:firmware_update_image,
|
1736
1861
|
:firmware_update_role,
|
1737
|
-
:created_at
|
1862
|
+
:created_at,
|
1863
|
+
:redundancy_percent,
|
1864
|
+
:fragment_size_bytes,
|
1865
|
+
:fragment_interval_ms)
|
1738
1866
|
SENSITIVE = []
|
1739
1867
|
include Aws::Structure
|
1740
1868
|
end
|
@@ -1972,7 +2100,7 @@ module Aws::IoTWireless
|
|
1972
2100
|
#
|
1973
2101
|
# @!attribute [rw] timestamp
|
1974
2102
|
# Optional information that specifies the time when the position
|
1975
|
-
# information will be resolved. It uses the
|
2103
|
+
# information will be resolved. It uses the Unix timestamp format. If
|
1976
2104
|
# not specified, the time at which the request was received will be
|
1977
2105
|
# used.
|
1978
2106
|
# @return [Time]
|
@@ -2144,7 +2272,7 @@ module Aws::IoTWireless
|
|
2144
2272
|
# @!attribute [rw] resource_identifier
|
2145
2273
|
# The identifier of the resource for which position information is
|
2146
2274
|
# retrieved. It can be the wireless device ID or the wireless gateway
|
2147
|
-
# ID depending on the resource type.
|
2275
|
+
# ID, depending on the resource type.
|
2148
2276
|
# @return [String]
|
2149
2277
|
#
|
2150
2278
|
# @!attribute [rw] resource_type
|
@@ -2244,6 +2372,84 @@ module Aws::IoTWireless
|
|
2244
2372
|
include Aws::Structure
|
2245
2373
|
end
|
2246
2374
|
|
2375
|
+
# @!attribute [rw] id
|
2376
|
+
# The identifier of the import task for which information is
|
2377
|
+
# requested.
|
2378
|
+
# @return [String]
|
2379
|
+
#
|
2380
|
+
class GetWirelessDeviceImportTaskRequest < Struct.new(
|
2381
|
+
:id)
|
2382
|
+
SENSITIVE = []
|
2383
|
+
include Aws::Structure
|
2384
|
+
end
|
2385
|
+
|
2386
|
+
# @!attribute [rw] id
|
2387
|
+
# The identifier of the import task for which information is
|
2388
|
+
# retrieved.
|
2389
|
+
# @return [String]
|
2390
|
+
#
|
2391
|
+
# @!attribute [rw] arn
|
2392
|
+
# The ARN (Amazon Resource Name) of the import task.
|
2393
|
+
# @return [String]
|
2394
|
+
#
|
2395
|
+
# @!attribute [rw] destination_name
|
2396
|
+
# The name of the destination that's assigned to the wireless devices
|
2397
|
+
# in the import task.
|
2398
|
+
# @return [String]
|
2399
|
+
#
|
2400
|
+
# @!attribute [rw] sidewalk
|
2401
|
+
# The Sidewalk-related information about an import task.
|
2402
|
+
# @return [Types::SidewalkGetStartImportInfo]
|
2403
|
+
#
|
2404
|
+
# @!attribute [rw] creation_time
|
2405
|
+
# The time at which the import task was created.
|
2406
|
+
# @return [Time]
|
2407
|
+
#
|
2408
|
+
# @!attribute [rw] status
|
2409
|
+
# The import task status.
|
2410
|
+
# @return [String]
|
2411
|
+
#
|
2412
|
+
# @!attribute [rw] status_reason
|
2413
|
+
# The reason for the provided status information, such as a validation
|
2414
|
+
# error that causes the import task to fail.
|
2415
|
+
# @return [String]
|
2416
|
+
#
|
2417
|
+
# @!attribute [rw] initialized_imported_device_count
|
2418
|
+
# The number of devices in the import task that are waiting for the
|
2419
|
+
# control log to start processing.
|
2420
|
+
# @return [Integer]
|
2421
|
+
#
|
2422
|
+
# @!attribute [rw] pending_imported_device_count
|
2423
|
+
# The number of devices in the import task that are waiting in the
|
2424
|
+
# import task queue to be onboarded.
|
2425
|
+
# @return [Integer]
|
2426
|
+
#
|
2427
|
+
# @!attribute [rw] onboarded_imported_device_count
|
2428
|
+
# The number of devices in the import task that have been onboarded to
|
2429
|
+
# the import task.
|
2430
|
+
# @return [Integer]
|
2431
|
+
#
|
2432
|
+
# @!attribute [rw] failed_imported_device_count
|
2433
|
+
# The number of devices in the import task that failed to onboard to
|
2434
|
+
# the import task.
|
2435
|
+
# @return [Integer]
|
2436
|
+
#
|
2437
|
+
class GetWirelessDeviceImportTaskResponse < Struct.new(
|
2438
|
+
:id,
|
2439
|
+
:arn,
|
2440
|
+
:destination_name,
|
2441
|
+
:sidewalk,
|
2442
|
+
:creation_time,
|
2443
|
+
:status,
|
2444
|
+
:status_reason,
|
2445
|
+
:initialized_imported_device_count,
|
2446
|
+
:pending_imported_device_count,
|
2447
|
+
:onboarded_imported_device_count,
|
2448
|
+
:failed_imported_device_count)
|
2449
|
+
SENSITIVE = []
|
2450
|
+
include Aws::Structure
|
2451
|
+
end
|
2452
|
+
|
2247
2453
|
# @!attribute [rw] identifier
|
2248
2454
|
# The identifier of the wireless device to get.
|
2249
2455
|
# @return [String]
|
@@ -2603,7 +2809,7 @@ module Aws::IoTWireless
|
|
2603
2809
|
#
|
2604
2810
|
# @!attribute [rw] assist_position
|
2605
2811
|
# Optional assistance position information, specified using latitude
|
2606
|
-
# and longitude values in degrees. The
|
2812
|
+
# and longitude values in degrees. The coordinates are inside the
|
2607
2813
|
# WGS84 reference frame.
|
2608
2814
|
# @return [Array<Float>]
|
2609
2815
|
#
|
@@ -2726,6 +2932,50 @@ module Aws::IoTWireless
|
|
2726
2932
|
include Aws::Structure
|
2727
2933
|
end
|
2728
2934
|
|
2935
|
+
# Information about a Sidewalk device that has been added to an import
|
2936
|
+
# task.
|
2937
|
+
#
|
2938
|
+
# @!attribute [rw] sidewalk_manufacturing_sn
|
2939
|
+
# The Sidewalk manufacturing serial number (SMSN) of the Sidewalk
|
2940
|
+
# device.
|
2941
|
+
# @return [String]
|
2942
|
+
#
|
2943
|
+
# @!attribute [rw] onboarding_status
|
2944
|
+
# The onboarding status of the Sidewalk device in the import task.
|
2945
|
+
# @return [String]
|
2946
|
+
#
|
2947
|
+
# @!attribute [rw] onboarding_status_reason
|
2948
|
+
# The reason for the onboarding status information for the Sidewalk
|
2949
|
+
# device.
|
2950
|
+
# @return [String]
|
2951
|
+
#
|
2952
|
+
# @!attribute [rw] last_update_time
|
2953
|
+
# The time at which the status information was last updated.
|
2954
|
+
# @return [Time]
|
2955
|
+
#
|
2956
|
+
class ImportedSidewalkDevice < Struct.new(
|
2957
|
+
:sidewalk_manufacturing_sn,
|
2958
|
+
:onboarding_status,
|
2959
|
+
:onboarding_status_reason,
|
2960
|
+
:last_update_time)
|
2961
|
+
SENSITIVE = []
|
2962
|
+
include Aws::Structure
|
2963
|
+
end
|
2964
|
+
|
2965
|
+
# Information about a wireless device that has been added to an import
|
2966
|
+
# task.
|
2967
|
+
#
|
2968
|
+
# @!attribute [rw] sidewalk
|
2969
|
+
# The Sidewalk-related information about a device that has been added
|
2970
|
+
# to an import task.
|
2971
|
+
# @return [Types::ImportedSidewalkDevice]
|
2972
|
+
#
|
2973
|
+
class ImportedWirelessDevice < Struct.new(
|
2974
|
+
:sidewalk)
|
2975
|
+
SENSITIVE = []
|
2976
|
+
include Aws::Structure
|
2977
|
+
end
|
2978
|
+
|
2729
2979
|
# An unexpected error occurred while processing a request.
|
2730
2980
|
#
|
2731
2981
|
# @!attribute [rw] message
|
@@ -2825,9 +3075,15 @@ module Aws::IoTWireless
|
|
2825
3075
|
# The maximum number of results to return in this operation.
|
2826
3076
|
# @return [Integer]
|
2827
3077
|
#
|
3078
|
+
# @!attribute [rw] device_profile_type
|
3079
|
+
# A filter to list only device profiles that use this type, which can
|
3080
|
+
# be `LoRaWAN` or `Sidewalk`.
|
3081
|
+
# @return [String]
|
3082
|
+
#
|
2828
3083
|
class ListDeviceProfilesRequest < Struct.new(
|
2829
3084
|
:next_token,
|
2830
|
-
:max_results
|
3085
|
+
:max_results,
|
3086
|
+
:device_profile_type)
|
2831
3087
|
SENSITIVE = []
|
2832
3088
|
include Aws::Structure
|
2833
3089
|
end
|
@@ -2848,6 +3104,58 @@ module Aws::IoTWireless
|
|
2848
3104
|
include Aws::Structure
|
2849
3105
|
end
|
2850
3106
|
|
3107
|
+
# @!attribute [rw] id
|
3108
|
+
# The identifier of the import task for which wireless devices are
|
3109
|
+
# listed.
|
3110
|
+
# @return [String]
|
3111
|
+
#
|
3112
|
+
# @!attribute [rw] max_results
|
3113
|
+
# The maximum number of results to return in this operation.
|
3114
|
+
# @return [Integer]
|
3115
|
+
#
|
3116
|
+
# @!attribute [rw] next_token
|
3117
|
+
# To retrieve the next set of results, the `nextToken` value from a
|
3118
|
+
# previous response; otherwise `null` to receive the first set of
|
3119
|
+
# results.
|
3120
|
+
# @return [String]
|
3121
|
+
#
|
3122
|
+
# @!attribute [rw] status
|
3123
|
+
# The status of the devices in the import task.
|
3124
|
+
# @return [String]
|
3125
|
+
#
|
3126
|
+
class ListDevicesForWirelessDeviceImportTaskRequest < Struct.new(
|
3127
|
+
:id,
|
3128
|
+
:max_results,
|
3129
|
+
:next_token,
|
3130
|
+
:status)
|
3131
|
+
SENSITIVE = []
|
3132
|
+
include Aws::Structure
|
3133
|
+
end
|
3134
|
+
|
3135
|
+
# @!attribute [rw] next_token
|
3136
|
+
# The token to use to get the next set of results, or `null` if there
|
3137
|
+
# are no additional results.
|
3138
|
+
# @return [String]
|
3139
|
+
#
|
3140
|
+
# @!attribute [rw] destination_name
|
3141
|
+
# The name of the Sidewalk destination that describes the IoT rule to
|
3142
|
+
# route messages received from devices in an import task that are
|
3143
|
+
# onboarded to AWS IoT Wireless.
|
3144
|
+
# @return [String]
|
3145
|
+
#
|
3146
|
+
# @!attribute [rw] imported_wireless_device_list
|
3147
|
+
# List of wireless devices in an import task and their onboarding
|
3148
|
+
# status.
|
3149
|
+
# @return [Array<Types::ImportedWirelessDevice>]
|
3150
|
+
#
|
3151
|
+
class ListDevicesForWirelessDeviceImportTaskResponse < Struct.new(
|
3152
|
+
:next_token,
|
3153
|
+
:destination_name,
|
3154
|
+
:imported_wireless_device_list)
|
3155
|
+
SENSITIVE = []
|
3156
|
+
include Aws::Structure
|
3157
|
+
end
|
3158
|
+
|
2851
3159
|
# @!attribute [rw] resource_type
|
2852
3160
|
# Resource type to filter event configurations.
|
2853
3161
|
# @return [String]
|
@@ -3197,6 +3505,40 @@ module Aws::IoTWireless
|
|
3197
3505
|
include Aws::Structure
|
3198
3506
|
end
|
3199
3507
|
|
3508
|
+
# @!attribute [rw] max_results
|
3509
|
+
# The maximum number of results to return in this operation.
|
3510
|
+
# @return [Integer]
|
3511
|
+
#
|
3512
|
+
# @!attribute [rw] next_token
|
3513
|
+
# To retrieve the next set of results, the `nextToken` value from a
|
3514
|
+
# previous response; otherwise `null` to receive the first set of
|
3515
|
+
# results.
|
3516
|
+
# @return [String]
|
3517
|
+
#
|
3518
|
+
class ListWirelessDeviceImportTasksRequest < Struct.new(
|
3519
|
+
:max_results,
|
3520
|
+
:next_token)
|
3521
|
+
SENSITIVE = []
|
3522
|
+
include Aws::Structure
|
3523
|
+
end
|
3524
|
+
|
3525
|
+
# @!attribute [rw] next_token
|
3526
|
+
# The token to use to get the next set of results, or `null` if there
|
3527
|
+
# are no additional results.
|
3528
|
+
# @return [String]
|
3529
|
+
#
|
3530
|
+
# @!attribute [rw] wireless_device_import_task_list
|
3531
|
+
# List of import tasks and summary information of onboarding status of
|
3532
|
+
# devices in each import task.
|
3533
|
+
# @return [Array<Types::WirelessDeviceImportTask>]
|
3534
|
+
#
|
3535
|
+
class ListWirelessDeviceImportTasksResponse < Struct.new(
|
3536
|
+
:next_token,
|
3537
|
+
:wireless_device_import_task_list)
|
3538
|
+
SENSITIVE = []
|
3539
|
+
include Aws::Structure
|
3540
|
+
end
|
3541
|
+
|
3200
3542
|
# @!attribute [rw] max_results
|
3201
3543
|
# The maximum number of results to return in this operation.
|
3202
3544
|
# @return [Integer]
|
@@ -4748,6 +5090,24 @@ module Aws::IoTWireless
|
|
4748
5090
|
include Aws::Structure
|
4749
5091
|
end
|
4750
5092
|
|
5093
|
+
# Sidewalk object for creating a device profile.
|
5094
|
+
#
|
5095
|
+
# @api private
|
5096
|
+
#
|
5097
|
+
class SidewalkCreateDeviceProfile < Aws::EmptyStructure; end
|
5098
|
+
|
5099
|
+
# Sidewalk object for creating a wireless device.
|
5100
|
+
#
|
5101
|
+
# @!attribute [rw] device_profile_id
|
5102
|
+
# The ID of the Sidewalk device profile.
|
5103
|
+
# @return [String]
|
5104
|
+
#
|
5105
|
+
class SidewalkCreateWirelessDevice < Struct.new(
|
5106
|
+
:device_profile_id)
|
5107
|
+
SENSITIVE = []
|
5108
|
+
include Aws::Structure
|
5109
|
+
end
|
5110
|
+
|
4751
5111
|
# Sidewalk device object.
|
4752
5112
|
#
|
4753
5113
|
# @!attribute [rw] amazon_id
|
@@ -4766,11 +5126,32 @@ module Aws::IoTWireless
|
|
4766
5126
|
# The sidewalk device certificates for Ed25519 and P256r1.
|
4767
5127
|
# @return [Array<Types::CertificateList>]
|
4768
5128
|
#
|
5129
|
+
# @!attribute [rw] private_keys
|
5130
|
+
# The Sidewalk device private keys that will be used for onboarding
|
5131
|
+
# the device.
|
5132
|
+
# @return [Array<Types::CertificateList>]
|
5133
|
+
#
|
5134
|
+
# @!attribute [rw] device_profile_id
|
5135
|
+
# The ID of the Sidewalk device profile.
|
5136
|
+
# @return [String]
|
5137
|
+
#
|
5138
|
+
# @!attribute [rw] certificate_id
|
5139
|
+
# The ID of the Sidewalk device profile.
|
5140
|
+
# @return [String]
|
5141
|
+
#
|
5142
|
+
# @!attribute [rw] status
|
5143
|
+
# The Sidewalk device status, such as provisioned or registered.
|
5144
|
+
# @return [String]
|
5145
|
+
#
|
4769
5146
|
class SidewalkDevice < Struct.new(
|
4770
5147
|
:amazon_id,
|
4771
5148
|
:sidewalk_id,
|
4772
5149
|
:sidewalk_manufacturing_sn,
|
4773
|
-
:device_certificates
|
5150
|
+
:device_certificates,
|
5151
|
+
:private_keys,
|
5152
|
+
:device_profile_id,
|
5153
|
+
:certificate_id,
|
5154
|
+
:status)
|
4774
5155
|
SENSITIVE = []
|
4775
5156
|
include Aws::Structure
|
4776
5157
|
end
|
@@ -4815,6 +5196,48 @@ module Aws::IoTWireless
|
|
4815
5196
|
include Aws::Structure
|
4816
5197
|
end
|
4817
5198
|
|
5199
|
+
# Gets information about a Sidewalk device profile.
|
5200
|
+
#
|
5201
|
+
# @!attribute [rw] application_server_public_key
|
5202
|
+
# The Sidewalk application server public key.
|
5203
|
+
# @return [String]
|
5204
|
+
#
|
5205
|
+
# @!attribute [rw] qualification_status
|
5206
|
+
# Gets information about the certification status of a Sidewalk device
|
5207
|
+
# profile.
|
5208
|
+
# @return [Boolean]
|
5209
|
+
#
|
5210
|
+
# @!attribute [rw] dak_certificate_metadata
|
5211
|
+
# The DAK certificate information of the Sidewalk device profile.
|
5212
|
+
# @return [Array<Types::DakCertificateMetadata>]
|
5213
|
+
#
|
5214
|
+
class SidewalkGetDeviceProfile < Struct.new(
|
5215
|
+
:application_server_public_key,
|
5216
|
+
:qualification_status,
|
5217
|
+
:dak_certificate_metadata)
|
5218
|
+
SENSITIVE = [:application_server_public_key]
|
5219
|
+
include Aws::Structure
|
5220
|
+
end
|
5221
|
+
|
5222
|
+
# Sidewalk-related information for devices in an import task that are
|
5223
|
+
# being onboarded.
|
5224
|
+
#
|
5225
|
+
# @!attribute [rw] device_creation_file_list
|
5226
|
+
# List of Sidewalk devices that are added to the import task.
|
5227
|
+
# @return [Array<String>]
|
5228
|
+
#
|
5229
|
+
# @!attribute [rw] role
|
5230
|
+
# The IAM role that allows AWS IoT Wireless to access the CSV file in
|
5231
|
+
# the S3 bucket.
|
5232
|
+
# @return [String]
|
5233
|
+
#
|
5234
|
+
class SidewalkGetStartImportInfo < Struct.new(
|
5235
|
+
:device_creation_file_list,
|
5236
|
+
:role)
|
5237
|
+
SENSITIVE = []
|
5238
|
+
include Aws::Structure
|
5239
|
+
end
|
5240
|
+
|
4818
5241
|
# Sidewalk object used by list functions.
|
4819
5242
|
#
|
4820
5243
|
# @!attribute [rw] amazon_id
|
@@ -4833,11 +5256,22 @@ module Aws::IoTWireless
|
|
4833
5256
|
# The sidewalk device certificates for Ed25519 and P256r1.
|
4834
5257
|
# @return [Array<Types::CertificateList>]
|
4835
5258
|
#
|
5259
|
+
# @!attribute [rw] device_profile_id
|
5260
|
+
# Sidewalk object used by list functions.
|
5261
|
+
# @return [String]
|
5262
|
+
#
|
5263
|
+
# @!attribute [rw] status
|
5264
|
+
# The status of the Sidewalk devices, such as provisioned or
|
5265
|
+
# registered.
|
5266
|
+
# @return [String]
|
5267
|
+
#
|
4836
5268
|
class SidewalkListDevice < Struct.new(
|
4837
5269
|
:amazon_id,
|
4838
5270
|
:sidewalk_id,
|
4839
5271
|
:sidewalk_manufacturing_sn,
|
4840
|
-
:device_certificates
|
5272
|
+
:device_certificates,
|
5273
|
+
:device_profile_id,
|
5274
|
+
:status)
|
4841
5275
|
SENSITIVE = []
|
4842
5276
|
include Aws::Structure
|
4843
5277
|
end
|
@@ -4879,6 +5313,39 @@ module Aws::IoTWireless
|
|
4879
5313
|
include Aws::Structure
|
4880
5314
|
end
|
4881
5315
|
|
5316
|
+
# Information about an import task created for an individual Sidewalk
|
5317
|
+
# device.
|
5318
|
+
#
|
5319
|
+
# @!attribute [rw] sidewalk_manufacturing_sn
|
5320
|
+
# The Sidewalk manufacturing serial number (SMSN) of the device added
|
5321
|
+
# to the import task.
|
5322
|
+
# @return [String]
|
5323
|
+
#
|
5324
|
+
class SidewalkSingleStartImportInfo < Struct.new(
|
5325
|
+
:sidewalk_manufacturing_sn)
|
5326
|
+
SENSITIVE = []
|
5327
|
+
include Aws::Structure
|
5328
|
+
end
|
5329
|
+
|
5330
|
+
# Information about an import task created for bulk provisioning.
|
5331
|
+
#
|
5332
|
+
# @!attribute [rw] device_creation_file
|
5333
|
+
# The CSV file contained in an S3 bucket that's used for adding
|
5334
|
+
# devices to an import task.
|
5335
|
+
# @return [String]
|
5336
|
+
#
|
5337
|
+
# @!attribute [rw] role
|
5338
|
+
# The IAM role that allows AWS IoT Wireless to access the CSV file in
|
5339
|
+
# the S3 bucket.
|
5340
|
+
# @return [String]
|
5341
|
+
#
|
5342
|
+
class SidewalkStartImportInfo < Struct.new(
|
5343
|
+
:device_creation_file,
|
5344
|
+
:role)
|
5345
|
+
SENSITIVE = []
|
5346
|
+
include Aws::Structure
|
5347
|
+
end
|
5348
|
+
|
4882
5349
|
# Sidewalk update.
|
4883
5350
|
#
|
4884
5351
|
# @!attribute [rw] app_server_private_key
|
@@ -4891,6 +5358,19 @@ module Aws::IoTWireless
|
|
4891
5358
|
include Aws::Structure
|
4892
5359
|
end
|
4893
5360
|
|
5361
|
+
# Sidewalk object information for updating an import task.
|
5362
|
+
#
|
5363
|
+
# @!attribute [rw] device_creation_file
|
5364
|
+
# The CSV file contained in an S3 bucket that's used for appending
|
5365
|
+
# devices to an existing import task.
|
5366
|
+
# @return [String]
|
5367
|
+
#
|
5368
|
+
class SidewalkUpdateImportInfo < Struct.new(
|
5369
|
+
:device_creation_file)
|
5370
|
+
SENSITIVE = []
|
5371
|
+
include Aws::Structure
|
5372
|
+
end
|
5373
|
+
|
4894
5374
|
# @!attribute [rw] id
|
4895
5375
|
# The ID of the multicast group.
|
4896
5376
|
# @return [String]
|
@@ -4973,6 +5453,112 @@ module Aws::IoTWireless
|
|
4973
5453
|
|
4974
5454
|
class StartMulticastGroupSessionResponse < Aws::EmptyStructure; end
|
4975
5455
|
|
5456
|
+
# @!attribute [rw] destination_name
|
5457
|
+
# The name of the Sidewalk destination that describes the IoT rule to
|
5458
|
+
# route messages from the device in the import task that will be
|
5459
|
+
# onboarded to AWS IoT Wireless.
|
5460
|
+
# @return [String]
|
5461
|
+
#
|
5462
|
+
# @!attribute [rw] client_request_token
|
5463
|
+
# Each resource must have a unique client request token. If you try to
|
5464
|
+
# create a new resource with the same token as a resource that already
|
5465
|
+
# exists, an exception occurs. If you omit this value, AWS SDKs will
|
5466
|
+
# automatically generate a unique client request.
|
5467
|
+
#
|
5468
|
+
# **A suitable default value is auto-generated.** You should normally
|
5469
|
+
# not need to pass this option.
|
5470
|
+
# @return [String]
|
5471
|
+
#
|
5472
|
+
# @!attribute [rw] device_name
|
5473
|
+
# The name of the wireless device for which an import task is being
|
5474
|
+
# started.
|
5475
|
+
# @return [String]
|
5476
|
+
#
|
5477
|
+
# @!attribute [rw] tags
|
5478
|
+
# The tag to attach to the specified resource. Tags are metadata that
|
5479
|
+
# you can use to manage a resource.
|
5480
|
+
# @return [Array<Types::Tag>]
|
5481
|
+
#
|
5482
|
+
# @!attribute [rw] sidewalk
|
5483
|
+
# The Sidewalk-related parameters for importing a single wireless
|
5484
|
+
# device.
|
5485
|
+
# @return [Types::SidewalkSingleStartImportInfo]
|
5486
|
+
#
|
5487
|
+
class StartSingleWirelessDeviceImportTaskRequest < Struct.new(
|
5488
|
+
:destination_name,
|
5489
|
+
:client_request_token,
|
5490
|
+
:device_name,
|
5491
|
+
:tags,
|
5492
|
+
:sidewalk)
|
5493
|
+
SENSITIVE = []
|
5494
|
+
include Aws::Structure
|
5495
|
+
end
|
5496
|
+
|
5497
|
+
# @!attribute [rw] id
|
5498
|
+
# The import task ID.
|
5499
|
+
# @return [String]
|
5500
|
+
#
|
5501
|
+
# @!attribute [rw] arn
|
5502
|
+
# The ARN (Amazon Resource Name) of the import task.
|
5503
|
+
# @return [String]
|
5504
|
+
#
|
5505
|
+
class StartSingleWirelessDeviceImportTaskResponse < Struct.new(
|
5506
|
+
:id,
|
5507
|
+
:arn)
|
5508
|
+
SENSITIVE = []
|
5509
|
+
include Aws::Structure
|
5510
|
+
end
|
5511
|
+
|
5512
|
+
# @!attribute [rw] destination_name
|
5513
|
+
# The name of the Sidewalk destination that describes the IoT rule to
|
5514
|
+
# route messages from the devices in the import task that are
|
5515
|
+
# onboarded to AWS IoT Wireless.
|
5516
|
+
# @return [String]
|
5517
|
+
#
|
5518
|
+
# @!attribute [rw] client_request_token
|
5519
|
+
# Each resource must have a unique client request token. If you try to
|
5520
|
+
# create a new resource with the same token as a resource that already
|
5521
|
+
# exists, an exception occurs. If you omit this value, AWS SDKs will
|
5522
|
+
# automatically generate a unique client request.
|
5523
|
+
#
|
5524
|
+
# **A suitable default value is auto-generated.** You should normally
|
5525
|
+
# not need to pass this option.
|
5526
|
+
# @return [String]
|
5527
|
+
#
|
5528
|
+
# @!attribute [rw] tags
|
5529
|
+
# The tag to attach to the specified resource. Tags are metadata that
|
5530
|
+
# you can use to manage a resource.
|
5531
|
+
# @return [Array<Types::Tag>]
|
5532
|
+
#
|
5533
|
+
# @!attribute [rw] sidewalk
|
5534
|
+
# The Sidewalk-related parameters for importing wireless devices that
|
5535
|
+
# need to be provisioned in bulk.
|
5536
|
+
# @return [Types::SidewalkStartImportInfo]
|
5537
|
+
#
|
5538
|
+
class StartWirelessDeviceImportTaskRequest < Struct.new(
|
5539
|
+
:destination_name,
|
5540
|
+
:client_request_token,
|
5541
|
+
:tags,
|
5542
|
+
:sidewalk)
|
5543
|
+
SENSITIVE = []
|
5544
|
+
include Aws::Structure
|
5545
|
+
end
|
5546
|
+
|
5547
|
+
# @!attribute [rw] id
|
5548
|
+
# The import task ID.
|
5549
|
+
# @return [String]
|
5550
|
+
#
|
5551
|
+
# @!attribute [rw] arn
|
5552
|
+
# The ARN (Amazon Resource Name) of the import task.
|
5553
|
+
# @return [String]
|
5554
|
+
#
|
5555
|
+
class StartWirelessDeviceImportTaskResponse < Struct.new(
|
5556
|
+
:id,
|
5557
|
+
:arn)
|
5558
|
+
SENSITIVE = []
|
5559
|
+
include Aws::Structure
|
5560
|
+
end
|
5561
|
+
|
4976
5562
|
# A simple label consisting of a customer-defined key-value pair
|
4977
5563
|
#
|
4978
5564
|
# @!attribute [rw] key
|
@@ -5339,13 +5925,36 @@ module Aws::IoTWireless
|
|
5339
5925
|
# The firmware update role that is to be used with a FUOTA task.
|
5340
5926
|
# @return [String]
|
5341
5927
|
#
|
5928
|
+
# @!attribute [rw] redundancy_percent
|
5929
|
+
# The percentage of added redundant fragments. For example, if
|
5930
|
+
# firmware file is 100 bytes and fragment size is 10 bytes, with
|
5931
|
+
# `RedundancyPercent` set to 50(%), the final number of encoded
|
5932
|
+
# fragments is (100 / 10) + (100 / 10 * 50%) = 15.
|
5933
|
+
# @return [Integer]
|
5934
|
+
#
|
5935
|
+
# @!attribute [rw] fragment_size_bytes
|
5936
|
+
# The size of each fragment in bytes. Currently only supported in
|
5937
|
+
# fuota tasks with multicast groups.
|
5938
|
+
# @return [Integer]
|
5939
|
+
#
|
5940
|
+
# @!attribute [rw] fragment_interval_ms
|
5941
|
+
# The interval of sending fragments in milliseconds. Currently the
|
5942
|
+
# interval will be rounded to the nearest second. Note that this
|
5943
|
+
# interval only controls the timing when the cloud sends the fragments
|
5944
|
+
# down. The actual delay of receiving fragments at device side depends
|
5945
|
+
# on the device's class and the communication delay with the cloud.
|
5946
|
+
# @return [Integer]
|
5947
|
+
#
|
5342
5948
|
class UpdateFuotaTaskRequest < Struct.new(
|
5343
5949
|
:id,
|
5344
5950
|
:name,
|
5345
5951
|
:description,
|
5346
5952
|
:lo_ra_wan,
|
5347
5953
|
:firmware_update_image,
|
5348
|
-
:firmware_update_role
|
5954
|
+
:firmware_update_role,
|
5955
|
+
:redundancy_percent,
|
5956
|
+
:fragment_size_bytes,
|
5957
|
+
:fragment_interval_ms)
|
5349
5958
|
SENSITIVE = []
|
5350
5959
|
include Aws::Structure
|
5351
5960
|
end
|
@@ -5549,8 +6158,8 @@ module Aws::IoTWireless
|
|
5549
6158
|
|
5550
6159
|
# @!attribute [rw] resource_identifier
|
5551
6160
|
# The identifier of the resource for which position information is
|
5552
|
-
# updated. It can be the wireless device ID or the wireless gateway
|
5553
|
-
# depending on the resource type.
|
6161
|
+
# updated. It can be the wireless device ID or the wireless gateway
|
6162
|
+
# ID, depending on the resource type.
|
5554
6163
|
# @return [String]
|
5555
6164
|
#
|
5556
6165
|
# @!attribute [rw] resource_type
|
@@ -5579,6 +6188,23 @@ module Aws::IoTWireless
|
|
5579
6188
|
|
5580
6189
|
class UpdateResourcePositionResponse < Aws::EmptyStructure; end
|
5581
6190
|
|
6191
|
+
# @!attribute [rw] id
|
6192
|
+
# The identifier of the import task to be updated.
|
6193
|
+
# @return [String]
|
6194
|
+
#
|
6195
|
+
# @!attribute [rw] sidewalk
|
6196
|
+
# The Sidewalk-related parameters of the import task to be updated.
|
6197
|
+
# @return [Types::SidewalkUpdateImportInfo]
|
6198
|
+
#
|
6199
|
+
class UpdateWirelessDeviceImportTaskRequest < Struct.new(
|
6200
|
+
:id,
|
6201
|
+
:sidewalk)
|
6202
|
+
SENSITIVE = []
|
6203
|
+
include Aws::Structure
|
6204
|
+
end
|
6205
|
+
|
6206
|
+
class UpdateWirelessDeviceImportTaskResponse < Aws::EmptyStructure; end
|
6207
|
+
|
5582
6208
|
# @!attribute [rw] id
|
5583
6209
|
# The ID of the resource to update.
|
5584
6210
|
# @return [String]
|
@@ -5812,7 +6438,7 @@ module Aws::IoTWireless
|
|
5812
6438
|
# @return [String]
|
5813
6439
|
#
|
5814
6440
|
# @!attribute [rw] rss
|
5815
|
-
#
|
6441
|
+
# Received signal strength (dBm) of the WLAN measurement data.
|
5816
6442
|
# @return [Integer]
|
5817
6443
|
#
|
5818
6444
|
class WiFiAccessPoint < Struct.new(
|
@@ -5848,6 +6474,75 @@ module Aws::IoTWireless
|
|
5848
6474
|
include Aws::Structure
|
5849
6475
|
end
|
5850
6476
|
|
6477
|
+
# Information about an import task for wireless devices.
|
6478
|
+
#
|
6479
|
+
# @!attribute [rw] id
|
6480
|
+
# The ID of the wireless device import task.
|
6481
|
+
# @return [String]
|
6482
|
+
#
|
6483
|
+
# @!attribute [rw] arn
|
6484
|
+
# The ARN (Amazon Resource Name) of the wireless device import task.
|
6485
|
+
# @return [String]
|
6486
|
+
#
|
6487
|
+
# @!attribute [rw] destination_name
|
6488
|
+
# The name of the Sidewalk destination that that describes the IoT
|
6489
|
+
# rule to route messages from the device in the import task that will
|
6490
|
+
# be onboarded to AWS IoT Wireless
|
6491
|
+
# @return [String]
|
6492
|
+
#
|
6493
|
+
# @!attribute [rw] sidewalk
|
6494
|
+
# The Sidewalk-related information of the wireless device import task.
|
6495
|
+
# @return [Types::SidewalkGetStartImportInfo]
|
6496
|
+
#
|
6497
|
+
# @!attribute [rw] creation_time
|
6498
|
+
# The time at which the import task was created.
|
6499
|
+
# @return [Time]
|
6500
|
+
#
|
6501
|
+
# @!attribute [rw] status
|
6502
|
+
# The status information of the wireless device import task.
|
6503
|
+
# @return [String]
|
6504
|
+
#
|
6505
|
+
# @!attribute [rw] status_reason
|
6506
|
+
# The reason that provides additional information about the import
|
6507
|
+
# task status.
|
6508
|
+
# @return [String]
|
6509
|
+
#
|
6510
|
+
# @!attribute [rw] initialized_imported_device_count
|
6511
|
+
# The summary information of count of wireless devices that are
|
6512
|
+
# waiting for the control log to be added to an import task.
|
6513
|
+
# @return [Integer]
|
6514
|
+
#
|
6515
|
+
# @!attribute [rw] pending_imported_device_count
|
6516
|
+
# The summary information of count of wireless devices in an import
|
6517
|
+
# task that are waiting in the queue to be onboarded.
|
6518
|
+
# @return [Integer]
|
6519
|
+
#
|
6520
|
+
# @!attribute [rw] onboarded_imported_device_count
|
6521
|
+
# The summary information of count of wireless devices in an import
|
6522
|
+
# task that have been onboarded to the import task.
|
6523
|
+
# @return [Integer]
|
6524
|
+
#
|
6525
|
+
# @!attribute [rw] failed_imported_device_count
|
6526
|
+
# The summary information of count of wireless devices in an import
|
6527
|
+
# task that failed to onboarded to the import task.
|
6528
|
+
# @return [Integer]
|
6529
|
+
#
|
6530
|
+
class WirelessDeviceImportTask < Struct.new(
|
6531
|
+
:id,
|
6532
|
+
:arn,
|
6533
|
+
:destination_name,
|
6534
|
+
:sidewalk,
|
6535
|
+
:creation_time,
|
6536
|
+
:status,
|
6537
|
+
:status_reason,
|
6538
|
+
:initialized_imported_device_count,
|
6539
|
+
:pending_imported_device_count,
|
6540
|
+
:onboarded_imported_device_count,
|
6541
|
+
:failed_imported_device_count)
|
6542
|
+
SENSITIVE = []
|
6543
|
+
include Aws::Structure
|
6544
|
+
end
|
6545
|
+
|
5851
6546
|
# The log options for wireless devices and can be used to set log levels
|
5852
6547
|
# for a specific type of wireless device.
|
5853
6548
|
#
|