@aws-sdk/client-codeguruprofiler 3.533.0 → 3.535.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.
Files changed (51) hide show
  1. package/dist-types/CodeGuruProfiler.d.ts +3 -1
  2. package/dist-types/CodeGuruProfilerClient.d.ts +1 -1
  3. package/dist-types/commands/AddNotificationChannelsCommand.d.ts +2 -1
  4. package/dist-types/commands/BatchGetFrameMetricDataCommand.d.ts +2 -1
  5. package/dist-types/commands/ConfigureAgentCommand.d.ts +2 -1
  6. package/dist-types/commands/CreateProfilingGroupCommand.d.ts +2 -1
  7. package/dist-types/commands/DeleteProfilingGroupCommand.d.ts +2 -1
  8. package/dist-types/commands/DescribeProfilingGroupCommand.d.ts +2 -1
  9. package/dist-types/commands/GetFindingsReportAccountSummaryCommand.d.ts +2 -1
  10. package/dist-types/commands/GetNotificationConfigurationCommand.d.ts +2 -1
  11. package/dist-types/commands/GetPolicyCommand.d.ts +2 -1
  12. package/dist-types/commands/GetProfileCommand.d.ts +2 -1
  13. package/dist-types/commands/GetRecommendationsCommand.d.ts +2 -1
  14. package/dist-types/commands/ListFindingsReportsCommand.d.ts +2 -1
  15. package/dist-types/commands/ListProfileTimesCommand.d.ts +2 -1
  16. package/dist-types/commands/ListProfilingGroupsCommand.d.ts +2 -1
  17. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
  18. package/dist-types/commands/PostAgentProfileCommand.d.ts +2 -1
  19. package/dist-types/commands/PutPermissionCommand.d.ts +2 -1
  20. package/dist-types/commands/RemoveNotificationChannelCommand.d.ts +2 -1
  21. package/dist-types/commands/RemovePermissionCommand.d.ts +2 -1
  22. package/dist-types/commands/SubmitFeedbackCommand.d.ts +2 -1
  23. package/dist-types/commands/TagResourceCommand.d.ts +2 -1
  24. package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
  25. package/dist-types/commands/UpdateProfilingGroupCommand.d.ts +2 -1
  26. package/dist-types/models/models_0.d.ts +235 -235
  27. package/dist-types/ts3.4/CodeGuruProfiler.d.ts +2 -0
  28. package/dist-types/ts3.4/commands/AddNotificationChannelsCommand.d.ts +9 -0
  29. package/dist-types/ts3.4/commands/BatchGetFrameMetricDataCommand.d.ts +9 -0
  30. package/dist-types/ts3.4/commands/ConfigureAgentCommand.d.ts +9 -0
  31. package/dist-types/ts3.4/commands/CreateProfilingGroupCommand.d.ts +9 -0
  32. package/dist-types/ts3.4/commands/DeleteProfilingGroupCommand.d.ts +9 -0
  33. package/dist-types/ts3.4/commands/DescribeProfilingGroupCommand.d.ts +9 -0
  34. package/dist-types/ts3.4/commands/GetFindingsReportAccountSummaryCommand.d.ts +9 -0
  35. package/dist-types/ts3.4/commands/GetNotificationConfigurationCommand.d.ts +9 -0
  36. package/dist-types/ts3.4/commands/GetPolicyCommand.d.ts +9 -0
  37. package/dist-types/ts3.4/commands/GetProfileCommand.d.ts +9 -0
  38. package/dist-types/ts3.4/commands/GetRecommendationsCommand.d.ts +9 -0
  39. package/dist-types/ts3.4/commands/ListFindingsReportsCommand.d.ts +9 -0
  40. package/dist-types/ts3.4/commands/ListProfileTimesCommand.d.ts +9 -0
  41. package/dist-types/ts3.4/commands/ListProfilingGroupsCommand.d.ts +9 -0
  42. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
  43. package/dist-types/ts3.4/commands/PostAgentProfileCommand.d.ts +9 -0
  44. package/dist-types/ts3.4/commands/PutPermissionCommand.d.ts +9 -0
  45. package/dist-types/ts3.4/commands/RemoveNotificationChannelCommand.d.ts +9 -0
  46. package/dist-types/ts3.4/commands/RemovePermissionCommand.d.ts +9 -0
  47. package/dist-types/ts3.4/commands/SubmitFeedbackCommand.d.ts +9 -0
  48. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
  49. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
  50. package/dist-types/ts3.4/commands/UpdateProfilingGroupCommand.d.ts +9 -0
  51. package/package.json +41 -41
@@ -29,72 +29,72 @@ export declare const EventPublisher: {
29
29
  */
30
30
  export type EventPublisher = (typeof EventPublisher)[keyof typeof EventPublisher];
31
31
  /**
32
- * @public
33
32
  * <p>Notification medium for users to get alerted for events that occur in application profile. We support SNS topic as a notification channel.</p>
33
+ * @public
34
34
  */
35
35
  export interface Channel {
36
36
  /**
37
- * @public
38
37
  * <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
+ * @public
39
39
  */
40
40
  id?: string;
41
41
  /**
42
- * @public
43
42
  * <p>Unique arn of the resource to be used for notifications. We support a valid SNS topic arn as a channel uri.</p>
43
+ * @public
44
44
  */
45
45
  uri: string | undefined;
46
46
  /**
47
- * @public
48
47
  * <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>
48
+ * @public
49
49
  */
50
50
  eventPublishers: EventPublisher[] | undefined;
51
51
  }
52
52
  /**
53
- * @public
54
53
  * <p>The structure representing the AddNotificationChannelsRequest.</p>
54
+ * @public
55
55
  */
56
56
  export interface AddNotificationChannelsRequest {
57
57
  /**
58
- * @public
59
58
  * <p>The name of the profiling group that we are setting up notifications for.</p>
59
+ * @public
60
60
  */
61
61
  profilingGroupName: string | undefined;
62
62
  /**
63
- * @public
64
63
  * <p>One or 2 channels to report to when anomalies are detected.</p>
64
+ * @public
65
65
  */
66
66
  channels: Channel[] | undefined;
67
67
  }
68
68
  /**
69
- * @public
70
69
  * <p>The configuration for notifications stored for each profiling group. This includes up to
71
70
  * to two channels and a list of event publishers associated with each channel.</p>
71
+ * @public
72
72
  */
73
73
  export interface NotificationConfiguration {
74
74
  /**
75
- * @public
76
75
  * <p>List of up to two channels to be used for sending notifications for events detected from
77
76
  * the application profile.</p>
77
+ * @public
78
78
  */
79
79
  channels?: Channel[];
80
80
  }
81
81
  /**
82
- * @public
83
82
  * <p>The structure representing the AddNotificationChannelsResponse.</p>
83
+ * @public
84
84
  */
85
85
  export interface AddNotificationChannelsResponse {
86
86
  /**
87
- * @public
88
87
  * <p>The new notification configuration for this profiling group.</p>
88
+ * @public
89
89
  */
90
90
  notificationConfiguration?: NotificationConfiguration;
91
91
  }
92
92
  /**
93
- * @public
94
93
  * <p>The requested operation would cause a conflict with the current state
95
94
  * of a service resource associated with the request. Resolve the conflict
96
95
  * before retrying this request.
97
96
  * </p>
97
+ * @public
98
98
  */
99
99
  export declare class ConflictException extends __BaseException {
100
100
  readonly name: "ConflictException";
@@ -105,8 +105,8 @@ export declare class ConflictException extends __BaseException {
105
105
  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
106
106
  }
107
107
  /**
108
- * @public
109
108
  * <p>The server encountered an internal error and is unable to complete the request.</p>
109
+ * @public
110
110
  */
111
111
  export declare class InternalServerException extends __BaseException {
112
112
  readonly name: "InternalServerException";
@@ -118,8 +118,8 @@ export declare class InternalServerException extends __BaseException {
118
118
  constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
119
119
  }
120
120
  /**
121
- * @public
122
121
  * <p>The resource specified in the request does not exist.</p>
122
+ * @public
123
123
  */
124
124
  export declare class ResourceNotFoundException extends __BaseException {
125
125
  readonly name: "ResourceNotFoundException";
@@ -130,11 +130,11 @@ export declare class ResourceNotFoundException extends __BaseException {
130
130
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
131
131
  }
132
132
  /**
133
- * @public
134
133
  * <p>You have exceeded your service quota. To perform the requested action,
135
134
  * remove some of the relevant resources, or use <a href="https://docs.aws.amazon.com/servicequotas/latest/userguide/intro.html">Service Quotas</a> to request a
136
135
  * service quota increase.
137
136
  * </p>
137
+ * @public
138
138
  */
139
139
  export declare class ServiceQuotaExceededException extends __BaseException {
140
140
  readonly name: "ServiceQuotaExceededException";
@@ -146,8 +146,8 @@ export declare class ServiceQuotaExceededException extends __BaseException {
146
146
  constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
147
147
  }
148
148
  /**
149
- * @public
150
149
  * <p>The request was denied due to request throttling.</p>
150
+ * @public
151
151
  */
152
152
  export declare class ThrottlingException extends __BaseException {
153
153
  readonly name: "ThrottlingException";
@@ -159,8 +159,8 @@ export declare class ThrottlingException extends __BaseException {
159
159
  constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
160
160
  }
161
161
  /**
162
- * @public
163
162
  * <p>The parameter is not valid.</p>
163
+ * @public
164
164
  */
165
165
  export declare class ValidationException extends __BaseException {
166
166
  readonly name: "ValidationException";
@@ -201,25 +201,24 @@ export declare const AgentParameterField: {
201
201
  */
202
202
  export type AgentParameterField = (typeof AgentParameterField)[keyof typeof AgentParameterField];
203
203
  /**
204
- * @public
205
204
  * <p>
206
205
  * The response of <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html">
207
206
  * <code>ConfigureAgent</code>
208
207
  * </a> that
209
208
  * specifies if an agent profiles or not and for how long to return profiling data.
210
209
  * </p>
210
+ * @public
211
211
  */
212
212
  export interface AgentConfiguration {
213
213
  /**
214
- * @public
215
214
  * <p>
216
215
  * A <code>Boolean</code> that specifies whether the profiling agent collects profiling data or not. Set to <code>true</code>
217
216
  * to enable profiling.
218
217
  * </p>
218
+ * @public
219
219
  */
220
220
  shouldProfile: boolean | undefined;
221
221
  /**
222
- * @public
223
222
  * <p>
224
223
  * How long a profiling agent should send profiling data using
225
224
  * <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html">
@@ -230,10 +229,10 @@ export interface AgentConfiguration {
230
229
  * </a>
231
230
  * every 5 minutes to submit the profiled data collected during that period.
232
231
  * </p>
232
+ * @public
233
233
  */
234
234
  periodInSeconds: number | undefined;
235
235
  /**
236
- * @public
237
236
  * <p>
238
237
  * Parameters used by the profiler. The valid parameters are:
239
238
  * </p>
@@ -271,11 +270,11 @@ export interface AgentConfiguration {
271
270
  * </p>
272
271
  * </li>
273
272
  * </ul>
273
+ * @public
274
274
  */
275
275
  agentParameters?: Partial<Record<AgentParameterField, string>>;
276
276
  }
277
277
  /**
278
- * @public
279
278
  * <p>
280
279
  * Specifies whether profiling is enabled or disabled for a profiling group. It
281
280
  * is used by <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html">
@@ -283,14 +282,15 @@ export interface AgentConfiguration {
283
282
  * </a>
284
283
  * to enable or disable profiling for a profiling group.
285
284
  * </p>
285
+ * @public
286
286
  */
287
287
  export interface AgentOrchestrationConfig {
288
288
  /**
289
- * @public
290
289
  * <p>
291
290
  * A <code>Boolean</code> that specifies whether the profiling agent collects profiling data or not. Set to <code>true</code>
292
291
  * to enable profiling.
293
292
  * </p>
293
+ * @public
294
294
  */
295
295
  profilingEnabled: boolean | undefined;
296
296
  }
@@ -317,17 +317,16 @@ export declare const AggregationPeriod: {
317
317
  */
318
318
  export type AggregationPeriod = (typeof AggregationPeriod)[keyof typeof AggregationPeriod];
319
319
  /**
320
- * @public
321
320
  * <p>
322
321
  * Specifies the aggregation period and aggregation start time for
323
322
  * an aggregated profile. An aggregated profile is used to collect posted agent profiles
324
323
  * during an aggregation period. There are three possible aggregation periods (1 day,
325
324
  * 1 hour, or 5 minutes).
326
325
  * </p>
326
+ * @public
327
327
  */
328
328
  export interface AggregatedProfileTime {
329
329
  /**
330
- * @public
331
330
  * <p>
332
331
  * The time that aggregation of posted agent profiles for a profiling group starts. The aggregation profile
333
332
  * contains profiles posted by the agent starting at this time for an aggregation period
@@ -338,10 +337,10 @@ export interface AggregatedProfileTime {
338
337
  * Specify <code>start</code> using the ISO 8601 format. For example,
339
338
  * 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
340
339
  * </p>
340
+ * @public
341
341
  */
342
342
  start?: Date;
343
343
  /**
344
- * @public
345
344
  * <p>
346
345
  * The aggregation period. This indicates the period during which an aggregation profile
347
346
  * collects posted agent profiles for a profiling group. Use one of three valid
@@ -364,6 +363,7 @@ export interface AggregatedProfileTime {
364
363
  * </p>
365
364
  * </li>
366
365
  * </ul>
366
+ * @public
367
367
  */
368
368
  period?: AggregationPeriod;
369
369
  }
@@ -386,53 +386,53 @@ export declare const FeedbackType: {
386
386
  */
387
387
  export type FeedbackType = (typeof FeedbackType)[keyof typeof FeedbackType];
388
388
  /**
389
- * @public
390
389
  * <p>Feedback that can be submitted for each instance of an anomaly by the user.
391
390
  * Feedback is be used for improvements in generating recommendations for the application.</p>
391
+ * @public
392
392
  */
393
393
  export interface UserFeedback {
394
394
  /**
395
- * @public
396
395
  * <p>Optional <code>Positive</code> or <code>Negative</code> feedback submitted by
397
396
  * the user about whether the recommendation is useful or not.</p>
397
+ * @public
398
398
  */
399
399
  type: FeedbackType | undefined;
400
400
  }
401
401
  /**
402
- * @public
403
402
  * <p>The specific duration in which the metric is flagged as anomalous.</p>
403
+ * @public
404
404
  */
405
405
  export interface AnomalyInstance {
406
406
  /**
407
- * @public
408
407
  * <p>
409
408
  * The universally unique identifier (UUID) of an instance of an anomaly in a metric.
410
409
  * </p>
410
+ * @public
411
411
  */
412
412
  id: string | undefined;
413
413
  /**
414
- * @public
415
414
  * <p>
416
415
  * The start time of the period during which the metric is flagged as anomalous.
417
416
  * This is specified
418
417
  * using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1
419
418
  * millisecond past June 1, 2020 1:15:02 PM UTC.
420
419
  * </p>
420
+ * @public
421
421
  */
422
422
  startTime: Date | undefined;
423
423
  /**
424
- * @public
425
424
  * <p>
426
425
  * The end time of the period during which the metric is flagged as anomalous.
427
426
  * This is specified
428
427
  * using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1
429
428
  * millisecond past June 1, 2020 1:15:02 PM UTC.
430
429
  * </p>
430
+ * @public
431
431
  */
432
432
  endTime?: Date;
433
433
  /**
434
- * @public
435
434
  * <p>Feedback type on a specific instance of anomaly submitted by the user.</p>
435
+ * @public
436
436
  */
437
437
  userFeedback?: UserFeedback;
438
438
  }
@@ -451,140 +451,139 @@ export declare const MetricType: {
451
451
  */
452
452
  export type MetricType = (typeof MetricType)[keyof typeof MetricType];
453
453
  /**
454
- * @public
455
454
  * <p>
456
455
  * Details about the metric that the analysis used when it detected the anomaly.
457
456
  * The metric what is analyzed to create recommendations. It includes the name of the
458
457
  * frame that was analyzed and the type and thread states used to derive the metric
459
458
  * value for that frame.
460
459
  * </p>
460
+ * @public
461
461
  */
462
462
  export interface Metric {
463
463
  /**
464
- * @public
465
464
  * <p>
466
465
  * The name of the method that appears as a frame in any stack in a profile.
467
466
  * </p>
467
+ * @public
468
468
  */
469
469
  frameName: string | undefined;
470
470
  /**
471
- * @public
472
471
  * <p>
473
472
  * A type that specifies how a metric for a frame is analyzed.
474
473
  * The supported value <code>AggregatedRelativeTotalTime</code> is an
475
474
  * aggregation of the metric value for one frame that is calculated across the
476
475
  * occurences of all frames in a profile.</p>
476
+ * @public
477
477
  */
478
478
  type: MetricType | undefined;
479
479
  /**
480
- * @public
481
480
  * <p>
482
481
  * The list of application runtime thread states that is used to calculate the
483
482
  * metric value for the frame.
484
483
  * </p>
484
+ * @public
485
485
  */
486
486
  threadStates: string[] | undefined;
487
487
  }
488
488
  /**
489
- * @public
490
489
  * <p>
491
490
  * Details about an anomaly in a specific metric of application profile. The anomaly is detected using
492
491
  * analysis of the metric data over a period of time.
493
492
  * </p>
493
+ * @public
494
494
  */
495
495
  export interface Anomaly {
496
496
  /**
497
- * @public
498
497
  * <p>
499
498
  * Details about the metric that the analysis used when it detected the anomaly.
500
499
  * The metric includes the name of the frame that was analyzed with the type and
501
500
  * thread states used to derive the metric value for that frame.
502
501
  * </p>
502
+ * @public
503
503
  */
504
504
  metric: Metric | undefined;
505
505
  /**
506
- * @public
507
506
  * <p>The reason for which metric was flagged as anomalous.</p>
507
+ * @public
508
508
  */
509
509
  reason: string | undefined;
510
510
  /**
511
- * @public
512
511
  * <p>
513
512
  * A list of the instances of the detected anomalies during the requested period.
514
513
  * </p>
514
+ * @public
515
515
  */
516
516
  instances: AnomalyInstance[] | undefined;
517
517
  }
518
518
  /**
519
- * @public
520
519
  * <p>
521
520
  * The frame name, metric type, and thread states. These are used
522
521
  * to derive the value of the metric for the frame.</p>
522
+ * @public
523
523
  */
524
524
  export interface FrameMetric {
525
525
  /**
526
- * @public
527
526
  * <p> Name of the method common across the multiple occurrences of a frame in an application
528
527
  * profile.</p>
528
+ * @public
529
529
  */
530
530
  frameName: string | undefined;
531
531
  /**
532
- * @public
533
532
  * <p> A type of aggregation that specifies how a metric for a frame is analyzed. The
534
533
  * supported value <code>AggregatedRelativeTotalTime</code> is an aggregation of the metric
535
534
  * value for one frame that is calculated across the occurrences of all frames in a profile. </p>
535
+ * @public
536
536
  */
537
537
  type: MetricType | undefined;
538
538
  /**
539
- * @public
540
539
  * <p>List of application runtime thread states used to get the counts for a frame a derive a metric value.</p>
540
+ * @public
541
541
  */
542
542
  threadStates: string[] | undefined;
543
543
  }
544
544
  /**
545
- * @public
546
545
  * <p>The structure representing the BatchGetFrameMetricDataRequest.</p>
546
+ * @public
547
547
  */
548
548
  export interface BatchGetFrameMetricDataRequest {
549
549
  /**
550
- * @public
551
550
  * <p>
552
551
  * The name of the profiling group associated with the
553
552
  * the frame metrics used to return the time series values.
554
553
  * </p>
554
+ * @public
555
555
  */
556
556
  profilingGroupName: string | undefined;
557
557
  /**
558
- * @public
559
558
  * <p>
560
559
  * The start time of the time period for the frame metrics used to return the time series values.
561
560
  * This is specified
562
561
  * using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1
563
562
  * millisecond past June 1, 2020 1:15:02 PM UTC.
564
563
  * </p>
564
+ * @public
565
565
  */
566
566
  startTime?: Date;
567
567
  /**
568
- * @public
569
568
  * <p>
570
569
  * The end time of the time period for the returned time series values.
571
570
  * This is specified
572
571
  * using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1
573
572
  * millisecond past June 1, 2020 1:15:02 PM UTC.
574
573
  * </p>
574
+ * @public
575
575
  */
576
576
  endTime?: Date;
577
577
  /**
578
- * @public
579
578
  * <p>
580
579
  * The duration of the frame metrics used to return the time series values.
581
580
  * Specify using the ISO 8601 format. The maximum period duration
582
581
  * is one day (<code>PT24H</code> or <code>P1D</code>).
583
582
  * </p>
583
+ * @public
584
584
  */
585
585
  period?: string;
586
586
  /**
587
- * @public
588
587
  * <p>The requested resolution of time steps for the returned time series of values.
589
588
  * If the requested target resolution is not available due to data not being retained we provide a best effort
590
589
  * result by falling back to the most granular available resolution after the target resolution.
@@ -607,85 +606,85 @@ export interface BatchGetFrameMetricDataRequest {
607
606
  * </p>
608
607
  * </li>
609
608
  * </ul>
609
+ * @public
610
610
  */
611
611
  targetResolution?: AggregationPeriod;
612
612
  /**
613
- * @public
614
613
  * <p>
615
614
  * The details of the metrics that are used to request a time series of values. The metric includes
616
615
  * the name of the frame, the aggregation type to calculate the metric value for the
617
616
  * frame, and the thread states to use to get the count for the metric value of the frame.</p>
617
+ * @public
618
618
  */
619
619
  frameMetrics?: FrameMetric[];
620
620
  }
621
621
  /**
622
- * @public
623
622
  * <p>
624
623
  * A data type that contains a <code>Timestamp</code> object. This is specified
625
624
  * using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1
626
625
  * millisecond past June 1, 2020 1:15:02 PM UTC.
627
626
  * </p>
627
+ * @public
628
628
  */
629
629
  export interface TimestampStructure {
630
630
  /**
631
- * @public
632
631
  * <p>
633
632
  * A <code>Timestamp</code>. This is specified
634
633
  * using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1
635
634
  * millisecond past June 1, 2020 1:15:02 PM UTC.
636
635
  * </p>
636
+ * @public
637
637
  */
638
638
  value: Date | undefined;
639
639
  }
640
640
  /**
641
- * @public
642
641
  * <p>
643
642
  * Information about a frame metric and its values.
644
643
  * </p>
644
+ * @public
645
645
  */
646
646
  export interface FrameMetricDatum {
647
647
  /**
648
- * @public
649
648
  * <p>
650
649
  * The frame name, metric type, and thread states. These are used
651
650
  * to derive the value of the metric for the frame.</p>
651
+ * @public
652
652
  */
653
653
  frameMetric: FrameMetric | undefined;
654
654
  /**
655
- * @public
656
655
  * <p>
657
656
  * A list of values that are associated with a frame metric.
658
657
  * </p>
658
+ * @public
659
659
  */
660
660
  values: number[] | undefined;
661
661
  }
662
662
  /**
663
- * @public
664
663
  * <p>The structure representing the BatchGetFrameMetricDataResponse.</p>
664
+ * @public
665
665
  */
666
666
  export interface BatchGetFrameMetricDataResponse {
667
667
  /**
668
- * @public
669
668
  * <p>
670
669
  * The start time of the time period for the returned time series values.
671
670
  * This is specified
672
671
  * using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1
673
672
  * millisecond past June 1, 2020 1:15:02 PM UTC.
674
673
  * </p>
674
+ * @public
675
675
  */
676
676
  startTime: Date | undefined;
677
677
  /**
678
- * @public
679
678
  * <p>
680
679
  * The end time of the time period for the returned time series values.
681
680
  * This is specified
682
681
  * using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1
683
682
  * millisecond past June 1, 2020 1:15:02 PM UTC.
684
683
  * </p>
684
+ * @public
685
685
  */
686
686
  endTime: Date | undefined;
687
687
  /**
688
- * @public
689
688
  * <p>Resolution or granularity of the profile data used to generate the time series.
690
689
  * This is the value used to jump through time steps in a time series. There are 3 valid values.
691
690
  * </p>
@@ -706,38 +705,38 @@ export interface BatchGetFrameMetricDataResponse {
706
705
  * </p>
707
706
  * </li>
708
707
  * </ul>
708
+ * @public
709
709
  */
710
710
  resolution: AggregationPeriod | undefined;
711
711
  /**
712
- * @public
713
712
  * <p>
714
713
  * List of instances, or time steps, in the time series. For example, if the
715
714
  * <code>period</code> is one day (<code>PT24H)</code>), and the <code>resolution</code>
716
715
  * is five minutes (<code>PT5M</code>), then there are 288 <code>endTimes</code> in the
717
716
  * list that are each five minutes appart.
718
717
  * </p>
718
+ * @public
719
719
  */
720
720
  endTimes: TimestampStructure[] | undefined;
721
721
  /**
722
- * @public
723
722
  * <p>List of instances which remained unprocessed. This will create a missing time step in the list of end times.</p>
723
+ * @public
724
724
  */
725
725
  unprocessedEndTimes: Record<string, TimestampStructure[]> | undefined;
726
726
  /**
727
- * @public
728
727
  * <p>Details of the metrics to request a time series of values. The metric includes
729
728
  * the name of the frame, the aggregation type to calculate the metric value for the frame,
730
729
  * and the thread states to use to get the count for the metric value of the frame.</p>
730
+ * @public
731
731
  */
732
732
  frameMetricData: FrameMetricDatum[] | undefined;
733
733
  }
734
734
  /**
735
- * @public
736
735
  * <p>The structure representing the GetFindingsReportAccountSummaryRequest.</p>
736
+ * @public
737
737
  */
738
738
  export interface GetFindingsReportAccountSummaryRequest {
739
739
  /**
740
- * @public
741
740
  * <p>The <code>nextToken</code> value returned from a previous paginated <code>GetFindingsReportAccountSummary</code>
742
741
  * request where <code>maxResults</code> was used and the results exceeded the value of that parameter.
743
742
  * Pagination continues from the end of the previous results that returned the <code>nextToken</code> value.
@@ -746,87 +745,88 @@ export interface GetFindingsReportAccountSummaryRequest {
746
745
  * <p>This token should be treated as an opaque identifier that is only used to retrieve
747
746
  * the next items in a list and not for other programmatic purposes.</p>
748
747
  * </note>
748
+ * @public
749
749
  */
750
750
  nextToken?: string;
751
751
  /**
752
- * @public
753
752
  * <p>The maximum number of results returned by <code> GetFindingsReportAccountSummary</code> in paginated output.
754
753
  * When this parameter is used, <code>GetFindingsReportAccountSummary</code> only returns <code>maxResults</code>
755
754
  * results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial
756
755
  * request can be seen by sending another <code>GetFindingsReportAccountSummary</code> request with the returned
757
756
  * <code>nextToken</code> value.</p>
757
+ * @public
758
758
  */
759
759
  maxResults?: number;
760
760
  /**
761
- * @public
762
761
  * <p>A <code>Boolean</code> value indicating whether to only return reports from daily profiles. If set
763
762
  * to <code>True</code>, only analysis data from daily profiles is returned. If set to <code>False</code>,
764
763
  * analysis data is returned from smaller time windows (for example, one hour).</p>
764
+ * @public
765
765
  */
766
766
  dailyReportsOnly?: boolean;
767
767
  }
768
768
  /**
769
- * @public
770
769
  * <p>
771
770
  * Information about potential recommendations that might be created from the
772
771
  * analysis of profiling data.
773
772
  * </p>
773
+ * @public
774
774
  */
775
775
  export interface FindingsReportSummary {
776
776
  /**
777
- * @public
778
777
  * <p>The universally unique identifier (UUID) of the recommendation report.</p>
778
+ * @public
779
779
  */
780
780
  id?: string;
781
781
  /**
782
- * @public
783
782
  * <p>The name of the profiling group that is associated with the analysis data.</p>
783
+ * @public
784
784
  */
785
785
  profilingGroupName?: string;
786
786
  /**
787
- * @public
788
787
  * <p>The start time of the profile the analysis data is about.
789
788
  * This is specified
790
789
  * using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1
791
790
  * millisecond past June 1, 2020 1:15:02 PM UTC.</p>
791
+ * @public
792
792
  */
793
793
  profileStartTime?: Date;
794
794
  /**
795
- * @public
796
795
  * <p>
797
796
  * The end time of the period during which the metric is flagged as anomalous.
798
797
  * This is specified
799
798
  * using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1
800
799
  * millisecond past June 1, 2020 1:15:02 PM UTC.
801
800
  * </p>
801
+ * @public
802
802
  */
803
803
  profileEndTime?: Date;
804
804
  /**
805
- * @public
806
805
  * <p>The total number of different recommendations that were found by the analysis.</p>
806
+ * @public
807
807
  */
808
808
  totalNumberOfFindings?: number;
809
809
  }
810
810
  /**
811
- * @public
812
811
  * <p>The structure representing the GetFindingsReportAccountSummaryResponse.</p>
812
+ * @public
813
813
  */
814
814
  export interface GetFindingsReportAccountSummaryResponse {
815
815
  /**
816
- * @public
817
816
  * <p>The return list of
818
817
  * <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_FindingsReportSummary.html">
819
818
  * <code>FindingsReportSummary</code>
820
819
  * </a>
821
820
  * objects taht contain summaries of analysis results for all profiling groups in your AWS account.</p>
821
+ * @public
822
822
  */
823
823
  reportSummaries: FindingsReportSummary[] | undefined;
824
824
  /**
825
- * @public
826
825
  * <p>The <code>nextToken</code> value to include in a future <code>GetFindingsReportAccountSummary</code> request.
827
826
  * When the results of a <code>GetFindingsReportAccountSummary</code> request exceed <code>maxResults</code>, this
828
827
  * value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more
829
828
  * results to return.</p>
829
+ * @public
830
830
  */
831
831
  nextToken?: string;
832
832
  }
@@ -835,10 +835,10 @@ export interface GetFindingsReportAccountSummaryResponse {
835
835
  */
836
836
  export interface ListTagsForResourceRequest {
837
837
  /**
838
- * @public
839
838
  * <p>
840
839
  * The Amazon Resource Name (ARN) of the resource that contains the tags to return.
841
840
  * </p>
841
+ * @public
842
842
  */
843
843
  resourceArn: string | undefined;
844
844
  }
@@ -847,11 +847,11 @@ export interface ListTagsForResourceRequest {
847
847
  */
848
848
  export interface ListTagsForResourceResponse {
849
849
  /**
850
- * @public
851
850
  * <p>
852
851
  * The list of tags assigned to the specified resource. This is the list of tags
853
852
  * returned in the response.
854
853
  * </p>
854
+ * @public
855
855
  */
856
856
  tags?: Record<string, string>;
857
857
  }
@@ -902,26 +902,25 @@ export declare const MetadataField: {
902
902
  */
903
903
  export type MetadataField = (typeof MetadataField)[keyof typeof MetadataField];
904
904
  /**
905
- * @public
906
905
  * <p>The structure representing the configureAgentRequest.</p>
906
+ * @public
907
907
  */
908
908
  export interface ConfigureAgentRequest {
909
909
  /**
910
- * @public
911
910
  * <p>
912
911
  * The name of the profiling group for which the configured agent is collecting profiling data.
913
912
  * </p>
913
+ * @public
914
914
  */
915
915
  profilingGroupName: string | undefined;
916
916
  /**
917
- * @public
918
917
  * <p> A universally unique identifier (UUID) for a profiling instance. For example, if the
919
918
  * profiling instance is an Amazon EC2 instance, it is the instance ID. If it is an AWS
920
919
  * Fargate container, it is the container's task ID. </p>
920
+ * @public
921
921
  */
922
922
  fleetInstanceId?: string;
923
923
  /**
924
- * @public
925
924
  * <p> Metadata captured about the compute platform the agent is running on. It includes
926
925
  * information about sampling and reporting. The valid fields are:</p>
927
926
  * <ul>
@@ -971,22 +970,23 @@ export interface ConfigureAgentRequest {
971
970
  * </p>
972
971
  * </li>
973
972
  * </ul>
973
+ * @public
974
974
  */
975
975
  metadata?: Partial<Record<MetadataField, string>>;
976
976
  }
977
977
  /**
978
- * @public
979
978
  * <p>The structure representing the configureAgentResponse.</p>
979
+ * @public
980
980
  */
981
981
  export interface ConfigureAgentResponse {
982
982
  /**
983
- * @public
984
983
  * <p>
985
984
  * An <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AgentConfiguration.html">
986
985
  * <code>AgentConfiguration</code>
987
986
  * </a>
988
987
  * object that specifies if an agent profiles or not and for how long to return profiling data.
989
988
  * </p>
989
+ * @public
990
990
  */
991
991
  configuration: AgentConfiguration | undefined;
992
992
  }
@@ -1009,126 +1009,125 @@ export declare const ComputePlatform: {
1009
1009
  */
1010
1010
  export type ComputePlatform = (typeof ComputePlatform)[keyof typeof ComputePlatform];
1011
1011
  /**
1012
- * @public
1013
1012
  * <p>The structure representing the createProfiliingGroupRequest.</p>
1013
+ * @public
1014
1014
  */
1015
1015
  export interface CreateProfilingGroupRequest {
1016
1016
  /**
1017
- * @public
1018
1017
  * <p>The name of the profiling group to create.</p>
1018
+ * @public
1019
1019
  */
1020
1020
  profilingGroupName: string | undefined;
1021
1021
  /**
1022
- * @public
1023
1022
  * <p>
1024
1023
  * The compute platform of the profiling group. Use <code>AWSLambda</code> if your application
1025
1024
  * runs on AWS Lambda. Use <code>Default</code> if your application runs on a compute platform that
1026
1025
  * is not AWS Lambda, such an Amazon EC2 instance, an on-premises server, or a different platform.
1027
1026
  * If not specified, <code>Default</code> is used.
1028
1027
  * </p>
1028
+ * @public
1029
1029
  */
1030
1030
  computePlatform?: ComputePlatform;
1031
1031
  /**
1032
- * @public
1033
1032
  * <p> Amazon CodeGuru Profiler uses this universally unique identifier (UUID) to prevent the
1034
1033
  * accidental creation of duplicate profiling groups if there are failures and retries. </p>
1034
+ * @public
1035
1035
  */
1036
1036
  clientToken?: string;
1037
1037
  /**
1038
- * @public
1039
1038
  * <p>
1040
1039
  * Specifies whether profiling is enabled or disabled for the created profiling group.
1041
1040
  * </p>
1041
+ * @public
1042
1042
  */
1043
1043
  agentOrchestrationConfig?: AgentOrchestrationConfig;
1044
1044
  /**
1045
- * @public
1046
1045
  * <p>
1047
1046
  * A list of tags to add to the created profiling group.
1048
1047
  * </p>
1048
+ * @public
1049
1049
  */
1050
1050
  tags?: Record<string, string>;
1051
1051
  }
1052
1052
  /**
1053
- * @public
1054
1053
  * <p>
1055
1054
  * Profiling status includes information about the last time a profile agent pinged back,
1056
1055
  * the last time a profile was received, and the aggregation period and start time for the
1057
1056
  * most recent aggregated profile.
1058
1057
  * </p>
1058
+ * @public
1059
1059
  */
1060
1060
  export interface ProfilingStatus {
1061
1061
  /**
1062
- * @public
1063
1062
  * <p>The date and time when the most recent profile was received. Specify using
1064
1063
  * the ISO 8601 format. For example,
1065
1064
  * 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.</p>
1065
+ * @public
1066
1066
  */
1067
1067
  latestAgentProfileReportedAt?: Date;
1068
1068
  /**
1069
- * @public
1070
1069
  * <p>
1071
1070
  * An <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AggregatedProfileTime.html">
1072
1071
  * <code>AggregatedProfileTime</code>
1073
1072
  * </a>
1074
1073
  * object that contains the aggregation period and start time for an aggregated profile.
1075
1074
  * </p>
1075
+ * @public
1076
1076
  */
1077
1077
  latestAggregatedProfile?: AggregatedProfileTime;
1078
1078
  /**
1079
- * @public
1080
1079
  * <p>The date and time when the profiling agent most recently pinged back. Specify using
1081
1080
  * the ISO 8601 format. For example,
1082
1081
  * 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.</p>
1082
+ * @public
1083
1083
  */
1084
1084
  latestAgentOrchestratedAt?: Date;
1085
1085
  }
1086
1086
  /**
1087
- * @public
1088
1087
  * <p>
1089
1088
  * Contains information about a profiling group.
1090
1089
  * </p>
1090
+ * @public
1091
1091
  */
1092
1092
  export interface ProfilingGroupDescription {
1093
1093
  /**
1094
- * @public
1095
1094
  * <p>The name of the profiling group.</p>
1095
+ * @public
1096
1096
  */
1097
1097
  name?: string;
1098
1098
  /**
1099
- * @public
1100
1099
  * <p>
1101
1100
  * An <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AgentOrchestrationConfig.html">
1102
1101
  * <code>AgentOrchestrationConfig</code>
1103
1102
  * </a>
1104
1103
  * object that indicates if the profiling group is enabled for profiled or not.
1105
1104
  * </p>
1105
+ * @public
1106
1106
  */
1107
1107
  agentOrchestrationConfig?: AgentOrchestrationConfig;
1108
1108
  /**
1109
- * @public
1110
1109
  * <p>The Amazon Resource Name (ARN) identifying the profiling group resource.</p>
1110
+ * @public
1111
1111
  */
1112
1112
  arn?: string;
1113
1113
  /**
1114
- * @public
1115
1114
  * <p>The time when the profiling group was created. Specify using
1116
1115
  * the ISO 8601 format. For example,
1117
1116
  * 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
1118
1117
  * </p>
1118
+ * @public
1119
1119
  */
1120
1120
  createdAt?: Date;
1121
1121
  /**
1122
- * @public
1123
1122
  * <p>
1124
1123
  * The date and time when the profiling group was last updated. Specify using
1125
1124
  * the ISO 8601 format. For example,
1126
1125
  * 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
1127
1126
  * </p>
1127
+ * @public
1128
1128
  */
1129
1129
  updatedAt?: Date;
1130
1130
  /**
1131
- * @public
1132
1131
  * <p>
1133
1132
  * A <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingStatus.html">
1134
1133
  * <code>ProfilingStatus</code>
@@ -1137,149 +1136,149 @@ export interface ProfilingGroupDescription {
1137
1136
  * the last time a profile was received, and the aggregation period and start time for the
1138
1137
  * most recent aggregated profile.
1139
1138
  * </p>
1139
+ * @public
1140
1140
  */
1141
1141
  profilingStatus?: ProfilingStatus;
1142
1142
  /**
1143
- * @public
1144
1143
  * <p>
1145
1144
  * The compute platform of the profiling group. If it is set to <code>AWSLambda</code>, then
1146
1145
  * the profiled application runs on AWS Lambda. If it is set to <code>Default</code>, then the
1147
1146
  * profiled application runs on a compute platform that is not AWS Lambda, such an Amazon EC2 instance,
1148
1147
  * an on-premises server, or a different platform. The default is <code>Default</code>.
1149
1148
  * </p>
1149
+ * @public
1150
1150
  */
1151
1151
  computePlatform?: ComputePlatform;
1152
1152
  /**
1153
- * @public
1154
1153
  * <p>
1155
1154
  * A list of the tags that belong to this profiling group.
1156
1155
  * </p>
1156
+ * @public
1157
1157
  */
1158
1158
  tags?: Record<string, string>;
1159
1159
  }
1160
1160
  /**
1161
- * @public
1162
1161
  * <p>The structure representing the createProfilingGroupResponse.</p>
1162
+ * @public
1163
1163
  */
1164
1164
  export interface CreateProfilingGroupResponse {
1165
1165
  /**
1166
- * @public
1167
1166
  * <p> The returned <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html">
1168
1167
  * <code>ProfilingGroupDescription</code>
1169
1168
  * </a> object that contains information
1170
1169
  * about the created profiling group. </p>
1170
+ * @public
1171
1171
  */
1172
1172
  profilingGroup: ProfilingGroupDescription | undefined;
1173
1173
  }
1174
1174
  /**
1175
- * @public
1176
1175
  * <p>The structure representing the deleteProfilingGroupRequest.</p>
1176
+ * @public
1177
1177
  */
1178
1178
  export interface DeleteProfilingGroupRequest {
1179
1179
  /**
1180
- * @public
1181
1180
  * <p>The name of the profiling group to delete.</p>
1181
+ * @public
1182
1182
  */
1183
1183
  profilingGroupName: string | undefined;
1184
1184
  }
1185
1185
  /**
1186
- * @public
1187
1186
  * <p>The structure representing the deleteProfilingGroupResponse.</p>
1187
+ * @public
1188
1188
  */
1189
1189
  export interface DeleteProfilingGroupResponse {
1190
1190
  }
1191
1191
  /**
1192
- * @public
1193
1192
  * <p>The structure representing the describeProfilingGroupRequest.</p>
1193
+ * @public
1194
1194
  */
1195
1195
  export interface DescribeProfilingGroupRequest {
1196
1196
  /**
1197
- * @public
1198
1197
  * <p>
1199
1198
  * The name of the profiling group to get information about.
1200
1199
  * </p>
1200
+ * @public
1201
1201
  */
1202
1202
  profilingGroupName: string | undefined;
1203
1203
  }
1204
1204
  /**
1205
- * @public
1206
1205
  * <p>The structure representing the describeProfilingGroupResponse.</p>
1206
+ * @public
1207
1207
  */
1208
1208
  export interface DescribeProfilingGroupResponse {
1209
1209
  /**
1210
- * @public
1211
1210
  * <p>
1212
1211
  * The returned <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html">
1213
1212
  * <code>ProfilingGroupDescription</code>
1214
1213
  * </a>
1215
1214
  * object that contains information about the requested profiling group.
1216
1215
  * </p>
1216
+ * @public
1217
1217
  */
1218
1218
  profilingGroup: ProfilingGroupDescription | undefined;
1219
1219
  }
1220
1220
  /**
1221
- * @public
1222
1221
  * <p>The structure representing the GetNotificationConfigurationRequest.</p>
1222
+ * @public
1223
1223
  */
1224
1224
  export interface GetNotificationConfigurationRequest {
1225
1225
  /**
1226
- * @public
1227
1226
  * <p>The name of the profiling group we want to get the notification configuration for.</p>
1227
+ * @public
1228
1228
  */
1229
1229
  profilingGroupName: string | undefined;
1230
1230
  }
1231
1231
  /**
1232
- * @public
1233
1232
  * <p>The structure representing the GetNotificationConfigurationResponse.</p>
1233
+ * @public
1234
1234
  */
1235
1235
  export interface GetNotificationConfigurationResponse {
1236
1236
  /**
1237
- * @public
1238
1237
  * <p>The current notification configuration for this profiling group.</p>
1238
+ * @public
1239
1239
  */
1240
1240
  notificationConfiguration: NotificationConfiguration | undefined;
1241
1241
  }
1242
1242
  /**
1243
- * @public
1244
1243
  * <p>
1245
1244
  * The structure representing the <code>getPolicyRequest</code>.
1246
1245
  * </p>
1246
+ * @public
1247
1247
  */
1248
1248
  export interface GetPolicyRequest {
1249
1249
  /**
1250
- * @public
1251
1250
  * <p>The name of the profiling group.</p>
1251
+ * @public
1252
1252
  */
1253
1253
  profilingGroupName: string | undefined;
1254
1254
  }
1255
1255
  /**
1256
- * @public
1257
1256
  * <p>The structure representing the <code>getPolicyResponse</code>.</p>
1257
+ * @public
1258
1258
  */
1259
1259
  export interface GetPolicyResponse {
1260
1260
  /**
1261
- * @public
1262
1261
  * <p>The JSON-formatted resource-based policy attached to the <code>ProfilingGroup</code>.</p>
1262
+ * @public
1263
1263
  */
1264
1264
  policy: string | undefined;
1265
1265
  /**
1266
- * @public
1267
1266
  * <p>A unique identifier for the current revision of the returned policy.</p>
1267
+ * @public
1268
1268
  */
1269
1269
  revisionId: string | undefined;
1270
1270
  }
1271
1271
  /**
1272
- * @public
1273
1272
  * <p>The structure representing the getProfileRequest.</p>
1273
+ * @public
1274
1274
  */
1275
1275
  export interface GetProfileRequest {
1276
1276
  /**
1277
- * @public
1278
1277
  * <p>The name of the profiling group to get.</p>
1278
+ * @public
1279
1279
  */
1280
1280
  profilingGroupName: string | undefined;
1281
1281
  /**
1282
- * @public
1283
1282
  * <p>The start time of the profile to get. Specify using
1284
1283
  * the ISO 8601 format. For example,
1285
1284
  * 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.</p>
@@ -1288,10 +1287,10 @@ export interface GetProfileRequest {
1288
1287
  * If you specify <code>startTime</code>, then you must also specify <code>period</code>
1289
1288
  * or <code>endTime</code>, but not both.
1290
1289
  * </p>
1290
+ * @public
1291
1291
  */
1292
1292
  startTime?: Date;
1293
1293
  /**
1294
- * @public
1295
1294
  * <p>
1296
1295
  * Used with <code>startTime</code> or <code>endTime</code> to specify
1297
1296
  * the time range for the returned aggregated profile. Specify using
@@ -1301,10 +1300,10 @@ export interface GetProfileRequest {
1301
1300
  * <p>
1302
1301
  * To get the latest aggregated profile, specify only <code>period</code>.
1303
1302
  * </p>
1303
+ * @public
1304
1304
  */
1305
1305
  period?: string;
1306
1306
  /**
1307
- * @public
1308
1307
  * <p>
1309
1308
  * The end time of the requested profile. Specify using
1310
1309
  * the ISO 8601 format. For example,
@@ -1314,10 +1313,10 @@ export interface GetProfileRequest {
1314
1313
  * If you specify <code>endTime</code>, then you must also specify <code>period</code>
1315
1314
  * or <code>startTime</code>, but not both.
1316
1315
  * </p>
1316
+ * @public
1317
1317
  */
1318
1318
  endTime?: Date;
1319
1319
  /**
1320
- * @public
1321
1320
  * <p>
1322
1321
  * The maximum depth of the stacks in the code that is represented in
1323
1322
  * the aggregated profile. For example, if CodeGuru Profiler finds a method <code>A</code>,
@@ -1326,10 +1325,10 @@ export interface GetProfileRequest {
1326
1325
  * set to 2, then the aggregated profile contains representations of methods <code>A</code>
1327
1326
  * and <code>B</code>.
1328
1327
  * </p>
1328
+ * @public
1329
1329
  */
1330
1330
  maxDepth?: number;
1331
1331
  /**
1332
- * @public
1333
1332
  * <p>
1334
1333
  * The format of the returned profiling data. The format maps to the
1335
1334
  * <code>Accept</code> and <code>Content-Type</code> headers of the
@@ -1350,66 +1349,66 @@ export interface GetProfileRequest {
1350
1349
  * </p>
1351
1350
  * </li>
1352
1351
  * </ul>
1352
+ * @public
1353
1353
  */
1354
1354
  accept?: string;
1355
1355
  }
1356
1356
  /**
1357
- * @public
1358
1357
  * <p>The structure representing the getProfileResponse.</p>
1358
+ * @public
1359
1359
  */
1360
1360
  export interface GetProfileResponse {
1361
1361
  /**
1362
- * @public
1363
1362
  * <p>Information about the profile.</p>
1363
+ * @public
1364
1364
  */
1365
1365
  profile: Uint8Array | undefined;
1366
1366
  /**
1367
- * @public
1368
1367
  * <p>The content type of the profile in the payload. It is
1369
1368
  * either <code>application/json</code> or the default
1370
1369
  * <code>application/x-amzn-ion</code>.</p>
1370
+ * @public
1371
1371
  */
1372
1372
  contentType: string | undefined;
1373
1373
  /**
1374
- * @public
1375
1374
  * <p>The content encoding of the profile.</p>
1375
+ * @public
1376
1376
  */
1377
1377
  contentEncoding?: string;
1378
1378
  }
1379
1379
  /**
1380
- * @public
1381
1380
  * <p>The structure representing the GetRecommendationsRequest.</p>
1381
+ * @public
1382
1382
  */
1383
1383
  export interface GetRecommendationsRequest {
1384
1384
  /**
1385
- * @public
1386
1385
  * <p>
1387
1386
  * The name of the profiling group to get analysis data about.
1388
1387
  * </p>
1388
+ * @public
1389
1389
  */
1390
1390
  profilingGroupName: string | undefined;
1391
1391
  /**
1392
- * @public
1393
1392
  * <p>
1394
1393
  * The end time of the profile to get analysis data about. You must specify <code>startTime</code> and <code>endTime</code>.
1395
1394
  * This is specified
1396
1395
  * using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1
1397
1396
  * millisecond past June 1, 2020 1:15:02 PM UTC.
1398
1397
  * </p>
1398
+ * @public
1399
1399
  */
1400
1400
  startTime: Date | undefined;
1401
1401
  /**
1402
- * @public
1403
1402
  * <p>
1404
1403
  * The start time of the profile to get analysis data about. You must specify <code>startTime</code> and <code>endTime</code>.
1405
1404
  * This is specified
1406
1405
  * using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1
1407
1406
  * millisecond past June 1, 2020 1:15:02 PM UTC.
1408
1407
  * </p>
1408
+ * @public
1409
1409
  */
1410
1410
  endTime: Date | undefined;
1411
1411
  /**
1412
- * @public
1413
1412
  * <p>
1414
1413
  * The language used to provide analysis. Specify using a string that is one
1415
1414
  * of the following <code>BCP 47</code> language codes.
@@ -1471,198 +1470,198 @@ export interface GetRecommendationsRequest {
1471
1470
  * </p>
1472
1471
  * </li>
1473
1472
  * </ul>
1473
+ * @public
1474
1474
  */
1475
1475
  locale?: string;
1476
1476
  }
1477
1477
  /**
1478
- * @public
1479
1478
  * <p>
1480
1479
  * A set of rules used to make a recommendation during an analysis.
1481
1480
  * </p>
1481
+ * @public
1482
1482
  */
1483
1483
  export interface Pattern {
1484
1484
  /**
1485
- * @public
1486
1485
  * <p>The universally unique identifier (UUID) of this pattern.</p>
1486
+ * @public
1487
1487
  */
1488
1488
  id?: string;
1489
1489
  /**
1490
- * @public
1491
1490
  * <p>The name for this pattern.</p>
1491
+ * @public
1492
1492
  */
1493
1493
  name?: string;
1494
1494
  /**
1495
- * @public
1496
1495
  * <p>The description of the recommendation. This explains a potential
1497
1496
  * inefficiency in a profiled application.</p>
1497
+ * @public
1498
1498
  */
1499
1499
  description?: string;
1500
1500
  /**
1501
- * @public
1502
1501
  * <p>
1503
1502
  * A string that contains the steps recommended to address the potential inefficiency.
1504
1503
  * </p>
1504
+ * @public
1505
1505
  */
1506
1506
  resolutionSteps?: string;
1507
1507
  /**
1508
- * @public
1509
1508
  * <p>A list of frame names that were searched during the analysis that generated
1510
1509
  * a recommendation.</p>
1510
+ * @public
1511
1511
  */
1512
1512
  targetFrames?: string[][];
1513
1513
  /**
1514
- * @public
1515
1514
  * <p>
1516
1515
  * The percentage of time an application spends in one method that triggers
1517
1516
  * a recommendation. The percentage of time is the same as the percentage of
1518
1517
  * the total gathered sample counts during analysis.
1519
1518
  * </p>
1519
+ * @public
1520
1520
  */
1521
1521
  thresholdPercent?: number;
1522
1522
  /**
1523
- * @public
1524
1523
  * <p>
1525
1524
  * A list of the different counters used to determine if there is a match.
1526
1525
  * </p>
1526
+ * @public
1527
1527
  */
1528
1528
  countersToAggregate?: string[];
1529
1529
  }
1530
1530
  /**
1531
- * @public
1532
1531
  * <p>The part of a profile that contains a recommendation found during analysis.</p>
1532
+ * @public
1533
1533
  */
1534
1534
  export interface Match {
1535
1535
  /**
1536
- * @public
1537
1536
  * <p>The target frame that triggered a match.</p>
1537
+ * @public
1538
1538
  */
1539
1539
  targetFramesIndex?: number;
1540
1540
  /**
1541
- * @public
1542
1541
  * <p>The location in the profiling graph that contains a recommendation found during analysis.</p>
1542
+ * @public
1543
1543
  */
1544
1544
  frameAddress?: string;
1545
1545
  /**
1546
- * @public
1547
1546
  * <p>The value in the profile data that exceeded the recommendation threshold.</p>
1547
+ * @public
1548
1548
  */
1549
1549
  thresholdBreachValue?: number;
1550
1550
  }
1551
1551
  /**
1552
- * @public
1553
1552
  * <p>A potential improvement that was found from analyzing the profiling data.</p>
1553
+ * @public
1554
1554
  */
1555
1555
  export interface Recommendation {
1556
1556
  /**
1557
- * @public
1558
1557
  * <p>How many different places in the profile graph triggered a match.</p>
1558
+ * @public
1559
1559
  */
1560
1560
  allMatchesCount: number | undefined;
1561
1561
  /**
1562
- * @public
1563
1562
  * <p>How much of the total sample count is potentially affected.</p>
1563
+ * @public
1564
1564
  */
1565
1565
  allMatchesSum: number | undefined;
1566
1566
  /**
1567
- * @public
1568
1567
  * <p>The pattern that analysis recognized in the profile to make this recommendation.</p>
1568
+ * @public
1569
1569
  */
1570
1570
  pattern: Pattern | undefined;
1571
1571
  /**
1572
- * @public
1573
1572
  * <p>List of the matches with most impact. </p>
1573
+ * @public
1574
1574
  */
1575
1575
  topMatches: Match[] | undefined;
1576
1576
  /**
1577
- * @public
1578
1577
  * <p>The start time of the profile that was used by this analysis.
1579
1578
  * This is specified
1580
1579
  * using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1
1581
1580
  * millisecond past June 1, 2020 1:15:02 PM UTC.</p>
1581
+ * @public
1582
1582
  */
1583
1583
  startTime: Date | undefined;
1584
1584
  /**
1585
- * @public
1586
1585
  * <p>End time of the profile that was used by this analysis.
1587
1586
  * This is specified
1588
1587
  * using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1
1589
1588
  * millisecond past June 1, 2020 1:15:02 PM UTC.</p>
1589
+ * @public
1590
1590
  */
1591
1591
  endTime: Date | undefined;
1592
1592
  }
1593
1593
  /**
1594
- * @public
1595
1594
  * <p>The structure representing the GetRecommendationsResponse.</p>
1595
+ * @public
1596
1596
  */
1597
1597
  export interface GetRecommendationsResponse {
1598
1598
  /**
1599
- * @public
1600
1599
  * <p>The name of the profiling group the analysis data is about.</p>
1600
+ * @public
1601
1601
  */
1602
1602
  profilingGroupName: string | undefined;
1603
1603
  /**
1604
- * @public
1605
1604
  * <p>
1606
1605
  * The start time of the profile the analysis data is about. This is specified
1607
1606
  * using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1
1608
1607
  * millisecond past June 1, 2020 1:15:02 PM UTC.
1609
1608
  * </p>
1609
+ * @public
1610
1610
  */
1611
1611
  profileStartTime: Date | undefined;
1612
1612
  /**
1613
- * @public
1614
1613
  * <p>
1615
1614
  * The end time of the profile the analysis data is about. This is specified
1616
1615
  * using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1
1617
1616
  * millisecond past June 1, 2020 1:15:02 PM UTC.
1618
1617
  * </p>
1618
+ * @public
1619
1619
  */
1620
1620
  profileEndTime: Date | undefined;
1621
1621
  /**
1622
- * @public
1623
1622
  * <p>The list of recommendations that the analysis found for this profile.</p>
1623
+ * @public
1624
1624
  */
1625
1625
  recommendations: Recommendation[] | undefined;
1626
1626
  /**
1627
- * @public
1628
1627
  * <p>
1629
1628
  * The list of anomalies that the analysis has found for this profile.
1630
1629
  * </p>
1630
+ * @public
1631
1631
  */
1632
1632
  anomalies: Anomaly[] | undefined;
1633
1633
  }
1634
1634
  /**
1635
- * @public
1636
1635
  * <p>The structure representing the ListFindingsReportsRequest.</p>
1636
+ * @public
1637
1637
  */
1638
1638
  export interface ListFindingsReportsRequest {
1639
1639
  /**
1640
- * @public
1641
1640
  * <p>The name of the profiling group from which to search for analysis data.</p>
1641
+ * @public
1642
1642
  */
1643
1643
  profilingGroupName: string | undefined;
1644
1644
  /**
1645
- * @public
1646
1645
  * <p>
1647
1646
  * The start time of the profile to get analysis data about. You must specify <code>startTime</code> and <code>endTime</code>.
1648
1647
  * This is specified
1649
1648
  * using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1
1650
1649
  * millisecond past June 1, 2020 1:15:02 PM UTC.
1651
1650
  * </p>
1651
+ * @public
1652
1652
  */
1653
1653
  startTime: Date | undefined;
1654
1654
  /**
1655
- * @public
1656
1655
  * <p>
1657
1656
  * The end time of the profile to get analysis data about. You must specify <code>startTime</code> and <code>endTime</code>.
1658
1657
  * This is specified
1659
1658
  * using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1
1660
1659
  * millisecond past June 1, 2020 1:15:02 PM UTC.
1661
1660
  * </p>
1661
+ * @public
1662
1662
  */
1663
1663
  endTime: Date | undefined;
1664
1664
  /**
1665
- * @public
1666
1665
  * <p>The <code>nextToken</code> value returned from a previous paginated <code>ListFindingsReportsRequest</code>
1667
1666
  * request where <code>maxResults</code> was used and the results exceeded the value of that parameter.
1668
1667
  * Pagination continues from the end of the previous results that returned the <code>nextToken</code> value.
@@ -1671,42 +1670,43 @@ export interface ListFindingsReportsRequest {
1671
1670
  * <p>This token should be treated as an opaque identifier that is only used to retrieve
1672
1671
  * the next items in a list and not for other programmatic purposes.</p>
1673
1672
  * </note>
1673
+ * @public
1674
1674
  */
1675
1675
  nextToken?: string;
1676
1676
  /**
1677
- * @public
1678
1677
  * <p>The maximum number of report results returned by <code>ListFindingsReports</code>
1679
1678
  * in paginated output. When this parameter is used, <code>ListFindingsReports</code> only returns
1680
1679
  * <code>maxResults</code> results in a single page along with a <code>nextToken</code> response
1681
1680
  * element. The remaining results of the initial request
1682
1681
  * can be seen by sending another <code>ListFindingsReports</code> request with the returned
1683
1682
  * <code>nextToken</code> value.</p>
1683
+ * @public
1684
1684
  */
1685
1685
  maxResults?: number;
1686
1686
  /**
1687
- * @public
1688
1687
  * <p>A <code>Boolean</code> value indicating whether to only return reports from daily profiles. If set
1689
1688
  * to <code>True</code>, only analysis data from daily profiles is returned. If set to <code>False</code>,
1690
1689
  * analysis data is returned from smaller time windows (for example, one hour).</p>
1690
+ * @public
1691
1691
  */
1692
1692
  dailyReportsOnly?: boolean;
1693
1693
  }
1694
1694
  /**
1695
- * @public
1696
1695
  * <p>The structure representing the ListFindingsReportsResponse.</p>
1696
+ * @public
1697
1697
  */
1698
1698
  export interface ListFindingsReportsResponse {
1699
1699
  /**
1700
- * @public
1701
1700
  * <p>The list of analysis results summaries.</p>
1701
+ * @public
1702
1702
  */
1703
1703
  findingsReportSummaries: FindingsReportSummary[] | undefined;
1704
1704
  /**
1705
- * @public
1706
1705
  * <p>The <code>nextToken</code> value to include in a future <code>ListFindingsReports</code> request.
1707
1706
  * When the results of a <code>ListFindingsReports</code> request exceed <code>maxResults</code>, this
1708
1707
  * value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more
1709
1708
  * results to return.</p>
1709
+ * @public
1710
1710
  */
1711
1711
  nextToken?: string;
1712
1712
  }
@@ -1729,27 +1729,26 @@ export declare const OrderBy: {
1729
1729
  */
1730
1730
  export type OrderBy = (typeof OrderBy)[keyof typeof OrderBy];
1731
1731
  /**
1732
- * @public
1733
1732
  * <p>The structure representing the listProfileTimesRequest.</p>
1733
+ * @public
1734
1734
  */
1735
1735
  export interface ListProfileTimesRequest {
1736
1736
  /**
1737
- * @public
1738
1737
  * <p>The name of the profiling group.</p>
1738
+ * @public
1739
1739
  */
1740
1740
  profilingGroupName: string | undefined;
1741
1741
  /**
1742
- * @public
1743
1742
  * <p>The start time of the time range from which to list the profiles.</p>
1743
+ * @public
1744
1744
  */
1745
1745
  startTime: Date | undefined;
1746
1746
  /**
1747
- * @public
1748
1747
  * <p>The end time of the time range from which to list the profiles.</p>
1748
+ * @public
1749
1749
  */
1750
1750
  endTime: Date | undefined;
1751
1751
  /**
1752
- * @public
1753
1752
  * <p>
1754
1753
  * The aggregation period. This specifies the period during which an aggregation profile
1755
1754
  * collects posted agent profiles for a profiling group. There are 3 valid values.
@@ -1771,17 +1770,17 @@ export interface ListProfileTimesRequest {
1771
1770
  * </p>
1772
1771
  * </li>
1773
1772
  * </ul>
1773
+ * @public
1774
1774
  */
1775
1775
  period: AggregationPeriod | undefined;
1776
1776
  /**
1777
- * @public
1778
1777
  * <p>The order (ascending or descending by start time of the profile) to
1779
1778
  * use when listing profiles. Defaults to <code>TIMESTAMP_DESCENDING</code>.
1780
1779
  * </p>
1780
+ * @public
1781
1781
  */
1782
1782
  orderBy?: OrderBy;
1783
1783
  /**
1784
- * @public
1785
1784
  * <p>The maximum number of profile time results returned by <code>ListProfileTimes</code>
1786
1785
  * in paginated output. When this parameter is used, <code>ListProfileTimes</code> only returns
1787
1786
  * <code>maxResults</code> results in a single page with a <code>nextToken</code> response
@@ -1789,10 +1788,10 @@ export interface ListProfileTimesRequest {
1789
1788
  * can be seen by sending another <code>ListProfileTimes</code> request with the returned
1790
1789
  * <code>nextToken</code> value.
1791
1790
  * </p>
1791
+ * @public
1792
1792
  */
1793
1793
  maxResults?: number;
1794
1794
  /**
1795
- * @public
1796
1795
  * <p>The <code>nextToken</code> value returned from a previous paginated
1797
1796
  * <code>ListProfileTimes</code> request where <code>maxResults</code> was used and the results
1798
1797
  * exceeded the value of that parameter. Pagination continues from the end of the previous results
@@ -1802,52 +1801,52 @@ export interface ListProfileTimesRequest {
1802
1801
  * <p>This token should be treated as an opaque identifier that is only used to retrieve
1803
1802
  * the next items in a list and not for other programmatic purposes.</p>
1804
1803
  * </note>
1804
+ * @public
1805
1805
  */
1806
1806
  nextToken?: string;
1807
1807
  }
1808
1808
  /**
1809
- * @public
1810
1809
  * <p>
1811
1810
  * Contains the start time of a profile.
1812
1811
  * </p>
1812
+ * @public
1813
1813
  */
1814
1814
  export interface ProfileTime {
1815
1815
  /**
1816
- * @public
1817
1816
  * <p>The start time of a profile. It is specified using
1818
1817
  * the ISO 8601 format. For example,
1819
1818
  * 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.</p>
1819
+ * @public
1820
1820
  */
1821
1821
  start?: Date;
1822
1822
  }
1823
1823
  /**
1824
- * @public
1825
1824
  * <p>The structure representing the listProfileTimesResponse.</p>
1825
+ * @public
1826
1826
  */
1827
1827
  export interface ListProfileTimesResponse {
1828
1828
  /**
1829
- * @public
1830
1829
  * <p>The list of start times of the available profiles for the aggregation
1831
1830
  * period in the specified time range.
1832
1831
  * </p>
1832
+ * @public
1833
1833
  */
1834
1834
  profileTimes: ProfileTime[] | undefined;
1835
1835
  /**
1836
- * @public
1837
1836
  * <p>The <code>nextToken</code> value to include in a future <code>ListProfileTimes</code> request.
1838
1837
  * When the results of a <code>ListProfileTimes</code> request exceed <code>maxResults</code>, this
1839
1838
  * value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more
1840
1839
  * results to return. </p>
1840
+ * @public
1841
1841
  */
1842
1842
  nextToken?: string;
1843
1843
  }
1844
1844
  /**
1845
- * @public
1846
1845
  * <p>The structure representing the listProfilingGroupsRequest.</p>
1846
+ * @public
1847
1847
  */
1848
1848
  export interface ListProfilingGroupsRequest {
1849
1849
  /**
1850
- * @public
1851
1850
  * <p>The <code>nextToken</code> value returned from a previous paginated
1852
1851
  * <code>ListProfilingGroups</code> request where <code>maxResults</code> was used and the results
1853
1852
  * exceeded the value of that parameter. Pagination continues from the end of the previous results
@@ -1857,10 +1856,10 @@ export interface ListProfilingGroupsRequest {
1857
1856
  * <p>This token should be treated as an opaque identifier that is only used to retrieve
1858
1857
  * the next items in a list and not for other programmatic purposes.</p>
1859
1858
  * </note>
1859
+ * @public
1860
1860
  */
1861
1861
  nextToken?: string;
1862
1862
  /**
1863
- * @public
1864
1863
  * <p>The maximum number of profiling groups results returned by <code>ListProfilingGroups</code>
1865
1864
  * in paginated output. When this parameter is used, <code>ListProfilingGroups</code> only returns
1866
1865
  * <code>maxResults</code> results in a single page along with a <code>nextToken</code> response
@@ -1868,10 +1867,10 @@ export interface ListProfilingGroupsRequest {
1868
1867
  * can be seen by sending another <code>ListProfilingGroups</code> request with the returned
1869
1868
  * <code>nextToken</code> value.
1870
1869
  * </p>
1870
+ * @public
1871
1871
  */
1872
1872
  maxResults?: number;
1873
1873
  /**
1874
- * @public
1875
1874
  * <p>A <code>Boolean</code> value indicating whether to include a description. If <code>true</code>,
1876
1875
  * then a list of
1877
1876
  * <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html">
@@ -1879,16 +1878,16 @@ export interface ListProfilingGroupsRequest {
1879
1878
  * </a> objects
1880
1879
  * that contain detailed information about profiling groups is returned. If <code>false</code>, then
1881
1880
  * a list of profiling group names is returned.</p>
1881
+ * @public
1882
1882
  */
1883
1883
  includeDescription?: boolean;
1884
1884
  }
1885
1885
  /**
1886
- * @public
1887
1886
  * <p>The structure representing the listProfilingGroupsResponse.</p>
1887
+ * @public
1888
1888
  */
1889
1889
  export interface ListProfilingGroupsResponse {
1890
1890
  /**
1891
- * @public
1892
1891
  * <p>
1893
1892
  * A returned list of profiling group names. A list of the names is returned only if
1894
1893
  * <code>includeDescription</code> is <code>false</code>, otherwise a list of
@@ -1897,10 +1896,10 @@ export interface ListProfilingGroupsResponse {
1897
1896
  * </a> objects
1898
1897
  * is returned.
1899
1898
  * </p>
1899
+ * @public
1900
1900
  */
1901
1901
  profilingGroupNames: string[] | undefined;
1902
1902
  /**
1903
- * @public
1904
1903
  * <p>
1905
1904
  * A returned list
1906
1905
  * <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html">
@@ -1912,45 +1911,45 @@ export interface ListProfilingGroupsResponse {
1912
1911
  * </a>
1913
1912
  * objects is returned only if <code>includeDescription</code> is <code>true</code>, otherwise a list of profiling group names is returned.
1914
1913
  * </p>
1914
+ * @public
1915
1915
  */
1916
1916
  profilingGroups?: ProfilingGroupDescription[];
1917
1917
  /**
1918
- * @public
1919
1918
  * <p>The <code>nextToken</code> value to include in a future <code>ListProfilingGroups</code> request.
1920
1919
  * When the results of a <code>ListProfilingGroups</code> request exceed <code>maxResults</code>, this
1921
1920
  * value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more
1922
1921
  * results to return. </p>
1922
+ * @public
1923
1923
  */
1924
1924
  nextToken?: string;
1925
1925
  }
1926
1926
  /**
1927
- * @public
1928
1927
  * <p>The structure representing the postAgentProfileRequest.</p>
1928
+ * @public
1929
1929
  */
1930
1930
  export interface PostAgentProfileRequest {
1931
1931
  /**
1932
- * @public
1933
1932
  * <p>
1934
1933
  * The name of the profiling group with the aggregated profile that receives the
1935
1934
  * submitted profiling data.
1936
1935
  * </p>
1936
+ * @public
1937
1937
  */
1938
1938
  profilingGroupName: string | undefined;
1939
1939
  /**
1940
- * @public
1941
1940
  * <p>
1942
1941
  * The submitted profiling data.
1943
1942
  * </p>
1943
+ * @public
1944
1944
  */
1945
1945
  agentProfile: Uint8Array | undefined;
1946
1946
  /**
1947
- * @public
1948
1947
  * <p> Amazon CodeGuru Profiler uses this universally unique identifier (UUID) to prevent the
1949
1948
  * accidental submission of duplicate profiling data if there are failures and retries. </p>
1949
+ * @public
1950
1950
  */
1951
1951
  profileToken?: string;
1952
1952
  /**
1953
- * @public
1954
1953
  * <p>
1955
1954
  * The format of the submitted profiling data. The format maps to the
1956
1955
  * <code>Accept</code> and <code>Content-Type</code> headers of the
@@ -1971,222 +1970,223 @@ export interface PostAgentProfileRequest {
1971
1970
  * </p>
1972
1971
  * </li>
1973
1972
  * </ul>
1973
+ * @public
1974
1974
  */
1975
1975
  contentType: string | undefined;
1976
1976
  }
1977
1977
  /**
1978
- * @public
1979
1978
  * <p>The structure representing the postAgentProfileResponse.</p>
1979
+ * @public
1980
1980
  */
1981
1981
  export interface PostAgentProfileResponse {
1982
1982
  }
1983
1983
  /**
1984
- * @public
1985
1984
  * <p>The structure representing the <code>putPermissionRequest</code>.</p>
1985
+ * @public
1986
1986
  */
1987
1987
  export interface PutPermissionRequest {
1988
1988
  /**
1989
- * @public
1990
1989
  * <p>The name of the profiling group to grant access to.</p>
1990
+ * @public
1991
1991
  */
1992
1992
  profilingGroupName: string | undefined;
1993
1993
  /**
1994
- * @public
1995
1994
  * <p>
1996
1995
  * Specifies an action group that contains permissions to add to
1997
1996
  * a profiling group resource. One action group is supported, <code>agentPermissions</code>, which
1998
1997
  * grants permission to perform actions required by the profiling agent, <code>ConfigureAgent</code>
1999
1998
  * and <code>PostAgentProfile</code> permissions.
2000
1999
  * </p>
2000
+ * @public
2001
2001
  */
2002
2002
  actionGroup: ActionGroup | undefined;
2003
2003
  /**
2004
- * @public
2005
2004
  * <p>
2006
2005
  * A list ARNs for the roles and users you want to grant access to the profiling group.
2007
2006
  * Wildcards are not are supported in the ARNs.
2008
2007
  * </p>
2008
+ * @public
2009
2009
  */
2010
2010
  principals: string[] | undefined;
2011
2011
  /**
2012
- * @public
2013
2012
  * <p>
2014
2013
  * A universally unique identifier (UUID) for the revision of the policy you
2015
2014
  * are adding to the profiling group. Do not specify
2016
2015
  * this when you add permissions to a profiling group for the first time. If a policy already exists on the
2017
2016
  * profiling group, you must specify the <code>revisionId</code>.
2018
2017
  * </p>
2018
+ * @public
2019
2019
  */
2020
2020
  revisionId?: string;
2021
2021
  }
2022
2022
  /**
2023
- * @public
2024
2023
  * <p>The structure representing the <code>putPermissionResponse</code>.</p>
2024
+ * @public
2025
2025
  */
2026
2026
  export interface PutPermissionResponse {
2027
2027
  /**
2028
- * @public
2029
2028
  * <p>
2030
2029
  * The JSON-formatted resource-based policy on the profiling group that includes the
2031
2030
  * added permissions.
2032
2031
  * </p>
2032
+ * @public
2033
2033
  */
2034
2034
  policy: string | undefined;
2035
2035
  /**
2036
- * @public
2037
2036
  * <p> A universally unique identifier (UUID) for the revision of the resource-based policy
2038
2037
  * that includes the added permissions. The JSON-formatted policy is in the
2039
2038
  * <code>policy</code> element of the response. </p>
2039
+ * @public
2040
2040
  */
2041
2041
  revisionId: string | undefined;
2042
2042
  }
2043
2043
  /**
2044
- * @public
2045
2044
  * <p>The structure representing the RemoveNotificationChannelRequest.</p>
2045
+ * @public
2046
2046
  */
2047
2047
  export interface RemoveNotificationChannelRequest {
2048
2048
  /**
2049
- * @public
2050
2049
  * <p>The name of the profiling group we want to change notification configuration for.</p>
2050
+ * @public
2051
2051
  */
2052
2052
  profilingGroupName: string | undefined;
2053
2053
  /**
2054
- * @public
2055
2054
  * <p>The id of the channel that we want to stop receiving notifications.</p>
2055
+ * @public
2056
2056
  */
2057
2057
  channelId: string | undefined;
2058
2058
  }
2059
2059
  /**
2060
- * @public
2061
2060
  * <p>The structure representing the RemoveNotificationChannelResponse.</p>
2061
+ * @public
2062
2062
  */
2063
2063
  export interface RemoveNotificationChannelResponse {
2064
2064
  /**
2065
- * @public
2066
2065
  * <p>The new notification configuration for this profiling group.</p>
2066
+ * @public
2067
2067
  */
2068
2068
  notificationConfiguration?: NotificationConfiguration;
2069
2069
  }
2070
2070
  /**
2071
- * @public
2072
2071
  * <p>
2073
2072
  *
2074
2073
  * The structure representing the <code>removePermissionRequest</code>.</p>
2074
+ * @public
2075
2075
  */
2076
2076
  export interface RemovePermissionRequest {
2077
2077
  /**
2078
- * @public
2079
2078
  * <p>The name of the profiling group.</p>
2079
+ * @public
2080
2080
  */
2081
2081
  profilingGroupName: string | undefined;
2082
2082
  /**
2083
- * @public
2084
2083
  * <p>
2085
2084
  * Specifies an action group that contains the permissions to remove from
2086
2085
  * a profiling group's resource-based policy. One action group is supported, <code>agentPermissions</code>, which
2087
2086
  * grants <code>ConfigureAgent</code> and <code>PostAgentProfile</code> permissions.
2088
2087
  * </p>
2088
+ * @public
2089
2089
  */
2090
2090
  actionGroup: ActionGroup | undefined;
2091
2091
  /**
2092
- * @public
2093
2092
  * <p>
2094
2093
  * A universally unique identifier (UUID) for the revision of the resource-based policy from which
2095
2094
  * you want to remove permissions.
2096
2095
  * </p>
2096
+ * @public
2097
2097
  */
2098
2098
  revisionId: string | undefined;
2099
2099
  }
2100
2100
  /**
2101
- * @public
2102
2101
  * <p>The structure representing the <code>removePermissionResponse</code>.</p>
2102
+ * @public
2103
2103
  */
2104
2104
  export interface RemovePermissionResponse {
2105
2105
  /**
2106
- * @public
2107
2106
  * <p>
2108
2107
  * The JSON-formatted resource-based policy on the profiling group after
2109
2108
  * the specified permissions were removed.
2110
2109
  * </p>
2110
+ * @public
2111
2111
  */
2112
2112
  policy: string | undefined;
2113
2113
  /**
2114
- * @public
2115
2114
  * <p> A universally unique identifier (UUID) for the revision of the resource-based policy
2116
2115
  * after the specified permissions were removed. The updated JSON-formatted policy is in the
2117
2116
  * <code>policy</code> element of the response. </p>
2117
+ * @public
2118
2118
  */
2119
2119
  revisionId: string | undefined;
2120
2120
  }
2121
2121
  /**
2122
- * @public
2123
2122
  * <p>The structure representing the SubmitFeedbackRequest.</p>
2123
+ * @public
2124
2124
  */
2125
2125
  export interface SubmitFeedbackRequest {
2126
2126
  /**
2127
- * @public
2128
2127
  * <p>The name of the profiling group that is associated with the analysis data.</p>
2128
+ * @public
2129
2129
  */
2130
2130
  profilingGroupName: string | undefined;
2131
2131
  /**
2132
- * @public
2133
2132
  * <p>The universally unique identifier (UUID) of the
2134
2133
  * <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AnomalyInstance.html">
2135
2134
  * <code>AnomalyInstance</code>
2136
2135
  * </a> object
2137
2136
  * that is included in the analysis data.</p>
2137
+ * @public
2138
2138
  */
2139
2139
  anomalyInstanceId: string | undefined;
2140
2140
  /**
2141
- * @public
2142
2141
  * <p>
2143
2142
  * The feedback tpye. Thee are two valid values, <code>Positive</code> and <code>Negative</code>.
2144
2143
  * </p>
2144
+ * @public
2145
2145
  */
2146
2146
  type: FeedbackType | undefined;
2147
2147
  /**
2148
- * @public
2149
2148
  * <p>Optional feedback about this anomaly.</p>
2149
+ * @public
2150
2150
  */
2151
2151
  comment?: string;
2152
2152
  }
2153
2153
  /**
2154
- * @public
2155
2154
  * <p>The structure representing the SubmitFeedbackResponse.</p>
2155
+ * @public
2156
2156
  */
2157
2157
  export interface SubmitFeedbackResponse {
2158
2158
  }
2159
2159
  /**
2160
- * @public
2161
2160
  * <p>The structure representing the updateProfilingGroupRequest.</p>
2161
+ * @public
2162
2162
  */
2163
2163
  export interface UpdateProfilingGroupRequest {
2164
2164
  /**
2165
- * @public
2166
2165
  * <p>The name of the profiling group to update.</p>
2166
+ * @public
2167
2167
  */
2168
2168
  profilingGroupName: string | undefined;
2169
2169
  /**
2170
- * @public
2171
2170
  * <p>
2172
2171
  * Specifies whether profiling is enabled or disabled for a profiling group.
2173
2172
  * </p>
2173
+ * @public
2174
2174
  */
2175
2175
  agentOrchestrationConfig: AgentOrchestrationConfig | undefined;
2176
2176
  }
2177
2177
  /**
2178
- * @public
2179
2178
  * <p>The structure representing the updateProfilingGroupResponse.</p>
2179
+ * @public
2180
2180
  */
2181
2181
  export interface UpdateProfilingGroupResponse {
2182
2182
  /**
2183
- * @public
2184
2183
  * <p>
2185
2184
  * A <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html">
2186
2185
  * <code>ProfilingGroupDescription</code>
2187
2186
  * </a>
2188
2187
  * that contains information about the returned updated profiling group.
2189
2188
  * </p>
2189
+ * @public
2190
2190
  */
2191
2191
  profilingGroup: ProfilingGroupDescription | undefined;
2192
2192
  }
@@ -2195,17 +2195,17 @@ export interface UpdateProfilingGroupResponse {
2195
2195
  */
2196
2196
  export interface TagResourceRequest {
2197
2197
  /**
2198
- * @public
2199
2198
  * <p>
2200
2199
  * The Amazon Resource Name (ARN) of the resource that the tags are added to.
2201
2200
  * </p>
2201
+ * @public
2202
2202
  */
2203
2203
  resourceArn: string | undefined;
2204
2204
  /**
2205
- * @public
2206
2205
  * <p>
2207
2206
  * The list of tags that are added to the specified resource.
2208
2207
  * </p>
2208
+ * @public
2209
2209
  */
2210
2210
  tags: Record<string, string> | undefined;
2211
2211
  }
@@ -2219,18 +2219,18 @@ export interface TagResourceResponse {
2219
2219
  */
2220
2220
  export interface UntagResourceRequest {
2221
2221
  /**
2222
- * @public
2223
2222
  * <p>
2224
2223
  * The Amazon Resource Name (ARN) of the resource that contains the tags to remove.
2225
2224
  * </p>
2225
+ * @public
2226
2226
  */
2227
2227
  resourceArn: string | undefined;
2228
2228
  /**
2229
- * @public
2230
2229
  * <p>
2231
2230
  * A list of tag keys. Existing tags of resources with keys in this list are removed from
2232
2231
  * the specified resource.
2233
2232
  * </p>
2233
+ * @public
2234
2234
  */
2235
2235
  tagKeys: string[] | undefined;
2236
2236
  }