@aws-sdk/client-xray 3.693.0 → 3.698.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. package/README.md +64 -0
  2. package/dist-cjs/index.js +506 -24
  3. package/dist-es/XRay.js +16 -0
  4. package/dist-es/commands/CancelTraceRetrievalCommand.js +22 -0
  5. package/dist-es/commands/GetIndexingRulesCommand.js +22 -0
  6. package/dist-es/commands/GetRetrievedTracesGraphCommand.js +22 -0
  7. package/dist-es/commands/GetTraceSegmentDestinationCommand.js +22 -0
  8. package/dist-es/commands/ListRetrievedTracesCommand.js +22 -0
  9. package/dist-es/commands/StartTraceRetrievalCommand.js +22 -0
  10. package/dist-es/commands/UpdateIndexingRuleCommand.js +22 -0
  11. package/dist-es/commands/UpdateTraceSegmentDestinationCommand.js +22 -0
  12. package/dist-es/commands/index.js +8 -0
  13. package/dist-es/models/models_0.js +50 -14
  14. package/dist-es/protocols/Aws_restJson1.js +294 -4
  15. package/dist-types/XRay.d.ts +59 -0
  16. package/dist-types/XRayClient.d.ts +10 -2
  17. package/dist-types/commands/BatchGetTracesCommand.d.ts +4 -1
  18. package/dist-types/commands/CancelTraceRetrievalCommand.d.ts +81 -0
  19. package/dist-types/commands/GetIndexingRulesCommand.d.ts +91 -0
  20. package/dist-types/commands/GetRetrievedTracesGraphCommand.d.ts +185 -0
  21. package/dist-types/commands/GetTraceSegmentDestinationCommand.d.ts +78 -0
  22. package/dist-types/commands/GetTraceSummariesCommand.d.ts +2 -2
  23. package/dist-types/commands/ListRetrievedTracesCommand.d.ts +104 -0
  24. package/dist-types/commands/PutTraceSegmentsCommand.d.ts +14 -4
  25. package/dist-types/commands/StartTraceRetrievalCommand.d.ts +90 -0
  26. package/dist-types/commands/UpdateIndexingRuleCommand.d.ts +98 -0
  27. package/dist-types/commands/UpdateTraceSegmentDestinationCommand.d.ts +80 -0
  28. package/dist-types/commands/index.d.ts +8 -0
  29. package/dist-types/models/models_0.d.ts +826 -256
  30. package/dist-types/protocols/Aws_restJson1.d.ts +72 -0
  31. package/dist-types/ts3.4/XRay.d.ts +139 -0
  32. package/dist-types/ts3.4/XRayClient.d.ts +50 -2
  33. package/dist-types/ts3.4/commands/CancelTraceRetrievalCommand.d.ts +51 -0
  34. package/dist-types/ts3.4/commands/GetIndexingRulesCommand.d.ts +50 -0
  35. package/dist-types/ts3.4/commands/GetRetrievedTracesGraphCommand.d.ts +51 -0
  36. package/dist-types/ts3.4/commands/GetTraceSegmentDestinationCommand.d.ts +51 -0
  37. package/dist-types/ts3.4/commands/ListRetrievedTracesCommand.d.ts +51 -0
  38. package/dist-types/ts3.4/commands/StartTraceRetrievalCommand.d.ts +51 -0
  39. package/dist-types/ts3.4/commands/UpdateIndexingRuleCommand.d.ts +51 -0
  40. package/dist-types/ts3.4/commands/UpdateTraceSegmentDestinationCommand.d.ts +51 -0
  41. package/dist-types/ts3.4/commands/index.d.ts +8 -0
  42. package/dist-types/ts3.4/models/models_0.d.ts +213 -61
  43. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +96 -0
  44. package/package.json +35 -35
@@ -161,8 +161,8 @@ export interface BatchGetTracesRequest {
161
161
  * compiled from documents uploaded with <a href="https://docs.aws.amazon.com/xray/latest/api/API_PutTraceSegments.html">PutTraceSegments</a>, or an
162
162
  * <code>inferred</code> segment for a downstream service, generated from a subsegment sent by
163
163
  * the service that called it.</p>
164
- * <p>For the full segment document schema, see <a href="https://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html">Amazon Web Services X-Ray Segment
165
- * Documents</a> in the <i>Amazon Web Services X-Ray Developer Guide</i>.</p>
164
+ * <p>For the full segment document schema, see <a href="https://docs.aws.amazon.com/xray/latest/devguide/aws-xray-interface-api.html#xray-api-segmentdocuments">Amazon Web Services X-Ray segment
165
+ * documents</a> in the <i>Amazon Web Services X-Ray Developer Guide</i>.</p>
166
166
  * @public
167
167
  */
168
168
  export interface Segment {
@@ -252,6 +252,38 @@ export declare class ThrottledException extends __BaseException {
252
252
  */
253
253
  constructor(opts: __ExceptionOptionType<ThrottledException, __BaseException>);
254
254
  }
255
+ /**
256
+ * @public
257
+ */
258
+ export interface CancelTraceRetrievalRequest {
259
+ /**
260
+ * <p>
261
+ * Retrieval token.
262
+ * </p>
263
+ * @public
264
+ */
265
+ RetrievalToken: string | undefined;
266
+ }
267
+ /**
268
+ * @public
269
+ */
270
+ export interface CancelTraceRetrievalResult {
271
+ }
272
+ /**
273
+ * <p>The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is
274
+ * correct.</p>
275
+ * @public
276
+ */
277
+ export declare class ResourceNotFoundException extends __BaseException {
278
+ readonly name: "ResourceNotFoundException";
279
+ readonly $fault: "client";
280
+ Message?: string | undefined;
281
+ ResourceName?: string | undefined;
282
+ /**
283
+ * @internal
284
+ */
285
+ constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
286
+ }
255
287
  /**
256
288
  * <p>The structure containing configurations related to insights.</p>
257
289
  * @public
@@ -805,6 +837,123 @@ export interface GetGroupsResult {
805
837
  */
806
838
  NextToken?: string | undefined;
807
839
  }
840
+ /**
841
+ * @public
842
+ */
843
+ export interface GetIndexingRulesRequest {
844
+ /**
845
+ * <p>
846
+ * Specify the pagination token returned by a previous request to retrieve the next page of indexes.
847
+ *
848
+ *
849
+ * </p>
850
+ * @public
851
+ */
852
+ NextToken?: string | undefined;
853
+ }
854
+ /**
855
+ * <p>
856
+ * The indexing rule configuration for probabilistic sampling.
857
+ * </p>
858
+ * @public
859
+ */
860
+ export interface ProbabilisticRuleValue {
861
+ /**
862
+ * <p>
863
+ * Configured sampling percentage of traceIds. Note that sampling can be subject to limits to ensure completeness of data.
864
+ * </p>
865
+ * @public
866
+ */
867
+ DesiredSamplingPercentage: number | undefined;
868
+ /**
869
+ * <p>
870
+ * Applied sampling percentage of traceIds.
871
+ * </p>
872
+ * @public
873
+ */
874
+ ActualSamplingPercentage?: number | undefined;
875
+ }
876
+ /**
877
+ * <p>
878
+ * The indexing rule configuration.
879
+ * </p>
880
+ * @public
881
+ */
882
+ export type IndexingRuleValue = IndexingRuleValue.ProbabilisticMember | IndexingRuleValue.$UnknownMember;
883
+ /**
884
+ * @public
885
+ */
886
+ export declare namespace IndexingRuleValue {
887
+ /**
888
+ * <p>
889
+ * Indexing rule configuration that is used to probabilistically sample traceIds.
890
+ * </p>
891
+ * @public
892
+ */
893
+ interface ProbabilisticMember {
894
+ Probabilistic: ProbabilisticRuleValue;
895
+ $unknown?: never;
896
+ }
897
+ /**
898
+ * @public
899
+ */
900
+ interface $UnknownMember {
901
+ Probabilistic?: never;
902
+ $unknown: [string, any];
903
+ }
904
+ interface Visitor<T> {
905
+ Probabilistic: (value: ProbabilisticRuleValue) => T;
906
+ _: (name: string, value: any) => T;
907
+ }
908
+ const visit: <T>(value: IndexingRuleValue, visitor: Visitor<T>) => T;
909
+ }
910
+ /**
911
+ * <p>
912
+ * Rule used to determine the server-side sampling rate for spans ingested through the CloudWatchLogs destination and indexed by X-Ray.
913
+ * </p>
914
+ * @public
915
+ */
916
+ export interface IndexingRule {
917
+ /**
918
+ * <p>
919
+ * The name of the indexing rule.
920
+ * </p>
921
+ * @public
922
+ */
923
+ Name?: string | undefined;
924
+ /**
925
+ * <p>
926
+ * Displays when the rule was last modified, in Unix time seconds.
927
+ * </p>
928
+ * @public
929
+ */
930
+ ModifiedAt?: Date | undefined;
931
+ /**
932
+ * <p>
933
+ * The indexing rule.
934
+ * </p>
935
+ * @public
936
+ */
937
+ Rule?: IndexingRuleValue | undefined;
938
+ }
939
+ /**
940
+ * @public
941
+ */
942
+ export interface GetIndexingRulesResult {
943
+ /**
944
+ * <p>
945
+ * Retrieves all indexing rules.</p>
946
+ * @public
947
+ */
948
+ IndexingRules?: IndexingRule[] | undefined;
949
+ /**
950
+ * <p>
951
+ * Specify the pagination token returned by a previous request to retrieve the next page of indexes.
952
+ * </p>
953
+ * @public
954
+ */
955
+ NextToken?: string | undefined;
956
+ }
808
957
  /**
809
958
  * @public
810
959
  */
@@ -1275,503 +1424,618 @@ export interface GetInsightSummariesResult {
1275
1424
  /**
1276
1425
  * @public
1277
1426
  */
1278
- export interface GetSamplingRulesRequest {
1427
+ export interface GetRetrievedTracesGraphRequest {
1279
1428
  /**
1280
- * <p>Pagination token.</p>
1429
+ * <p>
1430
+ * Retrieval token.
1431
+ * </p>
1432
+ * @public
1433
+ */
1434
+ RetrievalToken: string | undefined;
1435
+ /**
1436
+ * <p>
1437
+ * Specify the pagination token returned by a previous request to retrieve the next page of indexes.
1438
+ *
1439
+ *
1440
+ * </p>
1281
1441
  * @public
1282
1442
  */
1283
1443
  NextToken?: string | undefined;
1284
1444
  }
1285
1445
  /**
1286
1446
  * @public
1447
+ * @enum
1287
1448
  */
1288
- export interface GetSamplingRulesResult {
1449
+ export declare const RetrievalStatus: {
1450
+ readonly CANCELLED: "CANCELLED";
1451
+ readonly COMPLETE: "COMPLETE";
1452
+ readonly FAILED: "FAILED";
1453
+ readonly RUNNING: "RUNNING";
1454
+ readonly SCHEDULED: "SCHEDULED";
1455
+ readonly TIMEOUT: "TIMEOUT";
1456
+ };
1457
+ /**
1458
+ * @public
1459
+ */
1460
+ export type RetrievalStatus = (typeof RetrievalStatus)[keyof typeof RetrievalStatus];
1461
+ /**
1462
+ * <p>
1463
+ * The relation between two services.
1464
+ * </p>
1465
+ * @public
1466
+ */
1467
+ export interface GraphLink {
1289
1468
  /**
1290
- * <p>Rule definitions and metadata.</p>
1469
+ * <p>
1470
+ * Relationship of a trace to the corresponding service.
1471
+ * </p>
1291
1472
  * @public
1292
1473
  */
1293
- SamplingRuleRecords?: SamplingRuleRecord[] | undefined;
1474
+ ReferenceType?: string | undefined;
1294
1475
  /**
1295
- * <p>Pagination token.</p>
1476
+ * <p>
1477
+ * Source trace of a link relationship.
1478
+ * </p>
1296
1479
  * @public
1297
1480
  */
1298
- NextToken?: string | undefined;
1299
- }
1300
- /**
1301
- * @public
1302
- */
1303
- export interface GetSamplingStatisticSummariesRequest {
1481
+ SourceTraceId?: string | undefined;
1304
1482
  /**
1305
- * <p>Pagination token.</p>
1483
+ * <p>
1484
+ * Destination traces of a link relationship.
1485
+ * </p>
1306
1486
  * @public
1307
1487
  */
1308
- NextToken?: string | undefined;
1488
+ DestinationTraceIds?: string[] | undefined;
1309
1489
  }
1310
1490
  /**
1311
- * <p>Aggregated request sampling data for a sampling rule across all services for a 10-second window.</p>
1491
+ * <p>An entry in a histogram for a statistic. A histogram maps the range of observed values
1492
+ * on the X axis, and the prevalence of each value on the Y axis.</p>
1312
1493
  * @public
1313
1494
  */
1314
- export interface SamplingStatisticSummary {
1495
+ export interface HistogramEntry {
1315
1496
  /**
1316
- * <p>The name of the sampling rule.</p>
1497
+ * <p>The value of the entry.</p>
1317
1498
  * @public
1318
1499
  */
1319
- RuleName?: string | undefined;
1500
+ Value?: number | undefined;
1320
1501
  /**
1321
- * <p>The start time of the reporting window.</p>
1502
+ * <p>The prevalence of the entry.</p>
1322
1503
  * @public
1323
1504
  */
1324
- Timestamp?: Date | undefined;
1505
+ Count?: number | undefined;
1506
+ }
1507
+ /**
1508
+ * <p>Information about requests that failed with a 4xx Client Error status code.</p>
1509
+ * @public
1510
+ */
1511
+ export interface ErrorStatistics {
1325
1512
  /**
1326
- * <p>The number of requests that matched the rule.</p>
1513
+ * <p>The number of requests that failed with a 429 throttling status code.</p>
1327
1514
  * @public
1328
1515
  */
1329
- RequestCount?: number | undefined;
1516
+ ThrottleCount?: number | undefined;
1330
1517
  /**
1331
- * <p>The number of requests recorded with borrowed reservoir quota.</p>
1518
+ * <p>The number of requests that failed with untracked 4xx Client Error status
1519
+ * codes.</p>
1332
1520
  * @public
1333
1521
  */
1334
- BorrowCount?: number | undefined;
1522
+ OtherCount?: number | undefined;
1335
1523
  /**
1336
- * <p>The number of requests recorded.</p>
1524
+ * <p>The total number of requests that failed with a 4xx Client Error status code.</p>
1337
1525
  * @public
1338
1526
  */
1339
- SampledCount?: number | undefined;
1527
+ TotalCount?: number | undefined;
1340
1528
  }
1341
1529
  /**
1530
+ * <p>Information about requests that failed with a 5xx Server Error status code.</p>
1342
1531
  * @public
1343
1532
  */
1344
- export interface GetSamplingStatisticSummariesResult {
1533
+ export interface FaultStatistics {
1345
1534
  /**
1346
- * <p>Information about the number of requests instrumented for each sampling
1347
- * rule.</p>
1535
+ * <p>The number of requests that failed with untracked 5xx Server Error status
1536
+ * codes.</p>
1348
1537
  * @public
1349
1538
  */
1350
- SamplingStatisticSummaries?: SamplingStatisticSummary[] | undefined;
1539
+ OtherCount?: number | undefined;
1351
1540
  /**
1352
- * <p>Pagination token.</p>
1541
+ * <p>The total number of requests that failed with a 5xx Server Error status code.</p>
1353
1542
  * @public
1354
1543
  */
1355
- NextToken?: string | undefined;
1544
+ TotalCount?: number | undefined;
1356
1545
  }
1357
1546
  /**
1358
- * <p>Request sampling results for a single rule from a service. Results are for the last 10
1359
- * seconds unless the service has been assigned a longer reporting interval after a previous call
1360
- * to <a href="https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html">GetSamplingTargets</a>.</p>
1547
+ * <p>Response statistics for an edge.</p>
1361
1548
  * @public
1362
1549
  */
1363
- export interface SamplingStatisticsDocument {
1364
- /**
1365
- * <p>The name of the sampling rule.</p>
1366
- * @public
1367
- */
1368
- RuleName: string | undefined;
1369
- /**
1370
- * <p>A unique identifier for the service in hexadecimal.</p>
1371
- * @public
1372
- */
1373
- ClientID: string | undefined;
1550
+ export interface EdgeStatistics {
1374
1551
  /**
1375
- * <p>The current time.</p>
1552
+ * <p>The number of requests that completed with a 2xx Success status code.</p>
1376
1553
  * @public
1377
1554
  */
1378
- Timestamp: Date | undefined;
1555
+ OkCount?: number | undefined;
1379
1556
  /**
1380
- * <p>The number of requests that matched the rule.</p>
1557
+ * <p>Information about requests that failed with a 4xx Client Error status code.</p>
1381
1558
  * @public
1382
1559
  */
1383
- RequestCount: number | undefined;
1560
+ ErrorStatistics?: ErrorStatistics | undefined;
1384
1561
  /**
1385
- * <p>The number of requests recorded.</p>
1562
+ * <p>Information about requests that failed with a 5xx Server Error status code.</p>
1386
1563
  * @public
1387
1564
  */
1388
- SampledCount: number | undefined;
1565
+ FaultStatistics?: FaultStatistics | undefined;
1389
1566
  /**
1390
- * <p>The number of requests recorded with borrowed reservoir quota.</p>
1567
+ * <p>The total number of completed requests.</p>
1391
1568
  * @public
1392
1569
  */
1393
- BorrowCount?: number | undefined;
1394
- }
1395
- /**
1396
- * @public
1397
- */
1398
- export interface GetSamplingTargetsRequest {
1570
+ TotalCount?: number | undefined;
1399
1571
  /**
1400
- * <p>Information about rules that the service is using to sample requests.</p>
1572
+ * <p>The aggregate response time of completed requests.</p>
1401
1573
  * @public
1402
1574
  */
1403
- SamplingStatisticsDocuments: SamplingStatisticsDocument[] | undefined;
1575
+ TotalResponseTime?: number | undefined;
1404
1576
  }
1405
1577
  /**
1406
- * <p>Temporary changes to a sampling rule configuration. To meet the global sampling target for a rule, X-Ray
1407
- * calculates a new reservoir for each service based on the recent sampling results of all services that called
1408
- * <a href="https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html">GetSamplingTargets</a>.</p>
1578
+ * <p>Information about a connection between two services. An edge can be a synchronous connection, such as typical
1579
+ * call between client and service, or an asynchronous link, such as a Lambda function which retrieves an event from an
1580
+ * SNS queue.</p>
1409
1581
  * @public
1410
1582
  */
1411
- export interface SamplingTargetDocument {
1583
+ export interface Edge {
1412
1584
  /**
1413
- * <p>The name of the sampling rule.</p>
1585
+ * <p>Identifier of the edge. Unique within a service map.</p>
1414
1586
  * @public
1415
1587
  */
1416
- RuleName?: string | undefined;
1588
+ ReferenceId?: number | undefined;
1417
1589
  /**
1418
- * <p>The percentage of matching requests to instrument, after the reservoir is
1419
- * exhausted.</p>
1590
+ * <p>The start time of the first segment on the edge.</p>
1420
1591
  * @public
1421
1592
  */
1422
- FixedRate?: number | undefined;
1593
+ StartTime?: Date | undefined;
1423
1594
  /**
1424
- * <p>The number of requests per second that X-Ray allocated for this service.</p>
1595
+ * <p>The end time of the last segment on the edge.</p>
1425
1596
  * @public
1426
1597
  */
1427
- ReservoirQuota?: number | undefined;
1598
+ EndTime?: Date | undefined;
1428
1599
  /**
1429
- * <p>When the reservoir quota expires.</p>
1600
+ * <p>Response statistics for segments on the edge.</p>
1430
1601
  * @public
1431
1602
  */
1432
- ReservoirQuotaTTL?: Date | undefined;
1603
+ SummaryStatistics?: EdgeStatistics | undefined;
1433
1604
  /**
1434
- * <p>The number of seconds for the service to wait before getting sampling targets
1435
- * again.</p>
1605
+ * <p>A histogram that maps the spread of client response times on an edge. Only populated
1606
+ * for synchronous edges.</p>
1436
1607
  * @public
1437
1608
  */
1438
- Interval?: number | undefined;
1439
- }
1440
- /**
1441
- * <p>Sampling statistics from a call to <a href="https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html">GetSamplingTargets</a> that X-Ray
1442
- * could not process.</p>
1443
- * @public
1444
- */
1445
- export interface UnprocessedStatistics {
1609
+ ResponseTimeHistogram?: HistogramEntry[] | undefined;
1446
1610
  /**
1447
- * <p>The name of the sampling rule.</p>
1611
+ * <p>Aliases for the edge.</p>
1448
1612
  * @public
1449
1613
  */
1450
- RuleName?: string | undefined;
1614
+ Aliases?: Alias[] | undefined;
1451
1615
  /**
1452
- * <p>The error code.</p>
1616
+ * <p>Describes an asynchronous connection, with a value of <code>link</code>.</p>
1453
1617
  * @public
1454
1618
  */
1455
- ErrorCode?: string | undefined;
1619
+ EdgeType?: string | undefined;
1456
1620
  /**
1457
- * <p>The error message.</p>
1621
+ * <p>A histogram that maps the spread of event age when received by consumers.
1622
+ * Age is calculated each time an event is received. Only populated when <i>EdgeType</i> is
1623
+ * <code>link</code>.</p>
1458
1624
  * @public
1459
1625
  */
1460
- Message?: string | undefined;
1626
+ ReceivedEventAgeHistogram?: HistogramEntry[] | undefined;
1461
1627
  }
1462
1628
  /**
1629
+ * <p>Response statistics for a service.</p>
1463
1630
  * @public
1464
1631
  */
1465
- export interface GetSamplingTargetsResult {
1632
+ export interface ServiceStatistics {
1466
1633
  /**
1467
- * <p>Updated rules that the service should use to sample requests.</p>
1634
+ * <p>The number of requests that completed with a 2xx Success status code.</p>
1468
1635
  * @public
1469
1636
  */
1470
- SamplingTargetDocuments?: SamplingTargetDocument[] | undefined;
1637
+ OkCount?: number | undefined;
1471
1638
  /**
1472
- * <p>The last time a user changed the sampling rule configuration. If
1473
- * the sampling rule configuration changed since the service last retrieved it, the service
1474
- * should call <a href="https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingRules.html">GetSamplingRules</a> to get the latest version.</p>
1639
+ * <p>Information about requests that failed with a 4xx Client Error status code.</p>
1475
1640
  * @public
1476
1641
  */
1477
- LastRuleModification?: Date | undefined;
1642
+ ErrorStatistics?: ErrorStatistics | undefined;
1478
1643
  /**
1479
- * <p>Information about <a href="https://docs.aws.amazon.com/xray/latest/api/API_SamplingStatisticsDocument.html">SamplingStatisticsDocument</a> that X-Ray could not
1480
- * process.</p>
1644
+ * <p>Information about requests that failed with a 5xx Server Error status code.</p>
1481
1645
  * @public
1482
1646
  */
1483
- UnprocessedStatistics?: UnprocessedStatistics[] | undefined;
1647
+ FaultStatistics?: FaultStatistics | undefined;
1648
+ /**
1649
+ * <p>The total number of completed requests.</p>
1650
+ * @public
1651
+ */
1652
+ TotalCount?: number | undefined;
1653
+ /**
1654
+ * <p>The aggregate response time of completed requests.</p>
1655
+ * @public
1656
+ */
1657
+ TotalResponseTime?: number | undefined;
1484
1658
  }
1485
1659
  /**
1660
+ * <p>Information about an application that processed requests, users that made requests, or downstream services,
1661
+ * resources, and applications that an application used.</p>
1486
1662
  * @public
1487
1663
  */
1488
- export interface GetServiceGraphRequest {
1664
+ export interface Service {
1489
1665
  /**
1490
- * <p>The start of the time frame for which to generate a graph.</p>
1666
+ * <p>Identifier for the service. Unique within the service map.</p>
1491
1667
  * @public
1492
1668
  */
1493
- StartTime: Date | undefined;
1669
+ ReferenceId?: number | undefined;
1494
1670
  /**
1495
- * <p>The end of the timeframe for which to generate a graph.</p>
1671
+ * <p>The canonical name of the service.</p>
1496
1672
  * @public
1497
1673
  */
1498
- EndTime: Date | undefined;
1674
+ Name?: string | undefined;
1499
1675
  /**
1500
- * <p>The name of a group based on which you want to generate a graph.</p>
1676
+ * <p>A list of names for the service, including the canonical name.</p>
1501
1677
  * @public
1502
1678
  */
1503
- GroupName?: string | undefined;
1679
+ Names?: string[] | undefined;
1504
1680
  /**
1505
- * <p>The Amazon Resource Name (ARN) of a group based on which you want to generate a graph.</p>
1681
+ * <p>Indicates that the service was the first service to process a request.</p>
1506
1682
  * @public
1507
1683
  */
1508
- GroupARN?: string | undefined;
1684
+ Root?: boolean | undefined;
1509
1685
  /**
1510
- * <p>Pagination token.</p>
1686
+ * <p>Identifier of the Amazon Web Services account in which the service runs.</p>
1511
1687
  * @public
1512
1688
  */
1513
- NextToken?: string | undefined;
1514
- }
1515
- /**
1516
- * <p>An entry in a histogram for a statistic. A histogram maps the range of observed values
1517
- * on the X axis, and the prevalence of each value on the Y axis.</p>
1518
- * @public
1519
- */
1520
- export interface HistogramEntry {
1689
+ AccountId?: string | undefined;
1521
1690
  /**
1522
- * <p>The value of the entry.</p>
1691
+ * <p>The type of service.</p>
1692
+ * <ul>
1693
+ * <li>
1694
+ * <p>Amazon Web Services Resource - The type of an Amazon Web Services resource. For example, <code>AWS::EC2::Instance</code> for an
1695
+ * application running on Amazon EC2 or <code>AWS::DynamoDB::Table</code> for an Amazon DynamoDB table that the
1696
+ * application used.</p>
1697
+ * </li>
1698
+ * <li>
1699
+ * <p>Amazon Web Services Service - The type of an Amazon Web Services service. For example, <code>AWS::DynamoDB</code>
1700
+ * for downstream calls to Amazon DynamoDB that didn't target a specific table.</p>
1701
+ * </li>
1702
+ * <li>
1703
+ * <p>
1704
+ * <code>client</code> - Represents the clients that sent requests to a root
1705
+ * service.</p>
1706
+ * </li>
1707
+ * <li>
1708
+ * <p>
1709
+ * <code>remote</code> - A downstream service of indeterminate type.</p>
1710
+ * </li>
1711
+ * </ul>
1523
1712
  * @public
1524
1713
  */
1525
- Value?: number | undefined;
1714
+ Type?: string | undefined;
1526
1715
  /**
1527
- * <p>The prevalence of the entry.</p>
1716
+ * <p>The service's state.</p>
1528
1717
  * @public
1529
1718
  */
1530
- Count?: number | undefined;
1531
- }
1532
- /**
1533
- * <p>Information about requests that failed with a 4xx Client Error status code.</p>
1534
- * @public
1535
- */
1536
- export interface ErrorStatistics {
1719
+ State?: string | undefined;
1537
1720
  /**
1538
- * <p>The number of requests that failed with a 419 throttling status code.</p>
1721
+ * <p>The start time of the first segment that the service generated.</p>
1539
1722
  * @public
1540
1723
  */
1541
- ThrottleCount?: number | undefined;
1724
+ StartTime?: Date | undefined;
1542
1725
  /**
1543
- * <p>The number of requests that failed with untracked 4xx Client Error status
1544
- * codes.</p>
1726
+ * <p>The end time of the last segment that the service generated.</p>
1545
1727
  * @public
1546
1728
  */
1547
- OtherCount?: number | undefined;
1729
+ EndTime?: Date | undefined;
1548
1730
  /**
1549
- * <p>The total number of requests that failed with a 4xx Client Error status code.</p>
1731
+ * <p>Connections to downstream services.</p>
1550
1732
  * @public
1551
1733
  */
1552
- TotalCount?: number | undefined;
1734
+ Edges?: Edge[] | undefined;
1735
+ /**
1736
+ * <p>Aggregated statistics for the service.</p>
1737
+ * @public
1738
+ */
1739
+ SummaryStatistics?: ServiceStatistics | undefined;
1740
+ /**
1741
+ * <p>A histogram that maps the spread of service durations.</p>
1742
+ * @public
1743
+ */
1744
+ DurationHistogram?: HistogramEntry[] | undefined;
1745
+ /**
1746
+ * <p>A histogram that maps the spread of service response times.</p>
1747
+ * @public
1748
+ */
1749
+ ResponseTimeHistogram?: HistogramEntry[] | undefined;
1553
1750
  }
1554
1751
  /**
1555
- * <p>Information about requests that failed with a 5xx Server Error status code.</p>
1752
+ * <p>
1753
+ * Retrieved information about an application that processed requests, users that made requests, or downstream services, resources, and applications that an application used.
1754
+ * </p>
1556
1755
  * @public
1557
1756
  */
1558
- export interface FaultStatistics {
1757
+ export interface RetrievedService {
1559
1758
  /**
1560
- * <p>The number of requests that failed with untracked 5xx Server Error status
1561
- * codes.</p>
1759
+ * <p>Information about an application that processed requests, users that made requests, or downstream services,
1760
+ * resources, and applications that an application used.</p>
1562
1761
  * @public
1563
1762
  */
1564
- OtherCount?: number | undefined;
1763
+ Service?: Service | undefined;
1565
1764
  /**
1566
- * <p>The total number of requests that failed with a 5xx Server Error status code.</p>
1765
+ * <p>
1766
+ * Relation between two 2 services.
1767
+ * </p>
1567
1768
  * @public
1568
1769
  */
1569
- TotalCount?: number | undefined;
1770
+ Links?: GraphLink[] | undefined;
1570
1771
  }
1571
1772
  /**
1572
- * <p>Response statistics for an edge.</p>
1573
1773
  * @public
1574
1774
  */
1575
- export interface EdgeStatistics {
1775
+ export interface GetRetrievedTracesGraphResult {
1576
1776
  /**
1577
- * <p>The number of requests that completed with a 2xx Success status code.</p>
1777
+ * <p>
1778
+ * Status of the retrieval.
1779
+ * </p>
1578
1780
  * @public
1579
1781
  */
1580
- OkCount?: number | undefined;
1782
+ RetrievalStatus?: RetrievalStatus | undefined;
1581
1783
  /**
1582
- * <p>Information about requests that failed with a 4xx Client Error status code.</p>
1784
+ * <p>
1785
+ * Retrieved services.
1786
+ * </p>
1583
1787
  * @public
1584
1788
  */
1585
- ErrorStatistics?: ErrorStatistics | undefined;
1789
+ Services?: RetrievedService[] | undefined;
1586
1790
  /**
1587
- * <p>Information about requests that failed with a 5xx Server Error status code.</p>
1791
+ * <p>
1792
+ * Specify the pagination token returned by a previous request to retrieve the next page of indexes.
1793
+ *
1794
+ *
1795
+ * </p>
1588
1796
  * @public
1589
1797
  */
1590
- FaultStatistics?: FaultStatistics | undefined;
1798
+ NextToken?: string | undefined;
1799
+ }
1800
+ /**
1801
+ * @public
1802
+ */
1803
+ export interface GetSamplingRulesRequest {
1591
1804
  /**
1592
- * <p>The total number of completed requests.</p>
1805
+ * <p>Pagination token.</p>
1593
1806
  * @public
1594
1807
  */
1595
- TotalCount?: number | undefined;
1808
+ NextToken?: string | undefined;
1809
+ }
1810
+ /**
1811
+ * @public
1812
+ */
1813
+ export interface GetSamplingRulesResult {
1596
1814
  /**
1597
- * <p>The aggregate response time of completed requests.</p>
1815
+ * <p>Rule definitions and metadata.</p>
1598
1816
  * @public
1599
1817
  */
1600
- TotalResponseTime?: number | undefined;
1818
+ SamplingRuleRecords?: SamplingRuleRecord[] | undefined;
1819
+ /**
1820
+ * <p>Pagination token.</p>
1821
+ * @public
1822
+ */
1823
+ NextToken?: string | undefined;
1601
1824
  }
1602
1825
  /**
1603
- * <p>Information about a connection between two services. An edge can be a synchronous connection, such as typical
1604
- * call between client and service, or an asynchronous link, such as a Lambda function which retrieves an event from an
1605
- * SNS queue.</p>
1606
1826
  * @public
1607
1827
  */
1608
- export interface Edge {
1828
+ export interface GetSamplingStatisticSummariesRequest {
1609
1829
  /**
1610
- * <p>Identifier of the edge. Unique within a service map.</p>
1830
+ * <p>Pagination token.</p>
1611
1831
  * @public
1612
1832
  */
1613
- ReferenceId?: number | undefined;
1833
+ NextToken?: string | undefined;
1834
+ }
1835
+ /**
1836
+ * <p>Aggregated request sampling data for a sampling rule across all services for a 10-second window.</p>
1837
+ * @public
1838
+ */
1839
+ export interface SamplingStatisticSummary {
1614
1840
  /**
1615
- * <p>The start time of the first segment on the edge.</p>
1841
+ * <p>The name of the sampling rule.</p>
1616
1842
  * @public
1617
1843
  */
1618
- StartTime?: Date | undefined;
1844
+ RuleName?: string | undefined;
1619
1845
  /**
1620
- * <p>The end time of the last segment on the edge.</p>
1846
+ * <p>The start time of the reporting window.</p>
1621
1847
  * @public
1622
1848
  */
1623
- EndTime?: Date | undefined;
1849
+ Timestamp?: Date | undefined;
1624
1850
  /**
1625
- * <p>Response statistics for segments on the edge.</p>
1851
+ * <p>The number of requests that matched the rule.</p>
1626
1852
  * @public
1627
1853
  */
1628
- SummaryStatistics?: EdgeStatistics | undefined;
1854
+ RequestCount?: number | undefined;
1629
1855
  /**
1630
- * <p>A histogram that maps the spread of client response times on an edge. Only populated
1631
- * for synchronous edges.</p>
1856
+ * <p>The number of requests recorded with borrowed reservoir quota.</p>
1632
1857
  * @public
1633
1858
  */
1634
- ResponseTimeHistogram?: HistogramEntry[] | undefined;
1859
+ BorrowCount?: number | undefined;
1635
1860
  /**
1636
- * <p>Aliases for the edge.</p>
1861
+ * <p>The number of requests recorded.</p>
1637
1862
  * @public
1638
1863
  */
1639
- Aliases?: Alias[] | undefined;
1864
+ SampledCount?: number | undefined;
1865
+ }
1866
+ /**
1867
+ * @public
1868
+ */
1869
+ export interface GetSamplingStatisticSummariesResult {
1640
1870
  /**
1641
- * <p>Describes an asynchronous connection, with a value of <code>link</code>.</p>
1871
+ * <p>Information about the number of requests instrumented for each sampling
1872
+ * rule.</p>
1642
1873
  * @public
1643
1874
  */
1644
- EdgeType?: string | undefined;
1875
+ SamplingStatisticSummaries?: SamplingStatisticSummary[] | undefined;
1645
1876
  /**
1646
- * <p>A histogram that maps the spread of event age when received by consumers.
1647
- * Age is calculated each time an event is received. Only populated when <i>EdgeType</i> is
1648
- * <code>link</code>.</p>
1877
+ * <p>Pagination token.</p>
1649
1878
  * @public
1650
1879
  */
1651
- ReceivedEventAgeHistogram?: HistogramEntry[] | undefined;
1880
+ NextToken?: string | undefined;
1652
1881
  }
1653
1882
  /**
1654
- * <p>Response statistics for a service.</p>
1883
+ * <p>Request sampling results for a single rule from a service. Results are for the last 10
1884
+ * seconds unless the service has been assigned a longer reporting interval after a previous call
1885
+ * to <a href="https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html">GetSamplingTargets</a>.</p>
1655
1886
  * @public
1656
1887
  */
1657
- export interface ServiceStatistics {
1888
+ export interface SamplingStatisticsDocument {
1658
1889
  /**
1659
- * <p>The number of requests that completed with a 2xx Success status code.</p>
1890
+ * <p>The name of the sampling rule.</p>
1660
1891
  * @public
1661
1892
  */
1662
- OkCount?: number | undefined;
1893
+ RuleName: string | undefined;
1663
1894
  /**
1664
- * <p>Information about requests that failed with a 4xx Client Error status code.</p>
1895
+ * <p>A unique identifier for the service in hexadecimal.</p>
1665
1896
  * @public
1666
1897
  */
1667
- ErrorStatistics?: ErrorStatistics | undefined;
1898
+ ClientID: string | undefined;
1668
1899
  /**
1669
- * <p>Information about requests that failed with a 5xx Server Error status code.</p>
1900
+ * <p>The current time.</p>
1670
1901
  * @public
1671
1902
  */
1672
- FaultStatistics?: FaultStatistics | undefined;
1903
+ Timestamp: Date | undefined;
1673
1904
  /**
1674
- * <p>The total number of completed requests.</p>
1905
+ * <p>The number of requests that matched the rule.</p>
1675
1906
  * @public
1676
1907
  */
1677
- TotalCount?: number | undefined;
1908
+ RequestCount: number | undefined;
1678
1909
  /**
1679
- * <p>The aggregate response time of completed requests.</p>
1910
+ * <p>The number of requests recorded.</p>
1680
1911
  * @public
1681
1912
  */
1682
- TotalResponseTime?: number | undefined;
1913
+ SampledCount: number | undefined;
1914
+ /**
1915
+ * <p>The number of requests recorded with borrowed reservoir quota.</p>
1916
+ * @public
1917
+ */
1918
+ BorrowCount?: number | undefined;
1683
1919
  }
1684
1920
  /**
1685
- * <p>Information about an application that processed requests, users that made requests, or downstream services,
1686
- * resources, and applications that an application used.</p>
1687
1921
  * @public
1688
1922
  */
1689
- export interface Service {
1923
+ export interface GetSamplingTargetsRequest {
1690
1924
  /**
1691
- * <p>Identifier for the service. Unique within the service map.</p>
1925
+ * <p>Information about rules that the service is using to sample requests.</p>
1692
1926
  * @public
1693
1927
  */
1694
- ReferenceId?: number | undefined;
1928
+ SamplingStatisticsDocuments: SamplingStatisticsDocument[] | undefined;
1929
+ }
1930
+ /**
1931
+ * <p>Temporary changes to a sampling rule configuration. To meet the global sampling target for a rule, X-Ray
1932
+ * calculates a new reservoir for each service based on the recent sampling results of all services that called
1933
+ * <a href="https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html">GetSamplingTargets</a>.</p>
1934
+ * @public
1935
+ */
1936
+ export interface SamplingTargetDocument {
1695
1937
  /**
1696
- * <p>The canonical name of the service.</p>
1938
+ * <p>The name of the sampling rule.</p>
1697
1939
  * @public
1698
1940
  */
1699
- Name?: string | undefined;
1941
+ RuleName?: string | undefined;
1700
1942
  /**
1701
- * <p>A list of names for the service, including the canonical name.</p>
1943
+ * <p>The percentage of matching requests to instrument, after the reservoir is
1944
+ * exhausted.</p>
1702
1945
  * @public
1703
1946
  */
1704
- Names?: string[] | undefined;
1947
+ FixedRate?: number | undefined;
1705
1948
  /**
1706
- * <p>Indicates that the service was the first service to process a request.</p>
1949
+ * <p>The number of requests per second that X-Ray allocated for this service.</p>
1707
1950
  * @public
1708
1951
  */
1709
- Root?: boolean | undefined;
1952
+ ReservoirQuota?: number | undefined;
1710
1953
  /**
1711
- * <p>Identifier of the Amazon Web Services account in which the service runs.</p>
1954
+ * <p>When the reservoir quota expires.</p>
1712
1955
  * @public
1713
1956
  */
1714
- AccountId?: string | undefined;
1957
+ ReservoirQuotaTTL?: Date | undefined;
1715
1958
  /**
1716
- * <p>The type of service.</p>
1717
- * <ul>
1718
- * <li>
1719
- * <p>Amazon Web Services Resource - The type of an Amazon Web Services resource. For example, <code>AWS::EC2::Instance</code> for an
1720
- * application running on Amazon EC2 or <code>AWS::DynamoDB::Table</code> for an Amazon DynamoDB table that the
1721
- * application used.</p>
1722
- * </li>
1723
- * <li>
1724
- * <p>Amazon Web Services Service - The type of an Amazon Web Services service. For example, <code>AWS::DynamoDB</code>
1725
- * for downstream calls to Amazon DynamoDB that didn't target a specific table.</p>
1726
- * </li>
1727
- * <li>
1728
- * <p>
1729
- * <code>client</code> - Represents the clients that sent requests to a root
1730
- * service.</p>
1731
- * </li>
1732
- * <li>
1733
- * <p>
1734
- * <code>remote</code> - A downstream service of indeterminate type.</p>
1735
- * </li>
1736
- * </ul>
1959
+ * <p>The number of seconds for the service to wait before getting sampling targets
1960
+ * again.</p>
1961
+ * @public
1962
+ */
1963
+ Interval?: number | undefined;
1964
+ }
1965
+ /**
1966
+ * <p>Sampling statistics from a call to <a href="https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html">GetSamplingTargets</a> that X-Ray
1967
+ * could not process.</p>
1968
+ * @public
1969
+ */
1970
+ export interface UnprocessedStatistics {
1971
+ /**
1972
+ * <p>The name of the sampling rule.</p>
1737
1973
  * @public
1738
1974
  */
1739
- Type?: string | undefined;
1975
+ RuleName?: string | undefined;
1740
1976
  /**
1741
- * <p>The service's state.</p>
1977
+ * <p>The error code.</p>
1742
1978
  * @public
1743
1979
  */
1744
- State?: string | undefined;
1980
+ ErrorCode?: string | undefined;
1745
1981
  /**
1746
- * <p>The start time of the first segment that the service generated.</p>
1982
+ * <p>The error message.</p>
1747
1983
  * @public
1748
1984
  */
1749
- StartTime?: Date | undefined;
1985
+ Message?: string | undefined;
1986
+ }
1987
+ /**
1988
+ * @public
1989
+ */
1990
+ export interface GetSamplingTargetsResult {
1750
1991
  /**
1751
- * <p>The end time of the last segment that the service generated.</p>
1992
+ * <p>Updated rules that the service should use to sample requests.</p>
1752
1993
  * @public
1753
1994
  */
1754
- EndTime?: Date | undefined;
1995
+ SamplingTargetDocuments?: SamplingTargetDocument[] | undefined;
1755
1996
  /**
1756
- * <p>Connections to downstream services.</p>
1997
+ * <p>The last time a user changed the sampling rule configuration. If
1998
+ * the sampling rule configuration changed since the service last retrieved it, the service
1999
+ * should call <a href="https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingRules.html">GetSamplingRules</a> to get the latest version.</p>
1757
2000
  * @public
1758
2001
  */
1759
- Edges?: Edge[] | undefined;
2002
+ LastRuleModification?: Date | undefined;
1760
2003
  /**
1761
- * <p>Aggregated statistics for the service.</p>
2004
+ * <p>Information about <a href="https://docs.aws.amazon.com/xray/latest/api/API_SamplingStatisticsDocument.html">SamplingStatisticsDocument</a> that X-Ray could not
2005
+ * process.</p>
1762
2006
  * @public
1763
2007
  */
1764
- SummaryStatistics?: ServiceStatistics | undefined;
2008
+ UnprocessedStatistics?: UnprocessedStatistics[] | undefined;
2009
+ }
2010
+ /**
2011
+ * @public
2012
+ */
2013
+ export interface GetServiceGraphRequest {
1765
2014
  /**
1766
- * <p>A histogram that maps the spread of service durations.</p>
2015
+ * <p>The start of the time frame for which to generate a graph.</p>
1767
2016
  * @public
1768
2017
  */
1769
- DurationHistogram?: HistogramEntry[] | undefined;
2018
+ StartTime: Date | undefined;
1770
2019
  /**
1771
- * <p>A histogram that maps the spread of service response times.</p>
2020
+ * <p>The end of the timeframe for which to generate a graph.</p>
1772
2021
  * @public
1773
2022
  */
1774
- ResponseTimeHistogram?: HistogramEntry[] | undefined;
2023
+ EndTime: Date | undefined;
2024
+ /**
2025
+ * <p>The name of a group based on which you want to generate a graph.</p>
2026
+ * @public
2027
+ */
2028
+ GroupName?: string | undefined;
2029
+ /**
2030
+ * <p>The Amazon Resource Name (ARN) of a group based on which you want to generate a graph.</p>
2031
+ * @public
2032
+ */
2033
+ GroupARN?: string | undefined;
2034
+ /**
2035
+ * <p>Pagination token.</p>
2036
+ * @public
2037
+ */
2038
+ NextToken?: string | undefined;
1775
2039
  }
1776
2040
  /**
1777
2041
  * @public
@@ -1953,6 +2217,54 @@ export interface GetTraceGraphResult {
1953
2217
  */
1954
2218
  NextToken?: string | undefined;
1955
2219
  }
2220
+ /**
2221
+ * @public
2222
+ */
2223
+ export interface GetTraceSegmentDestinationRequest {
2224
+ }
2225
+ /**
2226
+ * @public
2227
+ * @enum
2228
+ */
2229
+ export declare const TraceSegmentDestination: {
2230
+ readonly CloudWatchLogs: "CloudWatchLogs";
2231
+ readonly XRay: "XRay";
2232
+ };
2233
+ /**
2234
+ * @public
2235
+ */
2236
+ export type TraceSegmentDestination = (typeof TraceSegmentDestination)[keyof typeof TraceSegmentDestination];
2237
+ /**
2238
+ * @public
2239
+ * @enum
2240
+ */
2241
+ export declare const TraceSegmentDestinationStatus: {
2242
+ readonly ACTIVE: "ACTIVE";
2243
+ readonly PENDING: "PENDING";
2244
+ };
2245
+ /**
2246
+ * @public
2247
+ */
2248
+ export type TraceSegmentDestinationStatus = (typeof TraceSegmentDestinationStatus)[keyof typeof TraceSegmentDestinationStatus];
2249
+ /**
2250
+ * @public
2251
+ */
2252
+ export interface GetTraceSegmentDestinationResult {
2253
+ /**
2254
+ * <p>
2255
+ * Retrieves the current destination.
2256
+ * </p>
2257
+ * @public
2258
+ */
2259
+ Destination?: TraceSegmentDestination | undefined;
2260
+ /**
2261
+ * <p>
2262
+ * Status of the retrieval.
2263
+ * </p>
2264
+ * @public
2265
+ */
2266
+ Status?: TraceSegmentDestinationStatus | undefined;
2267
+ }
1956
2268
  /**
1957
2269
  * @public
1958
2270
  * @enum
@@ -2009,7 +2321,7 @@ export interface GetTraceSummariesRequest {
2009
2321
  */
2010
2322
  EndTime: Date | undefined;
2011
2323
  /**
2012
- * <p>A parameter to indicate whether to query trace summaries by TraceId, Event (trace update time), or Service (segment end time).</p>
2324
+ * <p>Query trace summaries by TraceId (trace start time), Event (trace update time), or Service (trace segment end time).</p>
2013
2325
  * @public
2014
2326
  */
2015
2327
  TimeRangeType?: TimeRangeType | undefined;
@@ -2548,6 +2860,129 @@ export interface ListResourcePoliciesResult {
2548
2860
  */
2549
2861
  NextToken?: string | undefined;
2550
2862
  }
2863
+ /**
2864
+ * @public
2865
+ * @enum
2866
+ */
2867
+ export declare const TraceFormatType: {
2868
+ readonly OTEL: "OTEL";
2869
+ readonly XRAY: "XRAY";
2870
+ };
2871
+ /**
2872
+ * @public
2873
+ */
2874
+ export type TraceFormatType = (typeof TraceFormatType)[keyof typeof TraceFormatType];
2875
+ /**
2876
+ * @public
2877
+ */
2878
+ export interface ListRetrievedTracesRequest {
2879
+ /**
2880
+ * <p>
2881
+ * Retrieval token.
2882
+ * </p>
2883
+ * @public
2884
+ */
2885
+ RetrievalToken: string | undefined;
2886
+ /**
2887
+ * <p>
2888
+ * Format of the requested traces.
2889
+ * </p>
2890
+ * @public
2891
+ */
2892
+ TraceFormat?: TraceFormatType | undefined;
2893
+ /**
2894
+ * <p>
2895
+ * Specify the pagination token returned by a previous request to retrieve the next page of indexes.
2896
+ *
2897
+ *
2898
+ * </p>
2899
+ * @public
2900
+ */
2901
+ NextToken?: string | undefined;
2902
+ }
2903
+ /**
2904
+ * <p>
2905
+ * A span from a trace that has been ingested by the X-Ray service. A span represents a unit of work or an operation performed by a service.
2906
+ * </p>
2907
+ * @public
2908
+ */
2909
+ export interface Span {
2910
+ /**
2911
+ * <p>The span ID.</p>
2912
+ * @public
2913
+ */
2914
+ Id?: string | undefined;
2915
+ /**
2916
+ * <p>
2917
+ * The span document.</p>
2918
+ * @public
2919
+ */
2920
+ Document?: string | undefined;
2921
+ }
2922
+ /**
2923
+ * <p>
2924
+ * Retrieved collection of spans with matching trace IDs.
2925
+ * </p>
2926
+ * @public
2927
+ */
2928
+ export interface RetrievedTrace {
2929
+ /**
2930
+ * <p>
2931
+ * The unique identifier for the span.
2932
+ * </p>
2933
+ * @public
2934
+ */
2935
+ Id?: string | undefined;
2936
+ /**
2937
+ * <p>
2938
+ * The length of time in seconds between the start time of the root span and the end time of the last span that completed.
2939
+ * </p>
2940
+ * @public
2941
+ */
2942
+ Duration?: number | undefined;
2943
+ /**
2944
+ * <p>
2945
+ * Spans that comprise the trace.
2946
+ * </p>
2947
+ * @public
2948
+ */
2949
+ Spans?: Span[] | undefined;
2950
+ }
2951
+ /**
2952
+ * @public
2953
+ */
2954
+ export interface ListRetrievedTracesResult {
2955
+ /**
2956
+ * <p>
2957
+ * Status of the retrieval.
2958
+ * </p>
2959
+ * @public
2960
+ */
2961
+ RetrievalStatus?: RetrievalStatus | undefined;
2962
+ /**
2963
+ * <p>
2964
+ * Format of the requested traces.
2965
+ * </p>
2966
+ * @public
2967
+ */
2968
+ TraceFormat?: TraceFormatType | undefined;
2969
+ /**
2970
+ * <p>
2971
+ * Full traces for the specified requests.
2972
+ * </p>
2973
+ * @public
2974
+ */
2975
+ Traces?: RetrievedTrace[] | undefined;
2976
+ /**
2977
+ * <p>
2978
+ * Specify the pagination token returned by a previous request to retrieve the next page of indexes.
2979
+ *
2980
+ *
2981
+ * </p>
2982
+ * @public
2983
+ */
2984
+ NextToken?: string | undefined;
2985
+ }
2551
2986
  /**
2552
2987
  * @public
2553
2988
  */
@@ -2580,21 +3015,6 @@ export interface ListTagsForResourceResponse {
2580
3015
  */
2581
3016
  NextToken?: string | undefined;
2582
3017
  }
2583
- /**
2584
- * <p>The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is
2585
- * correct.</p>
2586
- * @public
2587
- */
2588
- export declare class ResourceNotFoundException extends __BaseException {
2589
- readonly name: "ResourceNotFoundException";
2590
- readonly $fault: "client";
2591
- Message?: string | undefined;
2592
- ResourceName?: string | undefined;
2593
- /**
2594
- * @internal
2595
- */
2596
- constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
2597
- }
2598
3018
  /**
2599
3019
  * @public
2600
3020
  */
@@ -2881,6 +3301,45 @@ export interface PutTraceSegmentsResult {
2881
3301
  */
2882
3302
  UnprocessedTraceSegments?: UnprocessedTraceSegment[] | undefined;
2883
3303
  }
3304
+ /**
3305
+ * @public
3306
+ */
3307
+ export interface StartTraceRetrievalRequest {
3308
+ /**
3309
+ * <p>
3310
+ * Specify the trace IDs of the traces to be retrieved.
3311
+ * </p>
3312
+ * @public
3313
+ */
3314
+ TraceIds: string[] | undefined;
3315
+ /**
3316
+ * <p>
3317
+ * The start of the time range to retrieve traces. The range is inclusive, so the specified start time is included in the query.
3318
+ * Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.
3319
+ * </p>
3320
+ * @public
3321
+ */
3322
+ StartTime: Date | undefined;
3323
+ /**
3324
+ * <p>
3325
+ * The end of the time range to retrieve traces. The range is inclusive, so the specified end time is included in the query. Specified as epoch time,
3326
+ * the number of seconds since January 1, 1970, 00:00:00 UTC.</p>
3327
+ * @public
3328
+ */
3329
+ EndTime: Date | undefined;
3330
+ }
3331
+ /**
3332
+ * @public
3333
+ */
3334
+ export interface StartTraceRetrievalResult {
3335
+ /**
3336
+ * <p>
3337
+ * Retrieval token.
3338
+ * </p>
3339
+ * @public
3340
+ */
3341
+ RetrievalToken?: string | undefined;
3342
+ }
2884
3343
  /**
2885
3344
  * @public
2886
3345
  */
@@ -3007,6 +3466,86 @@ export interface UpdateGroupResult {
3007
3466
  */
3008
3467
  Group?: Group | undefined;
3009
3468
  }
3469
+ /**
3470
+ * <p>
3471
+ * Update to the indexing rule configuration for probabilistic sampling.
3472
+ * </p>
3473
+ * @public
3474
+ */
3475
+ export interface ProbabilisticRuleValueUpdate {
3476
+ /**
3477
+ * <p>
3478
+ * Configured sampling percentage of traceIds. Note that sampling can be subject to limits to ensure completeness of data.
3479
+ * </p>
3480
+ * @public
3481
+ */
3482
+ DesiredSamplingPercentage: number | undefined;
3483
+ }
3484
+ /**
3485
+ * <p>
3486
+ * Update to an indexing rule.
3487
+ * </p>
3488
+ * @public
3489
+ */
3490
+ export type IndexingRuleValueUpdate = IndexingRuleValueUpdate.ProbabilisticMember | IndexingRuleValueUpdate.$UnknownMember;
3491
+ /**
3492
+ * @public
3493
+ */
3494
+ export declare namespace IndexingRuleValueUpdate {
3495
+ /**
3496
+ * <p>
3497
+ * Indexing rule configuration that is used to probabilistically sample traceIds.
3498
+ * </p>
3499
+ * @public
3500
+ */
3501
+ interface ProbabilisticMember {
3502
+ Probabilistic: ProbabilisticRuleValueUpdate;
3503
+ $unknown?: never;
3504
+ }
3505
+ /**
3506
+ * @public
3507
+ */
3508
+ interface $UnknownMember {
3509
+ Probabilistic?: never;
3510
+ $unknown: [string, any];
3511
+ }
3512
+ interface Visitor<T> {
3513
+ Probabilistic: (value: ProbabilisticRuleValueUpdate) => T;
3514
+ _: (name: string, value: any) => T;
3515
+ }
3516
+ const visit: <T>(value: IndexingRuleValueUpdate, visitor: Visitor<T>) => T;
3517
+ }
3518
+ /**
3519
+ * @public
3520
+ */
3521
+ export interface UpdateIndexingRuleRequest {
3522
+ /**
3523
+ * <p>
3524
+ * Name of the indexing rule to be updated.
3525
+ * </p>
3526
+ * @public
3527
+ */
3528
+ Name: string | undefined;
3529
+ /**
3530
+ * <p>
3531
+ * Rule configuration to be updated.
3532
+ * </p>
3533
+ * @public
3534
+ */
3535
+ Rule: IndexingRuleValueUpdate | undefined;
3536
+ }
3537
+ /**
3538
+ * @public
3539
+ */
3540
+ export interface UpdateIndexingRuleResult {
3541
+ /**
3542
+ * <p>
3543
+ * Updated indexing rule.
3544
+ * </p>
3545
+ * @public
3546
+ */
3547
+ IndexingRule?: IndexingRule | undefined;
3548
+ }
3010
3549
  /**
3011
3550
  * <p>A document specifying changes to a sampling rule's configuration.</p>
3012
3551
  * @public
@@ -3095,3 +3634,34 @@ export interface UpdateSamplingRuleResult {
3095
3634
  */
3096
3635
  SamplingRuleRecord?: SamplingRuleRecord | undefined;
3097
3636
  }
3637
+ /**
3638
+ * @public
3639
+ */
3640
+ export interface UpdateTraceSegmentDestinationRequest {
3641
+ /**
3642
+ * <p>
3643
+ * The configured destination of trace segments.
3644
+ * </p>
3645
+ * @public
3646
+ */
3647
+ Destination?: TraceSegmentDestination | undefined;
3648
+ }
3649
+ /**
3650
+ * @public
3651
+ */
3652
+ export interface UpdateTraceSegmentDestinationResult {
3653
+ /**
3654
+ * <p>
3655
+ * The destination of the trace segments.
3656
+ * </p>
3657
+ * @public
3658
+ */
3659
+ Destination?: TraceSegmentDestination | undefined;
3660
+ /**
3661
+ * <p>
3662
+ * The status of the update.
3663
+ * </p>
3664
+ * @public
3665
+ */
3666
+ Status?: TraceSegmentDestinationStatus | undefined;
3667
+ }