forked from aws/aws-sdk-go-v2
-
Notifications
You must be signed in to change notification settings - Fork 1
/
cloudtrail.2013-11-01.json
5252 lines (5252 loc) · 286 KB
/
cloudtrail.2013-11-01.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": "1.0",
"metadata": {
"suppressions": [
{
"id": "HttpMethodSemantics",
"namespace": "*"
},
{
"id": "HttpResponseCodeSemantics",
"namespace": "*"
},
{
"id": "PaginatedTrait",
"namespace": "*"
},
{
"id": "HttpHeaderTrait",
"namespace": "*"
},
{
"id": "HttpUriConflict",
"namespace": "*"
},
{
"id": "Service",
"namespace": "*"
}
]
},
"shapes": {
"com.amazonaws.cloudtrail#AddTags": {
"type": "operation",
"input": {
"target": "com.amazonaws.cloudtrail#AddTagsRequest"
},
"output": {
"target": "com.amazonaws.cloudtrail#AddTagsResponse"
},
"errors": [
{
"target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException"
},
{
"target": "com.amazonaws.cloudtrail#ConflictException"
},
{
"target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException"
},
{
"target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException"
},
{
"target": "com.amazonaws.cloudtrail#InvalidTagParameterException"
},
{
"target": "com.amazonaws.cloudtrail#InvalidTrailNameException"
},
{
"target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException"
},
{
"target": "com.amazonaws.cloudtrail#OperationNotPermittedException"
},
{
"target": "com.amazonaws.cloudtrail#ResourceNotFoundException"
},
{
"target": "com.amazonaws.cloudtrail#ResourceTypeNotSupportedException"
},
{
"target": "com.amazonaws.cloudtrail#TagsLimitExceededException"
},
{
"target": "com.amazonaws.cloudtrail#UnsupportedOperationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Adds one or more tags to a trail, up to a limit of 50. Overwrites an existing tag's value when a new value is specified for an existing tag key. \n Tag key names must be unique for a trail; you cannot have two keys with the same name but different values. \n If you specify a key without a value, the tag will be created with the specified key and a value of null. \n You can tag a trail that applies to all Amazon Web Services Regions only from the Region in which the trail was created (also known as its home region).</p>",
"smithy.api#idempotent": {}
}
},
"com.amazonaws.cloudtrail#AddTagsRequest": {
"type": "structure",
"members": {
"ResourceId": {
"target": "com.amazonaws.cloudtrail#String",
"traits": {
"smithy.api#documentation": "<p>Specifies the ARN of the trail to which one or more tags will be added. The format of a trail ARN is:</p>\n <p>\n <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>\n </p>",
"smithy.api#required": {}
}
},
"TagsList": {
"target": "com.amazonaws.cloudtrail#TagsList",
"traits": {
"smithy.api#documentation": "<p>Contains a list of tags, up to a limit of 50</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Specifies the tags to add to a trail.</p>"
}
},
"com.amazonaws.cloudtrail#AddTagsResponse": {
"type": "structure",
"members": {},
"traits": {
"smithy.api#documentation": "<p>Returns the objects or data if successful. Otherwise, returns an error.</p>"
}
},
"com.amazonaws.cloudtrail#AdvancedEventSelector": {
"type": "structure",
"members": {
"Name": {
"target": "com.amazonaws.cloudtrail#SelectorName",
"traits": {
"smithy.api#documentation": "<p>An optional, descriptive name for an advanced event selector, such as \"Log data events\n for only two S3 buckets\".</p>"
}
},
"FieldSelectors": {
"target": "com.amazonaws.cloudtrail#AdvancedFieldSelectors",
"traits": {
"smithy.api#documentation": "<p>Contains all selector statements in an advanced event selector.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Advanced event selectors let you create fine-grained selectors for the following CloudTrail \n event record fields. They help you control costs by logging only those events\n that are important to you. For more information about advanced event selectors, see <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html\">Logging data events for trails</a> in the <i>CloudTrail User Guide</i>.</p>\n <ul>\n <li>\n <p>\n <code>readOnly</code>\n </p>\n </li>\n <li>\n <p>\n <code>eventSource</code>\n </p>\n </li>\n <li>\n <p>\n <code>eventName</code>\n </p>\n </li>\n <li>\n <p>\n <code>eventCategory</code>\n </p>\n </li>\n <li>\n <p>\n <code>resources.type</code>\n </p>\n </li>\n <li>\n <p>\n <code>resources.ARN</code>\n </p>\n </li>\n </ul>\n <p>You cannot apply both event selectors and advanced event selectors to a trail.</p>"
}
},
"com.amazonaws.cloudtrail#AdvancedEventSelectors": {
"type": "list",
"member": {
"target": "com.amazonaws.cloudtrail#AdvancedEventSelector"
}
},
"com.amazonaws.cloudtrail#AdvancedFieldSelector": {
"type": "structure",
"members": {
"Field": {
"target": "com.amazonaws.cloudtrail#SelectorField",
"traits": {
"smithy.api#documentation": "<p>\n A field in an event record on which to filter events to be logged. Supported fields include <code>readOnly</code>, <code>eventCategory</code>, \n <code>eventSource</code> (for management events), <code>eventName</code>, <code>resources.type</code>, and <code>resources.ARN</code>.\n </p>\n <ul>\n <li>\n <p>\n <b>\n <code>readOnly</code>\n </b> - Optional. Can be set to <code>Equals</code> a value of <code>true</code>\n or <code>false</code>. If you do not add this field, CloudTrail logs both both <code>read</code> and\n <code>write</code> events. A value of <code>true</code> logs only <code>read</code> events. A value of <code>false</code> \n logs only <code>write</code> events.</p>\n </li>\n <li>\n <p>\n <b>\n <code>eventSource</code>\n </b> - For filtering management events only. \n This can be set only to <code>NotEquals</code> \n <code>kms.amazonaws.com</code>.</p>\n </li>\n <li>\n <p>\n <b>\n <code>eventName</code>\n </b> - Can use any operator. You can use it to filter in\n or filter out any data event logged to CloudTrail, such as <code>PutBucket</code> or <code>GetSnapshotBlock</code>. You can have multiple values\n for this field, separated by commas.</p>\n </li>\n <li>\n <p>\n <b>\n <code>eventCategory</code>\n </b> - This is required. It must be set to <code>Equals</code>, and \n the value must be <code>Management</code> or <code>Data</code>.</p>\n </li>\n <li>\n <p>\n <b>\n <code>resources.type</code>\n </b> - This field is required.\n <code>resources.type</code> can only use the <code>Equals</code> operator, and the\n value can be one of the following:</p>\n <ul>\n <li>\n <p>\n <code>AWS::S3::Object</code>\n </p>\n </li>\n <li>\n <p>\n <code>AWS::Lambda::Function</code>\n </p>\n </li>\n <li>\n <p>\n <code>AWS::DynamoDB::Table</code>\n </p>\n </li>\n <li>\n <p>\n <code>AWS::S3Outposts::Object</code>\n </p>\n </li>\n <li>\n <p>\n <code>AWS::ManagedBlockchain::Node</code>\n </p>\n </li>\n <li>\n <p>\n <code>AWS::S3ObjectLambda::AccessPoint</code>\n </p>\n </li>\n <li>\n <p>\n <code>AWS::EC2::Snapshot</code>\n </p>\n </li>\n <li>\n <p>\n <code>AWS::S3::AccessPoint</code>\n </p>\n </li>\n <li>\n <p>\n <code>AWS::DynamoDB::Stream</code>\n </p>\n </li>\n <li>\n <p>\n <code>AWS::Glue::Table</code>\n </p>\n </li>\n </ul>\n <p>\n You can have only one <code>resources.type</code> field per selector. To log data\n events on more than one resource type, add another selector.</p>\n </li>\n <li>\n <p>\n <b>\n <code>resources.ARN</code>\n </b> - You can use any operator with\n <code>resources.ARN</code>, but if you use <code>Equals</code> or <code>NotEquals</code>, the\n value must exactly match the ARN of a valid resource of the type you've specified in\n the template as the value of resources.type. For example, if resources.type equals\n <code>AWS::S3::Object</code>, the ARN must be in one of the following formats. To\n log all data events for all objects in a specific S3 bucket, use the\n <code>StartsWith</code> operator, and include only the bucket ARN as the matching value.</p>\n <p>The trailing slash is intentional; do not exclude it. Replace the text between\n less than and greater than symbols (<>) with resource-specific information. </p>\n <ul>\n <li>\n <p>\n <code>arn:<partition>:s3:::<bucket_name>/</code>\n </p>\n </li>\n <li>\n <p>\n <code>arn:<partition>:s3:::<bucket_name>/<object_path>/</code>\n </p>\n </li>\n </ul>\n <p>When <code>resources.type</code> equals <code>AWS::S3::AccessPoint</code>, and the\n operator is set to <code>Equals</code> or <code>NotEquals</code>, the ARN must be in\n one of the following formats. To log events on all objects in an S3 access point, we\n recommend that you use only the access point ARN, don’t include the object path, and\n use the <code>StartsWith</code> or <code>NotStartsWith</code> operators.</p>\n <ul>\n <li>\n <p>\n <code>arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name></code>\n </p>\n </li>\n <li>\n <p>\n <code>arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>/object/<object_path></code>\n </p>\n </li>\n </ul>\n <p>When resources.type equals <code>AWS::Lambda::Function</code>, and the operator is set\n to <code>Equals</code> or <code>NotEquals</code>, the ARN must be in the following format:</p>\n <ul>\n <li>\n <p>\n <code>arn:<partition>:lambda:<region>:<account_ID>:function:<function_name></code>\n </p>\n </li>\n </ul>\n <p>When resources.type equals <code>AWS::DynamoDB::Table</code>, and the operator is\n set to <code>Equals</code> or <code>NotEquals</code>, the ARN must be in the\n following format:</p>\n <ul>\n <li>\n <p>\n <code>arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name></code>\n </p>\n </li>\n </ul>\n <p>When <code>resources.type</code> equals <code>AWS::S3Outposts::Object</code>, and the operator \n is set to <code>Equals</code> or <code>NotEquals</code>, the ARN must be in the following format:</p>\n <ul>\n <li>\n <p>\n <code>arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path></code>\n </p>\n </li>\n </ul>\n <p>When <code>resources.type</code> equals <code>AWS::ManagedBlockchain::Node</code>,\n and the operator is set to <code>Equals</code> or <code>NotEquals</code>, the ARN\n must be in the following format:</p>\n <ul>\n <li>\n <p>\n <code>arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID></code>\n </p>\n </li>\n </ul>\n <p>When <code>resources.type</code> equals\n <code>AWS::S3ObjectLambda::AccessPoint</code>, and the operator is set to\n <code>Equals</code> or <code>NotEquals</code>, the ARN must be in the following\n format:</p>\n <ul>\n <li>\n <p>\n <code>arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name></code>\n </p>\n </li>\n </ul>\n <p>When <code>resources.type</code> equals <code>AWS::EC2::Snapshot</code>, and the\n operator is set to <code>Equals</code> or <code>NotEquals</code>, the ARN must be in\n the following format:</p>\n <ul>\n <li>\n <p>\n <code>arn:<partition>:ec2:<region>::snapshot/<snapshot_ID></code>\n </p>\n </li>\n </ul>\n <p>When <code>resources.type</code> equals <code>AWS::DynamoDB::Stream</code>, and the operator is set to\n <code>Equals</code> or <code>NotEquals</code>, the ARN must be in the following format:</p>\n <ul>\n <li>\n <p>\n <code>arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time></code>\n </p>\n </li>\n </ul>\n <p>When <code>resources.type</code> equals <code>AWS::Glue::Table</code>, and the operator is set to\n <code>Equals</code> or <code>NotEquals</code>, the ARN must be in the following format:</p>\n <ul>\n <li>\n <p>\n <code>arn:<partition>:glue:<region>:<account_ID>:table/<database_name>/<table_name></code>\n </p>\n </li>\n </ul>\n </li>\n </ul>",
"smithy.api#required": {}
}
},
"Equals": {
"target": "com.amazonaws.cloudtrail#Operator",
"traits": {
"smithy.api#documentation": "<p> An operator that includes events that match the exact value of the event record field\n specified as the value of <code>Field</code>. This is the only valid operator that you can\n use with the <code>readOnly</code>, <code>eventCategory</code>, and\n <code>resources.type</code> fields.</p>"
}
},
"StartsWith": {
"target": "com.amazonaws.cloudtrail#Operator",
"traits": {
"smithy.api#documentation": "<p>An operator that includes events that match the first few characters of the event record\n field specified as the value of <code>Field</code>.</p>"
}
},
"EndsWith": {
"target": "com.amazonaws.cloudtrail#Operator",
"traits": {
"smithy.api#documentation": "<p>An operator that includes events that match the last few characters of the event record\n field specified as the value of <code>Field</code>.</p>"
}
},
"NotEquals": {
"target": "com.amazonaws.cloudtrail#Operator",
"traits": {
"smithy.api#documentation": "<p>\n An operator that excludes events that match the exact value of the event record field specified as the value of <code>Field</code>.\n </p>"
}
},
"NotStartsWith": {
"target": "com.amazonaws.cloudtrail#Operator",
"traits": {
"smithy.api#documentation": "<p>\n An operator that excludes events that match the first few characters of the event record field specified as the value of <code>Field</code>.\n </p>"
}
},
"NotEndsWith": {
"target": "com.amazonaws.cloudtrail#Operator",
"traits": {
"smithy.api#documentation": "<p>\n An operator that excludes events that match the last few characters of the event record field specified as the value of <code>Field</code>.\n </p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A single selector statement in an advanced event selector.</p>"
}
},
"com.amazonaws.cloudtrail#AdvancedFieldSelectors": {
"type": "list",
"member": {
"target": "com.amazonaws.cloudtrail#AdvancedFieldSelector"
},
"traits": {
"smithy.api#length": {
"min": 1
}
}
},
"com.amazonaws.cloudtrail#Boolean": {
"type": "boolean",
"traits": {
"smithy.api#box": {}
}
},
"com.amazonaws.cloudtrail#ByteBuffer": {
"type": "blob"
},
"com.amazonaws.cloudtrail#CancelQuery": {
"type": "operation",
"input": {
"target": "com.amazonaws.cloudtrail#CancelQueryRequest"
},
"output": {
"target": "com.amazonaws.cloudtrail#CancelQueryResponse"
},
"errors": [
{
"target": "com.amazonaws.cloudtrail#ConflictException"
},
{
"target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException"
},
{
"target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException"
},
{
"target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException"
},
{
"target": "com.amazonaws.cloudtrail#InactiveQueryException"
},
{
"target": "com.amazonaws.cloudtrail#InvalidParameterException"
},
{
"target": "com.amazonaws.cloudtrail#OperationNotPermittedException"
},
{
"target": "com.amazonaws.cloudtrail#QueryIdNotFoundException"
},
{
"target": "com.amazonaws.cloudtrail#UnsupportedOperationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Cancels a query if the query is not in a terminated state, such as <code>CANCELLED</code>, <code>FAILED</code> or <code>FINISHED</code>. You must specify an ARN value for <code>EventDataStore</code>. \n The ID of the query that you want to cancel is also required. When you run <code>CancelQuery</code>, the query status might \n show as <code>CANCELLED</code> even if the operation is not yet finished.</p>",
"smithy.api#idempotent": {}
}
},
"com.amazonaws.cloudtrail#CancelQueryRequest": {
"type": "structure",
"members": {
"EventDataStore": {
"target": "com.amazonaws.cloudtrail#EventDataStoreArn",
"traits": {
"smithy.api#documentation": "<p>The ARN (or the ID suffix of the ARN) of an event data store on which the specified query is running.</p>",
"smithy.api#required": {}
}
},
"QueryId": {
"target": "com.amazonaws.cloudtrail#UUID",
"traits": {
"smithy.api#documentation": "<p>The ID of the query that you want to cancel. The <code>QueryId</code> comes from the response of a <code>StartQuery</code> \n operation.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.cloudtrail#CancelQueryResponse": {
"type": "structure",
"members": {
"QueryId": {
"target": "com.amazonaws.cloudtrail#UUID",
"traits": {
"smithy.api#documentation": "<p>The ID of the canceled query.</p>",
"smithy.api#required": {}
}
},
"QueryStatus": {
"target": "com.amazonaws.cloudtrail#QueryStatus",
"traits": {
"smithy.api#documentation": "<p>Shows the status of a query after a <code>CancelQuery</code> request. Typically, the values shown are either \n <code>RUNNING</code> or <code>CANCELLED</code>.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.cloudtrail#CloudTrailARNInvalidException": {
"type": "structure",
"members": {
"Message": {
"target": "com.amazonaws.cloudtrail#ErrorMessage",
"traits": {
"smithy.api#documentation": "<p>Brief description of the exception returned by the request.</p>"
}
}
},
"traits": {
"aws.protocols#awsQueryError": {
"code": "CloudTrailARNInvalid",
"httpResponseCode": 400
},
"smithy.api#documentation": "<p>This exception is thrown when an operation is called with a trail ARN that is not valid. The following is the format of a trail ARN.</p>\n <p>\n <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>\n </p>",
"smithy.api#error": "client",
"smithy.api#httpError": 400
}
},
"com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException": {
"type": "structure",
"members": {
"Message": {
"target": "com.amazonaws.cloudtrail#ErrorMessage",
"traits": {
"smithy.api#documentation": "<p>Brief description of the exception returned by the request.</p>"
}
}
},
"traits": {
"aws.protocols#awsQueryError": {
"code": "CloudTrailAccessNotEnabled",
"httpResponseCode": 400
},
"smithy.api#documentation": "<p>This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, \n see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html\">Enabling Trusted Access with Other Amazon Web Services Services</a>\n and <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html\">Prepare For Creating a Trail For Your Organization</a>. </p>",
"smithy.api#error": "client",
"smithy.api#httpError": 400
}
},
"com.amazonaws.cloudtrail#CloudTrailInvalidClientTokenIdException": {
"type": "structure",
"members": {
"Message": {
"target": "com.amazonaws.cloudtrail#ErrorMessage",
"traits": {
"smithy.api#documentation": "<p>Brief description of the exception returned by the request.</p>"
}
}
},
"traits": {
"aws.protocols#awsQueryError": {
"code": "CloudTrailInvalidClientTokenId",
"httpResponseCode": 400
},
"smithy.api#documentation": "<p>This exception is thrown when a call results in the <code>InvalidClientTokenId</code> error code. \n This can occur when you are creating or updating a trail to send notifications to an Amazon SNS topic that \n is in a suspended Amazon Web Services account.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 400
}
},
"com.amazonaws.cloudtrail#CloudTrail_20131101": {
"type": "service",
"traits": {
"aws.api#service": {
"sdkId": "CloudTrail",
"arnNamespace": "cloudtrail",
"cloudFormationName": "CloudTrail",
"cloudTrailEventSource": "cloudtrail.amazonaws.com",
"endpointPrefix": "cloudtrail"
},
"aws.auth#sigv4": {
"name": "cloudtrail"
},
"aws.protocols#awsJson1_1": {},
"smithy.api#documentation": "<fullname>CloudTrail</fullname>\n <p>This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.</p>\n <p>CloudTrail is a web service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. \n The recorded information includes the identity of the user, the start time of the Amazon Web Services API call, the source IP address, the request parameters, and the response elements returned by the service.</p> \n \n <note>\n <p>As an alternative to the API,\n you can use one of the Amazon Web Services SDKs, which consist of libraries and sample code for various\n programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs\n provide programmatic access to CloudTrail. For example, the SDKs\n handle cryptographically signing requests, managing errors, and retrying requests\n automatically. For more information about the Amazon Web Services SDKs, including how to download and install\n them, see <a href=\"http://aws.amazon.com/tools/\">Tools to Build on Amazon Web Services</a>.</p> \n </note> \n <p>See the <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-user-guide.html\">CloudTrail User \n Guide</a> for information about the data that is included with each Amazon Web Services API call listed in the log files.</p>",
"smithy.api#title": "AWS CloudTrail",
"smithy.api#xmlNamespace": {
"uri": "http://cloudtrail.amazonaws.com/doc/2013-11-01/"
}
},
"version": "2013-11-01",
"operations": [
{
"target": "com.amazonaws.cloudtrail#AddTags"
},
{
"target": "com.amazonaws.cloudtrail#CancelQuery"
},
{
"target": "com.amazonaws.cloudtrail#CreateEventDataStore"
},
{
"target": "com.amazonaws.cloudtrail#CreateTrail"
},
{
"target": "com.amazonaws.cloudtrail#DeleteEventDataStore"
},
{
"target": "com.amazonaws.cloudtrail#DeleteTrail"
},
{
"target": "com.amazonaws.cloudtrail#DescribeQuery"
},
{
"target": "com.amazonaws.cloudtrail#DescribeTrails"
},
{
"target": "com.amazonaws.cloudtrail#GetEventDataStore"
},
{
"target": "com.amazonaws.cloudtrail#GetEventSelectors"
},
{
"target": "com.amazonaws.cloudtrail#GetInsightSelectors"
},
{
"target": "com.amazonaws.cloudtrail#GetQueryResults"
},
{
"target": "com.amazonaws.cloudtrail#GetTrail"
},
{
"target": "com.amazonaws.cloudtrail#GetTrailStatus"
},
{
"target": "com.amazonaws.cloudtrail#ListEventDataStores"
},
{
"target": "com.amazonaws.cloudtrail#ListPublicKeys"
},
{
"target": "com.amazonaws.cloudtrail#ListQueries"
},
{
"target": "com.amazonaws.cloudtrail#ListTags"
},
{
"target": "com.amazonaws.cloudtrail#ListTrails"
},
{
"target": "com.amazonaws.cloudtrail#LookupEvents"
},
{
"target": "com.amazonaws.cloudtrail#PutEventSelectors"
},
{
"target": "com.amazonaws.cloudtrail#PutInsightSelectors"
},
{
"target": "com.amazonaws.cloudtrail#RemoveTags"
},
{
"target": "com.amazonaws.cloudtrail#RestoreEventDataStore"
},
{
"target": "com.amazonaws.cloudtrail#StartLogging"
},
{
"target": "com.amazonaws.cloudtrail#StartQuery"
},
{
"target": "com.amazonaws.cloudtrail#StopLogging"
},
{
"target": "com.amazonaws.cloudtrail#UpdateEventDataStore"
},
{
"target": "com.amazonaws.cloudtrail#UpdateTrail"
}
]
},
"com.amazonaws.cloudtrail#CloudWatchLogsDeliveryUnavailableException": {
"type": "structure",
"members": {
"Message": {
"target": "com.amazonaws.cloudtrail#ErrorMessage",
"traits": {
"smithy.api#documentation": "<p>Brief description of the exception returned by the request.</p>"
}
}
},
"traits": {
"aws.protocols#awsQueryError": {
"code": "CloudWatchLogsDeliveryUnavailable",
"httpResponseCode": 400
},
"smithy.api#documentation": "<p>Cannot set a CloudWatch Logs delivery for this region.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 400
}
},
"com.amazonaws.cloudtrail#ConflictException": {
"type": "structure",
"members": {
"Message": {
"target": "com.amazonaws.cloudtrail#ErrorMessage",
"traits": {
"smithy.api#documentation": "<p>Brief description of the exception returned by the request.</p>"
}
}
},
"traits": {
"aws.protocols#awsQueryError": {
"code": "ConflictException",
"httpResponseCode": 409
},
"smithy.api#documentation": "<p>This exception is thrown when the specified resource is not ready for an operation. \n This can occur when you try to run an operation on a trail before CloudTrail has time to fully load the trail. \n If this exception occurs, wait a few minutes, and then try the operation again.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 409
}
},
"com.amazonaws.cloudtrail#CreateEventDataStore": {
"type": "operation",
"input": {
"target": "com.amazonaws.cloudtrail#CreateEventDataStoreRequest"
},
"output": {
"target": "com.amazonaws.cloudtrail#CreateEventDataStoreResponse"
},
"errors": [
{
"target": "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException"
},
{
"target": "com.amazonaws.cloudtrail#ConflictException"
},
{
"target": "com.amazonaws.cloudtrail#EventDataStoreAlreadyExistsException"
},
{
"target": "com.amazonaws.cloudtrail#EventDataStoreMaxLimitExceededException"
},
{
"target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException"
},
{
"target": "com.amazonaws.cloudtrail#InvalidParameterException"
},
{
"target": "com.amazonaws.cloudtrail#InvalidTagParameterException"
},
{
"target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException"
},
{
"target": "com.amazonaws.cloudtrail#OperationNotPermittedException"
},
{
"target": "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException"
},
{
"target": "com.amazonaws.cloudtrail#OrganizationsNotInUseException"
},
{
"target": "com.amazonaws.cloudtrail#UnsupportedOperationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Creates a new event data store.</p>"
}
},
"com.amazonaws.cloudtrail#CreateEventDataStoreRequest": {
"type": "structure",
"members": {
"Name": {
"target": "com.amazonaws.cloudtrail#EventDataStoreName",
"traits": {
"smithy.api#documentation": "<p>The name of the event data store.</p>",
"smithy.api#required": {}
}
},
"AdvancedEventSelectors": {
"target": "com.amazonaws.cloudtrail#AdvancedEventSelectors",
"traits": {
"smithy.api#documentation": "<p>The advanced event selectors to use to select the events for the data store. For more information about how to use advanced event \n selectors, see <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#creating-data-event-selectors-advanced\">Log events by using advanced event selectors</a> in the CloudTrail \n User Guide.</p>"
}
},
"MultiRegionEnabled": {
"target": "com.amazonaws.cloudtrail#Boolean",
"traits": {
"smithy.api#documentation": "<p>Specifies whether the event data store includes events from all regions, or only from the region in which the event data store \n is created.</p>"
}
},
"OrganizationEnabled": {
"target": "com.amazonaws.cloudtrail#Boolean",
"traits": {
"smithy.api#documentation": "<p>Specifies whether an event data store collects events logged for an organization in Organizations.</p>"
}
},
"RetentionPeriod": {
"target": "com.amazonaws.cloudtrail#RetentionPeriod",
"traits": {
"smithy.api#documentation": "<p>The retention period of the event data store, in days. You can set a retention period of up to 2555 days, \n the equivalent of seven years.</p>"
}
},
"TerminationProtectionEnabled": {
"target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled",
"traits": {
"smithy.api#documentation": "<p>Specifies whether termination protection is enabled for the event data store. If termination protection is enabled, you \n cannot delete the event data store until termination protection is disabled.</p>"
}
},
"TagsList": {
"target": "com.amazonaws.cloudtrail#TagsList"
}
}
},
"com.amazonaws.cloudtrail#CreateEventDataStoreResponse": {
"type": "structure",
"members": {
"EventDataStoreArn": {
"target": "com.amazonaws.cloudtrail#EventDataStoreArn",
"traits": {
"smithy.api#documentation": "<p>The ARN of the event data store.</p>"
}
},
"Name": {
"target": "com.amazonaws.cloudtrail#EventDataStoreName",
"traits": {
"smithy.api#documentation": "<p>The name of the event data store.</p>"
}
},
"Status": {
"target": "com.amazonaws.cloudtrail#EventDataStoreStatus",
"traits": {
"smithy.api#documentation": "<p>The status of event data store creation.</p>"
}
},
"AdvancedEventSelectors": {
"target": "com.amazonaws.cloudtrail#AdvancedEventSelectors",
"traits": {
"smithy.api#documentation": "<p>The advanced event selectors that were used to select the events for the data store.</p>"
}
},
"MultiRegionEnabled": {
"target": "com.amazonaws.cloudtrail#Boolean",
"traits": {
"smithy.api#documentation": "<p>Indicates whether the event data store collects events from all regions, or only from the region in which it was created.</p>"
}
},
"OrganizationEnabled": {
"target": "com.amazonaws.cloudtrail#Boolean",
"traits": {
"smithy.api#documentation": "<p>Indicates whether an event data store is collecting logged events for an organization in Organizations.</p>"
}
},
"RetentionPeriod": {
"target": "com.amazonaws.cloudtrail#RetentionPeriod",
"traits": {
"smithy.api#documentation": "<p>The retention period of an event data store, in days.</p>"
}
},
"TerminationProtectionEnabled": {
"target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled",
"traits": {
"smithy.api#documentation": "<p>Indicates whether termination protection is enabled for the event data store.</p>"
}
},
"TagsList": {
"target": "com.amazonaws.cloudtrail#TagsList"
},
"CreatedTimestamp": {
"target": "com.amazonaws.cloudtrail#Date",
"traits": {
"smithy.api#documentation": "<p>The timestamp that shows when the event data store was created.</p>"
}
},
"UpdatedTimestamp": {
"target": "com.amazonaws.cloudtrail#Date",
"traits": {
"smithy.api#documentation": "<p>The timestamp that shows when an event data store was updated, if applicable. \n <code>UpdatedTimestamp</code> is always either the same or newer than the time shown in <code>CreatedTimestamp</code>.</p>"
}
}
}
},
"com.amazonaws.cloudtrail#CreateTrail": {
"type": "operation",
"input": {
"target": "com.amazonaws.cloudtrail#CreateTrailRequest"
},
"output": {
"target": "com.amazonaws.cloudtrail#CreateTrailResponse"
},
"errors": [
{
"target": "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException"
},
{
"target": "com.amazonaws.cloudtrail#CloudTrailInvalidClientTokenIdException"
},
{
"target": "com.amazonaws.cloudtrail#CloudWatchLogsDeliveryUnavailableException"
},
{
"target": "com.amazonaws.cloudtrail#ConflictException"
},
{
"target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException"
},
{
"target": "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException"
},
{
"target": "com.amazonaws.cloudtrail#InsufficientS3BucketPolicyException"
},
{
"target": "com.amazonaws.cloudtrail#InsufficientSnsTopicPolicyException"
},
{
"target": "com.amazonaws.cloudtrail#InvalidCloudWatchLogsLogGroupArnException"
},
{
"target": "com.amazonaws.cloudtrail#InvalidCloudWatchLogsRoleArnException"
},
{
"target": "com.amazonaws.cloudtrail#InvalidKmsKeyIdException"
},
{
"target": "com.amazonaws.cloudtrail#InvalidParameterCombinationException"
},
{
"target": "com.amazonaws.cloudtrail#InvalidS3BucketNameException"
},
{
"target": "com.amazonaws.cloudtrail#InvalidS3PrefixException"
},
{
"target": "com.amazonaws.cloudtrail#InvalidSnsTopicNameException"
},
{
"target": "com.amazonaws.cloudtrail#InvalidTagParameterException"
},
{
"target": "com.amazonaws.cloudtrail#InvalidTrailNameException"
},
{
"target": "com.amazonaws.cloudtrail#KmsException"
},
{
"target": "com.amazonaws.cloudtrail#KmsKeyDisabledException"
},
{
"target": "com.amazonaws.cloudtrail#KmsKeyNotFoundException"
},
{
"target": "com.amazonaws.cloudtrail#MaximumNumberOfTrailsExceededException"
},
{
"target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException"
},
{
"target": "com.amazonaws.cloudtrail#OperationNotPermittedException"
},
{
"target": "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException"
},
{
"target": "com.amazonaws.cloudtrail#OrganizationsNotInUseException"
},
{
"target": "com.amazonaws.cloudtrail#S3BucketDoesNotExistException"
},
{
"target": "com.amazonaws.cloudtrail#TrailAlreadyExistsException"
},
{
"target": "com.amazonaws.cloudtrail#TrailNotProvidedException"
},
{
"target": "com.amazonaws.cloudtrail#UnsupportedOperationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. \n </p>",
"smithy.api#idempotent": {}
}
},
"com.amazonaws.cloudtrail#CreateTrailRequest": {
"type": "structure",
"members": {
"Name": {
"target": "com.amazonaws.cloudtrail#String",
"traits": {
"smithy.api#documentation": "<p>Specifies the name of the trail. The name must meet the following requirements:</p>\n <ul>\n <li>\n <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</p>\n </li>\n <li>\n <p>Start with a letter or number, and end with a letter or number</p>\n </li>\n <li>\n <p>Be between 3 and 128 characters</p>\n </li>\n <li>\n <p>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code>\n and <code>my--namespace</code> are not valid.</p>\n </li>\n <li>\n <p>Not be in IP address format (for example, 192.168.5.4)</p>\n </li>\n </ul>",
"smithy.api#required": {}
}
},
"S3BucketName": {
"target": "com.amazonaws.cloudtrail#String",
"traits": {
"smithy.api#documentation": "<p>Specifies the name of the Amazon S3 bucket designated for publishing log files. See <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html\">Amazon S3 Bucket Naming Requirements</a>.</p>",
"smithy.api#required": {}
}
},
"S3KeyPrefix": {
"target": "com.amazonaws.cloudtrail#String",
"traits": {
"smithy.api#documentation": "<p>Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated\n for log file delivery. For more information, see <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html\">Finding Your CloudTrail Log Files</a>. The maximum length is 200 characters.</p>"
}
},
"SnsTopicName": {
"target": "com.amazonaws.cloudtrail#String",
"traits": {
"smithy.api#documentation": "<p>Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.</p>"
}
},
"IncludeGlobalServiceEvents": {
"target": "com.amazonaws.cloudtrail#Boolean",
"traits": {
"smithy.api#documentation": "<p>Specifies whether the trail is publishing events from global services such as IAM to the log files.</p>"
}
},
"IsMultiRegionTrail": {
"target": "com.amazonaws.cloudtrail#Boolean",
"traits": {
"smithy.api#documentation": "<p>Specifies whether the trail is created in the current region or in all regions. The default is false, which creates a trail only in the region where you are signed in. As a best practice, consider\n creating trails that log events in all regions.</p>"
}
},
"EnableLogFileValidation": {
"target": "com.amazonaws.cloudtrail#Boolean",
"traits": {
"smithy.api#documentation": "<p>Specifies whether log file integrity validation is enabled. The default is false.</p>\n <note>\n <p>When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail does \n not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. \n For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable \n it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on \n January 10. The same applies whenever you stop CloudTrail logging or delete a trail.</p>\n </note>"
}
},
"CloudWatchLogsLogGroupArn": {
"target": "com.amazonaws.cloudtrail#String",
"traits": {
"smithy.api#documentation": "<p>Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group \n to which CloudTrail logs will be delivered. Not required unless you specify <code>CloudWatchLogsRoleArn</code>.</p>"
}
},
"CloudWatchLogsRoleArn": {
"target": "com.amazonaws.cloudtrail#String",
"traits": {
"smithy.api#documentation": "<p>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.</p>"
}
},
"KmsKeyId": {
"target": "com.amazonaws.cloudtrail#String",
"traits": {
"smithy.api#documentation": "<p>Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The\n value can be an alias name prefixed by \"alias/\", a fully specified ARN to an alias, a fully\n specified ARN to a key, or a globally unique identifier.</p>\n <p>CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys,\n see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html\">Using multi-Region keys</a> in the <i>Key Management Service Developer Guide</i>.</p>\n <p>Examples:</p>\n <ul>\n <li>\n <p>alias/MyAliasName</p>\n </li>\n <li>\n <p>arn:aws:kms:us-east-2:123456789012:alias/MyAliasName</p>\n </li>\n <li>\n <p>arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012</p>\n </li>\n <li>\n <p>12345678-1234-1234-1234-123456789012</p>\n </li>\n </ul>"
}
},
"IsOrganizationTrail": {
"target": "com.amazonaws.cloudtrail#Boolean",
"traits": {
"smithy.api#documentation": "<p>Specifies whether the trail is created for all accounts in an organization in Organizations, or only for the current Amazon Web Services account. \n The default is false, and cannot be true unless the call is made on behalf of an Amazon Web Services account that is the management account for an organization in \n Organizations.</p>"
}
},
"TagsList": {
"target": "com.amazonaws.cloudtrail#TagsList"
}
},
"traits": {
"smithy.api#documentation": "<p>Specifies the settings for each trail.</p>"
}
},
"com.amazonaws.cloudtrail#CreateTrailResponse": {
"type": "structure",
"members": {
"Name": {
"target": "com.amazonaws.cloudtrail#String",
"traits": {
"smithy.api#documentation": "<p>Specifies the name of the trail.</p>"
}
},
"S3BucketName": {
"target": "com.amazonaws.cloudtrail#String",
"traits": {
"smithy.api#documentation": "<p>Specifies the name of the Amazon S3 bucket designated for publishing log files.</p>"
}
},
"S3KeyPrefix": {
"target": "com.amazonaws.cloudtrail#String",
"traits": {
"smithy.api#documentation": "<p>Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated\n for log file delivery. For more information, see <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html\">Finding Your CloudTrail Log Files</a>.</p>"
}
},
"SnsTopicName": {
"target": "com.amazonaws.cloudtrail#String",
"traits": {
"smithy.api#deprecated": {},
"smithy.api#documentation": "<p>This field is no longer in use. Use SnsTopicARN.</p>"
}
},
"SnsTopicARN": {
"target": "com.amazonaws.cloudtrail#String",
"traits": {
"smithy.api#documentation": "<p>Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The format of a topic ARN is:</p>\n <p>\n <code>arn:aws:sns:us-east-2:123456789012:MyTopic</code>\n </p>"
}
},
"IncludeGlobalServiceEvents": {
"target": "com.amazonaws.cloudtrail#Boolean",
"traits": {
"smithy.api#documentation": "<p>Specifies whether the trail is publishing events from global services such as IAM to the log files.</p>"
}
},
"IsMultiRegionTrail": {
"target": "com.amazonaws.cloudtrail#Boolean",
"traits": {
"smithy.api#documentation": "<p>Specifies whether the trail exists in one region or in all regions.</p>"
}
},
"TrailARN": {
"target": "com.amazonaws.cloudtrail#String",
"traits": {
"smithy.api#documentation": "<p>Specifies the ARN of the trail that was created. The format of a trail ARN\n is:</p>\n <p>\n <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>\n </p>"
}
},
"LogFileValidationEnabled": {
"target": "com.amazonaws.cloudtrail#Boolean",
"traits": {
"smithy.api#documentation": "<p>Specifies whether log file integrity validation is enabled.</p>"
}
},
"CloudWatchLogsLogGroupArn": {
"target": "com.amazonaws.cloudtrail#String",
"traits": {
"smithy.api#documentation": "<p>Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.</p>"
}
},
"CloudWatchLogsRoleArn": {
"target": "com.amazonaws.cloudtrail#String",
"traits": {
"smithy.api#documentation": "<p>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.</p>"
}
},
"KmsKeyId": {
"target": "com.amazonaws.cloudtrail#String",
"traits": {
"smithy.api#documentation": "<p>Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. \n The value is a fully specified ARN to a KMS key in the following format.</p>\n <p>\n <code>arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012</code>\n </p>"
}
},
"IsOrganizationTrail": {
"target": "com.amazonaws.cloudtrail#Boolean",
"traits": {
"smithy.api#documentation": "<p>Specifies whether the trail is an organization trail.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>"
}
},
"com.amazonaws.cloudtrail#DataResource": {
"type": "structure",
"members": {
"Type": {
"target": "com.amazonaws.cloudtrail#String",
"traits": {
"smithy.api#documentation": "<p>The resource type in which you want to log data events. You can specify\n the following <i>basic</i> event selector resource types:</p>\n <ul>\n <li>\n <p>\n <code>AWS::S3::Object</code>\n </p>\n </li>\n <li>\n <p>\n <code>AWS::Lambda::Function</code>\n </p>\n </li>\n <li>\n <p>\n <code>AWS::DynamoDB::Table</code>\n </p>\n </li>\n </ul>\n\n <p>The following resource types are also availble through <i>advanced</i> event selectors.\n Basic event selector resource types are valid in advanced event selectors, but\n advanced event selector resource types are not valid in basic event selectors.\n For more information, see <a>AdvancedFieldSelector$Field</a>.</p>\n <ul>\n <li>\n <p>\n <code>AWS::S3Outposts::Object</code>\n </p>\n </li>\n <li>\n <p>\n <code>AWS::ManagedBlockchain::Node</code>\n </p>\n </li>\n <li>\n <p>\n <code>AWS::S3ObjectLambda::AccessPoint</code>\n </p>\n </li>\n <li>\n <p>\n <code>AWS::EC2::Snapshot</code>\n </p>\n </li>\n <li>\n <p>\n <code>AWS::S3::AccessPoint</code>\n </p>\n </li>\n <li>\n <p>\n <code>AWS::DynamoDB::Stream</code>\n </p>\n </li>\n <li>\n <p>\n <code>AWS::Glue::Table</code>\n </p>\n </li>\n </ul>"
}
},
"Values": {
"target": "com.amazonaws.cloudtrail#DataResourceValues",
"traits": {
"smithy.api#documentation": "<p>An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects.</p>\n <ul>\n <li>\n <p>To log data events for all objects in all S3 buckets in your Amazon Web Services account, specify the \n prefix as <code>arn:aws:s3:::</code>.</p>\n <note>\n <p>This also enables logging of data event activity performed by any user or role in your Amazon Web Services account, \n even if that activity is performed on a bucket that belongs to another Amazon Web Services account.</p>\n </note>\n </li>\n <li>\n <p>To log data events for all objects in an S3 bucket, specify the bucket and an empty\n object prefix such as <code>arn:aws:s3:::bucket-1/</code>. The trail logs data events for\n all objects in this S3 bucket.</p>\n </li>\n <li>\n <p>To log data events for specific objects, specify the S3 bucket and object prefix such\n as <code>arn:aws:s3:::bucket-1/example-images</code>. The trail logs data events for\n objects in this S3 bucket that match the prefix.</p>\n </li>\n <li>\n <p>To log data events for all Lambda functions in your Amazon Web Services account, specify the prefix as\n <code>arn:aws:lambda</code>.</p>\n <note>\n <p>This also enables logging of <code>Invoke</code> activity performed by any user or role in your Amazon Web Services account, \n even if that activity is performed on a function that belongs to another Amazon Web Services account. </p>\n </note>\n </li>\n <li>\n <p>To log data events for a specific Lambda function, specify the function ARN.</p>\n <note>\n <p>Lambda function ARNs are exact. For example, if you specify a \n function ARN <i>arn:aws:lambda:us-west-2:111111111111:function:helloworld</i>, data events will\n only be logged for <i>arn:aws:lambda:us-west-2:111111111111:function:helloworld</i>. They will\n not be logged for <i>arn:aws:lambda:us-west-2:111111111111:function:helloworld2</i>.</p>\n </note> \n </li>\n <li>\n <p>To log data events for all DynamoDB tables in your Amazon Web Services account, specify the prefix\n as <code>arn:aws:dynamodb</code>.</p>\n </li>\n </ul>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The Amazon S3 buckets, Lambda functions, or Amazon DynamoDB tables that you specify\n in your event selectors for your trail to log data events. Data events provide information\n about the resource operations performed on or within a resource itself. These are also\n known as data plane operations. You can specify up to 250 data resources for a\n trail.</p>\n <note>\n <p>The total number of allowed data resources is 250. This number can be distributed between 1 and 5 event selectors, \n but the total cannot exceed 250 across all selectors.</p>\n <p>If you are using advanced event selectors, the maximum total number of values for\n all conditions, across all advanced event selectors for the trail, is 500.</p>\n </note>\n <p>The following example demonstrates how logging works when you configure logging of all data events\n for an S3 bucket named <code>bucket-1</code>. In this example, the CloudTrail user specified an empty prefix, \n and the option to log both <code>Read</code> and <code>Write</code> data events.</p>\n <ol>\n <li>\n <p>A user uploads an image file to <code>bucket-1</code>.</p>\n </li>\n <li>\n <p>The <code>PutObject</code> API operation is an Amazon S3 object-level API. \n It is recorded as a data event in CloudTrail. Because the CloudTrail user specified an S3 bucket\n with an empty prefix, events that occur on any object in that bucket are logged. The trail processes and logs the\n event.</p>\n </li>\n <li>\n <p>A user uploads an object to an Amazon S3 bucket named\n <code>arn:aws:s3:::bucket-2</code>.</p>\n </li>\n <li>\n <p>The <code>PutObject</code> API operation occurred for an object in an S3 bucket that the CloudTrail\n user didn't specify for the trail. The trail doesn’t log the event.</p>\n </li>\n </ol>\n <p>The following example demonstrates how logging works when you configure logging of Lambda data events for a \n Lambda function named <i>MyLambdaFunction</i>, but not for all Lambda functions.</p>\n <ol>\n <li>\n <p>A user runs a script that includes a call to the <i>MyLambdaFunction</i> function and the\n <i>MyOtherLambdaFunction</i> function.</p>\n </li>\n <li>\n <p>The <code>Invoke</code> API operation on <i>MyLambdaFunction</i> is an Lambda API. \n It is recorded as a data event in CloudTrail. Because the CloudTrail user specified logging data events for\n <i>MyLambdaFunction</i>, any invocations of that function are logged. The trail processes and logs the event.</p>\n </li>\n <li>\n <p>The <code>Invoke</code> API operation on <i>MyOtherLambdaFunction</i> is an Lambda API. \n Because the CloudTrail user did not specify logging data events for all Lambda functions,\n the <code>Invoke</code> operation for <i>MyOtherLambdaFunction</i> does not match the function specified for the trail. \n The trail doesn’t log the event. </p>\n </li>\n </ol>"
}
},
"com.amazonaws.cloudtrail#DataResourceValues": {
"type": "list",
"member": {
"target": "com.amazonaws.cloudtrail#String"
}
},
"com.amazonaws.cloudtrail#DataResources": {
"type": "list",
"member": {
"target": "com.amazonaws.cloudtrail#DataResource"
}
},
"com.amazonaws.cloudtrail#Date": {
"type": "timestamp"
},
"com.amazonaws.cloudtrail#DeleteEventDataStore": {
"type": "operation",
"input": {
"target": "com.amazonaws.cloudtrail#DeleteEventDataStoreRequest"
},
"output": {
"target": "com.amazonaws.cloudtrail#DeleteEventDataStoreResponse"
},
"errors": [
{
"target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException"
},
{
"target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException"
},
{
"target": "com.amazonaws.cloudtrail#EventDataStoreTerminationProtectedException"
},
{
"target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException"
},
{
"target": "com.amazonaws.cloudtrail#InvalidParameterException"
},
{
"target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException"
},
{
"target": "com.amazonaws.cloudtrail#OperationNotPermittedException"
},
{
"target": "com.amazonaws.cloudtrail#UnsupportedOperationException"
}
],