aws-sdk-iotwireless 1.14.0 → 1.18.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 +1009 -12
- 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
@@ -119,7 +119,9 @@ module Aws::IoTWireless
|
|
119
119
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
120
|
# are very aggressive. Construct and pass an instance of
|
121
121
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
-
# enable retries and extended timeouts.
|
122
|
+
# enable retries and extended timeouts. Instance profile credential
|
123
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
124
|
+
# to true.
|
123
125
|
#
|
124
126
|
# @option options [required, String] :region
|
125
127
|
# The AWS region to connect to. The configured `:region` is
|
@@ -275,6 +277,15 @@ module Aws::IoTWireless
|
|
275
277
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
276
278
|
# requests are made, and retries are disabled.
|
277
279
|
#
|
280
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
281
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
282
|
+
# will be used if available.
|
283
|
+
#
|
284
|
+
# @option options [Boolean] :use_fips_endpoint
|
285
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
286
|
+
# When a `fips` region is used, the region is normalized and this config
|
287
|
+
# is set to `true`.
|
288
|
+
#
|
278
289
|
# @option options [Boolean] :validate_params (true)
|
279
290
|
# When `true`, request parameters are validated before
|
280
291
|
# sending the request.
|
@@ -379,6 +390,78 @@ module Aws::IoTWireless
|
|
379
390
|
req.send_request(options)
|
380
391
|
end
|
381
392
|
|
393
|
+
# Associate a multicast group with a FUOTA task.
|
394
|
+
#
|
395
|
+
# @option params [required, String] :id
|
396
|
+
# The ID of a FUOTA task.
|
397
|
+
#
|
398
|
+
# @option params [required, String] :multicast_group_id
|
399
|
+
# The ID of the multicast group.
|
400
|
+
#
|
401
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
402
|
+
#
|
403
|
+
# @example Request syntax with placeholder values
|
404
|
+
#
|
405
|
+
# resp = client.associate_multicast_group_with_fuota_task({
|
406
|
+
# id: "FuotaTaskId", # required
|
407
|
+
# multicast_group_id: "MulticastGroupId", # required
|
408
|
+
# })
|
409
|
+
#
|
410
|
+
# @overload associate_multicast_group_with_fuota_task(params = {})
|
411
|
+
# @param [Hash] params ({})
|
412
|
+
def associate_multicast_group_with_fuota_task(params = {}, options = {})
|
413
|
+
req = build_request(:associate_multicast_group_with_fuota_task, params)
|
414
|
+
req.send_request(options)
|
415
|
+
end
|
416
|
+
|
417
|
+
# Associate a wireless device with a FUOTA task.
|
418
|
+
#
|
419
|
+
# @option params [required, String] :id
|
420
|
+
# The ID of a FUOTA task.
|
421
|
+
#
|
422
|
+
# @option params [required, String] :wireless_device_id
|
423
|
+
# The ID of the wireless device.
|
424
|
+
#
|
425
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
426
|
+
#
|
427
|
+
# @example Request syntax with placeholder values
|
428
|
+
#
|
429
|
+
# resp = client.associate_wireless_device_with_fuota_task({
|
430
|
+
# id: "FuotaTaskId", # required
|
431
|
+
# wireless_device_id: "WirelessDeviceId", # required
|
432
|
+
# })
|
433
|
+
#
|
434
|
+
# @overload associate_wireless_device_with_fuota_task(params = {})
|
435
|
+
# @param [Hash] params ({})
|
436
|
+
def associate_wireless_device_with_fuota_task(params = {}, options = {})
|
437
|
+
req = build_request(:associate_wireless_device_with_fuota_task, params)
|
438
|
+
req.send_request(options)
|
439
|
+
end
|
440
|
+
|
441
|
+
# Associates a wireless device with a multicast group.
|
442
|
+
#
|
443
|
+
# @option params [required, String] :id
|
444
|
+
# The ID of the multicast group.
|
445
|
+
#
|
446
|
+
# @option params [required, String] :wireless_device_id
|
447
|
+
# The ID of the wireless device.
|
448
|
+
#
|
449
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
450
|
+
#
|
451
|
+
# @example Request syntax with placeholder values
|
452
|
+
#
|
453
|
+
# resp = client.associate_wireless_device_with_multicast_group({
|
454
|
+
# id: "MulticastGroupId", # required
|
455
|
+
# wireless_device_id: "WirelessDeviceId", # required
|
456
|
+
# })
|
457
|
+
#
|
458
|
+
# @overload associate_wireless_device_with_multicast_group(params = {})
|
459
|
+
# @param [Hash] params ({})
|
460
|
+
def associate_wireless_device_with_multicast_group(params = {}, options = {})
|
461
|
+
req = build_request(:associate_wireless_device_with_multicast_group, params)
|
462
|
+
req.send_request(options)
|
463
|
+
end
|
464
|
+
|
382
465
|
# Associates a wireless device with a thing.
|
383
466
|
#
|
384
467
|
# @option params [required, String] :id
|
@@ -457,6 +540,26 @@ module Aws::IoTWireless
|
|
457
540
|
req.send_request(options)
|
458
541
|
end
|
459
542
|
|
543
|
+
# Cancels an existing multicast group session.
|
544
|
+
#
|
545
|
+
# @option params [required, String] :id
|
546
|
+
# The ID of the multicast group.
|
547
|
+
#
|
548
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
549
|
+
#
|
550
|
+
# @example Request syntax with placeholder values
|
551
|
+
#
|
552
|
+
# resp = client.cancel_multicast_group_session({
|
553
|
+
# id: "MulticastGroupId", # required
|
554
|
+
# })
|
555
|
+
#
|
556
|
+
# @overload cancel_multicast_group_session(params = {})
|
557
|
+
# @param [Hash] params ({})
|
558
|
+
def cancel_multicast_group_session(params = {}, options = {})
|
559
|
+
req = build_request(:cancel_multicast_group_session, params)
|
560
|
+
req.send_request(options)
|
561
|
+
end
|
562
|
+
|
460
563
|
# Creates a new destination that maps a device message to an AWS IoT
|
461
564
|
# rule.
|
462
565
|
#
|
@@ -594,6 +697,132 @@ module Aws::IoTWireless
|
|
594
697
|
req.send_request(options)
|
595
698
|
end
|
596
699
|
|
700
|
+
# Creates a FUOTA task.
|
701
|
+
#
|
702
|
+
# @option params [String] :name
|
703
|
+
# The name of a FUOTA task.
|
704
|
+
#
|
705
|
+
# @option params [String] :description
|
706
|
+
# The description of the new resource.
|
707
|
+
#
|
708
|
+
# @option params [String] :client_request_token
|
709
|
+
# Each resource must have a unique client request token. If you try to
|
710
|
+
# create a new resource with the same token as a resource that already
|
711
|
+
# exists, an exception occurs. If you omit this value, AWS SDKs will
|
712
|
+
# automatically generate a unique client request.
|
713
|
+
#
|
714
|
+
# **A suitable default value is auto-generated.** You should normally
|
715
|
+
# not need to pass this option.**
|
716
|
+
#
|
717
|
+
# @option params [Types::LoRaWANFuotaTask] :lo_ra_wan
|
718
|
+
# The LoRaWAN information used with a FUOTA task.
|
719
|
+
#
|
720
|
+
# @option params [required, String] :firmware_update_image
|
721
|
+
# The S3 URI points to a firmware update image that is to be used with a
|
722
|
+
# FUOTA task.
|
723
|
+
#
|
724
|
+
# @option params [required, String] :firmware_update_role
|
725
|
+
# The firmware update role that is to be used with a FUOTA task.
|
726
|
+
#
|
727
|
+
# @option params [Array<Types::Tag>] :tags
|
728
|
+
# The tag to attach to the specified resource. Tags are metadata that
|
729
|
+
# you can use to manage a resource.
|
730
|
+
#
|
731
|
+
# @return [Types::CreateFuotaTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
732
|
+
#
|
733
|
+
# * {Types::CreateFuotaTaskResponse#arn #arn} => String
|
734
|
+
# * {Types::CreateFuotaTaskResponse#id #id} => String
|
735
|
+
#
|
736
|
+
# @example Request syntax with placeholder values
|
737
|
+
#
|
738
|
+
# resp = client.create_fuota_task({
|
739
|
+
# name: "FuotaTaskName",
|
740
|
+
# description: "Description",
|
741
|
+
# client_request_token: "ClientRequestToken",
|
742
|
+
# lo_ra_wan: {
|
743
|
+
# rf_region: "EU868", # accepts EU868, US915, AU915, AS923-1
|
744
|
+
# },
|
745
|
+
# firmware_update_image: "FirmwareUpdateImage", # required
|
746
|
+
# firmware_update_role: "FirmwareUpdateRole", # required
|
747
|
+
# tags: [
|
748
|
+
# {
|
749
|
+
# key: "TagKey", # required
|
750
|
+
# value: "TagValue", # required
|
751
|
+
# },
|
752
|
+
# ],
|
753
|
+
# })
|
754
|
+
#
|
755
|
+
# @example Response structure
|
756
|
+
#
|
757
|
+
# resp.arn #=> String
|
758
|
+
# resp.id #=> String
|
759
|
+
#
|
760
|
+
# @overload create_fuota_task(params = {})
|
761
|
+
# @param [Hash] params ({})
|
762
|
+
def create_fuota_task(params = {}, options = {})
|
763
|
+
req = build_request(:create_fuota_task, params)
|
764
|
+
req.send_request(options)
|
765
|
+
end
|
766
|
+
|
767
|
+
# Creates a multicast group.
|
768
|
+
#
|
769
|
+
# @option params [String] :name
|
770
|
+
# The name of the multicast group.
|
771
|
+
#
|
772
|
+
# @option params [String] :description
|
773
|
+
# The description of the multicast group.
|
774
|
+
#
|
775
|
+
# @option params [String] :client_request_token
|
776
|
+
# Each resource must have a unique client request token. If you try to
|
777
|
+
# create a new resource with the same token as a resource that already
|
778
|
+
# exists, an exception occurs. If you omit this value, AWS SDKs will
|
779
|
+
# automatically generate a unique client request.
|
780
|
+
#
|
781
|
+
# **A suitable default value is auto-generated.** You should normally
|
782
|
+
# not need to pass this option.**
|
783
|
+
#
|
784
|
+
# @option params [required, Types::LoRaWANMulticast] :lo_ra_wan
|
785
|
+
# The LoRaWAN information that is to be used with the multicast group.
|
786
|
+
#
|
787
|
+
# @option params [Array<Types::Tag>] :tags
|
788
|
+
# The tag to attach to the specified resource. Tags are metadata that
|
789
|
+
# you can use to manage a resource.
|
790
|
+
#
|
791
|
+
# @return [Types::CreateMulticastGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
792
|
+
#
|
793
|
+
# * {Types::CreateMulticastGroupResponse#arn #arn} => String
|
794
|
+
# * {Types::CreateMulticastGroupResponse#id #id} => String
|
795
|
+
#
|
796
|
+
# @example Request syntax with placeholder values
|
797
|
+
#
|
798
|
+
# resp = client.create_multicast_group({
|
799
|
+
# name: "MulticastGroupName",
|
800
|
+
# description: "Description",
|
801
|
+
# client_request_token: "ClientRequestToken",
|
802
|
+
# lo_ra_wan: { # required
|
803
|
+
# rf_region: "EU868", # accepts EU868, US915, AU915, AS923-1
|
804
|
+
# dl_class: "ClassB", # accepts ClassB, ClassC
|
805
|
+
# },
|
806
|
+
# tags: [
|
807
|
+
# {
|
808
|
+
# key: "TagKey", # required
|
809
|
+
# value: "TagValue", # required
|
810
|
+
# },
|
811
|
+
# ],
|
812
|
+
# })
|
813
|
+
#
|
814
|
+
# @example Response structure
|
815
|
+
#
|
816
|
+
# resp.arn #=> String
|
817
|
+
# resp.id #=> String
|
818
|
+
#
|
819
|
+
# @overload create_multicast_group(params = {})
|
820
|
+
# @param [Hash] params ({})
|
821
|
+
def create_multicast_group(params = {}, options = {})
|
822
|
+
req = build_request(:create_multicast_group, params)
|
823
|
+
req.send_request(options)
|
824
|
+
end
|
825
|
+
|
597
826
|
# Creates a new service profile.
|
598
827
|
#
|
599
828
|
# @option params [String] :name
|
@@ -704,6 +933,7 @@ module Aws::IoTWireless
|
|
704
933
|
# otaa_v1_0_x: {
|
705
934
|
# app_key: "AppKey",
|
706
935
|
# app_eui: "AppEui",
|
936
|
+
# gen_app_key: "GenAppKey",
|
707
937
|
# },
|
708
938
|
# abp_v1_1: {
|
709
939
|
# dev_addr: "DevAddr",
|
@@ -721,6 +951,11 @@ module Aws::IoTWireless
|
|
721
951
|
# app_s_key: "AppSKey",
|
722
952
|
# },
|
723
953
|
# },
|
954
|
+
# f_ports: {
|
955
|
+
# fuota: 1,
|
956
|
+
# multicast: 1,
|
957
|
+
# clock_sync: 1,
|
958
|
+
# },
|
724
959
|
# },
|
725
960
|
# tags: [
|
726
961
|
# {
|
@@ -954,6 +1189,46 @@ module Aws::IoTWireless
|
|
954
1189
|
req.send_request(options)
|
955
1190
|
end
|
956
1191
|
|
1192
|
+
# Deletes a FUOTA task.
|
1193
|
+
#
|
1194
|
+
# @option params [required, String] :id
|
1195
|
+
# The ID of a FUOTA task.
|
1196
|
+
#
|
1197
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1198
|
+
#
|
1199
|
+
# @example Request syntax with placeholder values
|
1200
|
+
#
|
1201
|
+
# resp = client.delete_fuota_task({
|
1202
|
+
# id: "FuotaTaskId", # required
|
1203
|
+
# })
|
1204
|
+
#
|
1205
|
+
# @overload delete_fuota_task(params = {})
|
1206
|
+
# @param [Hash] params ({})
|
1207
|
+
def delete_fuota_task(params = {}, options = {})
|
1208
|
+
req = build_request(:delete_fuota_task, params)
|
1209
|
+
req.send_request(options)
|
1210
|
+
end
|
1211
|
+
|
1212
|
+
# Deletes a multicast group if it is not in use by a fuota task.
|
1213
|
+
#
|
1214
|
+
# @option params [required, String] :id
|
1215
|
+
# The ID of the multicast group.
|
1216
|
+
#
|
1217
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1218
|
+
#
|
1219
|
+
# @example Request syntax with placeholder values
|
1220
|
+
#
|
1221
|
+
# resp = client.delete_multicast_group({
|
1222
|
+
# id: "MulticastGroupId", # required
|
1223
|
+
# })
|
1224
|
+
#
|
1225
|
+
# @overload delete_multicast_group(params = {})
|
1226
|
+
# @param [Hash] params ({})
|
1227
|
+
def delete_multicast_group(params = {}, options = {})
|
1228
|
+
req = build_request(:delete_multicast_group, params)
|
1229
|
+
req.send_request(options)
|
1230
|
+
end
|
1231
|
+
|
957
1232
|
# Deletes a service profile.
|
958
1233
|
#
|
959
1234
|
# @option params [required, String] :id
|
@@ -1081,6 +1356,78 @@ module Aws::IoTWireless
|
|
1081
1356
|
req.send_request(options)
|
1082
1357
|
end
|
1083
1358
|
|
1359
|
+
# Disassociates a multicast group from a fuota task.
|
1360
|
+
#
|
1361
|
+
# @option params [required, String] :id
|
1362
|
+
# The ID of a FUOTA task.
|
1363
|
+
#
|
1364
|
+
# @option params [required, String] :multicast_group_id
|
1365
|
+
# The ID of the multicast group.
|
1366
|
+
#
|
1367
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1368
|
+
#
|
1369
|
+
# @example Request syntax with placeholder values
|
1370
|
+
#
|
1371
|
+
# resp = client.disassociate_multicast_group_from_fuota_task({
|
1372
|
+
# id: "FuotaTaskId", # required
|
1373
|
+
# multicast_group_id: "MulticastGroupId", # required
|
1374
|
+
# })
|
1375
|
+
#
|
1376
|
+
# @overload disassociate_multicast_group_from_fuota_task(params = {})
|
1377
|
+
# @param [Hash] params ({})
|
1378
|
+
def disassociate_multicast_group_from_fuota_task(params = {}, options = {})
|
1379
|
+
req = build_request(:disassociate_multicast_group_from_fuota_task, params)
|
1380
|
+
req.send_request(options)
|
1381
|
+
end
|
1382
|
+
|
1383
|
+
# Disassociates a wireless device from a FUOTA task.
|
1384
|
+
#
|
1385
|
+
# @option params [required, String] :id
|
1386
|
+
# The ID of a FUOTA task.
|
1387
|
+
#
|
1388
|
+
# @option params [required, String] :wireless_device_id
|
1389
|
+
# The ID of the wireless device.
|
1390
|
+
#
|
1391
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1392
|
+
#
|
1393
|
+
# @example Request syntax with placeholder values
|
1394
|
+
#
|
1395
|
+
# resp = client.disassociate_wireless_device_from_fuota_task({
|
1396
|
+
# id: "FuotaTaskId", # required
|
1397
|
+
# wireless_device_id: "WirelessDeviceId", # required
|
1398
|
+
# })
|
1399
|
+
#
|
1400
|
+
# @overload disassociate_wireless_device_from_fuota_task(params = {})
|
1401
|
+
# @param [Hash] params ({})
|
1402
|
+
def disassociate_wireless_device_from_fuota_task(params = {}, options = {})
|
1403
|
+
req = build_request(:disassociate_wireless_device_from_fuota_task, params)
|
1404
|
+
req.send_request(options)
|
1405
|
+
end
|
1406
|
+
|
1407
|
+
# Disassociates a wireless device from a multicast group.
|
1408
|
+
#
|
1409
|
+
# @option params [required, String] :id
|
1410
|
+
# The ID of the multicast group.
|
1411
|
+
#
|
1412
|
+
# @option params [required, String] :wireless_device_id
|
1413
|
+
# The ID of the wireless device.
|
1414
|
+
#
|
1415
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1416
|
+
#
|
1417
|
+
# @example Request syntax with placeholder values
|
1418
|
+
#
|
1419
|
+
# resp = client.disassociate_wireless_device_from_multicast_group({
|
1420
|
+
# id: "MulticastGroupId", # required
|
1421
|
+
# wireless_device_id: "WirelessDeviceId", # required
|
1422
|
+
# })
|
1423
|
+
#
|
1424
|
+
# @overload disassociate_wireless_device_from_multicast_group(params = {})
|
1425
|
+
# @param [Hash] params ({})
|
1426
|
+
def disassociate_wireless_device_from_multicast_group(params = {}, options = {})
|
1427
|
+
req = build_request(:disassociate_wireless_device_from_multicast_group, params)
|
1428
|
+
req.send_request(options)
|
1429
|
+
end
|
1430
|
+
|
1084
1431
|
# Disassociates a wireless device from its currently associated thing.
|
1085
1432
|
#
|
1086
1433
|
# @option params [required, String] :id
|
@@ -1229,6 +1576,49 @@ module Aws::IoTWireless
|
|
1229
1576
|
req.send_request(options)
|
1230
1577
|
end
|
1231
1578
|
|
1579
|
+
# Gets information about a FUOTA task.
|
1580
|
+
#
|
1581
|
+
# @option params [required, String] :id
|
1582
|
+
# The ID of a FUOTA task.
|
1583
|
+
#
|
1584
|
+
# @return [Types::GetFuotaTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1585
|
+
#
|
1586
|
+
# * {Types::GetFuotaTaskResponse#arn #arn} => String
|
1587
|
+
# * {Types::GetFuotaTaskResponse#id #id} => String
|
1588
|
+
# * {Types::GetFuotaTaskResponse#status #status} => String
|
1589
|
+
# * {Types::GetFuotaTaskResponse#name #name} => String
|
1590
|
+
# * {Types::GetFuotaTaskResponse#description #description} => String
|
1591
|
+
# * {Types::GetFuotaTaskResponse#lo_ra_wan #lo_ra_wan} => Types::LoRaWANFuotaTaskGetInfo
|
1592
|
+
# * {Types::GetFuotaTaskResponse#firmware_update_image #firmware_update_image} => String
|
1593
|
+
# * {Types::GetFuotaTaskResponse#firmware_update_role #firmware_update_role} => String
|
1594
|
+
# * {Types::GetFuotaTaskResponse#created_at #created_at} => Time
|
1595
|
+
#
|
1596
|
+
# @example Request syntax with placeholder values
|
1597
|
+
#
|
1598
|
+
# resp = client.get_fuota_task({
|
1599
|
+
# id: "FuotaTaskId", # required
|
1600
|
+
# })
|
1601
|
+
#
|
1602
|
+
# @example Response structure
|
1603
|
+
#
|
1604
|
+
# resp.arn #=> String
|
1605
|
+
# resp.id #=> String
|
1606
|
+
# resp.status #=> String, one of "Pending", "FuotaSession_Waiting", "In_FuotaSession", "FuotaDone", "Delete_Waiting"
|
1607
|
+
# resp.name #=> String
|
1608
|
+
# resp.description #=> String
|
1609
|
+
# resp.lo_ra_wan.rf_region #=> String
|
1610
|
+
# resp.lo_ra_wan.start_time #=> Time
|
1611
|
+
# resp.firmware_update_image #=> String
|
1612
|
+
# resp.firmware_update_role #=> String
|
1613
|
+
# resp.created_at #=> Time
|
1614
|
+
#
|
1615
|
+
# @overload get_fuota_task(params = {})
|
1616
|
+
# @param [Hash] params ({})
|
1617
|
+
def get_fuota_task(params = {}, options = {})
|
1618
|
+
req = build_request(:get_fuota_task, params)
|
1619
|
+
req.send_request(options)
|
1620
|
+
end
|
1621
|
+
|
1232
1622
|
# Returns current default log levels or log levels by resource types.
|
1233
1623
|
# Based on resource types, log levels can be for wireless device log
|
1234
1624
|
# options or wireless gateway log options.
|
@@ -1262,19 +1652,122 @@ module Aws::IoTWireless
|
|
1262
1652
|
req.send_request(options)
|
1263
1653
|
end
|
1264
1654
|
|
1265
|
-
# Gets information about a
|
1266
|
-
# `PartnerType` are `null`, returns all partner accounts.
|
1267
|
-
#
|
1268
|
-
# @option params [required, String] :partner_account_id
|
1269
|
-
# The partner account ID to disassociate from the AWS account.
|
1655
|
+
# Gets information about a multicast group.
|
1270
1656
|
#
|
1271
|
-
# @option params [required, String] :
|
1272
|
-
# The
|
1657
|
+
# @option params [required, String] :id
|
1658
|
+
# The ID of the multicast group.
|
1273
1659
|
#
|
1274
|
-
# @return [Types::
|
1660
|
+
# @return [Types::GetMulticastGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1275
1661
|
#
|
1276
|
-
# * {Types::
|
1277
|
-
# * {Types::
|
1662
|
+
# * {Types::GetMulticastGroupResponse#arn #arn} => String
|
1663
|
+
# * {Types::GetMulticastGroupResponse#id #id} => String
|
1664
|
+
# * {Types::GetMulticastGroupResponse#name #name} => String
|
1665
|
+
# * {Types::GetMulticastGroupResponse#description #description} => String
|
1666
|
+
# * {Types::GetMulticastGroupResponse#status #status} => String
|
1667
|
+
# * {Types::GetMulticastGroupResponse#lo_ra_wan #lo_ra_wan} => Types::LoRaWANMulticastGet
|
1668
|
+
# * {Types::GetMulticastGroupResponse#created_at #created_at} => Time
|
1669
|
+
#
|
1670
|
+
# @example Request syntax with placeholder values
|
1671
|
+
#
|
1672
|
+
# resp = client.get_multicast_group({
|
1673
|
+
# id: "MulticastGroupId", # required
|
1674
|
+
# })
|
1675
|
+
#
|
1676
|
+
# @example Response structure
|
1677
|
+
#
|
1678
|
+
# resp.arn #=> String
|
1679
|
+
# resp.id #=> String
|
1680
|
+
# resp.name #=> String
|
1681
|
+
# resp.description #=> String
|
1682
|
+
# resp.status #=> String
|
1683
|
+
# resp.lo_ra_wan.rf_region #=> String, one of "EU868", "US915", "AU915", "AS923-1"
|
1684
|
+
# resp.lo_ra_wan.dl_class #=> String, one of "ClassB", "ClassC"
|
1685
|
+
# resp.lo_ra_wan.number_of_devices_requested #=> Integer
|
1686
|
+
# resp.lo_ra_wan.number_of_devices_in_group #=> Integer
|
1687
|
+
# resp.created_at #=> Time
|
1688
|
+
#
|
1689
|
+
# @overload get_multicast_group(params = {})
|
1690
|
+
# @param [Hash] params ({})
|
1691
|
+
def get_multicast_group(params = {}, options = {})
|
1692
|
+
req = build_request(:get_multicast_group, params)
|
1693
|
+
req.send_request(options)
|
1694
|
+
end
|
1695
|
+
|
1696
|
+
# Gets information about a multicast group session.
|
1697
|
+
#
|
1698
|
+
# @option params [required, String] :id
|
1699
|
+
# The ID of the multicast group.
|
1700
|
+
#
|
1701
|
+
# @return [Types::GetMulticastGroupSessionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1702
|
+
#
|
1703
|
+
# * {Types::GetMulticastGroupSessionResponse#lo_ra_wan #lo_ra_wan} => Types::LoRaWANMulticastSession
|
1704
|
+
#
|
1705
|
+
# @example Request syntax with placeholder values
|
1706
|
+
#
|
1707
|
+
# resp = client.get_multicast_group_session({
|
1708
|
+
# id: "MulticastGroupId", # required
|
1709
|
+
# })
|
1710
|
+
#
|
1711
|
+
# @example Response structure
|
1712
|
+
#
|
1713
|
+
# resp.lo_ra_wan.dl_dr #=> Integer
|
1714
|
+
# resp.lo_ra_wan.dl_freq #=> Integer
|
1715
|
+
# resp.lo_ra_wan.session_start_time #=> Time
|
1716
|
+
# resp.lo_ra_wan.session_timeout #=> Integer
|
1717
|
+
#
|
1718
|
+
# @overload get_multicast_group_session(params = {})
|
1719
|
+
# @param [Hash] params ({})
|
1720
|
+
def get_multicast_group_session(params = {}, options = {})
|
1721
|
+
req = build_request(:get_multicast_group_session, params)
|
1722
|
+
req.send_request(options)
|
1723
|
+
end
|
1724
|
+
|
1725
|
+
# Get NetworkAnalyzer configuration.
|
1726
|
+
#
|
1727
|
+
# @option params [required, String] :configuration_name
|
1728
|
+
# NetworkAnalyzer configuration name.
|
1729
|
+
#
|
1730
|
+
# @return [Types::GetNetworkAnalyzerConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1731
|
+
#
|
1732
|
+
# * {Types::GetNetworkAnalyzerConfigurationResponse#trace_content #trace_content} => Types::TraceContent
|
1733
|
+
# * {Types::GetNetworkAnalyzerConfigurationResponse#wireless_devices #wireless_devices} => Array<String>
|
1734
|
+
# * {Types::GetNetworkAnalyzerConfigurationResponse#wireless_gateways #wireless_gateways} => Array<String>
|
1735
|
+
#
|
1736
|
+
# @example Request syntax with placeholder values
|
1737
|
+
#
|
1738
|
+
# resp = client.get_network_analyzer_configuration({
|
1739
|
+
# configuration_name: "NetworkAnalyzerConfigurationName", # required
|
1740
|
+
# })
|
1741
|
+
#
|
1742
|
+
# @example Response structure
|
1743
|
+
#
|
1744
|
+
# resp.trace_content.wireless_device_frame_info #=> String, one of "ENABLED", "DISABLED"
|
1745
|
+
# resp.trace_content.log_level #=> String, one of "INFO", "ERROR", "DISABLED"
|
1746
|
+
# resp.wireless_devices #=> Array
|
1747
|
+
# resp.wireless_devices[0] #=> String
|
1748
|
+
# resp.wireless_gateways #=> Array
|
1749
|
+
# resp.wireless_gateways[0] #=> String
|
1750
|
+
#
|
1751
|
+
# @overload get_network_analyzer_configuration(params = {})
|
1752
|
+
# @param [Hash] params ({})
|
1753
|
+
def get_network_analyzer_configuration(params = {}, options = {})
|
1754
|
+
req = build_request(:get_network_analyzer_configuration, params)
|
1755
|
+
req.send_request(options)
|
1756
|
+
end
|
1757
|
+
|
1758
|
+
# Gets information about a partner account. If `PartnerAccountId` and
|
1759
|
+
# `PartnerType` are `null`, returns all partner accounts.
|
1760
|
+
#
|
1761
|
+
# @option params [required, String] :partner_account_id
|
1762
|
+
# The partner account ID to disassociate from the AWS account.
|
1763
|
+
#
|
1764
|
+
# @option params [required, String] :partner_type
|
1765
|
+
# The partner type.
|
1766
|
+
#
|
1767
|
+
# @return [Types::GetPartnerAccountResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1768
|
+
#
|
1769
|
+
# * {Types::GetPartnerAccountResponse#sidewalk #sidewalk} => Types::SidewalkAccountInfoWithFingerprint
|
1770
|
+
# * {Types::GetPartnerAccountResponse#account_linked #account_linked} => Boolean
|
1278
1771
|
#
|
1279
1772
|
# @example Request syntax with placeholder values
|
1280
1773
|
#
|
@@ -1297,6 +1790,44 @@ module Aws::IoTWireless
|
|
1297
1790
|
req.send_request(options)
|
1298
1791
|
end
|
1299
1792
|
|
1793
|
+
# Get the event configuration for a particular resource identifier.
|
1794
|
+
#
|
1795
|
+
# @option params [required, String] :identifier
|
1796
|
+
# Resource identifier to opt in for event messaging.
|
1797
|
+
#
|
1798
|
+
# @option params [required, String] :identifier_type
|
1799
|
+
# Identifier type of the particular resource identifier for event
|
1800
|
+
# configuration.
|
1801
|
+
#
|
1802
|
+
# @option params [String] :partner_type
|
1803
|
+
# Partner type of the resource if the identifier type is
|
1804
|
+
# PartnerAccountId.
|
1805
|
+
#
|
1806
|
+
# @return [Types::GetResourceEventConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1807
|
+
#
|
1808
|
+
# * {Types::GetResourceEventConfigurationResponse#device_registration_state #device_registration_state} => Types::DeviceRegistrationStateEventConfiguration
|
1809
|
+
# * {Types::GetResourceEventConfigurationResponse#proximity #proximity} => Types::ProximityEventConfiguration
|
1810
|
+
#
|
1811
|
+
# @example Request syntax with placeholder values
|
1812
|
+
#
|
1813
|
+
# resp = client.get_resource_event_configuration({
|
1814
|
+
# identifier: "Identifier", # required
|
1815
|
+
# identifier_type: "PartnerAccountId", # required, accepts PartnerAccountId
|
1816
|
+
# partner_type: "Sidewalk", # accepts Sidewalk
|
1817
|
+
# })
|
1818
|
+
#
|
1819
|
+
# @example Response structure
|
1820
|
+
#
|
1821
|
+
# resp.device_registration_state.sidewalk.amazon_id_event_topic #=> String, one of "Enabled", "Disabled"
|
1822
|
+
# resp.proximity.sidewalk.amazon_id_event_topic #=> String, one of "Enabled", "Disabled"
|
1823
|
+
#
|
1824
|
+
# @overload get_resource_event_configuration(params = {})
|
1825
|
+
# @param [Hash] params ({})
|
1826
|
+
def get_resource_event_configuration(params = {}, options = {})
|
1827
|
+
req = build_request(:get_resource_event_configuration, params)
|
1828
|
+
req.send_request(options)
|
1829
|
+
end
|
1830
|
+
|
1300
1831
|
# Fetches the log-level override, if any, for a given resource-ID and
|
1301
1832
|
# resource-type. It can be used for a wireless device or a wireless
|
1302
1833
|
# gateway.
|
@@ -1461,6 +1992,7 @@ module Aws::IoTWireless
|
|
1461
1992
|
# resp.lo_ra_wan.otaa_v1_1.join_eui #=> String
|
1462
1993
|
# resp.lo_ra_wan.otaa_v1_0_x.app_key #=> String
|
1463
1994
|
# resp.lo_ra_wan.otaa_v1_0_x.app_eui #=> String
|
1995
|
+
# resp.lo_ra_wan.otaa_v1_0_x.gen_app_key #=> String
|
1464
1996
|
# resp.lo_ra_wan.abp_v1_1.dev_addr #=> String
|
1465
1997
|
# resp.lo_ra_wan.abp_v1_1.session_keys.f_nwk_s_int_key #=> String
|
1466
1998
|
# resp.lo_ra_wan.abp_v1_1.session_keys.s_nwk_s_int_key #=> String
|
@@ -1469,6 +2001,9 @@ module Aws::IoTWireless
|
|
1469
2001
|
# resp.lo_ra_wan.abp_v1_0_x.dev_addr #=> String
|
1470
2002
|
# resp.lo_ra_wan.abp_v1_0_x.session_keys.nwk_s_key #=> String
|
1471
2003
|
# resp.lo_ra_wan.abp_v1_0_x.session_keys.app_s_key #=> String
|
2004
|
+
# resp.lo_ra_wan.f_ports.fuota #=> Integer
|
2005
|
+
# resp.lo_ra_wan.f_ports.multicast #=> Integer
|
2006
|
+
# resp.lo_ra_wan.f_ports.clock_sync #=> Integer
|
1472
2007
|
# resp.sidewalk.amazon_id #=> String
|
1473
2008
|
# resp.sidewalk.sidewalk_id #=> String
|
1474
2009
|
# resp.sidewalk.sidewalk_manufacturing_sn #=> String
|
@@ -1820,6 +2355,125 @@ module Aws::IoTWireless
|
|
1820
2355
|
req.send_request(options)
|
1821
2356
|
end
|
1822
2357
|
|
2358
|
+
# Lists the FUOTA tasks registered to your AWS account.
|
2359
|
+
#
|
2360
|
+
# @option params [String] :next_token
|
2361
|
+
# To retrieve the next set of results, the `nextToken` value from a
|
2362
|
+
# previous response; otherwise **null** to receive the first set of
|
2363
|
+
# results.
|
2364
|
+
#
|
2365
|
+
# @option params [Integer] :max_results
|
2366
|
+
# The maximum number of results to return in this operation.
|
2367
|
+
#
|
2368
|
+
# @return [Types::ListFuotaTasksResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2369
|
+
#
|
2370
|
+
# * {Types::ListFuotaTasksResponse#next_token #next_token} => String
|
2371
|
+
# * {Types::ListFuotaTasksResponse#fuota_task_list #fuota_task_list} => Array<Types::FuotaTask>
|
2372
|
+
#
|
2373
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2374
|
+
#
|
2375
|
+
# @example Request syntax with placeholder values
|
2376
|
+
#
|
2377
|
+
# resp = client.list_fuota_tasks({
|
2378
|
+
# next_token: "NextToken",
|
2379
|
+
# max_results: 1,
|
2380
|
+
# })
|
2381
|
+
#
|
2382
|
+
# @example Response structure
|
2383
|
+
#
|
2384
|
+
# resp.next_token #=> String
|
2385
|
+
# resp.fuota_task_list #=> Array
|
2386
|
+
# resp.fuota_task_list[0].id #=> String
|
2387
|
+
# resp.fuota_task_list[0].arn #=> String
|
2388
|
+
# resp.fuota_task_list[0].name #=> String
|
2389
|
+
#
|
2390
|
+
# @overload list_fuota_tasks(params = {})
|
2391
|
+
# @param [Hash] params ({})
|
2392
|
+
def list_fuota_tasks(params = {}, options = {})
|
2393
|
+
req = build_request(:list_fuota_tasks, params)
|
2394
|
+
req.send_request(options)
|
2395
|
+
end
|
2396
|
+
|
2397
|
+
# Lists the multicast groups registered to your AWS account.
|
2398
|
+
#
|
2399
|
+
# @option params [String] :next_token
|
2400
|
+
# To retrieve the next set of results, the `nextToken` value from a
|
2401
|
+
# previous response; otherwise **null** to receive the first set of
|
2402
|
+
# results.
|
2403
|
+
#
|
2404
|
+
# @option params [Integer] :max_results
|
2405
|
+
# The maximum number of results to return in this operation.
|
2406
|
+
#
|
2407
|
+
# @return [Types::ListMulticastGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2408
|
+
#
|
2409
|
+
# * {Types::ListMulticastGroupsResponse#next_token #next_token} => String
|
2410
|
+
# * {Types::ListMulticastGroupsResponse#multicast_group_list #multicast_group_list} => Array<Types::MulticastGroup>
|
2411
|
+
#
|
2412
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2413
|
+
#
|
2414
|
+
# @example Request syntax with placeholder values
|
2415
|
+
#
|
2416
|
+
# resp = client.list_multicast_groups({
|
2417
|
+
# next_token: "NextToken",
|
2418
|
+
# max_results: 1,
|
2419
|
+
# })
|
2420
|
+
#
|
2421
|
+
# @example Response structure
|
2422
|
+
#
|
2423
|
+
# resp.next_token #=> String
|
2424
|
+
# resp.multicast_group_list #=> Array
|
2425
|
+
# resp.multicast_group_list[0].id #=> String
|
2426
|
+
# resp.multicast_group_list[0].arn #=> String
|
2427
|
+
# resp.multicast_group_list[0].name #=> String
|
2428
|
+
#
|
2429
|
+
# @overload list_multicast_groups(params = {})
|
2430
|
+
# @param [Hash] params ({})
|
2431
|
+
def list_multicast_groups(params = {}, options = {})
|
2432
|
+
req = build_request(:list_multicast_groups, params)
|
2433
|
+
req.send_request(options)
|
2434
|
+
end
|
2435
|
+
|
2436
|
+
# List all multicast groups associated with a fuota task.
|
2437
|
+
#
|
2438
|
+
# @option params [required, String] :id
|
2439
|
+
# The ID of a FUOTA task.
|
2440
|
+
#
|
2441
|
+
# @option params [String] :next_token
|
2442
|
+
# To retrieve the next set of results, the `nextToken` value from a
|
2443
|
+
# previous response; otherwise **null** to receive the first set of
|
2444
|
+
# results.
|
2445
|
+
#
|
2446
|
+
# @option params [Integer] :max_results
|
2447
|
+
# The maximum number of results to return in this operation.
|
2448
|
+
#
|
2449
|
+
# @return [Types::ListMulticastGroupsByFuotaTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2450
|
+
#
|
2451
|
+
# * {Types::ListMulticastGroupsByFuotaTaskResponse#next_token #next_token} => String
|
2452
|
+
# * {Types::ListMulticastGroupsByFuotaTaskResponse#multicast_group_list #multicast_group_list} => Array<Types::MulticastGroupByFuotaTask>
|
2453
|
+
#
|
2454
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2455
|
+
#
|
2456
|
+
# @example Request syntax with placeholder values
|
2457
|
+
#
|
2458
|
+
# resp = client.list_multicast_groups_by_fuota_task({
|
2459
|
+
# id: "FuotaTaskId", # required
|
2460
|
+
# next_token: "NextToken",
|
2461
|
+
# max_results: 1,
|
2462
|
+
# })
|
2463
|
+
#
|
2464
|
+
# @example Response structure
|
2465
|
+
#
|
2466
|
+
# resp.next_token #=> String
|
2467
|
+
# resp.multicast_group_list #=> Array
|
2468
|
+
# resp.multicast_group_list[0].id #=> String
|
2469
|
+
#
|
2470
|
+
# @overload list_multicast_groups_by_fuota_task(params = {})
|
2471
|
+
# @param [Hash] params ({})
|
2472
|
+
def list_multicast_groups_by_fuota_task(params = {}, options = {})
|
2473
|
+
req = build_request(:list_multicast_groups_by_fuota_task, params)
|
2474
|
+
req.send_request(options)
|
2475
|
+
end
|
2476
|
+
|
1823
2477
|
# Lists the partner accounts associated with your AWS account.
|
1824
2478
|
#
|
1825
2479
|
# @option params [String] :next_token
|
@@ -1949,6 +2603,12 @@ module Aws::IoTWireless
|
|
1949
2603
|
# A filter to list only the wireless devices that use this wireless
|
1950
2604
|
# device type.
|
1951
2605
|
#
|
2606
|
+
# @option params [String] :fuota_task_id
|
2607
|
+
# The ID of a FUOTA task.
|
2608
|
+
#
|
2609
|
+
# @option params [String] :multicast_group_id
|
2610
|
+
# The ID of the multicast group.
|
2611
|
+
#
|
1952
2612
|
# @return [Types::ListWirelessDevicesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1953
2613
|
#
|
1954
2614
|
# * {Types::ListWirelessDevicesResponse#next_token #next_token} => String
|
@@ -1965,6 +2625,8 @@ module Aws::IoTWireless
|
|
1965
2625
|
# device_profile_id: "DeviceProfileId",
|
1966
2626
|
# service_profile_id: "ServiceProfileId",
|
1967
2627
|
# wireless_device_type: "Sidewalk", # accepts Sidewalk, LoRaWAN
|
2628
|
+
# fuota_task_id: "FuotaTaskId",
|
2629
|
+
# multicast_group_id: "MulticastGroupId",
|
1968
2630
|
# })
|
1969
2631
|
#
|
1970
2632
|
# @example Response structure
|
@@ -1984,6 +2646,9 @@ module Aws::IoTWireless
|
|
1984
2646
|
# resp.wireless_device_list[0].sidewalk.device_certificates #=> Array
|
1985
2647
|
# resp.wireless_device_list[0].sidewalk.device_certificates[0].signing_alg #=> String, one of "Ed25519", "P256r1"
|
1986
2648
|
# resp.wireless_device_list[0].sidewalk.device_certificates[0].value #=> String
|
2649
|
+
# 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"
|
2650
|
+
# resp.wireless_device_list[0].multicast_device_status #=> String
|
2651
|
+
# resp.wireless_device_list[0].mc_group_id #=> Integer
|
1987
2652
|
#
|
1988
2653
|
# @overload list_wireless_devices(params = {})
|
1989
2654
|
# @param [Hash] params ({})
|
@@ -2164,6 +2829,44 @@ module Aws::IoTWireless
|
|
2164
2829
|
req.send_request(options)
|
2165
2830
|
end
|
2166
2831
|
|
2832
|
+
# Sends the specified data to a multicast group.
|
2833
|
+
#
|
2834
|
+
# @option params [required, String] :id
|
2835
|
+
# The ID of the multicast group.
|
2836
|
+
#
|
2837
|
+
# @option params [required, String] :payload_data
|
2838
|
+
# The binary to be sent to the end device, encoded in base64.
|
2839
|
+
#
|
2840
|
+
# @option params [required, Types::MulticastWirelessMetadata] :wireless_metadata
|
2841
|
+
# Wireless metadata that is to be sent to multicast group.
|
2842
|
+
#
|
2843
|
+
# @return [Types::SendDataToMulticastGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2844
|
+
#
|
2845
|
+
# * {Types::SendDataToMulticastGroupResponse#message_id #message_id} => String
|
2846
|
+
#
|
2847
|
+
# @example Request syntax with placeholder values
|
2848
|
+
#
|
2849
|
+
# resp = client.send_data_to_multicast_group({
|
2850
|
+
# id: "MulticastGroupId", # required
|
2851
|
+
# payload_data: "PayloadData", # required
|
2852
|
+
# wireless_metadata: { # required
|
2853
|
+
# lo_ra_wan: {
|
2854
|
+
# f_port: 1,
|
2855
|
+
# },
|
2856
|
+
# },
|
2857
|
+
# })
|
2858
|
+
#
|
2859
|
+
# @example Response structure
|
2860
|
+
#
|
2861
|
+
# resp.message_id #=> String
|
2862
|
+
#
|
2863
|
+
# @overload send_data_to_multicast_group(params = {})
|
2864
|
+
# @param [Hash] params ({})
|
2865
|
+
def send_data_to_multicast_group(params = {}, options = {})
|
2866
|
+
req = build_request(:send_data_to_multicast_group, params)
|
2867
|
+
req.send_request(options)
|
2868
|
+
end
|
2869
|
+
|
2167
2870
|
# Sends a decrypted application data frame to a device.
|
2168
2871
|
#
|
2169
2872
|
# @option params [required, String] :id
|
@@ -2211,6 +2914,133 @@ module Aws::IoTWireless
|
|
2211
2914
|
req.send_request(options)
|
2212
2915
|
end
|
2213
2916
|
|
2917
|
+
# Starts a bulk association of all qualifying wireless devices with a
|
2918
|
+
# multicast group.
|
2919
|
+
#
|
2920
|
+
# @option params [required, String] :id
|
2921
|
+
# The ID of the multicast group.
|
2922
|
+
#
|
2923
|
+
# @option params [String] :query_string
|
2924
|
+
# Query string used to search for wireless devices as part of the bulk
|
2925
|
+
# associate and disassociate process.
|
2926
|
+
#
|
2927
|
+
# @option params [Array<Types::Tag>] :tags
|
2928
|
+
# The tag to attach to the specified resource. Tags are metadata that
|
2929
|
+
# you can use to manage a resource.
|
2930
|
+
#
|
2931
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2932
|
+
#
|
2933
|
+
# @example Request syntax with placeholder values
|
2934
|
+
#
|
2935
|
+
# resp = client.start_bulk_associate_wireless_device_with_multicast_group({
|
2936
|
+
# id: "MulticastGroupId", # required
|
2937
|
+
# query_string: "QueryString",
|
2938
|
+
# tags: [
|
2939
|
+
# {
|
2940
|
+
# key: "TagKey", # required
|
2941
|
+
# value: "TagValue", # required
|
2942
|
+
# },
|
2943
|
+
# ],
|
2944
|
+
# })
|
2945
|
+
#
|
2946
|
+
# @overload start_bulk_associate_wireless_device_with_multicast_group(params = {})
|
2947
|
+
# @param [Hash] params ({})
|
2948
|
+
def start_bulk_associate_wireless_device_with_multicast_group(params = {}, options = {})
|
2949
|
+
req = build_request(:start_bulk_associate_wireless_device_with_multicast_group, params)
|
2950
|
+
req.send_request(options)
|
2951
|
+
end
|
2952
|
+
|
2953
|
+
# Starts a bulk disassociatin of all qualifying wireless devices from a
|
2954
|
+
# multicast group.
|
2955
|
+
#
|
2956
|
+
# @option params [required, String] :id
|
2957
|
+
# The ID of the multicast group.
|
2958
|
+
#
|
2959
|
+
# @option params [String] :query_string
|
2960
|
+
# Query string used to search for wireless devices as part of the bulk
|
2961
|
+
# associate and disassociate process.
|
2962
|
+
#
|
2963
|
+
# @option params [Array<Types::Tag>] :tags
|
2964
|
+
# The tag to attach to the specified resource. Tags are metadata that
|
2965
|
+
# you can use to manage a resource.
|
2966
|
+
#
|
2967
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2968
|
+
#
|
2969
|
+
# @example Request syntax with placeholder values
|
2970
|
+
#
|
2971
|
+
# resp = client.start_bulk_disassociate_wireless_device_from_multicast_group({
|
2972
|
+
# id: "MulticastGroupId", # required
|
2973
|
+
# query_string: "QueryString",
|
2974
|
+
# tags: [
|
2975
|
+
# {
|
2976
|
+
# key: "TagKey", # required
|
2977
|
+
# value: "TagValue", # required
|
2978
|
+
# },
|
2979
|
+
# ],
|
2980
|
+
# })
|
2981
|
+
#
|
2982
|
+
# @overload start_bulk_disassociate_wireless_device_from_multicast_group(params = {})
|
2983
|
+
# @param [Hash] params ({})
|
2984
|
+
def start_bulk_disassociate_wireless_device_from_multicast_group(params = {}, options = {})
|
2985
|
+
req = build_request(:start_bulk_disassociate_wireless_device_from_multicast_group, params)
|
2986
|
+
req.send_request(options)
|
2987
|
+
end
|
2988
|
+
|
2989
|
+
# Starts a FUOTA task.
|
2990
|
+
#
|
2991
|
+
# @option params [required, String] :id
|
2992
|
+
# The ID of a FUOTA task.
|
2993
|
+
#
|
2994
|
+
# @option params [Types::LoRaWANStartFuotaTask] :lo_ra_wan
|
2995
|
+
# The LoRaWAN information used to start a FUOTA task.
|
2996
|
+
#
|
2997
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2998
|
+
#
|
2999
|
+
# @example Request syntax with placeholder values
|
3000
|
+
#
|
3001
|
+
# resp = client.start_fuota_task({
|
3002
|
+
# id: "FuotaTaskId", # required
|
3003
|
+
# lo_ra_wan: {
|
3004
|
+
# start_time: Time.now,
|
3005
|
+
# },
|
3006
|
+
# })
|
3007
|
+
#
|
3008
|
+
# @overload start_fuota_task(params = {})
|
3009
|
+
# @param [Hash] params ({})
|
3010
|
+
def start_fuota_task(params = {}, options = {})
|
3011
|
+
req = build_request(:start_fuota_task, params)
|
3012
|
+
req.send_request(options)
|
3013
|
+
end
|
3014
|
+
|
3015
|
+
# Starts a multicast group session.
|
3016
|
+
#
|
3017
|
+
# @option params [required, String] :id
|
3018
|
+
# The ID of the multicast group.
|
3019
|
+
#
|
3020
|
+
# @option params [required, Types::LoRaWANMulticastSession] :lo_ra_wan
|
3021
|
+
# The LoRaWAN information used with the multicast session.
|
3022
|
+
#
|
3023
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3024
|
+
#
|
3025
|
+
# @example Request syntax with placeholder values
|
3026
|
+
#
|
3027
|
+
# resp = client.start_multicast_group_session({
|
3028
|
+
# id: "MulticastGroupId", # required
|
3029
|
+
# lo_ra_wan: { # required
|
3030
|
+
# dl_dr: 1,
|
3031
|
+
# dl_freq: 1,
|
3032
|
+
# session_start_time: Time.now,
|
3033
|
+
# session_timeout: 1,
|
3034
|
+
# },
|
3035
|
+
# })
|
3036
|
+
#
|
3037
|
+
# @overload start_multicast_group_session(params = {})
|
3038
|
+
# @param [Hash] params ({})
|
3039
|
+
def start_multicast_group_session(params = {}, options = {})
|
3040
|
+
req = build_request(:start_multicast_group_session, params)
|
3041
|
+
req.send_request(options)
|
3042
|
+
end
|
3043
|
+
|
2214
3044
|
# Adds a tag to a resource.
|
2215
3045
|
#
|
2216
3046
|
# @option params [required, String] :resource_arn
|
@@ -2328,6 +3158,49 @@ module Aws::IoTWireless
|
|
2328
3158
|
req.send_request(options)
|
2329
3159
|
end
|
2330
3160
|
|
3161
|
+
# Updates properties of a FUOTA task.
|
3162
|
+
#
|
3163
|
+
# @option params [required, String] :id
|
3164
|
+
# The ID of a FUOTA task.
|
3165
|
+
#
|
3166
|
+
# @option params [String] :name
|
3167
|
+
# The name of a FUOTA task.
|
3168
|
+
#
|
3169
|
+
# @option params [String] :description
|
3170
|
+
# The description of the new resource.
|
3171
|
+
#
|
3172
|
+
# @option params [Types::LoRaWANFuotaTask] :lo_ra_wan
|
3173
|
+
# The LoRaWAN information used with a FUOTA task.
|
3174
|
+
#
|
3175
|
+
# @option params [String] :firmware_update_image
|
3176
|
+
# The S3 URI points to a firmware update image that is to be used with a
|
3177
|
+
# FUOTA task.
|
3178
|
+
#
|
3179
|
+
# @option params [String] :firmware_update_role
|
3180
|
+
# The firmware update role that is to be used with a FUOTA task.
|
3181
|
+
#
|
3182
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3183
|
+
#
|
3184
|
+
# @example Request syntax with placeholder values
|
3185
|
+
#
|
3186
|
+
# resp = client.update_fuota_task({
|
3187
|
+
# id: "FuotaTaskId", # required
|
3188
|
+
# name: "FuotaTaskName",
|
3189
|
+
# description: "Description",
|
3190
|
+
# lo_ra_wan: {
|
3191
|
+
# rf_region: "EU868", # accepts EU868, US915, AU915, AS923-1
|
3192
|
+
# },
|
3193
|
+
# firmware_update_image: "FirmwareUpdateImage",
|
3194
|
+
# firmware_update_role: "FirmwareUpdateRole",
|
3195
|
+
# })
|
3196
|
+
#
|
3197
|
+
# @overload update_fuota_task(params = {})
|
3198
|
+
# @param [Hash] params ({})
|
3199
|
+
def update_fuota_task(params = {}, options = {})
|
3200
|
+
req = build_request(:update_fuota_task, params)
|
3201
|
+
req.send_request(options)
|
3202
|
+
end
|
3203
|
+
|
2331
3204
|
# Set default log level, or log levels by resource types. This can be
|
2332
3205
|
# for wireless device log options or wireless gateways log options and
|
2333
3206
|
# is used to control the log messages that'll be displayed in
|
@@ -2381,6 +3254,84 @@ module Aws::IoTWireless
|
|
2381
3254
|
req.send_request(options)
|
2382
3255
|
end
|
2383
3256
|
|
3257
|
+
# Updates properties of a multicast group session.
|
3258
|
+
#
|
3259
|
+
# @option params [required, String] :id
|
3260
|
+
# The ID of the multicast group.
|
3261
|
+
#
|
3262
|
+
# @option params [String] :name
|
3263
|
+
# The name of the multicast group.
|
3264
|
+
#
|
3265
|
+
# @option params [String] :description
|
3266
|
+
# The description of the new resource.
|
3267
|
+
#
|
3268
|
+
# @option params [Types::LoRaWANMulticast] :lo_ra_wan
|
3269
|
+
# The LoRaWAN information that is to be used with the multicast group.
|
3270
|
+
#
|
3271
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3272
|
+
#
|
3273
|
+
# @example Request syntax with placeholder values
|
3274
|
+
#
|
3275
|
+
# resp = client.update_multicast_group({
|
3276
|
+
# id: "MulticastGroupId", # required
|
3277
|
+
# name: "MulticastGroupName",
|
3278
|
+
# description: "Description",
|
3279
|
+
# lo_ra_wan: {
|
3280
|
+
# rf_region: "EU868", # accepts EU868, US915, AU915, AS923-1
|
3281
|
+
# dl_class: "ClassB", # accepts ClassB, ClassC
|
3282
|
+
# },
|
3283
|
+
# })
|
3284
|
+
#
|
3285
|
+
# @overload update_multicast_group(params = {})
|
3286
|
+
# @param [Hash] params ({})
|
3287
|
+
def update_multicast_group(params = {}, options = {})
|
3288
|
+
req = build_request(:update_multicast_group, params)
|
3289
|
+
req.send_request(options)
|
3290
|
+
end
|
3291
|
+
|
3292
|
+
# Update NetworkAnalyzer configuration.
|
3293
|
+
#
|
3294
|
+
# @option params [required, String] :configuration_name
|
3295
|
+
# NetworkAnalyzer configuration name.
|
3296
|
+
#
|
3297
|
+
# @option params [Types::TraceContent] :trace_content
|
3298
|
+
# Trace Content for resources.
|
3299
|
+
#
|
3300
|
+
# @option params [Array<String>] :wireless_devices_to_add
|
3301
|
+
# WirelessDevices to add into NetworkAnalyzerConfiguration.
|
3302
|
+
#
|
3303
|
+
# @option params [Array<String>] :wireless_devices_to_remove
|
3304
|
+
# WirelessDevices to remove from NetworkAnalyzerConfiguration.
|
3305
|
+
#
|
3306
|
+
# @option params [Array<String>] :wireless_gateways_to_add
|
3307
|
+
# WirelessGateways to add into NetworkAnalyzerConfiguration.
|
3308
|
+
#
|
3309
|
+
# @option params [Array<String>] :wireless_gateways_to_remove
|
3310
|
+
# WirelessGateways to remove from NetworkAnalyzerConfiguration.
|
3311
|
+
#
|
3312
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3313
|
+
#
|
3314
|
+
# @example Request syntax with placeholder values
|
3315
|
+
#
|
3316
|
+
# resp = client.update_network_analyzer_configuration({
|
3317
|
+
# configuration_name: "NetworkAnalyzerConfigurationName", # required
|
3318
|
+
# trace_content: {
|
3319
|
+
# wireless_device_frame_info: "ENABLED", # accepts ENABLED, DISABLED
|
3320
|
+
# log_level: "INFO", # accepts INFO, ERROR, DISABLED
|
3321
|
+
# },
|
3322
|
+
# wireless_devices_to_add: ["WirelessDeviceId"],
|
3323
|
+
# wireless_devices_to_remove: ["WirelessDeviceId"],
|
3324
|
+
# wireless_gateways_to_add: ["WirelessGatewayId"],
|
3325
|
+
# wireless_gateways_to_remove: ["WirelessGatewayId"],
|
3326
|
+
# })
|
3327
|
+
#
|
3328
|
+
# @overload update_network_analyzer_configuration(params = {})
|
3329
|
+
# @param [Hash] params ({})
|
3330
|
+
def update_network_analyzer_configuration(params = {}, options = {})
|
3331
|
+
req = build_request(:update_network_analyzer_configuration, params)
|
3332
|
+
req.send_request(options)
|
3333
|
+
end
|
3334
|
+
|
2384
3335
|
# Updates properties of a partner account.
|
2385
3336
|
#
|
2386
3337
|
# @option params [required, Types::SidewalkUpdateAccount] :sidewalk
|
@@ -2411,6 +3362,52 @@ module Aws::IoTWireless
|
|
2411
3362
|
req.send_request(options)
|
2412
3363
|
end
|
2413
3364
|
|
3365
|
+
# Update the event configuration for a particular resource identifier.
|
3366
|
+
#
|
3367
|
+
# @option params [required, String] :identifier
|
3368
|
+
# Resource identifier to opt in for event messaging.
|
3369
|
+
#
|
3370
|
+
# @option params [required, String] :identifier_type
|
3371
|
+
# Identifier type of the particular resource identifier for event
|
3372
|
+
# configuration.
|
3373
|
+
#
|
3374
|
+
# @option params [String] :partner_type
|
3375
|
+
# Partner type of the resource if the identifier type is
|
3376
|
+
# PartnerAccountId
|
3377
|
+
#
|
3378
|
+
# @option params [Types::DeviceRegistrationStateEventConfiguration] :device_registration_state
|
3379
|
+
# Event configuration for the device registration state event
|
3380
|
+
#
|
3381
|
+
# @option params [Types::ProximityEventConfiguration] :proximity
|
3382
|
+
# Event configuration for the Proximity event
|
3383
|
+
#
|
3384
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3385
|
+
#
|
3386
|
+
# @example Request syntax with placeholder values
|
3387
|
+
#
|
3388
|
+
# resp = client.update_resource_event_configuration({
|
3389
|
+
# identifier: "Identifier", # required
|
3390
|
+
# identifier_type: "PartnerAccountId", # required, accepts PartnerAccountId
|
3391
|
+
# partner_type: "Sidewalk", # accepts Sidewalk
|
3392
|
+
# device_registration_state: {
|
3393
|
+
# sidewalk: {
|
3394
|
+
# amazon_id_event_topic: "Enabled", # accepts Enabled, Disabled
|
3395
|
+
# },
|
3396
|
+
# },
|
3397
|
+
# proximity: {
|
3398
|
+
# sidewalk: {
|
3399
|
+
# amazon_id_event_topic: "Enabled", # accepts Enabled, Disabled
|
3400
|
+
# },
|
3401
|
+
# },
|
3402
|
+
# })
|
3403
|
+
#
|
3404
|
+
# @overload update_resource_event_configuration(params = {})
|
3405
|
+
# @param [Hash] params ({})
|
3406
|
+
def update_resource_event_configuration(params = {}, options = {})
|
3407
|
+
req = build_request(:update_resource_event_configuration, params)
|
3408
|
+
req.send_request(options)
|
3409
|
+
end
|
3410
|
+
|
2414
3411
|
# Updates properties of a wireless device.
|
2415
3412
|
#
|
2416
3413
|
# @option params [required, String] :id
|
@@ -2502,7 +3499,7 @@ module Aws::IoTWireless
|
|
2502
3499
|
params: params,
|
2503
3500
|
config: config)
|
2504
3501
|
context[:gem_name] = 'aws-sdk-iotwireless'
|
2505
|
-
context[:gem_version] = '1.
|
3502
|
+
context[:gem_version] = '1.18.0'
|
2506
3503
|
Seahorse::Client::Request.new(handlers, context)
|
2507
3504
|
end
|
2508
3505
|
|