-
Notifications
You must be signed in to change notification settings - Fork 62
/
greengrass.jl
3396 lines (3046 loc) · 104 KB
/
greengrass.jl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: greengrass
using AWS.Compat
using AWS.UUIDs
"""
associate_role_to_group(group_id, role_arn)
associate_role_to_group(group_id, role_arn, params::Dict{String,<:Any})
Associates a role with a group. Your Greengrass core will use the role to access AWS cloud
services. The role's permissions should allow Greengrass core Lambda functions to perform
actions against the cloud.
# Arguments
- `group_id`: The ID of the Greengrass group.
- `role_arn`: The ARN of the role you wish to associate with this group. The existence of
the role is not validated.
"""
function associate_role_to_group(
GroupId, RoleArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"PUT",
"/greengrass/groups/$(GroupId)/role",
Dict{String,Any}("RoleArn" => RoleArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_role_to_group(
GroupId,
RoleArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"PUT",
"/greengrass/groups/$(GroupId)/role",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("RoleArn" => RoleArn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_service_role_to_account(role_arn)
associate_service_role_to_account(role_arn, params::Dict{String,<:Any})
Associates a role with your account. AWS IoT Greengrass will use the role to access your
Lambda functions and AWS IoT resources. This is necessary for deployments to succeed. The
role must have at least minimum permissions in the policy
''AWSGreengrassResourceAccessRolePolicy''.
# Arguments
- `role_arn`: The ARN of the service role you wish to associate with your account.
"""
function associate_service_role_to_account(
RoleArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"PUT",
"/greengrass/servicerole",
Dict{String,Any}("RoleArn" => RoleArn);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_service_role_to_account(
RoleArn, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"PUT",
"/greengrass/servicerole",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("RoleArn" => RoleArn), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_connector_definition()
create_connector_definition(params::Dict{String,<:Any})
Creates a connector definition. You may provide the initial version of the connector
definition now or use ''CreateConnectorDefinitionVersion'' at a later time.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InitialVersion"`: Information about the initial version of the connector definition.
- `"Name"`: The name of the connector definition.
- `"X-Amzn-Client-Token"`: A client token used to correlate requests and responses.
- `"tags"`: Tag(s) to add to the new resource.
"""
function create_connector_definition(; aws_config::AbstractAWSConfig=global_aws_config())
return greengrass(
"POST",
"/greengrass/definition/connectors";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_connector_definition(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"POST",
"/greengrass/definition/connectors",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_connector_definition_version(connector_definition_id)
create_connector_definition_version(connector_definition_id, params::Dict{String,<:Any})
Creates a version of a connector definition which has already been defined.
# Arguments
- `connector_definition_id`: The ID of the connector definition.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Connectors"`: A list of references to connectors in this version, with their
corresponding configuration settings.
- `"X-Amzn-Client-Token"`: A client token used to correlate requests and responses.
"""
function create_connector_definition_version(
ConnectorDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"POST",
"/greengrass/definition/connectors/$(ConnectorDefinitionId)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_connector_definition_version(
ConnectorDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"POST",
"/greengrass/definition/connectors/$(ConnectorDefinitionId)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_core_definition()
create_core_definition(params::Dict{String,<:Any})
Creates a core definition. You may provide the initial version of the core definition now
or use ''CreateCoreDefinitionVersion'' at a later time. Greengrass groups must each contain
exactly one Greengrass core.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InitialVersion"`: Information about the initial version of the core definition.
- `"Name"`: The name of the core definition.
- `"X-Amzn-Client-Token"`: A client token used to correlate requests and responses.
- `"tags"`: Tag(s) to add to the new resource.
"""
function create_core_definition(; aws_config::AbstractAWSConfig=global_aws_config())
return greengrass(
"POST",
"/greengrass/definition/cores";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_core_definition(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"POST",
"/greengrass/definition/cores",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_core_definition_version(core_definition_id)
create_core_definition_version(core_definition_id, params::Dict{String,<:Any})
Creates a version of a core definition that has already been defined. Greengrass groups
must each contain exactly one Greengrass core.
# Arguments
- `core_definition_id`: The ID of the core definition.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Cores"`: A list of cores in the core definition version.
- `"X-Amzn-Client-Token"`: A client token used to correlate requests and responses.
"""
function create_core_definition_version(
CoreDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"POST",
"/greengrass/definition/cores/$(CoreDefinitionId)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_core_definition_version(
CoreDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"POST",
"/greengrass/definition/cores/$(CoreDefinitionId)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_deployment(deployment_type, group_id)
create_deployment(deployment_type, group_id, params::Dict{String,<:Any})
Creates a deployment. ''CreateDeployment'' requests are idempotent with respect to the
''X-Amzn-Client-Token'' token and the request parameters.
# Arguments
- `deployment_type`: The type of deployment. When used for ''CreateDeployment'', only
''NewDeployment'' and ''Redeployment'' are valid.
- `group_id`: The ID of the Greengrass group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DeploymentId"`: The ID of the deployment if you wish to redeploy a previous deployment.
- `"GroupVersionId"`: The ID of the group version to be deployed.
- `"X-Amzn-Client-Token"`: A client token used to correlate requests and responses.
"""
function create_deployment(
DeploymentType, GroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"POST",
"/greengrass/groups/$(GroupId)/deployments",
Dict{String,Any}("DeploymentType" => DeploymentType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_deployment(
DeploymentType,
GroupId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"POST",
"/greengrass/groups/$(GroupId)/deployments",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DeploymentType" => DeploymentType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_device_definition()
create_device_definition(params::Dict{String,<:Any})
Creates a device definition. You may provide the initial version of the device definition
now or use ''CreateDeviceDefinitionVersion'' at a later time.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InitialVersion"`: Information about the initial version of the device definition.
- `"Name"`: The name of the device definition.
- `"X-Amzn-Client-Token"`: A client token used to correlate requests and responses.
- `"tags"`: Tag(s) to add to the new resource.
"""
function create_device_definition(; aws_config::AbstractAWSConfig=global_aws_config())
return greengrass(
"POST",
"/greengrass/definition/devices";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_device_definition(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"POST",
"/greengrass/definition/devices",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_device_definition_version(device_definition_id)
create_device_definition_version(device_definition_id, params::Dict{String,<:Any})
Creates a version of a device definition that has already been defined.
# Arguments
- `device_definition_id`: The ID of the device definition.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Devices"`: A list of devices in the definition version.
- `"X-Amzn-Client-Token"`: A client token used to correlate requests and responses.
"""
function create_device_definition_version(
DeviceDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"POST",
"/greengrass/definition/devices/$(DeviceDefinitionId)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_device_definition_version(
DeviceDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"POST",
"/greengrass/definition/devices/$(DeviceDefinitionId)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_function_definition()
create_function_definition(params::Dict{String,<:Any})
Creates a Lambda function definition which contains a list of Lambda functions and their
configurations to be used in a group. You can create an initial version of the definition
by providing a list of Lambda functions and their configurations now, or use
''CreateFunctionDefinitionVersion'' later.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InitialVersion"`: Information about the initial version of the function definition.
- `"Name"`: The name of the function definition.
- `"X-Amzn-Client-Token"`: A client token used to correlate requests and responses.
- `"tags"`: Tag(s) to add to the new resource.
"""
function create_function_definition(; aws_config::AbstractAWSConfig=global_aws_config())
return greengrass(
"POST",
"/greengrass/definition/functions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_function_definition(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"POST",
"/greengrass/definition/functions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_function_definition_version(function_definition_id)
create_function_definition_version(function_definition_id, params::Dict{String,<:Any})
Creates a version of a Lambda function definition that has already been defined.
# Arguments
- `function_definition_id`: The ID of the Lambda function definition.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"DefaultConfig"`: The default configuration that applies to all Lambda functions in this
function definition version. Individual Lambda functions can override these settings.
- `"Functions"`: A list of Lambda functions in this function definition version.
- `"X-Amzn-Client-Token"`: A client token used to correlate requests and responses.
"""
function create_function_definition_version(
FunctionDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"POST",
"/greengrass/definition/functions/$(FunctionDefinitionId)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_function_definition_version(
FunctionDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"POST",
"/greengrass/definition/functions/$(FunctionDefinitionId)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_group(name)
create_group(name, params::Dict{String,<:Any})
Creates a group. You may provide the initial version of the group or use
''CreateGroupVersion'' at a later time. Tip: You can use the ''gg_group_setup'' package
(https://github.com/awslabs/aws-greengrass-group-setup) as a library or command-line
application to create and deploy Greengrass groups.
# Arguments
- `name`: The name of the group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InitialVersion"`: Information about the initial version of the group.
- `"X-Amzn-Client-Token"`: A client token used to correlate requests and responses.
- `"tags"`: Tag(s) to add to the new resource.
"""
function create_group(Name; aws_config::AbstractAWSConfig=global_aws_config())
return greengrass(
"POST",
"/greengrass/groups",
Dict{String,Any}("Name" => Name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_group(
Name, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"POST",
"/greengrass/groups",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("Name" => Name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_group_certificate_authority(group_id)
create_group_certificate_authority(group_id, params::Dict{String,<:Any})
Creates a CA for the group. If a CA already exists, it will rotate the existing CA.
# Arguments
- `group_id`: The ID of the Greengrass group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"X-Amzn-Client-Token"`: A client token used to correlate requests and responses.
"""
function create_group_certificate_authority(
GroupId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"POST",
"/greengrass/groups/$(GroupId)/certificateauthorities";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_group_certificate_authority(
GroupId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"POST",
"/greengrass/groups/$(GroupId)/certificateauthorities",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_group_version(group_id)
create_group_version(group_id, params::Dict{String,<:Any})
Creates a version of a group which has already been defined.
# Arguments
- `group_id`: The ID of the Greengrass group.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"ConnectorDefinitionVersionArn"`: The ARN of the connector definition version for this
group.
- `"CoreDefinitionVersionArn"`: The ARN of the core definition version for this group.
- `"DeviceDefinitionVersionArn"`: The ARN of the device definition version for this group.
- `"FunctionDefinitionVersionArn"`: The ARN of the function definition version for this
group.
- `"LoggerDefinitionVersionArn"`: The ARN of the logger definition version for this group.
- `"ResourceDefinitionVersionArn"`: The ARN of the resource definition version for this
group.
- `"SubscriptionDefinitionVersionArn"`: The ARN of the subscription definition version for
this group.
- `"X-Amzn-Client-Token"`: A client token used to correlate requests and responses.
"""
function create_group_version(GroupId; aws_config::AbstractAWSConfig=global_aws_config())
return greengrass(
"POST",
"/greengrass/groups/$(GroupId)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_group_version(
GroupId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"POST",
"/greengrass/groups/$(GroupId)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_logger_definition()
create_logger_definition(params::Dict{String,<:Any})
Creates a logger definition. You may provide the initial version of the logger definition
now or use ''CreateLoggerDefinitionVersion'' at a later time.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InitialVersion"`: Information about the initial version of the logger definition.
- `"Name"`: The name of the logger definition.
- `"X-Amzn-Client-Token"`: A client token used to correlate requests and responses.
- `"tags"`: Tag(s) to add to the new resource.
"""
function create_logger_definition(; aws_config::AbstractAWSConfig=global_aws_config())
return greengrass(
"POST",
"/greengrass/definition/loggers";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_logger_definition(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"POST",
"/greengrass/definition/loggers",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_logger_definition_version(logger_definition_id)
create_logger_definition_version(logger_definition_id, params::Dict{String,<:Any})
Creates a version of a logger definition that has already been defined.
# Arguments
- `logger_definition_id`: The ID of the logger definition.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Loggers"`: A list of loggers.
- `"X-Amzn-Client-Token"`: A client token used to correlate requests and responses.
"""
function create_logger_definition_version(
LoggerDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"POST",
"/greengrass/definition/loggers/$(LoggerDefinitionId)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_logger_definition_version(
LoggerDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"POST",
"/greengrass/definition/loggers/$(LoggerDefinitionId)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_resource_definition()
create_resource_definition(params::Dict{String,<:Any})
Creates a resource definition which contains a list of resources to be used in a group. You
can create an initial version of the definition by providing a list of resources now, or
use ''CreateResourceDefinitionVersion'' later.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InitialVersion"`: Information about the initial version of the resource definition.
- `"Name"`: The name of the resource definition.
- `"X-Amzn-Client-Token"`: A client token used to correlate requests and responses.
- `"tags"`: Tag(s) to add to the new resource.
"""
function create_resource_definition(; aws_config::AbstractAWSConfig=global_aws_config())
return greengrass(
"POST",
"/greengrass/definition/resources";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_resource_definition(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"POST",
"/greengrass/definition/resources",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_resource_definition_version(resource_definition_id)
create_resource_definition_version(resource_definition_id, params::Dict{String,<:Any})
Creates a version of a resource definition that has already been defined.
# Arguments
- `resource_definition_id`: The ID of the resource definition.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Resources"`: A list of resources.
- `"X-Amzn-Client-Token"`: A client token used to correlate requests and responses.
"""
function create_resource_definition_version(
ResourceDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"POST",
"/greengrass/definition/resources/$(ResourceDefinitionId)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_resource_definition_version(
ResourceDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"POST",
"/greengrass/definition/resources/$(ResourceDefinitionId)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_software_update_job(s3_url_signer_role, software_to_update, update_targets, update_targets_architecture, update_targets_operating_system)
create_software_update_job(s3_url_signer_role, software_to_update, update_targets, update_targets_architecture, update_targets_operating_system, params::Dict{String,<:Any})
Creates a software update for a core or group of cores (specified as an IoT thing group.)
Use this to update the OTA Agent as well as the Greengrass core software. It makes use of
the IoT Jobs feature which provides additional commands to manage a Greengrass core
software update job.
# Arguments
- `s3_url_signer_role`:
- `software_to_update`:
- `update_targets`:
- `update_targets_architecture`:
- `update_targets_operating_system`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"UpdateAgentLogLevel"`:
- `"X-Amzn-Client-Token"`: A client token used to correlate requests and responses.
"""
function create_software_update_job(
S3UrlSignerRole,
SoftwareToUpdate,
UpdateTargets,
UpdateTargetsArchitecture,
UpdateTargetsOperatingSystem;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"POST",
"/greengrass/updates",
Dict{String,Any}(
"S3UrlSignerRole" => S3UrlSignerRole,
"SoftwareToUpdate" => SoftwareToUpdate,
"UpdateTargets" => UpdateTargets,
"UpdateTargetsArchitecture" => UpdateTargetsArchitecture,
"UpdateTargetsOperatingSystem" => UpdateTargetsOperatingSystem,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_software_update_job(
S3UrlSignerRole,
SoftwareToUpdate,
UpdateTargets,
UpdateTargetsArchitecture,
UpdateTargetsOperatingSystem,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"POST",
"/greengrass/updates",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"S3UrlSignerRole" => S3UrlSignerRole,
"SoftwareToUpdate" => SoftwareToUpdate,
"UpdateTargets" => UpdateTargets,
"UpdateTargetsArchitecture" => UpdateTargetsArchitecture,
"UpdateTargetsOperatingSystem" => UpdateTargetsOperatingSystem,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_subscription_definition()
create_subscription_definition(params::Dict{String,<:Any})
Creates a subscription definition. You may provide the initial version of the subscription
definition now or use ''CreateSubscriptionDefinitionVersion'' at a later time.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"InitialVersion"`: Information about the initial version of the subscription definition.
- `"Name"`: The name of the subscription definition.
- `"X-Amzn-Client-Token"`: A client token used to correlate requests and responses.
- `"tags"`: Tag(s) to add to the new resource.
"""
function create_subscription_definition(; aws_config::AbstractAWSConfig=global_aws_config())
return greengrass(
"POST",
"/greengrass/definition/subscriptions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_subscription_definition(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"POST",
"/greengrass/definition/subscriptions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_subscription_definition_version(subscription_definition_id)
create_subscription_definition_version(subscription_definition_id, params::Dict{String,<:Any})
Creates a version of a subscription definition which has already been defined.
# Arguments
- `subscription_definition_id`: The ID of the subscription definition.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Subscriptions"`: A list of subscriptions.
- `"X-Amzn-Client-Token"`: A client token used to correlate requests and responses.
"""
function create_subscription_definition_version(
SubscriptionDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"POST",
"/greengrass/definition/subscriptions/$(SubscriptionDefinitionId)/versions";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_subscription_definition_version(
SubscriptionDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"POST",
"/greengrass/definition/subscriptions/$(SubscriptionDefinitionId)/versions",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_connector_definition(connector_definition_id)
delete_connector_definition(connector_definition_id, params::Dict{String,<:Any})
Deletes a connector definition.
# Arguments
- `connector_definition_id`: The ID of the connector definition.
"""
function delete_connector_definition(
ConnectorDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"DELETE",
"/greengrass/definition/connectors/$(ConnectorDefinitionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_connector_definition(
ConnectorDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"DELETE",
"/greengrass/definition/connectors/$(ConnectorDefinitionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_core_definition(core_definition_id)
delete_core_definition(core_definition_id, params::Dict{String,<:Any})
Deletes a core definition.
# Arguments
- `core_definition_id`: The ID of the core definition.
"""
function delete_core_definition(
CoreDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"DELETE",
"/greengrass/definition/cores/$(CoreDefinitionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_core_definition(
CoreDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"DELETE",
"/greengrass/definition/cores/$(CoreDefinitionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_device_definition(device_definition_id)
delete_device_definition(device_definition_id, params::Dict{String,<:Any})
Deletes a device definition.
# Arguments
- `device_definition_id`: The ID of the device definition.
"""
function delete_device_definition(
DeviceDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"DELETE",
"/greengrass/definition/devices/$(DeviceDefinitionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_device_definition(
DeviceDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"DELETE",
"/greengrass/definition/devices/$(DeviceDefinitionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_function_definition(function_definition_id)
delete_function_definition(function_definition_id, params::Dict{String,<:Any})
Deletes a Lambda function definition.
# Arguments
- `function_definition_id`: The ID of the Lambda function definition.
"""
function delete_function_definition(
FunctionDefinitionId; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"DELETE",
"/greengrass/definition/functions/$(FunctionDefinitionId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_function_definition(
FunctionDefinitionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return greengrass(
"DELETE",
"/greengrass/definition/functions/$(FunctionDefinitionId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_group(group_id)
delete_group(group_id, params::Dict{String,<:Any})
Deletes a group.
# Arguments
- `group_id`: The ID of the Greengrass group.
"""
function delete_group(GroupId; aws_config::AbstractAWSConfig=global_aws_config())
return greengrass(
"DELETE",
"/greengrass/groups/$(GroupId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_group(
GroupId, params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return greengrass(
"DELETE",
"/greengrass/groups/$(GroupId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_logger_definition(logger_definition_id)
delete_logger_definition(logger_definition_id, params::Dict{String,<:Any})