-
Notifications
You must be signed in to change notification settings - Fork 668
/
Copy pathsecuritylake.json
4757 lines (4757 loc) · 233 KB
/
securitylake.json
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
{
"smithy": "2.0",
"shapes": {
"com.amazonaws.securitylake#AccessDeniedException": {
"type": "structure",
"members": {
"message": {
"target": "smithy.api#String"
},
"errorCode": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>A coded string to provide more information about the access denied exception. You can use the error code to check the exception type.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>You do not have sufficient access to perform this action. Access denied errors appear when Amazon Security Lake explicitly or implicitly denies an authorization\n request. An explicit denial occurs when a policy contains a Deny statement for the specific\n Amazon Web Services action. An implicit denial occurs when there is no applicable Deny statement and also\n no applicable Allow statement.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 403
}
},
"com.amazonaws.securitylake#AccessType": {
"type": "enum",
"members": {
"LAKEFORMATION": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "LAKEFORMATION"
}
},
"S3": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "S3"
}
}
}
},
"com.amazonaws.securitylake#AccessTypeList": {
"type": "list",
"member": {
"target": "com.amazonaws.securitylake#AccessType"
}
},
"com.amazonaws.securitylake#AccountList": {
"type": "list",
"member": {
"target": "com.amazonaws.securitylake#AwsAccountId"
},
"traits": {
"smithy.api#uniqueItems": {}
}
},
"com.amazonaws.securitylake#AmazonResourceName": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 1011
},
"smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn):securitylake:[A-za-z0-9_/.\\-]{0,63}:[A-za-z0-9_/.\\-]{0,63}:[A-Za-z0-9][A-za-z0-9_/.\\-]{0,127}$"
}
},
"com.amazonaws.securitylake#AwsAccountId": {
"type": "string",
"traits": {
"aws.api#data": "account",
"smithy.api#length": {
"min": 12,
"max": 12
},
"smithy.api#pattern": "^[0-9]{12}$"
}
},
"com.amazonaws.securitylake#AwsIdentity": {
"type": "structure",
"members": {
"principal": {
"target": "com.amazonaws.securitylake#AwsPrincipal",
"traits": {
"smithy.api#documentation": "<p>The AWS identity principal.</p>",
"smithy.api#required": {}
}
},
"externalId": {
"target": "com.amazonaws.securitylake#ExternalId",
"traits": {
"smithy.api#documentation": "<p>The external ID used to estalish trust relationship with the AWS identity.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The AWS identity.</p>"
}
},
"com.amazonaws.securitylake#AwsLogSourceConfiguration": {
"type": "structure",
"members": {
"accounts": {
"target": "com.amazonaws.securitylake#AccountList",
"traits": {
"smithy.api#documentation": "<p>Specify the Amazon Web Services account information where you want to enable Security Lake.</p>"
}
},
"regions": {
"target": "com.amazonaws.securitylake#RegionList",
"traits": {
"smithy.api#documentation": "<p>Specify the Regions where you want to enable Security Lake.</p>",
"smithy.api#required": {}
}
},
"sourceName": {
"target": "com.amazonaws.securitylake#AwsLogSourceName",
"traits": {
"smithy.api#documentation": "<p>The name for a Amazon Web Services source. This must be a Regionally unique value.</p>",
"smithy.api#required": {}
}
},
"sourceVersion": {
"target": "com.amazonaws.securitylake#AwsLogSourceVersion",
"traits": {
"smithy.api#default": "latest",
"smithy.api#documentation": "<p>The version for a Amazon Web Services source. This must be a Regionally unique value.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The Security Lake logs source configuration file describes the information needed to generate Security Lake logs. </p>"
}
},
"com.amazonaws.securitylake#AwsLogSourceConfigurationList": {
"type": "list",
"member": {
"target": "com.amazonaws.securitylake#AwsLogSourceConfiguration"
},
"traits": {
"smithy.api#length": {
"min": 1,
"max": 50
}
}
},
"com.amazonaws.securitylake#AwsLogSourceName": {
"type": "enum",
"members": {
"ROUTE53": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ROUTE53"
}
},
"VPC_FLOW": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "VPC_FLOW"
}
},
"SH_FINDINGS": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "SH_FINDINGS"
}
},
"CLOUD_TRAIL_MGMT": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "CLOUD_TRAIL_MGMT"
}
},
"LAMBDA_EXECUTION": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "LAMBDA_EXECUTION"
}
},
"S3_DATA": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "S3_DATA"
}
},
"EKS_AUDIT": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "EKS_AUDIT"
}
},
"WAF": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "WAF"
}
}
}
},
"com.amazonaws.securitylake#AwsLogSourceResource": {
"type": "structure",
"members": {
"sourceName": {
"target": "com.amazonaws.securitylake#AwsLogSourceName",
"traits": {
"smithy.api#documentation": "<p>The name for a Amazon Web Services source. This must be a Regionally unique value.</p>"
}
},
"sourceVersion": {
"target": "com.amazonaws.securitylake#AwsLogSourceVersion",
"traits": {
"smithy.api#documentation": "<p>The version for a Amazon Web Services source. This must be a Regionally unique value.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Amazon Security Lake can collect logs and events from natively-supported Amazon Web Services services.</p>"
}
},
"com.amazonaws.securitylake#AwsLogSourceResourceList": {
"type": "list",
"member": {
"target": "com.amazonaws.securitylake#AwsLogSourceResource"
},
"traits": {
"smithy.api#length": {
"min": 1
}
}
},
"com.amazonaws.securitylake#AwsLogSourceVersion": {
"type": "string",
"traits": {
"smithy.api#pattern": "^(latest|[0-9]\\.[0-9])$"
}
},
"com.amazonaws.securitylake#AwsPrincipal": {
"type": "string",
"traits": {
"smithy.api#pattern": "^([0-9]{12}|[a-z0-9\\.\\-]*\\.(amazonaws|amazon)\\.com)$"
}
},
"com.amazonaws.securitylake#BadRequestException": {
"type": "structure",
"members": {
"message": {
"target": "smithy.api#String"
}
},
"traits": {
"smithy.api#documentation": "<p>The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 400
}
},
"com.amazonaws.securitylake#ConflictException": {
"type": "structure",
"members": {
"message": {
"target": "smithy.api#String"
},
"resourceName": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The resource name.</p>"
}
},
"resourceType": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The resource type.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Occurs when a conflict with a previous successful write is detected. This generally\n occurs when the previous write did not have time to propagate to the host serving the\n current request. A retry (with appropriate backoff logic) is the recommended response to\n this exception.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 409
}
},
"com.amazonaws.securitylake#CreateAwsLogSource": {
"type": "operation",
"input": {
"target": "com.amazonaws.securitylake#CreateAwsLogSourceRequest"
},
"output": {
"target": "com.amazonaws.securitylake#CreateAwsLogSourceResponse"
},
"errors": [
{
"target": "com.amazonaws.securitylake#AccessDeniedException"
},
{
"target": "com.amazonaws.securitylake#BadRequestException"
},
{
"target": "com.amazonaws.securitylake#ConflictException"
},
{
"target": "com.amazonaws.securitylake#InternalServerException"
},
{
"target": "com.amazonaws.securitylake#ResourceNotFoundException"
},
{
"target": "com.amazonaws.securitylake#ThrottlingException"
}
],
"traits": {
"aws.iam#actionPermissionDescription": "Grants permission to enable any source type in any region for accounts that are either part of a trusted organization or standalone account",
"aws.iam#requiredActions": [
"iam:CreateServiceLinkedRole",
"kms:DescribeKey",
"kms:CreateGrant",
"glue:GetTable",
"glue:GetDatabase",
"glue:CreateTable",
"glue:CreateDatabase"
],
"smithy.api#documentation": "<p>Adds a natively supported Amazon Web Service as an Amazon Security Lake source. Enables\n source types for member accounts in required Amazon Web Services Regions, based on the\n parameters you specify. You can choose any source type in any Region for either accounts\n that are part of a trusted organization or standalone accounts. Once you add an Amazon Web Service as a source, Security Lake starts collecting logs and events from it.</p>\n <p>You can use this API only to enable natively supported Amazon Web Services as a\n source. Use <code>CreateCustomLogSource</code> to enable data collection from a custom\n source.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/v1/datalake/logsources/aws",
"code": 200
}
}
},
"com.amazonaws.securitylake#CreateAwsLogSourceRequest": {
"type": "structure",
"members": {
"sources": {
"target": "com.amazonaws.securitylake#AwsLogSourceConfigurationList",
"traits": {
"smithy.api#documentation": "<p>Specify the natively-supported Amazon Web Services service to add as a source in Security Lake.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.securitylake#CreateAwsLogSourceResponse": {
"type": "structure",
"members": {
"failed": {
"target": "com.amazonaws.securitylake#AccountList",
"traits": {
"smithy.api#documentation": "<p>Lists all accounts in which enabling a natively supported Amazon Web Service as\n a Security Lake source failed. The failure occurred as these accounts are not part of an\n organization.</p>"
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.securitylake#CreateCustomLogSource": {
"type": "operation",
"input": {
"target": "com.amazonaws.securitylake#CreateCustomLogSourceRequest"
},
"output": {
"target": "com.amazonaws.securitylake#CreateCustomLogSourceResponse"
},
"errors": [
{
"target": "com.amazonaws.securitylake#AccessDeniedException"
},
{
"target": "com.amazonaws.securitylake#BadRequestException"
},
{
"target": "com.amazonaws.securitylake#ConflictException"
},
{
"target": "com.amazonaws.securitylake#InternalServerException"
},
{
"target": "com.amazonaws.securitylake#ResourceNotFoundException"
},
{
"target": "com.amazonaws.securitylake#ThrottlingException"
}
],
"traits": {
"aws.iam#actionPermissionDescription": "Grants permission to add a custom source",
"aws.iam#requiredActions": [
"iam:GetRole",
"iam:PutRolePolicy",
"iam:DeleteRolePolicy",
"iam:PassRole",
"s3:PutObject",
"s3:ListBucket",
"lakeformation:RegisterResource",
"lakeformation:GrantPermissions",
"kms:DescribeKey",
"kms:CreateGrant",
"kms:GenerateDataKey",
"glue:CreateCrawler",
"glue:StartCrawlerSchedule",
"glue:CreateTable",
"glue:CreateDatabase"
],
"smithy.api#documentation": "<p>Adds a third-party custom source in Amazon Security Lake, from the Amazon Web Services Region\n where you want to create a custom source. Security Lake can collect logs and events from\n third-party custom sources. After creating the appropriate IAM role to\n invoke Glue crawler, use this API to add a custom source name in Security Lake. This\n operation creates a partition in the Amazon S3 bucket for Security Lake as the target\n location for log files from the custom source. In addition, this operation also creates an\n associated Glue table and an Glue crawler.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/v1/datalake/logsources/custom",
"code": 200
},
"smithy.api#idempotent": {}
}
},
"com.amazonaws.securitylake#CreateCustomLogSourceRequest": {
"type": "structure",
"members": {
"sourceName": {
"target": "com.amazonaws.securitylake#CustomLogSourceName",
"traits": {
"smithy.api#documentation": "<p>Specify the name for a third-party custom source. This must be a Regionally unique\n value.</p>",
"smithy.api#required": {}
}
},
"sourceVersion": {
"target": "com.amazonaws.securitylake#CustomLogSourceVersion",
"traits": {
"smithy.api#documentation": "<p>Specify the source version for the third-party custom source, to limit log collection to\n a specific version of custom data source.</p>"
}
},
"eventClasses": {
"target": "com.amazonaws.securitylake#OcsfEventClassList",
"traits": {
"smithy.api#documentation": "<p>The Open Cybersecurity Schema Framework (OCSF) event classes which describes the type of\n data that the custom source will send to Security Lake. The supported event classes are:</p>\n <ul>\n <li>\n <p>\n <code>ACCESS_ACTIVITY</code>\n </p>\n </li>\n <li>\n <p>\n <code>FILE_ACTIVITY</code>\n </p>\n </li>\n <li>\n <p>\n <code>KERNEL_ACTIVITY</code>\n </p>\n </li>\n <li>\n <p>\n <code>KERNEL_EXTENSION</code>\n </p>\n </li>\n <li>\n <p>\n <code>MEMORY_ACTIVITY</code>\n </p>\n </li>\n <li>\n <p>\n <code>MODULE_ACTIVITY</code>\n </p>\n </li>\n <li>\n <p>\n <code>PROCESS_ACTIVITY</code>\n </p>\n </li>\n <li>\n <p>\n <code>REGISTRY_KEY_ACTIVITY</code>\n </p>\n </li>\n <li>\n <p>\n <code>REGISTRY_VALUE_ACTIVITY</code>\n </p>\n </li>\n <li>\n <p>\n <code>RESOURCE_ACTIVITY</code>\n </p>\n </li>\n <li>\n <p>\n <code>SCHEDULED_JOB_ACTIVITY</code>\n </p>\n </li>\n <li>\n <p>\n <code>SECURITY_FINDING</code>\n </p>\n </li>\n <li>\n <p>\n <code>ACCOUNT_CHANGE</code>\n </p>\n </li>\n <li>\n <p>\n <code>AUTHENTICATION</code>\n </p>\n </li>\n <li>\n <p>\n <code>AUTHORIZATION</code>\n </p>\n </li>\n <li>\n <p>\n <code>ENTITY_MANAGEMENT_AUDIT</code>\n </p>\n </li>\n <li>\n <p>\n <code>DHCP_ACTIVITY</code>\n </p>\n </li>\n <li>\n <p>\n <code>NETWORK_ACTIVITY</code>\n </p>\n </li>\n <li>\n <p>\n <code>DNS_ACTIVITY</code>\n </p>\n </li>\n <li>\n <p>\n <code>FTP_ACTIVITY</code>\n </p>\n </li>\n <li>\n <p>\n <code>HTTP_ACTIVITY</code>\n </p>\n </li>\n <li>\n <p>\n <code>RDP_ACTIVITY</code>\n </p>\n </li>\n <li>\n <p>\n <code>SMB_ACTIVITY</code>\n </p>\n </li>\n <li>\n <p>\n <code>SSH_ACTIVITY</code>\n </p>\n </li>\n <li>\n <p>\n <code>CONFIG_STATE</code>\n </p>\n </li>\n <li>\n <p>\n <code>INVENTORY_INFO</code>\n </p>\n </li>\n <li>\n <p>\n <code>EMAIL_ACTIVITY</code>\n </p>\n </li>\n <li>\n <p>\n <code>API_ACTIVITY</code>\n </p>\n </li>\n <li>\n <p>\n <code>CLOUD_API</code>\n </p>\n </li>\n </ul>"
}
},
"configuration": {
"target": "com.amazonaws.securitylake#CustomLogSourceConfiguration",
"traits": {
"smithy.api#documentation": "<p>The configuration for the third-party custom source.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.securitylake#CreateCustomLogSourceResponse": {
"type": "structure",
"members": {
"source": {
"target": "com.amazonaws.securitylake#CustomLogSourceResource",
"traits": {
"smithy.api#documentation": "<p>The created third-party custom source.</p>"
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.securitylake#CreateDataLake": {
"type": "operation",
"input": {
"target": "com.amazonaws.securitylake#CreateDataLakeRequest"
},
"output": {
"target": "com.amazonaws.securitylake#CreateDataLakeResponse"
},
"errors": [
{
"target": "com.amazonaws.securitylake#AccessDeniedException"
},
{
"target": "com.amazonaws.securitylake#BadRequestException"
},
{
"target": "com.amazonaws.securitylake#ConflictException"
},
{
"target": "com.amazonaws.securitylake#InternalServerException"
},
{
"target": "com.amazonaws.securitylake#ResourceNotFoundException"
},
{
"target": "com.amazonaws.securitylake#ThrottlingException"
}
],
"traits": {
"aws.iam#actionPermissionDescription": "Grants permission to create a new security data lake",
"aws.iam#conditionKeys": [
"aws:TagKeys",
"aws:RequestTag/${TagKey}"
],
"aws.iam#requiredActions": [
"iam:CreateServiceLinkedRole",
"iam:GetRole",
"iam:PutRolePolicy",
"iam:DeleteRolePolicy",
"iam:PassRole",
"s3:PutBucketPolicy",
"s3:PutBucketPublicAccessBlock",
"s3:CreateBucket",
"s3:ListBucket",
"s3:PutBucketVersioning",
"s3:PutBucketVersioning",
"organizations:DescribeOrganization",
"organizations:ListDelegatedServicesForAccount",
"lakeformation:GetDataLakeSettings",
"lakeformation:PutDataLakeSettings",
"kms:DescribeKey",
"kms:CreateGrant",
"events:PutRule",
"events:PutTargets",
"sqs:CreateQueue",
"sqs:GetQueueAttributes",
"sqs:SetQueueAttributes",
"lambda:CreateFunction",
"lambda:CreateEventSourceMapping"
],
"smithy.api#documentation": "<p>Initializes an Amazon Security Lake instance with the provided (or default) configuration. You\n can enable Security Lake in Amazon Web Services Regions with customized settings before enabling\n log collection in Regions. To specify particular Regions, configure these Regions using the\n <code>configurations</code> parameter. If you have already enabled Security Lake in a Region\n when you call this command, the command will update the Region if you provide new\n configuration parameters. If you have not already enabled Security Lake in the Region when you\n call this API, it will set up the data lake in the Region with the specified\n configurations.</p>\n <p>When you enable Security Lake, it starts ingesting security data after the\n <code>CreateAwsLogSource</code> call. This includes ingesting security data from\n sources, storing data, and making data accessible to subscribers. Security Lake also enables\n all the existing settings and resources that it stores or maintains for your Amazon Web Services account in the current Region, including security log and event data. For\n more information, see the <a href=\"https://docs.aws.amazon.com/security-lake/latest/userguide/what-is-security-lake.html\">Amazon Security Lake User\n Guide</a>.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/v1/datalake",
"code": 200
}
}
},
"com.amazonaws.securitylake#CreateDataLakeExceptionSubscription": {
"type": "operation",
"input": {
"target": "com.amazonaws.securitylake#CreateDataLakeExceptionSubscriptionRequest"
},
"output": {
"target": "com.amazonaws.securitylake#CreateDataLakeExceptionSubscriptionResponse"
},
"errors": [
{
"target": "com.amazonaws.securitylake#AccessDeniedException"
},
{
"target": "com.amazonaws.securitylake#BadRequestException"
},
{
"target": "com.amazonaws.securitylake#ConflictException"
},
{
"target": "com.amazonaws.securitylake#InternalServerException"
},
{
"target": "com.amazonaws.securitylake#ResourceNotFoundException"
},
{
"target": "com.amazonaws.securitylake#ThrottlingException"
}
],
"traits": {
"aws.iam#actionPermissionDescription": "Grants permission to get instant notifications about exceptions. Subscribes to the SNS topics for exception notifications",
"smithy.api#documentation": "<p>Creates the specified notification subscription in Amazon Security Lake for the organization\n you specify.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/v1/datalake/exceptions/subscription",
"code": 200
}
}
},
"com.amazonaws.securitylake#CreateDataLakeExceptionSubscriptionRequest": {
"type": "structure",
"members": {
"subscriptionProtocol": {
"target": "com.amazonaws.securitylake#SubscriptionProtocol",
"traits": {
"smithy.api#documentation": "<p>The subscription protocol to which exception notifications are posted.</p>",
"smithy.api#required": {}
}
},
"notificationEndpoint": {
"target": "com.amazonaws.securitylake#SafeString",
"traits": {
"smithy.api#documentation": "<p>The Amazon Web Services account where you want to receive exception notifications.</p>",
"smithy.api#required": {}
}
},
"exceptionTimeToLive": {
"target": "smithy.api#Long",
"traits": {
"smithy.api#documentation": "<p>The expiration period and time-to-live (TTL).</p>",
"smithy.api#range": {
"min": 1
}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.securitylake#CreateDataLakeExceptionSubscriptionResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.securitylake#CreateDataLakeOrganizationConfiguration": {
"type": "operation",
"input": {
"target": "com.amazonaws.securitylake#CreateDataLakeOrganizationConfigurationRequest"
},
"output": {
"target": "com.amazonaws.securitylake#CreateDataLakeOrganizationConfigurationResponse"
},
"errors": [
{
"target": "com.amazonaws.securitylake#AccessDeniedException"
},
{
"target": "com.amazonaws.securitylake#BadRequestException"
},
{
"target": "com.amazonaws.securitylake#ConflictException"
},
{
"target": "com.amazonaws.securitylake#InternalServerException"
},
{
"target": "com.amazonaws.securitylake#ResourceNotFoundException"
},
{
"target": "com.amazonaws.securitylake#ThrottlingException"
}
],
"traits": {
"aws.iam#actionPermissionDescription": "Grants permission to automatically enable Amazon Security Lake for new member accounts in your organization. or Grants permission to automatically enable Amazon Security Lake for new organization accounts",
"smithy.api#documentation": "<p>Automatically enables Amazon Security Lake for new member accounts in your organization.\n Security Lake is not automatically enabled for any existing member accounts in your\n organization.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/v1/datalake/organization/configuration",
"code": 200
}
}
},
"com.amazonaws.securitylake#CreateDataLakeOrganizationConfigurationRequest": {
"type": "structure",
"members": {
"autoEnableNewAccount": {
"target": "com.amazonaws.securitylake#DataLakeAutoEnableNewAccountConfigurationList",
"traits": {
"smithy.api#documentation": "<p>Enable Security Lake with the specified configuration settings, to begin collecting security\n data for new accounts in your organization.</p>"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.securitylake#CreateDataLakeOrganizationConfigurationResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.securitylake#CreateDataLakeRequest": {
"type": "structure",
"members": {
"configurations": {
"target": "com.amazonaws.securitylake#DataLakeConfigurationList",
"traits": {
"smithy.api#documentation": "<p>Specify the Region or Regions that will contribute data to the rollup region.</p>",
"smithy.api#required": {}
}
},
"metaStoreManagerRoleArn": {
"target": "com.amazonaws.securitylake#RoleArn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) used to create and update the Glue table.\n This table contains partitions generated by the ingestion and normalization of\n Amazon Web Services log sources and custom sources.</p>",
"smithy.api#required": {}
}
},
"tags": {
"target": "com.amazonaws.securitylake#TagList",
"traits": {
"smithy.api#documentation": "<p>An array of objects, one for each tag to associate with the data lake configuration. For each tag, you must specify both a tag key and a tag value. A tag \n value cannot be null, but it can be an empty string.</p>"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.securitylake#CreateDataLakeResponse": {
"type": "structure",
"members": {
"dataLakes": {
"target": "com.amazonaws.securitylake#DataLakeResourceList",
"traits": {
"smithy.api#documentation": "<p>The created Security Lake configuration object.</p>"
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.securitylake#CreateSubscriber": {
"type": "operation",
"input": {
"target": "com.amazonaws.securitylake#CreateSubscriberRequest"
},
"output": {
"target": "com.amazonaws.securitylake#CreateSubscriberResponse"
},
"errors": [
{
"target": "com.amazonaws.securitylake#AccessDeniedException"
},
{
"target": "com.amazonaws.securitylake#BadRequestException"
},
{
"target": "com.amazonaws.securitylake#ConflictException"
},
{
"target": "com.amazonaws.securitylake#InternalServerException"
},
{
"target": "com.amazonaws.securitylake#ResourceNotFoundException"
},
{
"target": "com.amazonaws.securitylake#ThrottlingException"
}
],
"traits": {
"aws.iam#actionPermissionDescription": "Grants permission to create a subscriber",
"aws.iam#conditionKeys": [
"aws:TagKeys",
"aws:RequestTag/${TagKey}"
],
"aws.iam#requiredActions": [
"iam:GetRole",
"iam:PutRolePolicy",
"iam:DeleteRolePolicy",
"iam:CreateRole",
"s3:PutObject",
"lakeformation:RegisterResource",
"lakeformation:GrantPermissions",
"lakeformation:RevokePermissions",
"lakeformation:ListPermissions",
"ram:GetResourceShareAssociations",
"ram:UpdateResourceShare",
"ram:GetResourceShares"
],
"smithy.api#documentation": "<p>Creates a subscription permission for accounts that are already enabled in\n Amazon Security Lake. You can create a subscriber with access to data in the current Amazon Web Services Region.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/v1/subscribers",
"code": 200
}
}
},
"com.amazonaws.securitylake#CreateSubscriberNotification": {
"type": "operation",
"input": {
"target": "com.amazonaws.securitylake#CreateSubscriberNotificationRequest"
},
"output": {
"target": "com.amazonaws.securitylake#CreateSubscriberNotificationResponse"
},
"errors": [
{
"target": "com.amazonaws.securitylake#AccessDeniedException"
},
{
"target": "com.amazonaws.securitylake#BadRequestException"
},
{
"target": "com.amazonaws.securitylake#ConflictException"
},
{
"target": "com.amazonaws.securitylake#InternalServerException"
},
{
"target": "com.amazonaws.securitylake#ResourceNotFoundException"
},
{
"target": "com.amazonaws.securitylake#ThrottlingException"
}
],
"traits": {
"aws.iam#actionPermissionDescription": "Grants permission to create a webhook invocation to notify a client when there is new data in the data lake",
"aws.iam#requiredActions": [
"iam:GetRole",
"iam:PassRole",
"iam:DeleteRolePolicy",
"s3:PutBucketNotification",
"s3:GetBucketNotification",
"events:CreateApiDestination",
"events:CreateConnection",
"events:ListApiDestinations",
"events:ListConnections",
"events:PutRule",
"events:DescribeRule",
"events:PutTargets",
"sqs:CreateQueue",
"sqs:DeleteQueue",
"sqs:GetQueueAttributes",
"sqs:GetQueueUrl",
"sqs:SetQueueAttributes"
],
"smithy.api#documentation": "<p>Notifies the subscriber when new data is written to the data lake for the sources that\n the subscriber consumes in Security Lake. You can create only one subscriber notification per\n subscriber.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/v1/subscribers/{subscriberId}/notification",
"code": 200
}
}
},
"com.amazonaws.securitylake#CreateSubscriberNotificationRequest": {
"type": "structure",
"members": {
"subscriberId": {
"target": "com.amazonaws.securitylake#UUID",
"traits": {
"smithy.api#documentation": "<p>The subscriber ID for the notification subscription.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"configuration": {
"target": "com.amazonaws.securitylake#NotificationConfiguration",
"traits": {
"smithy.api#documentation": "<p>Specify the configuration using which you want to create the subscriber\n notification.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.securitylake#CreateSubscriberNotificationResponse": {
"type": "structure",
"members": {
"subscriberEndpoint": {
"target": "com.amazonaws.securitylake#SafeString",
"traits": {
"smithy.api#documentation": "<p>The subscriber endpoint to which exception messages are posted.</p>"
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.securitylake#CreateSubscriberRequest": {
"type": "structure",
"members": {
"subscriberIdentity": {
"target": "com.amazonaws.securitylake#AwsIdentity",
"traits": {
"smithy.api#documentation": "<p>The Amazon Web Services identity used to access your data.</p>",
"smithy.api#required": {}
}
},
"subscriberName": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The name of your Security Lake subscriber account.</p>",
"smithy.api#length": {
"max": 64
},
"smithy.api#required": {}
}
},
"subscriberDescription": {
"target": "com.amazonaws.securitylake#DescriptionString",
"traits": {
"smithy.api#documentation": "<p>The description for your subscriber account in Security Lake.</p>"
}
},
"sources": {
"target": "com.amazonaws.securitylake#LogSourceResourceList",
"traits": {
"smithy.api#documentation": "<p>The supported Amazon Web Services from which logs and events are collected.\n Security Lake supports log and event collection for natively supported Amazon Web Services.</p>",
"smithy.api#required": {}
}
},
"accessTypes": {
"target": "com.amazonaws.securitylake#AccessTypeList",
"traits": {
"smithy.api#documentation": "<p>The Amazon S3 or Lake Formation access type.</p>"
}
},
"tags": {
"target": "com.amazonaws.securitylake#TagList",
"traits": {
"smithy.api#documentation": "<p>An array of objects, one for each tag to associate with the subscriber. For each tag, you must specify both a tag key and a tag value. A tag \n value cannot be null, but it can be an empty string.</p>"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.securitylake#CreateSubscriberResponse": {
"type": "structure",
"members": {
"subscriber": {
"target": "com.amazonaws.securitylake#SubscriberResource",
"traits": {
"smithy.api#documentation": "<p>Retrieve information about the subscriber created using the\n <code>CreateSubscriber</code> API.</p>"
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.securitylake#CustomLogSourceAttributes": {
"type": "structure",
"members": {
"crawlerArn": {
"target": "com.amazonaws.securitylake#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The ARN of the Glue crawler.</p>"
}
},
"databaseArn": {
"target": "com.amazonaws.securitylake#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The ARN of the Glue database where results are written, such as:\n <code>arn:aws:daylight:us-east-1::database/sometable/*</code>.</p>"
}
},
"tableArn": {
"target": "com.amazonaws.securitylake#AmazonResourceName",
"traits": {
"smithy.api#documentation": "<p>The ARN of the Glue table.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The attributes of a third-party custom source.</p>"
}
},
"com.amazonaws.securitylake#CustomLogSourceConfiguration": {
"type": "structure",
"members": {
"crawlerConfiguration": {
"target": "com.amazonaws.securitylake#CustomLogSourceCrawlerConfiguration",
"traits": {
"smithy.api#documentation": "<p>The configuration for the Glue Crawler for the third-party custom source.</p>",
"smithy.api#required": {}
}
},
"providerIdentity": {
"target": "com.amazonaws.securitylake#AwsIdentity",
"traits": {
"smithy.api#documentation": "<p>The identity of the log provider for the third-party custom source.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The configuration for the third-party custom source.</p>"
}
},
"com.amazonaws.securitylake#CustomLogSourceCrawlerConfiguration": {
"type": "structure",
"members": {
"roleArn": {
"target": "com.amazonaws.securitylake#RoleArn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role\n to be used by the Glue crawler. The recommended IAM policies\n are:</p>\n <ul>\n <li>\n <p>The managed policy <code>AWSGlueServiceRole</code>\n </p>\n </li>\n <li>\n <p>A custom policy granting access to your Amazon S3 Data Lake</p>\n </li>\n </ul>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The configuration for the Glue Crawler for the third-party custom source.</p>"
}
},
"com.amazonaws.securitylake#CustomLogSourceName": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 64
},
"smithy.api#pattern": "^[\\w\\-\\_\\:\\.]*$"
}
},
"com.amazonaws.securitylake#CustomLogSourceProvider": {
"type": "structure",
"members": {
"roleArn": {
"target": "com.amazonaws.securitylake#RoleArn",
"traits": {
"smithy.api#documentation": "<p>The ARN of the IAM role to be used by the entity putting logs into your\n custom source partition. Security Lake will apply the correct access policies to this role, but\n you must first manually create the trust policy for this role. The IAM role\n name must start with the text 'Security Lake'. The IAM role must trust the\n <code>logProviderAccountId</code> to assume the role.</p>"
}
},
"location": {