codeguruprofiler.d.ts
67.7 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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class CodeGuruProfiler extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: CodeGuruProfiler.Types.ClientConfiguration)
config: Config & CodeGuruProfiler.Types.ClientConfiguration;
/**
* Add up to 2 anomaly notifications channels for a profiling group.
*/
addNotificationChannels(params: CodeGuruProfiler.Types.AddNotificationChannelsRequest, callback?: (err: AWSError, data: CodeGuruProfiler.Types.AddNotificationChannelsResponse) => void): Request<CodeGuruProfiler.Types.AddNotificationChannelsResponse, AWSError>;
/**
* Add up to 2 anomaly notifications channels for a profiling group.
*/
addNotificationChannels(callback?: (err: AWSError, data: CodeGuruProfiler.Types.AddNotificationChannelsResponse) => void): Request<CodeGuruProfiler.Types.AddNotificationChannelsResponse, AWSError>;
/**
* Returns the time series of values for a requested list of frame metrics from a time period.
*/
batchGetFrameMetricData(params: CodeGuruProfiler.Types.BatchGetFrameMetricDataRequest, callback?: (err: AWSError, data: CodeGuruProfiler.Types.BatchGetFrameMetricDataResponse) => void): Request<CodeGuruProfiler.Types.BatchGetFrameMetricDataResponse, AWSError>;
/**
* Returns the time series of values for a requested list of frame metrics from a time period.
*/
batchGetFrameMetricData(callback?: (err: AWSError, data: CodeGuruProfiler.Types.BatchGetFrameMetricDataResponse) => void): Request<CodeGuruProfiler.Types.BatchGetFrameMetricDataResponse, AWSError>;
/**
* Used by profiler agents to report their current state and to receive remote configuration updates. For example, ConfigureAgent can be used to tell and agent whether to profile or not and for how long to return profiling data.
*/
configureAgent(params: CodeGuruProfiler.Types.ConfigureAgentRequest, callback?: (err: AWSError, data: CodeGuruProfiler.Types.ConfigureAgentResponse) => void): Request<CodeGuruProfiler.Types.ConfigureAgentResponse, AWSError>;
/**
* Used by profiler agents to report their current state and to receive remote configuration updates. For example, ConfigureAgent can be used to tell and agent whether to profile or not and for how long to return profiling data.
*/
configureAgent(callback?: (err: AWSError, data: CodeGuruProfiler.Types.ConfigureAgentResponse) => void): Request<CodeGuruProfiler.Types.ConfigureAgentResponse, AWSError>;
/**
* Creates a profiling group.
*/
createProfilingGroup(params: CodeGuruProfiler.Types.CreateProfilingGroupRequest, callback?: (err: AWSError, data: CodeGuruProfiler.Types.CreateProfilingGroupResponse) => void): Request<CodeGuruProfiler.Types.CreateProfilingGroupResponse, AWSError>;
/**
* Creates a profiling group.
*/
createProfilingGroup(callback?: (err: AWSError, data: CodeGuruProfiler.Types.CreateProfilingGroupResponse) => void): Request<CodeGuruProfiler.Types.CreateProfilingGroupResponse, AWSError>;
/**
* Deletes a profiling group.
*/
deleteProfilingGroup(params: CodeGuruProfiler.Types.DeleteProfilingGroupRequest, callback?: (err: AWSError, data: CodeGuruProfiler.Types.DeleteProfilingGroupResponse) => void): Request<CodeGuruProfiler.Types.DeleteProfilingGroupResponse, AWSError>;
/**
* Deletes a profiling group.
*/
deleteProfilingGroup(callback?: (err: AWSError, data: CodeGuruProfiler.Types.DeleteProfilingGroupResponse) => void): Request<CodeGuruProfiler.Types.DeleteProfilingGroupResponse, AWSError>;
/**
* Returns a ProfilingGroupDescription object that contains information about the requested profiling group.
*/
describeProfilingGroup(params: CodeGuruProfiler.Types.DescribeProfilingGroupRequest, callback?: (err: AWSError, data: CodeGuruProfiler.Types.DescribeProfilingGroupResponse) => void): Request<CodeGuruProfiler.Types.DescribeProfilingGroupResponse, AWSError>;
/**
* Returns a ProfilingGroupDescription object that contains information about the requested profiling group.
*/
describeProfilingGroup(callback?: (err: AWSError, data: CodeGuruProfiler.Types.DescribeProfilingGroupResponse) => void): Request<CodeGuruProfiler.Types.DescribeProfilingGroupResponse, AWSError>;
/**
* Returns a list of FindingsReportSummary objects that contain analysis results for all profiling groups in your AWS account.
*/
getFindingsReportAccountSummary(params: CodeGuruProfiler.Types.GetFindingsReportAccountSummaryRequest, callback?: (err: AWSError, data: CodeGuruProfiler.Types.GetFindingsReportAccountSummaryResponse) => void): Request<CodeGuruProfiler.Types.GetFindingsReportAccountSummaryResponse, AWSError>;
/**
* Returns a list of FindingsReportSummary objects that contain analysis results for all profiling groups in your AWS account.
*/
getFindingsReportAccountSummary(callback?: (err: AWSError, data: CodeGuruProfiler.Types.GetFindingsReportAccountSummaryResponse) => void): Request<CodeGuruProfiler.Types.GetFindingsReportAccountSummaryResponse, AWSError>;
/**
* Get the current configuration for anomaly notifications for a profiling group.
*/
getNotificationConfiguration(params: CodeGuruProfiler.Types.GetNotificationConfigurationRequest, callback?: (err: AWSError, data: CodeGuruProfiler.Types.GetNotificationConfigurationResponse) => void): Request<CodeGuruProfiler.Types.GetNotificationConfigurationResponse, AWSError>;
/**
* Get the current configuration for anomaly notifications for a profiling group.
*/
getNotificationConfiguration(callback?: (err: AWSError, data: CodeGuruProfiler.Types.GetNotificationConfigurationResponse) => void): Request<CodeGuruProfiler.Types.GetNotificationConfigurationResponse, AWSError>;
/**
* Returns the JSON-formatted resource-based policy on a profiling group.
*/
getPolicy(params: CodeGuruProfiler.Types.GetPolicyRequest, callback?: (err: AWSError, data: CodeGuruProfiler.Types.GetPolicyResponse) => void): Request<CodeGuruProfiler.Types.GetPolicyResponse, AWSError>;
/**
* Returns the JSON-formatted resource-based policy on a profiling group.
*/
getPolicy(callback?: (err: AWSError, data: CodeGuruProfiler.Types.GetPolicyResponse) => void): Request<CodeGuruProfiler.Types.GetPolicyResponse, AWSError>;
/**
* Gets the aggregated profile of a profiling group for a specified time range. Amazon CodeGuru Profiler collects posted agent profiles for a profiling group into aggregated profiles. <note> <p> Because aggregated profiles expire over time <code>GetProfile</code> is not idempotent. </p> </note> <p> Specify the time range for the requested aggregated profile using 1 or 2 of the following parameters: <code>startTime</code>, <code>endTime</code>, <code>period</code>. The maximum time range allowed is 7 days. If you specify all 3 parameters, an exception is thrown. If you specify only <code>period</code>, the latest aggregated profile is returned. </p> <p> Aggregated profiles are available with aggregation periods of 5 minutes, 1 hour, and 1 day, aligned to UTC. The aggregation period of an aggregated profile determines how long it is retained. For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AggregatedProfileTime.html"> <code>AggregatedProfileTime</code> </a>. The aggregated profile's aggregation period determines how long it is retained by CodeGuru Profiler. </p> <ul> <li> <p> If the aggregation period is 5 minutes, the aggregated profile is retained for 15 days. </p> </li> <li> <p> If the aggregation period is 1 hour, the aggregated profile is retained for 60 days. </p> </li> <li> <p> If the aggregation period is 1 day, the aggregated profile is retained for 3 years. </p> </li> </ul> <p>There are two use cases for calling <code>GetProfile</code>.</p> <ol> <li> <p> If you want to return an aggregated profile that already exists, use <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ListProfileTimes.html"> <code>ListProfileTimes</code> </a> to view the time ranges of existing aggregated profiles. Use them in a <code>GetProfile</code> request to return a specific, existing aggregated profile. </p> </li> <li> <p> If you want to return an aggregated profile for a time range that doesn't align with an existing aggregated profile, then CodeGuru Profiler makes a best effort to combine existing aggregated profiles from the requested time range and return them as one aggregated profile. </p> <p> If aggregated profiles do not exist for the full time range requested, then aggregated profiles for a smaller time range are returned. For example, if the requested time range is from 00:00 to 00:20, and the existing aggregated profiles are from 00:15 and 00:25, then the aggregated profiles from 00:15 to 00:20 are returned. </p> </li> </ol>
*/
getProfile(params: CodeGuruProfiler.Types.GetProfileRequest, callback?: (err: AWSError, data: CodeGuruProfiler.Types.GetProfileResponse) => void): Request<CodeGuruProfiler.Types.GetProfileResponse, AWSError>;
/**
* Gets the aggregated profile of a profiling group for a specified time range. Amazon CodeGuru Profiler collects posted agent profiles for a profiling group into aggregated profiles. <note> <p> Because aggregated profiles expire over time <code>GetProfile</code> is not idempotent. </p> </note> <p> Specify the time range for the requested aggregated profile using 1 or 2 of the following parameters: <code>startTime</code>, <code>endTime</code>, <code>period</code>. The maximum time range allowed is 7 days. If you specify all 3 parameters, an exception is thrown. If you specify only <code>period</code>, the latest aggregated profile is returned. </p> <p> Aggregated profiles are available with aggregation periods of 5 minutes, 1 hour, and 1 day, aligned to UTC. The aggregation period of an aggregated profile determines how long it is retained. For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AggregatedProfileTime.html"> <code>AggregatedProfileTime</code> </a>. The aggregated profile's aggregation period determines how long it is retained by CodeGuru Profiler. </p> <ul> <li> <p> If the aggregation period is 5 minutes, the aggregated profile is retained for 15 days. </p> </li> <li> <p> If the aggregation period is 1 hour, the aggregated profile is retained for 60 days. </p> </li> <li> <p> If the aggregation period is 1 day, the aggregated profile is retained for 3 years. </p> </li> </ul> <p>There are two use cases for calling <code>GetProfile</code>.</p> <ol> <li> <p> If you want to return an aggregated profile that already exists, use <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ListProfileTimes.html"> <code>ListProfileTimes</code> </a> to view the time ranges of existing aggregated profiles. Use them in a <code>GetProfile</code> request to return a specific, existing aggregated profile. </p> </li> <li> <p> If you want to return an aggregated profile for a time range that doesn't align with an existing aggregated profile, then CodeGuru Profiler makes a best effort to combine existing aggregated profiles from the requested time range and return them as one aggregated profile. </p> <p> If aggregated profiles do not exist for the full time range requested, then aggregated profiles for a smaller time range are returned. For example, if the requested time range is from 00:00 to 00:20, and the existing aggregated profiles are from 00:15 and 00:25, then the aggregated profiles from 00:15 to 00:20 are returned. </p> </li> </ol>
*/
getProfile(callback?: (err: AWSError, data: CodeGuruProfiler.Types.GetProfileResponse) => void): Request<CodeGuruProfiler.Types.GetProfileResponse, AWSError>;
/**
* Returns a list of Recommendation objects that contain recommendations for a profiling group for a given time period. A list of Anomaly objects that contains details about anomalies detected in the profiling group for the same time period is also returned.
*/
getRecommendations(params: CodeGuruProfiler.Types.GetRecommendationsRequest, callback?: (err: AWSError, data: CodeGuruProfiler.Types.GetRecommendationsResponse) => void): Request<CodeGuruProfiler.Types.GetRecommendationsResponse, AWSError>;
/**
* Returns a list of Recommendation objects that contain recommendations for a profiling group for a given time period. A list of Anomaly objects that contains details about anomalies detected in the profiling group for the same time period is also returned.
*/
getRecommendations(callback?: (err: AWSError, data: CodeGuruProfiler.Types.GetRecommendationsResponse) => void): Request<CodeGuruProfiler.Types.GetRecommendationsResponse, AWSError>;
/**
* List the available reports for a given profiling group and time range.
*/
listFindingsReports(params: CodeGuruProfiler.Types.ListFindingsReportsRequest, callback?: (err: AWSError, data: CodeGuruProfiler.Types.ListFindingsReportsResponse) => void): Request<CodeGuruProfiler.Types.ListFindingsReportsResponse, AWSError>;
/**
* List the available reports for a given profiling group and time range.
*/
listFindingsReports(callback?: (err: AWSError, data: CodeGuruProfiler.Types.ListFindingsReportsResponse) => void): Request<CodeGuruProfiler.Types.ListFindingsReportsResponse, AWSError>;
/**
* Lists the start times of the available aggregated profiles of a profiling group for an aggregation period within the specified time range.
*/
listProfileTimes(params: CodeGuruProfiler.Types.ListProfileTimesRequest, callback?: (err: AWSError, data: CodeGuruProfiler.Types.ListProfileTimesResponse) => void): Request<CodeGuruProfiler.Types.ListProfileTimesResponse, AWSError>;
/**
* Lists the start times of the available aggregated profiles of a profiling group for an aggregation period within the specified time range.
*/
listProfileTimes(callback?: (err: AWSError, data: CodeGuruProfiler.Types.ListProfileTimesResponse) => void): Request<CodeGuruProfiler.Types.ListProfileTimesResponse, AWSError>;
/**
* Returns a list of profiling groups. The profiling groups are returned as ProfilingGroupDescription objects.
*/
listProfilingGroups(params: CodeGuruProfiler.Types.ListProfilingGroupsRequest, callback?: (err: AWSError, data: CodeGuruProfiler.Types.ListProfilingGroupsResponse) => void): Request<CodeGuruProfiler.Types.ListProfilingGroupsResponse, AWSError>;
/**
* Returns a list of profiling groups. The profiling groups are returned as ProfilingGroupDescription objects.
*/
listProfilingGroups(callback?: (err: AWSError, data: CodeGuruProfiler.Types.ListProfilingGroupsResponse) => void): Request<CodeGuruProfiler.Types.ListProfilingGroupsResponse, AWSError>;
/**
* Returns a list of the tags that are assigned to a specified resource.
*/
listTagsForResource(params: CodeGuruProfiler.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: CodeGuruProfiler.Types.ListTagsForResourceResponse) => void): Request<CodeGuruProfiler.Types.ListTagsForResourceResponse, AWSError>;
/**
* Returns a list of the tags that are assigned to a specified resource.
*/
listTagsForResource(callback?: (err: AWSError, data: CodeGuruProfiler.Types.ListTagsForResourceResponse) => void): Request<CodeGuruProfiler.Types.ListTagsForResourceResponse, AWSError>;
/**
* Submits profiling data to an aggregated profile of a profiling group. To get an aggregated profile that is created with this profiling data, use GetProfile .
*/
postAgentProfile(params: CodeGuruProfiler.Types.PostAgentProfileRequest, callback?: (err: AWSError, data: CodeGuruProfiler.Types.PostAgentProfileResponse) => void): Request<CodeGuruProfiler.Types.PostAgentProfileResponse, AWSError>;
/**
* Submits profiling data to an aggregated profile of a profiling group. To get an aggregated profile that is created with this profiling data, use GetProfile .
*/
postAgentProfile(callback?: (err: AWSError, data: CodeGuruProfiler.Types.PostAgentProfileResponse) => void): Request<CodeGuruProfiler.Types.PostAgentProfileResponse, AWSError>;
/**
* Adds permissions to a profiling group's resource-based policy that are provided using an action group. If a profiling group doesn't have a resource-based policy, one is created for it using the permissions in the action group and the roles and users in the principals parameter. <p> The one supported action group that can be added is <code>agentPermission</code> which grants <code>ConfigureAgent</code> and <code>PostAgent</code> permissions. For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-ug/resource-based-policies.html">Resource-based policies in CodeGuru Profiler</a> in the <i>Amazon CodeGuru Profiler User Guide</i>, <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html"> <code>ConfigureAgent</code> </a>, and <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_PostAgentProfile.html"> <code>PostAgentProfile</code> </a>. </p> <p> The first time you call <code>PutPermission</code> on a profiling group, do not specify a <code>revisionId</code> because it doesn't have a resource-based policy. Subsequent calls must provide a <code>revisionId</code> to specify which revision of the resource-based policy to add the permissions to. </p> <p> The response contains the profiling group's JSON-formatted resource policy. </p>
*/
putPermission(params: CodeGuruProfiler.Types.PutPermissionRequest, callback?: (err: AWSError, data: CodeGuruProfiler.Types.PutPermissionResponse) => void): Request<CodeGuruProfiler.Types.PutPermissionResponse, AWSError>;
/**
* Adds permissions to a profiling group's resource-based policy that are provided using an action group. If a profiling group doesn't have a resource-based policy, one is created for it using the permissions in the action group and the roles and users in the principals parameter. <p> The one supported action group that can be added is <code>agentPermission</code> which grants <code>ConfigureAgent</code> and <code>PostAgent</code> permissions. For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-ug/resource-based-policies.html">Resource-based policies in CodeGuru Profiler</a> in the <i>Amazon CodeGuru Profiler User Guide</i>, <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html"> <code>ConfigureAgent</code> </a>, and <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_PostAgentProfile.html"> <code>PostAgentProfile</code> </a>. </p> <p> The first time you call <code>PutPermission</code> on a profiling group, do not specify a <code>revisionId</code> because it doesn't have a resource-based policy. Subsequent calls must provide a <code>revisionId</code> to specify which revision of the resource-based policy to add the permissions to. </p> <p> The response contains the profiling group's JSON-formatted resource policy. </p>
*/
putPermission(callback?: (err: AWSError, data: CodeGuruProfiler.Types.PutPermissionResponse) => void): Request<CodeGuruProfiler.Types.PutPermissionResponse, AWSError>;
/**
* Remove one anomaly notifications channel for a profiling group.
*/
removeNotificationChannel(params: CodeGuruProfiler.Types.RemoveNotificationChannelRequest, callback?: (err: AWSError, data: CodeGuruProfiler.Types.RemoveNotificationChannelResponse) => void): Request<CodeGuruProfiler.Types.RemoveNotificationChannelResponse, AWSError>;
/**
* Remove one anomaly notifications channel for a profiling group.
*/
removeNotificationChannel(callback?: (err: AWSError, data: CodeGuruProfiler.Types.RemoveNotificationChannelResponse) => void): Request<CodeGuruProfiler.Types.RemoveNotificationChannelResponse, AWSError>;
/**
* Removes permissions from a profiling group's resource-based policy that are provided using an action group. The one supported action group that can be removed is agentPermission which grants ConfigureAgent and PostAgent permissions. For more information, see Resource-based policies in CodeGuru Profiler in the Amazon CodeGuru Profiler User Guide, ConfigureAgent , and PostAgentProfile .
*/
removePermission(params: CodeGuruProfiler.Types.RemovePermissionRequest, callback?: (err: AWSError, data: CodeGuruProfiler.Types.RemovePermissionResponse) => void): Request<CodeGuruProfiler.Types.RemovePermissionResponse, AWSError>;
/**
* Removes permissions from a profiling group's resource-based policy that are provided using an action group. The one supported action group that can be removed is agentPermission which grants ConfigureAgent and PostAgent permissions. For more information, see Resource-based policies in CodeGuru Profiler in the Amazon CodeGuru Profiler User Guide, ConfigureAgent , and PostAgentProfile .
*/
removePermission(callback?: (err: AWSError, data: CodeGuruProfiler.Types.RemovePermissionResponse) => void): Request<CodeGuruProfiler.Types.RemovePermissionResponse, AWSError>;
/**
* Sends feedback to CodeGuru Profiler about whether the anomaly detected by the analysis is useful or not.
*/
submitFeedback(params: CodeGuruProfiler.Types.SubmitFeedbackRequest, callback?: (err: AWSError, data: CodeGuruProfiler.Types.SubmitFeedbackResponse) => void): Request<CodeGuruProfiler.Types.SubmitFeedbackResponse, AWSError>;
/**
* Sends feedback to CodeGuru Profiler about whether the anomaly detected by the analysis is useful or not.
*/
submitFeedback(callback?: (err: AWSError, data: CodeGuruProfiler.Types.SubmitFeedbackResponse) => void): Request<CodeGuruProfiler.Types.SubmitFeedbackResponse, AWSError>;
/**
* Use to assign one or more tags to a resource.
*/
tagResource(params: CodeGuruProfiler.Types.TagResourceRequest, callback?: (err: AWSError, data: CodeGuruProfiler.Types.TagResourceResponse) => void): Request<CodeGuruProfiler.Types.TagResourceResponse, AWSError>;
/**
* Use to assign one or more tags to a resource.
*/
tagResource(callback?: (err: AWSError, data: CodeGuruProfiler.Types.TagResourceResponse) => void): Request<CodeGuruProfiler.Types.TagResourceResponse, AWSError>;
/**
* Use to remove one or more tags from a resource.
*/
untagResource(params: CodeGuruProfiler.Types.UntagResourceRequest, callback?: (err: AWSError, data: CodeGuruProfiler.Types.UntagResourceResponse) => void): Request<CodeGuruProfiler.Types.UntagResourceResponse, AWSError>;
/**
* Use to remove one or more tags from a resource.
*/
untagResource(callback?: (err: AWSError, data: CodeGuruProfiler.Types.UntagResourceResponse) => void): Request<CodeGuruProfiler.Types.UntagResourceResponse, AWSError>;
/**
* Updates a profiling group.
*/
updateProfilingGroup(params: CodeGuruProfiler.Types.UpdateProfilingGroupRequest, callback?: (err: AWSError, data: CodeGuruProfiler.Types.UpdateProfilingGroupResponse) => void): Request<CodeGuruProfiler.Types.UpdateProfilingGroupResponse, AWSError>;
/**
* Updates a profiling group.
*/
updateProfilingGroup(callback?: (err: AWSError, data: CodeGuruProfiler.Types.UpdateProfilingGroupResponse) => void): Request<CodeGuruProfiler.Types.UpdateProfilingGroupResponse, AWSError>;
}
declare namespace CodeGuruProfiler {
export type ActionGroup = "agentPermissions"|string;
export interface AddNotificationChannelsRequest {
/**
* One or 2 channels to report to when anomalies are detected.
*/
channels: Channels;
/**
* The name of the profiling group that we are setting up notifications for.
*/
profilingGroupName: ProfilingGroupName;
}
export interface AddNotificationChannelsResponse {
/**
* The new notification configuration for this profiling group.
*/
notificationConfiguration?: NotificationConfiguration;
}
export interface AgentConfiguration {
/**
* Parameters used by the profiler. The valid parameters are: MaxStackDepth - The maximum depth of the stacks in the code that is represented in the profile. For example, if CodeGuru Profiler finds a method A, which calls method B, which calls method C, which calls method D, then the depth is 4. If the maxDepth is set to 2, then the profiler evaluates A and B. MemoryUsageLimitPercent - The percentage of memory that is used by the profiler. MinimumTimeForReportingInMilliseconds - The minimum time in milliseconds between sending reports. ReportingIntervalInMilliseconds - The reporting interval in milliseconds used to report profiles. SamplingIntervalInMilliseconds - The sampling interval in milliseconds that is used to profile samples.
*/
agentParameters?: AgentParameters;
/**
* How long a profiling agent should send profiling data using ConfigureAgent . For example, if this is set to 300, the profiling agent calls ConfigureAgent every 5 minutes to submit the profiled data collected during that period.
*/
periodInSeconds: Integer;
/**
* A Boolean that specifies whether the profiling agent collects profiling data or not. Set to true to enable profiling.
*/
shouldProfile: Boolean;
}
export interface AgentOrchestrationConfig {
/**
* A Boolean that specifies whether the profiling agent collects profiling data or not. Set to true to enable profiling.
*/
profilingEnabled: Boolean;
}
export type AgentParameterField = "MaxStackDepth"|"MemoryUsageLimitPercent"|"MinimumTimeForReportingInMilliseconds"|"ReportingIntervalInMilliseconds"|"SamplingIntervalInMilliseconds"|string;
export type AgentParameters = {[key: string]: String};
export type AgentProfile = Buffer|Uint8Array|Blob|string;
export type AggregatedProfile = Buffer|Uint8Array|Blob|string;
export interface AggregatedProfileTime {
/**
* The aggregation period. This indicates the period during which an aggregation profile collects posted agent profiles for a profiling group. Use one of three valid durations that are specified using the ISO 8601 format. P1D — 1 day PT1H — 1 hour PT5M — 5 minutes
*/
period?: AggregationPeriod;
/**
* The time that aggregation of posted agent profiles for a profiling group starts. The aggregation profile contains profiles posted by the agent starting at this time for an aggregation period specified by the period property of the AggregatedProfileTime object. Specify start using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
*/
start?: Timestamp;
}
export type AggregationPeriod = "P1D"|"PT1H"|"PT5M"|string;
export type Anomalies = Anomaly[];
export interface Anomaly {
/**
* A list of the instances of the detected anomalies during the requested period.
*/
instances: AnomalyInstances;
/**
* Details about the metric that the analysis used when it detected the anomaly. The metric includes the name of the frame that was analyzed with the type and thread states used to derive the metric value for that frame.
*/
metric: Metric;
/**
* The reason for which metric was flagged as anomalous.
*/
reason: String;
}
export interface AnomalyInstance {
/**
* The end time of the period during which the metric is flagged as anomalous. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
*/
endTime?: Timestamp;
/**
* The universally unique identifier (UUID) of an instance of an anomaly in a metric.
*/
id: String;
/**
* The start time of the period during which the metric is flagged as anomalous. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
*/
startTime: Timestamp;
/**
* Feedback type on a specific instance of anomaly submitted by the user.
*/
userFeedback?: UserFeedback;
}
export type AnomalyInstanceId = string;
export type AnomalyInstances = AnomalyInstance[];
export interface BatchGetFrameMetricDataRequest {
/**
* The end time of the time period for the returned time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
*/
endTime?: Timestamp;
/**
* The details of the metrics that are used to request a time series of values. The metric includes the name of the frame, the aggregation type to calculate the metric value for the frame, and the thread states to use to get the count for the metric value of the frame.
*/
frameMetrics?: FrameMetrics;
/**
* The duration of the frame metrics used to return the time series values. Specify using the ISO 8601 format. The maximum period duration is one day (PT24H or P1D).
*/
period?: Period;
/**
* The name of the profiling group associated with the the frame metrics used to return the time series values.
*/
profilingGroupName: ProfilingGroupName;
/**
* The start time of the time period for the frame metrics used to return the time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
*/
startTime?: Timestamp;
/**
* The requested resolution of time steps for the returned time series of values. If the requested target resolution is not available due to data not being retained we provide a best effort result by falling back to the most granular available resolution after the target resolution. There are 3 valid values. P1D — 1 day PT1H — 1 hour PT5M — 5 minutes
*/
targetResolution?: AggregationPeriod;
}
export interface BatchGetFrameMetricDataResponse {
/**
* The end time of the time period for the returned time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
*/
endTime: Timestamp;
/**
* List of instances, or time steps, in the time series. For example, if the period is one day (PT24H)), and the resolution is five minutes (PT5M), then there are 288 endTimes in the list that are each five minutes appart.
*/
endTimes: ListOfTimestamps;
/**
* Details of the metrics to request a time series of values. The metric includes the name of the frame, the aggregation type to calculate the metric value for the frame, and the thread states to use to get the count for the metric value of the frame.
*/
frameMetricData: FrameMetricData;
/**
* Resolution or granularity of the profile data used to generate the time series. This is the value used to jump through time steps in a time series. There are 3 valid values. P1D — 1 day PT1H — 1 hour PT5M — 5 minutes
*/
resolution: AggregationPeriod;
/**
* The start time of the time period for the returned time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
*/
startTime: Timestamp;
/**
* List of instances which remained unprocessed. This will create a missing time step in the list of end times.
*/
unprocessedEndTimes: UnprocessedEndTimeMap;
}
export type Boolean = boolean;
export interface Channel {
/**
* List of publishers for different type of events that may be detected in an application from the profile. Anomaly detection is the only event publisher in Profiler.
*/
eventPublishers: EventPublishers;
/**
* Unique identifier for each Channel in the notification configuration of a Profiling Group. A random UUID for channelId is used when adding a channel to the notification configuration if not specified in the request.
*/
id?: ChannelId;
/**
* Unique arn of the resource to be used for notifications. We support a valid SNS topic arn as a channel uri.
*/
uri: ChannelUri;
}
export type ChannelId = string;
export type ChannelUri = string;
export type Channels = Channel[];
export type ClientToken = string;
export type ComputePlatform = "AWSLambda"|"Default"|string;
export interface ConfigureAgentRequest {
/**
* A universally unique identifier (UUID) for a profiling instance. For example, if the profiling instance is an Amazon EC2 instance, it is the instance ID. If it is an AWS Fargate container, it is the container's task ID.
*/
fleetInstanceId?: FleetInstanceId;
/**
* Metadata captured about the compute platform the agent is running on. It includes information about sampling and reporting. The valid fields are: COMPUTE_PLATFORM - The compute platform on which the agent is running AGENT_ID - The ID for an agent instance. AWS_REQUEST_ID - The AWS request ID of a Lambda invocation. EXECUTION_ENVIRONMENT - The execution environment a Lambda function is running on. LAMBDA_FUNCTION_ARN - The Amazon Resource Name (ARN) that is used to invoke a Lambda function. LAMBDA_MEMORY_LIMIT_IN_MB - The memory allocated to a Lambda function. LAMBDA_REMAINING_TIME_IN_MILLISECONDS - The time in milliseconds before execution of a Lambda function times out. LAMBDA_TIME_GAP_BETWEEN_INVOKES_IN_MILLISECONDS - The time in milliseconds between two invocations of a Lambda function. LAMBDA_PREVIOUS_EXECUTION_TIME_IN_MILLISECONDS - The time in milliseconds for the previous Lambda invocation.
*/
metadata?: Metadata;
/**
* The name of the profiling group for which the configured agent is collecting profiling data.
*/
profilingGroupName: ProfilingGroupName;
}
export interface ConfigureAgentResponse {
/**
* An AgentConfiguration object that specifies if an agent profiles or not and for how long to return profiling data.
*/
configuration: AgentConfiguration;
}
export interface CreateProfilingGroupRequest {
/**
* Specifies whether profiling is enabled or disabled for the created profiling group.
*/
agentOrchestrationConfig?: AgentOrchestrationConfig;
/**
* Amazon CodeGuru Profiler uses this universally unique identifier (UUID) to prevent the accidental creation of duplicate profiling groups if there are failures and retries.
*/
clientToken: ClientToken;
/**
* The compute platform of the profiling group. Use AWSLambda if your application runs on AWS Lambda. Use Default if your application runs on a compute platform that is not AWS Lambda, such an Amazon EC2 instance, an on-premises server, or a different platform. If not specified, Default is used.
*/
computePlatform?: ComputePlatform;
/**
* The name of the profiling group to create.
*/
profilingGroupName: ProfilingGroupName;
/**
* A list of tags to add to the created profiling group.
*/
tags?: TagsMap;
}
export interface CreateProfilingGroupResponse {
/**
* The returned ProfilingGroupDescription object that contains information about the created profiling group.
*/
profilingGroup: ProfilingGroupDescription;
}
export interface DeleteProfilingGroupRequest {
/**
* The name of the profiling group to delete.
*/
profilingGroupName: ProfilingGroupName;
}
export interface DeleteProfilingGroupResponse {
}
export interface DescribeProfilingGroupRequest {
/**
* The name of the profiling group to get information about.
*/
profilingGroupName: ProfilingGroupName;
}
export interface DescribeProfilingGroupResponse {
/**
* The returned ProfilingGroupDescription object that contains information about the requested profiling group.
*/
profilingGroup: ProfilingGroupDescription;
}
export type Double = number;
export type EventPublisher = "AnomalyDetection"|string;
export type EventPublishers = EventPublisher[];
export type FeedbackType = "Negative"|"Positive"|string;
export type FindingsReportId = string;
export type FindingsReportSummaries = FindingsReportSummary[];
export interface FindingsReportSummary {
/**
* The universally unique identifier (UUID) of the recommendation report.
*/
id?: FindingsReportId;
/**
* The end time of the period during which the metric is flagged as anomalous. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
*/
profileEndTime?: Timestamp;
/**
* The start time of the profile the analysis data is about. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
*/
profileStartTime?: Timestamp;
/**
* The name of the profiling group that is associated with the analysis data.
*/
profilingGroupName?: String;
/**
* The total number of different recommendations that were found by the analysis.
*/
totalNumberOfFindings?: Integer;
}
export type FleetInstanceId = string;
export interface FrameMetric {
/**
* Name of the method common across the multiple occurrences of a frame in an application profile.
*/
frameName: String;
/**
* List of application runtime thread states used to get the counts for a frame a derive a metric value.
*/
threadStates: ThreadStates;
/**
* A type of aggregation that specifies how a metric for a frame is analyzed. The supported value AggregatedRelativeTotalTime is an aggregation of the metric value for one frame that is calculated across the occurrences of all frames in a profile.
*/
type: MetricType;
}
export type FrameMetricData = FrameMetricDatum[];
export interface FrameMetricDatum {
frameMetric: FrameMetric;
/**
* A list of values that are associated with a frame metric.
*/
values: FrameMetricValues;
}
export type FrameMetricValues = Double[];
export type FrameMetrics = FrameMetric[];
export interface GetFindingsReportAccountSummaryRequest {
/**
* A Boolean value indicating whether to only return reports from daily profiles. If set to True, only analysis data from daily profiles is returned. If set to False, analysis data is returned from smaller time windows (for example, one hour).
*/
dailyReportsOnly?: Boolean;
/**
* The maximum number of results returned by GetFindingsReportAccountSummary in paginated output. When this parameter is used, GetFindingsReportAccountSummary only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another GetFindingsReportAccountSummary request with the returned nextToken value.
*/
maxResults?: MaxResults;
/**
* The nextToken value returned from a previous paginated GetFindingsReportAccountSummary request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
*/
nextToken?: PaginationToken;
}
export interface GetFindingsReportAccountSummaryResponse {
/**
* The nextToken value to include in a future GetFindingsReportAccountSummary request. When the results of a GetFindingsReportAccountSummary request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
*/
nextToken?: PaginationToken;
/**
* The return list of FindingsReportSummary objects taht contain summaries of analysis results for all profiling groups in your AWS account.
*/
reportSummaries: FindingsReportSummaries;
}
export interface GetNotificationConfigurationRequest {
/**
* The name of the profiling group we want to get the notification configuration for.
*/
profilingGroupName: ProfilingGroupName;
}
export interface GetNotificationConfigurationResponse {
/**
* The current notification configuration for this profiling group.
*/
notificationConfiguration: NotificationConfiguration;
}
export interface GetPolicyRequest {
/**
* The name of the profiling group.
*/
profilingGroupName: ProfilingGroupName;
}
export interface GetPolicyResponse {
/**
* The JSON-formatted resource-based policy attached to the ProfilingGroup.
*/
policy: String;
/**
* A unique identifier for the current revision of the returned policy.
*/
revisionId: RevisionId;
}
export interface GetProfileRequest {
/**
* The format of the returned profiling data. The format maps to the Accept and Content-Type headers of the HTTP request. You can specify one of the following: or the default . <ul> <li> <p> <code>application/json</code> — standard JSON format </p> </li> <li> <p> <code>application/x-amzn-ion</code> — the Amazon Ion data format. For more information, see <a href="http://amzn.github.io/ion-docs/">Amazon Ion</a>. </p> </li> </ul>
*/
accept?: String;
/**
* The end time of the requested profile. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. If you specify endTime, then you must also specify period or startTime, but not both.
*/
endTime?: Timestamp;
/**
* The maximum depth of the stacks in the code that is represented in the aggregated profile. For example, if CodeGuru Profiler finds a method A, which calls method B, which calls method C, which calls method D, then the depth is 4. If the maxDepth is set to 2, then the aggregated profile contains representations of methods A and B.
*/
maxDepth?: MaxDepth;
/**
* Used with startTime or endTime to specify the time range for the returned aggregated profile. Specify using the ISO 8601 format. For example, P1DT1H1M1S. <p> To get the latest aggregated profile, specify only <code>period</code>. </p>
*/
period?: Period;
/**
* The name of the profiling group to get.
*/
profilingGroupName: ProfilingGroupName;
/**
* The start time of the profile to get. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. <p> If you specify <code>startTime</code>, then you must also specify <code>period</code> or <code>endTime</code>, but not both. </p>
*/
startTime?: Timestamp;
}
export interface GetProfileResponse {
/**
* The content encoding of the profile.
*/
contentEncoding?: String;
/**
* The content type of the profile in the payload. It is either application/json or the default application/x-amzn-ion.
*/
contentType: String;
/**
* Information about the profile.
*/
profile: AggregatedProfile;
}
export interface GetRecommendationsRequest {
/**
* The start time of the profile to get analysis data about. You must specify startTime and endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
*/
endTime: Timestamp;
/**
* The language used to provide analysis. Specify using a string that is one of the following BCP 47 language codes. de-DE - German, Germany en-GB - English, United Kingdom en-US - English, United States es-ES - Spanish, Spain fr-FR - French, France it-IT - Italian, Italy ja-JP - Japanese, Japan ko-KR - Korean, Republic of Korea pt-BR - Portugese, Brazil zh-CN - Chinese, China zh-TW - Chinese, Taiwan
*/
locale?: Locale;
/**
* The name of the profiling group to get analysis data about.
*/
profilingGroupName: ProfilingGroupName;
/**
* The end time of the profile to get analysis data about. You must specify startTime and endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
*/
startTime: Timestamp;
}
export interface GetRecommendationsResponse {
/**
* The list of anomalies that the analysis has found for this profile.
*/
anomalies: Anomalies;
/**
* The end time of the profile the analysis data is about. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
*/
profileEndTime: Timestamp;
/**
* The start time of the profile the analysis data is about. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
*/
profileStartTime: Timestamp;
/**
* The name of the profiling group the analysis data is about.
*/
profilingGroupName: ProfilingGroupName;
/**
* The list of recommendations that the analysis found for this profile.
*/
recommendations: Recommendations;
}
export type Integer = number;
export interface ListFindingsReportsRequest {
/**
* A Boolean value indicating whether to only return reports from daily profiles. If set to True, only analysis data from daily profiles is returned. If set to False, analysis data is returned from smaller time windows (for example, one hour).
*/
dailyReportsOnly?: Boolean;
/**
* The end time of the profile to get analysis data about. You must specify startTime and endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
*/
endTime: Timestamp;
/**
* The maximum number of report results returned by ListFindingsReports in paginated output. When this parameter is used, ListFindingsReports only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListFindingsReports request with the returned nextToken value.
*/
maxResults?: MaxResults;
/**
* The nextToken value returned from a previous paginated ListFindingsReportsRequest request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
*/
nextToken?: PaginationToken;
/**
* The name of the profiling group from which to search for analysis data.
*/
profilingGroupName: ProfilingGroupName;
/**
* The start time of the profile to get analysis data about. You must specify startTime and endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
*/
startTime: Timestamp;
}
export interface ListFindingsReportsResponse {
/**
* The list of analysis results summaries.
*/
findingsReportSummaries: FindingsReportSummaries;
/**
* The nextToken value to include in a future ListFindingsReports request. When the results of a ListFindingsReports request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
*/
nextToken?: PaginationToken;
}
export type ListOfTimestamps = TimestampStructure[];
export interface ListProfileTimesRequest {
/**
* The end time of the time range from which to list the profiles.
*/
endTime: Timestamp;
/**
* The maximum number of profile time results returned by ListProfileTimes in paginated output. When this parameter is used, ListProfileTimes only returns maxResults results in a single page with a nextToken response element. The remaining results of the initial request can be seen by sending another ListProfileTimes request with the returned nextToken value.
*/
maxResults?: MaxResults;
/**
* The nextToken value returned from a previous paginated ListProfileTimes request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
*/
nextToken?: PaginationToken;
/**
* The order (ascending or descending by start time of the profile) to use when listing profiles. Defaults to TIMESTAMP_DESCENDING.
*/
orderBy?: OrderBy;
/**
* The aggregation period. This specifies the period during which an aggregation profile collects posted agent profiles for a profiling group. There are 3 valid values. P1D — 1 day PT1H — 1 hour PT5M — 5 minutes
*/
period: AggregationPeriod;
/**
* The name of the profiling group.
*/
profilingGroupName: ProfilingGroupName;
/**
* The start time of the time range from which to list the profiles.
*/
startTime: Timestamp;
}
export interface ListProfileTimesResponse {
/**
* The nextToken value to include in a future ListProfileTimes request. When the results of a ListProfileTimes request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
*/
nextToken?: PaginationToken;
/**
* The list of start times of the available profiles for the aggregation period in the specified time range.
*/
profileTimes: ProfileTimes;
}
export interface ListProfilingGroupsRequest {
/**
* A Boolean value indicating whether to include a description. If true, then a list of ProfilingGroupDescription objects that contain detailed information about profiling groups is returned. If false, then a list of profiling group names is returned.
*/
includeDescription?: Boolean;
/**
* The maximum number of profiling groups results returned by ListProfilingGroups in paginated output. When this parameter is used, ListProfilingGroups only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListProfilingGroups request with the returned nextToken value.
*/
maxResults?: MaxResults;
/**
* The nextToken value returned from a previous paginated ListProfilingGroups request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
*/
nextToken?: PaginationToken;
}
export interface ListProfilingGroupsResponse {
/**
* The nextToken value to include in a future ListProfilingGroups request. When the results of a ListProfilingGroups request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
*/
nextToken?: PaginationToken;
/**
* A returned list of profiling group names. A list of the names is returned only if includeDescription is false, otherwise a list of ProfilingGroupDescription objects is returned.
*/
profilingGroupNames: ProfilingGroupNames;
/**
* A returned list ProfilingGroupDescription objects. A list of ProfilingGroupDescription objects is returned only if includeDescription is true, otherwise a list of profiling group names is returned.
*/
profilingGroups?: ProfilingGroupDescriptions;
}
export interface ListTagsForResourceRequest {
/**
* The Amazon Resource Name (ARN) of the resource that contains the tags to return.
*/
resourceArn: ProfilingGroupArn;
}
export interface ListTagsForResourceResponse {
/**
* The list of tags assigned to the specified resource. This is the list of tags returned in the response.
*/
tags?: TagsMap;
}
export type Locale = string;
export interface Match {
/**
* The location in the profiling graph that contains a recommendation found during analysis.
*/
frameAddress?: String;
/**
* The target frame that triggered a match.
*/
targetFramesIndex?: Integer;
/**
* The value in the profile data that exceeded the recommendation threshold.
*/
thresholdBreachValue?: Double;
}
export type Matches = Match[];
export type MaxDepth = number;
export type MaxResults = number;
export type Metadata = {[key: string]: String};
export type MetadataField = "AgentId"|"AwsRequestId"|"ComputePlatform"|"ExecutionEnvironment"|"LambdaFunctionArn"|"LambdaMemoryLimitInMB"|"LambdaPreviousExecutionTimeInMilliseconds"|"LambdaRemainingTimeInMilliseconds"|"LambdaTimeGapBetweenInvokesInMilliseconds"|string;
export interface Metric {
/**
* The name of the method that appears as a frame in any stack in a profile.
*/
frameName: String;
/**
* The list of application runtime thread states that is used to calculate the metric value for the frame.
*/
threadStates: Strings;
/**
* A type that specifies how a metric for a frame is analyzed. The supported value AggregatedRelativeTotalTime is an aggregation of the metric value for one frame that is calculated across the occurences of all frames in a profile.
*/
type: MetricType;
}
export type MetricType = "AggregatedRelativeTotalTime"|string;
export interface NotificationConfiguration {
/**
* List of up to two channels to be used for sending notifications for events detected from the application profile.
*/
channels?: Channels;
}
export type OrderBy = "TimestampAscending"|"TimestampDescending"|string;
export type PaginationToken = string;
export interface Pattern {
/**
* A list of the different counters used to determine if there is a match.
*/
countersToAggregate?: Strings;
/**
* The description of the recommendation. This explains a potential inefficiency in a profiled application.
*/
description?: String;
/**
* The universally unique identifier (UUID) of this pattern.
*/
id?: String;
/**
* The name for this pattern.
*/
name?: String;
/**
* A string that contains the steps recommended to address the potential inefficiency.
*/
resolutionSteps?: String;
/**
* A list of frame names that were searched during the analysis that generated a recommendation.
*/
targetFrames?: TargetFrames;
/**
* The percentage of time an application spends in one method that triggers a recommendation. The percentage of time is the same as the percentage of the total gathered sample counts during analysis.
*/
thresholdPercent?: Percentage;
}
export type Percentage = number;
export type Period = string;
export interface PostAgentProfileRequest {
/**
* The submitted profiling data.
*/
agentProfile: AgentProfile;
/**
* The format of the submitted profiling data. The format maps to the Accept and Content-Type headers of the HTTP request. You can specify one of the following: or the default . <ul> <li> <p> <code>application/json</code> — standard JSON format </p> </li> <li> <p> <code>application/x-amzn-ion</code> — the Amazon Ion data format. For more information, see <a href="http://amzn.github.io/ion-docs/">Amazon Ion</a>. </p> </li> </ul>
*/
contentType: String;
/**
* Amazon CodeGuru Profiler uses this universally unique identifier (UUID) to prevent the accidental submission of duplicate profiling data if there are failures and retries.
*/
profileToken?: ClientToken;
/**
* The name of the profiling group with the aggregated profile that receives the submitted profiling data.
*/
profilingGroupName: ProfilingGroupName;
}
export interface PostAgentProfileResponse {
}
export type Principal = string;
export type Principals = Principal[];
export interface ProfileTime {
/**
* The start time of a profile. It is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
*/
start?: Timestamp;
}
export type ProfileTimes = ProfileTime[];
export type ProfilingGroupArn = string;
export interface ProfilingGroupDescription {
/**
* An AgentOrchestrationConfig object that indicates if the profiling group is enabled for profiled or not.
*/
agentOrchestrationConfig?: AgentOrchestrationConfig;
/**
* The Amazon Resource Name (ARN) identifying the profiling group resource.
*/
arn?: ProfilingGroupArn;
/**
* The compute platform of the profiling group. If it is set to AWSLambda, then the profiled application runs on AWS Lambda. If it is set to Default, then the profiled application runs on a compute platform that is not AWS Lambda, such an Amazon EC2 instance, an on-premises server, or a different platform. The default is Default.
*/
computePlatform?: ComputePlatform;
/**
* The time when the profiling group was created. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
*/
createdAt?: Timestamp;
/**
* The name of the profiling group.
*/
name?: ProfilingGroupName;
/**
* A ProfilingStatus object that includes information about the last time a profile agent pinged back, the last time a profile was received, and the aggregation period and start time for the most recent aggregated profile.
*/
profilingStatus?: ProfilingStatus;
/**
* A list of the tags that belong to this profiling group.
*/
tags?: TagsMap;
/**
* The date and time when the profiling group was last updated. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
*/
updatedAt?: Timestamp;
}
export type ProfilingGroupDescriptions = ProfilingGroupDescription[];
export type ProfilingGroupName = string;
export type ProfilingGroupNames = ProfilingGroupName[];
export interface ProfilingStatus {
/**
* The date and time when the profiling agent most recently pinged back. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
*/
latestAgentOrchestratedAt?: Timestamp;
/**
* The date and time when the most recent profile was received. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
*/
latestAgentProfileReportedAt?: Timestamp;
/**
* An AggregatedProfileTime object that contains the aggregation period and start time for an aggregated profile.
*/
latestAggregatedProfile?: AggregatedProfileTime;
}
export interface PutPermissionRequest {
/**
* Specifies an action group that contains permissions to add to a profiling group resource. One action group is supported, agentPermissions, which grants permission to perform actions required by the profiling agent, ConfigureAgent and PostAgentProfile permissions.
*/
actionGroup: ActionGroup;
/**
* A list ARNs for the roles and users you want to grant access to the profiling group. Wildcards are not are supported in the ARNs.
*/
principals: Principals;
/**
* The name of the profiling group to grant access to.
*/
profilingGroupName: ProfilingGroupName;
/**
* A universally unique identifier (UUID) for the revision of the policy you are adding to the profiling group. Do not specify this when you add permissions to a profiling group for the first time. If a policy already exists on the profiling group, you must specify the revisionId.
*/
revisionId?: RevisionId;
}
export interface PutPermissionResponse {
/**
* The JSON-formatted resource-based policy on the profiling group that includes the added permissions.
*/
policy: String;
/**
* A universally unique identifier (UUID) for the revision of the resource-based policy that includes the added permissions. The JSON-formatted policy is in the policy element of the response.
*/
revisionId: RevisionId;
}
export interface Recommendation {
/**
* How many different places in the profile graph triggered a match.
*/
allMatchesCount: Integer;
/**
* How much of the total sample count is potentially affected.
*/
allMatchesSum: Double;
/**
* End time of the profile that was used by this analysis. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
*/
endTime: Timestamp;
/**
* The pattern that analysis recognized in the profile to make this recommendation.
*/
pattern: Pattern;
/**
* The start time of the profile that was used by this analysis. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
*/
startTime: Timestamp;
/**
* List of the matches with most impact.
*/
topMatches: Matches;
}
export type Recommendations = Recommendation[];
export interface RemoveNotificationChannelRequest {
/**
* The id of the channel that we want to stop receiving notifications.
*/
channelId: ChannelId;
/**
* The name of the profiling group we want to change notification configuration for.
*/
profilingGroupName: ProfilingGroupName;
}
export interface RemoveNotificationChannelResponse {
/**
* The new notification configuration for this profiling group.
*/
notificationConfiguration?: NotificationConfiguration;
}
export interface RemovePermissionRequest {
/**
* Specifies an action group that contains the permissions to remove from a profiling group's resource-based policy. One action group is supported, agentPermissions, which grants ConfigureAgent and PostAgentProfile permissions.
*/
actionGroup: ActionGroup;
/**
* The name of the profiling group.
*/
profilingGroupName: ProfilingGroupName;
/**
* A universally unique identifier (UUID) for the revision of the resource-based policy from which you want to remove permissions.
*/
revisionId: RevisionId;
}
export interface RemovePermissionResponse {
/**
* The JSON-formatted resource-based policy on the profiling group after the specified permissions were removed.
*/
policy: String;
/**
* A universally unique identifier (UUID) for the revision of the resource-based policy after the specified permissions were removed. The updated JSON-formatted policy is in the policy element of the response.
*/
revisionId: RevisionId;
}
export type RevisionId = string;
export type String = string;
export type Strings = String[];
export interface SubmitFeedbackRequest {
/**
* The universally unique identifier (UUID) of the AnomalyInstance object that is included in the analysis data.
*/
anomalyInstanceId: AnomalyInstanceId;
/**
* Optional feedback about this anomaly.
*/
comment?: String;
/**
* The name of the profiling group that is associated with the analysis data.
*/
profilingGroupName: ProfilingGroupName;
/**
* The feedback tpye. Thee are two valid values, Positive and Negative.
*/
type: FeedbackType;
}
export interface SubmitFeedbackResponse {
}
export type TagKeys = String[];
export interface TagResourceRequest {
/**
* The Amazon Resource Name (ARN) of the resource that the tags are added to.
*/
resourceArn: ProfilingGroupArn;
/**
* The list of tags that are added to the specified resource.
*/
tags: TagsMap;
}
export interface TagResourceResponse {
}
export type TagsMap = {[key: string]: String};
export type TargetFrame = String[];
export type TargetFrames = TargetFrame[];
export type ThreadStates = String[];
export type Timestamp = Date;
export interface TimestampStructure {
/**
* A Timestamp. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
*/
value: Timestamp;
}
export type UnprocessedEndTimeMap = {[key: string]: ListOfTimestamps};
export interface UntagResourceRequest {
/**
* The Amazon Resource Name (ARN) of the resource that contains the tags to remove.
*/
resourceArn: ProfilingGroupArn;
/**
* A list of tag keys. Existing tags of resources with keys in this list are removed from the specified resource.
*/
tagKeys: TagKeys;
}
export interface UntagResourceResponse {
}
export interface UpdateProfilingGroupRequest {
/**
* Specifies whether profiling is enabled or disabled for a profiling group.
*/
agentOrchestrationConfig: AgentOrchestrationConfig;
/**
* The name of the profiling group to update.
*/
profilingGroupName: ProfilingGroupName;
}
export interface UpdateProfilingGroupResponse {
/**
* A ProfilingGroupDescription that contains information about the returned updated profiling group.
*/
profilingGroup: ProfilingGroupDescription;
}
export interface UserFeedback {
/**
* Optional Positive or Negative feedback submitted by the user about whether the recommendation is useful or not.
*/
type: FeedbackType;
}
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2019-07-18"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the CodeGuruProfiler client.
*/
export import Types = CodeGuruProfiler;
}
export = CodeGuruProfiler;