@aws-sdk/client-codeguruprofiler 3.379.1 → 3.385.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -34,14 +34,17 @@ export type EventPublisher = (typeof EventPublisher)[keyof typeof EventPublisher
34
34
  */
35
35
  export interface Channel {
36
36
  /**
37
+ * @public
37
38
  * <p>Unique identifier for each <code>Channel</code> 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.</p>
38
39
  */
39
40
  id?: string;
40
41
  /**
42
+ * @public
41
43
  * <p>Unique arn of the resource to be used for notifications. We support a valid SNS topic arn as a channel uri.</p>
42
44
  */
43
45
  uri: string | undefined;
44
46
  /**
47
+ * @public
45
48
  * <p>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.</p>
46
49
  */
47
50
  eventPublishers: (EventPublisher | string)[] | undefined;
@@ -52,10 +55,12 @@ export interface Channel {
52
55
  */
53
56
  export interface AddNotificationChannelsRequest {
54
57
  /**
58
+ * @public
55
59
  * <p>The name of the profiling group that we are setting up notifications for.</p>
56
60
  */
57
61
  profilingGroupName: string | undefined;
58
62
  /**
63
+ * @public
59
64
  * <p>One or 2 channels to report to when anomalies are detected.</p>
60
65
  */
61
66
  channels: Channel[] | undefined;
@@ -67,6 +72,7 @@ export interface AddNotificationChannelsRequest {
67
72
  */
68
73
  export interface NotificationConfiguration {
69
74
  /**
75
+ * @public
70
76
  * <p>List of up to two channels to be used for sending notifications for events detected from
71
77
  * the application profile.</p>
72
78
  */
@@ -78,6 +84,7 @@ export interface NotificationConfiguration {
78
84
  */
79
85
  export interface AddNotificationChannelsResponse {
80
86
  /**
87
+ * @public
81
88
  * <p>The new notification configuration for this profiling group.</p>
82
89
  */
83
90
  notificationConfiguration?: NotificationConfiguration;
@@ -204,6 +211,7 @@ export type AgentParameterField = (typeof AgentParameterField)[keyof typeof Agen
204
211
  */
205
212
  export interface AgentConfiguration {
206
213
  /**
214
+ * @public
207
215
  * <p>
208
216
  * A <code>Boolean</code> that specifies whether the profiling agent collects profiling data or not. Set to <code>true</code>
209
217
  * to enable profiling.
@@ -211,6 +219,7 @@ export interface AgentConfiguration {
211
219
  */
212
220
  shouldProfile: boolean | undefined;
213
221
  /**
222
+ * @public
214
223
  * <p>
215
224
  * How long a profiling agent should send profiling data using
216
225
  * <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html">
@@ -224,6 +233,7 @@ export interface AgentConfiguration {
224
233
  */
225
234
  periodInSeconds: number | undefined;
226
235
  /**
236
+ * @public
227
237
  * <p>
228
238
  * Parameters used by the profiler. The valid parameters are:
229
239
  * </p>
@@ -276,6 +286,7 @@ export interface AgentConfiguration {
276
286
  */
277
287
  export interface AgentOrchestrationConfig {
278
288
  /**
289
+ * @public
279
290
  * <p>
280
291
  * A <code>Boolean</code> that specifies whether the profiling agent collects profiling data or not. Set to <code>true</code>
281
292
  * to enable profiling.
@@ -316,6 +327,7 @@ export type AggregationPeriod = (typeof AggregationPeriod)[keyof typeof Aggregat
316
327
  */
317
328
  export interface AggregatedProfileTime {
318
329
  /**
330
+ * @public
319
331
  * <p>
320
332
  * The time that aggregation of posted agent profiles for a profiling group starts. The aggregation profile
321
333
  * contains profiles posted by the agent starting at this time for an aggregation period
@@ -329,6 +341,7 @@ export interface AggregatedProfileTime {
329
341
  */
330
342
  start?: Date;
331
343
  /**
344
+ * @public
332
345
  * <p>
333
346
  * The aggregation period. This indicates the period during which an aggregation profile
334
347
  * collects posted agent profiles for a profiling group. Use one of three valid
@@ -379,6 +392,7 @@ export type FeedbackType = (typeof FeedbackType)[keyof typeof FeedbackType];
379
392
  */
380
393
  export interface UserFeedback {
381
394
  /**
395
+ * @public
382
396
  * <p>Optional <code>Positive</code> or <code>Negative</code> feedback submitted by
383
397
  * the user about whether the recommendation is useful or not.</p>
384
398
  */
@@ -390,12 +404,14 @@ export interface UserFeedback {
390
404
  */
391
405
  export interface AnomalyInstance {
392
406
  /**
407
+ * @public
393
408
  * <p>
394
409
  * The universally unique identifier (UUID) of an instance of an anomaly in a metric.
395
410
  * </p>
396
411
  */
397
412
  id: string | undefined;
398
413
  /**
414
+ * @public
399
415
  * <p>
400
416
  * The start time of the period during which the metric is flagged as anomalous.
401
417
  * This is specified
@@ -405,6 +421,7 @@ export interface AnomalyInstance {
405
421
  */
406
422
  startTime: Date | undefined;
407
423
  /**
424
+ * @public
408
425
  * <p>
409
426
  * The end time of the period during which the metric is flagged as anomalous.
410
427
  * This is specified
@@ -414,6 +431,7 @@ export interface AnomalyInstance {
414
431
  */
415
432
  endTime?: Date;
416
433
  /**
434
+ * @public
417
435
  * <p>Feedback type on a specific instance of anomaly submitted by the user.</p>
418
436
  */
419
437
  userFeedback?: UserFeedback;
@@ -443,12 +461,14 @@ export type MetricType = (typeof MetricType)[keyof typeof MetricType];
443
461
  */
444
462
  export interface Metric {
445
463
  /**
464
+ * @public
446
465
  * <p>
447
466
  * The name of the method that appears as a frame in any stack in a profile.
448
467
  * </p>
449
468
  */
450
469
  frameName: string | undefined;
451
470
  /**
471
+ * @public
452
472
  * <p>
453
473
  * A type that specifies how a metric for a frame is analyzed.
454
474
  * The supported value <code>AggregatedRelativeTotalTime</code> is an
@@ -457,6 +477,7 @@ export interface Metric {
457
477
  */
458
478
  type: MetricType | string | undefined;
459
479
  /**
480
+ * @public
460
481
  * <p>
461
482
  * The list of application runtime thread states that is used to calculate the
462
483
  * metric value for the frame.
@@ -473,6 +494,7 @@ export interface Metric {
473
494
  */
474
495
  export interface Anomaly {
475
496
  /**
497
+ * @public
476
498
  * <p>
477
499
  * Details about the metric that the analysis used when it detected the anomaly.
478
500
  * The metric includes the name of the frame that was analyzed with the type and
@@ -481,10 +503,12 @@ export interface Anomaly {
481
503
  */
482
504
  metric: Metric | undefined;
483
505
  /**
506
+ * @public
484
507
  * <p>The reason for which metric was flagged as anomalous.</p>
485
508
  */
486
509
  reason: string | undefined;
487
510
  /**
511
+ * @public
488
512
  * <p>
489
513
  * A list of the instances of the detected anomalies during the requested period.
490
514
  * </p>
@@ -499,17 +523,20 @@ export interface Anomaly {
499
523
  */
500
524
  export interface FrameMetric {
501
525
  /**
526
+ * @public
502
527
  * <p> Name of the method common across the multiple occurrences of a frame in an application
503
528
  * profile.</p>
504
529
  */
505
530
  frameName: string | undefined;
506
531
  /**
532
+ * @public
507
533
  * <p> A type of aggregation that specifies how a metric for a frame is analyzed. The
508
534
  * supported value <code>AggregatedRelativeTotalTime</code> is an aggregation of the metric
509
535
  * value for one frame that is calculated across the occurrences of all frames in a profile. </p>
510
536
  */
511
537
  type: MetricType | string | undefined;
512
538
  /**
539
+ * @public
513
540
  * <p>List of application runtime thread states used to get the counts for a frame a derive a metric value.</p>
514
541
  */
515
542
  threadStates: string[] | undefined;
@@ -520,6 +547,7 @@ export interface FrameMetric {
520
547
  */
521
548
  export interface BatchGetFrameMetricDataRequest {
522
549
  /**
550
+ * @public
523
551
  * <p>
524
552
  * The name of the profiling group associated with the
525
553
  * the frame metrics used to return the time series values.
@@ -527,6 +555,7 @@ export interface BatchGetFrameMetricDataRequest {
527
555
  */
528
556
  profilingGroupName: string | undefined;
529
557
  /**
558
+ * @public
530
559
  * <p>
531
560
  * The start time of the time period for the frame metrics used to return the time series values.
532
561
  * This is specified
@@ -536,6 +565,7 @@ export interface BatchGetFrameMetricDataRequest {
536
565
  */
537
566
  startTime?: Date;
538
567
  /**
568
+ * @public
539
569
  * <p>
540
570
  * The end time of the time period for the returned time series values.
541
571
  * This is specified
@@ -545,6 +575,7 @@ export interface BatchGetFrameMetricDataRequest {
545
575
  */
546
576
  endTime?: Date;
547
577
  /**
578
+ * @public
548
579
  * <p>
549
580
  * The duration of the frame metrics used to return the time series values.
550
581
  * Specify using the ISO 8601 format. The maximum period duration
@@ -553,6 +584,7 @@ export interface BatchGetFrameMetricDataRequest {
553
584
  */
554
585
  period?: string;
555
586
  /**
587
+ * @public
556
588
  * <p>The requested resolution of time steps for the returned time series of values.
557
589
  * If the requested target resolution is not available due to data not being retained we provide a best effort
558
590
  * result by falling back to the most granular available resolution after the target resolution.
@@ -578,6 +610,7 @@ export interface BatchGetFrameMetricDataRequest {
578
610
  */
579
611
  targetResolution?: AggregationPeriod | string;
580
612
  /**
613
+ * @public
581
614
  * <p>
582
615
  * The details of the metrics that are used to request a time series of values. The metric includes
583
616
  * the name of the frame, the aggregation type to calculate the metric value for the
@@ -595,6 +628,7 @@ export interface BatchGetFrameMetricDataRequest {
595
628
  */
596
629
  export interface TimestampStructure {
597
630
  /**
631
+ * @public
598
632
  * <p>
599
633
  * A <code>Timestamp</code>. This is specified
600
634
  * using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1
@@ -611,12 +645,14 @@ export interface TimestampStructure {
611
645
  */
612
646
  export interface FrameMetricDatum {
613
647
  /**
648
+ * @public
614
649
  * <p>
615
650
  * The frame name, metric type, and thread states. These are used
616
651
  * to derive the value of the metric for the frame.</p>
617
652
  */
618
653
  frameMetric: FrameMetric | undefined;
619
654
  /**
655
+ * @public
620
656
  * <p>
621
657
  * A list of values that are associated with a frame metric.
622
658
  * </p>
@@ -629,6 +665,7 @@ export interface FrameMetricDatum {
629
665
  */
630
666
  export interface BatchGetFrameMetricDataResponse {
631
667
  /**
668
+ * @public
632
669
  * <p>
633
670
  * The start time of the time period for the returned time series values.
634
671
  * This is specified
@@ -638,6 +675,7 @@ export interface BatchGetFrameMetricDataResponse {
638
675
  */
639
676
  startTime: Date | undefined;
640
677
  /**
678
+ * @public
641
679
  * <p>
642
680
  * The end time of the time period for the returned time series values.
643
681
  * This is specified
@@ -647,6 +685,7 @@ export interface BatchGetFrameMetricDataResponse {
647
685
  */
648
686
  endTime: Date | undefined;
649
687
  /**
688
+ * @public
650
689
  * <p>Resolution or granularity of the profile data used to generate the time series.
651
690
  * This is the value used to jump through time steps in a time series. There are 3 valid values.
652
691
  * </p>
@@ -670,6 +709,7 @@ export interface BatchGetFrameMetricDataResponse {
670
709
  */
671
710
  resolution: AggregationPeriod | string | undefined;
672
711
  /**
712
+ * @public
673
713
  * <p>
674
714
  * List of instances, or time steps, in the time series. For example, if the
675
715
  * <code>period</code> is one day (<code>PT24H)</code>), and the <code>resolution</code>
@@ -679,10 +719,12 @@ export interface BatchGetFrameMetricDataResponse {
679
719
  */
680
720
  endTimes: TimestampStructure[] | undefined;
681
721
  /**
722
+ * @public
682
723
  * <p>List of instances which remained unprocessed. This will create a missing time step in the list of end times.</p>
683
724
  */
684
725
  unprocessedEndTimes: Record<string, TimestampStructure[]> | undefined;
685
726
  /**
727
+ * @public
686
728
  * <p>Details of the metrics to request a time series of values. The metric includes
687
729
  * the name of the frame, the aggregation type to calculate the metric value for the frame,
688
730
  * and the thread states to use to get the count for the metric value of the frame.</p>
@@ -695,6 +737,7 @@ export interface BatchGetFrameMetricDataResponse {
695
737
  */
696
738
  export interface GetFindingsReportAccountSummaryRequest {
697
739
  /**
740
+ * @public
698
741
  * <p>The <code>nextToken</code> value returned from a previous paginated <code>GetFindingsReportAccountSummary</code>
699
742
  * request where <code>maxResults</code> was used and the results exceeded the value of that parameter.
700
743
  * Pagination continues from the end of the previous results that returned the <code>nextToken</code> value.
@@ -706,6 +749,7 @@ export interface GetFindingsReportAccountSummaryRequest {
706
749
  */
707
750
  nextToken?: string;
708
751
  /**
752
+ * @public
709
753
  * <p>The maximum number of results returned by <code> GetFindingsReportAccountSummary</code> in paginated output.
710
754
  * When this parameter is used, <code>GetFindingsReportAccountSummary</code> only returns <code>maxResults</code>
711
755
  * results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial
@@ -714,6 +758,7 @@ export interface GetFindingsReportAccountSummaryRequest {
714
758
  */
715
759
  maxResults?: number;
716
760
  /**
761
+ * @public
717
762
  * <p>A <code>Boolean</code> value indicating whether to only return reports from daily profiles. If set
718
763
  * to <code>True</code>, only analysis data from daily profiles is returned. If set to <code>False</code>,
719
764
  * analysis data is returned from smaller time windows (for example, one hour).</p>
@@ -729,14 +774,17 @@ export interface GetFindingsReportAccountSummaryRequest {
729
774
  */
730
775
  export interface FindingsReportSummary {
731
776
  /**
777
+ * @public
732
778
  * <p>The universally unique identifier (UUID) of the recommendation report.</p>
733
779
  */
734
780
  id?: string;
735
781
  /**
782
+ * @public
736
783
  * <p>The name of the profiling group that is associated with the analysis data.</p>
737
784
  */
738
785
  profilingGroupName?: string;
739
786
  /**
787
+ * @public
740
788
  * <p>The start time of the profile the analysis data is about.
741
789
  * This is specified
742
790
  * using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1
@@ -744,6 +792,7 @@ export interface FindingsReportSummary {
744
792
  */
745
793
  profileStartTime?: Date;
746
794
  /**
795
+ * @public
747
796
  * <p>
748
797
  * The end time of the period during which the metric is flagged as anomalous.
749
798
  * This is specified
@@ -753,6 +802,7 @@ export interface FindingsReportSummary {
753
802
  */
754
803
  profileEndTime?: Date;
755
804
  /**
805
+ * @public
756
806
  * <p>The total number of different recommendations that were found by the analysis.</p>
757
807
  */
758
808
  totalNumberOfFindings?: number;
@@ -763,6 +813,7 @@ export interface FindingsReportSummary {
763
813
  */
764
814
  export interface GetFindingsReportAccountSummaryResponse {
765
815
  /**
816
+ * @public
766
817
  * <p>The return list of
767
818
  * <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_FindingsReportSummary.html">
768
819
  * <code>FindingsReportSummary</code>
@@ -771,6 +822,7 @@ export interface GetFindingsReportAccountSummaryResponse {
771
822
  */
772
823
  reportSummaries: FindingsReportSummary[] | undefined;
773
824
  /**
825
+ * @public
774
826
  * <p>The <code>nextToken</code> value to include in a future <code>GetFindingsReportAccountSummary</code> request.
775
827
  * When the results of a <code>GetFindingsReportAccountSummary</code> request exceed <code>maxResults</code>, this
776
828
  * value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more
@@ -783,6 +835,7 @@ export interface GetFindingsReportAccountSummaryResponse {
783
835
  */
784
836
  export interface ListTagsForResourceRequest {
785
837
  /**
838
+ * @public
786
839
  * <p>
787
840
  * The Amazon Resource Name (ARN) of the resource that contains the tags to return.
788
841
  * </p>
@@ -794,6 +847,7 @@ export interface ListTagsForResourceRequest {
794
847
  */
795
848
  export interface ListTagsForResourceResponse {
796
849
  /**
850
+ * @public
797
851
  * <p>
798
852
  * The list of tags assigned to the specified resource. This is the list of tags
799
853
  * returned in the response.
@@ -853,18 +907,21 @@ export type MetadataField = (typeof MetadataField)[keyof typeof MetadataField];
853
907
  */
854
908
  export interface ConfigureAgentRequest {
855
909
  /**
910
+ * @public
856
911
  * <p>
857
912
  * The name of the profiling group for which the configured agent is collecting profiling data.
858
913
  * </p>
859
914
  */
860
915
  profilingGroupName: string | undefined;
861
916
  /**
917
+ * @public
862
918
  * <p> A universally unique identifier (UUID) for a profiling instance. For example, if the
863
919
  * profiling instance is an Amazon EC2 instance, it is the instance ID. If it is an AWS
864
920
  * Fargate container, it is the container's task ID. </p>
865
921
  */
866
922
  fleetInstanceId?: string;
867
923
  /**
924
+ * @public
868
925
  * <p> Metadata captured about the compute platform the agent is running on. It includes
869
926
  * information about sampling and reporting. The valid fields are:</p>
870
927
  * <ul>
@@ -923,6 +980,7 @@ export interface ConfigureAgentRequest {
923
980
  */
924
981
  export interface ConfigureAgentResponse {
925
982
  /**
983
+ * @public
926
984
  * <p>
927
985
  * An <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AgentConfiguration.html">
928
986
  * <code>AgentConfiguration</code>
@@ -956,10 +1014,12 @@ export type ComputePlatform = (typeof ComputePlatform)[keyof typeof ComputePlatf
956
1014
  */
957
1015
  export interface CreateProfilingGroupRequest {
958
1016
  /**
1017
+ * @public
959
1018
  * <p>The name of the profiling group to create.</p>
960
1019
  */
961
1020
  profilingGroupName: string | undefined;
962
1021
  /**
1022
+ * @public
963
1023
  * <p>
964
1024
  * The compute platform of the profiling group. Use <code>AWSLambda</code> if your application
965
1025
  * runs on AWS Lambda. Use <code>Default</code> if your application runs on a compute platform that
@@ -969,17 +1029,20 @@ export interface CreateProfilingGroupRequest {
969
1029
  */
970
1030
  computePlatform?: ComputePlatform | string;
971
1031
  /**
1032
+ * @public
972
1033
  * <p> Amazon CodeGuru Profiler uses this universally unique identifier (UUID) to prevent the
973
1034
  * accidental creation of duplicate profiling groups if there are failures and retries. </p>
974
1035
  */
975
1036
  clientToken?: string;
976
1037
  /**
1038
+ * @public
977
1039
  * <p>
978
1040
  * Specifies whether profiling is enabled or disabled for the created profiling group.
979
1041
  * </p>
980
1042
  */
981
1043
  agentOrchestrationConfig?: AgentOrchestrationConfig;
982
1044
  /**
1045
+ * @public
983
1046
  * <p>
984
1047
  * A list of tags to add to the created profiling group.
985
1048
  * </p>
@@ -996,12 +1059,14 @@ export interface CreateProfilingGroupRequest {
996
1059
  */
997
1060
  export interface ProfilingStatus {
998
1061
  /**
1062
+ * @public
999
1063
  * <p>The date and time when the most recent profile was received. Specify using
1000
1064
  * the ISO 8601 format. For example,
1001
1065
  * 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.</p>
1002
1066
  */
1003
1067
  latestAgentProfileReportedAt?: Date;
1004
1068
  /**
1069
+ * @public
1005
1070
  * <p>
1006
1071
  * An <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AggregatedProfileTime.html">
1007
1072
  * <code>AggregatedProfileTime</code>
@@ -1011,6 +1076,7 @@ export interface ProfilingStatus {
1011
1076
  */
1012
1077
  latestAggregatedProfile?: AggregatedProfileTime;
1013
1078
  /**
1079
+ * @public
1014
1080
  * <p>The date and time when the profiling agent most recently pinged back. Specify using
1015
1081
  * the ISO 8601 format. For example,
1016
1082
  * 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.</p>
@@ -1025,10 +1091,12 @@ export interface ProfilingStatus {
1025
1091
  */
1026
1092
  export interface ProfilingGroupDescription {
1027
1093
  /**
1094
+ * @public
1028
1095
  * <p>The name of the profiling group.</p>
1029
1096
  */
1030
1097
  name?: string;
1031
1098
  /**
1099
+ * @public
1032
1100
  * <p>
1033
1101
  * An <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AgentOrchestrationConfig.html">
1034
1102
  * <code>AgentOrchestrationConfig</code>
@@ -1038,10 +1106,12 @@ export interface ProfilingGroupDescription {
1038
1106
  */
1039
1107
  agentOrchestrationConfig?: AgentOrchestrationConfig;
1040
1108
  /**
1109
+ * @public
1041
1110
  * <p>The Amazon Resource Name (ARN) identifying the profiling group resource.</p>
1042
1111
  */
1043
1112
  arn?: string;
1044
1113
  /**
1114
+ * @public
1045
1115
  * <p>The time when the profiling group was created. Specify using
1046
1116
  * the ISO 8601 format. For example,
1047
1117
  * 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
@@ -1049,6 +1119,7 @@ export interface ProfilingGroupDescription {
1049
1119
  */
1050
1120
  createdAt?: Date;
1051
1121
  /**
1122
+ * @public
1052
1123
  * <p>
1053
1124
  * The date and time when the profiling group was last updated. Specify using
1054
1125
  * the ISO 8601 format. For example,
@@ -1057,6 +1128,7 @@ export interface ProfilingGroupDescription {
1057
1128
  */
1058
1129
  updatedAt?: Date;
1059
1130
  /**
1131
+ * @public
1060
1132
  * <p>
1061
1133
  * A <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingStatus.html">
1062
1134
  * <code>ProfilingStatus</code>
@@ -1068,6 +1140,7 @@ export interface ProfilingGroupDescription {
1068
1140
  */
1069
1141
  profilingStatus?: ProfilingStatus;
1070
1142
  /**
1143
+ * @public
1071
1144
  * <p>
1072
1145
  * The compute platform of the profiling group. If it is set to <code>AWSLambda</code>, then
1073
1146
  * the profiled application runs on AWS Lambda. If it is set to <code>Default</code>, then the
@@ -1077,6 +1150,7 @@ export interface ProfilingGroupDescription {
1077
1150
  */
1078
1151
  computePlatform?: ComputePlatform | string;
1079
1152
  /**
1153
+ * @public
1080
1154
  * <p>
1081
1155
  * A list of the tags that belong to this profiling group.
1082
1156
  * </p>
@@ -1089,6 +1163,7 @@ export interface ProfilingGroupDescription {
1089
1163
  */
1090
1164
  export interface CreateProfilingGroupResponse {
1091
1165
  /**
1166
+ * @public
1092
1167
  * <p> The returned <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html">
1093
1168
  * <code>ProfilingGroupDescription</code>
1094
1169
  * </a> object that contains information
@@ -1102,6 +1177,7 @@ export interface CreateProfilingGroupResponse {
1102
1177
  */
1103
1178
  export interface DeleteProfilingGroupRequest {
1104
1179
  /**
1180
+ * @public
1105
1181
  * <p>The name of the profiling group to delete.</p>
1106
1182
  */
1107
1183
  profilingGroupName: string | undefined;
@@ -1118,6 +1194,7 @@ export interface DeleteProfilingGroupResponse {
1118
1194
  */
1119
1195
  export interface DescribeProfilingGroupRequest {
1120
1196
  /**
1197
+ * @public
1121
1198
  * <p>
1122
1199
  * The name of the profiling group to get information about.
1123
1200
  * </p>
@@ -1130,6 +1207,7 @@ export interface DescribeProfilingGroupRequest {
1130
1207
  */
1131
1208
  export interface DescribeProfilingGroupResponse {
1132
1209
  /**
1210
+ * @public
1133
1211
  * <p>
1134
1212
  * The returned <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html">
1135
1213
  * <code>ProfilingGroupDescription</code>
@@ -1145,6 +1223,7 @@ export interface DescribeProfilingGroupResponse {
1145
1223
  */
1146
1224
  export interface GetNotificationConfigurationRequest {
1147
1225
  /**
1226
+ * @public
1148
1227
  * <p>The name of the profiling group we want to get the notification configuration for.</p>
1149
1228
  */
1150
1229
  profilingGroupName: string | undefined;
@@ -1155,6 +1234,7 @@ export interface GetNotificationConfigurationRequest {
1155
1234
  */
1156
1235
  export interface GetNotificationConfigurationResponse {
1157
1236
  /**
1237
+ * @public
1158
1238
  * <p>The current notification configuration for this profiling group.</p>
1159
1239
  */
1160
1240
  notificationConfiguration: NotificationConfiguration | undefined;
@@ -1167,6 +1247,7 @@ export interface GetNotificationConfigurationResponse {
1167
1247
  */
1168
1248
  export interface GetPolicyRequest {
1169
1249
  /**
1250
+ * @public
1170
1251
  * <p>The name of the profiling group.</p>
1171
1252
  */
1172
1253
  profilingGroupName: string | undefined;
@@ -1177,10 +1258,12 @@ export interface GetPolicyRequest {
1177
1258
  */
1178
1259
  export interface GetPolicyResponse {
1179
1260
  /**
1261
+ * @public
1180
1262
  * <p>The JSON-formatted resource-based policy attached to the <code>ProfilingGroup</code>.</p>
1181
1263
  */
1182
1264
  policy: string | undefined;
1183
1265
  /**
1266
+ * @public
1184
1267
  * <p>A unique identifier for the current revision of the returned policy.</p>
1185
1268
  */
1186
1269
  revisionId: string | undefined;
@@ -1191,10 +1274,12 @@ export interface GetPolicyResponse {
1191
1274
  */
1192
1275
  export interface GetProfileRequest {
1193
1276
  /**
1277
+ * @public
1194
1278
  * <p>The name of the profiling group to get.</p>
1195
1279
  */
1196
1280
  profilingGroupName: string | undefined;
1197
1281
  /**
1282
+ * @public
1198
1283
  * <p>The start time of the profile to get. Specify using
1199
1284
  * the ISO 8601 format. For example,
1200
1285
  * 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.</p>
@@ -1206,6 +1291,7 @@ export interface GetProfileRequest {
1206
1291
  */
1207
1292
  startTime?: Date;
1208
1293
  /**
1294
+ * @public
1209
1295
  * <p>
1210
1296
  * Used with <code>startTime</code> or <code>endTime</code> to specify
1211
1297
  * the time range for the returned aggregated profile. Specify using
@@ -1218,6 +1304,7 @@ export interface GetProfileRequest {
1218
1304
  */
1219
1305
  period?: string;
1220
1306
  /**
1307
+ * @public
1221
1308
  * <p>
1222
1309
  * The end time of the requested profile. Specify using
1223
1310
  * the ISO 8601 format. For example,
@@ -1230,6 +1317,7 @@ export interface GetProfileRequest {
1230
1317
  */
1231
1318
  endTime?: Date;
1232
1319
  /**
1320
+ * @public
1233
1321
  * <p>
1234
1322
  * The maximum depth of the stacks in the code that is represented in
1235
1323
  * the aggregated profile. For example, if CodeGuru Profiler finds a method <code>A</code>,
@@ -1241,6 +1329,7 @@ export interface GetProfileRequest {
1241
1329
  */
1242
1330
  maxDepth?: number;
1243
1331
  /**
1332
+ * @public
1244
1333
  * <p>
1245
1334
  * The format of the returned profiling data. The format maps to the
1246
1335
  * <code>Accept</code> and <code>Content-Type</code> headers of the
@@ -1270,16 +1359,19 @@ export interface GetProfileRequest {
1270
1359
  */
1271
1360
  export interface GetProfileResponse {
1272
1361
  /**
1362
+ * @public
1273
1363
  * <p>Information about the profile.</p>
1274
1364
  */
1275
1365
  profile: Uint8Array | undefined;
1276
1366
  /**
1367
+ * @public
1277
1368
  * <p>The content type of the profile in the payload. It is
1278
1369
  * either <code>application/json</code> or the default
1279
1370
  * <code>application/x-amzn-ion</code>.</p>
1280
1371
  */
1281
1372
  contentType: string | undefined;
1282
1373
  /**
1374
+ * @public
1283
1375
  * <p>The content encoding of the profile.</p>
1284
1376
  */
1285
1377
  contentEncoding?: string;
@@ -1290,12 +1382,14 @@ export interface GetProfileResponse {
1290
1382
  */
1291
1383
  export interface GetRecommendationsRequest {
1292
1384
  /**
1385
+ * @public
1293
1386
  * <p>
1294
1387
  * The name of the profiling group to get analysis data about.
1295
1388
  * </p>
1296
1389
  */
1297
1390
  profilingGroupName: string | undefined;
1298
1391
  /**
1392
+ * @public
1299
1393
  * <p>
1300
1394
  * The end time of the profile to get analysis data about. You must specify <code>startTime</code> and <code>endTime</code>.
1301
1395
  * This is specified
@@ -1305,6 +1399,7 @@ export interface GetRecommendationsRequest {
1305
1399
  */
1306
1400
  startTime: Date | undefined;
1307
1401
  /**
1402
+ * @public
1308
1403
  * <p>
1309
1404
  * The start time of the profile to get analysis data about. You must specify <code>startTime</code> and <code>endTime</code>.
1310
1405
  * This is specified
@@ -1314,6 +1409,7 @@ export interface GetRecommendationsRequest {
1314
1409
  */
1315
1410
  endTime: Date | undefined;
1316
1411
  /**
1412
+ * @public
1317
1413
  * <p>
1318
1414
  * The language used to provide analysis. Specify using a string that is one
1319
1415
  * of the following <code>BCP 47</code> language codes.
@@ -1386,30 +1482,36 @@ export interface GetRecommendationsRequest {
1386
1482
  */
1387
1483
  export interface Pattern {
1388
1484
  /**
1485
+ * @public
1389
1486
  * <p>The universally unique identifier (UUID) of this pattern.</p>
1390
1487
  */
1391
1488
  id?: string;
1392
1489
  /**
1490
+ * @public
1393
1491
  * <p>The name for this pattern.</p>
1394
1492
  */
1395
1493
  name?: string;
1396
1494
  /**
1495
+ * @public
1397
1496
  * <p>The description of the recommendation. This explains a potential
1398
1497
  * inefficiency in a profiled application.</p>
1399
1498
  */
1400
1499
  description?: string;
1401
1500
  /**
1501
+ * @public
1402
1502
  * <p>
1403
1503
  * A string that contains the steps recommended to address the potential inefficiency.
1404
1504
  * </p>
1405
1505
  */
1406
1506
  resolutionSteps?: string;
1407
1507
  /**
1508
+ * @public
1408
1509
  * <p>A list of frame names that were searched during the analysis that generated
1409
1510
  * a recommendation.</p>
1410
1511
  */
1411
1512
  targetFrames?: string[][];
1412
1513
  /**
1514
+ * @public
1413
1515
  * <p>
1414
1516
  * The percentage of time an application spends in one method that triggers
1415
1517
  * a recommendation. The percentage of time is the same as the percentage of
@@ -1418,6 +1520,7 @@ export interface Pattern {
1418
1520
  */
1419
1521
  thresholdPercent?: number;
1420
1522
  /**
1523
+ * @public
1421
1524
  * <p>
1422
1525
  * A list of the different counters used to determine if there is a match.
1423
1526
  * </p>
@@ -1430,14 +1533,17 @@ export interface Pattern {
1430
1533
  */
1431
1534
  export interface Match {
1432
1535
  /**
1536
+ * @public
1433
1537
  * <p>The target frame that triggered a match.</p>
1434
1538
  */
1435
1539
  targetFramesIndex?: number;
1436
1540
  /**
1541
+ * @public
1437
1542
  * <p>The location in the profiling graph that contains a recommendation found during analysis.</p>
1438
1543
  */
1439
1544
  frameAddress?: string;
1440
1545
  /**
1546
+ * @public
1441
1547
  * <p>The value in the profile data that exceeded the recommendation threshold.</p>
1442
1548
  */
1443
1549
  thresholdBreachValue?: number;
@@ -1448,22 +1554,27 @@ export interface Match {
1448
1554
  */
1449
1555
  export interface Recommendation {
1450
1556
  /**
1557
+ * @public
1451
1558
  * <p>How many different places in the profile graph triggered a match.</p>
1452
1559
  */
1453
1560
  allMatchesCount: number | undefined;
1454
1561
  /**
1562
+ * @public
1455
1563
  * <p>How much of the total sample count is potentially affected.</p>
1456
1564
  */
1457
1565
  allMatchesSum: number | undefined;
1458
1566
  /**
1567
+ * @public
1459
1568
  * <p>The pattern that analysis recognized in the profile to make this recommendation.</p>
1460
1569
  */
1461
1570
  pattern: Pattern | undefined;
1462
1571
  /**
1572
+ * @public
1463
1573
  * <p>List of the matches with most impact. </p>
1464
1574
  */
1465
1575
  topMatches: Match[] | undefined;
1466
1576
  /**
1577
+ * @public
1467
1578
  * <p>The start time of the profile that was used by this analysis.
1468
1579
  * This is specified
1469
1580
  * using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1
@@ -1471,6 +1582,7 @@ export interface Recommendation {
1471
1582
  */
1472
1583
  startTime: Date | undefined;
1473
1584
  /**
1585
+ * @public
1474
1586
  * <p>End time of the profile that was used by this analysis.
1475
1587
  * This is specified
1476
1588
  * using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1
@@ -1484,10 +1596,12 @@ export interface Recommendation {
1484
1596
  */
1485
1597
  export interface GetRecommendationsResponse {
1486
1598
  /**
1599
+ * @public
1487
1600
  * <p>The name of the profiling group the analysis data is about.</p>
1488
1601
  */
1489
1602
  profilingGroupName: string | undefined;
1490
1603
  /**
1604
+ * @public
1491
1605
  * <p>
1492
1606
  * The start time of the profile the analysis data is about. This is specified
1493
1607
  * using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1
@@ -1496,6 +1610,7 @@ export interface GetRecommendationsResponse {
1496
1610
  */
1497
1611
  profileStartTime: Date | undefined;
1498
1612
  /**
1613
+ * @public
1499
1614
  * <p>
1500
1615
  * The end time of the profile the analysis data is about. This is specified
1501
1616
  * using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1
@@ -1504,10 +1619,12 @@ export interface GetRecommendationsResponse {
1504
1619
  */
1505
1620
  profileEndTime: Date | undefined;
1506
1621
  /**
1622
+ * @public
1507
1623
  * <p>The list of recommendations that the analysis found for this profile.</p>
1508
1624
  */
1509
1625
  recommendations: Recommendation[] | undefined;
1510
1626
  /**
1627
+ * @public
1511
1628
  * <p>
1512
1629
  * The list of anomalies that the analysis has found for this profile.
1513
1630
  * </p>
@@ -1520,10 +1637,12 @@ export interface GetRecommendationsResponse {
1520
1637
  */
1521
1638
  export interface ListFindingsReportsRequest {
1522
1639
  /**
1640
+ * @public
1523
1641
  * <p>The name of the profiling group from which to search for analysis data.</p>
1524
1642
  */
1525
1643
  profilingGroupName: string | undefined;
1526
1644
  /**
1645
+ * @public
1527
1646
  * <p>
1528
1647
  * The start time of the profile to get analysis data about. You must specify <code>startTime</code> and <code>endTime</code>.
1529
1648
  * This is specified
@@ -1533,6 +1652,7 @@ export interface ListFindingsReportsRequest {
1533
1652
  */
1534
1653
  startTime: Date | undefined;
1535
1654
  /**
1655
+ * @public
1536
1656
  * <p>
1537
1657
  * The end time of the profile to get analysis data about. You must specify <code>startTime</code> and <code>endTime</code>.
1538
1658
  * This is specified
@@ -1542,6 +1662,7 @@ export interface ListFindingsReportsRequest {
1542
1662
  */
1543
1663
  endTime: Date | undefined;
1544
1664
  /**
1665
+ * @public
1545
1666
  * <p>The <code>nextToken</code> value returned from a previous paginated <code>ListFindingsReportsRequest</code>
1546
1667
  * request where <code>maxResults</code> was used and the results exceeded the value of that parameter.
1547
1668
  * Pagination continues from the end of the previous results that returned the <code>nextToken</code> value.
@@ -1553,6 +1674,7 @@ export interface ListFindingsReportsRequest {
1553
1674
  */
1554
1675
  nextToken?: string;
1555
1676
  /**
1677
+ * @public
1556
1678
  * <p>The maximum number of report results returned by <code>ListFindingsReports</code>
1557
1679
  * in paginated output. When this parameter is used, <code>ListFindingsReports</code> only returns
1558
1680
  * <code>maxResults</code> results in a single page along with a <code>nextToken</code> response
@@ -1562,6 +1684,7 @@ export interface ListFindingsReportsRequest {
1562
1684
  */
1563
1685
  maxResults?: number;
1564
1686
  /**
1687
+ * @public
1565
1688
  * <p>A <code>Boolean</code> value indicating whether to only return reports from daily profiles. If set
1566
1689
  * to <code>True</code>, only analysis data from daily profiles is returned. If set to <code>False</code>,
1567
1690
  * analysis data is returned from smaller time windows (for example, one hour).</p>
@@ -1574,10 +1697,12 @@ export interface ListFindingsReportsRequest {
1574
1697
  */
1575
1698
  export interface ListFindingsReportsResponse {
1576
1699
  /**
1700
+ * @public
1577
1701
  * <p>The list of analysis results summaries.</p>
1578
1702
  */
1579
1703
  findingsReportSummaries: FindingsReportSummary[] | undefined;
1580
1704
  /**
1705
+ * @public
1581
1706
  * <p>The <code>nextToken</code> value to include in a future <code>ListFindingsReports</code> request.
1582
1707
  * When the results of a <code>ListFindingsReports</code> request exceed <code>maxResults</code>, this
1583
1708
  * value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more
@@ -1609,18 +1734,22 @@ export type OrderBy = (typeof OrderBy)[keyof typeof OrderBy];
1609
1734
  */
1610
1735
  export interface ListProfileTimesRequest {
1611
1736
  /**
1737
+ * @public
1612
1738
  * <p>The name of the profiling group.</p>
1613
1739
  */
1614
1740
  profilingGroupName: string | undefined;
1615
1741
  /**
1742
+ * @public
1616
1743
  * <p>The start time of the time range from which to list the profiles.</p>
1617
1744
  */
1618
1745
  startTime: Date | undefined;
1619
1746
  /**
1747
+ * @public
1620
1748
  * <p>The end time of the time range from which to list the profiles.</p>
1621
1749
  */
1622
1750
  endTime: Date | undefined;
1623
1751
  /**
1752
+ * @public
1624
1753
  * <p>
1625
1754
  * The aggregation period. This specifies the period during which an aggregation profile
1626
1755
  * collects posted agent profiles for a profiling group. There are 3 valid values.
@@ -1645,12 +1774,14 @@ export interface ListProfileTimesRequest {
1645
1774
  */
1646
1775
  period: AggregationPeriod | string | undefined;
1647
1776
  /**
1777
+ * @public
1648
1778
  * <p>The order (ascending or descending by start time of the profile) to
1649
1779
  * use when listing profiles. Defaults to <code>TIMESTAMP_DESCENDING</code>.
1650
1780
  * </p>
1651
1781
  */
1652
1782
  orderBy?: OrderBy | string;
1653
1783
  /**
1784
+ * @public
1654
1785
  * <p>The maximum number of profile time results returned by <code>ListProfileTimes</code>
1655
1786
  * in paginated output. When this parameter is used, <code>ListProfileTimes</code> only returns
1656
1787
  * <code>maxResults</code> results in a single page with a <code>nextToken</code> response
@@ -1661,6 +1792,7 @@ export interface ListProfileTimesRequest {
1661
1792
  */
1662
1793
  maxResults?: number;
1663
1794
  /**
1795
+ * @public
1664
1796
  * <p>The <code>nextToken</code> value returned from a previous paginated
1665
1797
  * <code>ListProfileTimes</code> request where <code>maxResults</code> was used and the results
1666
1798
  * exceeded the value of that parameter. Pagination continues from the end of the previous results
@@ -1681,6 +1813,7 @@ export interface ListProfileTimesRequest {
1681
1813
  */
1682
1814
  export interface ProfileTime {
1683
1815
  /**
1816
+ * @public
1684
1817
  * <p>The start time of a profile. It is specified using
1685
1818
  * the ISO 8601 format. For example,
1686
1819
  * 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.</p>
@@ -1693,12 +1826,14 @@ export interface ProfileTime {
1693
1826
  */
1694
1827
  export interface ListProfileTimesResponse {
1695
1828
  /**
1829
+ * @public
1696
1830
  * <p>The list of start times of the available profiles for the aggregation
1697
1831
  * period in the specified time range.
1698
1832
  * </p>
1699
1833
  */
1700
1834
  profileTimes: ProfileTime[] | undefined;
1701
1835
  /**
1836
+ * @public
1702
1837
  * <p>The <code>nextToken</code> value to include in a future <code>ListProfileTimes</code> request.
1703
1838
  * When the results of a <code>ListProfileTimes</code> request exceed <code>maxResults</code>, this
1704
1839
  * value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more
@@ -1712,6 +1847,7 @@ export interface ListProfileTimesResponse {
1712
1847
  */
1713
1848
  export interface ListProfilingGroupsRequest {
1714
1849
  /**
1850
+ * @public
1715
1851
  * <p>The <code>nextToken</code> value returned from a previous paginated
1716
1852
  * <code>ListProfilingGroups</code> request where <code>maxResults</code> was used and the results
1717
1853
  * exceeded the value of that parameter. Pagination continues from the end of the previous results
@@ -1724,6 +1860,7 @@ export interface ListProfilingGroupsRequest {
1724
1860
  */
1725
1861
  nextToken?: string;
1726
1862
  /**
1863
+ * @public
1727
1864
  * <p>The maximum number of profiling groups results returned by <code>ListProfilingGroups</code>
1728
1865
  * in paginated output. When this parameter is used, <code>ListProfilingGroups</code> only returns
1729
1866
  * <code>maxResults</code> results in a single page along with a <code>nextToken</code> response
@@ -1734,6 +1871,7 @@ export interface ListProfilingGroupsRequest {
1734
1871
  */
1735
1872
  maxResults?: number;
1736
1873
  /**
1874
+ * @public
1737
1875
  * <p>A <code>Boolean</code> value indicating whether to include a description. If <code>true</code>,
1738
1876
  * then a list of
1739
1877
  * <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html">
@@ -1750,6 +1888,7 @@ export interface ListProfilingGroupsRequest {
1750
1888
  */
1751
1889
  export interface ListProfilingGroupsResponse {
1752
1890
  /**
1891
+ * @public
1753
1892
  * <p>
1754
1893
  * A returned list of profiling group names. A list of the names is returned only if
1755
1894
  * <code>includeDescription</code> is <code>false</code>, otherwise a list of
@@ -1761,6 +1900,7 @@ export interface ListProfilingGroupsResponse {
1761
1900
  */
1762
1901
  profilingGroupNames: string[] | undefined;
1763
1902
  /**
1903
+ * @public
1764
1904
  * <p>
1765
1905
  * A returned list
1766
1906
  * <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html">
@@ -1775,6 +1915,7 @@ export interface ListProfilingGroupsResponse {
1775
1915
  */
1776
1916
  profilingGroups?: ProfilingGroupDescription[];
1777
1917
  /**
1918
+ * @public
1778
1919
  * <p>The <code>nextToken</code> value to include in a future <code>ListProfilingGroups</code> request.
1779
1920
  * When the results of a <code>ListProfilingGroups</code> request exceed <code>maxResults</code>, this
1780
1921
  * value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more
@@ -1788,6 +1929,7 @@ export interface ListProfilingGroupsResponse {
1788
1929
  */
1789
1930
  export interface PostAgentProfileRequest {
1790
1931
  /**
1932
+ * @public
1791
1933
  * <p>
1792
1934
  * The name of the profiling group with the aggregated profile that receives the
1793
1935
  * submitted profiling data.
@@ -1795,17 +1937,20 @@ export interface PostAgentProfileRequest {
1795
1937
  */
1796
1938
  profilingGroupName: string | undefined;
1797
1939
  /**
1940
+ * @public
1798
1941
  * <p>
1799
1942
  * The submitted profiling data.
1800
1943
  * </p>
1801
1944
  */
1802
1945
  agentProfile: Uint8Array | undefined;
1803
1946
  /**
1947
+ * @public
1804
1948
  * <p> Amazon CodeGuru Profiler uses this universally unique identifier (UUID) to prevent the
1805
1949
  * accidental submission of duplicate profiling data if there are failures and retries. </p>
1806
1950
  */
1807
1951
  profileToken?: string;
1808
1952
  /**
1953
+ * @public
1809
1954
  * <p>
1810
1955
  * The format of the submitted profiling data. The format maps to the
1811
1956
  * <code>Accept</code> and <code>Content-Type</code> headers of the
@@ -1841,10 +1986,12 @@ export interface PostAgentProfileResponse {
1841
1986
  */
1842
1987
  export interface PutPermissionRequest {
1843
1988
  /**
1989
+ * @public
1844
1990
  * <p>The name of the profiling group to grant access to.</p>
1845
1991
  */
1846
1992
  profilingGroupName: string | undefined;
1847
1993
  /**
1994
+ * @public
1848
1995
  * <p>
1849
1996
  * Specifies an action group that contains permissions to add to
1850
1997
  * a profiling group resource. One action group is supported, <code>agentPermissions</code>, which
@@ -1854,6 +2001,7 @@ export interface PutPermissionRequest {
1854
2001
  */
1855
2002
  actionGroup: ActionGroup | string | undefined;
1856
2003
  /**
2004
+ * @public
1857
2005
  * <p>
1858
2006
  * A list ARNs for the roles and users you want to grant access to the profiling group.
1859
2007
  * Wildcards are not are supported in the ARNs.
@@ -1861,6 +2009,7 @@ export interface PutPermissionRequest {
1861
2009
  */
1862
2010
  principals: string[] | undefined;
1863
2011
  /**
2012
+ * @public
1864
2013
  * <p>
1865
2014
  * A universally unique identifier (UUID) for the revision of the policy you
1866
2015
  * are adding to the profiling group. Do not specify
@@ -1876,6 +2025,7 @@ export interface PutPermissionRequest {
1876
2025
  */
1877
2026
  export interface PutPermissionResponse {
1878
2027
  /**
2028
+ * @public
1879
2029
  * <p>
1880
2030
  * The JSON-formatted resource-based policy on the profiling group that includes the
1881
2031
  * added permissions.
@@ -1883,6 +2033,7 @@ export interface PutPermissionResponse {
1883
2033
  */
1884
2034
  policy: string | undefined;
1885
2035
  /**
2036
+ * @public
1886
2037
  * <p> A universally unique identifier (UUID) for the revision of the resource-based policy
1887
2038
  * that includes the added permissions. The JSON-formatted policy is in the
1888
2039
  * <code>policy</code> element of the response. </p>
@@ -1895,10 +2046,12 @@ export interface PutPermissionResponse {
1895
2046
  */
1896
2047
  export interface RemoveNotificationChannelRequest {
1897
2048
  /**
2049
+ * @public
1898
2050
  * <p>The name of the profiling group we want to change notification configuration for.</p>
1899
2051
  */
1900
2052
  profilingGroupName: string | undefined;
1901
2053
  /**
2054
+ * @public
1902
2055
  * <p>The id of the channel that we want to stop receiving notifications.</p>
1903
2056
  */
1904
2057
  channelId: string | undefined;
@@ -1909,6 +2062,7 @@ export interface RemoveNotificationChannelRequest {
1909
2062
  */
1910
2063
  export interface RemoveNotificationChannelResponse {
1911
2064
  /**
2065
+ * @public
1912
2066
  * <p>The new notification configuration for this profiling group.</p>
1913
2067
  */
1914
2068
  notificationConfiguration?: NotificationConfiguration;
@@ -1921,10 +2075,12 @@ export interface RemoveNotificationChannelResponse {
1921
2075
  */
1922
2076
  export interface RemovePermissionRequest {
1923
2077
  /**
2078
+ * @public
1924
2079
  * <p>The name of the profiling group.</p>
1925
2080
  */
1926
2081
  profilingGroupName: string | undefined;
1927
2082
  /**
2083
+ * @public
1928
2084
  * <p>
1929
2085
  * Specifies an action group that contains the permissions to remove from
1930
2086
  * a profiling group's resource-based policy. One action group is supported, <code>agentPermissions</code>, which
@@ -1933,6 +2089,7 @@ export interface RemovePermissionRequest {
1933
2089
  */
1934
2090
  actionGroup: ActionGroup | string | undefined;
1935
2091
  /**
2092
+ * @public
1936
2093
  * <p>
1937
2094
  * A universally unique identifier (UUID) for the revision of the resource-based policy from which
1938
2095
  * you want to remove permissions.
@@ -1946,6 +2103,7 @@ export interface RemovePermissionRequest {
1946
2103
  */
1947
2104
  export interface RemovePermissionResponse {
1948
2105
  /**
2106
+ * @public
1949
2107
  * <p>
1950
2108
  * The JSON-formatted resource-based policy on the profiling group after
1951
2109
  * the specified permissions were removed.
@@ -1953,6 +2111,7 @@ export interface RemovePermissionResponse {
1953
2111
  */
1954
2112
  policy: string | undefined;
1955
2113
  /**
2114
+ * @public
1956
2115
  * <p> A universally unique identifier (UUID) for the revision of the resource-based policy
1957
2116
  * after the specified permissions were removed. The updated JSON-formatted policy is in the
1958
2117
  * <code>policy</code> element of the response. </p>
@@ -1965,10 +2124,12 @@ export interface RemovePermissionResponse {
1965
2124
  */
1966
2125
  export interface SubmitFeedbackRequest {
1967
2126
  /**
2127
+ * @public
1968
2128
  * <p>The name of the profiling group that is associated with the analysis data.</p>
1969
2129
  */
1970
2130
  profilingGroupName: string | undefined;
1971
2131
  /**
2132
+ * @public
1972
2133
  * <p>The universally unique identifier (UUID) of the
1973
2134
  * <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AnomalyInstance.html">
1974
2135
  * <code>AnomalyInstance</code>
@@ -1977,12 +2138,14 @@ export interface SubmitFeedbackRequest {
1977
2138
  */
1978
2139
  anomalyInstanceId: string | undefined;
1979
2140
  /**
2141
+ * @public
1980
2142
  * <p>
1981
2143
  * The feedback tpye. Thee are two valid values, <code>Positive</code> and <code>Negative</code>.
1982
2144
  * </p>
1983
2145
  */
1984
2146
  type: FeedbackType | string | undefined;
1985
2147
  /**
2148
+ * @public
1986
2149
  * <p>Optional feedback about this anomaly.</p>
1987
2150
  */
1988
2151
  comment?: string;
@@ -1999,10 +2162,12 @@ export interface SubmitFeedbackResponse {
1999
2162
  */
2000
2163
  export interface UpdateProfilingGroupRequest {
2001
2164
  /**
2165
+ * @public
2002
2166
  * <p>The name of the profiling group to update.</p>
2003
2167
  */
2004
2168
  profilingGroupName: string | undefined;
2005
2169
  /**
2170
+ * @public
2006
2171
  * <p>
2007
2172
  * Specifies whether profiling is enabled or disabled for a profiling group.
2008
2173
  * </p>
@@ -2015,6 +2180,7 @@ export interface UpdateProfilingGroupRequest {
2015
2180
  */
2016
2181
  export interface UpdateProfilingGroupResponse {
2017
2182
  /**
2183
+ * @public
2018
2184
  * <p>
2019
2185
  * A <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html">
2020
2186
  * <code>ProfilingGroupDescription</code>
@@ -2029,12 +2195,14 @@ export interface UpdateProfilingGroupResponse {
2029
2195
  */
2030
2196
  export interface TagResourceRequest {
2031
2197
  /**
2198
+ * @public
2032
2199
  * <p>
2033
2200
  * The Amazon Resource Name (ARN) of the resource that the tags are added to.
2034
2201
  * </p>
2035
2202
  */
2036
2203
  resourceArn: string | undefined;
2037
2204
  /**
2205
+ * @public
2038
2206
  * <p>
2039
2207
  * The list of tags that are added to the specified resource.
2040
2208
  * </p>
@@ -2051,12 +2219,14 @@ export interface TagResourceResponse {
2051
2219
  */
2052
2220
  export interface UntagResourceRequest {
2053
2221
  /**
2222
+ * @public
2054
2223
  * <p>
2055
2224
  * The Amazon Resource Name (ARN) of the resource that contains the tags to remove.
2056
2225
  * </p>
2057
2226
  */
2058
2227
  resourceArn: string | undefined;
2059
2228
  /**
2229
+ * @public
2060
2230
  * <p>
2061
2231
  * A list of tag keys. Existing tags of resources with keys in this list are removed from
2062
2232
  * the specified resource.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-codeguruprofiler",
3
3
  "description": "AWS SDK for JavaScript Codeguruprofiler Client for Node.js, Browser and React Native",
4
- "version": "3.379.1",
4
+ "version": "3.385.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.379.1",
25
- "@aws-sdk/credential-provider-node": "3.379.1",
24
+ "@aws-sdk/client-sts": "3.385.0",
25
+ "@aws-sdk/credential-provider-node": "3.385.0",
26
26
  "@aws-sdk/middleware-host-header": "3.379.1",
27
27
  "@aws-sdk/middleware-logger": "3.378.0",
28
28
  "@aws-sdk/middleware-recursion-detection": "3.378.0",
29
29
  "@aws-sdk/middleware-signing": "3.379.1",
30
- "@aws-sdk/middleware-user-agent": "3.379.1",
30
+ "@aws-sdk/middleware-user-agent": "3.382.0",
31
31
  "@aws-sdk/types": "3.378.0",
32
- "@aws-sdk/util-endpoints": "3.378.0",
32
+ "@aws-sdk/util-endpoints": "3.382.0",
33
33
  "@aws-sdk/util-user-agent-browser": "3.378.0",
34
34
  "@aws-sdk/util-user-agent-node": "3.378.0",
35
35
  "@smithy/config-resolver": "^2.0.1",