/
codeguruprofiler.jl
1161 lines (1071 loc) · 44.9 KB
/
codeguruprofiler.jl
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
# This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: codeguruprofiler
using AWS.Compat
using AWS.UUIDs
"""
add_notification_channels(channels, profiling_group_name)
add_notification_channels(channels, profiling_group_name, params::Dict{String,<:Any})
Add up to 2 anomaly notifications channels for a profiling group.
# Arguments
- `channels`: One or 2 channels to report to when anomalies are detected.
- `profiling_group_name`: The name of the profiling group that we are setting up
notifications for.
"""
function add_notification_channels(
channels, profilingGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return codeguruprofiler(
"POST",
"/profilingGroups/$(profilingGroupName)/notificationConfiguration",
Dict{String,Any}("channels" => channels);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function add_notification_channels(
channels,
profilingGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codeguruprofiler(
"POST",
"/profilingGroups/$(profilingGroupName)/notificationConfiguration",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("channels" => channels), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_get_frame_metric_data(profiling_group_name)
batch_get_frame_metric_data(profiling_group_name, params::Dict{String,<:Any})
Returns the time series of values for a requested list of frame metrics from a time period.
# Arguments
- `profiling_group_name`: The name of the profiling group associated with the the frame
metrics used to return the time series values.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"endTime"`: 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.
- `"frameMetrics"`: 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.
- `"period"`: 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).
- `"startTime"`: 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.
- `"targetResolution"`: 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
"""
function batch_get_frame_metric_data(
profilingGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return codeguruprofiler(
"POST",
"/profilingGroups/$(profilingGroupName)/frames/-/metrics";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_get_frame_metric_data(
profilingGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codeguruprofiler(
"POST",
"/profilingGroups/$(profilingGroupName)/frames/-/metrics",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
configure_agent(profiling_group_name)
configure_agent(profiling_group_name, params::Dict{String,<:Any})
Used by profiler agents to report their current state and to receive remote configuration
updates. For example, ConfigureAgent can be used to tell an agent whether to profile or not
and for how long to return profiling data.
# Arguments
- `profiling_group_name`: The name of the profiling group for which the configured agent
is collecting profiling data.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"fleetInstanceId"`: 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.
- `"metadata"`: 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.
"""
function configure_agent(
profilingGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return codeguruprofiler(
"POST",
"/profilingGroups/$(profilingGroupName)/configureAgent";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function configure_agent(
profilingGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codeguruprofiler(
"POST",
"/profilingGroups/$(profilingGroupName)/configureAgent",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_profiling_group(client_token, profiling_group_name)
create_profiling_group(client_token, profiling_group_name, params::Dict{String,<:Any})
Creates a profiling group.
# Arguments
- `client_token`: Amazon CodeGuru Profiler uses this universally unique identifier (UUID)
to prevent the accidental creation of duplicate profiling groups if there are failures and
retries.
- `profiling_group_name`: The name of the profiling group to create.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"agentOrchestrationConfig"`: Specifies whether profiling is enabled or disabled for the
created profiling group.
- `"computePlatform"`: 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.
- `"tags"`: A list of tags to add to the created profiling group.
"""
function create_profiling_group(
clientToken, profilingGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return codeguruprofiler(
"POST",
"/profilingGroups",
Dict{String,Any}(
"clientToken" => clientToken, "profilingGroupName" => profilingGroupName
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_profiling_group(
clientToken,
profilingGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codeguruprofiler(
"POST",
"/profilingGroups",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"clientToken" => clientToken, "profilingGroupName" => profilingGroupName
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_profiling_group(profiling_group_name)
delete_profiling_group(profiling_group_name, params::Dict{String,<:Any})
Deletes a profiling group.
# Arguments
- `profiling_group_name`: The name of the profiling group to delete.
"""
function delete_profiling_group(
profilingGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return codeguruprofiler(
"DELETE",
"/profilingGroups/$(profilingGroupName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_profiling_group(
profilingGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codeguruprofiler(
"DELETE",
"/profilingGroups/$(profilingGroupName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
describe_profiling_group(profiling_group_name)
describe_profiling_group(profiling_group_name, params::Dict{String,<:Any})
Returns a ProfilingGroupDescription object that contains information about the requested
profiling group.
# Arguments
- `profiling_group_name`: The name of the profiling group to get information about.
"""
function describe_profiling_group(
profilingGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return codeguruprofiler(
"GET",
"/profilingGroups/$(profilingGroupName)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function describe_profiling_group(
profilingGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codeguruprofiler(
"GET",
"/profilingGroups/$(profilingGroupName)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_findings_report_account_summary()
get_findings_report_account_summary(params::Dict{String,<:Any})
Returns a list of FindingsReportSummary objects that contain analysis results for all
profiling groups in your AWS account.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"dailyReportsOnly"`: 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).
- `"maxResults"`: 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.
- `"nextToken"`: 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.
"""
function get_findings_report_account_summary(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return codeguruprofiler(
"GET",
"/internal/findingsReports";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_findings_report_account_summary(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return codeguruprofiler(
"GET",
"/internal/findingsReports",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_notification_configuration(profiling_group_name)
get_notification_configuration(profiling_group_name, params::Dict{String,<:Any})
Get the current configuration for anomaly notifications for a profiling group.
# Arguments
- `profiling_group_name`: The name of the profiling group we want to get the notification
configuration for.
"""
function get_notification_configuration(
profilingGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return codeguruprofiler(
"GET",
"/profilingGroups/$(profilingGroupName)/notificationConfiguration";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_notification_configuration(
profilingGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codeguruprofiler(
"GET",
"/profilingGroups/$(profilingGroupName)/notificationConfiguration",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_policy(profiling_group_name)
get_policy(profiling_group_name, params::Dict{String,<:Any})
Returns the JSON-formatted resource-based policy on a profiling group.
# Arguments
- `profiling_group_name`: The name of the profiling group.
"""
function get_policy(profilingGroupName; aws_config::AbstractAWSConfig=global_aws_config())
return codeguruprofiler(
"GET",
"/profilingGroups/$(profilingGroupName)/policy";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_policy(
profilingGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codeguruprofiler(
"GET",
"/profilingGroups/$(profilingGroupName)/policy",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_profile(profiling_group_name)
get_profile(profiling_group_name, params::Dict{String,<:Any})
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_AggregatedProfileTim
e.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.htm
l"> <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>
# Arguments
- `profiling_group_name`: The name of the profiling group to get.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Accept"`: 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>
- `"endTime"`: 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.
- `"maxDepth"`: 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.
- `"period"`: 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>
- `"startTime"`: 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>
"""
function get_profile(profilingGroupName; aws_config::AbstractAWSConfig=global_aws_config())
return codeguruprofiler(
"GET",
"/profilingGroups/$(profilingGroupName)/profile";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_profile(
profilingGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codeguruprofiler(
"GET",
"/profilingGroups/$(profilingGroupName)/profile",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_recommendations(end_time, profiling_group_name, start_time)
get_recommendations(end_time, profiling_group_name, start_time, params::Dict{String,<:Any})
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.
# Arguments
- `end_time`: 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.
- `profiling_group_name`: The name of the profiling group to get analysis data about.
- `start_time`: 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.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"locale"`: 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
"""
function get_recommendations(
endTime,
profilingGroupName,
startTime;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codeguruprofiler(
"GET",
"/internal/profilingGroups/$(profilingGroupName)/recommendations",
Dict{String,Any}("endTime" => endTime, "startTime" => startTime);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_recommendations(
endTime,
profilingGroupName,
startTime,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codeguruprofiler(
"GET",
"/internal/profilingGroups/$(profilingGroupName)/recommendations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("endTime" => endTime, "startTime" => startTime),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_findings_reports(end_time, profiling_group_name, start_time)
list_findings_reports(end_time, profiling_group_name, start_time, params::Dict{String,<:Any})
List the available reports for a given profiling group and time range.
# Arguments
- `end_time`: 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.
- `profiling_group_name`: The name of the profiling group from which to search for analysis
data.
- `start_time`: 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.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"dailyReportsOnly"`: 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).
- `"maxResults"`: 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.
- `"nextToken"`: 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.
"""
function list_findings_reports(
endTime,
profilingGroupName,
startTime;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codeguruprofiler(
"GET",
"/internal/profilingGroups/$(profilingGroupName)/findingsReports",
Dict{String,Any}("endTime" => endTime, "startTime" => startTime);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_findings_reports(
endTime,
profilingGroupName,
startTime,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codeguruprofiler(
"GET",
"/internal/profilingGroups/$(profilingGroupName)/findingsReports",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("endTime" => endTime, "startTime" => startTime),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_profile_times(end_time, period, profiling_group_name, start_time)
list_profile_times(end_time, period, profiling_group_name, start_time, params::Dict{String,<:Any})
Lists the start times of the available aggregated profiles of a profiling group for an
aggregation period within the specified time range.
# Arguments
- `end_time`: The end time of the time range from which to list the profiles.
- `period`: 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
- `profiling_group_name`: The name of the profiling group.
- `start_time`: The start time of the time range from which to list the profiles.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"maxResults"`: 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.
- `"nextToken"`: 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.
- `"orderBy"`: The order (ascending or descending by start time of the profile) to use when
listing profiles. Defaults to TIMESTAMP_DESCENDING.
"""
function list_profile_times(
endTime,
period,
profilingGroupName,
startTime;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codeguruprofiler(
"GET",
"/profilingGroups/$(profilingGroupName)/profileTimes",
Dict{String,Any}(
"endTime" => endTime, "period" => period, "startTime" => startTime
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_profile_times(
endTime,
period,
profilingGroupName,
startTime,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codeguruprofiler(
"GET",
"/profilingGroups/$(profilingGroupName)/profileTimes",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"endTime" => endTime, "period" => period, "startTime" => startTime
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_profiling_groups()
list_profiling_groups(params::Dict{String,<:Any})
Returns a list of profiling groups. The profiling groups are returned as
ProfilingGroupDescription objects.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"includeDescription"`: 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.
- `"maxResults"`: 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.
- `"nextToken"`: 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.
"""
function list_profiling_groups(; aws_config::AbstractAWSConfig=global_aws_config())
return codeguruprofiler(
"GET", "/profilingGroups"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_profiling_groups(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return codeguruprofiler(
"GET",
"/profilingGroups",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Returns a list of the tags that are assigned to a specified resource.
# Arguments
- `resource_arn`: The Amazon Resource Name (ARN) of the resource that contains the tags to
return.
"""
function list_tags_for_resource(
resourceArn; aws_config::AbstractAWSConfig=global_aws_config()
)
return codeguruprofiler(
"GET",
"/tags/$(resourceArn)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_resource(
resourceArn,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codeguruprofiler(
"GET",
"/tags/$(resourceArn)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
post_agent_profile(content-_type, agent_profile, profiling_group_name)
post_agent_profile(content-_type, agent_profile, profiling_group_name, params::Dict{String,<:Any})
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 .
# Arguments
- `content-_type`: 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>
- `agent_profile`: The submitted profiling data.
- `profiling_group_name`: The name of the profiling group with the aggregated profile that
receives the submitted profiling data.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"profileToken"`: Amazon CodeGuru Profiler uses this universally unique identifier
(UUID) to prevent the accidental submission of duplicate profiling data if there are
failures and retries.
"""
function post_agent_profile(
Content_Type,
agentProfile,
profilingGroupName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codeguruprofiler(
"POST",
"/profilingGroups/$(profilingGroupName)/agentProfile",
Dict{String,Any}(
"agentProfile" => agentProfile,
"profileToken" => string(uuid4()),
"headers" => Dict{String,Any}("Content-Type" => Content_Type),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function post_agent_profile(
Content_Type,
agentProfile,
profilingGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codeguruprofiler(
"POST",
"/profilingGroups/$(profilingGroupName)/agentProfile",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"agentProfile" => agentProfile,
"profileToken" => string(uuid4()),
"headers" => Dict{String,Any}("Content-Type" => Content_Type),
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
put_permission(action_group, principals, profiling_group_name)
put_permission(action_group, principals, profiling_group_name, params::Dict{String,<:Any})
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.h
tml">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.htm
l"> <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>
# Arguments
- `action_group`: 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.
- `principals`: 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.
- `profiling_group_name`: The name of the profiling group to grant access to.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"revisionId"`: 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.
"""
function put_permission(
actionGroup,
principals,
profilingGroupName;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codeguruprofiler(
"PUT",
"/profilingGroups/$(profilingGroupName)/policy/$(actionGroup)",
Dict{String,Any}("principals" => principals);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function put_permission(
actionGroup,
principals,
profilingGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codeguruprofiler(
"PUT",
"/profilingGroups/$(profilingGroupName)/policy/$(actionGroup)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("principals" => principals), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_notification_channel(channel_id, profiling_group_name)
remove_notification_channel(channel_id, profiling_group_name, params::Dict{String,<:Any})
Remove one anomaly notifications channel for a profiling group.
# Arguments
- `channel_id`: The id of the channel that we want to stop receiving notifications.
- `profiling_group_name`: The name of the profiling group we want to change notification
configuration for.
"""
function remove_notification_channel(
channelId, profilingGroupName; aws_config::AbstractAWSConfig=global_aws_config()
)
return codeguruprofiler(
"DELETE",
"/profilingGroups/$(profilingGroupName)/notificationConfiguration/$(channelId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_notification_channel(
channelId,
profilingGroupName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codeguruprofiler(
"DELETE",
"/profilingGroups/$(profilingGroupName)/notificationConfiguration/$(channelId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
remove_permission(action_group, profiling_group_name, revision_id)
remove_permission(action_group, profiling_group_name, revision_id, params::Dict{String,<:Any})
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 .
# Arguments
- `action_group`: 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.
- `profiling_group_name`: The name of the profiling group.
- `revision_id`: A universally unique identifier (UUID) for the revision of the
resource-based policy from which you want to remove permissions.
"""
function remove_permission(
actionGroup,
profilingGroupName,
revisionId;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codeguruprofiler(
"DELETE",
"/profilingGroups/$(profilingGroupName)/policy/$(actionGroup)",
Dict{String,Any}("revisionId" => revisionId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function remove_permission(
actionGroup,
profilingGroupName,
revisionId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return codeguruprofiler(
"DELETE",
"/profilingGroups/$(profilingGroupName)/policy/$(actionGroup)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("revisionId" => revisionId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
submit_feedback(anomaly_instance_id, profiling_group_name, type)
submit_feedback(anomaly_instance_id, profiling_group_name, type, params::Dict{String,<:Any})
Sends feedback to CodeGuru Profiler about whether the anomaly detected by the analysis is
useful or not.