aws-sdk-iotwireless 1.15.0 → 1.19.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 +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-iotwireless/client.rb +1017 -11
- data/lib/aws-sdk-iotwireless/client_api.rb +802 -0
- data/lib/aws-sdk-iotwireless/types.rb +1572 -54
- data/lib/aws-sdk-iotwireless.rb +1 -1
- metadata +4 -4
|
@@ -27,6 +27,7 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
|
27
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
|
30
|
+
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
|
30
31
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
|
31
32
|
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
|
32
33
|
|
|
@@ -73,6 +74,7 @@ module Aws::IoTWireless
|
|
|
73
74
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
|
74
75
|
add_plugin(Aws::Plugins::TransferEncoding)
|
|
75
76
|
add_plugin(Aws::Plugins::HttpChecksum)
|
|
77
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
|
76
78
|
add_plugin(Aws::Plugins::SignatureV4)
|
|
77
79
|
add_plugin(Aws::Plugins::Protocols::RestJson)
|
|
78
80
|
|
|
@@ -119,7 +121,9 @@ module Aws::IoTWireless
|
|
|
119
121
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
|
120
122
|
# are very aggressive. Construct and pass an instance of
|
|
121
123
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
|
122
|
-
# enable retries and extended timeouts.
|
|
124
|
+
# enable retries and extended timeouts. Instance profile credential
|
|
125
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
|
126
|
+
# to true.
|
|
123
127
|
#
|
|
124
128
|
# @option options [required, String] :region
|
|
125
129
|
# The AWS region to connect to. The configured `:region` is
|
|
@@ -173,6 +177,10 @@ module Aws::IoTWireless
|
|
|
173
177
|
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
|
174
178
|
# a clock skew correction and retry requests with skewed client clocks.
|
|
175
179
|
#
|
|
180
|
+
# @option options [String] :defaults_mode ("legacy")
|
|
181
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
|
182
|
+
# accepted modes and the configuration defaults that are included.
|
|
183
|
+
#
|
|
176
184
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
|
177
185
|
# Set to true to disable SDK automatically adding host prefix
|
|
178
186
|
# to default service endpoint when available.
|
|
@@ -275,6 +283,15 @@ module Aws::IoTWireless
|
|
|
275
283
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
|
276
284
|
# requests are made, and retries are disabled.
|
|
277
285
|
#
|
|
286
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
|
287
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
|
288
|
+
# will be used if available.
|
|
289
|
+
#
|
|
290
|
+
# @option options [Boolean] :use_fips_endpoint
|
|
291
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
|
292
|
+
# When a `fips` region is used, the region is normalized and this config
|
|
293
|
+
# is set to `true`.
|
|
294
|
+
#
|
|
278
295
|
# @option options [Boolean] :validate_params (true)
|
|
279
296
|
# When `true`, request parameters are validated before
|
|
280
297
|
# sending the request.
|
|
@@ -286,7 +303,7 @@ module Aws::IoTWireless
|
|
|
286
303
|
# seconds to wait when opening a HTTP session before raising a
|
|
287
304
|
# `Timeout::Error`.
|
|
288
305
|
#
|
|
289
|
-
# @option options [
|
|
306
|
+
# @option options [Float] :http_read_timeout (60) The default
|
|
290
307
|
# number of seconds to wait for response data. This value can
|
|
291
308
|
# safely be set per-request on the session.
|
|
292
309
|
#
|
|
@@ -302,6 +319,9 @@ module Aws::IoTWireless
|
|
|
302
319
|
# disables this behaviour. This value can safely be set per
|
|
303
320
|
# request on the session.
|
|
304
321
|
#
|
|
322
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
|
323
|
+
# in seconds.
|
|
324
|
+
#
|
|
305
325
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
|
306
326
|
# HTTP debug output will be sent to the `:logger`.
|
|
307
327
|
#
|
|
@@ -379,6 +399,78 @@ module Aws::IoTWireless
|
|
|
379
399
|
req.send_request(options)
|
|
380
400
|
end
|
|
381
401
|
|
|
402
|
+
# Associate a multicast group with a FUOTA task.
|
|
403
|
+
#
|
|
404
|
+
# @option params [required, String] :id
|
|
405
|
+
# The ID of a FUOTA task.
|
|
406
|
+
#
|
|
407
|
+
# @option params [required, String] :multicast_group_id
|
|
408
|
+
# The ID of the multicast group.
|
|
409
|
+
#
|
|
410
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
411
|
+
#
|
|
412
|
+
# @example Request syntax with placeholder values
|
|
413
|
+
#
|
|
414
|
+
# resp = client.associate_multicast_group_with_fuota_task({
|
|
415
|
+
# id: "FuotaTaskId", # required
|
|
416
|
+
# multicast_group_id: "MulticastGroupId", # required
|
|
417
|
+
# })
|
|
418
|
+
#
|
|
419
|
+
# @overload associate_multicast_group_with_fuota_task(params = {})
|
|
420
|
+
# @param [Hash] params ({})
|
|
421
|
+
def associate_multicast_group_with_fuota_task(params = {}, options = {})
|
|
422
|
+
req = build_request(:associate_multicast_group_with_fuota_task, params)
|
|
423
|
+
req.send_request(options)
|
|
424
|
+
end
|
|
425
|
+
|
|
426
|
+
# Associate a wireless device with a FUOTA task.
|
|
427
|
+
#
|
|
428
|
+
# @option params [required, String] :id
|
|
429
|
+
# The ID of a FUOTA task.
|
|
430
|
+
#
|
|
431
|
+
# @option params [required, String] :wireless_device_id
|
|
432
|
+
# The ID of the wireless device.
|
|
433
|
+
#
|
|
434
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
435
|
+
#
|
|
436
|
+
# @example Request syntax with placeholder values
|
|
437
|
+
#
|
|
438
|
+
# resp = client.associate_wireless_device_with_fuota_task({
|
|
439
|
+
# id: "FuotaTaskId", # required
|
|
440
|
+
# wireless_device_id: "WirelessDeviceId", # required
|
|
441
|
+
# })
|
|
442
|
+
#
|
|
443
|
+
# @overload associate_wireless_device_with_fuota_task(params = {})
|
|
444
|
+
# @param [Hash] params ({})
|
|
445
|
+
def associate_wireless_device_with_fuota_task(params = {}, options = {})
|
|
446
|
+
req = build_request(:associate_wireless_device_with_fuota_task, params)
|
|
447
|
+
req.send_request(options)
|
|
448
|
+
end
|
|
449
|
+
|
|
450
|
+
# Associates a wireless device with a multicast group.
|
|
451
|
+
#
|
|
452
|
+
# @option params [required, String] :id
|
|
453
|
+
# The ID of the multicast group.
|
|
454
|
+
#
|
|
455
|
+
# @option params [required, String] :wireless_device_id
|
|
456
|
+
# The ID of the wireless device.
|
|
457
|
+
#
|
|
458
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
459
|
+
#
|
|
460
|
+
# @example Request syntax with placeholder values
|
|
461
|
+
#
|
|
462
|
+
# resp = client.associate_wireless_device_with_multicast_group({
|
|
463
|
+
# id: "MulticastGroupId", # required
|
|
464
|
+
# wireless_device_id: "WirelessDeviceId", # required
|
|
465
|
+
# })
|
|
466
|
+
#
|
|
467
|
+
# @overload associate_wireless_device_with_multicast_group(params = {})
|
|
468
|
+
# @param [Hash] params ({})
|
|
469
|
+
def associate_wireless_device_with_multicast_group(params = {}, options = {})
|
|
470
|
+
req = build_request(:associate_wireless_device_with_multicast_group, params)
|
|
471
|
+
req.send_request(options)
|
|
472
|
+
end
|
|
473
|
+
|
|
382
474
|
# Associates a wireless device with a thing.
|
|
383
475
|
#
|
|
384
476
|
# @option params [required, String] :id
|
|
@@ -457,6 +549,26 @@ module Aws::IoTWireless
|
|
|
457
549
|
req.send_request(options)
|
|
458
550
|
end
|
|
459
551
|
|
|
552
|
+
# Cancels an existing multicast group session.
|
|
553
|
+
#
|
|
554
|
+
# @option params [required, String] :id
|
|
555
|
+
# The ID of the multicast group.
|
|
556
|
+
#
|
|
557
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
558
|
+
#
|
|
559
|
+
# @example Request syntax with placeholder values
|
|
560
|
+
#
|
|
561
|
+
# resp = client.cancel_multicast_group_session({
|
|
562
|
+
# id: "MulticastGroupId", # required
|
|
563
|
+
# })
|
|
564
|
+
#
|
|
565
|
+
# @overload cancel_multicast_group_session(params = {})
|
|
566
|
+
# @param [Hash] params ({})
|
|
567
|
+
def cancel_multicast_group_session(params = {}, options = {})
|
|
568
|
+
req = build_request(:cancel_multicast_group_session, params)
|
|
569
|
+
req.send_request(options)
|
|
570
|
+
end
|
|
571
|
+
|
|
460
572
|
# Creates a new destination that maps a device message to an AWS IoT
|
|
461
573
|
# rule.
|
|
462
574
|
#
|
|
@@ -594,6 +706,132 @@ module Aws::IoTWireless
|
|
|
594
706
|
req.send_request(options)
|
|
595
707
|
end
|
|
596
708
|
|
|
709
|
+
# Creates a FUOTA task.
|
|
710
|
+
#
|
|
711
|
+
# @option params [String] :name
|
|
712
|
+
# The name of a FUOTA task.
|
|
713
|
+
#
|
|
714
|
+
# @option params [String] :description
|
|
715
|
+
# The description of the new resource.
|
|
716
|
+
#
|
|
717
|
+
# @option params [String] :client_request_token
|
|
718
|
+
# Each resource must have a unique client request token. If you try to
|
|
719
|
+
# create a new resource with the same token as a resource that already
|
|
720
|
+
# exists, an exception occurs. If you omit this value, AWS SDKs will
|
|
721
|
+
# automatically generate a unique client request.
|
|
722
|
+
#
|
|
723
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
724
|
+
# not need to pass this option.**
|
|
725
|
+
#
|
|
726
|
+
# @option params [Types::LoRaWANFuotaTask] :lo_ra_wan
|
|
727
|
+
# The LoRaWAN information used with a FUOTA task.
|
|
728
|
+
#
|
|
729
|
+
# @option params [required, String] :firmware_update_image
|
|
730
|
+
# The S3 URI points to a firmware update image that is to be used with a
|
|
731
|
+
# FUOTA task.
|
|
732
|
+
#
|
|
733
|
+
# @option params [required, String] :firmware_update_role
|
|
734
|
+
# The firmware update role that is to be used with a FUOTA task.
|
|
735
|
+
#
|
|
736
|
+
# @option params [Array<Types::Tag>] :tags
|
|
737
|
+
# The tag to attach to the specified resource. Tags are metadata that
|
|
738
|
+
# you can use to manage a resource.
|
|
739
|
+
#
|
|
740
|
+
# @return [Types::CreateFuotaTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
741
|
+
#
|
|
742
|
+
# * {Types::CreateFuotaTaskResponse#arn #arn} => String
|
|
743
|
+
# * {Types::CreateFuotaTaskResponse#id #id} => String
|
|
744
|
+
#
|
|
745
|
+
# @example Request syntax with placeholder values
|
|
746
|
+
#
|
|
747
|
+
# resp = client.create_fuota_task({
|
|
748
|
+
# name: "FuotaTaskName",
|
|
749
|
+
# description: "Description",
|
|
750
|
+
# client_request_token: "ClientRequestToken",
|
|
751
|
+
# lo_ra_wan: {
|
|
752
|
+
# rf_region: "EU868", # accepts EU868, US915, AU915, AS923-1
|
|
753
|
+
# },
|
|
754
|
+
# firmware_update_image: "FirmwareUpdateImage", # required
|
|
755
|
+
# firmware_update_role: "FirmwareUpdateRole", # required
|
|
756
|
+
# tags: [
|
|
757
|
+
# {
|
|
758
|
+
# key: "TagKey", # required
|
|
759
|
+
# value: "TagValue", # required
|
|
760
|
+
# },
|
|
761
|
+
# ],
|
|
762
|
+
# })
|
|
763
|
+
#
|
|
764
|
+
# @example Response structure
|
|
765
|
+
#
|
|
766
|
+
# resp.arn #=> String
|
|
767
|
+
# resp.id #=> String
|
|
768
|
+
#
|
|
769
|
+
# @overload create_fuota_task(params = {})
|
|
770
|
+
# @param [Hash] params ({})
|
|
771
|
+
def create_fuota_task(params = {}, options = {})
|
|
772
|
+
req = build_request(:create_fuota_task, params)
|
|
773
|
+
req.send_request(options)
|
|
774
|
+
end
|
|
775
|
+
|
|
776
|
+
# Creates a multicast group.
|
|
777
|
+
#
|
|
778
|
+
# @option params [String] :name
|
|
779
|
+
# The name of the multicast group.
|
|
780
|
+
#
|
|
781
|
+
# @option params [String] :description
|
|
782
|
+
# The description of the multicast group.
|
|
783
|
+
#
|
|
784
|
+
# @option params [String] :client_request_token
|
|
785
|
+
# Each resource must have a unique client request token. If you try to
|
|
786
|
+
# create a new resource with the same token as a resource that already
|
|
787
|
+
# exists, an exception occurs. If you omit this value, AWS SDKs will
|
|
788
|
+
# automatically generate a unique client request.
|
|
789
|
+
#
|
|
790
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
791
|
+
# not need to pass this option.**
|
|
792
|
+
#
|
|
793
|
+
# @option params [required, Types::LoRaWANMulticast] :lo_ra_wan
|
|
794
|
+
# The LoRaWAN information that is to be used with the multicast group.
|
|
795
|
+
#
|
|
796
|
+
# @option params [Array<Types::Tag>] :tags
|
|
797
|
+
# The tag to attach to the specified resource. Tags are metadata that
|
|
798
|
+
# you can use to manage a resource.
|
|
799
|
+
#
|
|
800
|
+
# @return [Types::CreateMulticastGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
801
|
+
#
|
|
802
|
+
# * {Types::CreateMulticastGroupResponse#arn #arn} => String
|
|
803
|
+
# * {Types::CreateMulticastGroupResponse#id #id} => String
|
|
804
|
+
#
|
|
805
|
+
# @example Request syntax with placeholder values
|
|
806
|
+
#
|
|
807
|
+
# resp = client.create_multicast_group({
|
|
808
|
+
# name: "MulticastGroupName",
|
|
809
|
+
# description: "Description",
|
|
810
|
+
# client_request_token: "ClientRequestToken",
|
|
811
|
+
# lo_ra_wan: { # required
|
|
812
|
+
# rf_region: "EU868", # accepts EU868, US915, AU915, AS923-1
|
|
813
|
+
# dl_class: "ClassB", # accepts ClassB, ClassC
|
|
814
|
+
# },
|
|
815
|
+
# tags: [
|
|
816
|
+
# {
|
|
817
|
+
# key: "TagKey", # required
|
|
818
|
+
# value: "TagValue", # required
|
|
819
|
+
# },
|
|
820
|
+
# ],
|
|
821
|
+
# })
|
|
822
|
+
#
|
|
823
|
+
# @example Response structure
|
|
824
|
+
#
|
|
825
|
+
# resp.arn #=> String
|
|
826
|
+
# resp.id #=> String
|
|
827
|
+
#
|
|
828
|
+
# @overload create_multicast_group(params = {})
|
|
829
|
+
# @param [Hash] params ({})
|
|
830
|
+
def create_multicast_group(params = {}, options = {})
|
|
831
|
+
req = build_request(:create_multicast_group, params)
|
|
832
|
+
req.send_request(options)
|
|
833
|
+
end
|
|
834
|
+
|
|
597
835
|
# Creates a new service profile.
|
|
598
836
|
#
|
|
599
837
|
# @option params [String] :name
|
|
@@ -704,6 +942,7 @@ module Aws::IoTWireless
|
|
|
704
942
|
# otaa_v1_0_x: {
|
|
705
943
|
# app_key: "AppKey",
|
|
706
944
|
# app_eui: "AppEui",
|
|
945
|
+
# gen_app_key: "GenAppKey",
|
|
707
946
|
# },
|
|
708
947
|
# abp_v1_1: {
|
|
709
948
|
# dev_addr: "DevAddr",
|
|
@@ -721,6 +960,11 @@ module Aws::IoTWireless
|
|
|
721
960
|
# app_s_key: "AppSKey",
|
|
722
961
|
# },
|
|
723
962
|
# },
|
|
963
|
+
# f_ports: {
|
|
964
|
+
# fuota: 1,
|
|
965
|
+
# multicast: 1,
|
|
966
|
+
# clock_sync: 1,
|
|
967
|
+
# },
|
|
724
968
|
# },
|
|
725
969
|
# tags: [
|
|
726
970
|
# {
|
|
@@ -954,6 +1198,46 @@ module Aws::IoTWireless
|
|
|
954
1198
|
req.send_request(options)
|
|
955
1199
|
end
|
|
956
1200
|
|
|
1201
|
+
# Deletes a FUOTA task.
|
|
1202
|
+
#
|
|
1203
|
+
# @option params [required, String] :id
|
|
1204
|
+
# The ID of a FUOTA task.
|
|
1205
|
+
#
|
|
1206
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
1207
|
+
#
|
|
1208
|
+
# @example Request syntax with placeholder values
|
|
1209
|
+
#
|
|
1210
|
+
# resp = client.delete_fuota_task({
|
|
1211
|
+
# id: "FuotaTaskId", # required
|
|
1212
|
+
# })
|
|
1213
|
+
#
|
|
1214
|
+
# @overload delete_fuota_task(params = {})
|
|
1215
|
+
# @param [Hash] params ({})
|
|
1216
|
+
def delete_fuota_task(params = {}, options = {})
|
|
1217
|
+
req = build_request(:delete_fuota_task, params)
|
|
1218
|
+
req.send_request(options)
|
|
1219
|
+
end
|
|
1220
|
+
|
|
1221
|
+
# Deletes a multicast group if it is not in use by a fuota task.
|
|
1222
|
+
#
|
|
1223
|
+
# @option params [required, String] :id
|
|
1224
|
+
# The ID of the multicast group.
|
|
1225
|
+
#
|
|
1226
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
1227
|
+
#
|
|
1228
|
+
# @example Request syntax with placeholder values
|
|
1229
|
+
#
|
|
1230
|
+
# resp = client.delete_multicast_group({
|
|
1231
|
+
# id: "MulticastGroupId", # required
|
|
1232
|
+
# })
|
|
1233
|
+
#
|
|
1234
|
+
# @overload delete_multicast_group(params = {})
|
|
1235
|
+
# @param [Hash] params ({})
|
|
1236
|
+
def delete_multicast_group(params = {}, options = {})
|
|
1237
|
+
req = build_request(:delete_multicast_group, params)
|
|
1238
|
+
req.send_request(options)
|
|
1239
|
+
end
|
|
1240
|
+
|
|
957
1241
|
# Deletes a service profile.
|
|
958
1242
|
#
|
|
959
1243
|
# @option params [required, String] :id
|
|
@@ -1081,6 +1365,78 @@ module Aws::IoTWireless
|
|
|
1081
1365
|
req.send_request(options)
|
|
1082
1366
|
end
|
|
1083
1367
|
|
|
1368
|
+
# Disassociates a multicast group from a fuota task.
|
|
1369
|
+
#
|
|
1370
|
+
# @option params [required, String] :id
|
|
1371
|
+
# The ID of a FUOTA task.
|
|
1372
|
+
#
|
|
1373
|
+
# @option params [required, String] :multicast_group_id
|
|
1374
|
+
# The ID of the multicast group.
|
|
1375
|
+
#
|
|
1376
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
1377
|
+
#
|
|
1378
|
+
# @example Request syntax with placeholder values
|
|
1379
|
+
#
|
|
1380
|
+
# resp = client.disassociate_multicast_group_from_fuota_task({
|
|
1381
|
+
# id: "FuotaTaskId", # required
|
|
1382
|
+
# multicast_group_id: "MulticastGroupId", # required
|
|
1383
|
+
# })
|
|
1384
|
+
#
|
|
1385
|
+
# @overload disassociate_multicast_group_from_fuota_task(params = {})
|
|
1386
|
+
# @param [Hash] params ({})
|
|
1387
|
+
def disassociate_multicast_group_from_fuota_task(params = {}, options = {})
|
|
1388
|
+
req = build_request(:disassociate_multicast_group_from_fuota_task, params)
|
|
1389
|
+
req.send_request(options)
|
|
1390
|
+
end
|
|
1391
|
+
|
|
1392
|
+
# Disassociates a wireless device from a FUOTA task.
|
|
1393
|
+
#
|
|
1394
|
+
# @option params [required, String] :id
|
|
1395
|
+
# The ID of a FUOTA task.
|
|
1396
|
+
#
|
|
1397
|
+
# @option params [required, String] :wireless_device_id
|
|
1398
|
+
# The ID of the wireless device.
|
|
1399
|
+
#
|
|
1400
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
1401
|
+
#
|
|
1402
|
+
# @example Request syntax with placeholder values
|
|
1403
|
+
#
|
|
1404
|
+
# resp = client.disassociate_wireless_device_from_fuota_task({
|
|
1405
|
+
# id: "FuotaTaskId", # required
|
|
1406
|
+
# wireless_device_id: "WirelessDeviceId", # required
|
|
1407
|
+
# })
|
|
1408
|
+
#
|
|
1409
|
+
# @overload disassociate_wireless_device_from_fuota_task(params = {})
|
|
1410
|
+
# @param [Hash] params ({})
|
|
1411
|
+
def disassociate_wireless_device_from_fuota_task(params = {}, options = {})
|
|
1412
|
+
req = build_request(:disassociate_wireless_device_from_fuota_task, params)
|
|
1413
|
+
req.send_request(options)
|
|
1414
|
+
end
|
|
1415
|
+
|
|
1416
|
+
# Disassociates a wireless device from a multicast group.
|
|
1417
|
+
#
|
|
1418
|
+
# @option params [required, String] :id
|
|
1419
|
+
# The ID of the multicast group.
|
|
1420
|
+
#
|
|
1421
|
+
# @option params [required, String] :wireless_device_id
|
|
1422
|
+
# The ID of the wireless device.
|
|
1423
|
+
#
|
|
1424
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
1425
|
+
#
|
|
1426
|
+
# @example Request syntax with placeholder values
|
|
1427
|
+
#
|
|
1428
|
+
# resp = client.disassociate_wireless_device_from_multicast_group({
|
|
1429
|
+
# id: "MulticastGroupId", # required
|
|
1430
|
+
# wireless_device_id: "WirelessDeviceId", # required
|
|
1431
|
+
# })
|
|
1432
|
+
#
|
|
1433
|
+
# @overload disassociate_wireless_device_from_multicast_group(params = {})
|
|
1434
|
+
# @param [Hash] params ({})
|
|
1435
|
+
def disassociate_wireless_device_from_multicast_group(params = {}, options = {})
|
|
1436
|
+
req = build_request(:disassociate_wireless_device_from_multicast_group, params)
|
|
1437
|
+
req.send_request(options)
|
|
1438
|
+
end
|
|
1439
|
+
|
|
1084
1440
|
# Disassociates a wireless device from its currently associated thing.
|
|
1085
1441
|
#
|
|
1086
1442
|
# @option params [required, String] :id
|
|
@@ -1229,6 +1585,49 @@ module Aws::IoTWireless
|
|
|
1229
1585
|
req.send_request(options)
|
|
1230
1586
|
end
|
|
1231
1587
|
|
|
1588
|
+
# Gets information about a FUOTA task.
|
|
1589
|
+
#
|
|
1590
|
+
# @option params [required, String] :id
|
|
1591
|
+
# The ID of a FUOTA task.
|
|
1592
|
+
#
|
|
1593
|
+
# @return [Types::GetFuotaTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1594
|
+
#
|
|
1595
|
+
# * {Types::GetFuotaTaskResponse#arn #arn} => String
|
|
1596
|
+
# * {Types::GetFuotaTaskResponse#id #id} => String
|
|
1597
|
+
# * {Types::GetFuotaTaskResponse#status #status} => String
|
|
1598
|
+
# * {Types::GetFuotaTaskResponse#name #name} => String
|
|
1599
|
+
# * {Types::GetFuotaTaskResponse#description #description} => String
|
|
1600
|
+
# * {Types::GetFuotaTaskResponse#lo_ra_wan #lo_ra_wan} => Types::LoRaWANFuotaTaskGetInfo
|
|
1601
|
+
# * {Types::GetFuotaTaskResponse#firmware_update_image #firmware_update_image} => String
|
|
1602
|
+
# * {Types::GetFuotaTaskResponse#firmware_update_role #firmware_update_role} => String
|
|
1603
|
+
# * {Types::GetFuotaTaskResponse#created_at #created_at} => Time
|
|
1604
|
+
#
|
|
1605
|
+
# @example Request syntax with placeholder values
|
|
1606
|
+
#
|
|
1607
|
+
# resp = client.get_fuota_task({
|
|
1608
|
+
# id: "FuotaTaskId", # required
|
|
1609
|
+
# })
|
|
1610
|
+
#
|
|
1611
|
+
# @example Response structure
|
|
1612
|
+
#
|
|
1613
|
+
# resp.arn #=> String
|
|
1614
|
+
# resp.id #=> String
|
|
1615
|
+
# resp.status #=> String, one of "Pending", "FuotaSession_Waiting", "In_FuotaSession", "FuotaDone", "Delete_Waiting"
|
|
1616
|
+
# resp.name #=> String
|
|
1617
|
+
# resp.description #=> String
|
|
1618
|
+
# resp.lo_ra_wan.rf_region #=> String
|
|
1619
|
+
# resp.lo_ra_wan.start_time #=> Time
|
|
1620
|
+
# resp.firmware_update_image #=> String
|
|
1621
|
+
# resp.firmware_update_role #=> String
|
|
1622
|
+
# resp.created_at #=> Time
|
|
1623
|
+
#
|
|
1624
|
+
# @overload get_fuota_task(params = {})
|
|
1625
|
+
# @param [Hash] params ({})
|
|
1626
|
+
def get_fuota_task(params = {}, options = {})
|
|
1627
|
+
req = build_request(:get_fuota_task, params)
|
|
1628
|
+
req.send_request(options)
|
|
1629
|
+
end
|
|
1630
|
+
|
|
1232
1631
|
# Returns current default log levels or log levels by resource types.
|
|
1233
1632
|
# Based on resource types, log levels can be for wireless device log
|
|
1234
1633
|
# options or wireless gateway log options.
|
|
@@ -1262,18 +1661,121 @@ module Aws::IoTWireless
|
|
|
1262
1661
|
req.send_request(options)
|
|
1263
1662
|
end
|
|
1264
1663
|
|
|
1265
|
-
# Gets information about a
|
|
1266
|
-
# `PartnerType` are `null`, returns all partner accounts.
|
|
1664
|
+
# Gets information about a multicast group.
|
|
1267
1665
|
#
|
|
1268
|
-
# @option params [required, String] :
|
|
1269
|
-
# The
|
|
1666
|
+
# @option params [required, String] :id
|
|
1667
|
+
# The ID of the multicast group.
|
|
1270
1668
|
#
|
|
1271
|
-
# @
|
|
1272
|
-
# The partner type.
|
|
1669
|
+
# @return [Types::GetMulticastGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1273
1670
|
#
|
|
1274
|
-
#
|
|
1671
|
+
# * {Types::GetMulticastGroupResponse#arn #arn} => String
|
|
1672
|
+
# * {Types::GetMulticastGroupResponse#id #id} => String
|
|
1673
|
+
# * {Types::GetMulticastGroupResponse#name #name} => String
|
|
1674
|
+
# * {Types::GetMulticastGroupResponse#description #description} => String
|
|
1675
|
+
# * {Types::GetMulticastGroupResponse#status #status} => String
|
|
1676
|
+
# * {Types::GetMulticastGroupResponse#lo_ra_wan #lo_ra_wan} => Types::LoRaWANMulticastGet
|
|
1677
|
+
# * {Types::GetMulticastGroupResponse#created_at #created_at} => Time
|
|
1275
1678
|
#
|
|
1276
|
-
#
|
|
1679
|
+
# @example Request syntax with placeholder values
|
|
1680
|
+
#
|
|
1681
|
+
# resp = client.get_multicast_group({
|
|
1682
|
+
# id: "MulticastGroupId", # required
|
|
1683
|
+
# })
|
|
1684
|
+
#
|
|
1685
|
+
# @example Response structure
|
|
1686
|
+
#
|
|
1687
|
+
# resp.arn #=> String
|
|
1688
|
+
# resp.id #=> String
|
|
1689
|
+
# resp.name #=> String
|
|
1690
|
+
# resp.description #=> String
|
|
1691
|
+
# resp.status #=> String
|
|
1692
|
+
# resp.lo_ra_wan.rf_region #=> String, one of "EU868", "US915", "AU915", "AS923-1"
|
|
1693
|
+
# resp.lo_ra_wan.dl_class #=> String, one of "ClassB", "ClassC"
|
|
1694
|
+
# resp.lo_ra_wan.number_of_devices_requested #=> Integer
|
|
1695
|
+
# resp.lo_ra_wan.number_of_devices_in_group #=> Integer
|
|
1696
|
+
# resp.created_at #=> Time
|
|
1697
|
+
#
|
|
1698
|
+
# @overload get_multicast_group(params = {})
|
|
1699
|
+
# @param [Hash] params ({})
|
|
1700
|
+
def get_multicast_group(params = {}, options = {})
|
|
1701
|
+
req = build_request(:get_multicast_group, params)
|
|
1702
|
+
req.send_request(options)
|
|
1703
|
+
end
|
|
1704
|
+
|
|
1705
|
+
# Gets information about a multicast group session.
|
|
1706
|
+
#
|
|
1707
|
+
# @option params [required, String] :id
|
|
1708
|
+
# The ID of the multicast group.
|
|
1709
|
+
#
|
|
1710
|
+
# @return [Types::GetMulticastGroupSessionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1711
|
+
#
|
|
1712
|
+
# * {Types::GetMulticastGroupSessionResponse#lo_ra_wan #lo_ra_wan} => Types::LoRaWANMulticastSession
|
|
1713
|
+
#
|
|
1714
|
+
# @example Request syntax with placeholder values
|
|
1715
|
+
#
|
|
1716
|
+
# resp = client.get_multicast_group_session({
|
|
1717
|
+
# id: "MulticastGroupId", # required
|
|
1718
|
+
# })
|
|
1719
|
+
#
|
|
1720
|
+
# @example Response structure
|
|
1721
|
+
#
|
|
1722
|
+
# resp.lo_ra_wan.dl_dr #=> Integer
|
|
1723
|
+
# resp.lo_ra_wan.dl_freq #=> Integer
|
|
1724
|
+
# resp.lo_ra_wan.session_start_time #=> Time
|
|
1725
|
+
# resp.lo_ra_wan.session_timeout #=> Integer
|
|
1726
|
+
#
|
|
1727
|
+
# @overload get_multicast_group_session(params = {})
|
|
1728
|
+
# @param [Hash] params ({})
|
|
1729
|
+
def get_multicast_group_session(params = {}, options = {})
|
|
1730
|
+
req = build_request(:get_multicast_group_session, params)
|
|
1731
|
+
req.send_request(options)
|
|
1732
|
+
end
|
|
1733
|
+
|
|
1734
|
+
# Get NetworkAnalyzer configuration.
|
|
1735
|
+
#
|
|
1736
|
+
# @option params [required, String] :configuration_name
|
|
1737
|
+
# NetworkAnalyzer configuration name.
|
|
1738
|
+
#
|
|
1739
|
+
# @return [Types::GetNetworkAnalyzerConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1740
|
+
#
|
|
1741
|
+
# * {Types::GetNetworkAnalyzerConfigurationResponse#trace_content #trace_content} => Types::TraceContent
|
|
1742
|
+
# * {Types::GetNetworkAnalyzerConfigurationResponse#wireless_devices #wireless_devices} => Array<String>
|
|
1743
|
+
# * {Types::GetNetworkAnalyzerConfigurationResponse#wireless_gateways #wireless_gateways} => Array<String>
|
|
1744
|
+
#
|
|
1745
|
+
# @example Request syntax with placeholder values
|
|
1746
|
+
#
|
|
1747
|
+
# resp = client.get_network_analyzer_configuration({
|
|
1748
|
+
# configuration_name: "NetworkAnalyzerConfigurationName", # required
|
|
1749
|
+
# })
|
|
1750
|
+
#
|
|
1751
|
+
# @example Response structure
|
|
1752
|
+
#
|
|
1753
|
+
# resp.trace_content.wireless_device_frame_info #=> String, one of "ENABLED", "DISABLED"
|
|
1754
|
+
# resp.trace_content.log_level #=> String, one of "INFO", "ERROR", "DISABLED"
|
|
1755
|
+
# resp.wireless_devices #=> Array
|
|
1756
|
+
# resp.wireless_devices[0] #=> String
|
|
1757
|
+
# resp.wireless_gateways #=> Array
|
|
1758
|
+
# resp.wireless_gateways[0] #=> String
|
|
1759
|
+
#
|
|
1760
|
+
# @overload get_network_analyzer_configuration(params = {})
|
|
1761
|
+
# @param [Hash] params ({})
|
|
1762
|
+
def get_network_analyzer_configuration(params = {}, options = {})
|
|
1763
|
+
req = build_request(:get_network_analyzer_configuration, params)
|
|
1764
|
+
req.send_request(options)
|
|
1765
|
+
end
|
|
1766
|
+
|
|
1767
|
+
# Gets information about a partner account. If `PartnerAccountId` and
|
|
1768
|
+
# `PartnerType` are `null`, returns all partner accounts.
|
|
1769
|
+
#
|
|
1770
|
+
# @option params [required, String] :partner_account_id
|
|
1771
|
+
# The partner account ID to disassociate from the AWS account.
|
|
1772
|
+
#
|
|
1773
|
+
# @option params [required, String] :partner_type
|
|
1774
|
+
# The partner type.
|
|
1775
|
+
#
|
|
1776
|
+
# @return [Types::GetPartnerAccountResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1777
|
+
#
|
|
1778
|
+
# * {Types::GetPartnerAccountResponse#sidewalk #sidewalk} => Types::SidewalkAccountInfoWithFingerprint
|
|
1277
1779
|
# * {Types::GetPartnerAccountResponse#account_linked #account_linked} => Boolean
|
|
1278
1780
|
#
|
|
1279
1781
|
# @example Request syntax with placeholder values
|
|
@@ -1297,6 +1799,44 @@ module Aws::IoTWireless
|
|
|
1297
1799
|
req.send_request(options)
|
|
1298
1800
|
end
|
|
1299
1801
|
|
|
1802
|
+
# Get the event configuration for a particular resource identifier.
|
|
1803
|
+
#
|
|
1804
|
+
# @option params [required, String] :identifier
|
|
1805
|
+
# Resource identifier to opt in for event messaging.
|
|
1806
|
+
#
|
|
1807
|
+
# @option params [required, String] :identifier_type
|
|
1808
|
+
# Identifier type of the particular resource identifier for event
|
|
1809
|
+
# configuration.
|
|
1810
|
+
#
|
|
1811
|
+
# @option params [String] :partner_type
|
|
1812
|
+
# Partner type of the resource if the identifier type is
|
|
1813
|
+
# PartnerAccountId.
|
|
1814
|
+
#
|
|
1815
|
+
# @return [Types::GetResourceEventConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1816
|
+
#
|
|
1817
|
+
# * {Types::GetResourceEventConfigurationResponse#device_registration_state #device_registration_state} => Types::DeviceRegistrationStateEventConfiguration
|
|
1818
|
+
# * {Types::GetResourceEventConfigurationResponse#proximity #proximity} => Types::ProximityEventConfiguration
|
|
1819
|
+
#
|
|
1820
|
+
# @example Request syntax with placeholder values
|
|
1821
|
+
#
|
|
1822
|
+
# resp = client.get_resource_event_configuration({
|
|
1823
|
+
# identifier: "Identifier", # required
|
|
1824
|
+
# identifier_type: "PartnerAccountId", # required, accepts PartnerAccountId
|
|
1825
|
+
# partner_type: "Sidewalk", # accepts Sidewalk
|
|
1826
|
+
# })
|
|
1827
|
+
#
|
|
1828
|
+
# @example Response structure
|
|
1829
|
+
#
|
|
1830
|
+
# resp.device_registration_state.sidewalk.amazon_id_event_topic #=> String, one of "Enabled", "Disabled"
|
|
1831
|
+
# resp.proximity.sidewalk.amazon_id_event_topic #=> String, one of "Enabled", "Disabled"
|
|
1832
|
+
#
|
|
1833
|
+
# @overload get_resource_event_configuration(params = {})
|
|
1834
|
+
# @param [Hash] params ({})
|
|
1835
|
+
def get_resource_event_configuration(params = {}, options = {})
|
|
1836
|
+
req = build_request(:get_resource_event_configuration, params)
|
|
1837
|
+
req.send_request(options)
|
|
1838
|
+
end
|
|
1839
|
+
|
|
1300
1840
|
# Fetches the log-level override, if any, for a given resource-ID and
|
|
1301
1841
|
# resource-type. It can be used for a wireless device or a wireless
|
|
1302
1842
|
# gateway.
|
|
@@ -1461,6 +2001,7 @@ module Aws::IoTWireless
|
|
|
1461
2001
|
# resp.lo_ra_wan.otaa_v1_1.join_eui #=> String
|
|
1462
2002
|
# resp.lo_ra_wan.otaa_v1_0_x.app_key #=> String
|
|
1463
2003
|
# resp.lo_ra_wan.otaa_v1_0_x.app_eui #=> String
|
|
2004
|
+
# resp.lo_ra_wan.otaa_v1_0_x.gen_app_key #=> String
|
|
1464
2005
|
# resp.lo_ra_wan.abp_v1_1.dev_addr #=> String
|
|
1465
2006
|
# resp.lo_ra_wan.abp_v1_1.session_keys.f_nwk_s_int_key #=> String
|
|
1466
2007
|
# resp.lo_ra_wan.abp_v1_1.session_keys.s_nwk_s_int_key #=> String
|
|
@@ -1469,6 +2010,9 @@ module Aws::IoTWireless
|
|
|
1469
2010
|
# resp.lo_ra_wan.abp_v1_0_x.dev_addr #=> String
|
|
1470
2011
|
# resp.lo_ra_wan.abp_v1_0_x.session_keys.nwk_s_key #=> String
|
|
1471
2012
|
# resp.lo_ra_wan.abp_v1_0_x.session_keys.app_s_key #=> String
|
|
2013
|
+
# resp.lo_ra_wan.f_ports.fuota #=> Integer
|
|
2014
|
+
# resp.lo_ra_wan.f_ports.multicast #=> Integer
|
|
2015
|
+
# resp.lo_ra_wan.f_ports.clock_sync #=> Integer
|
|
1472
2016
|
# resp.sidewalk.amazon_id #=> String
|
|
1473
2017
|
# resp.sidewalk.sidewalk_id #=> String
|
|
1474
2018
|
# resp.sidewalk.sidewalk_manufacturing_sn #=> String
|
|
@@ -1820,6 +2364,125 @@ module Aws::IoTWireless
|
|
|
1820
2364
|
req.send_request(options)
|
|
1821
2365
|
end
|
|
1822
2366
|
|
|
2367
|
+
# Lists the FUOTA tasks registered to your AWS account.
|
|
2368
|
+
#
|
|
2369
|
+
# @option params [String] :next_token
|
|
2370
|
+
# To retrieve the next set of results, the `nextToken` value from a
|
|
2371
|
+
# previous response; otherwise **null** to receive the first set of
|
|
2372
|
+
# results.
|
|
2373
|
+
#
|
|
2374
|
+
# @option params [Integer] :max_results
|
|
2375
|
+
# The maximum number of results to return in this operation.
|
|
2376
|
+
#
|
|
2377
|
+
# @return [Types::ListFuotaTasksResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2378
|
+
#
|
|
2379
|
+
# * {Types::ListFuotaTasksResponse#next_token #next_token} => String
|
|
2380
|
+
# * {Types::ListFuotaTasksResponse#fuota_task_list #fuota_task_list} => Array<Types::FuotaTask>
|
|
2381
|
+
#
|
|
2382
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
2383
|
+
#
|
|
2384
|
+
# @example Request syntax with placeholder values
|
|
2385
|
+
#
|
|
2386
|
+
# resp = client.list_fuota_tasks({
|
|
2387
|
+
# next_token: "NextToken",
|
|
2388
|
+
# max_results: 1,
|
|
2389
|
+
# })
|
|
2390
|
+
#
|
|
2391
|
+
# @example Response structure
|
|
2392
|
+
#
|
|
2393
|
+
# resp.next_token #=> String
|
|
2394
|
+
# resp.fuota_task_list #=> Array
|
|
2395
|
+
# resp.fuota_task_list[0].id #=> String
|
|
2396
|
+
# resp.fuota_task_list[0].arn #=> String
|
|
2397
|
+
# resp.fuota_task_list[0].name #=> String
|
|
2398
|
+
#
|
|
2399
|
+
# @overload list_fuota_tasks(params = {})
|
|
2400
|
+
# @param [Hash] params ({})
|
|
2401
|
+
def list_fuota_tasks(params = {}, options = {})
|
|
2402
|
+
req = build_request(:list_fuota_tasks, params)
|
|
2403
|
+
req.send_request(options)
|
|
2404
|
+
end
|
|
2405
|
+
|
|
2406
|
+
# Lists the multicast groups registered to your AWS account.
|
|
2407
|
+
#
|
|
2408
|
+
# @option params [String] :next_token
|
|
2409
|
+
# To retrieve the next set of results, the `nextToken` value from a
|
|
2410
|
+
# previous response; otherwise **null** to receive the first set of
|
|
2411
|
+
# results.
|
|
2412
|
+
#
|
|
2413
|
+
# @option params [Integer] :max_results
|
|
2414
|
+
# The maximum number of results to return in this operation.
|
|
2415
|
+
#
|
|
2416
|
+
# @return [Types::ListMulticastGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2417
|
+
#
|
|
2418
|
+
# * {Types::ListMulticastGroupsResponse#next_token #next_token} => String
|
|
2419
|
+
# * {Types::ListMulticastGroupsResponse#multicast_group_list #multicast_group_list} => Array<Types::MulticastGroup>
|
|
2420
|
+
#
|
|
2421
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
2422
|
+
#
|
|
2423
|
+
# @example Request syntax with placeholder values
|
|
2424
|
+
#
|
|
2425
|
+
# resp = client.list_multicast_groups({
|
|
2426
|
+
# next_token: "NextToken",
|
|
2427
|
+
# max_results: 1,
|
|
2428
|
+
# })
|
|
2429
|
+
#
|
|
2430
|
+
# @example Response structure
|
|
2431
|
+
#
|
|
2432
|
+
# resp.next_token #=> String
|
|
2433
|
+
# resp.multicast_group_list #=> Array
|
|
2434
|
+
# resp.multicast_group_list[0].id #=> String
|
|
2435
|
+
# resp.multicast_group_list[0].arn #=> String
|
|
2436
|
+
# resp.multicast_group_list[0].name #=> String
|
|
2437
|
+
#
|
|
2438
|
+
# @overload list_multicast_groups(params = {})
|
|
2439
|
+
# @param [Hash] params ({})
|
|
2440
|
+
def list_multicast_groups(params = {}, options = {})
|
|
2441
|
+
req = build_request(:list_multicast_groups, params)
|
|
2442
|
+
req.send_request(options)
|
|
2443
|
+
end
|
|
2444
|
+
|
|
2445
|
+
# List all multicast groups associated with a fuota task.
|
|
2446
|
+
#
|
|
2447
|
+
# @option params [required, String] :id
|
|
2448
|
+
# The ID of a FUOTA task.
|
|
2449
|
+
#
|
|
2450
|
+
# @option params [String] :next_token
|
|
2451
|
+
# To retrieve the next set of results, the `nextToken` value from a
|
|
2452
|
+
# previous response; otherwise **null** to receive the first set of
|
|
2453
|
+
# results.
|
|
2454
|
+
#
|
|
2455
|
+
# @option params [Integer] :max_results
|
|
2456
|
+
# The maximum number of results to return in this operation.
|
|
2457
|
+
#
|
|
2458
|
+
# @return [Types::ListMulticastGroupsByFuotaTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2459
|
+
#
|
|
2460
|
+
# * {Types::ListMulticastGroupsByFuotaTaskResponse#next_token #next_token} => String
|
|
2461
|
+
# * {Types::ListMulticastGroupsByFuotaTaskResponse#multicast_group_list #multicast_group_list} => Array<Types::MulticastGroupByFuotaTask>
|
|
2462
|
+
#
|
|
2463
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
2464
|
+
#
|
|
2465
|
+
# @example Request syntax with placeholder values
|
|
2466
|
+
#
|
|
2467
|
+
# resp = client.list_multicast_groups_by_fuota_task({
|
|
2468
|
+
# id: "FuotaTaskId", # required
|
|
2469
|
+
# next_token: "NextToken",
|
|
2470
|
+
# max_results: 1,
|
|
2471
|
+
# })
|
|
2472
|
+
#
|
|
2473
|
+
# @example Response structure
|
|
2474
|
+
#
|
|
2475
|
+
# resp.next_token #=> String
|
|
2476
|
+
# resp.multicast_group_list #=> Array
|
|
2477
|
+
# resp.multicast_group_list[0].id #=> String
|
|
2478
|
+
#
|
|
2479
|
+
# @overload list_multicast_groups_by_fuota_task(params = {})
|
|
2480
|
+
# @param [Hash] params ({})
|
|
2481
|
+
def list_multicast_groups_by_fuota_task(params = {}, options = {})
|
|
2482
|
+
req = build_request(:list_multicast_groups_by_fuota_task, params)
|
|
2483
|
+
req.send_request(options)
|
|
2484
|
+
end
|
|
2485
|
+
|
|
1823
2486
|
# Lists the partner accounts associated with your AWS account.
|
|
1824
2487
|
#
|
|
1825
2488
|
# @option params [String] :next_token
|
|
@@ -1949,6 +2612,12 @@ module Aws::IoTWireless
|
|
|
1949
2612
|
# A filter to list only the wireless devices that use this wireless
|
|
1950
2613
|
# device type.
|
|
1951
2614
|
#
|
|
2615
|
+
# @option params [String] :fuota_task_id
|
|
2616
|
+
# The ID of a FUOTA task.
|
|
2617
|
+
#
|
|
2618
|
+
# @option params [String] :multicast_group_id
|
|
2619
|
+
# The ID of the multicast group.
|
|
2620
|
+
#
|
|
1952
2621
|
# @return [Types::ListWirelessDevicesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1953
2622
|
#
|
|
1954
2623
|
# * {Types::ListWirelessDevicesResponse#next_token #next_token} => String
|
|
@@ -1965,6 +2634,8 @@ module Aws::IoTWireless
|
|
|
1965
2634
|
# device_profile_id: "DeviceProfileId",
|
|
1966
2635
|
# service_profile_id: "ServiceProfileId",
|
|
1967
2636
|
# wireless_device_type: "Sidewalk", # accepts Sidewalk, LoRaWAN
|
|
2637
|
+
# fuota_task_id: "FuotaTaskId",
|
|
2638
|
+
# multicast_group_id: "MulticastGroupId",
|
|
1968
2639
|
# })
|
|
1969
2640
|
#
|
|
1970
2641
|
# @example Response structure
|
|
@@ -1984,6 +2655,9 @@ module Aws::IoTWireless
|
|
|
1984
2655
|
# resp.wireless_device_list[0].sidewalk.device_certificates #=> Array
|
|
1985
2656
|
# resp.wireless_device_list[0].sidewalk.device_certificates[0].signing_alg #=> String, one of "Ed25519", "P256r1"
|
|
1986
2657
|
# resp.wireless_device_list[0].sidewalk.device_certificates[0].value #=> String
|
|
2658
|
+
# 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"
|
|
2659
|
+
# resp.wireless_device_list[0].multicast_device_status #=> String
|
|
2660
|
+
# resp.wireless_device_list[0].mc_group_id #=> Integer
|
|
1987
2661
|
#
|
|
1988
2662
|
# @overload list_wireless_devices(params = {})
|
|
1989
2663
|
# @param [Hash] params ({})
|
|
@@ -2164,6 +2838,44 @@ module Aws::IoTWireless
|
|
|
2164
2838
|
req.send_request(options)
|
|
2165
2839
|
end
|
|
2166
2840
|
|
|
2841
|
+
# Sends the specified data to a multicast group.
|
|
2842
|
+
#
|
|
2843
|
+
# @option params [required, String] :id
|
|
2844
|
+
# The ID of the multicast group.
|
|
2845
|
+
#
|
|
2846
|
+
# @option params [required, String] :payload_data
|
|
2847
|
+
# The binary to be sent to the end device, encoded in base64.
|
|
2848
|
+
#
|
|
2849
|
+
# @option params [required, Types::MulticastWirelessMetadata] :wireless_metadata
|
|
2850
|
+
# Wireless metadata that is to be sent to multicast group.
|
|
2851
|
+
#
|
|
2852
|
+
# @return [Types::SendDataToMulticastGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2853
|
+
#
|
|
2854
|
+
# * {Types::SendDataToMulticastGroupResponse#message_id #message_id} => String
|
|
2855
|
+
#
|
|
2856
|
+
# @example Request syntax with placeholder values
|
|
2857
|
+
#
|
|
2858
|
+
# resp = client.send_data_to_multicast_group({
|
|
2859
|
+
# id: "MulticastGroupId", # required
|
|
2860
|
+
# payload_data: "PayloadData", # required
|
|
2861
|
+
# wireless_metadata: { # required
|
|
2862
|
+
# lo_ra_wan: {
|
|
2863
|
+
# f_port: 1,
|
|
2864
|
+
# },
|
|
2865
|
+
# },
|
|
2866
|
+
# })
|
|
2867
|
+
#
|
|
2868
|
+
# @example Response structure
|
|
2869
|
+
#
|
|
2870
|
+
# resp.message_id #=> String
|
|
2871
|
+
#
|
|
2872
|
+
# @overload send_data_to_multicast_group(params = {})
|
|
2873
|
+
# @param [Hash] params ({})
|
|
2874
|
+
def send_data_to_multicast_group(params = {}, options = {})
|
|
2875
|
+
req = build_request(:send_data_to_multicast_group, params)
|
|
2876
|
+
req.send_request(options)
|
|
2877
|
+
end
|
|
2878
|
+
|
|
2167
2879
|
# Sends a decrypted application data frame to a device.
|
|
2168
2880
|
#
|
|
2169
2881
|
# @option params [required, String] :id
|
|
@@ -2211,6 +2923,133 @@ module Aws::IoTWireless
|
|
|
2211
2923
|
req.send_request(options)
|
|
2212
2924
|
end
|
|
2213
2925
|
|
|
2926
|
+
# Starts a bulk association of all qualifying wireless devices with a
|
|
2927
|
+
# multicast group.
|
|
2928
|
+
#
|
|
2929
|
+
# @option params [required, String] :id
|
|
2930
|
+
# The ID of the multicast group.
|
|
2931
|
+
#
|
|
2932
|
+
# @option params [String] :query_string
|
|
2933
|
+
# Query string used to search for wireless devices as part of the bulk
|
|
2934
|
+
# associate and disassociate process.
|
|
2935
|
+
#
|
|
2936
|
+
# @option params [Array<Types::Tag>] :tags
|
|
2937
|
+
# The tag to attach to the specified resource. Tags are metadata that
|
|
2938
|
+
# you can use to manage a resource.
|
|
2939
|
+
#
|
|
2940
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
2941
|
+
#
|
|
2942
|
+
# @example Request syntax with placeholder values
|
|
2943
|
+
#
|
|
2944
|
+
# resp = client.start_bulk_associate_wireless_device_with_multicast_group({
|
|
2945
|
+
# id: "MulticastGroupId", # required
|
|
2946
|
+
# query_string: "QueryString",
|
|
2947
|
+
# tags: [
|
|
2948
|
+
# {
|
|
2949
|
+
# key: "TagKey", # required
|
|
2950
|
+
# value: "TagValue", # required
|
|
2951
|
+
# },
|
|
2952
|
+
# ],
|
|
2953
|
+
# })
|
|
2954
|
+
#
|
|
2955
|
+
# @overload start_bulk_associate_wireless_device_with_multicast_group(params = {})
|
|
2956
|
+
# @param [Hash] params ({})
|
|
2957
|
+
def start_bulk_associate_wireless_device_with_multicast_group(params = {}, options = {})
|
|
2958
|
+
req = build_request(:start_bulk_associate_wireless_device_with_multicast_group, params)
|
|
2959
|
+
req.send_request(options)
|
|
2960
|
+
end
|
|
2961
|
+
|
|
2962
|
+
# Starts a bulk disassociatin of all qualifying wireless devices from a
|
|
2963
|
+
# multicast group.
|
|
2964
|
+
#
|
|
2965
|
+
# @option params [required, String] :id
|
|
2966
|
+
# The ID of the multicast group.
|
|
2967
|
+
#
|
|
2968
|
+
# @option params [String] :query_string
|
|
2969
|
+
# Query string used to search for wireless devices as part of the bulk
|
|
2970
|
+
# associate and disassociate process.
|
|
2971
|
+
#
|
|
2972
|
+
# @option params [Array<Types::Tag>] :tags
|
|
2973
|
+
# The tag to attach to the specified resource. Tags are metadata that
|
|
2974
|
+
# you can use to manage a resource.
|
|
2975
|
+
#
|
|
2976
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
2977
|
+
#
|
|
2978
|
+
# @example Request syntax with placeholder values
|
|
2979
|
+
#
|
|
2980
|
+
# resp = client.start_bulk_disassociate_wireless_device_from_multicast_group({
|
|
2981
|
+
# id: "MulticastGroupId", # required
|
|
2982
|
+
# query_string: "QueryString",
|
|
2983
|
+
# tags: [
|
|
2984
|
+
# {
|
|
2985
|
+
# key: "TagKey", # required
|
|
2986
|
+
# value: "TagValue", # required
|
|
2987
|
+
# },
|
|
2988
|
+
# ],
|
|
2989
|
+
# })
|
|
2990
|
+
#
|
|
2991
|
+
# @overload start_bulk_disassociate_wireless_device_from_multicast_group(params = {})
|
|
2992
|
+
# @param [Hash] params ({})
|
|
2993
|
+
def start_bulk_disassociate_wireless_device_from_multicast_group(params = {}, options = {})
|
|
2994
|
+
req = build_request(:start_bulk_disassociate_wireless_device_from_multicast_group, params)
|
|
2995
|
+
req.send_request(options)
|
|
2996
|
+
end
|
|
2997
|
+
|
|
2998
|
+
# Starts a FUOTA task.
|
|
2999
|
+
#
|
|
3000
|
+
# @option params [required, String] :id
|
|
3001
|
+
# The ID of a FUOTA task.
|
|
3002
|
+
#
|
|
3003
|
+
# @option params [Types::LoRaWANStartFuotaTask] :lo_ra_wan
|
|
3004
|
+
# The LoRaWAN information used to start a FUOTA task.
|
|
3005
|
+
#
|
|
3006
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
3007
|
+
#
|
|
3008
|
+
# @example Request syntax with placeholder values
|
|
3009
|
+
#
|
|
3010
|
+
# resp = client.start_fuota_task({
|
|
3011
|
+
# id: "FuotaTaskId", # required
|
|
3012
|
+
# lo_ra_wan: {
|
|
3013
|
+
# start_time: Time.now,
|
|
3014
|
+
# },
|
|
3015
|
+
# })
|
|
3016
|
+
#
|
|
3017
|
+
# @overload start_fuota_task(params = {})
|
|
3018
|
+
# @param [Hash] params ({})
|
|
3019
|
+
def start_fuota_task(params = {}, options = {})
|
|
3020
|
+
req = build_request(:start_fuota_task, params)
|
|
3021
|
+
req.send_request(options)
|
|
3022
|
+
end
|
|
3023
|
+
|
|
3024
|
+
# Starts a multicast group session.
|
|
3025
|
+
#
|
|
3026
|
+
# @option params [required, String] :id
|
|
3027
|
+
# The ID of the multicast group.
|
|
3028
|
+
#
|
|
3029
|
+
# @option params [required, Types::LoRaWANMulticastSession] :lo_ra_wan
|
|
3030
|
+
# The LoRaWAN information used with the multicast session.
|
|
3031
|
+
#
|
|
3032
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
3033
|
+
#
|
|
3034
|
+
# @example Request syntax with placeholder values
|
|
3035
|
+
#
|
|
3036
|
+
# resp = client.start_multicast_group_session({
|
|
3037
|
+
# id: "MulticastGroupId", # required
|
|
3038
|
+
# lo_ra_wan: { # required
|
|
3039
|
+
# dl_dr: 1,
|
|
3040
|
+
# dl_freq: 1,
|
|
3041
|
+
# session_start_time: Time.now,
|
|
3042
|
+
# session_timeout: 1,
|
|
3043
|
+
# },
|
|
3044
|
+
# })
|
|
3045
|
+
#
|
|
3046
|
+
# @overload start_multicast_group_session(params = {})
|
|
3047
|
+
# @param [Hash] params ({})
|
|
3048
|
+
def start_multicast_group_session(params = {}, options = {})
|
|
3049
|
+
req = build_request(:start_multicast_group_session, params)
|
|
3050
|
+
req.send_request(options)
|
|
3051
|
+
end
|
|
3052
|
+
|
|
2214
3053
|
# Adds a tag to a resource.
|
|
2215
3054
|
#
|
|
2216
3055
|
# @option params [required, String] :resource_arn
|
|
@@ -2328,6 +3167,49 @@ module Aws::IoTWireless
|
|
|
2328
3167
|
req.send_request(options)
|
|
2329
3168
|
end
|
|
2330
3169
|
|
|
3170
|
+
# Updates properties of a FUOTA task.
|
|
3171
|
+
#
|
|
3172
|
+
# @option params [required, String] :id
|
|
3173
|
+
# The ID of a FUOTA task.
|
|
3174
|
+
#
|
|
3175
|
+
# @option params [String] :name
|
|
3176
|
+
# The name of a FUOTA task.
|
|
3177
|
+
#
|
|
3178
|
+
# @option params [String] :description
|
|
3179
|
+
# The description of the new resource.
|
|
3180
|
+
#
|
|
3181
|
+
# @option params [Types::LoRaWANFuotaTask] :lo_ra_wan
|
|
3182
|
+
# The LoRaWAN information used with a FUOTA task.
|
|
3183
|
+
#
|
|
3184
|
+
# @option params [String] :firmware_update_image
|
|
3185
|
+
# The S3 URI points to a firmware update image that is to be used with a
|
|
3186
|
+
# FUOTA task.
|
|
3187
|
+
#
|
|
3188
|
+
# @option params [String] :firmware_update_role
|
|
3189
|
+
# The firmware update role that is to be used with a FUOTA task.
|
|
3190
|
+
#
|
|
3191
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
3192
|
+
#
|
|
3193
|
+
# @example Request syntax with placeholder values
|
|
3194
|
+
#
|
|
3195
|
+
# resp = client.update_fuota_task({
|
|
3196
|
+
# id: "FuotaTaskId", # required
|
|
3197
|
+
# name: "FuotaTaskName",
|
|
3198
|
+
# description: "Description",
|
|
3199
|
+
# lo_ra_wan: {
|
|
3200
|
+
# rf_region: "EU868", # accepts EU868, US915, AU915, AS923-1
|
|
3201
|
+
# },
|
|
3202
|
+
# firmware_update_image: "FirmwareUpdateImage",
|
|
3203
|
+
# firmware_update_role: "FirmwareUpdateRole",
|
|
3204
|
+
# })
|
|
3205
|
+
#
|
|
3206
|
+
# @overload update_fuota_task(params = {})
|
|
3207
|
+
# @param [Hash] params ({})
|
|
3208
|
+
def update_fuota_task(params = {}, options = {})
|
|
3209
|
+
req = build_request(:update_fuota_task, params)
|
|
3210
|
+
req.send_request(options)
|
|
3211
|
+
end
|
|
3212
|
+
|
|
2331
3213
|
# Set default log level, or log levels by resource types. This can be
|
|
2332
3214
|
# for wireless device log options or wireless gateways log options and
|
|
2333
3215
|
# is used to control the log messages that'll be displayed in
|
|
@@ -2381,6 +3263,84 @@ module Aws::IoTWireless
|
|
|
2381
3263
|
req.send_request(options)
|
|
2382
3264
|
end
|
|
2383
3265
|
|
|
3266
|
+
# Updates properties of a multicast group session.
|
|
3267
|
+
#
|
|
3268
|
+
# @option params [required, String] :id
|
|
3269
|
+
# The ID of the multicast group.
|
|
3270
|
+
#
|
|
3271
|
+
# @option params [String] :name
|
|
3272
|
+
# The name of the multicast group.
|
|
3273
|
+
#
|
|
3274
|
+
# @option params [String] :description
|
|
3275
|
+
# The description of the new resource.
|
|
3276
|
+
#
|
|
3277
|
+
# @option params [Types::LoRaWANMulticast] :lo_ra_wan
|
|
3278
|
+
# The LoRaWAN information that is to be used with the multicast group.
|
|
3279
|
+
#
|
|
3280
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
3281
|
+
#
|
|
3282
|
+
# @example Request syntax with placeholder values
|
|
3283
|
+
#
|
|
3284
|
+
# resp = client.update_multicast_group({
|
|
3285
|
+
# id: "MulticastGroupId", # required
|
|
3286
|
+
# name: "MulticastGroupName",
|
|
3287
|
+
# description: "Description",
|
|
3288
|
+
# lo_ra_wan: {
|
|
3289
|
+
# rf_region: "EU868", # accepts EU868, US915, AU915, AS923-1
|
|
3290
|
+
# dl_class: "ClassB", # accepts ClassB, ClassC
|
|
3291
|
+
# },
|
|
3292
|
+
# })
|
|
3293
|
+
#
|
|
3294
|
+
# @overload update_multicast_group(params = {})
|
|
3295
|
+
# @param [Hash] params ({})
|
|
3296
|
+
def update_multicast_group(params = {}, options = {})
|
|
3297
|
+
req = build_request(:update_multicast_group, params)
|
|
3298
|
+
req.send_request(options)
|
|
3299
|
+
end
|
|
3300
|
+
|
|
3301
|
+
# Update NetworkAnalyzer configuration.
|
|
3302
|
+
#
|
|
3303
|
+
# @option params [required, String] :configuration_name
|
|
3304
|
+
# NetworkAnalyzer configuration name.
|
|
3305
|
+
#
|
|
3306
|
+
# @option params [Types::TraceContent] :trace_content
|
|
3307
|
+
# Trace Content for resources.
|
|
3308
|
+
#
|
|
3309
|
+
# @option params [Array<String>] :wireless_devices_to_add
|
|
3310
|
+
# WirelessDevices to add into NetworkAnalyzerConfiguration.
|
|
3311
|
+
#
|
|
3312
|
+
# @option params [Array<String>] :wireless_devices_to_remove
|
|
3313
|
+
# WirelessDevices to remove from NetworkAnalyzerConfiguration.
|
|
3314
|
+
#
|
|
3315
|
+
# @option params [Array<String>] :wireless_gateways_to_add
|
|
3316
|
+
# WirelessGateways to add into NetworkAnalyzerConfiguration.
|
|
3317
|
+
#
|
|
3318
|
+
# @option params [Array<String>] :wireless_gateways_to_remove
|
|
3319
|
+
# WirelessGateways to remove from NetworkAnalyzerConfiguration.
|
|
3320
|
+
#
|
|
3321
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
3322
|
+
#
|
|
3323
|
+
# @example Request syntax with placeholder values
|
|
3324
|
+
#
|
|
3325
|
+
# resp = client.update_network_analyzer_configuration({
|
|
3326
|
+
# configuration_name: "NetworkAnalyzerConfigurationName", # required
|
|
3327
|
+
# trace_content: {
|
|
3328
|
+
# wireless_device_frame_info: "ENABLED", # accepts ENABLED, DISABLED
|
|
3329
|
+
# log_level: "INFO", # accepts INFO, ERROR, DISABLED
|
|
3330
|
+
# },
|
|
3331
|
+
# wireless_devices_to_add: ["WirelessDeviceId"],
|
|
3332
|
+
# wireless_devices_to_remove: ["WirelessDeviceId"],
|
|
3333
|
+
# wireless_gateways_to_add: ["WirelessGatewayId"],
|
|
3334
|
+
# wireless_gateways_to_remove: ["WirelessGatewayId"],
|
|
3335
|
+
# })
|
|
3336
|
+
#
|
|
3337
|
+
# @overload update_network_analyzer_configuration(params = {})
|
|
3338
|
+
# @param [Hash] params ({})
|
|
3339
|
+
def update_network_analyzer_configuration(params = {}, options = {})
|
|
3340
|
+
req = build_request(:update_network_analyzer_configuration, params)
|
|
3341
|
+
req.send_request(options)
|
|
3342
|
+
end
|
|
3343
|
+
|
|
2384
3344
|
# Updates properties of a partner account.
|
|
2385
3345
|
#
|
|
2386
3346
|
# @option params [required, Types::SidewalkUpdateAccount] :sidewalk
|
|
@@ -2411,6 +3371,52 @@ module Aws::IoTWireless
|
|
|
2411
3371
|
req.send_request(options)
|
|
2412
3372
|
end
|
|
2413
3373
|
|
|
3374
|
+
# Update the event configuration for a particular resource identifier.
|
|
3375
|
+
#
|
|
3376
|
+
# @option params [required, String] :identifier
|
|
3377
|
+
# Resource identifier to opt in for event messaging.
|
|
3378
|
+
#
|
|
3379
|
+
# @option params [required, String] :identifier_type
|
|
3380
|
+
# Identifier type of the particular resource identifier for event
|
|
3381
|
+
# configuration.
|
|
3382
|
+
#
|
|
3383
|
+
# @option params [String] :partner_type
|
|
3384
|
+
# Partner type of the resource if the identifier type is
|
|
3385
|
+
# PartnerAccountId
|
|
3386
|
+
#
|
|
3387
|
+
# @option params [Types::DeviceRegistrationStateEventConfiguration] :device_registration_state
|
|
3388
|
+
# Event configuration for the device registration state event
|
|
3389
|
+
#
|
|
3390
|
+
# @option params [Types::ProximityEventConfiguration] :proximity
|
|
3391
|
+
# Event configuration for the Proximity event
|
|
3392
|
+
#
|
|
3393
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
3394
|
+
#
|
|
3395
|
+
# @example Request syntax with placeholder values
|
|
3396
|
+
#
|
|
3397
|
+
# resp = client.update_resource_event_configuration({
|
|
3398
|
+
# identifier: "Identifier", # required
|
|
3399
|
+
# identifier_type: "PartnerAccountId", # required, accepts PartnerAccountId
|
|
3400
|
+
# partner_type: "Sidewalk", # accepts Sidewalk
|
|
3401
|
+
# device_registration_state: {
|
|
3402
|
+
# sidewalk: {
|
|
3403
|
+
# amazon_id_event_topic: "Enabled", # accepts Enabled, Disabled
|
|
3404
|
+
# },
|
|
3405
|
+
# },
|
|
3406
|
+
# proximity: {
|
|
3407
|
+
# sidewalk: {
|
|
3408
|
+
# amazon_id_event_topic: "Enabled", # accepts Enabled, Disabled
|
|
3409
|
+
# },
|
|
3410
|
+
# },
|
|
3411
|
+
# })
|
|
3412
|
+
#
|
|
3413
|
+
# @overload update_resource_event_configuration(params = {})
|
|
3414
|
+
# @param [Hash] params ({})
|
|
3415
|
+
def update_resource_event_configuration(params = {}, options = {})
|
|
3416
|
+
req = build_request(:update_resource_event_configuration, params)
|
|
3417
|
+
req.send_request(options)
|
|
3418
|
+
end
|
|
3419
|
+
|
|
2414
3420
|
# Updates properties of a wireless device.
|
|
2415
3421
|
#
|
|
2416
3422
|
# @option params [required, String] :id
|
|
@@ -2502,7 +3508,7 @@ module Aws::IoTWireless
|
|
|
2502
3508
|
params: params,
|
|
2503
3509
|
config: config)
|
|
2504
3510
|
context[:gem_name] = 'aws-sdk-iotwireless'
|
|
2505
|
-
context[:gem_version] = '1.
|
|
3511
|
+
context[:gem_version] = '1.19.0'
|
|
2506
3512
|
Seahorse::Client::Request.new(handlers, context)
|
|
2507
3513
|
end
|
|
2508
3514
|
|