aws-sdk-greengrassv2 1.21.0 → 1.23.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +12 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-greengrassv2/client.rb +22 -2
- data/lib/aws-sdk-greengrassv2/client_api.rb +4 -0
- data/lib/aws-sdk-greengrassv2/endpoint_provider.rb +41 -106
- data/lib/aws-sdk-greengrassv2/types.rb +41 -779
- data/lib/aws-sdk-greengrassv2.rb +1 -1
- metadata +2 -2
@@ -31,13 +31,6 @@ module Aws::GreengrassV2
|
|
31
31
|
#
|
32
32
|
# [1]: https://docs.aws.amazon.com/greengrass/v2/APIReference/API_BatchAssociateClientDeviceWithCoreDevice.html
|
33
33
|
#
|
34
|
-
# @note When making an API call, you may pass AssociateClientDeviceWithCoreDeviceEntry
|
35
|
-
# data as a hash:
|
36
|
-
#
|
37
|
-
# {
|
38
|
-
# thing_name: "IoTThingName", # required
|
39
|
-
# }
|
40
|
-
#
|
41
34
|
# @!attribute [rw] thing_name
|
42
35
|
# The name of the IoT thing that represents the client device to
|
43
36
|
# associate.
|
@@ -82,13 +75,6 @@ module Aws::GreengrassV2
|
|
82
75
|
include Aws::Structure
|
83
76
|
end
|
84
77
|
|
85
|
-
# @note When making an API call, you may pass AssociateServiceRoleToAccountRequest
|
86
|
-
# data as a hash:
|
87
|
-
#
|
88
|
-
# {
|
89
|
-
# role_arn: "String", # required
|
90
|
-
# }
|
91
|
-
#
|
92
78
|
# @!attribute [rw] role_arn
|
93
79
|
# The Amazon Resource Name (ARN) of the service role to associate with
|
94
80
|
# IoT Greengrass for your Amazon Web Services account in this Amazon
|
@@ -139,18 +125,6 @@ module Aws::GreengrassV2
|
|
139
125
|
include Aws::Structure
|
140
126
|
end
|
141
127
|
|
142
|
-
# @note When making an API call, you may pass BatchAssociateClientDeviceWithCoreDeviceRequest
|
143
|
-
# data as a hash:
|
144
|
-
#
|
145
|
-
# {
|
146
|
-
# entries: [
|
147
|
-
# {
|
148
|
-
# thing_name: "IoTThingName", # required
|
149
|
-
# },
|
150
|
-
# ],
|
151
|
-
# core_device_thing_name: "IoTThingName", # required
|
152
|
-
# }
|
153
|
-
#
|
154
128
|
# @!attribute [rw] entries
|
155
129
|
# The list of client devices to associate.
|
156
130
|
# @return [Array<Types::AssociateClientDeviceWithCoreDeviceEntry>]
|
@@ -181,18 +155,6 @@ module Aws::GreengrassV2
|
|
181
155
|
include Aws::Structure
|
182
156
|
end
|
183
157
|
|
184
|
-
# @note When making an API call, you may pass BatchDisassociateClientDeviceFromCoreDeviceRequest
|
185
|
-
# data as a hash:
|
186
|
-
#
|
187
|
-
# {
|
188
|
-
# entries: [
|
189
|
-
# {
|
190
|
-
# thing_name: "IoTThingName", # required
|
191
|
-
# },
|
192
|
-
# ],
|
193
|
-
# core_device_thing_name: "IoTThingName", # required
|
194
|
-
# }
|
195
|
-
#
|
196
158
|
# @!attribute [rw] entries
|
197
159
|
# The list of client devices to disassociate.
|
198
160
|
# @return [Array<Types::DisassociateClientDeviceFromCoreDeviceEntry>]
|
@@ -224,13 +186,6 @@ module Aws::GreengrassV2
|
|
224
186
|
include Aws::Structure
|
225
187
|
end
|
226
188
|
|
227
|
-
# @note When making an API call, you may pass CancelDeploymentRequest
|
228
|
-
# data as a hash:
|
229
|
-
#
|
230
|
-
# {
|
231
|
-
# deployment_id: "NonEmptyString", # required
|
232
|
-
# }
|
233
|
-
#
|
234
189
|
# @!attribute [rw] deployment_id
|
235
190
|
# The ID of the deployment.
|
236
191
|
# @return [String]
|
@@ -343,17 +298,6 @@ module Aws::GreengrassV2
|
|
343
298
|
# Contains information about a component that is a candidate to deploy
|
344
299
|
# to a Greengrass core device.
|
345
300
|
#
|
346
|
-
# @note When making an API call, you may pass ComponentCandidate
|
347
|
-
# data as a hash:
|
348
|
-
#
|
349
|
-
# {
|
350
|
-
# component_name: "ComponentNameString",
|
351
|
-
# component_version: "ComponentVersionString",
|
352
|
-
# version_requirements: {
|
353
|
-
# "NonEmptyString" => "NonEmptyString",
|
354
|
-
# },
|
355
|
-
# }
|
356
|
-
#
|
357
301
|
# @!attribute [rw] component_name
|
358
302
|
# The name of the component.
|
359
303
|
# @return [String]
|
@@ -394,14 +338,6 @@ module Aws::GreengrassV2
|
|
394
338
|
#
|
395
339
|
# [1]: https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html
|
396
340
|
#
|
397
|
-
# @note When making an API call, you may pass ComponentConfigurationUpdate
|
398
|
-
# data as a hash:
|
399
|
-
#
|
400
|
-
# {
|
401
|
-
# merge: "ComponentConfigurationString",
|
402
|
-
# reset: ["ComponentConfigurationPath"],
|
403
|
-
# }
|
404
|
-
#
|
405
341
|
# @!attribute [rw] merge
|
406
342
|
# A serialized JSON string that contains the configuration object to
|
407
343
|
# merge to target devices. The core device merges this configuration
|
@@ -444,14 +380,6 @@ module Aws::GreengrassV2
|
|
444
380
|
# Contains information about a component dependency for a Lambda
|
445
381
|
# function component.
|
446
382
|
#
|
447
|
-
# @note When making an API call, you may pass ComponentDependencyRequirement
|
448
|
-
# data as a hash:
|
449
|
-
#
|
450
|
-
# {
|
451
|
-
# version_requirement: "NonEmptyString",
|
452
|
-
# dependency_type: "HARD", # accepts HARD, SOFT
|
453
|
-
# }
|
454
|
-
#
|
455
383
|
# @!attribute [rw] version_requirement
|
456
384
|
# The component version requirement for the component dependency.
|
457
385
|
#
|
@@ -485,25 +413,6 @@ module Aws::GreengrassV2
|
|
485
413
|
|
486
414
|
# Contains information about a component to deploy.
|
487
415
|
#
|
488
|
-
# @note When making an API call, you may pass ComponentDeploymentSpecification
|
489
|
-
# data as a hash:
|
490
|
-
#
|
491
|
-
# {
|
492
|
-
# component_version: "ComponentVersionString",
|
493
|
-
# configuration_update: {
|
494
|
-
# merge: "ComponentConfigurationString",
|
495
|
-
# reset: ["ComponentConfigurationPath"],
|
496
|
-
# },
|
497
|
-
# run_with: {
|
498
|
-
# posix_user: "NonEmptyString",
|
499
|
-
# system_resource_limits: {
|
500
|
-
# memory: 1,
|
501
|
-
# cpus: 1.0,
|
502
|
-
# },
|
503
|
-
# windows_user: "NonEmptyString",
|
504
|
-
# },
|
505
|
-
# }
|
506
|
-
#
|
507
416
|
# @!attribute [rw] component_version
|
508
417
|
# The version of the component.
|
509
418
|
# @return [String]
|
@@ -592,16 +501,6 @@ module Aws::GreengrassV2
|
|
592
501
|
|
593
502
|
# Contains information about a platform that a component supports.
|
594
503
|
#
|
595
|
-
# @note When making an API call, you may pass ComponentPlatform
|
596
|
-
# data as a hash:
|
597
|
-
#
|
598
|
-
# {
|
599
|
-
# name: "NonEmptyString",
|
600
|
-
# attributes: {
|
601
|
-
# "NonEmptyString" => "NonEmptyString",
|
602
|
-
# },
|
603
|
-
# }
|
604
|
-
#
|
605
504
|
# @!attribute [rw] name
|
606
505
|
# The friendly name of the platform. This name helps you identify the
|
607
506
|
# platform.
|
@@ -641,18 +540,6 @@ module Aws::GreengrassV2
|
|
641
540
|
#
|
642
541
|
# [1]: https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user
|
643
542
|
#
|
644
|
-
# @note When making an API call, you may pass ComponentRunWith
|
645
|
-
# data as a hash:
|
646
|
-
#
|
647
|
-
# {
|
648
|
-
# posix_user: "NonEmptyString",
|
649
|
-
# system_resource_limits: {
|
650
|
-
# memory: 1,
|
651
|
-
# cpus: 1.0,
|
652
|
-
# },
|
653
|
-
# windows_user: "NonEmptyString",
|
654
|
-
# }
|
655
|
-
#
|
656
543
|
# @!attribute [rw] posix_user
|
657
544
|
# The POSIX system user and, optionally, group to use to run this
|
658
545
|
# component on Linux core devices. The user, and group if specified,
|
@@ -768,16 +655,6 @@ module Aws::GreengrassV2
|
|
768
655
|
# Contains information about an endpoint and port where client devices
|
769
656
|
# can connect to an MQTT broker on a Greengrass core device.
|
770
657
|
#
|
771
|
-
# @note When making an API call, you may pass ConnectivityInfo
|
772
|
-
# data as a hash:
|
773
|
-
#
|
774
|
-
# {
|
775
|
-
# id: "String",
|
776
|
-
# host_address: "String",
|
777
|
-
# port_number: 1,
|
778
|
-
# metadata: "String",
|
779
|
-
# }
|
780
|
-
#
|
781
658
|
# @!attribute [rw] id
|
782
659
|
# An ID for the connectivity information.
|
783
660
|
# @return [String]
|
@@ -842,77 +719,6 @@ module Aws::GreengrassV2
|
|
842
719
|
include Aws::Structure
|
843
720
|
end
|
844
721
|
|
845
|
-
# @note When making an API call, you may pass CreateComponentVersionRequest
|
846
|
-
# data as a hash:
|
847
|
-
#
|
848
|
-
# {
|
849
|
-
# inline_recipe: "data",
|
850
|
-
# lambda_function: {
|
851
|
-
# lambda_arn: "NonEmptyString", # required
|
852
|
-
# component_name: "ComponentNameString",
|
853
|
-
# component_version: "ComponentVersionString",
|
854
|
-
# component_platforms: [
|
855
|
-
# {
|
856
|
-
# name: "NonEmptyString",
|
857
|
-
# attributes: {
|
858
|
-
# "NonEmptyString" => "NonEmptyString",
|
859
|
-
# },
|
860
|
-
# },
|
861
|
-
# ],
|
862
|
-
# component_dependencies: {
|
863
|
-
# "NonEmptyString" => {
|
864
|
-
# version_requirement: "NonEmptyString",
|
865
|
-
# dependency_type: "HARD", # accepts HARD, SOFT
|
866
|
-
# },
|
867
|
-
# },
|
868
|
-
# component_lambda_parameters: {
|
869
|
-
# event_sources: [
|
870
|
-
# {
|
871
|
-
# topic: "TopicString", # required
|
872
|
-
# type: "PUB_SUB", # required, accepts PUB_SUB, IOT_CORE
|
873
|
-
# },
|
874
|
-
# ],
|
875
|
-
# max_queue_size: 1,
|
876
|
-
# max_instances_count: 1,
|
877
|
-
# max_idle_time_in_seconds: 1,
|
878
|
-
# timeout_in_seconds: 1,
|
879
|
-
# status_timeout_in_seconds: 1,
|
880
|
-
# pinned: false,
|
881
|
-
# input_payload_encoding_type: "json", # accepts json, binary
|
882
|
-
# exec_args: ["LambdaExecArg"],
|
883
|
-
# environment_variables: {
|
884
|
-
# "NonEmptyString" => "String",
|
885
|
-
# },
|
886
|
-
# linux_process_params: {
|
887
|
-
# isolation_mode: "GreengrassContainer", # accepts GreengrassContainer, NoContainer
|
888
|
-
# container_params: {
|
889
|
-
# memory_size_in_kb: 1,
|
890
|
-
# mount_ro_sysfs: false,
|
891
|
-
# volumes: [
|
892
|
-
# {
|
893
|
-
# source_path: "FileSystemPath", # required
|
894
|
-
# destination_path: "FileSystemPath", # required
|
895
|
-
# permission: "ro", # accepts ro, rw
|
896
|
-
# add_group_owner: false,
|
897
|
-
# },
|
898
|
-
# ],
|
899
|
-
# devices: [
|
900
|
-
# {
|
901
|
-
# path: "FileSystemPath", # required
|
902
|
-
# permission: "ro", # accepts ro, rw
|
903
|
-
# add_group_owner: false,
|
904
|
-
# },
|
905
|
-
# ],
|
906
|
-
# },
|
907
|
-
# },
|
908
|
-
# },
|
909
|
-
# },
|
910
|
-
# tags: {
|
911
|
-
# "TagKey" => "TagValue",
|
912
|
-
# },
|
913
|
-
# client_token: "ClientTokenString",
|
914
|
-
# }
|
915
|
-
#
|
916
722
|
# @!attribute [rw] inline_recipe
|
917
723
|
# The recipe to use to create the component. The recipe defines the
|
918
724
|
# component's metadata, parameters, dependencies, lifecycle,
|
@@ -1001,73 +807,9 @@ module Aws::GreengrassV2
|
|
1001
807
|
include Aws::Structure
|
1002
808
|
end
|
1003
809
|
|
1004
|
-
# @note When making an API call, you may pass CreateDeploymentRequest
|
1005
|
-
# data as a hash:
|
1006
|
-
#
|
1007
|
-
# {
|
1008
|
-
# target_arn: "TargetARN", # required
|
1009
|
-
# deployment_name: "DeploymentNameString",
|
1010
|
-
# components: {
|
1011
|
-
# "NonEmptyString" => {
|
1012
|
-
# component_version: "ComponentVersionString",
|
1013
|
-
# configuration_update: {
|
1014
|
-
# merge: "ComponentConfigurationString",
|
1015
|
-
# reset: ["ComponentConfigurationPath"],
|
1016
|
-
# },
|
1017
|
-
# run_with: {
|
1018
|
-
# posix_user: "NonEmptyString",
|
1019
|
-
# system_resource_limits: {
|
1020
|
-
# memory: 1,
|
1021
|
-
# cpus: 1.0,
|
1022
|
-
# },
|
1023
|
-
# windows_user: "NonEmptyString",
|
1024
|
-
# },
|
1025
|
-
# },
|
1026
|
-
# },
|
1027
|
-
# iot_job_configuration: {
|
1028
|
-
# job_executions_rollout_config: {
|
1029
|
-
# exponential_rate: {
|
1030
|
-
# base_rate_per_minute: 1, # required
|
1031
|
-
# increment_factor: 1.0, # required
|
1032
|
-
# rate_increase_criteria: { # required
|
1033
|
-
# number_of_notified_things: 1,
|
1034
|
-
# number_of_succeeded_things: 1,
|
1035
|
-
# },
|
1036
|
-
# },
|
1037
|
-
# maximum_per_minute: 1,
|
1038
|
-
# },
|
1039
|
-
# abort_config: {
|
1040
|
-
# criteria_list: [ # required
|
1041
|
-
# {
|
1042
|
-
# failure_type: "FAILED", # required, accepts FAILED, REJECTED, TIMED_OUT, ALL
|
1043
|
-
# action: "CANCEL", # required, accepts CANCEL
|
1044
|
-
# threshold_percentage: 1.0, # required
|
1045
|
-
# min_number_of_executed_things: 1, # required
|
1046
|
-
# },
|
1047
|
-
# ],
|
1048
|
-
# },
|
1049
|
-
# timeout_config: {
|
1050
|
-
# in_progress_timeout_in_minutes: 1,
|
1051
|
-
# },
|
1052
|
-
# },
|
1053
|
-
# deployment_policies: {
|
1054
|
-
# failure_handling_policy: "ROLLBACK", # accepts ROLLBACK, DO_NOTHING
|
1055
|
-
# component_update_policy: {
|
1056
|
-
# timeout_in_seconds: 1,
|
1057
|
-
# action: "NOTIFY_COMPONENTS", # accepts NOTIFY_COMPONENTS, SKIP_NOTIFY_COMPONENTS
|
1058
|
-
# },
|
1059
|
-
# configuration_validation_policy: {
|
1060
|
-
# timeout_in_seconds: 1,
|
1061
|
-
# },
|
1062
|
-
# },
|
1063
|
-
# tags: {
|
1064
|
-
# "TagKey" => "TagValue",
|
1065
|
-
# },
|
1066
|
-
# client_token: "ClientTokenString",
|
1067
|
-
# }
|
1068
|
-
#
|
1069
810
|
# @!attribute [rw] target_arn
|
1070
|
-
# The [ARN][1] of the target IoT thing or thing group.
|
811
|
+
# The [ARN][1] of the target IoT thing or thing group. When creating a
|
812
|
+
# subdeployment, the targetARN can only be a thing group.
|
1071
813
|
#
|
1072
814
|
#
|
1073
815
|
#
|
@@ -1095,6 +837,14 @@ module Aws::GreengrassV2
|
|
1095
837
|
# how the deployment updates components and handles failure.
|
1096
838
|
# @return [Types::DeploymentPolicies]
|
1097
839
|
#
|
840
|
+
# @!attribute [rw] parent_target_arn
|
841
|
+
# The parent deployment's target [ARN][1] within a subdeployment.
|
842
|
+
#
|
843
|
+
#
|
844
|
+
#
|
845
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
846
|
+
# @return [String]
|
847
|
+
#
|
1098
848
|
# @!attribute [rw] tags
|
1099
849
|
# A list of key-value pairs that contain metadata for the resource.
|
1100
850
|
# For more information, see [Tag your resources][1] in the *IoT
|
@@ -1127,6 +877,7 @@ module Aws::GreengrassV2
|
|
1127
877
|
:components,
|
1128
878
|
:iot_job_configuration,
|
1129
879
|
:deployment_policies,
|
880
|
+
:parent_target_arn,
|
1130
881
|
:tags,
|
1131
882
|
:client_token)
|
1132
883
|
SENSITIVE = []
|
@@ -1160,13 +911,6 @@ module Aws::GreengrassV2
|
|
1160
911
|
include Aws::Structure
|
1161
912
|
end
|
1162
913
|
|
1163
|
-
# @note When making an API call, you may pass DeleteComponentRequest
|
1164
|
-
# data as a hash:
|
1165
|
-
#
|
1166
|
-
# {
|
1167
|
-
# arn: "ComponentVersionARN", # required
|
1168
|
-
# }
|
1169
|
-
#
|
1170
914
|
# @!attribute [rw] arn
|
1171
915
|
# The [ARN][1] of the component version.
|
1172
916
|
#
|
@@ -1183,13 +927,6 @@ module Aws::GreengrassV2
|
|
1183
927
|
include Aws::Structure
|
1184
928
|
end
|
1185
929
|
|
1186
|
-
# @note When making an API call, you may pass DeleteCoreDeviceRequest
|
1187
|
-
# data as a hash:
|
1188
|
-
#
|
1189
|
-
# {
|
1190
|
-
# core_device_thing_name: "CoreDeviceThingName", # required
|
1191
|
-
# }
|
1192
|
-
#
|
1193
930
|
# @!attribute [rw] core_device_thing_name
|
1194
931
|
# The name of the core device. This is also the name of the IoT thing.
|
1195
932
|
# @return [String]
|
@@ -1202,13 +939,6 @@ module Aws::GreengrassV2
|
|
1202
939
|
include Aws::Structure
|
1203
940
|
end
|
1204
941
|
|
1205
|
-
# @note When making an API call, you may pass DeleteDeploymentRequest
|
1206
|
-
# data as a hash:
|
1207
|
-
#
|
1208
|
-
# {
|
1209
|
-
# deployment_id: "NonEmptyString", # required
|
1210
|
-
# }
|
1211
|
-
#
|
1212
942
|
# @!attribute [rw] deployment_id
|
1213
943
|
# The ID of the deployment.
|
1214
944
|
# @return [String]
|
@@ -1224,7 +954,8 @@ module Aws::GreengrassV2
|
|
1224
954
|
# Contains information about a deployment.
|
1225
955
|
#
|
1226
956
|
# @!attribute [rw] target_arn
|
1227
|
-
# The [ARN][1] of the target IoT thing or thing group.
|
957
|
+
# The [ARN][1] of the target IoT thing or thing group. When creating a
|
958
|
+
# subdeployment, the targetARN can only be a thing group.
|
1228
959
|
#
|
1229
960
|
#
|
1230
961
|
#
|
@@ -1256,6 +987,14 @@ module Aws::GreengrassV2
|
|
1256
987
|
# Whether or not the deployment is the latest revision for its target.
|
1257
988
|
# @return [Boolean]
|
1258
989
|
#
|
990
|
+
# @!attribute [rw] parent_target_arn
|
991
|
+
# The parent deployment's target [ARN][1] within a subdeployment.
|
992
|
+
#
|
993
|
+
#
|
994
|
+
#
|
995
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
996
|
+
# @return [String]
|
997
|
+
#
|
1259
998
|
# @see http://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/Deployment AWS API Documentation
|
1260
999
|
#
|
1261
1000
|
class Deployment < Struct.new(
|
@@ -1265,7 +1004,8 @@ module Aws::GreengrassV2
|
|
1265
1004
|
:deployment_name,
|
1266
1005
|
:creation_timestamp,
|
1267
1006
|
:deployment_status,
|
1268
|
-
:is_latest_for_target
|
1007
|
+
:is_latest_for_target,
|
1008
|
+
:parent_target_arn)
|
1269
1009
|
SENSITIVE = []
|
1270
1010
|
include Aws::Structure
|
1271
1011
|
end
|
@@ -1280,14 +1020,6 @@ module Aws::GreengrassV2
|
|
1280
1020
|
# response. You specify the amount of time each component has to respond
|
1281
1021
|
# to the update notification.
|
1282
1022
|
#
|
1283
|
-
# @note When making an API call, you may pass DeploymentComponentUpdatePolicy
|
1284
|
-
# data as a hash:
|
1285
|
-
#
|
1286
|
-
# {
|
1287
|
-
# timeout_in_seconds: 1,
|
1288
|
-
# action: "NOTIFY_COMPONENTS", # accepts NOTIFY_COMPONENTS, SKIP_NOTIFY_COMPONENTS
|
1289
|
-
# }
|
1290
|
-
#
|
1291
1023
|
# @!attribute [rw] timeout_in_seconds
|
1292
1024
|
# The amount of time in seconds that each component on a device has to
|
1293
1025
|
# report that it's safe to update. If the component waits for longer
|
@@ -1344,13 +1076,6 @@ module Aws::GreengrassV2
|
|
1344
1076
|
# [2]: https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-sendconfigurationvalidityreport
|
1345
1077
|
# [3]: https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html
|
1346
1078
|
#
|
1347
|
-
# @note When making an API call, you may pass DeploymentConfigurationValidationPolicy
|
1348
|
-
# data as a hash:
|
1349
|
-
#
|
1350
|
-
# {
|
1351
|
-
# timeout_in_seconds: 1,
|
1352
|
-
# }
|
1353
|
-
#
|
1354
1079
|
# @!attribute [rw] timeout_in_seconds
|
1355
1080
|
# The amount of time in seconds that a component can validate its
|
1356
1081
|
# configuration updates. If the validation time exceeds this timeout,
|
@@ -1369,36 +1094,6 @@ module Aws::GreengrassV2
|
|
1369
1094
|
|
1370
1095
|
# Contains information about an IoT job configuration.
|
1371
1096
|
#
|
1372
|
-
# @note When making an API call, you may pass DeploymentIoTJobConfiguration
|
1373
|
-
# data as a hash:
|
1374
|
-
#
|
1375
|
-
# {
|
1376
|
-
# job_executions_rollout_config: {
|
1377
|
-
# exponential_rate: {
|
1378
|
-
# base_rate_per_minute: 1, # required
|
1379
|
-
# increment_factor: 1.0, # required
|
1380
|
-
# rate_increase_criteria: { # required
|
1381
|
-
# number_of_notified_things: 1,
|
1382
|
-
# number_of_succeeded_things: 1,
|
1383
|
-
# },
|
1384
|
-
# },
|
1385
|
-
# maximum_per_minute: 1,
|
1386
|
-
# },
|
1387
|
-
# abort_config: {
|
1388
|
-
# criteria_list: [ # required
|
1389
|
-
# {
|
1390
|
-
# failure_type: "FAILED", # required, accepts FAILED, REJECTED, TIMED_OUT, ALL
|
1391
|
-
# action: "CANCEL", # required, accepts CANCEL
|
1392
|
-
# threshold_percentage: 1.0, # required
|
1393
|
-
# min_number_of_executed_things: 1, # required
|
1394
|
-
# },
|
1395
|
-
# ],
|
1396
|
-
# },
|
1397
|
-
# timeout_config: {
|
1398
|
-
# in_progress_timeout_in_minutes: 1,
|
1399
|
-
# },
|
1400
|
-
# }
|
1401
|
-
#
|
1402
1097
|
# @!attribute [rw] job_executions_rollout_config
|
1403
1098
|
# The rollout configuration for the job. This configuration defines
|
1404
1099
|
# the rate at which the job rolls out to the fleet of target devices.
|
@@ -1427,20 +1122,6 @@ module Aws::GreengrassV2
|
|
1427
1122
|
# Contains information about policies that define how a deployment
|
1428
1123
|
# updates components and handles failure.
|
1429
1124
|
#
|
1430
|
-
# @note When making an API call, you may pass DeploymentPolicies
|
1431
|
-
# data as a hash:
|
1432
|
-
#
|
1433
|
-
# {
|
1434
|
-
# failure_handling_policy: "ROLLBACK", # accepts ROLLBACK, DO_NOTHING
|
1435
|
-
# component_update_policy: {
|
1436
|
-
# timeout_in_seconds: 1,
|
1437
|
-
# action: "NOTIFY_COMPONENTS", # accepts NOTIFY_COMPONENTS, SKIP_NOTIFY_COMPONENTS
|
1438
|
-
# },
|
1439
|
-
# configuration_validation_policy: {
|
1440
|
-
# timeout_in_seconds: 1,
|
1441
|
-
# },
|
1442
|
-
# }
|
1443
|
-
#
|
1444
1125
|
# @!attribute [rw] failure_handling_policy
|
1445
1126
|
# The failure handling policy for the configuration deployment. This
|
1446
1127
|
# policy defines what to do if the deployment fails.
|
@@ -1470,13 +1151,6 @@ module Aws::GreengrassV2
|
|
1470
1151
|
include Aws::Structure
|
1471
1152
|
end
|
1472
1153
|
|
1473
|
-
# @note When making an API call, you may pass DescribeComponentRequest
|
1474
|
-
# data as a hash:
|
1475
|
-
#
|
1476
|
-
# {
|
1477
|
-
# arn: "ComponentVersionARN", # required
|
1478
|
-
# }
|
1479
|
-
#
|
1480
1154
|
# @!attribute [rw] arn
|
1481
1155
|
# The [ARN][1] of the component version.
|
1482
1156
|
#
|
@@ -1566,13 +1240,6 @@ module Aws::GreengrassV2
|
|
1566
1240
|
#
|
1567
1241
|
# [1]: https://docs.aws.amazon.com/greengrass/v2/APIReference/API_BatchDisassociateClientDeviceWithCoreDevice.html
|
1568
1242
|
#
|
1569
|
-
# @note When making an API call, you may pass DisassociateClientDeviceFromCoreDeviceEntry
|
1570
|
-
# data as a hash:
|
1571
|
-
#
|
1572
|
-
# {
|
1573
|
-
# thing_name: "IoTThingName", # required
|
1574
|
-
# }
|
1575
|
-
#
|
1576
1243
|
# @!attribute [rw] thing_name
|
1577
1244
|
# The name of the IoT thing that represents the client device to
|
1578
1245
|
# disassociate.
|
@@ -1746,14 +1413,6 @@ module Aws::GreengrassV2
|
|
1746
1413
|
include Aws::Structure
|
1747
1414
|
end
|
1748
1415
|
|
1749
|
-
# @note When making an API call, you may pass GetComponentRequest
|
1750
|
-
# data as a hash:
|
1751
|
-
#
|
1752
|
-
# {
|
1753
|
-
# recipe_output_format: "JSON", # accepts JSON, YAML
|
1754
|
-
# arn: "ComponentVersionARN", # required
|
1755
|
-
# }
|
1756
|
-
#
|
1757
1416
|
# @!attribute [rw] recipe_output_format
|
1758
1417
|
# The format of the recipe.
|
1759
1418
|
# @return [String]
|
@@ -1803,14 +1462,6 @@ module Aws::GreengrassV2
|
|
1803
1462
|
include Aws::Structure
|
1804
1463
|
end
|
1805
1464
|
|
1806
|
-
# @note When making an API call, you may pass GetComponentVersionArtifactRequest
|
1807
|
-
# data as a hash:
|
1808
|
-
#
|
1809
|
-
# {
|
1810
|
-
# arn: "ComponentVersionARN", # required
|
1811
|
-
# artifact_name: "NonEmptyString", # required
|
1812
|
-
# }
|
1813
|
-
#
|
1814
1465
|
# @!attribute [rw] arn
|
1815
1466
|
# The [ARN][1] of the component version. Specify the ARN of a public
|
1816
1467
|
# or a Lambda component version.
|
@@ -1855,13 +1506,6 @@ module Aws::GreengrassV2
|
|
1855
1506
|
include Aws::Structure
|
1856
1507
|
end
|
1857
1508
|
|
1858
|
-
# @note When making an API call, you may pass GetConnectivityInfoRequest
|
1859
|
-
# data as a hash:
|
1860
|
-
#
|
1861
|
-
# {
|
1862
|
-
# thing_name: "CoreDeviceThingName", # required
|
1863
|
-
# }
|
1864
|
-
#
|
1865
1509
|
# @!attribute [rw] thing_name
|
1866
1510
|
# The name of the core device. This is also the name of the IoT thing.
|
1867
1511
|
# @return [String]
|
@@ -1891,13 +1535,6 @@ module Aws::GreengrassV2
|
|
1891
1535
|
include Aws::Structure
|
1892
1536
|
end
|
1893
1537
|
|
1894
|
-
# @note When making an API call, you may pass GetCoreDeviceRequest
|
1895
|
-
# data as a hash:
|
1896
|
-
#
|
1897
|
-
# {
|
1898
|
-
# core_device_thing_name: "CoreDeviceThingName", # required
|
1899
|
-
# }
|
1900
|
-
#
|
1901
1538
|
# @!attribute [rw] core_device_thing_name
|
1902
1539
|
# The name of the core device. This is also the name of the IoT thing.
|
1903
1540
|
# @return [String]
|
@@ -1973,13 +1610,6 @@ module Aws::GreengrassV2
|
|
1973
1610
|
include Aws::Structure
|
1974
1611
|
end
|
1975
1612
|
|
1976
|
-
# @note When making an API call, you may pass GetDeploymentRequest
|
1977
|
-
# data as a hash:
|
1978
|
-
#
|
1979
|
-
# {
|
1980
|
-
# deployment_id: "NonEmptyString", # required
|
1981
|
-
# }
|
1982
|
-
#
|
1983
1613
|
# @!attribute [rw] deployment_id
|
1984
1614
|
# The ID of the deployment.
|
1985
1615
|
# @return [String]
|
@@ -2055,6 +1685,14 @@ module Aws::GreengrassV2
|
|
2055
1685
|
# Whether or not the deployment is the latest revision for its target.
|
2056
1686
|
# @return [Boolean]
|
2057
1687
|
#
|
1688
|
+
# @!attribute [rw] parent_target_arn
|
1689
|
+
# The parent deployment's target [ARN][1] within a subdeployment.
|
1690
|
+
#
|
1691
|
+
#
|
1692
|
+
#
|
1693
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
1694
|
+
# @return [String]
|
1695
|
+
#
|
2058
1696
|
# @!attribute [rw] tags
|
2059
1697
|
# A list of key-value pairs that contain metadata for the resource.
|
2060
1698
|
# For more information, see [Tag your resources][1] in the *IoT
|
@@ -2080,6 +1718,7 @@ module Aws::GreengrassV2
|
|
2080
1718
|
:iot_job_configuration,
|
2081
1719
|
:creation_timestamp,
|
2082
1720
|
:is_latest_for_target,
|
1721
|
+
:parent_target_arn,
|
2083
1722
|
:tags)
|
2084
1723
|
SENSITIVE = []
|
2085
1724
|
include Aws::Structure
|
@@ -2207,20 +1846,6 @@ module Aws::GreengrassV2
|
|
2207
1846
|
# Contains a list of criteria that define when and how to cancel a
|
2208
1847
|
# configuration deployment.
|
2209
1848
|
#
|
2210
|
-
# @note When making an API call, you may pass IoTJobAbortConfig
|
2211
|
-
# data as a hash:
|
2212
|
-
#
|
2213
|
-
# {
|
2214
|
-
# criteria_list: [ # required
|
2215
|
-
# {
|
2216
|
-
# failure_type: "FAILED", # required, accepts FAILED, REJECTED, TIMED_OUT, ALL
|
2217
|
-
# action: "CANCEL", # required, accepts CANCEL
|
2218
|
-
# threshold_percentage: 1.0, # required
|
2219
|
-
# min_number_of_executed_things: 1, # required
|
2220
|
-
# },
|
2221
|
-
# ],
|
2222
|
-
# }
|
2223
|
-
#
|
2224
1849
|
# @!attribute [rw] criteria_list
|
2225
1850
|
# The list of criteria that define when and how to cancel the
|
2226
1851
|
# configuration deployment.
|
@@ -2244,16 +1869,6 @@ module Aws::GreengrassV2
|
|
2244
1869
|
# 2. The percentage of failures with type `failureType` exceeds the
|
2245
1870
|
# `thresholdPercentage`.
|
2246
1871
|
#
|
2247
|
-
# @note When making an API call, you may pass IoTJobAbortCriteria
|
2248
|
-
# data as a hash:
|
2249
|
-
#
|
2250
|
-
# {
|
2251
|
-
# failure_type: "FAILED", # required, accepts FAILED, REJECTED, TIMED_OUT, ALL
|
2252
|
-
# action: "CANCEL", # required, accepts CANCEL
|
2253
|
-
# threshold_percentage: 1.0, # required
|
2254
|
-
# min_number_of_executed_things: 1, # required
|
2255
|
-
# }
|
2256
|
-
#
|
2257
1872
|
# @!attribute [rw] failure_type
|
2258
1873
|
# The type of job deployment failure that can cancel a job.
|
2259
1874
|
# @return [String]
|
@@ -2290,21 +1905,6 @@ module Aws::GreengrassV2
|
|
2290
1905
|
# configuration defines the rate at which the job deploys a
|
2291
1906
|
# configuration to a fleet of target devices.
|
2292
1907
|
#
|
2293
|
-
# @note When making an API call, you may pass IoTJobExecutionsRolloutConfig
|
2294
|
-
# data as a hash:
|
2295
|
-
#
|
2296
|
-
# {
|
2297
|
-
# exponential_rate: {
|
2298
|
-
# base_rate_per_minute: 1, # required
|
2299
|
-
# increment_factor: 1.0, # required
|
2300
|
-
# rate_increase_criteria: { # required
|
2301
|
-
# number_of_notified_things: 1,
|
2302
|
-
# number_of_succeeded_things: 1,
|
2303
|
-
# },
|
2304
|
-
# },
|
2305
|
-
# maximum_per_minute: 1,
|
2306
|
-
# }
|
2307
|
-
#
|
2308
1908
|
# @!attribute [rw] exponential_rate
|
2309
1909
|
# The exponential rate to increase the job rollout rate.
|
2310
1910
|
# @return [Types::IoTJobExponentialRolloutRate]
|
@@ -2326,18 +1926,6 @@ module Aws::GreengrassV2
|
|
2326
1926
|
# Contains information about an exponential rollout rate for a
|
2327
1927
|
# configuration deployment job.
|
2328
1928
|
#
|
2329
|
-
# @note When making an API call, you may pass IoTJobExponentialRolloutRate
|
2330
|
-
# data as a hash:
|
2331
|
-
#
|
2332
|
-
# {
|
2333
|
-
# base_rate_per_minute: 1, # required
|
2334
|
-
# increment_factor: 1.0, # required
|
2335
|
-
# rate_increase_criteria: { # required
|
2336
|
-
# number_of_notified_things: 1,
|
2337
|
-
# number_of_succeeded_things: 1,
|
2338
|
-
# },
|
2339
|
-
# }
|
2340
|
-
#
|
2341
1929
|
# @!attribute [rw] base_rate_per_minute
|
2342
1930
|
# The minimum number of devices that receive a pending job
|
2343
1931
|
# notification, per minute, when the job starts. This parameter
|
@@ -2369,14 +1957,6 @@ module Aws::GreengrassV2
|
|
2369
1957
|
# rollout rate. Specify either `numberOfNotifiedThings` or
|
2370
1958
|
# `numberOfSucceededThings`.
|
2371
1959
|
#
|
2372
|
-
# @note When making an API call, you may pass IoTJobRateIncreaseCriteria
|
2373
|
-
# data as a hash:
|
2374
|
-
#
|
2375
|
-
# {
|
2376
|
-
# number_of_notified_things: 1,
|
2377
|
-
# number_of_succeeded_things: 1,
|
2378
|
-
# }
|
2379
|
-
#
|
2380
1960
|
# @!attribute [rw] number_of_notified_things
|
2381
1961
|
# The number of devices to receive the job notification before the
|
2382
1962
|
# rollout rate increases.
|
@@ -2398,13 +1978,6 @@ module Aws::GreengrassV2
|
|
2398
1978
|
|
2399
1979
|
# Contains information about the timeout configuration for a job.
|
2400
1980
|
#
|
2401
|
-
# @note When making an API call, you may pass IoTJobTimeoutConfig
|
2402
|
-
# data as a hash:
|
2403
|
-
#
|
2404
|
-
# {
|
2405
|
-
# in_progress_timeout_in_minutes: 1,
|
2406
|
-
# }
|
2407
|
-
#
|
2408
1981
|
# @!attribute [rw] in_progress_timeout_in_minutes
|
2409
1982
|
# The amount of time, in minutes, that devices have to complete the
|
2410
1983
|
# job. The timer starts when the job status is set to `IN_PROGRESS`.
|
@@ -2426,29 +1999,6 @@ module Aws::GreengrassV2
|
|
2426
1999
|
# Contains information about a container in which Lambda functions run
|
2427
2000
|
# on Greengrass core devices.
|
2428
2001
|
#
|
2429
|
-
# @note When making an API call, you may pass LambdaContainerParams
|
2430
|
-
# data as a hash:
|
2431
|
-
#
|
2432
|
-
# {
|
2433
|
-
# memory_size_in_kb: 1,
|
2434
|
-
# mount_ro_sysfs: false,
|
2435
|
-
# volumes: [
|
2436
|
-
# {
|
2437
|
-
# source_path: "FileSystemPath", # required
|
2438
|
-
# destination_path: "FileSystemPath", # required
|
2439
|
-
# permission: "ro", # accepts ro, rw
|
2440
|
-
# add_group_owner: false,
|
2441
|
-
# },
|
2442
|
-
# ],
|
2443
|
-
# devices: [
|
2444
|
-
# {
|
2445
|
-
# path: "FileSystemPath", # required
|
2446
|
-
# permission: "ro", # accepts ro, rw
|
2447
|
-
# add_group_owner: false,
|
2448
|
-
# },
|
2449
|
-
# ],
|
2450
|
-
# }
|
2451
|
-
#
|
2452
2002
|
# @!attribute [rw] memory_size_in_kb
|
2453
2003
|
# The memory size of the container, expressed in kilobytes.
|
2454
2004
|
#
|
@@ -2484,15 +2034,6 @@ module Aws::GreengrassV2
|
|
2484
2034
|
# Contains information about a device that Linux processes in a
|
2485
2035
|
# container can access.
|
2486
2036
|
#
|
2487
|
-
# @note When making an API call, you may pass LambdaDeviceMount
|
2488
|
-
# data as a hash:
|
2489
|
-
#
|
2490
|
-
# {
|
2491
|
-
# path: "FileSystemPath", # required
|
2492
|
-
# permission: "ro", # accepts ro, rw
|
2493
|
-
# add_group_owner: false,
|
2494
|
-
# }
|
2495
|
-
#
|
2496
2037
|
# @!attribute [rw] path
|
2497
2038
|
# The mount path for the device in the file system.
|
2498
2039
|
# @return [String]
|
@@ -2525,14 +2066,6 @@ module Aws::GreengrassV2
|
|
2525
2066
|
# event source defines the topics on which this Lambda function
|
2526
2067
|
# subscribes to receive messages that run the function.
|
2527
2068
|
#
|
2528
|
-
# @note When making an API call, you may pass LambdaEventSource
|
2529
|
-
# data as a hash:
|
2530
|
-
#
|
2531
|
-
# {
|
2532
|
-
# topic: "TopicString", # required
|
2533
|
-
# type: "PUB_SUB", # required, accepts PUB_SUB, IOT_CORE
|
2534
|
-
# }
|
2535
|
-
#
|
2536
2069
|
# @!attribute [rw] topic
|
2537
2070
|
# The topic to which to subscribe to receive event messages.
|
2538
2071
|
# @return [String]
|
@@ -2560,51 +2093,6 @@ module Aws::GreengrassV2
|
|
2560
2093
|
|
2561
2094
|
# Contains parameters for a Lambda function that runs on IoT Greengrass.
|
2562
2095
|
#
|
2563
|
-
# @note When making an API call, you may pass LambdaExecutionParameters
|
2564
|
-
# data as a hash:
|
2565
|
-
#
|
2566
|
-
# {
|
2567
|
-
# event_sources: [
|
2568
|
-
# {
|
2569
|
-
# topic: "TopicString", # required
|
2570
|
-
# type: "PUB_SUB", # required, accepts PUB_SUB, IOT_CORE
|
2571
|
-
# },
|
2572
|
-
# ],
|
2573
|
-
# max_queue_size: 1,
|
2574
|
-
# max_instances_count: 1,
|
2575
|
-
# max_idle_time_in_seconds: 1,
|
2576
|
-
# timeout_in_seconds: 1,
|
2577
|
-
# status_timeout_in_seconds: 1,
|
2578
|
-
# pinned: false,
|
2579
|
-
# input_payload_encoding_type: "json", # accepts json, binary
|
2580
|
-
# exec_args: ["LambdaExecArg"],
|
2581
|
-
# environment_variables: {
|
2582
|
-
# "NonEmptyString" => "String",
|
2583
|
-
# },
|
2584
|
-
# linux_process_params: {
|
2585
|
-
# isolation_mode: "GreengrassContainer", # accepts GreengrassContainer, NoContainer
|
2586
|
-
# container_params: {
|
2587
|
-
# memory_size_in_kb: 1,
|
2588
|
-
# mount_ro_sysfs: false,
|
2589
|
-
# volumes: [
|
2590
|
-
# {
|
2591
|
-
# source_path: "FileSystemPath", # required
|
2592
|
-
# destination_path: "FileSystemPath", # required
|
2593
|
-
# permission: "ro", # accepts ro, rw
|
2594
|
-
# add_group_owner: false,
|
2595
|
-
# },
|
2596
|
-
# ],
|
2597
|
-
# devices: [
|
2598
|
-
# {
|
2599
|
-
# path: "FileSystemPath", # required
|
2600
|
-
# permission: "ro", # accepts ro, rw
|
2601
|
-
# add_group_owner: false,
|
2602
|
-
# },
|
2603
|
-
# ],
|
2604
|
-
# },
|
2605
|
-
# },
|
2606
|
-
# }
|
2607
|
-
#
|
2608
2096
|
# @!attribute [rw] event_sources
|
2609
2097
|
# The list of event sources to which to subscribe to receive work
|
2610
2098
|
# messages. The Lambda function runs when it receives a message from
|
@@ -2697,70 +2185,6 @@ module Aws::GreengrassV2
|
|
2697
2185
|
# Contains information about an Lambda function to import to create a
|
2698
2186
|
# component.
|
2699
2187
|
#
|
2700
|
-
# @note When making an API call, you may pass LambdaFunctionRecipeSource
|
2701
|
-
# data as a hash:
|
2702
|
-
#
|
2703
|
-
# {
|
2704
|
-
# lambda_arn: "NonEmptyString", # required
|
2705
|
-
# component_name: "ComponentNameString",
|
2706
|
-
# component_version: "ComponentVersionString",
|
2707
|
-
# component_platforms: [
|
2708
|
-
# {
|
2709
|
-
# name: "NonEmptyString",
|
2710
|
-
# attributes: {
|
2711
|
-
# "NonEmptyString" => "NonEmptyString",
|
2712
|
-
# },
|
2713
|
-
# },
|
2714
|
-
# ],
|
2715
|
-
# component_dependencies: {
|
2716
|
-
# "NonEmptyString" => {
|
2717
|
-
# version_requirement: "NonEmptyString",
|
2718
|
-
# dependency_type: "HARD", # accepts HARD, SOFT
|
2719
|
-
# },
|
2720
|
-
# },
|
2721
|
-
# component_lambda_parameters: {
|
2722
|
-
# event_sources: [
|
2723
|
-
# {
|
2724
|
-
# topic: "TopicString", # required
|
2725
|
-
# type: "PUB_SUB", # required, accepts PUB_SUB, IOT_CORE
|
2726
|
-
# },
|
2727
|
-
# ],
|
2728
|
-
# max_queue_size: 1,
|
2729
|
-
# max_instances_count: 1,
|
2730
|
-
# max_idle_time_in_seconds: 1,
|
2731
|
-
# timeout_in_seconds: 1,
|
2732
|
-
# status_timeout_in_seconds: 1,
|
2733
|
-
# pinned: false,
|
2734
|
-
# input_payload_encoding_type: "json", # accepts json, binary
|
2735
|
-
# exec_args: ["LambdaExecArg"],
|
2736
|
-
# environment_variables: {
|
2737
|
-
# "NonEmptyString" => "String",
|
2738
|
-
# },
|
2739
|
-
# linux_process_params: {
|
2740
|
-
# isolation_mode: "GreengrassContainer", # accepts GreengrassContainer, NoContainer
|
2741
|
-
# container_params: {
|
2742
|
-
# memory_size_in_kb: 1,
|
2743
|
-
# mount_ro_sysfs: false,
|
2744
|
-
# volumes: [
|
2745
|
-
# {
|
2746
|
-
# source_path: "FileSystemPath", # required
|
2747
|
-
# destination_path: "FileSystemPath", # required
|
2748
|
-
# permission: "ro", # accepts ro, rw
|
2749
|
-
# add_group_owner: false,
|
2750
|
-
# },
|
2751
|
-
# ],
|
2752
|
-
# devices: [
|
2753
|
-
# {
|
2754
|
-
# path: "FileSystemPath", # required
|
2755
|
-
# permission: "ro", # accepts ro, rw
|
2756
|
-
# add_group_owner: false,
|
2757
|
-
# },
|
2758
|
-
# ],
|
2759
|
-
# },
|
2760
|
-
# },
|
2761
|
-
# },
|
2762
|
-
# }
|
2763
|
-
#
|
2764
2188
|
# @!attribute [rw] lambda_arn
|
2765
2189
|
# The [ARN][1] of the Lambda function. The ARN must include the
|
2766
2190
|
# version of the function to import. You can't use version aliases
|
@@ -2815,32 +2239,6 @@ module Aws::GreengrassV2
|
|
2815
2239
|
# Contains parameters for a Linux process that contains an Lambda
|
2816
2240
|
# function.
|
2817
2241
|
#
|
2818
|
-
# @note When making an API call, you may pass LambdaLinuxProcessParams
|
2819
|
-
# data as a hash:
|
2820
|
-
#
|
2821
|
-
# {
|
2822
|
-
# isolation_mode: "GreengrassContainer", # accepts GreengrassContainer, NoContainer
|
2823
|
-
# container_params: {
|
2824
|
-
# memory_size_in_kb: 1,
|
2825
|
-
# mount_ro_sysfs: false,
|
2826
|
-
# volumes: [
|
2827
|
-
# {
|
2828
|
-
# source_path: "FileSystemPath", # required
|
2829
|
-
# destination_path: "FileSystemPath", # required
|
2830
|
-
# permission: "ro", # accepts ro, rw
|
2831
|
-
# add_group_owner: false,
|
2832
|
-
# },
|
2833
|
-
# ],
|
2834
|
-
# devices: [
|
2835
|
-
# {
|
2836
|
-
# path: "FileSystemPath", # required
|
2837
|
-
# permission: "ro", # accepts ro, rw
|
2838
|
-
# add_group_owner: false,
|
2839
|
-
# },
|
2840
|
-
# ],
|
2841
|
-
# },
|
2842
|
-
# }
|
2843
|
-
#
|
2844
2242
|
# @!attribute [rw] isolation_mode
|
2845
2243
|
# The isolation mode for the process that contains the Lambda
|
2846
2244
|
# function. The process can run in an isolated runtime environment
|
@@ -2868,16 +2266,6 @@ module Aws::GreengrassV2
|
|
2868
2266
|
# Core software mounts the source files to the destination inside the
|
2869
2267
|
# container.
|
2870
2268
|
#
|
2871
|
-
# @note When making an API call, you may pass LambdaVolumeMount
|
2872
|
-
# data as a hash:
|
2873
|
-
#
|
2874
|
-
# {
|
2875
|
-
# source_path: "FileSystemPath", # required
|
2876
|
-
# destination_path: "FileSystemPath", # required
|
2877
|
-
# permission: "ro", # accepts ro, rw
|
2878
|
-
# add_group_owner: false,
|
2879
|
-
# }
|
2880
|
-
#
|
2881
2269
|
# @!attribute [rw] source_path
|
2882
2270
|
# The path to the physical volume in the file system.
|
2883
2271
|
# @return [String]
|
@@ -2911,15 +2299,6 @@ module Aws::GreengrassV2
|
|
2911
2299
|
include Aws::Structure
|
2912
2300
|
end
|
2913
2301
|
|
2914
|
-
# @note When making an API call, you may pass ListClientDevicesAssociatedWithCoreDeviceRequest
|
2915
|
-
# data as a hash:
|
2916
|
-
#
|
2917
|
-
# {
|
2918
|
-
# core_device_thing_name: "IoTThingName", # required
|
2919
|
-
# max_results: 1,
|
2920
|
-
# next_token: "NextTokenString",
|
2921
|
-
# }
|
2922
|
-
#
|
2923
2302
|
# @!attribute [rw] core_device_thing_name
|
2924
2303
|
# The name of the core device. This is also the name of the IoT thing.
|
2925
2304
|
# @return [String]
|
@@ -2961,15 +2340,6 @@ module Aws::GreengrassV2
|
|
2961
2340
|
include Aws::Structure
|
2962
2341
|
end
|
2963
2342
|
|
2964
|
-
# @note When making an API call, you may pass ListComponentVersionsRequest
|
2965
|
-
# data as a hash:
|
2966
|
-
#
|
2967
|
-
# {
|
2968
|
-
# arn: "ComponentARN", # required
|
2969
|
-
# max_results: 1,
|
2970
|
-
# next_token: "NextTokenString",
|
2971
|
-
# }
|
2972
|
-
#
|
2973
2343
|
# @!attribute [rw] arn
|
2974
2344
|
# The [ARN][1] of the component.
|
2975
2345
|
#
|
@@ -3014,15 +2384,6 @@ module Aws::GreengrassV2
|
|
3014
2384
|
include Aws::Structure
|
3015
2385
|
end
|
3016
2386
|
|
3017
|
-
# @note When making an API call, you may pass ListComponentsRequest
|
3018
|
-
# data as a hash:
|
3019
|
-
#
|
3020
|
-
# {
|
3021
|
-
# scope: "PRIVATE", # accepts PRIVATE, PUBLIC
|
3022
|
-
# max_results: 1,
|
3023
|
-
# next_token: "NextTokenString",
|
3024
|
-
# }
|
3025
|
-
#
|
3026
2387
|
# @!attribute [rw] scope
|
3027
2388
|
# The scope of the components to list.
|
3028
2389
|
#
|
@@ -3065,16 +2426,6 @@ module Aws::GreengrassV2
|
|
3065
2426
|
include Aws::Structure
|
3066
2427
|
end
|
3067
2428
|
|
3068
|
-
# @note When making an API call, you may pass ListCoreDevicesRequest
|
3069
|
-
# data as a hash:
|
3070
|
-
#
|
3071
|
-
# {
|
3072
|
-
# thing_group_arn: "ThingGroupARN",
|
3073
|
-
# status: "HEALTHY", # accepts HEALTHY, UNHEALTHY
|
3074
|
-
# max_results: 1,
|
3075
|
-
# next_token: "NextTokenString",
|
3076
|
-
# }
|
3077
|
-
#
|
3078
2429
|
# @!attribute [rw] thing_group_arn
|
3079
2430
|
# The [ARN][1] of the IoT thing group by which to filter. If you
|
3080
2431
|
# specify this parameter, the list includes only core devices that
|
@@ -3136,16 +2487,6 @@ module Aws::GreengrassV2
|
|
3136
2487
|
include Aws::Structure
|
3137
2488
|
end
|
3138
2489
|
|
3139
|
-
# @note When making an API call, you may pass ListDeploymentsRequest
|
3140
|
-
# data as a hash:
|
3141
|
-
#
|
3142
|
-
# {
|
3143
|
-
# target_arn: "TargetARN",
|
3144
|
-
# history_filter: "ALL", # accepts ALL, LATEST_ONLY
|
3145
|
-
# max_results: 1,
|
3146
|
-
# next_token: "NextTokenString",
|
3147
|
-
# }
|
3148
|
-
#
|
3149
2490
|
# @!attribute [rw] target_arn
|
3150
2491
|
# The [ARN][1] of the target IoT thing or thing group.
|
3151
2492
|
#
|
@@ -3166,6 +2507,14 @@ module Aws::GreengrassV2
|
|
3166
2507
|
# Default: `LATEST_ONLY`
|
3167
2508
|
# @return [String]
|
3168
2509
|
#
|
2510
|
+
# @!attribute [rw] parent_target_arn
|
2511
|
+
# The parent deployment's target [ARN][1] within a subdeployment.
|
2512
|
+
#
|
2513
|
+
#
|
2514
|
+
#
|
2515
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
2516
|
+
# @return [String]
|
2517
|
+
#
|
3169
2518
|
# @!attribute [rw] max_results
|
3170
2519
|
# The maximum number of results to be returned per paginated request.
|
3171
2520
|
# @return [Integer]
|
@@ -3179,6 +2528,7 @@ module Aws::GreengrassV2
|
|
3179
2528
|
class ListDeploymentsRequest < Struct.new(
|
3180
2529
|
:target_arn,
|
3181
2530
|
:history_filter,
|
2531
|
+
:parent_target_arn,
|
3182
2532
|
:max_results,
|
3183
2533
|
:next_token)
|
3184
2534
|
SENSITIVE = []
|
@@ -3203,15 +2553,6 @@ module Aws::GreengrassV2
|
|
3203
2553
|
include Aws::Structure
|
3204
2554
|
end
|
3205
2555
|
|
3206
|
-
# @note When making an API call, you may pass ListEffectiveDeploymentsRequest
|
3207
|
-
# data as a hash:
|
3208
|
-
#
|
3209
|
-
# {
|
3210
|
-
# core_device_thing_name: "CoreDeviceThingName", # required
|
3211
|
-
# max_results: 1,
|
3212
|
-
# next_token: "NextTokenString",
|
3213
|
-
# }
|
3214
|
-
#
|
3215
2556
|
# @!attribute [rw] core_device_thing_name
|
3216
2557
|
# The name of the core device. This is also the name of the IoT thing.
|
3217
2558
|
# @return [String]
|
@@ -3252,16 +2593,6 @@ module Aws::GreengrassV2
|
|
3252
2593
|
include Aws::Structure
|
3253
2594
|
end
|
3254
2595
|
|
3255
|
-
# @note When making an API call, you may pass ListInstalledComponentsRequest
|
3256
|
-
# data as a hash:
|
3257
|
-
#
|
3258
|
-
# {
|
3259
|
-
# core_device_thing_name: "CoreDeviceThingName", # required
|
3260
|
-
# max_results: 1,
|
3261
|
-
# next_token: "NextTokenString",
|
3262
|
-
# topology_filter: "ALL", # accepts ALL, ROOT
|
3263
|
-
# }
|
3264
|
-
#
|
3265
2596
|
# @!attribute [rw] core_device_thing_name
|
3266
2597
|
# The name of the core device. This is also the name of the IoT thing.
|
3267
2598
|
# @return [String]
|
@@ -3331,13 +2662,6 @@ module Aws::GreengrassV2
|
|
3331
2662
|
include Aws::Structure
|
3332
2663
|
end
|
3333
2664
|
|
3334
|
-
# @note When making an API call, you may pass ListTagsForResourceRequest
|
3335
|
-
# data as a hash:
|
3336
|
-
#
|
3337
|
-
# {
|
3338
|
-
# resource_arn: "GenericV2ARN", # required
|
3339
|
-
# }
|
3340
|
-
#
|
3341
2665
|
# @!attribute [rw] resource_arn
|
3342
2666
|
# The [ARN][1] of the resource.
|
3343
2667
|
#
|
@@ -3387,27 +2711,6 @@ module Aws::GreengrassV2
|
|
3387
2711
|
include Aws::Structure
|
3388
2712
|
end
|
3389
2713
|
|
3390
|
-
# @note When making an API call, you may pass ResolveComponentCandidatesRequest
|
3391
|
-
# data as a hash:
|
3392
|
-
#
|
3393
|
-
# {
|
3394
|
-
# platform: {
|
3395
|
-
# name: "NonEmptyString",
|
3396
|
-
# attributes: {
|
3397
|
-
# "NonEmptyString" => "NonEmptyString",
|
3398
|
-
# },
|
3399
|
-
# },
|
3400
|
-
# component_candidates: [
|
3401
|
-
# {
|
3402
|
-
# component_name: "ComponentNameString",
|
3403
|
-
# component_version: "ComponentVersionString",
|
3404
|
-
# version_requirements: {
|
3405
|
-
# "NonEmptyString" => "NonEmptyString",
|
3406
|
-
# },
|
3407
|
-
# },
|
3408
|
-
# ],
|
3409
|
-
# }
|
3410
|
-
#
|
3411
2714
|
# @!attribute [rw] platform
|
3412
2715
|
# The platform to use to resolve compatible components.
|
3413
2716
|
# @return [Types::ComponentPlatform]
|
@@ -3573,14 +2876,6 @@ module Aws::GreengrassV2
|
|
3573
2876
|
#
|
3574
2877
|
# [1]: https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-system-resource-limits
|
3575
2878
|
#
|
3576
|
-
# @note When making an API call, you may pass SystemResourceLimits
|
3577
|
-
# data as a hash:
|
3578
|
-
#
|
3579
|
-
# {
|
3580
|
-
# memory: 1,
|
3581
|
-
# cpus: 1.0,
|
3582
|
-
# }
|
3583
|
-
#
|
3584
2879
|
# @!attribute [rw] memory
|
3585
2880
|
# The maximum amount of RAM, expressed in kilobytes, that a
|
3586
2881
|
# component's processes can use on the core device.
|
@@ -3608,16 +2903,6 @@ module Aws::GreengrassV2
|
|
3608
2903
|
include Aws::Structure
|
3609
2904
|
end
|
3610
2905
|
|
3611
|
-
# @note When making an API call, you may pass TagResourceRequest
|
3612
|
-
# data as a hash:
|
3613
|
-
#
|
3614
|
-
# {
|
3615
|
-
# resource_arn: "GenericV2ARN", # required
|
3616
|
-
# tags: { # required
|
3617
|
-
# "TagKey" => "TagValue",
|
3618
|
-
# },
|
3619
|
-
# }
|
3620
|
-
#
|
3621
2906
|
# @!attribute [rw] resource_arn
|
3622
2907
|
# The [ARN][1] of the resource to tag.
|
3623
2908
|
#
|
@@ -3687,14 +2972,6 @@ module Aws::GreengrassV2
|
|
3687
2972
|
include Aws::Structure
|
3688
2973
|
end
|
3689
2974
|
|
3690
|
-
# @note When making an API call, you may pass UntagResourceRequest
|
3691
|
-
# data as a hash:
|
3692
|
-
#
|
3693
|
-
# {
|
3694
|
-
# resource_arn: "GenericV2ARN", # required
|
3695
|
-
# tag_keys: ["TagKey"], # required
|
3696
|
-
# }
|
3697
|
-
#
|
3698
2975
|
# @!attribute [rw] resource_arn
|
3699
2976
|
# The [ARN][1] of the resource to untag.
|
3700
2977
|
#
|
@@ -3720,21 +2997,6 @@ module Aws::GreengrassV2
|
|
3720
2997
|
#
|
3721
2998
|
class UntagResourceResponse < Aws::EmptyStructure; end
|
3722
2999
|
|
3723
|
-
# @note When making an API call, you may pass UpdateConnectivityInfoRequest
|
3724
|
-
# data as a hash:
|
3725
|
-
#
|
3726
|
-
# {
|
3727
|
-
# thing_name: "CoreDeviceThingName", # required
|
3728
|
-
# connectivity_info: [ # required
|
3729
|
-
# {
|
3730
|
-
# id: "String",
|
3731
|
-
# host_address: "String",
|
3732
|
-
# port_number: 1,
|
3733
|
-
# metadata: "String",
|
3734
|
-
# },
|
3735
|
-
# ],
|
3736
|
-
# }
|
3737
|
-
#
|
3738
3000
|
# @!attribute [rw] thing_name
|
3739
3001
|
# The name of the core device. This is also the name of the IoT thing.
|
3740
3002
|
# @return [String]
|