@aws-sdk/client-xray 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.
@@ -6,14 +6,17 @@ import { XRayServiceException as __BaseException } from "./XRayServiceException"
6
6
  */
7
7
  export interface Alias {
8
8
  /**
9
+ * @public
9
10
  * <p>The canonical name of the alias.</p>
10
11
  */
11
12
  Name?: string;
12
13
  /**
14
+ * @public
13
15
  * <p>A list of names for the alias, including the canonical name.</p>
14
16
  */
15
17
  Names?: string[];
16
18
  /**
19
+ * @public
17
20
  * <p>The type of the alias.</p>
18
21
  */
19
22
  Type?: string;
@@ -28,6 +31,7 @@ export type AnnotationValue = AnnotationValue.BooleanValueMember | AnnotationVal
28
31
  */
29
32
  export declare namespace AnnotationValue {
30
33
  /**
34
+ * @public
31
35
  * <p>Value for a Number annotation.</p>
32
36
  */
33
37
  interface NumberValueMember {
@@ -37,6 +41,7 @@ export declare namespace AnnotationValue {
37
41
  $unknown?: never;
38
42
  }
39
43
  /**
44
+ * @public
40
45
  * <p>Value for a Boolean annotation.</p>
41
46
  */
42
47
  interface BooleanValueMember {
@@ -46,6 +51,7 @@ export declare namespace AnnotationValue {
46
51
  $unknown?: never;
47
52
  }
48
53
  /**
54
+ * @public
49
55
  * <p>Value for a String annotation.</p>
50
56
  */
51
57
  interface StringValueMember {
@@ -54,6 +60,9 @@ export declare namespace AnnotationValue {
54
60
  StringValue: string;
55
61
  $unknown?: never;
56
62
  }
63
+ /**
64
+ * @public
65
+ */
57
66
  interface $UnknownMember {
58
67
  NumberValue?: never;
59
68
  BooleanValue?: never;
@@ -74,18 +83,22 @@ export declare namespace AnnotationValue {
74
83
  */
75
84
  export interface ServiceId {
76
85
  /**
86
+ * @public
77
87
  * <p></p>
78
88
  */
79
89
  Name?: string;
80
90
  /**
91
+ * @public
81
92
  * <p></p>
82
93
  */
83
94
  Names?: string[];
84
95
  /**
96
+ * @public
85
97
  * <p></p>
86
98
  */
87
99
  AccountId?: string;
88
100
  /**
101
+ * @public
89
102
  * <p></p>
90
103
  */
91
104
  Type?: string;
@@ -96,10 +109,12 @@ export interface ServiceId {
96
109
  */
97
110
  export interface ValueWithServiceIds {
98
111
  /**
112
+ * @public
99
113
  * <p>Values of the annotation.</p>
100
114
  */
101
115
  AnnotationValue?: AnnotationValue;
102
116
  /**
117
+ * @public
103
118
  * <p>Services to which the annotation applies.</p>
104
119
  */
105
120
  ServiceIds?: ServiceId[];
@@ -110,6 +125,7 @@ export interface ValueWithServiceIds {
110
125
  */
111
126
  export interface AnomalousService {
112
127
  /**
128
+ * @public
113
129
  * <p></p>
114
130
  */
115
131
  ServiceId?: ServiceId;
@@ -120,6 +136,7 @@ export interface AnomalousService {
120
136
  */
121
137
  export interface AvailabilityZoneDetail {
122
138
  /**
139
+ * @public
123
140
  * <p>The name of a corresponding Availability Zone.</p>
124
141
  */
125
142
  Name?: string;
@@ -129,10 +146,12 @@ export interface AvailabilityZoneDetail {
129
146
  */
130
147
  export interface BatchGetTracesRequest {
131
148
  /**
149
+ * @public
132
150
  * <p>Specify the trace IDs of requests for which to retrieve segments.</p>
133
151
  */
134
152
  TraceIds: string[] | undefined;
135
153
  /**
154
+ * @public
136
155
  * <p>Pagination token.</p>
137
156
  */
138
157
  NextToken?: string;
@@ -148,10 +167,12 @@ export interface BatchGetTracesRequest {
148
167
  */
149
168
  export interface Segment {
150
169
  /**
170
+ * @public
151
171
  * <p>The segment's ID.</p>
152
172
  */
153
173
  Id?: string;
154
174
  /**
175
+ * @public
155
176
  * <p>The segment document.</p>
156
177
  */
157
178
  Document?: string;
@@ -162,21 +183,25 @@ export interface Segment {
162
183
  */
163
184
  export interface Trace {
164
185
  /**
186
+ * @public
165
187
  * <p>The unique identifier for the request that generated the trace's segments and
166
188
  * subsegments.</p>
167
189
  */
168
190
  Id?: string;
169
191
  /**
192
+ * @public
170
193
  * <p>The length of time in seconds between the start time of the root segment and the end
171
194
  * time of the last segment that completed.</p>
172
195
  */
173
196
  Duration?: number;
174
197
  /**
198
+ * @public
175
199
  * <p>LimitExceeded is set to true when the trace has exceeded the <code>Trace document size</code> limit. For
176
200
  * more information about this limit and other X-Ray limits and quotas, see <a href="https://docs.aws.amazon.com/general/latest/gr/xray.html">Amazon Web Services X-Ray endpoints and quotas</a>.</p>
177
201
  */
178
202
  LimitExceeded?: boolean;
179
203
  /**
204
+ * @public
180
205
  * <p>Segment documents for the segments and subsegments that comprise the trace.</p>
181
206
  */
182
207
  Segments?: Segment[];
@@ -186,14 +211,17 @@ export interface Trace {
186
211
  */
187
212
  export interface BatchGetTracesResult {
188
213
  /**
214
+ * @public
189
215
  * <p>Full traces for the specified requests.</p>
190
216
  */
191
217
  Traces?: Trace[];
192
218
  /**
219
+ * @public
193
220
  * <p>Trace IDs of requests that haven't been processed.</p>
194
221
  */
195
222
  UnprocessedTraceIds?: string[];
196
223
  /**
224
+ * @public
197
225
  * <p>Pagination token.</p>
198
226
  */
199
227
  NextToken?: string;
@@ -230,11 +258,13 @@ export declare class ThrottledException extends __BaseException {
230
258
  */
231
259
  export interface InsightsConfiguration {
232
260
  /**
261
+ * @public
233
262
  * <p>Set the InsightsEnabled value to true to enable insights or false to disable
234
263
  * insights.</p>
235
264
  */
236
265
  InsightsEnabled?: boolean;
237
266
  /**
267
+ * @public
238
268
  * <p>Set the NotificationsEnabled value to true to enable insights notifications. Notifications can only be
239
269
  * enabled on a group with InsightsEnabled set to true.</p>
240
270
  */
@@ -261,6 +291,7 @@ export interface InsightsConfiguration {
261
291
  */
262
292
  export interface Tag {
263
293
  /**
294
+ * @public
264
295
  * <p>A tag key, such as <code>Stage</code> or <code>Name</code>. A tag key cannot be empty. The
265
296
  * key can be a maximum of 128 characters, and can contain only Unicode letters, numbers, or separators,
266
297
  * or the following special characters: <code>+ - = . _ : /</code>
@@ -268,6 +299,7 @@ export interface Tag {
268
299
  */
269
300
  Key: string | undefined;
270
301
  /**
302
+ * @public
271
303
  * <p>An optional tag value, such as <code>Production</code> or <code>test-only</code>. The value can be
272
304
  * a maximum of 255 characters, and contain only Unicode letters, numbers, or separators, or the following
273
305
  * special characters: <code>+ - = . _ : /</code>
@@ -280,15 +312,18 @@ export interface Tag {
280
312
  */
281
313
  export interface CreateGroupRequest {
282
314
  /**
315
+ * @public
283
316
  * <p>The case-sensitive name of the new group. Default is a reserved name and names must
284
317
  * be unique.</p>
285
318
  */
286
319
  GroupName: string | undefined;
287
320
  /**
321
+ * @public
288
322
  * <p>The filter expression defining criteria by which to group traces.</p>
289
323
  */
290
324
  FilterExpression?: string;
291
325
  /**
326
+ * @public
292
327
  * <p>The structure containing configurations related to insights.</p>
293
328
  * <ul>
294
329
  * <li>
@@ -304,6 +339,7 @@ export interface CreateGroupRequest {
304
339
  */
305
340
  InsightsConfiguration?: InsightsConfiguration;
306
341
  /**
342
+ * @public
307
343
  * <p>A map that contains one or more tag keys and tag values to attach to an X-Ray group.
308
344
  * For more information about ways to use tags, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services
309
345
  * resources</a> in the <i>Amazon Web Services General Reference</i>.</p>
@@ -339,18 +375,22 @@ export interface CreateGroupRequest {
339
375
  */
340
376
  export interface Group {
341
377
  /**
378
+ * @public
342
379
  * <p>The unique case-sensitive name of the group.</p>
343
380
  */
344
381
  GroupName?: string;
345
382
  /**
383
+ * @public
346
384
  * <p>The Amazon Resource Name (ARN) of the group generated based on the GroupName.</p>
347
385
  */
348
386
  GroupARN?: string;
349
387
  /**
388
+ * @public
350
389
  * <p>The filter expression defining the parameters to include traces.</p>
351
390
  */
352
391
  FilterExpression?: string;
353
392
  /**
393
+ * @public
354
394
  * <p>The structure containing configurations related to insights.</p>
355
395
  * <ul>
356
396
  * <li>
@@ -370,6 +410,7 @@ export interface Group {
370
410
  */
371
411
  export interface CreateGroupResult {
372
412
  /**
413
+ * @public
373
414
  * <p>The group that was created. Contains the name of the group that was created, the Amazon Resource Name
374
415
  * (ARN) of the group that was generated based on the group name, the filter expression, and the insight
375
416
  * configuration that was assigned to the group.</p>
@@ -384,56 +425,69 @@ export interface CreateGroupResult {
384
425
  */
385
426
  export interface SamplingRule {
386
427
  /**
428
+ * @public
387
429
  * <p>The name of the sampling rule. Specify a rule by either name or ARN, but not both.</p>
388
430
  */
389
431
  RuleName?: string;
390
432
  /**
433
+ * @public
391
434
  * <p>The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.</p>
392
435
  */
393
436
  RuleARN?: string;
394
437
  /**
438
+ * @public
395
439
  * <p>Matches the ARN of the Amazon Web Services resource on which the service runs.</p>
396
440
  */
397
441
  ResourceARN: string | undefined;
398
442
  /**
443
+ * @public
399
444
  * <p>The priority of the sampling rule.</p>
400
445
  */
401
446
  Priority: number | undefined;
402
447
  /**
448
+ * @public
403
449
  * <p>The percentage of matching requests to instrument, after the reservoir is
404
450
  * exhausted.</p>
405
451
  */
406
452
  FixedRate: number | undefined;
407
453
  /**
454
+ * @public
408
455
  * <p>A fixed number of matching requests to instrument per second, prior to applying the
409
456
  * fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.</p>
410
457
  */
411
458
  ReservoirSize: number | undefined;
412
459
  /**
460
+ * @public
413
461
  * <p>Matches the <code>name</code> that the service uses to identify itself in segments.</p>
414
462
  */
415
463
  ServiceName: string | undefined;
416
464
  /**
465
+ * @public
417
466
  * <p>Matches the <code>origin</code> that the service uses to identify its type in segments.</p>
418
467
  */
419
468
  ServiceType: string | undefined;
420
469
  /**
470
+ * @public
421
471
  * <p>Matches the hostname from a request URL.</p>
422
472
  */
423
473
  Host: string | undefined;
424
474
  /**
475
+ * @public
425
476
  * <p>Matches the HTTP method of a request.</p>
426
477
  */
427
478
  HTTPMethod: string | undefined;
428
479
  /**
480
+ * @public
429
481
  * <p>Matches the path from a request URL.</p>
430
482
  */
431
483
  URLPath: string | undefined;
432
484
  /**
485
+ * @public
433
486
  * <p>The version of the sampling rule format (<code>1</code>).</p>
434
487
  */
435
488
  Version: number | undefined;
436
489
  /**
490
+ * @public
437
491
  * <p>Matches attributes derived from the request.</p>
438
492
  */
439
493
  Attributes?: Record<string, string>;
@@ -443,10 +497,12 @@ export interface SamplingRule {
443
497
  */
444
498
  export interface CreateSamplingRuleRequest {
445
499
  /**
500
+ * @public
446
501
  * <p>The rule definition.</p>
447
502
  */
448
503
  SamplingRule: SamplingRule | undefined;
449
504
  /**
505
+ * @public
450
506
  * <p>A map that contains one or more tag keys and tag values to attach to an X-Ray sampling
451
507
  * rule. For more information about ways to use tags, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services
452
508
  * resources</a> in the <i>Amazon Web Services General Reference</i>.</p>
@@ -482,14 +538,17 @@ export interface CreateSamplingRuleRequest {
482
538
  */
483
539
  export interface SamplingRuleRecord {
484
540
  /**
541
+ * @public
485
542
  * <p>The sampling rule.</p>
486
543
  */
487
544
  SamplingRule?: SamplingRule;
488
545
  /**
546
+ * @public
489
547
  * <p>When the rule was created.</p>
490
548
  */
491
549
  CreatedAt?: Date;
492
550
  /**
551
+ * @public
493
552
  * <p>When the rule was last modified.</p>
494
553
  */
495
554
  ModifiedAt?: Date;
@@ -499,6 +558,7 @@ export interface SamplingRuleRecord {
499
558
  */
500
559
  export interface CreateSamplingRuleResult {
501
560
  /**
561
+ * @public
502
562
  * <p>The saved rule definition and metadata.</p>
503
563
  */
504
564
  SamplingRuleRecord?: SamplingRuleRecord;
@@ -521,10 +581,12 @@ export declare class RuleLimitExceededException extends __BaseException {
521
581
  */
522
582
  export interface DeleteGroupRequest {
523
583
  /**
584
+ * @public
524
585
  * <p>The case-sensitive name of the group.</p>
525
586
  */
526
587
  GroupName?: string;
527
588
  /**
589
+ * @public
528
590
  * <p>The ARN of the group that was generated on creation.</p>
529
591
  */
530
592
  GroupARN?: string;
@@ -539,10 +601,12 @@ export interface DeleteGroupResult {
539
601
  */
540
602
  export interface DeleteResourcePolicyRequest {
541
603
  /**
604
+ * @public
542
605
  * <p>The name of the resource policy to delete.</p>
543
606
  */
544
607
  PolicyName: string | undefined;
545
608
  /**
609
+ * @public
546
610
  * <p>Specifies a specific policy revision to delete. Provide a <code>PolicyRevisionId</code> to ensure an atomic delete operation. If the provided revision id does
547
611
  * not match the latest policy revision id, an <code>InvalidPolicyRevisionIdException</code> exception is returned.
548
612
  * </p>
@@ -573,10 +637,12 @@ export declare class InvalidPolicyRevisionIdException extends __BaseException {
573
637
  */
574
638
  export interface DeleteSamplingRuleRequest {
575
639
  /**
640
+ * @public
576
641
  * <p>The name of the sampling rule. Specify a rule by either name or ARN, but not both.</p>
577
642
  */
578
643
  RuleName?: string;
579
644
  /**
645
+ * @public
580
646
  * <p>The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.</p>
581
647
  */
582
648
  RuleARN?: string;
@@ -586,6 +652,7 @@ export interface DeleteSamplingRuleRequest {
586
652
  */
587
653
  export interface DeleteSamplingRuleResult {
588
654
  /**
655
+ * @public
589
656
  * <p>The deleted rule definition and metadata.</p>
590
657
  */
591
658
  SamplingRuleRecord?: SamplingRuleRecord;
@@ -625,14 +692,17 @@ export type EncryptionType = (typeof EncryptionType)[keyof typeof EncryptionType
625
692
  */
626
693
  export interface EncryptionConfig {
627
694
  /**
695
+ * @public
628
696
  * <p>The ID of the KMS key used for encryption, if applicable.</p>
629
697
  */
630
698
  KeyId?: string;
631
699
  /**
700
+ * @public
632
701
  * <p>The encryption status. While the status is <code>UPDATING</code>, X-Ray may encrypt data with a combination of the new and old settings.</p>
633
702
  */
634
703
  Status?: EncryptionStatus | string;
635
704
  /**
705
+ * @public
636
706
  * <p>The type of encryption. Set to <code>KMS</code> for encryption with KMS keys. Set to <code>NONE</code> for
637
707
  * default encryption.</p>
638
708
  */
@@ -643,6 +713,7 @@ export interface EncryptionConfig {
643
713
  */
644
714
  export interface GetEncryptionConfigResult {
645
715
  /**
716
+ * @public
646
717
  * <p>The encryption configuration document.</p>
647
718
  */
648
719
  EncryptionConfig?: EncryptionConfig;
@@ -652,10 +723,12 @@ export interface GetEncryptionConfigResult {
652
723
  */
653
724
  export interface GetGroupRequest {
654
725
  /**
726
+ * @public
655
727
  * <p>The case-sensitive name of the group.</p>
656
728
  */
657
729
  GroupName?: string;
658
730
  /**
731
+ * @public
659
732
  * <p>The ARN of the group that was generated on creation.</p>
660
733
  */
661
734
  GroupARN?: string;
@@ -665,6 +738,7 @@ export interface GetGroupRequest {
665
738
  */
666
739
  export interface GetGroupResult {
667
740
  /**
741
+ * @public
668
742
  * <p>The group that was requested. Contains the name of the group, the ARN of the group,
669
743
  * the filter expression, and the insight configuration assigned to the group.</p>
670
744
  */
@@ -675,6 +749,7 @@ export interface GetGroupResult {
675
749
  */
676
750
  export interface GetGroupsRequest {
677
751
  /**
752
+ * @public
678
753
  * <p>Pagination token.</p>
679
754
  */
680
755
  NextToken?: string;
@@ -685,18 +760,22 @@ export interface GetGroupsRequest {
685
760
  */
686
761
  export interface GroupSummary {
687
762
  /**
763
+ * @public
688
764
  * <p>The unique case-sensitive name of the group.</p>
689
765
  */
690
766
  GroupName?: string;
691
767
  /**
768
+ * @public
692
769
  * <p>The ARN of the group generated based on the GroupName.</p>
693
770
  */
694
771
  GroupARN?: string;
695
772
  /**
773
+ * @public
696
774
  * <p>The filter expression defining the parameters to include traces.</p>
697
775
  */
698
776
  FilterExpression?: string;
699
777
  /**
778
+ * @public
700
779
  * <p>The structure containing configurations related to insights.</p>
701
780
  * <ul>
702
781
  * <li>
@@ -716,10 +795,12 @@ export interface GroupSummary {
716
795
  */
717
796
  export interface GetGroupsResult {
718
797
  /**
798
+ * @public
719
799
  * <p>The collection of all active groups.</p>
720
800
  */
721
801
  Groups?: GroupSummary[];
722
802
  /**
803
+ * @public
723
804
  * <p>Pagination token.</p>
724
805
  */
725
806
  NextToken?: string;
@@ -729,6 +810,7 @@ export interface GetGroupsResult {
729
810
  */
730
811
  export interface GetInsightRequest {
731
812
  /**
813
+ * @public
732
814
  * <p>The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.</p>
733
815
  */
734
816
  InsightId: string | undefined;
@@ -750,14 +832,17 @@ export type InsightCategory = (typeof InsightCategory)[keyof typeof InsightCateg
750
832
  */
751
833
  export interface RequestImpactStatistics {
752
834
  /**
835
+ * @public
753
836
  * <p>The number of requests that have resulted in a fault,</p>
754
837
  */
755
838
  FaultCount?: number;
756
839
  /**
840
+ * @public
757
841
  * <p>The number of successful requests.</p>
758
842
  */
759
843
  OkCount?: number;
760
844
  /**
845
+ * @public
761
846
  * <p>The total number of requests to the service.</p>
762
847
  */
763
848
  TotalCount?: number;
@@ -781,52 +866,64 @@ export type InsightState = (typeof InsightState)[keyof typeof InsightState];
781
866
  */
782
867
  export interface Insight {
783
868
  /**
869
+ * @public
784
870
  * <p>The insights unique identifier. </p>
785
871
  */
786
872
  InsightId?: string;
787
873
  /**
874
+ * @public
788
875
  * <p>The Amazon Resource Name (ARN) of the group that the insight belongs to.</p>
789
876
  */
790
877
  GroupARN?: string;
791
878
  /**
879
+ * @public
792
880
  * <p>The name of the group that the insight belongs to.</p>
793
881
  */
794
882
  GroupName?: string;
795
883
  /**
884
+ * @public
796
885
  * <p></p>
797
886
  */
798
887
  RootCauseServiceId?: ServiceId;
799
888
  /**
889
+ * @public
800
890
  * <p>The categories that label and describe the type of insight.</p>
801
891
  */
802
892
  Categories?: (InsightCategory | string)[];
803
893
  /**
894
+ * @public
804
895
  * <p>The current state of the insight.</p>
805
896
  */
806
897
  State?: InsightState | string;
807
898
  /**
899
+ * @public
808
900
  * <p>The time, in Unix seconds, at which the insight began.</p>
809
901
  */
810
902
  StartTime?: Date;
811
903
  /**
904
+ * @public
812
905
  * <p>The time, in Unix seconds, at which the insight ended.</p>
813
906
  */
814
907
  EndTime?: Date;
815
908
  /**
909
+ * @public
816
910
  * <p>A brief description of the insight.</p>
817
911
  */
818
912
  Summary?: string;
819
913
  /**
914
+ * @public
820
915
  * <p>The impact statistics of the client side service. This includes the number of requests to the client service
821
916
  * and whether the requests were faults or okay.</p>
822
917
  */
823
918
  ClientRequestImpactStatistics?: RequestImpactStatistics;
824
919
  /**
920
+ * @public
825
921
  * <p>The impact statistics of the root cause service. This includes the number of requests to the client service
826
922
  * and whether the requests were faults or okay.</p>
827
923
  */
828
924
  RootCauseServiceRequestImpactStatistics?: RequestImpactStatistics;
829
925
  /**
926
+ * @public
830
927
  * <p>The service within the insight that is most impacted by the incident.</p>
831
928
  */
832
929
  TopAnomalousServices?: AnomalousService[];
@@ -836,6 +933,7 @@ export interface Insight {
836
933
  */
837
934
  export interface GetInsightResult {
838
935
  /**
936
+ * @public
839
937
  * <p>The summary information of an insight.</p>
840
938
  */
841
939
  Insight?: Insight;
@@ -845,14 +943,17 @@ export interface GetInsightResult {
845
943
  */
846
944
  export interface GetInsightEventsRequest {
847
945
  /**
946
+ * @public
848
947
  * <p>The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.</p>
849
948
  */
850
949
  InsightId: string | undefined;
851
950
  /**
951
+ * @public
852
952
  * <p>Used to retrieve at most the specified value of events.</p>
853
953
  */
854
954
  MaxResults?: number;
855
955
  /**
956
+ * @public
856
957
  * <p>Specify the pagination token returned by a previous request to retrieve the next page of events. </p>
857
958
  */
858
959
  NextToken?: string;
@@ -864,24 +965,29 @@ export interface GetInsightEventsRequest {
864
965
  */
865
966
  export interface InsightEvent {
866
967
  /**
968
+ * @public
867
969
  * <p>A brief description of the event.</p>
868
970
  */
869
971
  Summary?: string;
870
972
  /**
973
+ * @public
871
974
  * <p>The time, in Unix seconds, at which the event was recorded.</p>
872
975
  */
873
976
  EventTime?: Date;
874
977
  /**
978
+ * @public
875
979
  * <p>The impact statistics of the client side service. This includes the number of requests to the client service
876
980
  * and whether the requests were faults or okay.</p>
877
981
  */
878
982
  ClientRequestImpactStatistics?: RequestImpactStatistics;
879
983
  /**
984
+ * @public
880
985
  * <p>The impact statistics of the root cause service. This includes the number of requests to the client service
881
986
  * and whether the requests were faults or okay.</p>
882
987
  */
883
988
  RootCauseServiceRequestImpactStatistics?: RequestImpactStatistics;
884
989
  /**
990
+ * @public
885
991
  * <p>The service during the event that is most impacted by the incident.</p>
886
992
  */
887
993
  TopAnomalousServices?: AnomalousService[];
@@ -891,12 +997,14 @@ export interface InsightEvent {
891
997
  */
892
998
  export interface GetInsightEventsResult {
893
999
  /**
1000
+ * @public
894
1001
  * <p>A detailed description of the event. This includes the time of the event, client and
895
1002
  * root cause impact statistics, and the top anomalous service at the time of the
896
1003
  * event.</p>
897
1004
  */
898
1005
  InsightEvents?: InsightEvent[];
899
1006
  /**
1007
+ * @public
900
1008
  * <p>Use this token to retrieve the next page of insight events.</p>
901
1009
  */
902
1010
  NextToken?: string;
@@ -906,20 +1014,24 @@ export interface GetInsightEventsResult {
906
1014
  */
907
1015
  export interface GetInsightImpactGraphRequest {
908
1016
  /**
1017
+ * @public
909
1018
  * <p>The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.</p>
910
1019
  */
911
1020
  InsightId: string | undefined;
912
1021
  /**
1022
+ * @public
913
1023
  * <p>The estimated start time of the insight, in Unix time seconds. The StartTime is inclusive of the value
914
1024
  * provided and can't be more than 30 days old.</p>
915
1025
  */
916
1026
  StartTime: Date | undefined;
917
1027
  /**
1028
+ * @public
918
1029
  * <p>The estimated end time of the insight, in Unix time seconds. The EndTime is exclusive of the value provided.
919
1030
  * The time range between the start time and end time can't be more than six hours. </p>
920
1031
  */
921
1032
  EndTime: Date | undefined;
922
1033
  /**
1034
+ * @public
923
1035
  * <p>Specify the pagination token returned by a previous request to retrieve the next page of results. </p>
924
1036
  */
925
1037
  NextToken?: string;
@@ -930,6 +1042,7 @@ export interface GetInsightImpactGraphRequest {
930
1042
  */
931
1043
  export interface InsightImpactGraphEdge {
932
1044
  /**
1045
+ * @public
933
1046
  * <p>Identifier of the edge. Unique within a service map.</p>
934
1047
  */
935
1048
  ReferenceId?: number;
@@ -941,10 +1054,12 @@ export interface InsightImpactGraphEdge {
941
1054
  */
942
1055
  export interface InsightImpactGraphService {
943
1056
  /**
1057
+ * @public
944
1058
  * <p>Identifier for the service. Unique within the service map.</p>
945
1059
  */
946
1060
  ReferenceId?: number;
947
1061
  /**
1062
+ * @public
948
1063
  * <p>Identifier for the service. Unique within the service map.</p>
949
1064
  * <ul>
950
1065
  * <li>
@@ -966,18 +1081,22 @@ export interface InsightImpactGraphService {
966
1081
  */
967
1082
  Type?: string;
968
1083
  /**
1084
+ * @public
969
1085
  * <p>The canonical name of the service.</p>
970
1086
  */
971
1087
  Name?: string;
972
1088
  /**
1089
+ * @public
973
1090
  * <p>A list of names for the service, including the canonical name.</p>
974
1091
  */
975
1092
  Names?: string[];
976
1093
  /**
1094
+ * @public
977
1095
  * <p>Identifier of the Amazon Web Services account in which the service runs.</p>
978
1096
  */
979
1097
  AccountId?: string;
980
1098
  /**
1099
+ * @public
981
1100
  * <p>Connections to downstream services.</p>
982
1101
  */
983
1102
  Edges?: InsightImpactGraphEdge[];
@@ -987,30 +1106,37 @@ export interface InsightImpactGraphService {
987
1106
  */
988
1107
  export interface GetInsightImpactGraphResult {
989
1108
  /**
1109
+ * @public
990
1110
  * <p>The insight's unique identifier.</p>
991
1111
  */
992
1112
  InsightId?: string;
993
1113
  /**
1114
+ * @public
994
1115
  * <p>The provided start time.</p>
995
1116
  */
996
1117
  StartTime?: Date;
997
1118
  /**
1119
+ * @public
998
1120
  * <p>The provided end time. </p>
999
1121
  */
1000
1122
  EndTime?: Date;
1001
1123
  /**
1124
+ * @public
1002
1125
  * <p>The time, in Unix seconds, at which the service graph started.</p>
1003
1126
  */
1004
1127
  ServiceGraphStartTime?: Date;
1005
1128
  /**
1129
+ * @public
1006
1130
  * <p>The time, in Unix seconds, at which the service graph ended.</p>
1007
1131
  */
1008
1132
  ServiceGraphEndTime?: Date;
1009
1133
  /**
1134
+ * @public
1010
1135
  * <p>The Amazon Web Services instrumented services related to the insight.</p>
1011
1136
  */
1012
1137
  Services?: InsightImpactGraphService[];
1013
1138
  /**
1139
+ * @public
1014
1140
  * <p>Pagination token.</p>
1015
1141
  */
1016
1142
  NextToken?: string;
@@ -1020,31 +1146,38 @@ export interface GetInsightImpactGraphResult {
1020
1146
  */
1021
1147
  export interface GetInsightSummariesRequest {
1022
1148
  /**
1149
+ * @public
1023
1150
  * <p>The list of insight states. </p>
1024
1151
  */
1025
1152
  States?: (InsightState | string)[];
1026
1153
  /**
1154
+ * @public
1027
1155
  * <p>The Amazon Resource Name (ARN) of the group. Required if the GroupName isn't provided.</p>
1028
1156
  */
1029
1157
  GroupARN?: string;
1030
1158
  /**
1159
+ * @public
1031
1160
  * <p>The name of the group. Required if the GroupARN isn't provided.</p>
1032
1161
  */
1033
1162
  GroupName?: string;
1034
1163
  /**
1164
+ * @public
1035
1165
  * <p>The beginning of the time frame in which the insights started. The start time can't be more than 30 days
1036
1166
  * old.</p>
1037
1167
  */
1038
1168
  StartTime: Date | undefined;
1039
1169
  /**
1170
+ * @public
1040
1171
  * <p>The end of the time frame in which the insights ended. The end time can't be more than 30 days old.</p>
1041
1172
  */
1042
1173
  EndTime: Date | undefined;
1043
1174
  /**
1175
+ * @public
1044
1176
  * <p>The maximum number of results to display.</p>
1045
1177
  */
1046
1178
  MaxResults?: number;
1047
1179
  /**
1180
+ * @public
1048
1181
  * <p>Pagination token.</p>
1049
1182
  */
1050
1183
  NextToken?: string;
@@ -1055,56 +1188,69 @@ export interface GetInsightSummariesRequest {
1055
1188
  */
1056
1189
  export interface InsightSummary {
1057
1190
  /**
1191
+ * @public
1058
1192
  * <p>The insights unique identifier. </p>
1059
1193
  */
1060
1194
  InsightId?: string;
1061
1195
  /**
1196
+ * @public
1062
1197
  * <p>The Amazon Resource Name (ARN) of the group that the insight belongs to.</p>
1063
1198
  */
1064
1199
  GroupARN?: string;
1065
1200
  /**
1201
+ * @public
1066
1202
  * <p>The name of the group that the insight belongs to.</p>
1067
1203
  */
1068
1204
  GroupName?: string;
1069
1205
  /**
1206
+ * @public
1070
1207
  * <p></p>
1071
1208
  */
1072
1209
  RootCauseServiceId?: ServiceId;
1073
1210
  /**
1211
+ * @public
1074
1212
  * <p> Categories The categories that label and describe the type of insight.</p>
1075
1213
  */
1076
1214
  Categories?: (InsightCategory | string)[];
1077
1215
  /**
1216
+ * @public
1078
1217
  * <p>The current state of the insight.</p>
1079
1218
  */
1080
1219
  State?: InsightState | string;
1081
1220
  /**
1221
+ * @public
1082
1222
  * <p>The time, in Unix seconds, at which the insight began.</p>
1083
1223
  */
1084
1224
  StartTime?: Date;
1085
1225
  /**
1226
+ * @public
1086
1227
  * <p>The time, in Unix seconds, at which the insight ended.</p>
1087
1228
  */
1088
1229
  EndTime?: Date;
1089
1230
  /**
1231
+ * @public
1090
1232
  * <p>A brief description of the insight.</p>
1091
1233
  */
1092
1234
  Summary?: string;
1093
1235
  /**
1236
+ * @public
1094
1237
  * <p>The impact statistics of the client side service. This includes the number of requests
1095
1238
  * to the client service and whether the requests were faults or okay. </p>
1096
1239
  */
1097
1240
  ClientRequestImpactStatistics?: RequestImpactStatistics;
1098
1241
  /**
1242
+ * @public
1099
1243
  * <p>The impact statistics of the root cause service. This includes the number of requests to
1100
1244
  * the client service and whether the requests were faults or okay. </p>
1101
1245
  */
1102
1246
  RootCauseServiceRequestImpactStatistics?: RequestImpactStatistics;
1103
1247
  /**
1248
+ * @public
1104
1249
  * <p>The service within the insight that is most impacted by the incident.</p>
1105
1250
  */
1106
1251
  TopAnomalousServices?: AnomalousService[];
1107
1252
  /**
1253
+ * @public
1108
1254
  * <p>The time, in Unix seconds, that the insight was last updated.</p>
1109
1255
  */
1110
1256
  LastUpdateTime?: Date;
@@ -1114,12 +1260,14 @@ export interface InsightSummary {
1114
1260
  */
1115
1261
  export interface GetInsightSummariesResult {
1116
1262
  /**
1263
+ * @public
1117
1264
  * <p>The summary of each insight within the group matching the provided filters. The summary
1118
1265
  * contains the InsightID, start and end time, the root cause service, the root cause and
1119
1266
  * client impact statistics, the top anomalous services, and the status of the insight.</p>
1120
1267
  */
1121
1268
  InsightSummaries?: InsightSummary[];
1122
1269
  /**
1270
+ * @public
1123
1271
  * <p>Pagination token.</p>
1124
1272
  */
1125
1273
  NextToken?: string;
@@ -1129,6 +1277,7 @@ export interface GetInsightSummariesResult {
1129
1277
  */
1130
1278
  export interface GetSamplingRulesRequest {
1131
1279
  /**
1280
+ * @public
1132
1281
  * <p>Pagination token.</p>
1133
1282
  */
1134
1283
  NextToken?: string;
@@ -1138,10 +1287,12 @@ export interface GetSamplingRulesRequest {
1138
1287
  */
1139
1288
  export interface GetSamplingRulesResult {
1140
1289
  /**
1290
+ * @public
1141
1291
  * <p>Rule definitions and metadata.</p>
1142
1292
  */
1143
1293
  SamplingRuleRecords?: SamplingRuleRecord[];
1144
1294
  /**
1295
+ * @public
1145
1296
  * <p>Pagination token.</p>
1146
1297
  */
1147
1298
  NextToken?: string;
@@ -1151,6 +1302,7 @@ export interface GetSamplingRulesResult {
1151
1302
  */
1152
1303
  export interface GetSamplingStatisticSummariesRequest {
1153
1304
  /**
1305
+ * @public
1154
1306
  * <p>Pagination token.</p>
1155
1307
  */
1156
1308
  NextToken?: string;
@@ -1161,22 +1313,27 @@ export interface GetSamplingStatisticSummariesRequest {
1161
1313
  */
1162
1314
  export interface SamplingStatisticSummary {
1163
1315
  /**
1316
+ * @public
1164
1317
  * <p>The name of the sampling rule.</p>
1165
1318
  */
1166
1319
  RuleName?: string;
1167
1320
  /**
1321
+ * @public
1168
1322
  * <p>The start time of the reporting window.</p>
1169
1323
  */
1170
1324
  Timestamp?: Date;
1171
1325
  /**
1326
+ * @public
1172
1327
  * <p>The number of requests that matched the rule.</p>
1173
1328
  */
1174
1329
  RequestCount?: number;
1175
1330
  /**
1331
+ * @public
1176
1332
  * <p>The number of requests recorded with borrowed reservoir quota.</p>
1177
1333
  */
1178
1334
  BorrowCount?: number;
1179
1335
  /**
1336
+ * @public
1180
1337
  * <p>The number of requests recorded.</p>
1181
1338
  */
1182
1339
  SampledCount?: number;
@@ -1186,11 +1343,13 @@ export interface SamplingStatisticSummary {
1186
1343
  */
1187
1344
  export interface GetSamplingStatisticSummariesResult {
1188
1345
  /**
1346
+ * @public
1189
1347
  * <p>Information about the number of requests instrumented for each sampling
1190
1348
  * rule.</p>
1191
1349
  */
1192
1350
  SamplingStatisticSummaries?: SamplingStatisticSummary[];
1193
1351
  /**
1352
+ * @public
1194
1353
  * <p>Pagination token.</p>
1195
1354
  */
1196
1355
  NextToken?: string;
@@ -1203,26 +1362,32 @@ export interface GetSamplingStatisticSummariesResult {
1203
1362
  */
1204
1363
  export interface SamplingStatisticsDocument {
1205
1364
  /**
1365
+ * @public
1206
1366
  * <p>The name of the sampling rule.</p>
1207
1367
  */
1208
1368
  RuleName: string | undefined;
1209
1369
  /**
1370
+ * @public
1210
1371
  * <p>A unique identifier for the service in hexadecimal.</p>
1211
1372
  */
1212
1373
  ClientID: string | undefined;
1213
1374
  /**
1375
+ * @public
1214
1376
  * <p>The current time.</p>
1215
1377
  */
1216
1378
  Timestamp: Date | undefined;
1217
1379
  /**
1380
+ * @public
1218
1381
  * <p>The number of requests that matched the rule.</p>
1219
1382
  */
1220
1383
  RequestCount: number | undefined;
1221
1384
  /**
1385
+ * @public
1222
1386
  * <p>The number of requests recorded.</p>
1223
1387
  */
1224
1388
  SampledCount: number | undefined;
1225
1389
  /**
1390
+ * @public
1226
1391
  * <p>The number of requests recorded with borrowed reservoir quota.</p>
1227
1392
  */
1228
1393
  BorrowCount?: number;
@@ -1232,6 +1397,7 @@ export interface SamplingStatisticsDocument {
1232
1397
  */
1233
1398
  export interface GetSamplingTargetsRequest {
1234
1399
  /**
1400
+ * @public
1235
1401
  * <p>Information about rules that the service is using to sample requests.</p>
1236
1402
  */
1237
1403
  SamplingStatisticsDocuments: SamplingStatisticsDocument[] | undefined;
@@ -1244,23 +1410,28 @@ export interface GetSamplingTargetsRequest {
1244
1410
  */
1245
1411
  export interface SamplingTargetDocument {
1246
1412
  /**
1413
+ * @public
1247
1414
  * <p>The name of the sampling rule.</p>
1248
1415
  */
1249
1416
  RuleName?: string;
1250
1417
  /**
1418
+ * @public
1251
1419
  * <p>The percentage of matching requests to instrument, after the reservoir is
1252
1420
  * exhausted.</p>
1253
1421
  */
1254
1422
  FixedRate?: number;
1255
1423
  /**
1424
+ * @public
1256
1425
  * <p>The number of requests per second that X-Ray allocated for this service.</p>
1257
1426
  */
1258
1427
  ReservoirQuota?: number;
1259
1428
  /**
1429
+ * @public
1260
1430
  * <p>When the reservoir quota expires.</p>
1261
1431
  */
1262
1432
  ReservoirQuotaTTL?: Date;
1263
1433
  /**
1434
+ * @public
1264
1435
  * <p>The number of seconds for the service to wait before getting sampling targets
1265
1436
  * again.</p>
1266
1437
  */
@@ -1273,14 +1444,17 @@ export interface SamplingTargetDocument {
1273
1444
  */
1274
1445
  export interface UnprocessedStatistics {
1275
1446
  /**
1447
+ * @public
1276
1448
  * <p>The name of the sampling rule.</p>
1277
1449
  */
1278
1450
  RuleName?: string;
1279
1451
  /**
1452
+ * @public
1280
1453
  * <p>The error code.</p>
1281
1454
  */
1282
1455
  ErrorCode?: string;
1283
1456
  /**
1457
+ * @public
1284
1458
  * <p>The error message.</p>
1285
1459
  */
1286
1460
  Message?: string;
@@ -1290,16 +1464,19 @@ export interface UnprocessedStatistics {
1290
1464
  */
1291
1465
  export interface GetSamplingTargetsResult {
1292
1466
  /**
1467
+ * @public
1293
1468
  * <p>Updated rules that the service should use to sample requests.</p>
1294
1469
  */
1295
1470
  SamplingTargetDocuments?: SamplingTargetDocument[];
1296
1471
  /**
1472
+ * @public
1297
1473
  * <p>The last time a user changed the sampling rule configuration. If
1298
1474
  * the sampling rule configuration changed since the service last retrieved it, the service
1299
1475
  * should call <a href="https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingRules.html">GetSamplingRules</a> to get the latest version.</p>
1300
1476
  */
1301
1477
  LastRuleModification?: Date;
1302
1478
  /**
1479
+ * @public
1303
1480
  * <p>Information about <a href="https://docs.aws.amazon.com/xray/latest/api/API_SamplingStatisticsDocument.html">SamplingStatisticsDocument</a> that X-Ray could not
1304
1481
  * process.</p>
1305
1482
  */
@@ -1310,22 +1487,27 @@ export interface GetSamplingTargetsResult {
1310
1487
  */
1311
1488
  export interface GetServiceGraphRequest {
1312
1489
  /**
1490
+ * @public
1313
1491
  * <p>The start of the time frame for which to generate a graph.</p>
1314
1492
  */
1315
1493
  StartTime: Date | undefined;
1316
1494
  /**
1495
+ * @public
1317
1496
  * <p>The end of the timeframe for which to generate a graph.</p>
1318
1497
  */
1319
1498
  EndTime: Date | undefined;
1320
1499
  /**
1500
+ * @public
1321
1501
  * <p>The name of a group based on which you want to generate a graph.</p>
1322
1502
  */
1323
1503
  GroupName?: string;
1324
1504
  /**
1505
+ * @public
1325
1506
  * <p>The Amazon Resource Name (ARN) of a group based on which you want to generate a graph.</p>
1326
1507
  */
1327
1508
  GroupARN?: string;
1328
1509
  /**
1510
+ * @public
1329
1511
  * <p>Pagination token.</p>
1330
1512
  */
1331
1513
  NextToken?: string;
@@ -1337,10 +1519,12 @@ export interface GetServiceGraphRequest {
1337
1519
  */
1338
1520
  export interface HistogramEntry {
1339
1521
  /**
1522
+ * @public
1340
1523
  * <p>The value of the entry.</p>
1341
1524
  */
1342
1525
  Value?: number;
1343
1526
  /**
1527
+ * @public
1344
1528
  * <p>The prevalence of the entry.</p>
1345
1529
  */
1346
1530
  Count?: number;
@@ -1351,15 +1535,18 @@ export interface HistogramEntry {
1351
1535
  */
1352
1536
  export interface ErrorStatistics {
1353
1537
  /**
1538
+ * @public
1354
1539
  * <p>The number of requests that failed with a 419 throttling status code.</p>
1355
1540
  */
1356
1541
  ThrottleCount?: number;
1357
1542
  /**
1543
+ * @public
1358
1544
  * <p>The number of requests that failed with untracked 4xx Client Error status
1359
1545
  * codes.</p>
1360
1546
  */
1361
1547
  OtherCount?: number;
1362
1548
  /**
1549
+ * @public
1363
1550
  * <p>The total number of requests that failed with a 4xx Client Error status code.</p>
1364
1551
  */
1365
1552
  TotalCount?: number;
@@ -1370,11 +1557,13 @@ export interface ErrorStatistics {
1370
1557
  */
1371
1558
  export interface FaultStatistics {
1372
1559
  /**
1560
+ * @public
1373
1561
  * <p>The number of requests that failed with untracked 5xx Server Error status
1374
1562
  * codes.</p>
1375
1563
  */
1376
1564
  OtherCount?: number;
1377
1565
  /**
1566
+ * @public
1378
1567
  * <p>The total number of requests that failed with a 5xx Server Error status code.</p>
1379
1568
  */
1380
1569
  TotalCount?: number;
@@ -1385,22 +1574,27 @@ export interface FaultStatistics {
1385
1574
  */
1386
1575
  export interface EdgeStatistics {
1387
1576
  /**
1577
+ * @public
1388
1578
  * <p>The number of requests that completed with a 2xx Success status code.</p>
1389
1579
  */
1390
1580
  OkCount?: number;
1391
1581
  /**
1582
+ * @public
1392
1583
  * <p>Information about requests that failed with a 4xx Client Error status code.</p>
1393
1584
  */
1394
1585
  ErrorStatistics?: ErrorStatistics;
1395
1586
  /**
1587
+ * @public
1396
1588
  * <p>Information about requests that failed with a 5xx Server Error status code.</p>
1397
1589
  */
1398
1590
  FaultStatistics?: FaultStatistics;
1399
1591
  /**
1592
+ * @public
1400
1593
  * <p>The total number of completed requests.</p>
1401
1594
  */
1402
1595
  TotalCount?: number;
1403
1596
  /**
1597
+ * @public
1404
1598
  * <p>The aggregate response time of completed requests.</p>
1405
1599
  */
1406
1600
  TotalResponseTime?: number;
@@ -1413,35 +1607,43 @@ export interface EdgeStatistics {
1413
1607
  */
1414
1608
  export interface Edge {
1415
1609
  /**
1610
+ * @public
1416
1611
  * <p>Identifier of the edge. Unique within a service map.</p>
1417
1612
  */
1418
1613
  ReferenceId?: number;
1419
1614
  /**
1615
+ * @public
1420
1616
  * <p>The start time of the first segment on the edge.</p>
1421
1617
  */
1422
1618
  StartTime?: Date;
1423
1619
  /**
1620
+ * @public
1424
1621
  * <p>The end time of the last segment on the edge.</p>
1425
1622
  */
1426
1623
  EndTime?: Date;
1427
1624
  /**
1625
+ * @public
1428
1626
  * <p>Response statistics for segments on the edge.</p>
1429
1627
  */
1430
1628
  SummaryStatistics?: EdgeStatistics;
1431
1629
  /**
1630
+ * @public
1432
1631
  * <p>A histogram that maps the spread of client response times on an edge. Only populated
1433
1632
  * for synchronous edges.</p>
1434
1633
  */
1435
1634
  ResponseTimeHistogram?: HistogramEntry[];
1436
1635
  /**
1636
+ * @public
1437
1637
  * <p>Aliases for the edge.</p>
1438
1638
  */
1439
1639
  Aliases?: Alias[];
1440
1640
  /**
1641
+ * @public
1441
1642
  * <p>Describes an asynchronous connection, with a value of <code>link</code>.</p>
1442
1643
  */
1443
1644
  EdgeType?: string;
1444
1645
  /**
1646
+ * @public
1445
1647
  * <p>A histogram that maps the spread of event age when received by consumers.
1446
1648
  * Age is calculated each time an event is received. Only populated when <i>EdgeType</i> is
1447
1649
  * <code>link</code>.</p>
@@ -1454,22 +1656,27 @@ export interface Edge {
1454
1656
  */
1455
1657
  export interface ServiceStatistics {
1456
1658
  /**
1659
+ * @public
1457
1660
  * <p>The number of requests that completed with a 2xx Success status code.</p>
1458
1661
  */
1459
1662
  OkCount?: number;
1460
1663
  /**
1664
+ * @public
1461
1665
  * <p>Information about requests that failed with a 4xx Client Error status code.</p>
1462
1666
  */
1463
1667
  ErrorStatistics?: ErrorStatistics;
1464
1668
  /**
1669
+ * @public
1465
1670
  * <p>Information about requests that failed with a 5xx Server Error status code.</p>
1466
1671
  */
1467
1672
  FaultStatistics?: FaultStatistics;
1468
1673
  /**
1674
+ * @public
1469
1675
  * <p>The total number of completed requests.</p>
1470
1676
  */
1471
1677
  TotalCount?: number;
1472
1678
  /**
1679
+ * @public
1473
1680
  * <p>The aggregate response time of completed requests.</p>
1474
1681
  */
1475
1682
  TotalResponseTime?: number;
@@ -1481,26 +1688,32 @@ export interface ServiceStatistics {
1481
1688
  */
1482
1689
  export interface Service {
1483
1690
  /**
1691
+ * @public
1484
1692
  * <p>Identifier for the service. Unique within the service map.</p>
1485
1693
  */
1486
1694
  ReferenceId?: number;
1487
1695
  /**
1696
+ * @public
1488
1697
  * <p>The canonical name of the service.</p>
1489
1698
  */
1490
1699
  Name?: string;
1491
1700
  /**
1701
+ * @public
1492
1702
  * <p>A list of names for the service, including the canonical name.</p>
1493
1703
  */
1494
1704
  Names?: string[];
1495
1705
  /**
1706
+ * @public
1496
1707
  * <p>Indicates that the service was the first service to process a request.</p>
1497
1708
  */
1498
1709
  Root?: boolean;
1499
1710
  /**
1711
+ * @public
1500
1712
  * <p>Identifier of the Amazon Web Services account in which the service runs.</p>
1501
1713
  */
1502
1714
  AccountId?: string;
1503
1715
  /**
1716
+ * @public
1504
1717
  * <p>The type of service.</p>
1505
1718
  * <ul>
1506
1719
  * <li>
@@ -1525,30 +1738,37 @@ export interface Service {
1525
1738
  */
1526
1739
  Type?: string;
1527
1740
  /**
1741
+ * @public
1528
1742
  * <p>The service's state.</p>
1529
1743
  */
1530
1744
  State?: string;
1531
1745
  /**
1746
+ * @public
1532
1747
  * <p>The start time of the first segment that the service generated.</p>
1533
1748
  */
1534
1749
  StartTime?: Date;
1535
1750
  /**
1751
+ * @public
1536
1752
  * <p>The end time of the last segment that the service generated.</p>
1537
1753
  */
1538
1754
  EndTime?: Date;
1539
1755
  /**
1756
+ * @public
1540
1757
  * <p>Connections to downstream services.</p>
1541
1758
  */
1542
1759
  Edges?: Edge[];
1543
1760
  /**
1761
+ * @public
1544
1762
  * <p>Aggregated statistics for the service.</p>
1545
1763
  */
1546
1764
  SummaryStatistics?: ServiceStatistics;
1547
1765
  /**
1766
+ * @public
1548
1767
  * <p>A histogram that maps the spread of service durations.</p>
1549
1768
  */
1550
1769
  DurationHistogram?: HistogramEntry[];
1551
1770
  /**
1771
+ * @public
1552
1772
  * <p>A histogram that maps the spread of service response times.</p>
1553
1773
  */
1554
1774
  ResponseTimeHistogram?: HistogramEntry[];
@@ -1558,25 +1778,30 @@ export interface Service {
1558
1778
  */
1559
1779
  export interface GetServiceGraphResult {
1560
1780
  /**
1781
+ * @public
1561
1782
  * <p>The start of the time frame for which the graph was generated.</p>
1562
1783
  */
1563
1784
  StartTime?: Date;
1564
1785
  /**
1786
+ * @public
1565
1787
  * <p>The end of the time frame for which the graph was generated.</p>
1566
1788
  */
1567
1789
  EndTime?: Date;
1568
1790
  /**
1791
+ * @public
1569
1792
  * <p>The services that have processed a traced request during the specified time
1570
1793
  * frame.</p>
1571
1794
  */
1572
1795
  Services?: Service[];
1573
1796
  /**
1797
+ * @public
1574
1798
  * <p>A flag indicating whether the group's filter expression has been consistent, or
1575
1799
  * if the returned service graph may show traces from an older version of the group's filter
1576
1800
  * expression.</p>
1577
1801
  */
1578
1802
  ContainsOldGroupVersions?: boolean;
1579
1803
  /**
1804
+ * @public
1580
1805
  * <p>Pagination token.</p>
1581
1806
  */
1582
1807
  NextToken?: string;
@@ -1586,37 +1811,45 @@ export interface GetServiceGraphResult {
1586
1811
  */
1587
1812
  export interface GetTimeSeriesServiceStatisticsRequest {
1588
1813
  /**
1814
+ * @public
1589
1815
  * <p>The start of the time frame for which to aggregate statistics.</p>
1590
1816
  */
1591
1817
  StartTime: Date | undefined;
1592
1818
  /**
1819
+ * @public
1593
1820
  * <p>The end of the time frame for which to aggregate statistics.</p>
1594
1821
  */
1595
1822
  EndTime: Date | undefined;
1596
1823
  /**
1824
+ * @public
1597
1825
  * <p>The case-sensitive name of the group for which to pull statistics from.</p>
1598
1826
  */
1599
1827
  GroupName?: string;
1600
1828
  /**
1829
+ * @public
1601
1830
  * <p>The Amazon Resource Name (ARN) of the group for which to pull statistics from.</p>
1602
1831
  */
1603
1832
  GroupARN?: string;
1604
1833
  /**
1834
+ * @public
1605
1835
  * <p>A filter expression defining entities that will be aggregated for statistics.
1606
1836
  * Supports ID, service, and edge functions. If no selector expression is specified, edge
1607
1837
  * statistics are returned. </p>
1608
1838
  */
1609
1839
  EntitySelectorExpression?: string;
1610
1840
  /**
1841
+ * @public
1611
1842
  * <p>Aggregation period in seconds.</p>
1612
1843
  */
1613
1844
  Period?: number;
1614
1845
  /**
1846
+ * @public
1615
1847
  * <p>The forecasted high and low fault count values. Forecast enabled requests require the
1616
1848
  * EntitySelectorExpression ID be provided.</p>
1617
1849
  */
1618
1850
  ForecastStatistics?: boolean;
1619
1851
  /**
1852
+ * @public
1620
1853
  * <p>Pagination token.</p>
1621
1854
  */
1622
1855
  NextToken?: string;
@@ -1628,10 +1861,12 @@ export interface GetTimeSeriesServiceStatisticsRequest {
1628
1861
  */
1629
1862
  export interface ForecastStatistics {
1630
1863
  /**
1864
+ * @public
1631
1865
  * <p>The upper limit of fault counts for a service.</p>
1632
1866
  */
1633
1867
  FaultCountHigh?: number;
1634
1868
  /**
1869
+ * @public
1635
1870
  * <p>The lower limit of fault counts for a service.</p>
1636
1871
  */
1637
1872
  FaultCountLow?: number;
@@ -1642,22 +1877,27 @@ export interface ForecastStatistics {
1642
1877
  */
1643
1878
  export interface TimeSeriesServiceStatistics {
1644
1879
  /**
1880
+ * @public
1645
1881
  * <p>Timestamp of the window for which statistics are aggregated.</p>
1646
1882
  */
1647
1883
  Timestamp?: Date;
1648
1884
  /**
1885
+ * @public
1649
1886
  * <p>Response statistics for an edge.</p>
1650
1887
  */
1651
1888
  EdgeSummaryStatistics?: EdgeStatistics;
1652
1889
  /**
1890
+ * @public
1653
1891
  * <p>Response statistics for a service.</p>
1654
1892
  */
1655
1893
  ServiceSummaryStatistics?: ServiceStatistics;
1656
1894
  /**
1895
+ * @public
1657
1896
  * <p>The forecasted high and low fault count values.</p>
1658
1897
  */
1659
1898
  ServiceForecastStatistics?: ForecastStatistics;
1660
1899
  /**
1900
+ * @public
1661
1901
  * <p>The response time histogram for the selected entities.</p>
1662
1902
  */
1663
1903
  ResponseTimeHistogram?: HistogramEntry[];
@@ -1667,15 +1907,18 @@ export interface TimeSeriesServiceStatistics {
1667
1907
  */
1668
1908
  export interface GetTimeSeriesServiceStatisticsResult {
1669
1909
  /**
1910
+ * @public
1670
1911
  * <p>The collection of statistics.</p>
1671
1912
  */
1672
1913
  TimeSeriesServiceStatistics?: TimeSeriesServiceStatistics[];
1673
1914
  /**
1915
+ * @public
1674
1916
  * <p>A flag indicating whether or not a group's filter expression has been consistent, or if a returned
1675
1917
  * aggregation might show statistics from an older version of the group's filter expression.</p>
1676
1918
  */
1677
1919
  ContainsOldGroupVersions?: boolean;
1678
1920
  /**
1921
+ * @public
1679
1922
  * <p>Pagination token.</p>
1680
1923
  */
1681
1924
  NextToken?: string;
@@ -1685,10 +1928,12 @@ export interface GetTimeSeriesServiceStatisticsResult {
1685
1928
  */
1686
1929
  export interface GetTraceGraphRequest {
1687
1930
  /**
1931
+ * @public
1688
1932
  * <p>Trace IDs of requests for which to generate a service graph.</p>
1689
1933
  */
1690
1934
  TraceIds: string[] | undefined;
1691
1935
  /**
1936
+ * @public
1692
1937
  * <p>Pagination token.</p>
1693
1938
  */
1694
1939
  NextToken?: string;
@@ -1698,10 +1943,12 @@ export interface GetTraceGraphRequest {
1698
1943
  */
1699
1944
  export interface GetTraceGraphResult {
1700
1945
  /**
1946
+ * @public
1701
1947
  * <p>The services that have processed one of the specified requests.</p>
1702
1948
  */
1703
1949
  Services?: Service[];
1704
1950
  /**
1951
+ * @public
1705
1952
  * <p>Pagination token.</p>
1706
1953
  */
1707
1954
  NextToken?: string;
@@ -1724,10 +1971,12 @@ export type SamplingStrategyName = (typeof SamplingStrategyName)[keyof typeof Sa
1724
1971
  */
1725
1972
  export interface SamplingStrategy {
1726
1973
  /**
1974
+ * @public
1727
1975
  * <p>The name of a sampling rule.</p>
1728
1976
  */
1729
1977
  Name?: SamplingStrategyName | string;
1730
1978
  /**
1979
+ * @public
1731
1980
  * <p>The value of a sampling rule.</p>
1732
1981
  */
1733
1982
  Value?: number;
@@ -1749,33 +1998,40 @@ export type TimeRangeType = (typeof TimeRangeType)[keyof typeof TimeRangeType];
1749
1998
  */
1750
1999
  export interface GetTraceSummariesRequest {
1751
2000
  /**
2001
+ * @public
1752
2002
  * <p>The start of the time frame for which to retrieve traces.</p>
1753
2003
  */
1754
2004
  StartTime: Date | undefined;
1755
2005
  /**
2006
+ * @public
1756
2007
  * <p>The end of the time frame for which to retrieve traces.</p>
1757
2008
  */
1758
2009
  EndTime: Date | undefined;
1759
2010
  /**
2011
+ * @public
1760
2012
  * <p>A parameter to indicate whether to query trace summaries by TraceId or Event time.</p>
1761
2013
  */
1762
2014
  TimeRangeType?: TimeRangeType | string;
1763
2015
  /**
2016
+ * @public
1764
2017
  * <p>Set to <code>true</code> to get summaries for only a subset of available
1765
2018
  * traces.</p>
1766
2019
  */
1767
2020
  Sampling?: boolean;
1768
2021
  /**
2022
+ * @public
1769
2023
  * <p>A parameter to indicate whether to enable sampling on trace summaries. Input parameters are Name and
1770
2024
  * Value.</p>
1771
2025
  */
1772
2026
  SamplingStrategy?: SamplingStrategy;
1773
2027
  /**
2028
+ * @public
1774
2029
  * <p>Specify a filter expression to retrieve trace summaries for services or requests that
1775
2030
  * meet certain requirements.</p>
1776
2031
  */
1777
2032
  FilterExpression?: string;
1778
2033
  /**
2034
+ * @public
1779
2035
  * <p>Specify the pagination token returned by a previous request to retrieve the next page
1780
2036
  * of results.</p>
1781
2037
  */
@@ -1787,10 +2043,12 @@ export interface GetTraceSummariesRequest {
1787
2043
  */
1788
2044
  export interface RootCauseException {
1789
2045
  /**
2046
+ * @public
1790
2047
  * <p>The name of the exception.</p>
1791
2048
  */
1792
2049
  Name?: string;
1793
2050
  /**
2051
+ * @public
1794
2052
  * <p>The message of the exception.</p>
1795
2053
  */
1796
2054
  Message?: string;
@@ -1802,14 +2060,17 @@ export interface RootCauseException {
1802
2060
  */
1803
2061
  export interface ErrorRootCauseEntity {
1804
2062
  /**
2063
+ * @public
1805
2064
  * <p>The name of the entity.</p>
1806
2065
  */
1807
2066
  Name?: string;
1808
2067
  /**
2068
+ * @public
1809
2069
  * <p>The types and messages of the exceptions.</p>
1810
2070
  */
1811
2071
  Exceptions?: RootCauseException[];
1812
2072
  /**
2073
+ * @public
1813
2074
  * <p>A flag that denotes a remote subsegment.</p>
1814
2075
  */
1815
2076
  Remote?: boolean;
@@ -1820,26 +2081,32 @@ export interface ErrorRootCauseEntity {
1820
2081
  */
1821
2082
  export interface ErrorRootCauseService {
1822
2083
  /**
2084
+ * @public
1823
2085
  * <p>The service name.</p>
1824
2086
  */
1825
2087
  Name?: string;
1826
2088
  /**
2089
+ * @public
1827
2090
  * <p>A collection of associated service names.</p>
1828
2091
  */
1829
2092
  Names?: string[];
1830
2093
  /**
2094
+ * @public
1831
2095
  * <p>The type associated to the service.</p>
1832
2096
  */
1833
2097
  Type?: string;
1834
2098
  /**
2099
+ * @public
1835
2100
  * <p>The account ID associated to the service.</p>
1836
2101
  */
1837
2102
  AccountId?: string;
1838
2103
  /**
2104
+ * @public
1839
2105
  * <p>The path of root cause entities found on the service. </p>
1840
2106
  */
1841
2107
  EntityPath?: ErrorRootCauseEntity[];
1842
2108
  /**
2109
+ * @public
1843
2110
  * <p>A Boolean value indicating if the service is inferred from the trace.</p>
1844
2111
  */
1845
2112
  Inferred?: boolean;
@@ -1850,11 +2117,13 @@ export interface ErrorRootCauseService {
1850
2117
  */
1851
2118
  export interface ErrorRootCause {
1852
2119
  /**
2120
+ * @public
1853
2121
  * <p>A list of services corresponding to an error. A service identifies a segment and it
1854
2122
  * contains a name, account ID, type, and inferred flag.</p>
1855
2123
  */
1856
2124
  Services?: ErrorRootCauseService[];
1857
2125
  /**
2126
+ * @public
1858
2127
  * <p>A flag that denotes that the root cause impacts the trace client.</p>
1859
2128
  */
1860
2129
  ClientImpacting?: boolean;
@@ -1866,14 +2135,17 @@ export interface ErrorRootCause {
1866
2135
  */
1867
2136
  export interface FaultRootCauseEntity {
1868
2137
  /**
2138
+ * @public
1869
2139
  * <p>The name of the entity.</p>
1870
2140
  */
1871
2141
  Name?: string;
1872
2142
  /**
2143
+ * @public
1873
2144
  * <p>The types and messages of the exceptions.</p>
1874
2145
  */
1875
2146
  Exceptions?: RootCauseException[];
1876
2147
  /**
2148
+ * @public
1877
2149
  * <p>A flag that denotes a remote subsegment.</p>
1878
2150
  */
1879
2151
  Remote?: boolean;
@@ -1884,26 +2156,32 @@ export interface FaultRootCauseEntity {
1884
2156
  */
1885
2157
  export interface FaultRootCauseService {
1886
2158
  /**
2159
+ * @public
1887
2160
  * <p>The service name.</p>
1888
2161
  */
1889
2162
  Name?: string;
1890
2163
  /**
2164
+ * @public
1891
2165
  * <p>A collection of associated service names.</p>
1892
2166
  */
1893
2167
  Names?: string[];
1894
2168
  /**
2169
+ * @public
1895
2170
  * <p>The type associated to the service.</p>
1896
2171
  */
1897
2172
  Type?: string;
1898
2173
  /**
2174
+ * @public
1899
2175
  * <p>The account ID associated to the service.</p>
1900
2176
  */
1901
2177
  AccountId?: string;
1902
2178
  /**
2179
+ * @public
1903
2180
  * <p>The path of root cause entities found on the service. </p>
1904
2181
  */
1905
2182
  EntityPath?: FaultRootCauseEntity[];
1906
2183
  /**
2184
+ * @public
1907
2185
  * <p>A Boolean value indicating if the service is inferred from the trace.</p>
1908
2186
  */
1909
2187
  Inferred?: boolean;
@@ -1914,11 +2192,13 @@ export interface FaultRootCauseService {
1914
2192
  */
1915
2193
  export interface FaultRootCause {
1916
2194
  /**
2195
+ * @public
1917
2196
  * <p>A list of corresponding services. A service identifies a segment and it contains a
1918
2197
  * name, account ID, type, and inferred flag.</p>
1919
2198
  */
1920
2199
  Services?: FaultRootCauseService[];
1921
2200
  /**
2201
+ * @public
1922
2202
  * <p>A flag that denotes that the root cause impacts the trace client.</p>
1923
2203
  */
1924
2204
  ClientImpacting?: boolean;
@@ -1929,22 +2209,27 @@ export interface FaultRootCause {
1929
2209
  */
1930
2210
  export interface Http {
1931
2211
  /**
2212
+ * @public
1932
2213
  * <p>The request URL.</p>
1933
2214
  */
1934
2215
  HttpURL?: string;
1935
2216
  /**
2217
+ * @public
1936
2218
  * <p>The response status.</p>
1937
2219
  */
1938
2220
  HttpStatus?: number;
1939
2221
  /**
2222
+ * @public
1940
2223
  * <p>The request method.</p>
1941
2224
  */
1942
2225
  HttpMethod?: string;
1943
2226
  /**
2227
+ * @public
1944
2228
  * <p>The request's user agent string.</p>
1945
2229
  */
1946
2230
  UserAgent?: string;
1947
2231
  /**
2232
+ * @public
1948
2233
  * <p>The IP address of the requestor.</p>
1949
2234
  */
1950
2235
  ClientIp?: string;
@@ -1955,6 +2240,7 @@ export interface Http {
1955
2240
  */
1956
2241
  export interface InstanceIdDetail {
1957
2242
  /**
2243
+ * @public
1958
2244
  * <p>The ID of a corresponding EC2 instance.</p>
1959
2245
  */
1960
2246
  Id?: string;
@@ -1965,6 +2251,7 @@ export interface InstanceIdDetail {
1965
2251
  */
1966
2252
  export interface ResourceARNDetail {
1967
2253
  /**
2254
+ * @public
1968
2255
  * <p>The ARN of a corresponding resource.</p>
1969
2256
  */
1970
2257
  ARN?: string;
@@ -1976,14 +2263,17 @@ export interface ResourceARNDetail {
1976
2263
  */
1977
2264
  export interface ResponseTimeRootCauseEntity {
1978
2265
  /**
2266
+ * @public
1979
2267
  * <p>The name of the entity.</p>
1980
2268
  */
1981
2269
  Name?: string;
1982
2270
  /**
2271
+ * @public
1983
2272
  * <p>The type and messages of the exceptions.</p>
1984
2273
  */
1985
2274
  Coverage?: number;
1986
2275
  /**
2276
+ * @public
1987
2277
  * <p>A flag that denotes a remote subsegment.</p>
1988
2278
  */
1989
2279
  Remote?: boolean;
@@ -1994,26 +2284,32 @@ export interface ResponseTimeRootCauseEntity {
1994
2284
  */
1995
2285
  export interface ResponseTimeRootCauseService {
1996
2286
  /**
2287
+ * @public
1997
2288
  * <p>The service name.</p>
1998
2289
  */
1999
2290
  Name?: string;
2000
2291
  /**
2292
+ * @public
2001
2293
  * <p>A collection of associated service names.</p>
2002
2294
  */
2003
2295
  Names?: string[];
2004
2296
  /**
2297
+ * @public
2005
2298
  * <p>The type associated to the service.</p>
2006
2299
  */
2007
2300
  Type?: string;
2008
2301
  /**
2302
+ * @public
2009
2303
  * <p>The account ID associated to the service.</p>
2010
2304
  */
2011
2305
  AccountId?: string;
2012
2306
  /**
2307
+ * @public
2013
2308
  * <p>The path of root cause entities found on the service. </p>
2014
2309
  */
2015
2310
  EntityPath?: ResponseTimeRootCauseEntity[];
2016
2311
  /**
2312
+ * @public
2017
2313
  * <p>A Boolean value indicating if the service is inferred from the trace.</p>
2018
2314
  */
2019
2315
  Inferred?: boolean;
@@ -2024,11 +2320,13 @@ export interface ResponseTimeRootCauseService {
2024
2320
  */
2025
2321
  export interface ResponseTimeRootCause {
2026
2322
  /**
2323
+ * @public
2027
2324
  * <p>A list of corresponding services. A service identifies a segment and contains a name,
2028
2325
  * account ID, type, and inferred flag.</p>
2029
2326
  */
2030
2327
  Services?: ResponseTimeRootCauseService[];
2031
2328
  /**
2329
+ * @public
2032
2330
  * <p>A flag that denotes that the root cause impacts the trace client.</p>
2033
2331
  */
2034
2332
  ClientImpacting?: boolean;
@@ -2039,10 +2337,12 @@ export interface ResponseTimeRootCause {
2039
2337
  */
2040
2338
  export interface TraceUser {
2041
2339
  /**
2340
+ * @public
2042
2341
  * <p>The user's name.</p>
2043
2342
  */
2044
2343
  UserName?: string;
2045
2344
  /**
2345
+ * @public
2046
2346
  * <p>Services that the user's request hit.</p>
2047
2347
  */
2048
2348
  ServiceIds?: ServiceId[];
@@ -2053,16 +2353,19 @@ export interface TraceUser {
2053
2353
  */
2054
2354
  export interface TraceSummary {
2055
2355
  /**
2356
+ * @public
2056
2357
  * <p>The unique identifier for the request that generated the trace's segments and
2057
2358
  * subsegments.</p>
2058
2359
  */
2059
2360
  Id?: string;
2060
2361
  /**
2362
+ * @public
2061
2363
  * <p>The length of time in seconds between the start time of the root segment and the end
2062
2364
  * time of the last segment that completed.</p>
2063
2365
  */
2064
2366
  Duration?: number;
2065
2367
  /**
2368
+ * @public
2066
2369
  * <p>The length of time in seconds between the start and end times of the root segment. If
2067
2370
  * the service performs work asynchronously, the response time measures the time before the
2068
2371
  * response is sent to the user, while the duration measures the amount of time before the last
@@ -2070,73 +2373,90 @@ export interface TraceSummary {
2070
2373
  */
2071
2374
  ResponseTime?: number;
2072
2375
  /**
2376
+ * @public
2073
2377
  * <p>The root segment document has a 500 series error.</p>
2074
2378
  */
2075
2379
  HasFault?: boolean;
2076
2380
  /**
2381
+ * @public
2077
2382
  * <p>The root segment document has a 400 series error.</p>
2078
2383
  */
2079
2384
  HasError?: boolean;
2080
2385
  /**
2386
+ * @public
2081
2387
  * <p>One or more of the segment documents has a 429 throttling error.</p>
2082
2388
  */
2083
2389
  HasThrottle?: boolean;
2084
2390
  /**
2391
+ * @public
2085
2392
  * <p>One or more of the segment documents is in progress.</p>
2086
2393
  */
2087
2394
  IsPartial?: boolean;
2088
2395
  /**
2396
+ * @public
2089
2397
  * <p>Information about the HTTP request served by the trace.</p>
2090
2398
  */
2091
2399
  Http?: Http;
2092
2400
  /**
2401
+ * @public
2093
2402
  * <p>Annotations from the trace's segment documents.</p>
2094
2403
  */
2095
2404
  Annotations?: Record<string, ValueWithServiceIds[]>;
2096
2405
  /**
2406
+ * @public
2097
2407
  * <p>Users from the trace's segment documents.</p>
2098
2408
  */
2099
2409
  Users?: TraceUser[];
2100
2410
  /**
2411
+ * @public
2101
2412
  * <p>Service IDs from the trace's segment documents.</p>
2102
2413
  */
2103
2414
  ServiceIds?: ServiceId[];
2104
2415
  /**
2416
+ * @public
2105
2417
  * <p>A list of resource ARNs for any resource corresponding to the trace segments.</p>
2106
2418
  */
2107
2419
  ResourceARNs?: ResourceARNDetail[];
2108
2420
  /**
2421
+ * @public
2109
2422
  * <p>A list of EC2 instance IDs for any instance corresponding to the trace
2110
2423
  * segments.</p>
2111
2424
  */
2112
2425
  InstanceIds?: InstanceIdDetail[];
2113
2426
  /**
2427
+ * @public
2114
2428
  * <p>A list of Availability Zones for any zone corresponding to the trace segments.</p>
2115
2429
  */
2116
2430
  AvailabilityZones?: AvailabilityZoneDetail[];
2117
2431
  /**
2432
+ * @public
2118
2433
  * <p>The root of a trace.</p>
2119
2434
  */
2120
2435
  EntryPoint?: ServiceId;
2121
2436
  /**
2437
+ * @public
2122
2438
  * <p>A collection of FaultRootCause structures corresponding to the trace segments.</p>
2123
2439
  */
2124
2440
  FaultRootCauses?: FaultRootCause[];
2125
2441
  /**
2442
+ * @public
2126
2443
  * <p>A collection of ErrorRootCause structures corresponding to the trace
2127
2444
  * segments.</p>
2128
2445
  */
2129
2446
  ErrorRootCauses?: ErrorRootCause[];
2130
2447
  /**
2448
+ * @public
2131
2449
  * <p>A collection of ResponseTimeRootCause structures corresponding to the trace
2132
2450
  * segments.</p>
2133
2451
  */
2134
2452
  ResponseTimeRootCauses?: ResponseTimeRootCause[];
2135
2453
  /**
2454
+ * @public
2136
2455
  * <p>The revision number of a trace.</p>
2137
2456
  */
2138
2457
  Revision?: number;
2139
2458
  /**
2459
+ * @public
2140
2460
  * <p>The matched time stamp of a defined event.</p>
2141
2461
  */
2142
2462
  MatchedEventTime?: Date;
@@ -2146,20 +2466,24 @@ export interface TraceSummary {
2146
2466
  */
2147
2467
  export interface GetTraceSummariesResult {
2148
2468
  /**
2469
+ * @public
2149
2470
  * <p>Trace IDs and annotations for traces that were found in the specified time
2150
2471
  * frame.</p>
2151
2472
  */
2152
2473
  TraceSummaries?: TraceSummary[];
2153
2474
  /**
2475
+ * @public
2154
2476
  * <p>The start time of this page of results.</p>
2155
2477
  */
2156
2478
  ApproximateTime?: Date;
2157
2479
  /**
2480
+ * @public
2158
2481
  * <p>The total number of traces processed, including traces that did not match the specified
2159
2482
  * filter expression.</p>
2160
2483
  */
2161
2484
  TracesProcessedCount?: number;
2162
2485
  /**
2486
+ * @public
2163
2487
  * <p>If the requested time frame contained more than one page of results, you can use this token to retrieve the
2164
2488
  * next page. The first page contains the most recent results, closest to the end of the time frame.</p>
2165
2489
  */
@@ -2170,6 +2494,7 @@ export interface GetTraceSummariesResult {
2170
2494
  */
2171
2495
  export interface ListResourcePoliciesRequest {
2172
2496
  /**
2497
+ * @public
2173
2498
  * <p>Not currently supported.</p>
2174
2499
  */
2175
2500
  NextToken?: string;
@@ -2182,18 +2507,22 @@ export interface ListResourcePoliciesRequest {
2182
2507
  */
2183
2508
  export interface ResourcePolicy {
2184
2509
  /**
2510
+ * @public
2185
2511
  * <p>The name of the resource policy. Must be unique within a specific Amazon Web Services account.</p>
2186
2512
  */
2187
2513
  PolicyName?: string;
2188
2514
  /**
2515
+ * @public
2189
2516
  * <p>The resource policy document, which can be up to 5kb in size.</p>
2190
2517
  */
2191
2518
  PolicyDocument?: string;
2192
2519
  /**
2520
+ * @public
2193
2521
  * <p>Returns the current policy revision id for this policy name.</p>
2194
2522
  */
2195
2523
  PolicyRevisionId?: string;
2196
2524
  /**
2525
+ * @public
2197
2526
  * <p>When the policy was last updated, in Unix time seconds.</p>
2198
2527
  */
2199
2528
  LastUpdatedTime?: Date;
@@ -2203,10 +2532,12 @@ export interface ResourcePolicy {
2203
2532
  */
2204
2533
  export interface ListResourcePoliciesResult {
2205
2534
  /**
2535
+ * @public
2206
2536
  * <p>The list of resource policies in the target Amazon Web Services account.</p>
2207
2537
  */
2208
2538
  ResourcePolicies?: ResourcePolicy[];
2209
2539
  /**
2540
+ * @public
2210
2541
  * <p>Pagination token. Not currently supported.</p>
2211
2542
  */
2212
2543
  NextToken?: string;
@@ -2216,10 +2547,12 @@ export interface ListResourcePoliciesResult {
2216
2547
  */
2217
2548
  export interface ListTagsForResourceRequest {
2218
2549
  /**
2550
+ * @public
2219
2551
  * <p>The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.</p>
2220
2552
  */
2221
2553
  ResourceARN: string | undefined;
2222
2554
  /**
2555
+ * @public
2223
2556
  * <p>A pagination token. If multiple pages of results are returned, use the <code>NextToken</code> value returned with
2224
2557
  * the current page of results as the value of this parameter to get the next page of results.</p>
2225
2558
  */
@@ -2230,10 +2563,12 @@ export interface ListTagsForResourceRequest {
2230
2563
  */
2231
2564
  export interface ListTagsForResourceResponse {
2232
2565
  /**
2566
+ * @public
2233
2567
  * <p>A list of tags, as key and value pairs, that is associated with the specified X-Ray group or sampling rule.</p>
2234
2568
  */
2235
2569
  Tags?: Tag[];
2236
2570
  /**
2571
+ * @public
2237
2572
  * <p>A pagination token. If multiple pages of results are returned, use the <code>NextToken</code> value returned with
2238
2573
  * the current page of results to get the next page of results.</p>
2239
2574
  */
@@ -2259,6 +2594,7 @@ export declare class ResourceNotFoundException extends __BaseException {
2259
2594
  */
2260
2595
  export interface PutEncryptionConfigRequest {
2261
2596
  /**
2597
+ * @public
2262
2598
  * <p>An Amazon Web Services KMS key in one of the following formats:</p>
2263
2599
  * <ul>
2264
2600
  * <li>
@@ -2283,6 +2619,7 @@ export interface PutEncryptionConfigRequest {
2283
2619
  */
2284
2620
  KeyId?: string;
2285
2621
  /**
2622
+ * @public
2286
2623
  * <p>The type of encryption. Set to <code>KMS</code> to use your own key for encryption. Set
2287
2624
  * to <code>NONE</code> for default encryption.</p>
2288
2625
  */
@@ -2293,6 +2630,7 @@ export interface PutEncryptionConfigRequest {
2293
2630
  */
2294
2631
  export interface PutEncryptionConfigResult {
2295
2632
  /**
2633
+ * @public
2296
2634
  * <p>The new encryption configuration.</p>
2297
2635
  */
2298
2636
  EncryptionConfig?: EncryptionConfig;
@@ -2354,14 +2692,17 @@ export declare class PolicySizeLimitExceededException extends __BaseException {
2354
2692
  */
2355
2693
  export interface PutResourcePolicyRequest {
2356
2694
  /**
2695
+ * @public
2357
2696
  * <p>The name of the resource policy. Must be unique within a specific Amazon Web Services account.</p>
2358
2697
  */
2359
2698
  PolicyName: string | undefined;
2360
2699
  /**
2700
+ * @public
2361
2701
  * <p>The resource policy document, which can be up to 5kb in size.</p>
2362
2702
  */
2363
2703
  PolicyDocument: string | undefined;
2364
2704
  /**
2705
+ * @public
2365
2706
  * <p>Specifies a specific policy revision, to ensure an atomic create operation. By default the resource policy is created if it does not exist, or updated with an incremented revision id.
2366
2707
  * The revision id is unique to each policy in the account.</p>
2367
2708
  * <p>If the policy revision id does not match the latest revision id, the operation will fail with an <code>InvalidPolicyRevisionIdException</code> exception. You can also provide a
@@ -2370,6 +2711,7 @@ export interface PutResourcePolicyRequest {
2370
2711
  */
2371
2712
  PolicyRevisionId?: string;
2372
2713
  /**
2714
+ * @public
2373
2715
  * <p>A flag to indicate whether to bypass the resource policy lockout safety check.</p>
2374
2716
  * <important>
2375
2717
  * <p>Setting this value to true increases the risk that the policy becomes unmanageable. Do not set this value to true indiscriminately.</p>
@@ -2384,6 +2726,7 @@ export interface PutResourcePolicyRequest {
2384
2726
  */
2385
2727
  export interface PutResourcePolicyResult {
2386
2728
  /**
2729
+ * @public
2387
2730
  * <p>The resource policy document, as provided in the <code>PutResourcePolicyRequest</code>.</p>
2388
2731
  */
2389
2732
  ResourcePolicy?: ResourcePolicy;
@@ -2394,26 +2737,32 @@ export interface PutResourcePolicyResult {
2394
2737
  */
2395
2738
  export interface BackendConnectionErrors {
2396
2739
  /**
2740
+ * @public
2397
2741
  * <p></p>
2398
2742
  */
2399
2743
  TimeoutCount?: number;
2400
2744
  /**
2745
+ * @public
2401
2746
  * <p></p>
2402
2747
  */
2403
2748
  ConnectionRefusedCount?: number;
2404
2749
  /**
2750
+ * @public
2405
2751
  * <p></p>
2406
2752
  */
2407
2753
  HTTPCode4XXCount?: number;
2408
2754
  /**
2755
+ * @public
2409
2756
  * <p></p>
2410
2757
  */
2411
2758
  HTTPCode5XXCount?: number;
2412
2759
  /**
2760
+ * @public
2413
2761
  * <p></p>
2414
2762
  */
2415
2763
  UnknownHostCount?: number;
2416
2764
  /**
2765
+ * @public
2417
2766
  * <p></p>
2418
2767
  */
2419
2768
  OtherCount?: number;
@@ -2424,26 +2773,32 @@ export interface BackendConnectionErrors {
2424
2773
  */
2425
2774
  export interface TelemetryRecord {
2426
2775
  /**
2776
+ * @public
2427
2777
  * <p></p>
2428
2778
  */
2429
2779
  Timestamp: Date | undefined;
2430
2780
  /**
2781
+ * @public
2431
2782
  * <p></p>
2432
2783
  */
2433
2784
  SegmentsReceivedCount?: number;
2434
2785
  /**
2786
+ * @public
2435
2787
  * <p></p>
2436
2788
  */
2437
2789
  SegmentsSentCount?: number;
2438
2790
  /**
2791
+ * @public
2439
2792
  * <p></p>
2440
2793
  */
2441
2794
  SegmentsSpilloverCount?: number;
2442
2795
  /**
2796
+ * @public
2443
2797
  * <p></p>
2444
2798
  */
2445
2799
  SegmentsRejectedCount?: number;
2446
2800
  /**
2801
+ * @public
2447
2802
  * <p></p>
2448
2803
  */
2449
2804
  BackendConnectionErrors?: BackendConnectionErrors;
@@ -2453,18 +2808,22 @@ export interface TelemetryRecord {
2453
2808
  */
2454
2809
  export interface PutTelemetryRecordsRequest {
2455
2810
  /**
2811
+ * @public
2456
2812
  * <p></p>
2457
2813
  */
2458
2814
  TelemetryRecords: TelemetryRecord[] | undefined;
2459
2815
  /**
2816
+ * @public
2460
2817
  * <p></p>
2461
2818
  */
2462
2819
  EC2InstanceId?: string;
2463
2820
  /**
2821
+ * @public
2464
2822
  * <p></p>
2465
2823
  */
2466
2824
  Hostname?: string;
2467
2825
  /**
2826
+ * @public
2468
2827
  * <p></p>
2469
2828
  */
2470
2829
  ResourceARN?: string;
@@ -2479,6 +2838,7 @@ export interface PutTelemetryRecordsResult {
2479
2838
  */
2480
2839
  export interface PutTraceSegmentsRequest {
2481
2840
  /**
2841
+ * @public
2482
2842
  * <p>A string containing a JSON document defining one or more segments or
2483
2843
  * subsegments.</p>
2484
2844
  */
@@ -2490,14 +2850,17 @@ export interface PutTraceSegmentsRequest {
2490
2850
  */
2491
2851
  export interface UnprocessedTraceSegment {
2492
2852
  /**
2853
+ * @public
2493
2854
  * <p>The segment's ID.</p>
2494
2855
  */
2495
2856
  Id?: string;
2496
2857
  /**
2858
+ * @public
2497
2859
  * <p>The error that caused processing to fail.</p>
2498
2860
  */
2499
2861
  ErrorCode?: string;
2500
2862
  /**
2863
+ * @public
2501
2864
  * <p>The error message.</p>
2502
2865
  */
2503
2866
  Message?: string;
@@ -2507,6 +2870,7 @@ export interface UnprocessedTraceSegment {
2507
2870
  */
2508
2871
  export interface PutTraceSegmentsResult {
2509
2872
  /**
2873
+ * @public
2510
2874
  * <p>Segments that failed processing.</p>
2511
2875
  */
2512
2876
  UnprocessedTraceSegments?: UnprocessedTraceSegment[];
@@ -2516,10 +2880,12 @@ export interface PutTraceSegmentsResult {
2516
2880
  */
2517
2881
  export interface TagResourceRequest {
2518
2882
  /**
2883
+ * @public
2519
2884
  * <p>The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.</p>
2520
2885
  */
2521
2886
  ResourceARN: string | undefined;
2522
2887
  /**
2888
+ * @public
2523
2889
  * <p>A map that contains one or more tag keys and tag values to attach to an X-Ray group or
2524
2890
  * sampling rule. For more information about ways to use tags, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>
2525
2891
  * in the <i>Amazon Web Services General Reference</i>.</p>
@@ -2573,10 +2939,12 @@ export declare class TooManyTagsException extends __BaseException {
2573
2939
  */
2574
2940
  export interface UntagResourceRequest {
2575
2941
  /**
2942
+ * @public
2576
2943
  * <p>The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.</p>
2577
2944
  */
2578
2945
  ResourceARN: string | undefined;
2579
2946
  /**
2947
+ * @public
2580
2948
  * <p>Keys for one or more tags that you want to remove from an X-Ray group or sampling rule.</p>
2581
2949
  */
2582
2950
  TagKeys: string[] | undefined;
@@ -2591,18 +2959,22 @@ export interface UntagResourceResponse {
2591
2959
  */
2592
2960
  export interface UpdateGroupRequest {
2593
2961
  /**
2962
+ * @public
2594
2963
  * <p>The case-sensitive name of the group.</p>
2595
2964
  */
2596
2965
  GroupName?: string;
2597
2966
  /**
2967
+ * @public
2598
2968
  * <p>The ARN that was generated upon creation.</p>
2599
2969
  */
2600
2970
  GroupARN?: string;
2601
2971
  /**
2972
+ * @public
2602
2973
  * <p>The updated filter expression defining criteria by which to group traces.</p>
2603
2974
  */
2604
2975
  FilterExpression?: string;
2605
2976
  /**
2977
+ * @public
2606
2978
  * <p>The structure containing configurations related to insights.</p>
2607
2979
  * <ul>
2608
2980
  * <li>
@@ -2622,6 +2994,7 @@ export interface UpdateGroupRequest {
2622
2994
  */
2623
2995
  export interface UpdateGroupResult {
2624
2996
  /**
2997
+ * @public
2625
2998
  * <p>The group that was updated. Contains the name of the group that was updated, the
2626
2999
  * ARN of the group that was updated, the updated filter expression, and the updated insight
2627
3000
  * configuration assigned to the group.</p>
@@ -2634,52 +3007,64 @@ export interface UpdateGroupResult {
2634
3007
  */
2635
3008
  export interface SamplingRuleUpdate {
2636
3009
  /**
3010
+ * @public
2637
3011
  * <p>The name of the sampling rule. Specify a rule by either name or ARN, but not both.</p>
2638
3012
  */
2639
3013
  RuleName?: string;
2640
3014
  /**
3015
+ * @public
2641
3016
  * <p>The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.</p>
2642
3017
  */
2643
3018
  RuleARN?: string;
2644
3019
  /**
3020
+ * @public
2645
3021
  * <p>Matches the ARN of the Amazon Web Services resource on which the service runs.</p>
2646
3022
  */
2647
3023
  ResourceARN?: string;
2648
3024
  /**
3025
+ * @public
2649
3026
  * <p>The priority of the sampling rule.</p>
2650
3027
  */
2651
3028
  Priority?: number;
2652
3029
  /**
3030
+ * @public
2653
3031
  * <p>The percentage of matching requests to instrument, after the reservoir is
2654
3032
  * exhausted.</p>
2655
3033
  */
2656
3034
  FixedRate?: number;
2657
3035
  /**
3036
+ * @public
2658
3037
  * <p>A fixed number of matching requests to instrument per second, prior to applying the
2659
3038
  * fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.</p>
2660
3039
  */
2661
3040
  ReservoirSize?: number;
2662
3041
  /**
3042
+ * @public
2663
3043
  * <p>Matches the hostname from a request URL.</p>
2664
3044
  */
2665
3045
  Host?: string;
2666
3046
  /**
3047
+ * @public
2667
3048
  * <p>Matches the <code>name</code> that the service uses to identify itself in segments.</p>
2668
3049
  */
2669
3050
  ServiceName?: string;
2670
3051
  /**
3052
+ * @public
2671
3053
  * <p>Matches the <code>origin</code> that the service uses to identify its type in segments.</p>
2672
3054
  */
2673
3055
  ServiceType?: string;
2674
3056
  /**
3057
+ * @public
2675
3058
  * <p>Matches the HTTP method of a request.</p>
2676
3059
  */
2677
3060
  HTTPMethod?: string;
2678
3061
  /**
3062
+ * @public
2679
3063
  * <p>Matches the path from a request URL.</p>
2680
3064
  */
2681
3065
  URLPath?: string;
2682
3066
  /**
3067
+ * @public
2683
3068
  * <p>Matches attributes derived from the request.</p>
2684
3069
  */
2685
3070
  Attributes?: Record<string, string>;
@@ -2689,6 +3074,7 @@ export interface SamplingRuleUpdate {
2689
3074
  */
2690
3075
  export interface UpdateSamplingRuleRequest {
2691
3076
  /**
3077
+ * @public
2692
3078
  * <p>The rule and fields to change.</p>
2693
3079
  */
2694
3080
  SamplingRuleUpdate: SamplingRuleUpdate | undefined;
@@ -2698,6 +3084,7 @@ export interface UpdateSamplingRuleRequest {
2698
3084
  */
2699
3085
  export interface UpdateSamplingRuleResult {
2700
3086
  /**
3087
+ * @public
2701
3088
  * <p>The updated rule definition and metadata.</p>
2702
3089
  */
2703
3090
  SamplingRuleRecord?: SamplingRuleRecord;