generated from amazon-archives/__template_Apache-2.0
-
Notifications
You must be signed in to change notification settings - Fork 237
Expand file tree
/
Copy pathcloudwatch-logs.json
More file actions
13480 lines (13480 loc) · 760 KB
/
cloudwatch-logs.json
File metadata and controls
13480 lines (13480 loc) · 760 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"smithy": "2.0",
"metadata": {
"suppressions": [
{
"id": "HttpMethodSemantics",
"namespace": "*"
},
{
"id": "HttpResponseCodeSemantics",
"namespace": "*"
},
{
"id": "PaginatedTrait",
"namespace": "*"
},
{
"id": "HttpHeaderTrait",
"namespace": "*"
},
{
"id": "HttpUriConflict",
"namespace": "*"
},
{
"id": "Service",
"namespace": "*"
}
]
},
"shapes": {
"com.amazonaws.cloudwatchlogs#AccessDeniedException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.cloudwatchlogs#Message"
}
},
"traits": {
"smithy.api#documentation": "<p>You don't have sufficient permissions to perform this action.</p>",
"smithy.api#error": "client"
}
},
"com.amazonaws.cloudwatchlogs#AccessPolicy": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1
}
}
},
"com.amazonaws.cloudwatchlogs#AccountId": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 12,
"max": 12
},
"smithy.api#pattern": "^\\d{12}$"
}
},
"com.amazonaws.cloudwatchlogs#AccountIds": {
"type": "list",
"member": {
"target": "com.amazonaws.cloudwatchlogs#AccountId"
},
"traits": {
"smithy.api#length": {
"min": 0,
"max": 20
}
}
},
"com.amazonaws.cloudwatchlogs#AccountPolicies": {
"type": "list",
"member": {
"target": "com.amazonaws.cloudwatchlogs#AccountPolicy"
}
},
"com.amazonaws.cloudwatchlogs#AccountPolicy": {
"type": "structure",
"members": {
"policyName": {
"target": "com.amazonaws.cloudwatchlogs#PolicyName",
"traits": {
"smithy.api#documentation": "<p>The name of the account policy.</p>"
}
},
"policyDocument": {
"target": "com.amazonaws.cloudwatchlogs#AccountPolicyDocument",
"traits": {
"smithy.api#documentation": "<p>The policy document for this account policy.</p>\n <p>The JSON specified in <code>policyDocument</code> can be up to 30,720 characters.</p>"
}
},
"lastUpdatedTime": {
"target": "com.amazonaws.cloudwatchlogs#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The date and time that this policy was most recently updated.</p>"
}
},
"policyType": {
"target": "com.amazonaws.cloudwatchlogs#PolicyType",
"traits": {
"smithy.api#documentation": "<p>The type of policy for this account policy.</p>"
}
},
"scope": {
"target": "com.amazonaws.cloudwatchlogs#Scope",
"traits": {
"smithy.api#documentation": "<p>The scope of the account policy.</p>"
}
},
"selectionCriteria": {
"target": "com.amazonaws.cloudwatchlogs#SelectionCriteria",
"traits": {
"smithy.api#documentation": "<p>The log group selection criteria that is used for this policy.</p>"
}
},
"accountId": {
"target": "com.amazonaws.cloudwatchlogs#AccountId",
"traits": {
"smithy.api#documentation": "<p>The Amazon Web Services account ID that the policy applies to.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A structure that contains information about one CloudWatch Logs account policy.</p>"
}
},
"com.amazonaws.cloudwatchlogs#AccountPolicyDocument": {
"type": "string"
},
"com.amazonaws.cloudwatchlogs#AddKeyEntries": {
"type": "list",
"member": {
"target": "com.amazonaws.cloudwatchlogs#AddKeyEntry"
},
"traits": {
"smithy.api#length": {
"min": 1,
"max": 5
}
}
},
"com.amazonaws.cloudwatchlogs#AddKeyEntry": {
"type": "structure",
"members": {
"key": {
"target": "com.amazonaws.cloudwatchlogs#Key",
"traits": {
"smithy.api#documentation": "<p>The key of the new entry to be added to the log event</p>",
"smithy.api#required": {}
}
},
"value": {
"target": "com.amazonaws.cloudwatchlogs#AddKeyValue",
"traits": {
"smithy.api#documentation": "<p>The value of the new entry to be added to the log event</p>",
"smithy.api#required": {}
}
},
"overwriteIfExists": {
"target": "com.amazonaws.cloudwatchlogs#OverwriteIfExists",
"traits": {
"smithy.api#default": false,
"smithy.api#documentation": "<p>Specifies whether to overwrite the value if the key already exists in the log event. If\n you omit this, the default is <code>false</code>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>This object defines one key that will be added with the <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-addKey\"> addKeys</a> processor.</p>"
}
},
"com.amazonaws.cloudwatchlogs#AddKeyValue": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 256
}
}
},
"com.amazonaws.cloudwatchlogs#AddKeys": {
"type": "structure",
"members": {
"entries": {
"target": "com.amazonaws.cloudwatchlogs#AddKeyEntries",
"traits": {
"smithy.api#documentation": "<p>An array of objects, where each object contains the information about one key to add to\n the log event. </p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>This processor adds new key-value pairs to the log event. </p>\n <p>For more information about this processor including examples, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-addKeys\"> addKeys</a> in the <i>CloudWatch Logs User Guide</i>.</p>"
}
},
"com.amazonaws.cloudwatchlogs#AllowedActionForAllowVendedLogsDeliveryForResource": {
"type": "string"
},
"com.amazonaws.cloudwatchlogs#AllowedFieldDelimiters": {
"type": "list",
"member": {
"target": "com.amazonaws.cloudwatchlogs#FieldDelimiter"
}
},
"com.amazonaws.cloudwatchlogs#AllowedFields": {
"type": "list",
"member": {
"target": "com.amazonaws.cloudwatchlogs#RecordField"
}
},
"com.amazonaws.cloudwatchlogs#AmazonResourceName": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 1011
},
"smithy.api#pattern": "^[\\w+=/:,.@-]*$"
}
},
"com.amazonaws.cloudwatchlogs#Anomalies": {
"type": "list",
"member": {
"target": "com.amazonaws.cloudwatchlogs#Anomaly"
}
},
"com.amazonaws.cloudwatchlogs#Anomaly": {
"type": "structure",
"members": {
"anomalyId": {
"target": "com.amazonaws.cloudwatchlogs#AnomalyId",
"traits": {
"smithy.api#documentation": "<p>The unique ID that CloudWatch Logs assigned to this anomaly.</p>",
"smithy.api#required": {}
}
},
"patternId": {
"target": "com.amazonaws.cloudwatchlogs#PatternId",
"traits": {
"smithy.api#documentation": "<p>The ID of the pattern used to help identify this anomaly.</p>",
"smithy.api#required": {}
}
},
"anomalyDetectorArn": {
"target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn",
"traits": {
"smithy.api#documentation": "<p>The ARN of the anomaly detector that identified this anomaly.</p>",
"smithy.api#required": {}
}
},
"patternString": {
"target": "com.amazonaws.cloudwatchlogs#PatternString",
"traits": {
"smithy.api#documentation": "<p>The pattern used to help identify this anomaly, in string format.</p>",
"smithy.api#required": {}
}
},
"patternRegex": {
"target": "com.amazonaws.cloudwatchlogs#PatternRegex",
"traits": {
"smithy.api#documentation": "<p>The pattern used to help identify this anomaly, in regular expression format.</p>"
}
},
"priority": {
"target": "com.amazonaws.cloudwatchlogs#Priority",
"traits": {
"smithy.api#documentation": "<p>The priority level of this anomaly, as determined by CloudWatch Logs. Priority is\n computed based on log severity labels such as <code>FATAL</code> and <code>ERROR</code> and\n the amount of deviation from the baseline. Possible values are <code>HIGH</code>,\n <code>MEDIUM</code>, and <code>LOW</code>.</p>"
}
},
"firstSeen": {
"target": "com.amazonaws.cloudwatchlogs#EpochMillis",
"traits": {
"smithy.api#default": 0,
"smithy.api#documentation": "<p>The date and time when the anomaly detector first saw this anomaly. It is specified as\n epoch time, which is the number of seconds since <code>January 1, 1970, 00:00:00\n UTC</code>.</p>",
"smithy.api#required": {}
}
},
"lastSeen": {
"target": "com.amazonaws.cloudwatchlogs#EpochMillis",
"traits": {
"smithy.api#default": 0,
"smithy.api#documentation": "<p>The date and time when the anomaly detector most recently saw this anomaly. It is\n specified as epoch time, which is the number of seconds since <code>January 1, 1970, 00:00:00\n UTC</code>.</p>",
"smithy.api#required": {}
}
},
"description": {
"target": "com.amazonaws.cloudwatchlogs#Description",
"traits": {
"smithy.api#documentation": "<p>A human-readable description of the anomaly. This description is generated by CloudWatch Logs.</p>",
"smithy.api#required": {}
}
},
"active": {
"target": "com.amazonaws.cloudwatchlogs#Boolean",
"traits": {
"smithy.api#documentation": "<p>Specifies whether this anomaly is still ongoing.</p>",
"smithy.api#required": {}
}
},
"state": {
"target": "com.amazonaws.cloudwatchlogs#State",
"traits": {
"smithy.api#documentation": "<p>Indicates the current state of this anomaly. If it is still being treated as an anomaly,\n the value is <code>Active</code>. If you have suppressed this anomaly by using the <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateAnomaly.html\">UpdateAnomaly</a> operation, the value is <code>Suppressed</code>. If this behavior is\n now considered to be normal, the value is <code>Baseline</code>.</p>",
"smithy.api#required": {}
}
},
"histogram": {
"target": "com.amazonaws.cloudwatchlogs#Histogram",
"traits": {
"smithy.api#documentation": "<p>A map showing times when the anomaly detector ran, and the number of occurrences of this\n anomaly that were detected at each of those runs. The times are specified in epoch time, which\n is the number of seconds since <code>January 1, 1970, 00:00:00 UTC</code>.</p>",
"smithy.api#required": {}
}
},
"logSamples": {
"target": "com.amazonaws.cloudwatchlogs#LogSamples",
"traits": {
"smithy.api#documentation": "<p>An array of sample log event messages that are considered to be part of this\n anomaly.</p>",
"smithy.api#required": {}
}
},
"patternTokens": {
"target": "com.amazonaws.cloudwatchlogs#PatternTokens",
"traits": {
"smithy.api#documentation": "<p>An array of structures where each structure contains information about one token that\n makes up the pattern.</p>",
"smithy.api#required": {}
}
},
"logGroupArnList": {
"target": "com.amazonaws.cloudwatchlogs#LogGroupArnList",
"traits": {
"smithy.api#documentation": "<p>An array of ARNS of the log groups that contained log events considered to be part of this\n anomaly.</p>",
"smithy.api#required": {}
}
},
"suppressed": {
"target": "com.amazonaws.cloudwatchlogs#Boolean",
"traits": {
"smithy.api#documentation": "<p>Indicates whether this anomaly is currently suppressed. To suppress an anomaly, use <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateAnomaly.html\">UpdateAnomaly</a>.</p>"
}
},
"suppressedDate": {
"target": "com.amazonaws.cloudwatchlogs#EpochMillis",
"traits": {
"smithy.api#default": 0,
"smithy.api#documentation": "<p>If the anomaly is suppressed, this indicates when it was suppressed.</p>"
}
},
"suppressedUntil": {
"target": "com.amazonaws.cloudwatchlogs#EpochMillis",
"traits": {
"smithy.api#default": 0,
"smithy.api#documentation": "<p>If the anomaly is suppressed, this indicates when the suppression will end. If this value\n is <code>0</code>, the anomaly was suppressed with no expiration, with the\n <code>INFINITE</code> value.</p>"
}
},
"isPatternLevelSuppression": {
"target": "com.amazonaws.cloudwatchlogs#Boolean",
"traits": {
"smithy.api#documentation": "<p>If this anomaly is suppressed, this field is <code>true</code> if the suppression is\n because the pattern is suppressed. If <code>false</code>, then only this particular anomaly is\n suppressed.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>This structure represents one anomaly that has been found by a logs anomaly\n detector.</p>\n <p>For more information about patterns and anomalies, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateLogAnomalyDetector.html\">CreateLogAnomalyDetector</a>. </p>"
}
},
"com.amazonaws.cloudwatchlogs#AnomalyDetector": {
"type": "structure",
"members": {
"anomalyDetectorArn": {
"target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn",
"traits": {
"smithy.api#documentation": "<p>The ARN of the anomaly detector.</p>"
}
},
"detectorName": {
"target": "com.amazonaws.cloudwatchlogs#DetectorName",
"traits": {
"smithy.api#documentation": "<p>The name of the anomaly detector.</p>"
}
},
"logGroupArnList": {
"target": "com.amazonaws.cloudwatchlogs#LogGroupArnList",
"traits": {
"smithy.api#documentation": "<p>A list of the ARNs of the log groups that this anomaly detector watches.</p>"
}
},
"evaluationFrequency": {
"target": "com.amazonaws.cloudwatchlogs#EvaluationFrequency",
"traits": {
"smithy.api#documentation": "<p>Specifies how often the anomaly detector runs and look for anomalies.</p>"
}
},
"filterPattern": {
"target": "com.amazonaws.cloudwatchlogs#FilterPattern"
},
"anomalyDetectorStatus": {
"target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorStatus",
"traits": {
"smithy.api#documentation": "<p>Specifies the current status of the anomaly detector. To pause an anomaly detector, use\n the <code>enabled</code> parameter in the <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateLogAnomalyDetector.html\">UpdateLogAnomalyDetector</a> operation.</p>"
}
},
"kmsKeyId": {
"target": "com.amazonaws.cloudwatchlogs#KmsKeyId",
"traits": {
"smithy.api#documentation": "<p>The ARN of the KMS key assigned to this anomaly detector, if any.</p>"
}
},
"creationTimeStamp": {
"target": "com.amazonaws.cloudwatchlogs#EpochMillis",
"traits": {
"smithy.api#default": 0,
"smithy.api#documentation": "<p>The date and time when this anomaly detector was created.</p>"
}
},
"lastModifiedTimeStamp": {
"target": "com.amazonaws.cloudwatchlogs#EpochMillis",
"traits": {
"smithy.api#default": 0,
"smithy.api#documentation": "<p>The date and time when this anomaly detector was most recently modified.</p>"
}
},
"anomalyVisibilityTime": {
"target": "com.amazonaws.cloudwatchlogs#AnomalyVisibilityTime",
"traits": {
"smithy.api#documentation": "<p>The number of days used as the life cycle of anomalies. After this time, anomalies are\n automatically baselined and the anomaly detector model will treat new occurrences of similar\n event as normal. </p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains information about one anomaly detector in the account.</p>"
}
},
"com.amazonaws.cloudwatchlogs#AnomalyDetectorArn": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1
},
"smithy.api#pattern": "^[\\w#+=/:,.@-]*$"
}
},
"com.amazonaws.cloudwatchlogs#AnomalyDetectorStatus": {
"type": "enum",
"members": {
"INITIALIZING": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "INITIALIZING"
}
},
"TRAINING": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "TRAINING"
}
},
"ANALYZING": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ANALYZING"
}
},
"FAILED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "FAILED"
}
},
"DELETED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "DELETED"
}
},
"PAUSED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "PAUSED"
}
}
}
},
"com.amazonaws.cloudwatchlogs#AnomalyDetectors": {
"type": "list",
"member": {
"target": "com.amazonaws.cloudwatchlogs#AnomalyDetector"
}
},
"com.amazonaws.cloudwatchlogs#AnomalyId": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 36,
"max": 36
}
}
},
"com.amazonaws.cloudwatchlogs#AnomalyVisibilityTime": {
"type": "long",
"traits": {
"smithy.api#range": {
"min": 7,
"max": 90
}
}
},
"com.amazonaws.cloudwatchlogs#ApplyOnTransformedLogs": {
"type": "boolean",
"traits": {
"smithy.api#default": false
}
},
"com.amazonaws.cloudwatchlogs#Arn": {
"type": "string"
},
"com.amazonaws.cloudwatchlogs#AssociateKmsKey": {
"type": "operation",
"input": {
"target": "com.amazonaws.cloudwatchlogs#AssociateKmsKeyRequest"
},
"output": {
"target": "smithy.api#Unit"
},
"errors": [
{
"target": "com.amazonaws.cloudwatchlogs#InvalidParameterException"
},
{
"target": "com.amazonaws.cloudwatchlogs#OperationAbortedException"
},
{
"target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException"
},
{
"target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException"
}
],
"traits": {
"smithy.api#documentation": "<p>Associates the specified KMS key with either one log group in the\n account, or with all stored CloudWatch Logs query insights results in the\n account.</p>\n <p>When you use <code>AssociateKmsKey</code>, you specify either the\n <code>logGroupName</code> parameter or the <code>resourceIdentifier</code> parameter. You\n can't specify both of those parameters in the same operation.</p>\n <ul>\n <li>\n <p>Specify the <code>logGroupName</code> parameter to cause log events ingested into that\n log group to be encrypted with that key. Only the log events ingested after the key is\n associated are encrypted with that key.</p>\n <p>Associating a KMS key with a log group overrides any existing\n associations between the log group and a KMS key. After a KMS key is associated with a log group, all newly ingested data for the log group\n is encrypted using the KMS key. This association is stored as long as the\n data encrypted with the KMS key is still within CloudWatch Logs. This\n enables CloudWatch Logs to decrypt this data whenever it is requested.</p>\n <p>Associating a key with a log group does not cause the results of queries of that log\n group to be encrypted with that key. To have query results encrypted with a KMS key, you must use an <code>AssociateKmsKey</code> operation with the\n <code>resourceIdentifier</code> parameter that specifies a <code>query-result</code>\n resource. </p>\n </li>\n <li>\n <p>Specify the <code>resourceIdentifier</code> parameter with a <code>query-result</code>\n resource, to use that key to encrypt the stored results of all future <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html\">StartQuery</a> operations in the account. The response from a <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetQueryResults.html\">GetQueryResults</a> operation will still return the query results in plain\n text.</p>\n <p>Even if you have not associated a key with your query results, the query results are\n encrypted when stored, using the default CloudWatch Logs method.</p>\n <p>If you run a query from a monitoring account that queries logs in a source account,\n the query results key from the monitoring account, if any, is used.</p>\n </li>\n </ul>\n <important>\n <p>If you delete the key that is used to encrypt log events or log group query results,\n then all the associated stored log events or query results that were encrypted with that key\n will be unencryptable and unusable.</p>\n </important>\n <note>\n <p>CloudWatch Logs supports only symmetric KMS keys. Do not associate an\n asymmetric KMS key with your log group or query results. For more\n information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html\">Using Symmetric and Asymmetric\n Keys</a>.</p>\n </note>\n <p>It can take up to 5 minutes for this operation to take effect.</p>\n <p>If you attempt to associate a KMS key with a log group but the KMS key does not exist or the KMS key is disabled, you receive an\n <code>InvalidParameterException</code> error. </p>"
}
},
"com.amazonaws.cloudwatchlogs#AssociateKmsKeyRequest": {
"type": "structure",
"members": {
"logGroupName": {
"target": "com.amazonaws.cloudwatchlogs#LogGroupName",
"traits": {
"smithy.api#documentation": "<p>The name of the log group.</p>\n <p>In your <code>AssociateKmsKey</code> operation, you must specify either the\n <code>resourceIdentifier</code> parameter or the <code>logGroup</code> parameter, but you\n can't specify both.</p>"
}
},
"kmsKeyId": {
"target": "com.amazonaws.cloudwatchlogs#KmsKeyId",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the KMS key to use when encrypting log\n data. This must be a symmetric KMS key. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms\">Amazon Resource Names</a> and <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html\">Using Symmetric and Asymmetric\n Keys</a>.</p>",
"smithy.api#required": {}
}
},
"resourceIdentifier": {
"target": "com.amazonaws.cloudwatchlogs#ResourceIdentifier",
"traits": {
"smithy.api#documentation": "<p>Specifies the target for this operation. You must specify one of the following:</p>\n <ul>\n <li>\n <p>Specify the following ARN to have future <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetQueryResults.html\">GetQueryResults</a> operations in this account encrypt the results with the\n specified KMS key. Replace <i>REGION</i> and\n <i>ACCOUNT_ID</i> with your Region and account ID.</p>\n <p>\n <code>arn:aws:logs:<i>REGION</i>:<i>ACCOUNT_ID</i>:query-result:*</code>\n </p>\n </li>\n <li>\n <p>Specify the ARN of a log group to have CloudWatch Logs use the KMS key to encrypt log events that are ingested and stored by that log\n group. The log group ARN must be in the following format. Replace\n <i>REGION</i> and <i>ACCOUNT_ID</i> with your Region and\n account ID.</p>\n <p>\n <code>arn:aws:logs:<i>REGION</i>:<i>ACCOUNT_ID</i>:log-group:<i>LOG_GROUP_NAME</i>\n </code>\n </p>\n </li>\n </ul>\n <p>In your <code>AssociateKmsKey</code> operation, you must specify either the\n <code>resourceIdentifier</code> parameter or the <code>logGroup</code> parameter, but you\n can't specify both.</p>"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.cloudwatchlogs#Baseline": {
"type": "boolean"
},
"com.amazonaws.cloudwatchlogs#Boolean": {
"type": "boolean"
},
"com.amazonaws.cloudwatchlogs#CSV": {
"type": "structure",
"members": {
"quoteCharacter": {
"target": "com.amazonaws.cloudwatchlogs#QuoteCharacter",
"traits": {
"smithy.api#documentation": "<p>The character used used as a text qualifier for a single column of data. If you omit this,\n the double quotation mark <code>\"</code> character is used.</p>"
}
},
"delimiter": {
"target": "com.amazonaws.cloudwatchlogs#Delimiter",
"traits": {
"smithy.api#documentation": "<p>The character used to separate each column in the original comma-separated value log\n event. If you omit this, the processor looks for the comma <code>,</code> character as the\n delimiter.</p>"
}
},
"columns": {
"target": "com.amazonaws.cloudwatchlogs#Columns",
"traits": {
"smithy.api#documentation": "<p>An array of names to use for the columns in the transformed log event.</p>\n <p>If you omit this, default column names (<code>[column_1, column_2 ...]</code>) are\n used.</p>"
}
},
"source": {
"target": "com.amazonaws.cloudwatchlogs#Source",
"traits": {
"smithy.api#documentation": "<p>The path to the field in the log event that has the comma separated values to be parsed.\n If you omit this value, the whole log message is processed.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The <code>CSV</code> processor parses comma-separated values (CSV) from the log events\n into columns.</p>\n <p>For more information about this processor including examples, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-csv\"> csv</a> in the <i>CloudWatch Logs User Guide</i>.</p>"
}
},
"com.amazonaws.cloudwatchlogs#CancelExportTask": {
"type": "operation",
"input": {
"target": "com.amazonaws.cloudwatchlogs#CancelExportTaskRequest"
},
"output": {
"target": "smithy.api#Unit"
},
"errors": [
{
"target": "com.amazonaws.cloudwatchlogs#InvalidOperationException"
},
{
"target": "com.amazonaws.cloudwatchlogs#InvalidParameterException"
},
{
"target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException"
},
{
"target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException"
}
],
"traits": {
"smithy.api#documentation": "<p>Cancels the specified export task.</p>\n <p>The task must be in the <code>PENDING</code> or <code>RUNNING</code> state.</p>"
}
},
"com.amazonaws.cloudwatchlogs#CancelExportTaskRequest": {
"type": "structure",
"members": {
"taskId": {
"target": "com.amazonaws.cloudwatchlogs#ExportTaskId",
"traits": {
"smithy.api#documentation": "<p>The ID of the export task.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.cloudwatchlogs#ClientToken": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 36,
"max": 128
},
"smithy.api#pattern": "^\\S{36,128}$"
}
},
"com.amazonaws.cloudwatchlogs#CollectionRetentionDays": {
"type": "integer",
"traits": {
"smithy.api#range": {
"min": 1,
"max": 30
}
}
},
"com.amazonaws.cloudwatchlogs#Column": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 128
}
}
},
"com.amazonaws.cloudwatchlogs#Columns": {
"type": "list",
"member": {
"target": "com.amazonaws.cloudwatchlogs#Column"
},
"traits": {
"smithy.api#length": {
"min": 0,
"max": 100
}
}
},
"com.amazonaws.cloudwatchlogs#ConfigurationTemplate": {
"type": "structure",
"members": {
"service": {
"target": "com.amazonaws.cloudwatchlogs#Service",
"traits": {
"smithy.api#documentation": "<p>A string specifying which service this configuration template applies to. For more\n information about supported services see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html\">Enable logging from\n Amazon Web Services services.</a>.</p>"
}
},
"logType": {
"target": "com.amazonaws.cloudwatchlogs#LogType",
"traits": {
"smithy.api#documentation": "<p>A string specifying which log type this configuration template applies to.</p>"
}
},
"resourceType": {
"target": "com.amazonaws.cloudwatchlogs#ResourceType",
"traits": {
"smithy.api#documentation": "<p>A string specifying which resource type this configuration template applies to.</p>"
}
},
"deliveryDestinationType": {
"target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationType",
"traits": {
"smithy.api#documentation": "<p>A string specifying which destination type this configuration template applies to.</p>"
}
},
"defaultDeliveryConfigValues": {
"target": "com.amazonaws.cloudwatchlogs#ConfigurationTemplateDeliveryConfigValues",
"traits": {
"smithy.api#documentation": "<p>A mapping that displays the default value of each property within a delivery's\n configuration, if it is not specified in the request.</p>"
}
},
"allowedFields": {
"target": "com.amazonaws.cloudwatchlogs#AllowedFields",
"traits": {
"smithy.api#documentation": "<p>The allowed fields that a caller can use in the <code>recordFields</code> parameter of a\n <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html\">CreateDelivery</a> or <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateDeliveryConfiguration.html\">UpdateDeliveryConfiguration</a> operation.</p>"
}
},
"allowedOutputFormats": {
"target": "com.amazonaws.cloudwatchlogs#OutputFormats",
"traits": {
"smithy.api#documentation": "<p>The list of delivery destination output formats that are supported by this log\n source.</p>"
}
},
"allowedActionForAllowVendedLogsDeliveryForResource": {
"target": "com.amazonaws.cloudwatchlogs#AllowedActionForAllowVendedLogsDeliveryForResource",
"traits": {
"smithy.api#documentation": "<p>The action permissions that a caller needs to have to be able to successfully create a\n delivery source on the desired resource type when calling <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html\">PutDeliverySource</a>.</p>"
}
},
"allowedFieldDelimiters": {
"target": "com.amazonaws.cloudwatchlogs#AllowedFieldDelimiters",
"traits": {
"smithy.api#documentation": "<p>The valid values that a caller can use as field delimiters when calling <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html\">CreateDelivery</a> or <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateDeliveryConfiguration.html\">UpdateDeliveryConfiguration</a> on a delivery that delivers in <code>Plain</code>,\n <code>W3C</code>, or <code>Raw</code> format.</p>"
}
},
"allowedSuffixPathFields": {
"target": "com.amazonaws.cloudwatchlogs#RecordFields",
"traits": {
"smithy.api#documentation": "<p>The list of variable fields that can be used in the suffix path of a delivery that\n delivers to an S3 bucket.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A structure containing information about the deafult settings and available settings that\n you can use to configure a <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_Delivery.html\">delivery</a> or a\n <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeliveryDestination.html\">delivery\n destination</a>.</p>"
}
},
"com.amazonaws.cloudwatchlogs#ConfigurationTemplateDeliveryConfigValues": {
"type": "structure",
"members": {
"recordFields": {
"target": "com.amazonaws.cloudwatchlogs#RecordFields",
"traits": {
"smithy.api#documentation": "<p>The default record fields that will be delivered when a list of record fields is not\n provided in a <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html\">CreateDelivery</a> operation.</p>"
}
},
"fieldDelimiter": {
"target": "com.amazonaws.cloudwatchlogs#FieldDelimiter",
"traits": {
"smithy.api#documentation": "<p>The default field delimiter that is used in a <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html\">CreateDelivery</a> operation when the field delimiter is not specified in that\n operation. The field delimiter is used only when the final output delivery is in\n <code>Plain</code>, <code>W3C</code>, or <code>Raw</code> format.</p>"
}
},
"s3DeliveryConfiguration": {
"target": "com.amazonaws.cloudwatchlogs#S3DeliveryConfiguration",
"traits": {
"smithy.api#documentation": "<p>The delivery parameters that are used when you create a delivery to a delivery destination\n that is an S3 Bucket.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>This structure contains the default values that are used for each configuration parameter\n when you use <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html\">CreateDelivery</a> to create a deliver under the current service type, resource type,\n and log type.</p>"
}
},
"com.amazonaws.cloudwatchlogs#ConfigurationTemplates": {
"type": "list",
"member": {
"target": "com.amazonaws.cloudwatchlogs#ConfigurationTemplate"
}
},
"com.amazonaws.cloudwatchlogs#ConflictException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.cloudwatchlogs#Message"
}
},
"traits": {
"smithy.api#documentation": "<p>This operation attempted to create a resource that already exists.</p>",
"smithy.api#error": "client"
}
},
"com.amazonaws.cloudwatchlogs#CopyValue": {
"type": "structure",
"members": {
"entries": {
"target": "com.amazonaws.cloudwatchlogs#CopyValueEntries",
"traits": {
"smithy.api#documentation": "<p>An array of <code>CopyValueEntry</code> objects, where each object contains the\n information about one field value to copy. </p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>This processor copies values within a log event. You can also use this processor to add\n metadata to log events by copying the values of the following metadata keys into the log\n events: <code>@logGroupName</code>, <code>@logGroupStream</code>, <code>@accountId</code>,\n <code>@regionName</code>. </p>\n <p>For more information about this processor including examples, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-copyValue\"> copyValue</a> in the <i>CloudWatch Logs User Guide</i>.</p>"
}
},
"com.amazonaws.cloudwatchlogs#CopyValueEntries": {
"type": "list",
"member": {
"target": "com.amazonaws.cloudwatchlogs#CopyValueEntry"
},
"traits": {
"smithy.api#length": {
"min": 1,
"max": 5
}
}
},
"com.amazonaws.cloudwatchlogs#CopyValueEntry": {
"type": "structure",
"members": {
"source": {
"target": "com.amazonaws.cloudwatchlogs#Source",
"traits": {
"smithy.api#documentation": "<p>The key to copy.</p>",
"smithy.api#required": {}
}
},
"target": {
"target": "com.amazonaws.cloudwatchlogs#Target",
"traits": {
"smithy.api#documentation": "<p>The key of the field to copy the value to.</p>",
"smithy.api#required": {}
}
},
"overwriteIfExists": {
"target": "com.amazonaws.cloudwatchlogs#OverwriteIfExists",
"traits": {
"smithy.api#default": false,
"smithy.api#documentation": "<p>Specifies whether to overwrite the value if the destination key already exists. If you\n omit this, the default is <code>false</code>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>This object defines one value to be copied with the <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-copoyValue\"> copyValue</a> processor.</p>"
}
},
"com.amazonaws.cloudwatchlogs#Count": {
"type": "long",
"traits": {
"smithy.api#default": 0
}
},
"com.amazonaws.cloudwatchlogs#CreateDelivery": {
"type": "operation",
"input": {
"target": "com.amazonaws.cloudwatchlogs#CreateDeliveryRequest"
},
"output": {
"target": "com.amazonaws.cloudwatchlogs#CreateDeliveryResponse"
},
"errors": [
{
"target": "com.amazonaws.cloudwatchlogs#AccessDeniedException"
},
{
"target": "com.amazonaws.cloudwatchlogs#ConflictException"
},
{
"target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException"
},
{
"target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException"
},
{
"target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException"
},
{
"target": "com.amazonaws.cloudwatchlogs#ThrottlingException"
},
{
"target": "com.amazonaws.cloudwatchlogs#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Creates a <i>delivery</i>. A delivery is a connection between a logical\n <i>delivery source</i> and a logical <i>delivery destination</i>\n that you have already created.</p>\n <p>Only some Amazon Web Services services support being configured as a delivery source using\n this operation. These services are listed as <b>Supported [V2\n Permissions]</b> in the table at <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html\">Enabling logging from\n Amazon Web Services services.</a>\n </p>\n <p>A delivery destination can represent a log group in CloudWatch Logs, an Amazon S3 bucket, a delivery stream in Firehose, or X-Ray.</p>\n <p>To configure logs delivery between a supported Amazon Web Services service and a\n destination, you must do the following:</p>\n <ul>\n <li>\n <p>Create a delivery source, which is a logical object that represents the resource that\n is actually sending the logs. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html\">PutDeliverySource</a>.</p>\n </li>\n <li>\n <p>Create a <i>delivery destination</i>, which is a logical object that\n represents the actual delivery destination. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestination.html\">PutDeliveryDestination</a>.</p>\n </li>\n <li>\n <p>If you are delivering logs cross-account, you must use <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestinationPolicy.html\">PutDeliveryDestinationPolicy</a> in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.\n </p>\n </li>\n <li>\n <p>Use <code>CreateDelivery</code> to create a <i>delivery</i> by pairing\n exactly one delivery source and one delivery destination. </p>\n </li>\n </ul>\n <p>You can configure a single delivery source to send logs to multiple destinations by\n creating multiple deliveries. You can also create multiple deliveries to configure multiple\n delivery sources to send logs to the same delivery destination.</p>\n <p>To update an existing delivery configuration, use <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateDeliveryConfiguration.html\">UpdateDeliveryConfiguration</a>.</p>"
}
},
"com.amazonaws.cloudwatchlogs#CreateDeliveryRequest": {
"type": "structure",
"members": {
"deliverySourceName": {
"target": "com.amazonaws.cloudwatchlogs#DeliverySourceName",
"traits": {
"smithy.api#documentation": "<p>The name of the delivery source to use for this delivery.</p>",
"smithy.api#required": {}
}
},
"deliveryDestinationArn": {
"target": "com.amazonaws.cloudwatchlogs#Arn",
"traits": {
"smithy.api#documentation": "<p>The ARN of the delivery destination to use for this delivery.</p>",
"smithy.api#required": {}
}
},
"recordFields": {
"target": "com.amazonaws.cloudwatchlogs#RecordFields",
"traits": {
"smithy.api#documentation": "<p>The list of record fields to be delivered to the destination, in order. If the delivery's\n log source has mandatory fields, they must be included in this list.</p>"
}
},
"fieldDelimiter": {
"target": "com.amazonaws.cloudwatchlogs#FieldDelimiter",
"traits": {
"smithy.api#documentation": "<p>The field delimiter to use between record fields when the final output format of a\n delivery is in <code>Plain</code>, <code>W3C</code>, or <code>Raw</code> format.</p>"
}
},
"s3DeliveryConfiguration": {
"target": "com.amazonaws.cloudwatchlogs#S3DeliveryConfiguration",
"traits": {
"smithy.api#documentation": "<p>This structure contains parameters that are valid only when the delivery's delivery\n destination is an S3 bucket.</p>"
}
},
"tags": {
"target": "com.amazonaws.cloudwatchlogs#Tags",
"traits": {
"smithy.api#documentation": "<p>An optional list of key-value pairs to associate with the resource.</p>\n <p>For more information about tagging, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\">Tagging Amazon Web Services resources</a>\n </p>"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.cloudwatchlogs#CreateDeliveryResponse": {
"type": "structure",
"members": {
"delivery": {
"target": "com.amazonaws.cloudwatchlogs#Delivery",
"traits": {
"smithy.api#documentation": "<p>A structure that contains information about the delivery that you just created.</p>"
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.cloudwatchlogs#CreateExportTask": {
"type": "operation",
"input": {
"target": "com.amazonaws.cloudwatchlogs#CreateExportTaskRequest"
},
"output": {
"target": "com.amazonaws.cloudwatchlogs#CreateExportTaskResponse"
},
"errors": [
{
"target": "com.amazonaws.cloudwatchlogs#InvalidParameterException"
},
{
"target": "com.amazonaws.cloudwatchlogs#LimitExceededException"
},
{
"target": "com.amazonaws.cloudwatchlogs#OperationAbortedException"
},
{
"target": "com.amazonaws.cloudwatchlogs#ResourceAlreadyExistsException"
},
{
"target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException"
},
{
"target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException"
}
],
"traits": {
"smithy.api#documentation": "<p>Creates an export task so that you can efficiently export data from a log group to an\n Amazon S3 bucket. When you perform a <code>CreateExportTask</code> operation, you must use\n credentials that have permission to write to the S3 bucket that you specify as the\n destination.</p>\n <p>Exporting log data to S3 buckets that are encrypted by KMS is supported.\n Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a\n retention period is also supported.</p>\n <p>Exporting to S3 buckets that are encrypted with AES-256 is supported. </p>\n <p>This is an asynchronous call. If all the required information is provided, this\n operation initiates an export task and responds with the ID of the task. After the task has\n started, you can use <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeExportTasks.html\">DescribeExportTasks</a> to get the status of the export task. Each account can only\n have one active (<code>RUNNING</code> or <code>PENDING</code>) export task at a time. To\n cancel an export task, use <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CancelExportTask.html\">CancelExportTask</a>.</p>\n <p>You can export logs from multiple log groups or multiple time ranges to the same S3\n bucket. To separate log data for each export task, specify a prefix to be used as the Amazon\n S3 key prefix for all exported objects.</p>\n <note>\n <p>We recommend that you don't regularly export to Amazon S3 as a way to\n continuously archive your logs. For that use case, we instead recommend that you use\n subscriptions. For more information about subscriptions, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Subscriptions.html\">Real-time processing of log data\n with subscriptions</a>.</p>\n </note>\n <note>\n <p>Time-based sorting on chunks of log data inside an exported file is not guaranteed. You\n can sort the exported log field data by using Linux utilities.</p>\n </note>"
}
},
"com.amazonaws.cloudwatchlogs#CreateExportTaskRequest": {
"type": "structure",
"members": {
"taskName": {
"target": "com.amazonaws.cloudwatchlogs#ExportTaskName",
"traits": {
"smithy.api#documentation": "<p>The name of the export task.</p>"
}
},
"logGroupName": {