/
docs-2.json
1690 lines (1690 loc) · 140 KB
/
docs-2.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
{
"version": "2.0",
"service": "<fullname>CloudTrail</fullname> <p>This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.</p> <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. 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> <note> <p>As an alternative to the API, you can use one of the Amazon Web Services SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide programmatic access to CloudTrail. For example, the SDKs handle cryptographically signing requests, managing errors, and retrying requests automatically. For more information about the Amazon Web Services SDKs, including how to download and install them, see <a href=\"http://aws.amazon.com/tools/\">Tools to Build on Amazon Web Services</a>.</p> </note> <p>See the <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-user-guide.html\">CloudTrail User Guide</a> for information about the data that is included with each Amazon Web Services API call listed in the log files.</p>",
"operations": {
"AddTags": "<p>Adds one or more tags to a trail or event data store, up to a limit of 50. Overwrites an existing tag's value when a new value is specified for an existing tag key. Tag key names must be unique for a trail; you cannot have two keys with the same name but different values. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail or event data store that applies to all Amazon Web Services Regions only from the Region in which the trail or event data store was created (also known as its home region).</p>",
"CancelQuery": "<p>Cancels a query if the query is not in a terminated state, such as <code>CANCELLED</code>, <code>FAILED</code>, <code>TIMED_OUT</code>, or <code>FINISHED</code>. You must specify an ARN value for <code>EventDataStore</code>. The ID of the query that you want to cancel is also required. When you run <code>CancelQuery</code>, the query status might show as <code>CANCELLED</code> even if the operation is not yet finished.</p>",
"CreateEventDataStore": "<p>Creates a new event data store.</p>",
"CreateTrail": "<p>Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. </p>",
"DeleteEventDataStore": "<p>Disables the event data store specified by <code>EventDataStore</code>, which accepts an event data store ARN. After you run <code>DeleteEventDataStore</code>, the event data store enters a <code>PENDING_DELETION</code> state, and is automatically deleted after a wait period of seven days. <code>TerminationProtectionEnabled</code> must be set to <code>False</code> on the event data store; this operation cannot work if <code>TerminationProtectionEnabled</code> is <code>True</code>.</p> <p>After you run <code>DeleteEventDataStore</code> on an event data store, you cannot run <code>ListQueries</code>, <code>DescribeQuery</code>, or <code>GetQueryResults</code> on queries that are using an event data store in a <code>PENDING_DELETION</code> state. An event data store in the <code>PENDING_DELETION</code> state does not incur costs.</p>",
"DeleteTrail": "<p>Deletes a trail. This operation must be called from the region in which the trail was created. <code>DeleteTrail</code> cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.</p>",
"DeregisterOrganizationDelegatedAdmin": "<p>Removes CloudTrail delegated administrator permissions from a member account in an organization.</p>",
"DescribeQuery": "<p>Returns metadata about a query, including query run time in milliseconds, number of events scanned and matched, and query status. You must specify an ARN for <code>EventDataStore</code>, and a value for <code>QueryID</code>.</p>",
"DescribeTrails": "<p>Retrieves settings for one or more trails associated with the current region for your account.</p>",
"GetChannel": "<p> Returns information about a specific channel. Amazon Web Services services create service-linked channels to get information about CloudTrail events on your behalf. For more information about service-linked channels, see <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/viewing-service-linked-channels.html\">Viewing service-linked channels for CloudTrail by using the CLI</a>. </p>",
"GetEventDataStore": "<p>Returns information about an event data store specified as either an ARN or the ID portion of the ARN.</p>",
"GetEventSelectors": "<p>Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following:</p> <ul> <li> <p>If your event selector includes read-only events, write-only events, or all events. This applies to both management events and data events.</p> </li> <li> <p>If your event selector includes management events.</p> </li> <li> <p>If your event selector includes data events, the resources on which you are logging data events.</p> </li> </ul> <p>For more information about logging management and data events, see the following topics in the <i>CloudTrail User Guide</i>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html\">Logging management events for trails </a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html\">Logging data events for trails </a> </p> </li> </ul>",
"GetImport": "<p> Returns information about a specific import. </p>",
"GetInsightSelectors": "<p>Describes the settings for the Insights event selectors that you configured for your trail. <code>GetInsightSelectors</code> shows if CloudTrail Insights event logging is enabled on the trail, and if it is, which insight types are enabled. If you run <code>GetInsightSelectors</code> on a trail that does not have Insights events enabled, the operation throws the exception <code>InsightNotEnabledException</code> </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-insights-events-with-cloudtrail.html\">Logging CloudTrail Insights Events for Trails </a> in the <i>CloudTrail User Guide</i>.</p>",
"GetQueryResults": "<p>Gets event data results of a query. You must specify the <code>QueryID</code> value returned by the <code>StartQuery</code> operation, and an ARN for <code>EventDataStore</code>.</p>",
"GetTrail": "<p>Returns settings information for a specified trail.</p>",
"GetTrailStatus": "<p>Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail. This operation returns trail status from a single region. To return trail status from all regions, you must call the operation on each region.</p>",
"ListChannels": "<p> Lists the channels in the current account, and their source names. Amazon Web Services services create service-linked channels get information about CloudTrail events on your behalf. For more information about service-linked channels, see <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/viewing-service-linked-channels.html\">Viewing service-linked channels for CloudTrail by using the CLI</a>. </p>",
"ListEventDataStores": "<p>Returns information about all event data stores in the account, in the current region.</p>",
"ListImportFailures": "<p> Returns a list of failures for the specified import. </p>",
"ListImports": "<p> Returns information on all imports, or a select set of imports by <code>ImportStatus</code> or <code>Destination</code>. </p>",
"ListPublicKeys": "<p>Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key.</p> <note> <p>CloudTrail uses different private and public key pairs per region. Each digest file is signed with a private key unique to its region. When you validate a digest file from a specific region, you must look in the same region for its corresponding public key.</p> </note>",
"ListQueries": "<p>Returns a list of queries and query statuses for the past seven days. You must specify an ARN value for <code>EventDataStore</code>. Optionally, to shorten the list of results, you can specify a time range, formatted as timestamps, by adding <code>StartTime</code> and <code>EndTime</code> parameters, and a <code>QueryStatus</code> value. Valid values for <code>QueryStatus</code> include <code>QUEUED</code>, <code>RUNNING</code>, <code>FINISHED</code>, <code>FAILED</code>, <code>TIMED_OUT</code>, or <code>CANCELLED</code>.</p>",
"ListTags": "<p>Lists the tags for the trail or event data store in the current region.</p>",
"ListTrails": "<p>Lists trails that are in the current account.</p>",
"LookupEvents": "<p>Looks up <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-concepts.html#cloudtrail-concepts-management-events\">management events</a> or <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-concepts.html#cloudtrail-concepts-insights-events\">CloudTrail Insights events</a> that are captured by CloudTrail. You can look up events that occurred in a region within the last 90 days. Lookup supports the following attributes for management events:</p> <ul> <li> <p>Amazon Web Services access key</p> </li> <li> <p>Event ID</p> </li> <li> <p>Event name</p> </li> <li> <p>Event source</p> </li> <li> <p>Read only</p> </li> <li> <p>Resource name</p> </li> <li> <p>Resource type</p> </li> <li> <p>User name</p> </li> </ul> <p>Lookup supports the following attributes for Insights events:</p> <ul> <li> <p>Event ID</p> </li> <li> <p>Event name</p> </li> <li> <p>Event source</p> </li> </ul> <p>All attributes are optional. The default number of results returned is 50, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.</p> <important> <p>The rate of lookup requests is limited to two per second, per account, per region. If this limit is exceeded, a throttling error occurs.</p> </important>",
"PutEventSelectors": "<p>Configures an event selector or advanced event selectors for your trail. Use event selectors or advanced event selectors to specify management and data event settings for your trail. By default, trails created without specific event selectors are configured to log all read and write management events, and no data events.</p> <p>When an event occurs in your account, CloudTrail evaluates the event selectors or advanced event selectors in all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.</p> <p>Example</p> <ol> <li> <p>You create an event selector for a trail and specify that you want write-only events.</p> </li> <li> <p>The EC2 <code>GetConsoleOutput</code> and <code>RunInstances</code> API operations occur in your account.</p> </li> <li> <p>CloudTrail evaluates whether the events match your event selectors.</p> </li> <li> <p>The <code>RunInstances</code> is a write-only event and it matches your event selector. The trail logs the event.</p> </li> <li> <p>The <code>GetConsoleOutput</code> is a read-only event that doesn't match your event selector. The trail doesn't log the event. </p> </li> </ol> <p>The <code>PutEventSelectors</code> operation must be called from the region in which the trail was created; otherwise, an <code>InvalidHomeRegionException</code> exception is thrown.</p> <p>You can configure up to five event selectors for each trail. For more information, see <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html\">Logging management events for trails </a>, <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html\">Logging data events for trails </a>, and <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/WhatIsCloudTrail-Limits.html\">Quotas in CloudTrail</a> in the <i>CloudTrail User Guide</i>.</p> <p>You can add advanced event selectors, and conditions for your advanced event selectors, up to a maximum of 500 values for all conditions and selectors on a trail. You can use either <code>AdvancedEventSelectors</code> or <code>EventSelectors</code>, but not both. If you apply <code>AdvancedEventSelectors</code> to a trail, any existing <code>EventSelectors</code> are overwritten. 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>",
"PutInsightSelectors": "<p>Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail. You also use <code>PutInsightSelectors</code> to turn off Insights event logging, by passing an empty list of insight types. The valid Insights event types in this release are <code>ApiErrorRateInsight</code> and <code>ApiCallRateInsight</code>.</p>",
"RegisterOrganizationDelegatedAdmin": "<p>Registers an organization’s member account as the CloudTrail delegated administrator.</p>",
"RemoveTags": "<p>Removes the specified tags from a trail or event data store.</p>",
"RestoreEventDataStore": "<p>Restores a deleted event data store specified by <code>EventDataStore</code>, which accepts an event data store ARN. You can only restore a deleted event data store within the seven-day wait period after deletion. Restoring an event data store can take several minutes, depending on the size of the event data store.</p>",
"StartImport": "<p> Starts an import of logged trail events from a source S3 bucket to a destination event data store. By default, CloudTrail only imports events contained in the S3 bucket's <code>CloudTrail</code> prefix and the prefixes inside the <code>CloudTrail</code> prefix, and does not check prefixes for other Amazon Web Services services. If you want to import CloudTrail events contained in another prefix, you must include the prefix in the <code>S3LocationUri</code>. For more considerations about importing trail events, see <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-copy-trail-to-lake.html#cloudtrail-trail-copy-considerations\">Considerations</a>. </p> <p> When you start a new import, the <code>Destinations</code> and <code>ImportSource</code> parameters are required. Before starting a new import, disable any access control lists (ACLs) attached to the source S3 bucket. For more information about disabling ACLs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html\">Controlling ownership of objects and disabling ACLs for your bucket</a>. </p> <p> When you retry an import, the <code>ImportID</code> parameter is required. </p>",
"StartLogging": "<p>Starts the recording of Amazon Web Services API calls and log file delivery for a trail. For a trail that is enabled in all regions, this operation must be called from the region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.</p>",
"StartQuery": "<p>Starts a CloudTrail Lake query. The required <code>QueryStatement</code> parameter provides your SQL query, enclosed in single quotation marks. Use the optional <code>DeliveryS3Uri</code> parameter to deliver the query results to an S3 bucket.</p>",
"StopImport": "<p> Stops a specified import. </p>",
"StopLogging": "<p>Suspends the recording of Amazon Web Services API calls and log file delivery for the specified trail. Under most circumstances, there is no need to use this action. You can update a trail without stopping it first. This action is the only way to stop recording. For a trail enabled in all regions, this operation must be called from the region in which the trail was created, or an <code>InvalidHomeRegionException</code> will occur. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail enabled in all regions.</p>",
"UpdateEventDataStore": "<p>Updates an event data store. The required <code>EventDataStore</code> value is an ARN or the ID portion of the ARN. Other parameters are optional, but at least one optional parameter must be specified, or CloudTrail throws an error. <code>RetentionPeriod</code> is in days, and valid values are integers between 90 and 2557. By default, <code>TerminationProtection</code> is enabled. <code>AdvancedEventSelectors</code> includes or excludes management and data events in your event data store; for more information about <code>AdvancedEventSelectors</code>, see <a>PutEventSelectorsRequest$AdvancedEventSelectors</a>.</p>",
"UpdateTrail": "<p>Updates trail settings that control what events you are logging, and how to handle log files. Changes to a trail do not require stopping the CloudTrail service. Use this action to designate an existing bucket for log delivery. If the existing bucket has previously been a target for CloudTrail log files, an IAM policy exists for the bucket. <code>UpdateTrail</code> must be called from the region in which the trail was created; otherwise, an <code>InvalidHomeRegionException</code> is thrown.</p>"
},
"shapes": {
"AccountHasOngoingImportException": {
"base": "<p> This exception is thrown when you start a new import and a previous import is still in progress. </p>",
"refs": {
}
},
"AccountId": {
"base": null,
"refs": {
"DeregisterOrganizationDelegatedAdminRequest$DelegatedAdminAccountId": "<p>A delegated administrator account ID. This is a member account in an organization that is currently designated as a delegated administrator.</p>",
"RegisterOrganizationDelegatedAdminRequest$MemberAccountId": "<p>An organization member account ID that you want to designate as a delegated administrator.</p>"
}
},
"AccountNotFoundException": {
"base": "<p>This exception is thrown when when the specified account is not found or not part of an organization.</p>",
"refs": {
}
},
"AccountNotRegisteredException": {
"base": "<p>This exception is thrown when the specified account is not registered as the CloudTrail delegated administrator.</p>",
"refs": {
}
},
"AccountRegisteredException": {
"base": "<p>This exception is thrown when the account is already registered as the CloudTrail delegated administrator.</p>",
"refs": {
}
},
"AddTagsRequest": {
"base": "<p>Specifies the tags to add to a trail or event data store.</p>",
"refs": {
}
},
"AddTagsResponse": {
"base": "<p>Returns the objects or data if successful. Otherwise, returns an error.</p>",
"refs": {
}
},
"AdvancedEventSelector": {
"base": "<p>Advanced event selectors let you create fine-grained selectors for the following CloudTrail event record fields. They help you control costs by logging only those events 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> <ul> <li> <p> <code>readOnly</code> </p> </li> <li> <p> <code>eventSource</code> </p> </li> <li> <p> <code>eventName</code> </p> </li> <li> <p> <code>eventCategory</code> </p> </li> <li> <p> <code>resources.type</code> </p> </li> <li> <p> <code>resources.ARN</code> </p> </li> </ul> <p>You cannot apply both event selectors and advanced event selectors to a trail.</p>",
"refs": {
"AdvancedEventSelectors$member": null
}
},
"AdvancedEventSelectors": {
"base": null,
"refs": {
"CreateEventDataStoreRequest$AdvancedEventSelectors": "<p>The advanced event selectors to use to select the events for the data store. For more information about how to use advanced event 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 User Guide.</p>",
"CreateEventDataStoreResponse$AdvancedEventSelectors": "<p>The advanced event selectors that were used to select the events for the data store.</p>",
"EventDataStore$AdvancedEventSelectors": "<p>This field is being deprecated. The advanced event selectors that were used to select events for the data store.</p>",
"GetEventDataStoreResponse$AdvancedEventSelectors": "<p>The advanced event selectors used to select events for the data store.</p>",
"GetEventSelectorsResponse$AdvancedEventSelectors": "<p> The advanced event selectors that are configured for the trail. </p>",
"PutEventSelectorsRequest$AdvancedEventSelectors": "<p> Specifies the settings for advanced event selectors. You can add advanced event selectors, and conditions for your advanced event selectors, up to a maximum of 500 values for all conditions and selectors on a trail. You can use either <code>AdvancedEventSelectors</code> or <code>EventSelectors</code>, but not both. If you apply <code>AdvancedEventSelectors</code> to a trail, any existing <code>EventSelectors</code> are overwritten. 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>",
"PutEventSelectorsResponse$AdvancedEventSelectors": "<p>Specifies the advanced event selectors configured for your trail.</p>",
"RestoreEventDataStoreResponse$AdvancedEventSelectors": "<p>The advanced event selectors that were used to select events.</p>",
"SourceConfig$AdvancedEventSelectors": "<p> The advanced event selectors that are configured for the channel.</p>",
"UpdateEventDataStoreRequest$AdvancedEventSelectors": "<p>The advanced event selectors used to select events for the event data store. You can configure up to five advanced event selectors for each event data store.</p>",
"UpdateEventDataStoreResponse$AdvancedEventSelectors": "<p>The advanced event selectors that are applied to the event data store.</p>"
}
},
"AdvancedFieldSelector": {
"base": "<p>A single selector statement in an advanced event selector.</p>",
"refs": {
"AdvancedFieldSelectors$member": null
}
},
"AdvancedFieldSelectors": {
"base": null,
"refs": {
"AdvancedEventSelector$FieldSelectors": "<p>Contains all selector statements in an advanced event selector.</p>"
}
},
"Boolean": {
"base": null,
"refs": {
"CreateEventDataStoreRequest$MultiRegionEnabled": "<p>Specifies whether the event data store includes events from all regions, or only from the region in which the event data store is created.</p>",
"CreateEventDataStoreRequest$OrganizationEnabled": "<p>Specifies whether an event data store collects events logged for an organization in Organizations.</p>",
"CreateEventDataStoreResponse$MultiRegionEnabled": "<p>Indicates whether the event data store collects events from all regions, or only from the region in which it was created.</p>",
"CreateEventDataStoreResponse$OrganizationEnabled": "<p>Indicates whether an event data store is collecting logged events for an organization in Organizations.</p>",
"CreateTrailRequest$IncludeGlobalServiceEvents": "<p>Specifies whether the trail is publishing events from global services such as IAM to the log files.</p>",
"CreateTrailRequest$IsMultiRegionTrail": "<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 creating trails that log events in all regions.</p>",
"CreateTrailRequest$EnableLogFileValidation": "<p>Specifies whether log file integrity validation is enabled. The default is false.</p> <note> <p>When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail does not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable 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 January 10. The same applies whenever you stop CloudTrail logging or delete a trail.</p> </note>",
"CreateTrailRequest$IsOrganizationTrail": "<p>Specifies whether the trail is created for all accounts in an organization in Organizations, or only for the current Amazon Web Services account. 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 Organizations.</p>",
"CreateTrailResponse$IncludeGlobalServiceEvents": "<p>Specifies whether the trail is publishing events from global services such as IAM to the log files.</p>",
"CreateTrailResponse$IsMultiRegionTrail": "<p>Specifies whether the trail exists in one region or in all regions.</p>",
"CreateTrailResponse$LogFileValidationEnabled": "<p>Specifies whether log file integrity validation is enabled.</p>",
"CreateTrailResponse$IsOrganizationTrail": "<p>Specifies whether the trail is an organization trail.</p>",
"DescribeTrailsRequest$includeShadowTrails": "<p>Specifies whether to include shadow trails in the response. A shadow trail is the replication in a region of a trail that was created in a different region, or in the case of an organization trail, the replication of an organization trail in member accounts. If you do not include shadow trails, organization trails in a member account and region replication trails will not be returned. The default is true.</p>",
"EventDataStore$MultiRegionEnabled": "<p>This field is being deprecated. Indicates whether the event data store includes events from all regions, or only from the region in which it was created.</p>",
"EventDataStore$OrganizationEnabled": "<p>This field is being deprecated. Indicates that an event data store is collecting logged events for an organization.</p>",
"EventSelector$IncludeManagementEvents": "<p>Specify if you want your event selector to include management events for your trail.</p> <p> For more information, see <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html\">Management Events</a> in the <i>CloudTrail User Guide</i>.</p> <p>By default, the value is <code>true</code>.</p> <p>The first copy of management events is free. You are charged for additional copies of management events that you are logging on any subsequent trail in the same region. For more information about CloudTrail pricing, see <a href=\"http://aws.amazon.com/cloudtrail/pricing/\">CloudTrail Pricing</a>.</p>",
"GetEventDataStoreResponse$MultiRegionEnabled": "<p>Indicates whether the event data store includes events from all regions, or only from the region in which it was created.</p>",
"GetEventDataStoreResponse$OrganizationEnabled": "<p>Indicates whether an event data store is collecting logged events for an organization in Organizations.</p>",
"GetTrailStatusResponse$IsLogging": "<p>Whether the CloudTrail trail is currently logging Amazon Web Services API calls.</p>",
"RestoreEventDataStoreResponse$MultiRegionEnabled": "<p>Indicates whether the event data store is collecting events from all regions, or only from the region in which the event data store was created.</p>",
"RestoreEventDataStoreResponse$OrganizationEnabled": "<p>Indicates whether an event data store is collecting logged events for an organization in Organizations.</p>",
"SourceConfig$ApplyToAllRegions": "<p> Specifies whether the channel applies to a single region or to all regions.</p>",
"Trail$IncludeGlobalServiceEvents": "<p>Set to <b>True</b> to include Amazon Web Services API calls from Amazon Web Services global services such as IAM. Otherwise, <b>False</b>.</p>",
"Trail$IsMultiRegionTrail": "<p>Specifies whether the trail exists only in one region or exists in all regions.</p>",
"Trail$LogFileValidationEnabled": "<p>Specifies whether log file validation is enabled.</p>",
"Trail$HasCustomEventSelectors": "<p>Specifies if the trail has custom event selectors.</p>",
"Trail$HasInsightSelectors": "<p>Specifies whether a trail has insight types specified in an <code>InsightSelector</code> list.</p>",
"Trail$IsOrganizationTrail": "<p>Specifies whether the trail is an organization trail.</p>",
"UpdateEventDataStoreRequest$MultiRegionEnabled": "<p>Specifies whether an event data store collects events from all regions, or only from the region in which it was created.</p>",
"UpdateEventDataStoreRequest$OrganizationEnabled": "<p>Specifies whether an event data store collects events logged for an organization in Organizations.</p>",
"UpdateEventDataStoreResponse$MultiRegionEnabled": "<p>Indicates whether the event data store includes events from all regions, or only from the region in which it was created.</p>",
"UpdateEventDataStoreResponse$OrganizationEnabled": "<p>Indicates whether an event data store is collecting logged events for an organization in Organizations.</p>",
"UpdateTrailRequest$IncludeGlobalServiceEvents": "<p>Specifies whether the trail is publishing events from global services such as IAM to the log files.</p>",
"UpdateTrailRequest$IsMultiRegionTrail": "<p>Specifies whether the trail applies only to the current region or to all regions. The default is false. If the trail exists only in the current region and this value is set to true, shadow trails (replications of the trail) will be created in the other regions. If the trail exists in all regions and this value is set to false, the trail will remain in the region where it was created, and its shadow trails in other regions will be deleted. As a best practice, consider using trails that log events in all regions.</p>",
"UpdateTrailRequest$EnableLogFileValidation": "<p>Specifies whether log file validation is enabled. The default is false.</p> <note> <p>When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail does not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable 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 January 10. The same applies whenever you stop CloudTrail logging or delete a trail.</p> </note>",
"UpdateTrailRequest$IsOrganizationTrail": "<p>Specifies whether the trail is applied to all accounts in an organization in Organizations, or only for the current Amazon Web Services account. 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 Organizations. If the trail is not an organization trail and this is set to <code>true</code>, the trail will be created in all Amazon Web Services accounts that belong to the organization. If the trail is an organization trail and this is set to <code>false</code>, the trail will remain in the current Amazon Web Services account but be deleted from all member accounts in the organization.</p>",
"UpdateTrailResponse$IncludeGlobalServiceEvents": "<p>Specifies whether the trail is publishing events from global services such as IAM to the log files.</p>",
"UpdateTrailResponse$IsMultiRegionTrail": "<p>Specifies whether the trail exists in one region or in all regions.</p>",
"UpdateTrailResponse$LogFileValidationEnabled": "<p>Specifies whether log file integrity validation is enabled.</p>",
"UpdateTrailResponse$IsOrganizationTrail": "<p>Specifies whether the trail is an organization trail.</p>"
}
},
"ByteBuffer": {
"base": null,
"refs": {
"PublicKey$Value": "<p>The DER encoded public key value in PKCS#1 format.</p>"
}
},
"CancelQueryRequest": {
"base": null,
"refs": {
}
},
"CancelQueryResponse": {
"base": null,
"refs": {
}
},
"CannotDelegateManagementAccountException": {
"base": "<p>This exception is thrown when the management account of an organization is registered as the CloudTrail delegated administrator.</p>",
"refs": {
}
},
"Channel": {
"base": "<p>Contains information about a returned CloudTrail channel.</p>",
"refs": {
"Channels$member": null
}
},
"ChannelARNInvalidException": {
"base": "<p>This exception is thrown when the specified value of <code>ChannelARN</code> is not valid.</p>",
"refs": {
}
},
"ChannelArn": {
"base": null,
"refs": {
"Channel$ChannelArn": "<p>The Amazon Resource Name (ARN) of a channel.</p>",
"GetChannelRequest$Channel": "<p>The ARN or <code>UUID</code> of a channel.</p>",
"GetChannelResponse$ChannelArn": "<p>The ARN of an channel returned by a <code>GetChannel</code> request.</p>"
}
},
"ChannelName": {
"base": null,
"refs": {
"Channel$Name": "<p> The name of the CloudTrail channel. For service-linked channels, the name is <code>aws-service-channel/service-name/custom-suffix</code> where <code>service-name</code> represents the name of the Amazon Web Services service that created the channel and <code>custom-suffix</code> represents the suffix created by the Amazon Web Services service. </p>",
"GetChannelResponse$Name": "<p> The name of the CloudTrail channel. For service-linked channels, the value is <code>aws-service-channel/service-name/custom-suffix</code> where <code>service-name</code> represents the name of the Amazon Web Services service that created the channel and <code>custom-suffix</code> represents the suffix generated by the Amazon Web Services service. </p>"
}
},
"ChannelNotFoundException": {
"base": "<p> The specified channel was not found. </p>",
"refs": {
}
},
"Channels": {
"base": null,
"refs": {
"ListChannelsResponse$Channels": "<p> The list of channels in the account. </p>"
}
},
"CloudTrailARNInvalidException": {
"base": "<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> <p> <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code> </p>",
"refs": {
}
},
"CloudTrailAccessNotEnabledException": {
"base": "<p>This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, 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> 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>",
"refs": {
}
},
"CloudTrailInvalidClientTokenIdException": {
"base": "<p>This exception is thrown when a call results in the <code>InvalidClientTokenId</code> error code. This can occur when you are creating or updating a trail to send notifications to an Amazon SNS topic that is in a suspended Amazon Web Services account.</p>",
"refs": {
}
},
"CloudWatchLogsDeliveryUnavailableException": {
"base": "<p>Cannot set a CloudWatch Logs delivery for this region.</p>",
"refs": {
}
},
"ConflictException": {
"base": "<p>This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a resource before CloudTrail has time to fully load the resource. If this exception occurs, wait a few minutes, and then try the operation again.</p>",
"refs": {
}
},
"CreateEventDataStoreRequest": {
"base": null,
"refs": {
}
},
"CreateEventDataStoreResponse": {
"base": null,
"refs": {
}
},
"CreateTrailRequest": {
"base": "<p>Specifies the settings for each trail.</p>",
"refs": {
}
},
"CreateTrailResponse": {
"base": "<p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>",
"refs": {
}
},
"DataResource": {
"base": "<p>The Amazon S3 buckets, Lambda functions, or Amazon DynamoDB tables that you specify in your event selectors for your trail to log data events. Data events provide information about the resource operations performed on or within a resource itself. These are also known as data plane operations. You can specify up to 250 data resources for a trail.</p> <note> <p>The total number of allowed data resources is 250. This number can be distributed between 1 and 5 event selectors, but the total cannot exceed 250 across all selectors.</p> <p>If you are using advanced event selectors, the maximum total number of values for all conditions, across all advanced event selectors for the trail, is 500.</p> </note> <p>The following example demonstrates how logging works when you configure logging of all data events for an S3 bucket named <code>bucket-1</code>. In this example, the CloudTrail user specified an empty prefix, and the option to log both <code>Read</code> and <code>Write</code> data events.</p> <ol> <li> <p>A user uploads an image file to <code>bucket-1</code>.</p> </li> <li> <p>The <code>PutObject</code> API operation is an Amazon S3 object-level API. It is recorded as a data event in CloudTrail. Because the CloudTrail user specified an S3 bucket with an empty prefix, events that occur on any object in that bucket are logged. The trail processes and logs the event.</p> </li> <li> <p>A user uploads an object to an Amazon S3 bucket named <code>arn:aws:s3:::bucket-2</code>.</p> </li> <li> <p>The <code>PutObject</code> API operation occurred for an object in an S3 bucket that the CloudTrail user didn't specify for the trail. The trail doesn’t log the event.</p> </li> </ol> <p>The following example demonstrates how logging works when you configure logging of Lambda data events for a Lambda function named <i>MyLambdaFunction</i>, but not for all Lambda functions.</p> <ol> <li> <p>A user runs a script that includes a call to the <i>MyLambdaFunction</i> function and the <i>MyOtherLambdaFunction</i> function.</p> </li> <li> <p>The <code>Invoke</code> API operation on <i>MyLambdaFunction</i> is an Lambda API. It is recorded as a data event in CloudTrail. Because the CloudTrail user specified logging data events for <i>MyLambdaFunction</i>, any invocations of that function are logged. The trail processes and logs the event.</p> </li> <li> <p>The <code>Invoke</code> API operation on <i>MyOtherLambdaFunction</i> is an Lambda API. Because the CloudTrail user did not specify logging data events for all Lambda functions, the <code>Invoke</code> operation for <i>MyOtherLambdaFunction</i> does not match the function specified for the trail. The trail doesn’t log the event. </p> </li> </ol>",
"refs": {
"DataResources$member": null
}
},
"DataResourceValues": {
"base": null,
"refs": {
"DataResource$Values": "<p>An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects.</p> <ul> <li> <p>To log data events for all objects in all S3 buckets in your Amazon Web Services account, specify the prefix as <code>arn:aws:s3</code>.</p> <note> <p>This also enables logging of data event activity performed by any user or role in your Amazon Web Services account, even if that activity is performed on a bucket that belongs to another Amazon Web Services account.</p> </note> </li> <li> <p>To log data events for all objects in an S3 bucket, specify the bucket and an empty object prefix such as <code>arn:aws:s3:::bucket-1/</code>. The trail logs data events for all objects in this S3 bucket.</p> </li> <li> <p>To log data events for specific objects, specify the S3 bucket and object prefix such as <code>arn:aws:s3:::bucket-1/example-images</code>. The trail logs data events for objects in this S3 bucket that match the prefix.</p> </li> <li> <p>To log data events for all Lambda functions in your Amazon Web Services account, specify the prefix as <code>arn:aws:lambda</code>.</p> <note> <p>This also enables logging of <code>Invoke</code> activity performed by any user or role in your Amazon Web Services account, even if that activity is performed on a function that belongs to another Amazon Web Services account. </p> </note> </li> <li> <p>To log data events for a specific Lambda function, specify the function ARN.</p> <note> <p>Lambda function ARNs are exact. For example, if you specify a function ARN <i>arn:aws:lambda:us-west-2:111111111111:function:helloworld</i>, data events will only be logged for <i>arn:aws:lambda:us-west-2:111111111111:function:helloworld</i>. They will not be logged for <i>arn:aws:lambda:us-west-2:111111111111:function:helloworld2</i>.</p> </note> </li> <li> <p>To log data events for all DynamoDB tables in your Amazon Web Services account, specify the prefix as <code>arn:aws:dynamodb</code>.</p> </li> </ul>"
}
},
"DataResources": {
"base": null,
"refs": {
"EventSelector$DataResources": "<p>CloudTrail supports data event logging for Amazon S3 objects, Lambda functions, and Amazon DynamoDB tables with basic event selectors. You can specify up to 250 resources for an individual event selector, but the total number of data resources cannot exceed 250 across all event selectors in a trail. This limit does not apply if you configure resource logging for all data events.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html\">Data Events</a> and <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/WhatIsCloudTrail-Limits.html\">Limits in CloudTrail</a> in the <i>CloudTrail User Guide</i>.</p>"
}
},
"Date": {
"base": null,
"refs": {
"CreateEventDataStoreResponse$CreatedTimestamp": "<p>The timestamp that shows when the event data store was created.</p>",
"CreateEventDataStoreResponse$UpdatedTimestamp": "<p>The timestamp that shows when an event data store was updated, if applicable. <code>UpdatedTimestamp</code> is always either the same or newer than the time shown in <code>CreatedTimestamp</code>.</p>",
"Event$EventTime": "<p>The date and time of the event returned.</p>",
"EventDataStore$CreatedTimestamp": "<p>This field is being deprecated. The timestamp of the event data store's creation.</p>",
"EventDataStore$UpdatedTimestamp": "<p>This field is being deprecated. The timestamp showing when an event data store was updated, if applicable. <code>UpdatedTimestamp</code> is always either the same or newer than the time shown in <code>CreatedTimestamp</code>.</p>",
"GetEventDataStoreResponse$CreatedTimestamp": "<p>The timestamp of the event data store's creation.</p>",
"GetEventDataStoreResponse$UpdatedTimestamp": "<p>Shows the time that an event data store was updated, if applicable. <code>UpdatedTimestamp</code> is always either the same or newer than the time shown in <code>CreatedTimestamp</code>.</p>",
"GetImportResponse$StartEventTime": "<p> Used with <code>EndEventTime</code> to bound a <code>StartImport</code> request, and limit imported trail events to only those events logged within a specified time period. </p>",
"GetImportResponse$EndEventTime": "<p> Used with <code>StartEventTime</code> to bound a <code>StartImport</code> request, and limit imported trail events to only those events logged within a specified time period. </p>",
"GetImportResponse$CreatedTimestamp": "<p> The timestamp of the import's creation. </p>",
"GetImportResponse$UpdatedTimestamp": "<p> The timestamp of when the import was updated. </p>",
"GetTrailStatusResponse$LatestDeliveryTime": "<p>Specifies the date and time that CloudTrail last delivered log files to an account's Amazon S3 bucket.</p>",
"GetTrailStatusResponse$LatestNotificationTime": "<p>Specifies the date and time of the most recent Amazon SNS notification that CloudTrail has written a new log file to an account's Amazon S3 bucket.</p>",
"GetTrailStatusResponse$StartLoggingTime": "<p>Specifies the most recent date and time when CloudTrail started recording API calls for an Amazon Web Services account.</p>",
"GetTrailStatusResponse$StopLoggingTime": "<p>Specifies the most recent date and time when CloudTrail stopped recording API calls for an Amazon Web Services account.</p>",
"GetTrailStatusResponse$LatestCloudWatchLogsDeliveryTime": "<p>Displays the most recent date and time when CloudTrail delivered logs to CloudWatch Logs.</p>",
"GetTrailStatusResponse$LatestDigestDeliveryTime": "<p>Specifies the date and time that CloudTrail last delivered a digest file to an account's Amazon S3 bucket.</p>",
"ImportFailureListItem$LastUpdatedTime": "<p> When the import was last updated. </p>",
"ImportsListItem$CreatedTimestamp": "<p> The timestamp of the import's creation. </p>",
"ImportsListItem$UpdatedTimestamp": "<p> The timestamp of the import's last update. </p>",
"ListPublicKeysRequest$StartTime": "<p>Optionally specifies, in UTC, the start of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used, and the current public key is returned.</p>",
"ListPublicKeysRequest$EndTime": "<p>Optionally specifies, in UTC, the end of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used.</p>",
"ListQueriesRequest$StartTime": "<p>Use with <code>EndTime</code> to bound a <code>ListQueries</code> request, and limit its results to only those queries run within a specified time period.</p>",
"ListQueriesRequest$EndTime": "<p>Use with <code>StartTime</code> to bound a <code>ListQueries</code> request, and limit its results to only those queries run within a specified time period.</p>",
"LookupEventsRequest$StartTime": "<p>Specifies that only events that occur after or at the specified time are returned. If the specified start time is after the specified end time, an error is returned.</p>",
"LookupEventsRequest$EndTime": "<p>Specifies that only events that occur before or at the specified time are returned. If the specified end time is before the specified start time, an error is returned.</p>",
"PublicKey$ValidityStartTime": "<p>The starting time of validity of the public key.</p>",
"PublicKey$ValidityEndTime": "<p>The ending time of validity of the public key.</p>",
"Query$CreationTime": "<p>The creation time of a query.</p>",
"QueryStatisticsForDescribeQuery$CreationTime": "<p>The creation time of the query.</p>",
"RestoreEventDataStoreResponse$CreatedTimestamp": "<p>The timestamp of an event data store's creation.</p>",
"RestoreEventDataStoreResponse$UpdatedTimestamp": "<p>The timestamp that shows when an event data store was updated, if applicable. <code>UpdatedTimestamp</code> is always either the same or newer than the time shown in <code>CreatedTimestamp</code>.</p>",
"StartImportRequest$StartEventTime": "<p> Use with <code>EndEventTime</code> to bound a <code>StartImport</code> request, and limit imported trail events to only those events logged within a specified time period. When you specify a time range, CloudTrail checks the prefix and log file names to verify the names contain a date between the specified <code>StartEventTime</code> and <code>EndEventTime</code> before attempting to import events. </p>",
"StartImportRequest$EndEventTime": "<p> Use with <code>StartEventTime</code> to bound a <code>StartImport</code> request, and limit imported trail events to only those events logged within a specified time period. When you specify a time range, CloudTrail checks the prefix and log file names to verify the names contain a date between the specified <code>StartEventTime</code> and <code>EndEventTime</code> before attempting to import events. </p>",
"StartImportResponse$StartEventTime": "<p> Used with <code>EndEventTime</code> to bound a <code>StartImport</code> request, and limit imported trail events to only those events logged within a specified time period. </p>",
"StartImportResponse$EndEventTime": "<p> Used with <code>StartEventTime</code> to bound a <code>StartImport</code> request, and limit imported trail events to only those events logged within a specified time period. </p>",
"StartImportResponse$CreatedTimestamp": "<p> The timestamp for the import's creation. </p>",
"StartImportResponse$UpdatedTimestamp": "<p> The timestamp of the import's last update, if applicable. </p>",
"StopImportResponse$CreatedTimestamp": "<p> The timestamp of the import's creation. </p>",
"StopImportResponse$UpdatedTimestamp": "<p> The timestamp of the import's last update. </p>",
"StopImportResponse$StartEventTime": "<p> Used with <code>EndEventTime</code> to bound a <code>StartImport</code> request, and limit imported trail events to only those events logged within a specified time period. </p>",
"StopImportResponse$EndEventTime": "<p> Used with <code>StartEventTime</code> to bound a <code>StartImport</code> request, and limit imported trail events to only those events logged within a specified time period. </p>",
"UpdateEventDataStoreResponse$CreatedTimestamp": "<p>The timestamp that shows when an event data store was first created.</p>",
"UpdateEventDataStoreResponse$UpdatedTimestamp": "<p>The timestamp that shows when the event data store was last updated. <code>UpdatedTimestamp</code> is always either the same or newer than the time shown in <code>CreatedTimestamp</code>.</p>"
}
},
"DelegatedAdminAccountLimitExceededException": {
"base": "<p>This exception is thrown when the maximum number of CloudTrail delegated administrators is reached.</p>",
"refs": {
}
},
"DeleteEventDataStoreRequest": {
"base": null,
"refs": {
}
},
"DeleteEventDataStoreResponse": {
"base": null,
"refs": {
}
},
"DeleteTrailRequest": {
"base": "<p>The request that specifies the name of a trail to delete.</p>",
"refs": {
}
},
"DeleteTrailResponse": {
"base": "<p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>",
"refs": {
}
},
"DeliveryS3Uri": {
"base": null,
"refs": {
"DescribeQueryResponse$DeliveryS3Uri": "<p>The URI for the S3 bucket where CloudTrail delivered query results, if applicable.</p>",
"StartQueryRequest$DeliveryS3Uri": "<p> The URI for the S3 bucket where CloudTrail delivers the query results. </p>"
}
},
"DeliveryStatus": {
"base": null,
"refs": {
"DescribeQueryResponse$DeliveryStatus": "<p>The delivery status.</p>"
}
},
"DeregisterOrganizationDelegatedAdminRequest": {
"base": "<p>Removes CloudTrail delegated administrator permissions from a specified member account in an organization that is currently designated as a delegated administrator.</p>",
"refs": {
}
},
"DeregisterOrganizationDelegatedAdminResponse": {
"base": "<p>Returns the following response if successful. Otherwise, returns an error.</p>",
"refs": {
}
},
"DescribeQueryRequest": {
"base": null,
"refs": {
}
},
"DescribeQueryResponse": {
"base": null,
"refs": {
}
},
"DescribeTrailsRequest": {
"base": "<p>Returns information about the trail.</p>",
"refs": {
}
},
"DescribeTrailsResponse": {
"base": "<p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>",
"refs": {
}
},
"Destination": {
"base": "<p>Contains information about the service where CloudTrail delivers events.</p>",
"refs": {
"Destinations$member": null
}
},
"DestinationType": {
"base": null,
"refs": {
"Destination$Type": "<p>The type of destination for events arriving from a channel. For service-linked channels, the value is <code>AWS_SERVICE</code>.</p>"
}
},
"Destinations": {
"base": null,
"refs": {
"GetChannelResponse$Destinations": "<p>The Amazon Web Services service that created the service-linked channel.</p>"
}
},
"ErrorMessage": {
"base": null,
"refs": {
"DescribeQueryResponse$ErrorMessage": "<p>The error message returned if a query failed.</p>",
"GetQueryResultsResponse$ErrorMessage": "<p>The error message returned if a query failed.</p>"
}
},
"Event": {
"base": "<p>Contains information about an event that was returned by a lookup request. The result includes a representation of a CloudTrail event.</p>",
"refs": {
"EventsList$member": null
}
},
"EventCategory": {
"base": null,
"refs": {
"LookupEventsRequest$EventCategory": "<p>Specifies the event category. If you do not specify an event category, events of the category are not returned in the response. For example, if you do not specify <code>insight</code> as the value of <code>EventCategory</code>, no Insights events are returned.</p>"
}
},
"EventDataStore": {
"base": "<p>A storage lake of event data against which you can run complex SQL-based queries. An event data store can include events that you have logged on your account from the last 90 to 2557 days (about three months to up to seven years). To select events for an event data store, use <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#creating-data-event-selectors-advanced\">advanced event selectors</a>.</p>",
"refs": {
"EventDataStores$member": null
}
},
"EventDataStoreARNInvalidException": {
"base": "<p>The specified event data store ARN is not valid or does not map to an event data store in your account.</p>",
"refs": {
}
},
"EventDataStoreAlreadyExistsException": {
"base": "<p>An event data store with that name already exists.</p>",
"refs": {
}
},
"EventDataStoreArn": {
"base": null,
"refs": {
"CancelQueryRequest$EventDataStore": "<p>The ARN (or the ID suffix of the ARN) of an event data store on which the specified query is running.</p>",
"CreateEventDataStoreResponse$EventDataStoreArn": "<p>The ARN of the event data store.</p>",
"DeleteEventDataStoreRequest$EventDataStore": "<p>The ARN (or the ID suffix of the ARN) of the event data store to delete.</p>",
"DescribeQueryRequest$EventDataStore": "<p>The ARN (or the ID suffix of the ARN) of an event data store on which the specified query was run.</p>",
"EventDataStore$EventDataStoreArn": "<p>The ARN of the event data store.</p>",
"GetEventDataStoreRequest$EventDataStore": "<p>The ARN (or ID suffix of the ARN) of the event data store about which you want information.</p>",
"GetEventDataStoreResponse$EventDataStoreArn": "<p>The event data store Amazon Resource Number (ARN).</p>",
"GetQueryResultsRequest$EventDataStore": "<p>The ARN (or ID suffix of the ARN) of the event data store against which the query was run.</p>",
"ImportDestinations$member": null,
"ListImportsRequest$Destination": "<p> The ARN of the destination event data store. </p>",
"ListQueriesRequest$EventDataStore": "<p>The ARN (or the ID suffix of the ARN) of an event data store on which queries were run.</p>",
"RestoreEventDataStoreRequest$EventDataStore": "<p>The ARN (or the ID suffix of the ARN) of the event data store that you want to restore.</p>",
"RestoreEventDataStoreResponse$EventDataStoreArn": "<p>The event data store ARN.</p>",
"UpdateEventDataStoreRequest$EventDataStore": "<p>The ARN (or the ID suffix of the ARN) of the event data store that you want to update.</p>",
"UpdateEventDataStoreResponse$EventDataStoreArn": "<p>The ARN of the event data store.</p>"
}
},
"EventDataStoreHasOngoingImportException": {
"base": "<p> This exception is thrown when you try to update or delete an event data store that currently has an import in progress. </p>",
"refs": {
}
},
"EventDataStoreKmsKeyId": {
"base": null,
"refs": {
"CreateEventDataStoreRequest$KmsKeyId": "<p>Specifies the KMS key ID to use to encrypt the events delivered by CloudTrail. The value can be an alias name prefixed by <code>alias/</code>, a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.</p> <important> <p>Disabling or deleting the KMS key, or removing CloudTrail permissions on the key, prevents CloudTrail from logging events to the event data store, and prevents users from querying the data in the event data store that was encrypted with the key. After you associate an event data store with a KMS key, the KMS key cannot be removed or changed. Before you disable or delete a KMS key that you are using with an event data store, delete or back up your event data store.</p> </important> <p>CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys, 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> <p>Examples:</p> <ul> <li> <p> <code>alias/MyAliasName</code> </p> </li> <li> <p> <code>arn:aws:kms:us-east-2:123456789012:alias/MyAliasName</code> </p> </li> <li> <p> <code>arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012</code> </p> </li> <li> <p> <code>12345678-1234-1234-1234-123456789012</code> </p> </li> </ul>",
"CreateEventDataStoreResponse$KmsKeyId": "<p>Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the following format.</p> <p> <code>arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012</code> </p>",
"GetEventDataStoreResponse$KmsKeyId": "<p>Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the following format.</p> <p> <code>arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012</code> </p>",
"RestoreEventDataStoreResponse$KmsKeyId": "<p>Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the following format.</p> <p> <code>arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012</code> </p>",
"UpdateEventDataStoreRequest$KmsKeyId": "<p>Specifies the KMS key ID to use to encrypt the events delivered by CloudTrail. The value can be an alias name prefixed by <code>alias/</code>, a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.</p> <important> <p>Disabling or deleting the KMS key, or removing CloudTrail permissions on the key, prevents CloudTrail from logging events to the event data store, and prevents users from querying the data in the event data store that was encrypted with the key. After you associate an event data store with a KMS key, the KMS key cannot be removed or changed. Before you disable or delete a KMS key that you are using with an event data store, delete or back up your event data store.</p> </important> <p>CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys, 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> <p>Examples:</p> <ul> <li> <p> <code>alias/MyAliasName</code> </p> </li> <li> <p> <code>arn:aws:kms:us-east-2:123456789012:alias/MyAliasName</code> </p> </li> <li> <p> <code>arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012</code> </p> </li> <li> <p> <code>12345678-1234-1234-1234-123456789012</code> </p> </li> </ul>",
"UpdateEventDataStoreResponse$KmsKeyId": "<p>Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the following format.</p> <p> <code>arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012</code> </p>"
}
},
"EventDataStoreMaxLimitExceededException": {
"base": "<p>Your account has used the maximum number of event data stores.</p>",
"refs": {
}
},
"EventDataStoreName": {
"base": null,
"refs": {
"CreateEventDataStoreRequest$Name": "<p>The name of the event data store.</p>",
"CreateEventDataStoreResponse$Name": "<p>The name of the event data store.</p>",
"EventDataStore$Name": "<p>The name of the event data store.</p>",
"GetEventDataStoreResponse$Name": "<p>The name of the event data store.</p>",
"RestoreEventDataStoreResponse$Name": "<p>The name of the event data store.</p>",
"UpdateEventDataStoreRequest$Name": "<p>The event data store name.</p>",
"UpdateEventDataStoreResponse$Name": "<p>The name of the event data store.</p>"
}
},
"EventDataStoreNotFoundException": {
"base": "<p>The specified event data store was not found.</p>",
"refs": {
}
},
"EventDataStoreStatus": {
"base": null,
"refs": {
"CreateEventDataStoreResponse$Status": "<p>The status of event data store creation.</p>",
"EventDataStore$Status": "<p>This field is being deprecated. The status of an event data store. Values are <code>ENABLED</code> and <code>PENDING_DELETION</code>.</p>",
"GetEventDataStoreResponse$Status": "<p>The status of an event data store. Values can be <code>ENABLED</code> and <code>PENDING_DELETION</code>.</p>",
"RestoreEventDataStoreResponse$Status": "<p>The status of the event data store.</p>",
"UpdateEventDataStoreResponse$Status": "<p>The status of an event data store. Values can be <code>ENABLED</code> and <code>PENDING_DELETION</code>.</p>"
}
},
"EventDataStoreTerminationProtectedException": {
"base": "<p>The event data store cannot be deleted because termination protection is enabled for it.</p>",
"refs": {
}
},
"EventDataStores": {
"base": null,
"refs": {
"ListEventDataStoresResponse$EventDataStores": "<p>Contains information about event data stores in the account, in the current region.</p>"
}
},
"EventSelector": {
"base": "<p>Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.</p> <p>You can configure up to five event selectors for a trail.</p> <p>You cannot apply both event selectors and advanced event selectors to a trail.</p>",
"refs": {
"EventSelectors$member": null
}
},
"EventSelectors": {
"base": null,
"refs": {
"GetEventSelectorsResponse$EventSelectors": "<p>The event selectors that are configured for the trail.</p>",
"PutEventSelectorsRequest$EventSelectors": "<p>Specifies the settings for your event selectors. You can configure up to five event selectors for a trail. You can use either <code>EventSelectors</code> or <code>AdvancedEventSelectors</code> in a <code>PutEventSelectors</code> request, but not both. If you apply <code>EventSelectors</code> to a trail, any existing <code>AdvancedEventSelectors</code> are overwritten.</p>",
"PutEventSelectorsResponse$EventSelectors": "<p>Specifies the event selectors configured for your trail.</p>"
}
},
"EventsList": {
"base": null,
"refs": {
"LookupEventsResponse$Events": "<p>A list of events returned based on the lookup attributes specified and the CloudTrail event. The events list is sorted by time. The most recent event is listed first.</p>"
}
},
"ExcludeManagementEventSources": {
"base": null,
"refs": {
"EventSelector$ExcludeManagementEventSources": "<p>An optional list of service event sources from which you do not want management events to be logged on your trail. In this release, the list can be empty (disables the filter), or it can filter out Key Management Service or Amazon RDS Data API events by containing <code>kms.amazonaws.com</code> or <code>rdsdata.amazonaws.com</code>. By default, <code>ExcludeManagementEventSources</code> is empty, and KMS and Amazon RDS Data API events are logged to your trail. You can exclude management event sources only in regions that support the event source.</p>"
}
},
"GetChannelRequest": {
"base": null,
"refs": {
}
},
"GetChannelResponse": {
"base": null,
"refs": {
}
},
"GetEventDataStoreRequest": {
"base": null,
"refs": {
}
},
"GetEventDataStoreResponse": {
"base": null,
"refs": {
}
},
"GetEventSelectorsRequest": {
"base": null,
"refs": {
}
},
"GetEventSelectorsResponse": {
"base": null,
"refs": {
}
},
"GetImportRequest": {
"base": null,
"refs": {
}
},
"GetImportResponse": {
"base": null,
"refs": {
}
},
"GetInsightSelectorsRequest": {
"base": null,
"refs": {
}
},
"GetInsightSelectorsResponse": {
"base": null,
"refs": {
}
},
"GetQueryResultsRequest": {
"base": null,
"refs": {
}
},
"GetQueryResultsResponse": {
"base": null,
"refs": {
}
},
"GetTrailRequest": {
"base": null,
"refs": {
}
},
"GetTrailResponse": {
"base": null,
"refs": {
}
},
"GetTrailStatusRequest": {
"base": "<p>The name of a trail about which you want the current status.</p>",
"refs": {
}
},
"GetTrailStatusResponse": {
"base": "<p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>",
"refs": {
}
},
"ImportDestinations": {
"base": null,
"refs": {
"GetImportResponse$Destinations": "<p> The ARN of the destination event data store. </p>",
"ImportsListItem$Destinations": "<p> The ARN of the destination event data store. </p>",
"StartImportRequest$Destinations": "<p> The ARN of the destination event data store. Use this parameter for a new import. </p>",
"StartImportResponse$Destinations": "<p> The ARN of the destination event data store. </p>",
"StopImportResponse$Destinations": "<p> The ARN of the destination event data store. </p>"
}
},
"ImportFailureList": {
"base": null,
"refs": {
"ListImportFailuresResponse$Failures": "<p> Contains information about the import failures. </p>"
}
},
"ImportFailureListItem": {
"base": "<p> Provides information about an import failure. </p>",
"refs": {
"ImportFailureList$member": null
}
},
"ImportFailureStatus": {
"base": null,
"refs": {
"ImportFailureListItem$Status": "<p> The status of the import. </p>"
}
},
"ImportNotFoundException": {
"base": "<p> The specified import was not found. </p>",
"refs": {
}
},
"ImportSource": {
"base": "<p> The import source. </p>",
"refs": {
"GetImportResponse$ImportSource": "<p> The source S3 bucket. </p>",
"StartImportRequest$ImportSource": "<p> The source S3 bucket for the import. Use this parameter for a new import. </p>",
"StartImportResponse$ImportSource": "<p> The source S3 bucket for the import. </p>",
"StopImportResponse$ImportSource": "<p> The source S3 bucket for the import. </p>"
}
},
"ImportStatistics": {
"base": "<p> Provides statistics for the specified <code>ImportID</code>. CloudTrail does not update import statistics in real-time. Returned values for parameters such as <code>EventsCompleted</code> may be lower than the actual value, because CloudTrail updates statistics incrementally over the course of the import. </p>",
"refs": {
"GetImportResponse$ImportStatistics": "<p> Provides statistics for the import. CloudTrail does not update import statistics in real-time. Returned values for parameters such as <code>EventsCompleted</code> may be lower than the actual value, because CloudTrail updates statistics incrementally over the course of the import. </p>",
"StopImportResponse$ImportStatistics": "<p> Returns information on the stopped import. </p>"
}
},
"ImportStatus": {
"base": null,
"refs": {
"GetImportResponse$ImportStatus": "<p> The status of the import. </p>",
"ImportsListItem$ImportStatus": "<p> The status of the import. </p>",
"ListImportsRequest$ImportStatus": "<p> The status of the import. </p>",
"StartImportResponse$ImportStatus": "<p> Shows the status of the import after a <code>StartImport</code> request. An import finishes with a status of <code>COMPLETED</code> if there were no failures, or <code>FAILED</code> if there were failures. </p>",
"StopImportResponse$ImportStatus": "<p> The status of the import. </p>"
}
},
"ImportsList": {
"base": null,
"refs": {
"ListImportsResponse$Imports": "<p> The list of returned imports. </p>"
}
},
"ImportsListItem": {
"base": "<p> Contains information about an import that was returned by a lookup request. </p>",
"refs": {
"ImportsList$member": null
}
},
"InactiveEventDataStoreException": {
"base": "<p>The event data store is inactive.</p>",
"refs": {
}
},
"InactiveQueryException": {
"base": "<p>The specified query cannot be canceled because it is in the <code>FINISHED</code>, <code>FAILED</code>, <code>TIMED_OUT</code>, or <code>CANCELLED</code> state.</p>",
"refs": {
}
},
"InsightNotEnabledException": {
"base": "<p>If you run <code>GetInsightSelectors</code> on a trail that does not have Insights events enabled, the operation throws the exception <code>InsightNotEnabledException</code>.</p>",
"refs": {
}
},
"InsightSelector": {
"base": "<p>A JSON string that contains a list of insight types that are logged on a trail.</p>",
"refs": {
"InsightSelectors$member": null
}
},
"InsightSelectors": {
"base": null,
"refs": {
"GetInsightSelectorsResponse$InsightSelectors": "<p>A JSON string that contains the insight types you want to log on a trail. In this release, <code>ApiErrorRateInsight</code> and <code>ApiCallRateInsight</code> are supported as insight types.</p>",
"PutInsightSelectorsRequest$InsightSelectors": "<p>A JSON string that contains the insight types you want to log on a trail. <code>ApiCallRateInsight</code> and <code>ApiErrorRateInsight</code> are valid insight types.</p>",
"PutInsightSelectorsResponse$InsightSelectors": "<p>A JSON string that contains the Insights event types that you want to log on a trail. The valid Insights types in this release are <code>ApiErrorRateInsight</code> and <code>ApiCallRateInsight</code>.</p>"
}
},
"InsightType": {
"base": null,
"refs": {
"InsightSelector$InsightType": "<p>The type of insights to log on a trail. <code>ApiCallRateInsight</code> and <code>ApiErrorRateInsight</code> are valid insight types.</p>"
}
},
"InsufficientDependencyServiceAccessPermissionException": {
"base": "<p>This exception is thrown when the IAM user or role that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.</p>",
"refs": {
}
},
"InsufficientEncryptionPolicyException": {
"base": "<p>This exception is thrown when the policy on the S3 bucket or KMS key does not have sufficient permissions for the operation.</p>",
"refs": {
}
},
"InsufficientS3BucketPolicyException": {
"base": "<p>This exception is thrown when the policy on the S3 bucket is not sufficient.</p>",
"refs": {
}
},
"InsufficientSnsTopicPolicyException": {
"base": "<p>This exception is thrown when the policy on the Amazon SNS topic is not sufficient.</p>",
"refs": {
}
},
"Integer": {
"base": null,
"refs": {
"QueryStatistics$ResultsCount": "<p>The number of results returned.</p>",
"QueryStatistics$TotalResultsCount": "<p>The total number of results returned by a query.</p>",
"QueryStatisticsForDescribeQuery$ExecutionTimeInMillis": "<p>The query's run time, in milliseconds.</p>"
}
},
"InvalidCloudWatchLogsLogGroupArnException": {
"base": "<p>This exception is thrown when the provided CloudWatch Logs log group is not valid.</p>",
"refs": {
}
},
"InvalidCloudWatchLogsRoleArnException": {
"base": "<p>This exception is thrown when the provided role is not valid.</p>",
"refs": {
}
},
"InvalidDateRangeException": {
"base": "<p>A date range for the query was specified that is not valid. Be sure that the start time is chronologically before the end time. For more information about writing a query, see <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-create-edit-query.html\">Create or edit a query</a> in the <i>CloudTrail User Guide</i>.</p>",
"refs": {
}
},
"InvalidEventCategoryException": {
"base": "<p>Occurs if an event category that is not valid is specified as a value of <code>EventCategory</code>.</p>",
"refs": {
}
},
"InvalidEventDataStoreCategoryException": {
"base": "<p>This exception is thrown when event categories of specified event data stores are not valid.</p>",
"refs": {
}
},
"InvalidEventDataStoreStatusException": {
"base": "<p>The event data store is not in a status that supports the operation.</p>",
"refs": {
}
},
"InvalidEventSelectorsException": {
"base": "<p>This exception is thrown when the <code>PutEventSelectors</code> operation is called with a number of event selectors, advanced event selectors, or data resources that is not valid. The combination of event selectors or advanced event selectors and data resources is not valid. A trail can have up to 5 event selectors. If a trail uses advanced event selectors, a maximum of 500 total values for all conditions in all advanced event selectors is allowed. A trail is limited to 250 data resources. These data resources can be distributed across event selectors, but the overall total cannot exceed 250.</p> <p>You can:</p> <ul> <li> <p>Specify a valid number of event selectors (1 to 5) for a trail.</p> </li> <li> <p>Specify a valid number of data resources (1 to 250) for an event selector. The limit of number of resources on an individual event selector is configurable up to 250. However, this upper limit is allowed only if the total number of data resources does not exceed 250 across all event selectors for a trail.</p> </li> <li> <p>Specify up to 500 values for all conditions in all advanced event selectors for a trail.</p> </li> <li> <p>Specify a valid value for a parameter. For example, specifying the <code>ReadWriteType</code> parameter with a value of <code>read-only</code> is not valid.</p> </li> </ul>",
"refs": {
}
},
"InvalidHomeRegionException": {
"base": "<p>This exception is thrown when an operation is called on a trail from a region other than the region in which the trail was created.</p>",
"refs": {
}
},
"InvalidImportSourceException": {
"base": "<p> This exception is thrown when the provided source S3 bucket is not valid for import. </p>",
"refs": {
}
},
"InvalidInsightSelectorsException": {
"base": "<p>The formatting or syntax of the <code>InsightSelectors</code> JSON statement in your <code>PutInsightSelectors</code> or <code>GetInsightSelectors</code> request is not valid, or the specified insight type in the <code>InsightSelectors</code> statement is not a valid insight type.</p>",
"refs": {
}
},
"InvalidKmsKeyIdException": {
"base": "<p>This exception is thrown when the KMS key ARN is not valid.</p>",
"refs": {
}
},
"InvalidLookupAttributesException": {
"base": "<p>Occurs when a lookup attribute is specified that is not valid.</p>",
"refs": {
}
},
"InvalidMaxResultsException": {
"base": "<p>This exception is thrown if the limit specified is not valid.</p>",
"refs": {
}
},
"InvalidNextTokenException": {
"base": "<p>A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.</p>",
"refs": {
}
},
"InvalidParameterCombinationException": {
"base": "<p>This exception is thrown when the combination of parameters provided is not valid.</p>",
"refs": {
}
},
"InvalidParameterException": {
"base": "<p>The request includes a parameter that is not valid.</p>",
"refs": {
}
},
"InvalidQueryStatementException": {
"base": "<p>The query that was submitted has validation errors, or uses incorrect syntax or unsupported keywords. For more information about writing a query, see <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-create-edit-query.html\">Create or edit a query</a> in the <i>CloudTrail User Guide</i>.</p>",
"refs": {
}
},
"InvalidQueryStatusException": {
"base": "<p>The query status is not valid for the operation.</p>",
"refs": {
}
},
"InvalidS3BucketNameException": {
"base": "<p>This exception is thrown when the provided S3 bucket name is not valid.</p>",
"refs": {
}
},
"InvalidS3PrefixException": {
"base": "<p>This exception is thrown when the provided S3 prefix is not valid.</p>",
"refs": {
}
},
"InvalidSnsTopicNameException": {
"base": "<p>This exception is thrown when the provided SNS topic name is not valid.</p>",
"refs": {
}
},
"InvalidTagParameterException": {
"base": "<p>This exception is thrown when the specified tag key or values are not valid. It can also occur if there are duplicate tags or too many tags on the resource.</p>",
"refs": {
}
},
"InvalidTimeRangeException": {
"base": "<p>Occurs if the timestamp values are not valid. Either the start time occurs after the end time, or the time range is outside the range of possible values.</p>",
"refs": {
}
},
"InvalidTokenException": {
"base": "<p>Reserved for future use.</p>",
"refs": {
}
},
"InvalidTrailNameException": {
"base": "<p>This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements:</p> <ul> <li> <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</p> </li> <li> <p>Start with a letter or number, and end with a letter or number</p> </li> <li> <p>Be between 3 and 128 characters</p> </li> <li> <p>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are not valid.</p> </li> <li> <p>Not be in IP address format (for example, 192.168.5.4)</p> </li> </ul>",
"refs": {
}
},
"KmsException": {
"base": "<p>This exception is thrown when there is an issue with the specified KMS key and the trail or event data store can't be updated.</p>",
"refs": {
}
},
"KmsKeyDisabledException": {
"base": "<p>This exception is no longer in use.</p>",
"refs": {
}
},
"KmsKeyNotFoundException": {
"base": "<p>This exception is thrown when the KMS key does not exist, when the S3 bucket and the KMS key are not in the same region, or when the KMS key associated with the Amazon SNS topic either does not exist or is not in the same region.</p>",
"refs": {
}
},
"ListChannelsMaxResultsCount": {
"base": null,
"refs": {
"ListChannelsRequest$MaxResults": "<p> The maximum number of CloudTrail channels to display on a single page. </p>"
}
},
"ListChannelsRequest": {
"base": null,
"refs": {
}
},
"ListChannelsResponse": {
"base": null,
"refs": {
}
},
"ListEventDataStoresMaxResultsCount": {
"base": null,
"refs": {
"ListEventDataStoresRequest$MaxResults": "<p>The maximum number of event data stores to display on a single page.</p>"
}
},
"ListEventDataStoresRequest": {
"base": null,
"refs": {
}
},
"ListEventDataStoresResponse": {
"base": null,
"refs": {
}
},
"ListImportFailuresMaxResultsCount": {
"base": null,
"refs": {
"ListImportFailuresRequest$MaxResults": "<p> The maximum number of failures to display on a single page. </p>"
}
},
"ListImportFailuresRequest": {
"base": null,
"refs": {
}
},
"ListImportFailuresResponse": {
"base": null,
"refs": {
}
},
"ListImportsMaxResultsCount": {
"base": null,
"refs": {
"ListImportsRequest$MaxResults": "<p> The maximum number of imports to display on a single page. </p>"
}
},
"ListImportsRequest": {
"base": null,
"refs": {
}
},
"ListImportsResponse": {
"base": null,
"refs": {
}
},
"ListPublicKeysRequest": {
"base": "<p>Requests the public keys for a specified time range.</p>",
"refs": {
}
},
"ListPublicKeysResponse": {
"base": "<p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>",
"refs": {
}
},
"ListQueriesMaxResultsCount": {
"base": null,
"refs": {
"ListQueriesRequest$MaxResults": "<p>The maximum number of queries to show on a page.</p>"
}
},
"ListQueriesRequest": {
"base": null,
"refs": {
}
},
"ListQueriesResponse": {
"base": null,
"refs": {
}
},