xray.d.ts
61.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class XRay extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: XRay.Types.ClientConfiguration)
config: Config & XRay.Types.ClientConfiguration;
/**
* Retrieves a list of traces specified by ID. Each trace is a collection of segment documents that originates from a single request. Use GetTraceSummaries to get a list of trace IDs.
*/
batchGetTraces(params: XRay.Types.BatchGetTracesRequest, callback?: (err: AWSError, data: XRay.Types.BatchGetTracesResult) => void): Request<XRay.Types.BatchGetTracesResult, AWSError>;
/**
* Retrieves a list of traces specified by ID. Each trace is a collection of segment documents that originates from a single request. Use GetTraceSummaries to get a list of trace IDs.
*/
batchGetTraces(callback?: (err: AWSError, data: XRay.Types.BatchGetTracesResult) => void): Request<XRay.Types.BatchGetTracesResult, AWSError>;
/**
* Creates a group resource with a name and a filter expression.
*/
createGroup(params: XRay.Types.CreateGroupRequest, callback?: (err: AWSError, data: XRay.Types.CreateGroupResult) => void): Request<XRay.Types.CreateGroupResult, AWSError>;
/**
* Creates a group resource with a name and a filter expression.
*/
createGroup(callback?: (err: AWSError, data: XRay.Types.CreateGroupResult) => void): Request<XRay.Types.CreateGroupResult, AWSError>;
/**
* Creates a rule to control sampling behavior for instrumented applications. Services retrieve rules with GetSamplingRules, and evaluate each rule in ascending order of priority for each request. If a rule matches, the service records a trace, borrowing it from the reservoir size. After 10 seconds, the service reports back to X-Ray with GetSamplingTargets to get updated versions of each in-use rule. The updated rule contains a trace quota that the service can use instead of borrowing from the reservoir.
*/
createSamplingRule(params: XRay.Types.CreateSamplingRuleRequest, callback?: (err: AWSError, data: XRay.Types.CreateSamplingRuleResult) => void): Request<XRay.Types.CreateSamplingRuleResult, AWSError>;
/**
* Creates a rule to control sampling behavior for instrumented applications. Services retrieve rules with GetSamplingRules, and evaluate each rule in ascending order of priority for each request. If a rule matches, the service records a trace, borrowing it from the reservoir size. After 10 seconds, the service reports back to X-Ray with GetSamplingTargets to get updated versions of each in-use rule. The updated rule contains a trace quota that the service can use instead of borrowing from the reservoir.
*/
createSamplingRule(callback?: (err: AWSError, data: XRay.Types.CreateSamplingRuleResult) => void): Request<XRay.Types.CreateSamplingRuleResult, AWSError>;
/**
* Deletes a group resource.
*/
deleteGroup(params: XRay.Types.DeleteGroupRequest, callback?: (err: AWSError, data: XRay.Types.DeleteGroupResult) => void): Request<XRay.Types.DeleteGroupResult, AWSError>;
/**
* Deletes a group resource.
*/
deleteGroup(callback?: (err: AWSError, data: XRay.Types.DeleteGroupResult) => void): Request<XRay.Types.DeleteGroupResult, AWSError>;
/**
* Deletes a sampling rule.
*/
deleteSamplingRule(params: XRay.Types.DeleteSamplingRuleRequest, callback?: (err: AWSError, data: XRay.Types.DeleteSamplingRuleResult) => void): Request<XRay.Types.DeleteSamplingRuleResult, AWSError>;
/**
* Deletes a sampling rule.
*/
deleteSamplingRule(callback?: (err: AWSError, data: XRay.Types.DeleteSamplingRuleResult) => void): Request<XRay.Types.DeleteSamplingRuleResult, AWSError>;
/**
* Retrieves the current encryption configuration for X-Ray data.
*/
getEncryptionConfig(params: XRay.Types.GetEncryptionConfigRequest, callback?: (err: AWSError, data: XRay.Types.GetEncryptionConfigResult) => void): Request<XRay.Types.GetEncryptionConfigResult, AWSError>;
/**
* Retrieves the current encryption configuration for X-Ray data.
*/
getEncryptionConfig(callback?: (err: AWSError, data: XRay.Types.GetEncryptionConfigResult) => void): Request<XRay.Types.GetEncryptionConfigResult, AWSError>;
/**
* Retrieves group resource details.
*/
getGroup(params: XRay.Types.GetGroupRequest, callback?: (err: AWSError, data: XRay.Types.GetGroupResult) => void): Request<XRay.Types.GetGroupResult, AWSError>;
/**
* Retrieves group resource details.
*/
getGroup(callback?: (err: AWSError, data: XRay.Types.GetGroupResult) => void): Request<XRay.Types.GetGroupResult, AWSError>;
/**
* Retrieves all active group details.
*/
getGroups(params: XRay.Types.GetGroupsRequest, callback?: (err: AWSError, data: XRay.Types.GetGroupsResult) => void): Request<XRay.Types.GetGroupsResult, AWSError>;
/**
* Retrieves all active group details.
*/
getGroups(callback?: (err: AWSError, data: XRay.Types.GetGroupsResult) => void): Request<XRay.Types.GetGroupsResult, AWSError>;
/**
* Retrieves all sampling rules.
*/
getSamplingRules(params: XRay.Types.GetSamplingRulesRequest, callback?: (err: AWSError, data: XRay.Types.GetSamplingRulesResult) => void): Request<XRay.Types.GetSamplingRulesResult, AWSError>;
/**
* Retrieves all sampling rules.
*/
getSamplingRules(callback?: (err: AWSError, data: XRay.Types.GetSamplingRulesResult) => void): Request<XRay.Types.GetSamplingRulesResult, AWSError>;
/**
* Retrieves information about recent sampling results for all sampling rules.
*/
getSamplingStatisticSummaries(params: XRay.Types.GetSamplingStatisticSummariesRequest, callback?: (err: AWSError, data: XRay.Types.GetSamplingStatisticSummariesResult) => void): Request<XRay.Types.GetSamplingStatisticSummariesResult, AWSError>;
/**
* Retrieves information about recent sampling results for all sampling rules.
*/
getSamplingStatisticSummaries(callback?: (err: AWSError, data: XRay.Types.GetSamplingStatisticSummariesResult) => void): Request<XRay.Types.GetSamplingStatisticSummariesResult, AWSError>;
/**
* Requests a sampling quota for rules that the service is using to sample requests.
*/
getSamplingTargets(params: XRay.Types.GetSamplingTargetsRequest, callback?: (err: AWSError, data: XRay.Types.GetSamplingTargetsResult) => void): Request<XRay.Types.GetSamplingTargetsResult, AWSError>;
/**
* Requests a sampling quota for rules that the service is using to sample requests.
*/
getSamplingTargets(callback?: (err: AWSError, data: XRay.Types.GetSamplingTargetsResult) => void): Request<XRay.Types.GetSamplingTargetsResult, AWSError>;
/**
* Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result. Root services process incoming requests and make calls to downstream services. Root services are applications that use the AWS X-Ray SDK. Downstream services can be other applications, AWS resources, HTTP web APIs, or SQL databases.
*/
getServiceGraph(params: XRay.Types.GetServiceGraphRequest, callback?: (err: AWSError, data: XRay.Types.GetServiceGraphResult) => void): Request<XRay.Types.GetServiceGraphResult, AWSError>;
/**
* Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result. Root services process incoming requests and make calls to downstream services. Root services are applications that use the AWS X-Ray SDK. Downstream services can be other applications, AWS resources, HTTP web APIs, or SQL databases.
*/
getServiceGraph(callback?: (err: AWSError, data: XRay.Types.GetServiceGraphResult) => void): Request<XRay.Types.GetServiceGraphResult, AWSError>;
/**
* Get an aggregation of service statistics defined by a specific time range.
*/
getTimeSeriesServiceStatistics(params: XRay.Types.GetTimeSeriesServiceStatisticsRequest, callback?: (err: AWSError, data: XRay.Types.GetTimeSeriesServiceStatisticsResult) => void): Request<XRay.Types.GetTimeSeriesServiceStatisticsResult, AWSError>;
/**
* Get an aggregation of service statistics defined by a specific time range.
*/
getTimeSeriesServiceStatistics(callback?: (err: AWSError, data: XRay.Types.GetTimeSeriesServiceStatisticsResult) => void): Request<XRay.Types.GetTimeSeriesServiceStatisticsResult, AWSError>;
/**
* Retrieves a service graph for one or more specific trace IDs.
*/
getTraceGraph(params: XRay.Types.GetTraceGraphRequest, callback?: (err: AWSError, data: XRay.Types.GetTraceGraphResult) => void): Request<XRay.Types.GetTraceGraphResult, AWSError>;
/**
* Retrieves a service graph for one or more specific trace IDs.
*/
getTraceGraph(callback?: (err: AWSError, data: XRay.Types.GetTraceGraphResult) => void): Request<XRay.Types.GetTraceGraphResult, AWSError>;
/**
* Retrieves IDs and annotations for traces available for a specified time frame using an optional filter. To get the full traces, pass the trace IDs to BatchGetTraces. A filter expression can target traced requests that hit specific service nodes or edges, have errors, or come from a known user. For example, the following filter expression targets traces that pass through api.example.com: service("api.example.com") This filter expression finds traces that have an annotation named account with the value 12345: annotation.account = "12345" For a full list of indexed fields and keywords that you can use in filter expressions, see Using Filter Expressions in the AWS X-Ray Developer Guide.
*/
getTraceSummaries(params: XRay.Types.GetTraceSummariesRequest, callback?: (err: AWSError, data: XRay.Types.GetTraceSummariesResult) => void): Request<XRay.Types.GetTraceSummariesResult, AWSError>;
/**
* Retrieves IDs and annotations for traces available for a specified time frame using an optional filter. To get the full traces, pass the trace IDs to BatchGetTraces. A filter expression can target traced requests that hit specific service nodes or edges, have errors, or come from a known user. For example, the following filter expression targets traces that pass through api.example.com: service("api.example.com") This filter expression finds traces that have an annotation named account with the value 12345: annotation.account = "12345" For a full list of indexed fields and keywords that you can use in filter expressions, see Using Filter Expressions in the AWS X-Ray Developer Guide.
*/
getTraceSummaries(callback?: (err: AWSError, data: XRay.Types.GetTraceSummariesResult) => void): Request<XRay.Types.GetTraceSummariesResult, AWSError>;
/**
* Returns a list of tags that are applied to the specified AWS X-Ray group or sampling rule.
*/
listTagsForResource(params: XRay.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: XRay.Types.ListTagsForResourceResponse) => void): Request<XRay.Types.ListTagsForResourceResponse, AWSError>;
/**
* Returns a list of tags that are applied to the specified AWS X-Ray group or sampling rule.
*/
listTagsForResource(callback?: (err: AWSError, data: XRay.Types.ListTagsForResourceResponse) => void): Request<XRay.Types.ListTagsForResourceResponse, AWSError>;
/**
* Updates the encryption configuration for X-Ray data.
*/
putEncryptionConfig(params: XRay.Types.PutEncryptionConfigRequest, callback?: (err: AWSError, data: XRay.Types.PutEncryptionConfigResult) => void): Request<XRay.Types.PutEncryptionConfigResult, AWSError>;
/**
* Updates the encryption configuration for X-Ray data.
*/
putEncryptionConfig(callback?: (err: AWSError, data: XRay.Types.PutEncryptionConfigResult) => void): Request<XRay.Types.PutEncryptionConfigResult, AWSError>;
/**
* Used by the AWS X-Ray daemon to upload telemetry.
*/
putTelemetryRecords(params: XRay.Types.PutTelemetryRecordsRequest, callback?: (err: AWSError, data: XRay.Types.PutTelemetryRecordsResult) => void): Request<XRay.Types.PutTelemetryRecordsResult, AWSError>;
/**
* Used by the AWS X-Ray daemon to upload telemetry.
*/
putTelemetryRecords(callback?: (err: AWSError, data: XRay.Types.PutTelemetryRecordsResult) => void): Request<XRay.Types.PutTelemetryRecordsResult, AWSError>;
/**
* Uploads segment documents to AWS X-Ray. The X-Ray SDK generates segment documents and sends them to the X-Ray daemon, which uploads them in batches. A segment document can be a completed segment, an in-progress segment, or an array of subsegments. Segments must include the following fields. For the full segment document schema, see AWS X-Ray Segment Documents in the AWS X-Ray Developer Guide. Required Segment Document Fields name - The name of the service that handled the request. id - A 64-bit identifier for the segment, unique among segments in the same trace, in 16 hexadecimal digits. trace_id - A unique identifier that connects all segments and subsegments originating from a single client request. start_time - Time the segment or subsegment was created, in floating point seconds in epoch time, accurate to milliseconds. For example, 1480615200.010 or 1.480615200010E9. end_time - Time the segment or subsegment was closed. For example, 1480615200.090 or 1.480615200090E9. Specify either an end_time or in_progress. in_progress - Set to true instead of specifying an end_time to record that a segment has been started, but is not complete. Send an in progress segment when your application receives a request that will take a long time to serve, to trace the fact that the request was received. When the response is sent, send the complete segment to overwrite the in-progress segment. A trace_id consists of three numbers separated by hyphens. For example, 1-58406520-a006649127e371903a2de979. This includes: Trace ID Format The version number, i.e. 1. The time of the original request, in Unix epoch time, in 8 hexadecimal digits. For example, 10:00AM December 2nd, 2016 PST in epoch time is 1480615200 seconds, or 58406520 in hexadecimal. A 96-bit identifier for the trace, globally unique, in 24 hexadecimal digits.
*/
putTraceSegments(params: XRay.Types.PutTraceSegmentsRequest, callback?: (err: AWSError, data: XRay.Types.PutTraceSegmentsResult) => void): Request<XRay.Types.PutTraceSegmentsResult, AWSError>;
/**
* Uploads segment documents to AWS X-Ray. The X-Ray SDK generates segment documents and sends them to the X-Ray daemon, which uploads them in batches. A segment document can be a completed segment, an in-progress segment, or an array of subsegments. Segments must include the following fields. For the full segment document schema, see AWS X-Ray Segment Documents in the AWS X-Ray Developer Guide. Required Segment Document Fields name - The name of the service that handled the request. id - A 64-bit identifier for the segment, unique among segments in the same trace, in 16 hexadecimal digits. trace_id - A unique identifier that connects all segments and subsegments originating from a single client request. start_time - Time the segment or subsegment was created, in floating point seconds in epoch time, accurate to milliseconds. For example, 1480615200.010 or 1.480615200010E9. end_time - Time the segment or subsegment was closed. For example, 1480615200.090 or 1.480615200090E9. Specify either an end_time or in_progress. in_progress - Set to true instead of specifying an end_time to record that a segment has been started, but is not complete. Send an in progress segment when your application receives a request that will take a long time to serve, to trace the fact that the request was received. When the response is sent, send the complete segment to overwrite the in-progress segment. A trace_id consists of three numbers separated by hyphens. For example, 1-58406520-a006649127e371903a2de979. This includes: Trace ID Format The version number, i.e. 1. The time of the original request, in Unix epoch time, in 8 hexadecimal digits. For example, 10:00AM December 2nd, 2016 PST in epoch time is 1480615200 seconds, or 58406520 in hexadecimal. A 96-bit identifier for the trace, globally unique, in 24 hexadecimal digits.
*/
putTraceSegments(callback?: (err: AWSError, data: XRay.Types.PutTraceSegmentsResult) => void): Request<XRay.Types.PutTraceSegmentsResult, AWSError>;
/**
* Applies tags to an existing AWS X-Ray group or sampling rule.
*/
tagResource(params: XRay.Types.TagResourceRequest, callback?: (err: AWSError, data: XRay.Types.TagResourceResponse) => void): Request<XRay.Types.TagResourceResponse, AWSError>;
/**
* Applies tags to an existing AWS X-Ray group or sampling rule.
*/
tagResource(callback?: (err: AWSError, data: XRay.Types.TagResourceResponse) => void): Request<XRay.Types.TagResourceResponse, AWSError>;
/**
* Removes tags from an AWS X-Ray group or sampling rule. You cannot edit or delete system tags (those with an aws: prefix).
*/
untagResource(params: XRay.Types.UntagResourceRequest, callback?: (err: AWSError, data: XRay.Types.UntagResourceResponse) => void): Request<XRay.Types.UntagResourceResponse, AWSError>;
/**
* Removes tags from an AWS X-Ray group or sampling rule. You cannot edit or delete system tags (those with an aws: prefix).
*/
untagResource(callback?: (err: AWSError, data: XRay.Types.UntagResourceResponse) => void): Request<XRay.Types.UntagResourceResponse, AWSError>;
/**
* Updates a group resource.
*/
updateGroup(params: XRay.Types.UpdateGroupRequest, callback?: (err: AWSError, data: XRay.Types.UpdateGroupResult) => void): Request<XRay.Types.UpdateGroupResult, AWSError>;
/**
* Updates a group resource.
*/
updateGroup(callback?: (err: AWSError, data: XRay.Types.UpdateGroupResult) => void): Request<XRay.Types.UpdateGroupResult, AWSError>;
/**
* Modifies a sampling rule's configuration.
*/
updateSamplingRule(params: XRay.Types.UpdateSamplingRuleRequest, callback?: (err: AWSError, data: XRay.Types.UpdateSamplingRuleResult) => void): Request<XRay.Types.UpdateSamplingRuleResult, AWSError>;
/**
* Modifies a sampling rule's configuration.
*/
updateSamplingRule(callback?: (err: AWSError, data: XRay.Types.UpdateSamplingRuleResult) => void): Request<XRay.Types.UpdateSamplingRuleResult, AWSError>;
}
declare namespace XRay {
export interface Alias {
/**
* The canonical name of the alias.
*/
Name?: String;
/**
* A list of names for the alias, including the canonical name.
*/
Names?: AliasNames;
/**
* The type of the alias.
*/
Type?: String;
}
export type AliasList = Alias[];
export type AliasNames = String[];
export type AmazonResourceName = string;
export type AnnotationKey = string;
export interface AnnotationValue {
/**
* Value for a Number annotation.
*/
NumberValue?: NullableDouble;
/**
* Value for a Boolean annotation.
*/
BooleanValue?: NullableBoolean;
/**
* Value for a String annotation.
*/
StringValue?: String;
}
export type Annotations = {[key: string]: ValuesWithServiceIds};
export type AttributeKey = string;
export type AttributeMap = {[key: string]: AttributeValue};
export type AttributeValue = string;
export interface AvailabilityZoneDetail {
/**
* The name of a corresponding availability zone.
*/
Name?: String;
}
export interface BackendConnectionErrors {
/**
*
*/
TimeoutCount?: NullableInteger;
/**
*
*/
ConnectionRefusedCount?: NullableInteger;
/**
*
*/
HTTPCode4XXCount?: NullableInteger;
/**
*
*/
HTTPCode5XXCount?: NullableInteger;
/**
*
*/
UnknownHostCount?: NullableInteger;
/**
*
*/
OtherCount?: NullableInteger;
}
export interface BatchGetTracesRequest {
/**
* Specify the trace IDs of requests for which to retrieve segments.
*/
TraceIds: TraceIdList;
/**
* Pagination token.
*/
NextToken?: String;
}
export interface BatchGetTracesResult {
/**
* Full traces for the specified requests.
*/
Traces?: TraceList;
/**
* Trace IDs of requests that haven't been processed.
*/
UnprocessedTraceIds?: UnprocessedTraceIdList;
/**
* Pagination token.
*/
NextToken?: String;
}
export type Boolean = boolean;
export type BorrowCount = number;
export type ClientID = string;
export interface CreateGroupRequest {
/**
* The case-sensitive name of the new group. Default is a reserved name and names must be unique.
*/
GroupName: GroupName;
/**
* The filter expression defining criteria by which to group traces.
*/
FilterExpression?: FilterExpression;
/**
* The structure containing configurations related to insights. The InsightsEnabled boolean can be set to true to enable insights for the new group or false to disable insights for the new group.
*/
InsightsConfiguration?: InsightsConfiguration;
/**
* A map that contains one or more tag keys and tag values to attach to an X-Ray group. For more information about ways to use tags, see Tagging AWS resources in the AWS General Reference. The following restrictions apply to tags: Maximum number of user-applied tags per resource: 50 Maximum tag key length: 128 Unicode characters Maximum tag value length: 256 Unicode characters Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @ Tag keys and values are case sensitive. Don't use aws: as a prefix for keys; it's reserved for AWS use.
*/
Tags?: TagList;
}
export interface CreateGroupResult {
/**
* The group that was created. Contains the name of the group that was created, the ARN of the group that was generated based on the group name, the filter expression, and the insight configuration that was assigned to the group.
*/
Group?: Group;
}
export interface CreateSamplingRuleRequest {
/**
* The rule definition.
*/
SamplingRule: SamplingRule;
/**
* A map that contains one or more tag keys and tag values to attach to an X-Ray sampling rule. For more information about ways to use tags, see Tagging AWS resources in the AWS General Reference. The following restrictions apply to tags: Maximum number of user-applied tags per resource: 50 Maximum tag key length: 128 Unicode characters Maximum tag value length: 256 Unicode characters Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @ Tag keys and values are case sensitive. Don't use aws: as a prefix for keys; it's reserved for AWS use.
*/
Tags?: TagList;
}
export interface CreateSamplingRuleResult {
/**
* The saved rule definition and metadata.
*/
SamplingRuleRecord?: SamplingRuleRecord;
}
export interface DeleteGroupRequest {
/**
* The case-sensitive name of the group.
*/
GroupName?: GroupName;
/**
* The ARN of the group that was generated on creation.
*/
GroupARN?: GroupARN;
}
export interface DeleteGroupResult {
}
export interface DeleteSamplingRuleRequest {
/**
* The name of the sampling rule. Specify a rule by either name or ARN, but not both.
*/
RuleName?: String;
/**
* The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
*/
RuleARN?: String;
}
export interface DeleteSamplingRuleResult {
/**
* The deleted rule definition and metadata.
*/
SamplingRuleRecord?: SamplingRuleRecord;
}
export type Double = number;
export type EC2InstanceId = string;
export interface Edge {
/**
* Identifier of the edge. Unique within a service map.
*/
ReferenceId?: NullableInteger;
/**
* The start time of the first segment on the edge.
*/
StartTime?: Timestamp;
/**
* The end time of the last segment on the edge.
*/
EndTime?: Timestamp;
/**
* Response statistics for segments on the edge.
*/
SummaryStatistics?: EdgeStatistics;
/**
* A histogram that maps the spread of client response times on an edge.
*/
ResponseTimeHistogram?: Histogram;
/**
* Aliases for the edge.
*/
Aliases?: AliasList;
}
export type EdgeList = Edge[];
export interface EdgeStatistics {
/**
* The number of requests that completed with a 2xx Success status code.
*/
OkCount?: NullableLong;
/**
* Information about requests that failed with a 4xx Client Error status code.
*/
ErrorStatistics?: ErrorStatistics;
/**
* Information about requests that failed with a 5xx Server Error status code.
*/
FaultStatistics?: FaultStatistics;
/**
* The total number of completed requests.
*/
TotalCount?: NullableLong;
/**
* The aggregate response time of completed requests.
*/
TotalResponseTime?: NullableDouble;
}
export interface EncryptionConfig {
/**
* The ID of the customer master key (CMK) used for encryption, if applicable.
*/
KeyId?: String;
/**
* The encryption status. While the status is UPDATING, X-Ray may encrypt data with a combination of the new and old settings.
*/
Status?: EncryptionStatus;
/**
* The type of encryption. Set to KMS for encryption with CMKs. Set to NONE for default encryption.
*/
Type?: EncryptionType;
}
export type EncryptionKeyId = string;
export type EncryptionStatus = "UPDATING"|"ACTIVE"|string;
export type EncryptionType = "NONE"|"KMS"|string;
export type EntitySelectorExpression = string;
export interface ErrorRootCause {
/**
* A list of services corresponding to an error. A service identifies a segment and it contains a name, account ID, type, and inferred flag.
*/
Services?: ErrorRootCauseServices;
/**
* A flag that denotes that the root cause impacts the trace client.
*/
ClientImpacting?: NullableBoolean;
}
export interface ErrorRootCauseEntity {
/**
* The name of the entity.
*/
Name?: String;
/**
* The types and messages of the exceptions.
*/
Exceptions?: RootCauseExceptions;
/**
* A flag that denotes a remote subsegment.
*/
Remote?: NullableBoolean;
}
export type ErrorRootCauseEntityPath = ErrorRootCauseEntity[];
export interface ErrorRootCauseService {
/**
* The service name.
*/
Name?: String;
/**
* A collection of associated service names.
*/
Names?: ServiceNames;
/**
* The type associated to the service.
*/
Type?: String;
/**
* The account ID associated to the service.
*/
AccountId?: String;
/**
* The path of root cause entities found on the service.
*/
EntityPath?: ErrorRootCauseEntityPath;
/**
* A Boolean value indicating if the service is inferred from the trace.
*/
Inferred?: NullableBoolean;
}
export type ErrorRootCauseServices = ErrorRootCauseService[];
export type ErrorRootCauses = ErrorRootCause[];
export interface ErrorStatistics {
/**
* The number of requests that failed with a 419 throttling status code.
*/
ThrottleCount?: NullableLong;
/**
* The number of requests that failed with untracked 4xx Client Error status codes.
*/
OtherCount?: NullableLong;
/**
* The total number of requests that failed with a 4xx Client Error status code.
*/
TotalCount?: NullableLong;
}
export interface FaultRootCause {
/**
* A list of corresponding services. A service identifies a segment and it contains a name, account ID, type, and inferred flag.
*/
Services?: FaultRootCauseServices;
/**
* A flag that denotes that the root cause impacts the trace client.
*/
ClientImpacting?: NullableBoolean;
}
export interface FaultRootCauseEntity {
/**
* The name of the entity.
*/
Name?: String;
/**
* The types and messages of the exceptions.
*/
Exceptions?: RootCauseExceptions;
/**
* A flag that denotes a remote subsegment.
*/
Remote?: NullableBoolean;
}
export type FaultRootCauseEntityPath = FaultRootCauseEntity[];
export interface FaultRootCauseService {
/**
* The service name.
*/
Name?: String;
/**
* A collection of associated service names.
*/
Names?: ServiceNames;
/**
* The type associated to the service.
*/
Type?: String;
/**
* The account ID associated to the service.
*/
AccountId?: String;
/**
* The path of root cause entities found on the service.
*/
EntityPath?: FaultRootCauseEntityPath;
/**
* A Boolean value indicating if the service is inferred from the trace.
*/
Inferred?: NullableBoolean;
}
export type FaultRootCauseServices = FaultRootCauseService[];
export type FaultRootCauses = FaultRootCause[];
export interface FaultStatistics {
/**
* The number of requests that failed with untracked 5xx Server Error status codes.
*/
OtherCount?: NullableLong;
/**
* The total number of requests that failed with a 5xx Server Error status code.
*/
TotalCount?: NullableLong;
}
export type FilterExpression = string;
export type FixedRate = number;
export interface GetEncryptionConfigRequest {
}
export interface GetEncryptionConfigResult {
/**
* The encryption configuration document.
*/
EncryptionConfig?: EncryptionConfig;
}
export interface GetGroupRequest {
/**
* The case-sensitive name of the group.
*/
GroupName?: GroupName;
/**
* The ARN of the group that was generated on creation.
*/
GroupARN?: GroupARN;
}
export interface GetGroupResult {
/**
* The group that was requested. Contains the name of the group, the ARN of the group, and the filter expression that assigned to the group.
*/
Group?: Group;
}
export type GetGroupsNextToken = string;
export interface GetGroupsRequest {
/**
* Pagination token.
*/
NextToken?: GetGroupsNextToken;
}
export interface GetGroupsResult {
/**
* The collection of all active groups.
*/
Groups?: GroupSummaryList;
/**
* Pagination token.
*/
NextToken?: String;
}
export interface GetSamplingRulesRequest {
/**
* Pagination token.
*/
NextToken?: String;
}
export interface GetSamplingRulesResult {
/**
* Rule definitions and metadata.
*/
SamplingRuleRecords?: SamplingRuleRecordList;
/**
* Pagination token.
*/
NextToken?: String;
}
export interface GetSamplingStatisticSummariesRequest {
/**
* Pagination token.
*/
NextToken?: String;
}
export interface GetSamplingStatisticSummariesResult {
/**
* Information about the number of requests instrumented for each sampling rule.
*/
SamplingStatisticSummaries?: SamplingStatisticSummaryList;
/**
* Pagination token.
*/
NextToken?: String;
}
export interface GetSamplingTargetsRequest {
/**
* Information about rules that the service is using to sample requests.
*/
SamplingStatisticsDocuments: SamplingStatisticsDocumentList;
}
export interface GetSamplingTargetsResult {
/**
* Updated rules that the service should use to sample requests.
*/
SamplingTargetDocuments?: SamplingTargetDocumentList;
/**
* The last time a user changed the sampling rule configuration. If the sampling rule configuration changed since the service last retrieved it, the service should call GetSamplingRules to get the latest version.
*/
LastRuleModification?: Timestamp;
/**
* Information about SamplingStatisticsDocument that X-Ray could not process.
*/
UnprocessedStatistics?: UnprocessedStatisticsList;
}
export interface GetServiceGraphRequest {
/**
* The start of the time frame for which to generate a graph.
*/
StartTime: Timestamp;
/**
* The end of the timeframe for which to generate a graph.
*/
EndTime: Timestamp;
/**
* The name of a group to generate a graph based on.
*/
GroupName?: GroupName;
/**
* The ARN of a group to generate a graph based on.
*/
GroupARN?: GroupARN;
/**
* Pagination token.
*/
NextToken?: String;
}
export interface GetServiceGraphResult {
/**
* The start of the time frame for which the graph was generated.
*/
StartTime?: Timestamp;
/**
* The end of the time frame for which the graph was generated.
*/
EndTime?: Timestamp;
/**
* The services that have processed a traced request during the specified time frame.
*/
Services?: ServiceList;
/**
* A flag indicating whether the group's filter expression has been consistent, or if the returned service graph may show traces from an older version of the group's filter expression.
*/
ContainsOldGroupVersions?: Boolean;
/**
* Pagination token.
*/
NextToken?: String;
}
export interface GetTimeSeriesServiceStatisticsRequest {
/**
* The start of the time frame for which to aggregate statistics.
*/
StartTime: Timestamp;
/**
* The end of the time frame for which to aggregate statistics.
*/
EndTime: Timestamp;
/**
* The case-sensitive name of the group for which to pull statistics from.
*/
GroupName?: GroupName;
/**
* The ARN of the group for which to pull statistics from.
*/
GroupARN?: GroupARN;
/**
* A filter expression defining entities that will be aggregated for statistics. Supports ID, service, and edge functions. If no selector expression is specified, edge statistics are returned.
*/
EntitySelectorExpression?: EntitySelectorExpression;
/**
* Aggregation period in seconds.
*/
Period?: NullableInteger;
/**
* Pagination token.
*/
NextToken?: String;
}
export interface GetTimeSeriesServiceStatisticsResult {
/**
* The collection of statistics.
*/
TimeSeriesServiceStatistics?: TimeSeriesServiceStatisticsList;
/**
* A flag indicating whether or not a group's filter expression has been consistent, or if a returned aggregation may show statistics from an older version of the group's filter expression.
*/
ContainsOldGroupVersions?: Boolean;
/**
* Pagination token.
*/
NextToken?: String;
}
export interface GetTraceGraphRequest {
/**
* Trace IDs of requests for which to generate a service graph.
*/
TraceIds: TraceIdList;
/**
* Pagination token.
*/
NextToken?: String;
}
export interface GetTraceGraphResult {
/**
* The services that have processed one of the specified requests.
*/
Services?: ServiceList;
/**
* Pagination token.
*/
NextToken?: String;
}
export interface GetTraceSummariesRequest {
/**
* The start of the time frame for which to retrieve traces.
*/
StartTime: Timestamp;
/**
* The end of the time frame for which to retrieve traces.
*/
EndTime: Timestamp;
/**
* A parameter to indicate whether to query trace summaries by TraceId or Event time.
*/
TimeRangeType?: TimeRangeType;
/**
* Set to true to get summaries for only a subset of available traces.
*/
Sampling?: NullableBoolean;
/**
* A paramater to indicate whether to enable sampling on trace summaries. Input parameters are Name and Value.
*/
SamplingStrategy?: SamplingStrategy;
/**
* Specify a filter expression to retrieve trace summaries for services or requests that meet certain requirements.
*/
FilterExpression?: FilterExpression;
/**
* Specify the pagination token returned by a previous request to retrieve the next page of results.
*/
NextToken?: String;
}
export interface GetTraceSummariesResult {
/**
* Trace IDs and annotations for traces that were found in the specified time frame.
*/
TraceSummaries?: TraceSummaryList;
/**
* The start time of this page of results.
*/
ApproximateTime?: Timestamp;
/**
* The total number of traces processed, including traces that did not match the specified filter expression.
*/
TracesProcessedCount?: NullableLong;
/**
* If the requested time frame contained more than one page of results, you can use this token to retrieve the next page. The first page contains the most most recent results, closest to the end of the time frame.
*/
NextToken?: String;
}
export interface Group {
/**
* The unique case-sensitive name of the group.
*/
GroupName?: String;
/**
* The ARN of the group generated based on the GroupName.
*/
GroupARN?: String;
/**
* The filter expression defining the parameters to include traces.
*/
FilterExpression?: String;
/**
* The structure containing configurations related to insights. The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group.
*/
InsightsConfiguration?: InsightsConfiguration;
}
export type GroupARN = string;
export type GroupName = string;
export interface GroupSummary {
/**
* The unique case-sensitive name of the group.
*/
GroupName?: String;
/**
* The ARN of the group generated based on the GroupName.
*/
GroupARN?: String;
/**
* The filter expression defining the parameters to include traces.
*/
FilterExpression?: String;
/**
* The structure containing configurations related to insights. The InsightsEnabled boolean can be set to true to enable insights for the groups or false to disable insights for the groups.
*/
InsightsConfiguration?: InsightsConfiguration;
}
export type GroupSummaryList = GroupSummary[];
export type HTTPMethod = string;
export type Histogram = HistogramEntry[];
export interface HistogramEntry {
/**
* The value of the entry.
*/
Value?: Double;
/**
* The prevalence of the entry.
*/
Count?: Integer;
}
export type Host = string;
export type Hostname = string;
export interface Http {
/**
* The request URL.
*/
HttpURL?: String;
/**
* The response status.
*/
HttpStatus?: NullableInteger;
/**
* The request method.
*/
HttpMethod?: String;
/**
* The request's user agent string.
*/
UserAgent?: String;
/**
* The IP address of the requestor.
*/
ClientIp?: String;
}
export interface InsightsConfiguration {
/**
* Set the InsightsEnabled value to true to enable insights or false to disable insights.
*/
InsightsEnabled?: NullableBoolean;
}
export interface InstanceIdDetail {
/**
* The ID of a corresponding EC2 instance.
*/
Id?: String;
}
export type Integer = number;
export interface ListTagsForResourceRequest {
/**
* The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.
*/
ResourceARN: AmazonResourceName;
/**
* A pagination token. If multiple pages of results are returned, use the NextToken value returned with the current page of results as the value of this parameter to get the next page of results.
*/
NextToken?: String;
}
export interface ListTagsForResourceResponse {
/**
* A list of tags, as key and value pairs, that is associated with the specified X-Ray group or sampling rule.
*/
Tags?: TagList;
/**
* A pagination token. If multiple pages of results are returned, use the NextToken value returned with the current page of results to get the next page of results.
*/
NextToken?: String;
}
export type NullableBoolean = boolean;
export type NullableDouble = number;
export type NullableInteger = number;
export type NullableLong = number;
export type Priority = number;
export interface PutEncryptionConfigRequest {
/**
* An AWS KMS customer master key (CMK) in one of the following formats: Alias - The name of the key. For example, alias/MyKey. Key ID - The KMS key ID of the key. For example, ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. AWS X-Ray does not support asymmetric CMKs. ARN - The full Amazon Resource Name of the key ID or alias. For example, arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Use this format to specify a key in a different account. Omit this key if you set Type to NONE.
*/
KeyId?: EncryptionKeyId;
/**
* The type of encryption. Set to KMS to use your own key for encryption. Set to NONE for default encryption.
*/
Type: EncryptionType;
}
export interface PutEncryptionConfigResult {
/**
* The new encryption configuration.
*/
EncryptionConfig?: EncryptionConfig;
}
export interface PutTelemetryRecordsRequest {
/**
*
*/
TelemetryRecords: TelemetryRecordList;
/**
*
*/
EC2InstanceId?: EC2InstanceId;
/**
*
*/
Hostname?: Hostname;
/**
*
*/
ResourceARN?: ResourceARN;
}
export interface PutTelemetryRecordsResult {
}
export interface PutTraceSegmentsRequest {
/**
* A string containing a JSON document defining one or more segments or subsegments.
*/
TraceSegmentDocuments: TraceSegmentDocumentList;
}
export interface PutTraceSegmentsResult {
/**
* Segments that failed processing.
*/
UnprocessedTraceSegments?: UnprocessedTraceSegmentList;
}
export type RequestCount = number;
export type ReservoirSize = number;
export type ResourceARN = string;
export interface ResourceARNDetail {
/**
* The ARN of a corresponding resource.
*/
ARN?: String;
}
export interface ResponseTimeRootCause {
/**
* A list of corresponding services. A service identifies a segment and contains a name, account ID, type, and inferred flag.
*/
Services?: ResponseTimeRootCauseServices;
/**
* A flag that denotes that the root cause impacts the trace client.
*/
ClientImpacting?: NullableBoolean;
}
export interface ResponseTimeRootCauseEntity {
/**
* The name of the entity.
*/
Name?: String;
/**
* The types and messages of the exceptions.
*/
Coverage?: NullableDouble;
/**
* A flag that denotes a remote subsegment.
*/
Remote?: NullableBoolean;
}
export type ResponseTimeRootCauseEntityPath = ResponseTimeRootCauseEntity[];
export interface ResponseTimeRootCauseService {
/**
* The service name.
*/
Name?: String;
/**
* A collection of associated service names.
*/
Names?: ServiceNames;
/**
* The type associated to the service.
*/
Type?: String;
/**
* The account ID associated to the service.
*/
AccountId?: String;
/**
* The path of root cause entities found on the service.
*/
EntityPath?: ResponseTimeRootCauseEntityPath;
/**
* A Boolean value indicating if the service is inferred from the trace.
*/
Inferred?: NullableBoolean;
}
export type ResponseTimeRootCauseServices = ResponseTimeRootCauseService[];
export type ResponseTimeRootCauses = ResponseTimeRootCause[];
export interface RootCauseException {
/**
* The name of the exception.
*/
Name?: String;
/**
* The message of the exception.
*/
Message?: String;
}
export type RootCauseExceptions = RootCauseException[];
export type RuleName = string;
export type SampledCount = number;
export interface SamplingRule {
/**
* The name of the sampling rule. Specify a rule by either name or ARN, but not both.
*/
RuleName?: RuleName;
/**
* The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
*/
RuleARN?: String;
/**
* Matches the ARN of the AWS resource on which the service runs.
*/
ResourceARN: ResourceARN;
/**
* The priority of the sampling rule.
*/
Priority: Priority;
/**
* The percentage of matching requests to instrument, after the reservoir is exhausted.
*/
FixedRate: FixedRate;
/**
* A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.
*/
ReservoirSize: ReservoirSize;
/**
* Matches the name that the service uses to identify itself in segments.
*/
ServiceName: ServiceName;
/**
* Matches the origin that the service uses to identify its type in segments.
*/
ServiceType: ServiceType;
/**
* Matches the hostname from a request URL.
*/
Host: Host;
/**
* Matches the HTTP method of a request.
*/
HTTPMethod: HTTPMethod;
/**
* Matches the path from a request URL.
*/
URLPath: URLPath;
/**
* The version of the sampling rule format (1).
*/
Version: Version;
/**
* Matches attributes derived from the request.
*/
Attributes?: AttributeMap;
}
export interface SamplingRuleRecord {
/**
* The sampling rule.
*/
SamplingRule?: SamplingRule;
/**
* When the rule was created.
*/
CreatedAt?: Timestamp;
/**
* When the rule was last modified.
*/
ModifiedAt?: Timestamp;
}
export type SamplingRuleRecordList = SamplingRuleRecord[];
export interface SamplingRuleUpdate {
/**
* The name of the sampling rule. Specify a rule by either name or ARN, but not both.
*/
RuleName?: RuleName;
/**
* The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
*/
RuleARN?: String;
/**
* Matches the ARN of the AWS resource on which the service runs.
*/
ResourceARN?: ResourceARN;
/**
* The priority of the sampling rule.
*/
Priority?: NullableInteger;
/**
* The percentage of matching requests to instrument, after the reservoir is exhausted.
*/
FixedRate?: NullableDouble;
/**
* A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.
*/
ReservoirSize?: NullableInteger;
/**
* Matches the hostname from a request URL.
*/
Host?: Host;
/**
* Matches the name that the service uses to identify itself in segments.
*/
ServiceName?: ServiceName;
/**
* Matches the origin that the service uses to identify its type in segments.
*/
ServiceType?: ServiceType;
/**
* Matches the HTTP method of a request.
*/
HTTPMethod?: HTTPMethod;
/**
* Matches the path from a request URL.
*/
URLPath?: URLPath;
/**
* Matches attributes derived from the request.
*/
Attributes?: AttributeMap;
}
export interface SamplingStatisticSummary {
/**
* The name of the sampling rule.
*/
RuleName?: String;
/**
* The start time of the reporting window.
*/
Timestamp?: Timestamp;
/**
* The number of requests that matched the rule.
*/
RequestCount?: Integer;
/**
* The number of requests recorded with borrowed reservoir quota.
*/
BorrowCount?: Integer;
/**
* The number of requests recorded.
*/
SampledCount?: Integer;
}
export type SamplingStatisticSummaryList = SamplingStatisticSummary[];
export interface SamplingStatisticsDocument {
/**
* The name of the sampling rule.
*/
RuleName: RuleName;
/**
* A unique identifier for the service in hexadecimal.
*/
ClientID: ClientID;
/**
* The current time.
*/
Timestamp: Timestamp;
/**
* The number of requests that matched the rule.
*/
RequestCount: RequestCount;
/**
* The number of requests recorded.
*/
SampledCount: SampledCount;
/**
* The number of requests recorded with borrowed reservoir quota.
*/
BorrowCount?: BorrowCount;
}
export type SamplingStatisticsDocumentList = SamplingStatisticsDocument[];
export interface SamplingStrategy {
/**
* The name of a sampling rule.
*/
Name?: SamplingStrategyName;
/**
* The value of a sampling rule.
*/
Value?: NullableDouble;
}
export type SamplingStrategyName = "PartialScan"|"FixedRate"|string;
export interface SamplingTargetDocument {
/**
* The name of the sampling rule.
*/
RuleName?: String;
/**
* The percentage of matching requests to instrument, after the reservoir is exhausted.
*/
FixedRate?: Double;
/**
* The number of requests per second that X-Ray allocated this service.
*/
ReservoirQuota?: NullableInteger;
/**
* When the reservoir quota expires.
*/
ReservoirQuotaTTL?: Timestamp;
/**
* The number of seconds for the service to wait before getting sampling targets again.
*/
Interval?: NullableInteger;
}
export type SamplingTargetDocumentList = SamplingTargetDocument[];
export interface Segment {
/**
* The segment's ID.
*/
Id?: SegmentId;
/**
* The segment document.
*/
Document?: SegmentDocument;
}
export type SegmentDocument = string;
export type SegmentId = string;
export type SegmentList = Segment[];
export interface Service {
/**
* Identifier for the service. Unique within the service map.
*/
ReferenceId?: NullableInteger;
/**
* The canonical name of the service.
*/
Name?: String;
/**
* A list of names for the service, including the canonical name.
*/
Names?: ServiceNames;
/**
* Indicates that the service was the first service to process a request.
*/
Root?: NullableBoolean;
/**
* Identifier of the AWS account in which the service runs.
*/
AccountId?: String;
/**
* The type of service. AWS Resource - The type of an AWS resource. For example, AWS::EC2::Instance for a application running on Amazon EC2 or AWS::DynamoDB::Table for an Amazon DynamoDB table that the application used. AWS Service - The type of an AWS service. For example, AWS::DynamoDB for downstream calls to Amazon DynamoDB that didn't target a specific table. client - Represents the clients that sent requests to a root service. remote - A downstream service of indeterminate type.
*/
Type?: String;
/**
* The service's state.
*/
State?: String;
/**
* The start time of the first segment that the service generated.
*/
StartTime?: Timestamp;
/**
* The end time of the last segment that the service generated.
*/
EndTime?: Timestamp;
/**
* Connections to downstream services.
*/
Edges?: EdgeList;
/**
* Aggregated statistics for the service.
*/
SummaryStatistics?: ServiceStatistics;
/**
* A histogram that maps the spread of service durations.
*/
DurationHistogram?: Histogram;
/**
* A histogram that maps the spread of service response times.
*/
ResponseTimeHistogram?: Histogram;
}
export interface ServiceId {
/**
*
*/
Name?: String;
/**
*
*/
Names?: ServiceNames;
/**
*
*/
AccountId?: String;
/**
*
*/
Type?: String;
}
export type ServiceIds = ServiceId[];
export type ServiceList = Service[];
export type ServiceName = string;
export type ServiceNames = String[];
export interface ServiceStatistics {
/**
* The number of requests that completed with a 2xx Success status code.
*/
OkCount?: NullableLong;
/**
* Information about requests that failed with a 4xx Client Error status code.
*/
ErrorStatistics?: ErrorStatistics;
/**
* Information about requests that failed with a 5xx Server Error status code.
*/
FaultStatistics?: FaultStatistics;
/**
* The total number of completed requests.
*/
TotalCount?: NullableLong;
/**
* The aggregate response time of completed requests.
*/
TotalResponseTime?: NullableDouble;
}
export type ServiceType = string;
export type String = string;
export interface Tag {
/**
* A tag key, such as Stage or Name. A tag key cannot be empty. The key can be a maximum of 128 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /
*/
Key: TagKey;
/**
* An optional tag value, such as Production or test-only. The value can be a maximum of 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /
*/
Value: TagValue;
}
export type TagKey = string;
export type TagKeyList = TagKey[];
export type TagList = Tag[];
export interface TagResourceRequest {
/**
* The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.
*/
ResourceARN: AmazonResourceName;
/**
* A map that contains one or more tag keys and tag values to attach to an X-Ray group or sampling rule. For more information about ways to use tags, see Tagging AWS resources in the AWS General Reference. The following restrictions apply to tags: Maximum number of user-applied tags per resource: 50 Maximum tag key length: 128 Unicode characters Maximum tag value length: 256 Unicode characters Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @ Tag keys and values are case sensitive. Don't use aws: as a prefix for keys; it's reserved for AWS use. You cannot edit or delete system tags.
*/
Tags: TagList;
}
export interface TagResourceResponse {
}
export type TagValue = string;
export interface TelemetryRecord {
/**
*
*/
Timestamp: Timestamp;
/**
*
*/
SegmentsReceivedCount?: NullableInteger;
/**
*
*/
SegmentsSentCount?: NullableInteger;
/**
*
*/
SegmentsSpilloverCount?: NullableInteger;
/**
*
*/
SegmentsRejectedCount?: NullableInteger;
/**
*
*/
BackendConnectionErrors?: BackendConnectionErrors;
}
export type TelemetryRecordList = TelemetryRecord[];
export type TimeRangeType = "TraceId"|"Event"|string;
export interface TimeSeriesServiceStatistics {
/**
* Timestamp of the window for which statistics are aggregated.
*/
Timestamp?: Timestamp;
EdgeSummaryStatistics?: EdgeStatistics;
ServiceSummaryStatistics?: ServiceStatistics;
/**
* The response time histogram for the selected entities.
*/
ResponseTimeHistogram?: Histogram;
}
export type TimeSeriesServiceStatisticsList = TimeSeriesServiceStatistics[];
export type Timestamp = Date;
export interface Trace {
/**
* The unique identifier for the request that generated the trace's segments and subsegments.
*/
Id?: TraceId;
/**
* The length of time in seconds between the start time of the root segment and the end time of the last segment that completed.
*/
Duration?: NullableDouble;
/**
* Segment documents for the segments and subsegments that comprise the trace.
*/
Segments?: SegmentList;
}
export type TraceAvailabilityZones = AvailabilityZoneDetail[];
export type TraceId = string;
export type TraceIdList = TraceId[];
export type TraceInstanceIds = InstanceIdDetail[];
export type TraceList = Trace[];
export type TraceResourceARNs = ResourceARNDetail[];
export type TraceSegmentDocument = string;
export type TraceSegmentDocumentList = TraceSegmentDocument[];
export interface TraceSummary {
/**
* The unique identifier for the request that generated the trace's segments and subsegments.
*/
Id?: TraceId;
/**
* The length of time in seconds between the start time of the root segment and the end time of the last segment that completed.
*/
Duration?: NullableDouble;
/**
* The length of time in seconds between the start and end times of the root segment. If the service performs work asynchronously, the response time measures the time before the response is sent to the user, while the duration measures the amount of time before the last traced activity completes.
*/
ResponseTime?: NullableDouble;
/**
* The root segment document has a 500 series error.
*/
HasFault?: NullableBoolean;
/**
* The root segment document has a 400 series error.
*/
HasError?: NullableBoolean;
/**
* One or more of the segment documents has a 429 throttling error.
*/
HasThrottle?: NullableBoolean;
/**
* One or more of the segment documents is in progress.
*/
IsPartial?: NullableBoolean;
/**
* Information about the HTTP request served by the trace.
*/
Http?: Http;
/**
* Annotations from the trace's segment documents.
*/
Annotations?: Annotations;
/**
* Users from the trace's segment documents.
*/
Users?: TraceUsers;
/**
* Service IDs from the trace's segment documents.
*/
ServiceIds?: ServiceIds;
/**
* A list of resource ARNs for any resource corresponding to the trace segments.
*/
ResourceARNs?: TraceResourceARNs;
/**
* A list of EC2 instance IDs for any instance corresponding to the trace segments.
*/
InstanceIds?: TraceInstanceIds;
/**
* A list of availability zones for any zone corresponding to the trace segments.
*/
AvailabilityZones?: TraceAvailabilityZones;
/**
* The root of a trace.
*/
EntryPoint?: ServiceId;
/**
* A collection of FaultRootCause structures corresponding to the the trace segments.
*/
FaultRootCauses?: FaultRootCauses;
/**
* A collection of ErrorRootCause structures corresponding to the trace segments.
*/
ErrorRootCauses?: ErrorRootCauses;
/**
* A collection of ResponseTimeRootCause structures corresponding to the trace segments.
*/
ResponseTimeRootCauses?: ResponseTimeRootCauses;
/**
* The revision number of a trace.
*/
Revision?: Integer;
/**
* The matched time stamp of a defined event.
*/
MatchedEventTime?: Timestamp;
}
export type TraceSummaryList = TraceSummary[];
export interface TraceUser {
/**
* The user's name.
*/
UserName?: String;
/**
* Services that the user's request hit.
*/
ServiceIds?: ServiceIds;
}
export type TraceUsers = TraceUser[];
export type URLPath = string;
export interface UnprocessedStatistics {
/**
* The name of the sampling rule.
*/
RuleName?: String;
/**
* The error code.
*/
ErrorCode?: String;
/**
* The error message.
*/
Message?: String;
}
export type UnprocessedStatisticsList = UnprocessedStatistics[];
export type UnprocessedTraceIdList = TraceId[];
export interface UnprocessedTraceSegment {
/**
* The segment's ID.
*/
Id?: String;
/**
* The error that caused processing to fail.
*/
ErrorCode?: String;
/**
* The error message.
*/
Message?: String;
}
export type UnprocessedTraceSegmentList = UnprocessedTraceSegment[];
export interface UntagResourceRequest {
/**
* The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.
*/
ResourceARN: AmazonResourceName;
/**
* Keys for one or more tags that you want to remove from an X-Ray group or sampling rule.
*/
TagKeys: TagKeyList;
}
export interface UntagResourceResponse {
}
export interface UpdateGroupRequest {
/**
* The case-sensitive name of the group.
*/
GroupName?: GroupName;
/**
* The ARN that was generated upon creation.
*/
GroupARN?: GroupARN;
/**
* The updated filter expression defining criteria by which to group traces.
*/
FilterExpression?: FilterExpression;
/**
* The structure containing configurations related to insights. The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group.
*/
InsightsConfiguration?: InsightsConfiguration;
}
export interface UpdateGroupResult {
/**
* The group that was updated. Contains the name of the group that was updated, the ARN of the group that was updated, the updated filter expression, and the updated insight configuration assigned to the group.
*/
Group?: Group;
}
export interface UpdateSamplingRuleRequest {
/**
* The rule and fields to change.
*/
SamplingRuleUpdate: SamplingRuleUpdate;
}
export interface UpdateSamplingRuleResult {
/**
* The updated rule definition and metadata.
*/
SamplingRuleRecord?: SamplingRuleRecord;
}
export interface ValueWithServiceIds {
/**
* Values of the annotation.
*/
AnnotationValue?: AnnotationValue;
/**
* Services to which the annotation applies.
*/
ServiceIds?: ServiceIds;
}
export type ValuesWithServiceIds = ValueWithServiceIds[];
export type Version = number;
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2016-04-12"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the XRay client.
*/
export import Types = XRay;
}
export = XRay;