aws-sdk-xray 1.77.0 → 1.78.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 0d06e60443dca534268705fcf2f5e666f814a36184cde08b292b6108a5ac373a
4
- data.tar.gz: c80fe86b26e516ef37b18192b037e422f57f8fa48356ef515f9e0712bc84ffd8
3
+ metadata.gz: 5ce38f1bc77e0944af62e135fe329ee1db8535ca6ff8b747ee21be3bf79dfccc
4
+ data.tar.gz: 893333142252bd040a8574a49529e1e425ed6e62f44cc27e18896731b3418085
5
5
  SHA512:
6
- metadata.gz: cb8288668ef382c0a687d26a3a36c3d1a4a3a71f0d6e187020935e1636f89f1a15b2e2f19e133f3cef0f317ba36c03a27fc701b6d0a246262b7d280b57eb3311
7
- data.tar.gz: 04b0c831b71565503829e6c16e67733c84571f7d5ca32ca33cd5aeee203d5c55c8f34d34759597e9cf59be43418ed09ce4ab09938b08ed3ee6280c09223fbd5a
6
+ metadata.gz: 546fbea139661b4d44a6ab98efa40818c2a32f11a909a96fe9bdf47461849879186c10c352e94f99d5e82edc1f94fba21dc08d7ef6c0ebdbf6fb57fa57a34d40
7
+ data.tar.gz: 3c9495247dbbf042342f663c0fd0450308ad0809f43d9472fd792da07a44d0cfbc43b5e560c06d55dc4571d74eb38bf98aec4e1b73b8be28cf6982f53c37c6be
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.78.0 (2024-11-21)
5
+ ------------------
6
+
7
+ * Feature - AWS X-Ray introduces Transaction Search APIs, enabling span ingestion into CloudWatch Logs for high-scale trace data indexing. These APIs support span-level queries, trace graph generation, and metric correlation for deeper application insights.
8
+
4
9
  1.77.0 (2024-10-18)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.77.0
1
+ 1.78.0
@@ -447,6 +447,11 @@ module Aws::XRay
447
447
 
448
448
  # @!group API Operations
449
449
 
450
+ # <note markdown="1"> You cannot find traces through this API if Transaction Search is
451
+ # enabled since trace is not indexed in X-Ray.
452
+ #
453
+ # </note>
454
+ #
450
455
  # Retrieves a list of traces specified by ID. Each trace is a collection
451
456
  # of segment documents that originates from a single request. Use
452
457
  # `GetTraceSummaries` to get a list of trace IDs.
@@ -494,6 +499,30 @@ module Aws::XRay
494
499
  req.send_request(options)
495
500
  end
496
501
 
502
+ # Cancels an ongoing trace retrieval job initiated by
503
+ # `StartTraceRetrieval` using the provided `RetrievalToken`. A
504
+ # successful cancellation will return an HTTP 200 response.
505
+ #
506
+ # @option params [required, String] :retrieval_token
507
+ # Retrieval token.
508
+ #
509
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
510
+ #
511
+ # @example Request syntax with placeholder values
512
+ #
513
+ # resp = client.cancel_trace_retrieval({
514
+ # retrieval_token: "RetrievalToken", # required
515
+ # })
516
+ #
517
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/CancelTraceRetrieval AWS API Documentation
518
+ #
519
+ # @overload cancel_trace_retrieval(params = {})
520
+ # @param [Hash] params ({})
521
+ def cancel_trace_retrieval(params = {}, options = {})
522
+ req = build_request(:cancel_trace_retrieval, params)
523
+ req.send_request(options)
524
+ end
525
+
497
526
  # Creates a group resource with a name and a filter expression.
498
527
  #
499
528
  # @option params [required, String] :group_name
@@ -878,6 +907,49 @@ module Aws::XRay
878
907
  req.send_request(options)
879
908
  end
880
909
 
910
+ # Retrieves all indexing rules.
911
+ #
912
+ # Indexing rules are used to determine the server-side sampling rate for
913
+ # spans ingested through the CloudWatchLogs destination and indexed by
914
+ # X-Ray. For more information, see [Transaction Search][1].
915
+ #
916
+ #
917
+ #
918
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Transaction-Search.html
919
+ #
920
+ # @option params [String] :next_token
921
+ # Specify the pagination token returned by a previous request to
922
+ # retrieve the next page of indexes.
923
+ #
924
+ # @return [Types::GetIndexingRulesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
925
+ #
926
+ # * {Types::GetIndexingRulesResult#indexing_rules #indexing_rules} => Array&lt;Types::IndexingRule&gt;
927
+ # * {Types::GetIndexingRulesResult#next_token #next_token} => String
928
+ #
929
+ # @example Request syntax with placeholder values
930
+ #
931
+ # resp = client.get_indexing_rules({
932
+ # next_token: "String",
933
+ # })
934
+ #
935
+ # @example Response structure
936
+ #
937
+ # resp.indexing_rules #=> Array
938
+ # resp.indexing_rules[0].name #=> String
939
+ # resp.indexing_rules[0].modified_at #=> Time
940
+ # resp.indexing_rules[0].rule.probabilistic.desired_sampling_percentage #=> Float
941
+ # resp.indexing_rules[0].rule.probabilistic.actual_sampling_percentage #=> Float
942
+ # resp.next_token #=> String
943
+ #
944
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetIndexingRules AWS API Documentation
945
+ #
946
+ # @overload get_indexing_rules(params = {})
947
+ # @param [Hash] params ({})
948
+ def get_indexing_rules(params = {}, options = {})
949
+ req = build_request(:get_indexing_rules, params)
950
+ req.send_request(options)
951
+ end
952
+
881
953
  # Retrieves the summary information of an insight. This includes impact
882
954
  # to clients and root cause services, the top anomalous services, the
883
955
  # category, the state of the insight, and the start and end time of the
@@ -1149,6 +1221,119 @@ module Aws::XRay
1149
1221
  req.send_request(options)
1150
1222
  end
1151
1223
 
1224
+ # Retrieves a service graph for traces based on the specified
1225
+ # `RetrievalToken` from the CloudWatch log group generated by
1226
+ # Transaction Search. This API does not initiate a retrieval job. You
1227
+ # must first execute `StartTraceRetrieval` to obtain the required
1228
+ # `RetrievalToken`.
1229
+ #
1230
+ # The trace graph describes services that process incoming requests and
1231
+ # any downstream services they call, which may include Amazon Web
1232
+ # Services resources, external APIs, or databases.
1233
+ #
1234
+ # The response is empty until the `RetrievalStatus` is *COMPLETE*. Retry
1235
+ # the request after the status changes from *RUNNING* or *SCHEDULED* to
1236
+ # *COMPLETE* to access the full service graph.
1237
+ #
1238
+ # When CloudWatch log is the destination, this API can support
1239
+ # cross-account observability and service graph retrieval across linked
1240
+ # accounts.
1241
+ #
1242
+ # For retrieving graphs from X-Ray directly as opposed to the
1243
+ # Transaction-Search Log group, see [GetTraceGraph][1].
1244
+ #
1245
+ #
1246
+ #
1247
+ # [1]: https://docs.aws.amazon.com/xray/latest/api/API_GetTraceGraph.html
1248
+ #
1249
+ # @option params [required, String] :retrieval_token
1250
+ # Retrieval token.
1251
+ #
1252
+ # @option params [String] :next_token
1253
+ # Specify the pagination token returned by a previous request to
1254
+ # retrieve the next page of indexes.
1255
+ #
1256
+ # @return [Types::GetRetrievedTracesGraphResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1257
+ #
1258
+ # * {Types::GetRetrievedTracesGraphResult#retrieval_status #retrieval_status} => String
1259
+ # * {Types::GetRetrievedTracesGraphResult#services #services} => Array&lt;Types::RetrievedService&gt;
1260
+ # * {Types::GetRetrievedTracesGraphResult#next_token #next_token} => String
1261
+ #
1262
+ # @example Request syntax with placeholder values
1263
+ #
1264
+ # resp = client.get_retrieved_traces_graph({
1265
+ # retrieval_token: "RetrievalToken", # required
1266
+ # next_token: "String",
1267
+ # })
1268
+ #
1269
+ # @example Response structure
1270
+ #
1271
+ # resp.retrieval_status #=> String, one of "SCHEDULED", "RUNNING", "COMPLETE", "FAILED", "CANCELLED", "TIMEOUT"
1272
+ # resp.services #=> Array
1273
+ # resp.services[0].service.reference_id #=> Integer
1274
+ # resp.services[0].service.name #=> String
1275
+ # resp.services[0].service.names #=> Array
1276
+ # resp.services[0].service.names[0] #=> String
1277
+ # resp.services[0].service.root #=> Boolean
1278
+ # resp.services[0].service.account_id #=> String
1279
+ # resp.services[0].service.type #=> String
1280
+ # resp.services[0].service.state #=> String
1281
+ # resp.services[0].service.start_time #=> Time
1282
+ # resp.services[0].service.end_time #=> Time
1283
+ # resp.services[0].service.edges #=> Array
1284
+ # resp.services[0].service.edges[0].reference_id #=> Integer
1285
+ # resp.services[0].service.edges[0].start_time #=> Time
1286
+ # resp.services[0].service.edges[0].end_time #=> Time
1287
+ # resp.services[0].service.edges[0].summary_statistics.ok_count #=> Integer
1288
+ # resp.services[0].service.edges[0].summary_statistics.error_statistics.throttle_count #=> Integer
1289
+ # resp.services[0].service.edges[0].summary_statistics.error_statistics.other_count #=> Integer
1290
+ # resp.services[0].service.edges[0].summary_statistics.error_statistics.total_count #=> Integer
1291
+ # resp.services[0].service.edges[0].summary_statistics.fault_statistics.other_count #=> Integer
1292
+ # resp.services[0].service.edges[0].summary_statistics.fault_statistics.total_count #=> Integer
1293
+ # resp.services[0].service.edges[0].summary_statistics.total_count #=> Integer
1294
+ # resp.services[0].service.edges[0].summary_statistics.total_response_time #=> Float
1295
+ # resp.services[0].service.edges[0].response_time_histogram #=> Array
1296
+ # resp.services[0].service.edges[0].response_time_histogram[0].value #=> Float
1297
+ # resp.services[0].service.edges[0].response_time_histogram[0].count #=> Integer
1298
+ # resp.services[0].service.edges[0].aliases #=> Array
1299
+ # resp.services[0].service.edges[0].aliases[0].name #=> String
1300
+ # resp.services[0].service.edges[0].aliases[0].names #=> Array
1301
+ # resp.services[0].service.edges[0].aliases[0].names[0] #=> String
1302
+ # resp.services[0].service.edges[0].aliases[0].type #=> String
1303
+ # resp.services[0].service.edges[0].edge_type #=> String
1304
+ # resp.services[0].service.edges[0].received_event_age_histogram #=> Array
1305
+ # resp.services[0].service.edges[0].received_event_age_histogram[0].value #=> Float
1306
+ # resp.services[0].service.edges[0].received_event_age_histogram[0].count #=> Integer
1307
+ # resp.services[0].service.summary_statistics.ok_count #=> Integer
1308
+ # resp.services[0].service.summary_statistics.error_statistics.throttle_count #=> Integer
1309
+ # resp.services[0].service.summary_statistics.error_statistics.other_count #=> Integer
1310
+ # resp.services[0].service.summary_statistics.error_statistics.total_count #=> Integer
1311
+ # resp.services[0].service.summary_statistics.fault_statistics.other_count #=> Integer
1312
+ # resp.services[0].service.summary_statistics.fault_statistics.total_count #=> Integer
1313
+ # resp.services[0].service.summary_statistics.total_count #=> Integer
1314
+ # resp.services[0].service.summary_statistics.total_response_time #=> Float
1315
+ # resp.services[0].service.duration_histogram #=> Array
1316
+ # resp.services[0].service.duration_histogram[0].value #=> Float
1317
+ # resp.services[0].service.duration_histogram[0].count #=> Integer
1318
+ # resp.services[0].service.response_time_histogram #=> Array
1319
+ # resp.services[0].service.response_time_histogram[0].value #=> Float
1320
+ # resp.services[0].service.response_time_histogram[0].count #=> Integer
1321
+ # resp.services[0].links #=> Array
1322
+ # resp.services[0].links[0].reference_type #=> String
1323
+ # resp.services[0].links[0].source_trace_id #=> String
1324
+ # resp.services[0].links[0].destination_trace_ids #=> Array
1325
+ # resp.services[0].links[0].destination_trace_ids[0] #=> String
1326
+ # resp.next_token #=> String
1327
+ #
1328
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetRetrievedTracesGraph AWS API Documentation
1329
+ #
1330
+ # @overload get_retrieved_traces_graph(params = {})
1331
+ # @param [Hash] params ({})
1332
+ def get_retrieved_traces_graph(params = {}, options = {})
1333
+ req = build_request(:get_retrieved_traces_graph, params)
1334
+ req.send_request(options)
1335
+ end
1336
+
1152
1337
  # Retrieves all sampling rules.
1153
1338
  #
1154
1339
  # @option params [String] :next_token
@@ -1571,6 +1756,35 @@ module Aws::XRay
1571
1756
  req.send_request(options)
1572
1757
  end
1573
1758
 
1759
+ # Retrieves the current destination of data sent to `PutTraceSegments`
1760
+ # and *OpenTelemetry* API. The Transaction Search feature requires a
1761
+ # CloudWatchLogs destination. For more information, see [Transaction
1762
+ # Search][1] and [OpenTelemetry][2].
1763
+ #
1764
+ #
1765
+ #
1766
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Transaction-Search.html
1767
+ # [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-OpenTelemetry-Sections.html
1768
+ #
1769
+ # @return [Types::GetTraceSegmentDestinationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1770
+ #
1771
+ # * {Types::GetTraceSegmentDestinationResult#destination #destination} => String
1772
+ # * {Types::GetTraceSegmentDestinationResult#status #status} => String
1773
+ #
1774
+ # @example Response structure
1775
+ #
1776
+ # resp.destination #=> String, one of "XRay", "CloudWatchLogs"
1777
+ # resp.status #=> String, one of "PENDING", "ACTIVE"
1778
+ #
1779
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetTraceSegmentDestination AWS API Documentation
1780
+ #
1781
+ # @overload get_trace_segment_destination(params = {})
1782
+ # @param [Hash] params ({})
1783
+ def get_trace_segment_destination(params = {}, options = {})
1784
+ req = build_request(:get_trace_segment_destination, params)
1785
+ req.send_request(options)
1786
+ end
1787
+
1574
1788
  # Retrieves IDs and annotations for traces available for a specified
1575
1789
  # time frame using an optional filter. To get the full traces, pass the
1576
1790
  # trace IDs to `BatchGetTraces`.
@@ -1588,12 +1802,12 @@ module Aws::XRay
1588
1802
  # `annotation.account = "12345"`
1589
1803
  #
1590
1804
  # For a full list of indexed fields and keywords that you can use in
1591
- # filter expressions, see [Using Filter Expressions][1] in the *Amazon
1592
- # Web Services X-Ray Developer Guide*.
1805
+ # filter expressions, see [Use filter expressions][1] in the *Amazon Web
1806
+ # Services X-Ray Developer Guide*.
1593
1807
  #
1594
1808
  #
1595
1809
  #
1596
- # [1]: https://docs.aws.amazon.com/xray/latest/devguide/xray-console-filters.html
1810
+ # [1]: https://docs.aws.amazon.com/xray/latest/devguide/aws-xray-interface-console.html#xray-console-filters
1597
1811
  #
1598
1812
  # @option params [required, Time,DateTime,Date,Integer,String] :start_time
1599
1813
  # The start of the time frame for which to retrieve traces.
@@ -1602,8 +1816,8 @@ module Aws::XRay
1602
1816
  # The end of the time frame for which to retrieve traces.
1603
1817
  #
1604
1818
  # @option params [String] :time_range_type
1605
- # A parameter to indicate whether to query trace summaries by TraceId,
1606
- # Event (trace update time), or Service (segment end time).
1819
+ # Query trace summaries by TraceId (trace start time), Event (trace
1820
+ # update time), or Service (trace segment end time).
1607
1821
  #
1608
1822
  # @option params [Boolean] :sampling
1609
1823
  # Set to `true` to get summaries for only a subset of available traces.
@@ -1791,6 +2005,77 @@ module Aws::XRay
1791
2005
  req.send_request(options)
1792
2006
  end
1793
2007
 
2008
+ # Retrieves a list of traces for a given `RetrievalToken` from the
2009
+ # CloudWatch log group generated by Transaction Search. For information
2010
+ # on what each trace returns, see [BatchGetTraces][1].
2011
+ #
2012
+ # This API does not initiate a retrieval job. To start a trace
2013
+ # retrieval, use `StartTraceRetrieval`, which generates the required
2014
+ # `RetrievalToken`.
2015
+ #
2016
+ # When the `RetrievalStatus` is not *COMPLETE*, the API will return an
2017
+ # empty response. Retry the request once the retrieval has completed to
2018
+ # access the full list of traces.
2019
+ #
2020
+ # For cross-account observability, this API can retrieve traces from
2021
+ # linked accounts when CloudWatch log is the destination across relevant
2022
+ # accounts. For more details, see [CloudWatch cross-account
2023
+ # observability][2].
2024
+ #
2025
+ # For retrieving data from X-Ray directly as opposed to the
2026
+ # Transaction-Search Log group, see [BatchGetTraces][1].
2027
+ #
2028
+ #
2029
+ #
2030
+ # [1]: https://docs.aws.amazon.com/xray/latest/api/API_BatchGetTraces.html
2031
+ # [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html
2032
+ #
2033
+ # @option params [required, String] :retrieval_token
2034
+ # Retrieval token.
2035
+ #
2036
+ # @option params [String] :trace_format
2037
+ # Format of the requested traces.
2038
+ #
2039
+ # @option params [String] :next_token
2040
+ # Specify the pagination token returned by a previous request to
2041
+ # retrieve the next page of indexes.
2042
+ #
2043
+ # @return [Types::ListRetrievedTracesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2044
+ #
2045
+ # * {Types::ListRetrievedTracesResult#retrieval_status #retrieval_status} => String
2046
+ # * {Types::ListRetrievedTracesResult#trace_format #trace_format} => String
2047
+ # * {Types::ListRetrievedTracesResult#traces #traces} => Array&lt;Types::RetrievedTrace&gt;
2048
+ # * {Types::ListRetrievedTracesResult#next_token #next_token} => String
2049
+ #
2050
+ # @example Request syntax with placeholder values
2051
+ #
2052
+ # resp = client.list_retrieved_traces({
2053
+ # retrieval_token: "RetrievalToken", # required
2054
+ # trace_format: "XRAY", # accepts XRAY, OTEL
2055
+ # next_token: "String",
2056
+ # })
2057
+ #
2058
+ # @example Response structure
2059
+ #
2060
+ # resp.retrieval_status #=> String, one of "SCHEDULED", "RUNNING", "COMPLETE", "FAILED", "CANCELLED", "TIMEOUT"
2061
+ # resp.trace_format #=> String, one of "XRAY", "OTEL"
2062
+ # resp.traces #=> Array
2063
+ # resp.traces[0].id #=> String
2064
+ # resp.traces[0].duration #=> Float
2065
+ # resp.traces[0].spans #=> Array
2066
+ # resp.traces[0].spans[0].id #=> String
2067
+ # resp.traces[0].spans[0].document #=> String
2068
+ # resp.next_token #=> String
2069
+ #
2070
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/ListRetrievedTraces AWS API Documentation
2071
+ #
2072
+ # @overload list_retrieved_traces(params = {})
2073
+ # @param [Hash] params ({})
2074
+ def list_retrieved_traces(params = {}, options = {})
2075
+ req = build_request(:list_retrieved_traces, params)
2076
+ req.send_request(options)
2077
+ end
2078
+
1794
2079
  # Returns a list of tags that are applied to the specified Amazon Web
1795
2080
  # Services X-Ray group or sampling rule.
1796
2081
  #
@@ -1995,13 +2280,12 @@ module Aws::XRay
1995
2280
  req.send_request(options)
1996
2281
  end
1997
2282
 
1998
- # Uploads segment documents to Amazon Web Services X-Ray. The [X-Ray
1999
- # SDK][1] generates segment documents and sends them to the X-Ray
2000
- # daemon, which uploads them in batches. A segment document can be a
2001
- # completed segment, an in-progress segment, or an array of subsegments.
2283
+ # Uploads segment documents to Amazon Web Services X-Ray. A segment
2284
+ # document can be a completed segment, an in-progress segment, or an
2285
+ # array of subsegments.
2002
2286
  #
2003
2287
  # Segments must include the following fields. For the full segment
2004
- # document schema, see [Amazon Web Services X-Ray Segment Documents][2]
2288
+ # document schema, see [Amazon Web Services X-Ray Segment Documents][1]
2005
2289
  # in the *Amazon Web Services X-Ray Developer Guide*.
2006
2290
  #
2007
2291
  # **Required segment document fields**
@@ -2030,7 +2314,9 @@ module Aws::XRay
2030
2314
  # overwrite the in-progress segment.
2031
2315
  #
2032
2316
  # A `trace_id` consists of three numbers separated by hyphens. For
2033
- # example, 1-58406520-a006649127e371903a2de979. This includes:
2317
+ # example, 1-58406520-a006649127e371903a2de979. For trace IDs created by
2318
+ # an X-Ray SDK, or by Amazon Web Services services integrated with
2319
+ # X-Ray, a trace ID includes:
2034
2320
  #
2035
2321
  # **Trace ID Format**
2036
2322
  #
@@ -2043,10 +2329,20 @@ module Aws::XRay
2043
2329
  # * A 96-bit identifier for the trace, globally unique, in 24
2044
2330
  # hexadecimal digits.
2045
2331
  #
2332
+ # <note markdown="1"> Trace IDs created via OpenTelemetry have a different format based on
2333
+ # the [W3C Trace Context specification][2]. A W3C trace ID must be
2334
+ # formatted in the X-Ray trace ID format when sending to X-Ray. For
2335
+ # example, a W3C trace ID `4efaaf4d1e8720b39541901950019ee5` should be
2336
+ # formatted as `1-4efaaf4d-1e8720b39541901950019ee5` when sending to
2337
+ # X-Ray. While X-Ray trace IDs include the original request timestamp in
2338
+ # Unix epoch time, this is not required or validated.
2339
+ #
2340
+ # </note>
2046
2341
  #
2047
2342
  #
2048
- # [1]: https://docs.aws.amazon.com/xray/index.html
2049
- # [2]: https://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html
2343
+ #
2344
+ # [1]: https://docs.aws.amazon.com/xray/latest/devguide/aws-xray-interface-api.html#xray-api-segmentdocuments.html
2345
+ # [2]: https://www.w3.org/TR/trace-context/
2050
2346
  #
2051
2347
  # @option params [required, Array<String>] :trace_segment_documents
2052
2348
  # A string containing a JSON document defining one or more segments or
@@ -2078,6 +2374,69 @@ module Aws::XRay
2078
2374
  req.send_request(options)
2079
2375
  end
2080
2376
 
2377
+ # Initiates a trace retrieval process using the specified time range and
2378
+ # for the give trace IDs on Transaction Search generated by the
2379
+ # CloudWatch log group. For more information, see [Transaction
2380
+ # Search][1].
2381
+ #
2382
+ # API returns a `RetrievalToken`, which can be used with
2383
+ # `ListRetrievedTraces` or `GetRetrievedTracesGraph` to fetch results.
2384
+ # Retrievals will time out after 60 minutes. To execute long time
2385
+ # ranges, consider segmenting into multiple retrievals.
2386
+ #
2387
+ # If you are using [CloudWatch cross-account observability][2], you can
2388
+ # use this operation in a monitoring account to retrieve data from a
2389
+ # linked source account, as long as both accounts have transaction
2390
+ # search enabled.
2391
+ #
2392
+ # For retrieving data from X-Ray directly as opposed to the
2393
+ # Transaction-Search Log group, see [BatchGetTraces][3].
2394
+ #
2395
+ #
2396
+ #
2397
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Transaction-Search.html
2398
+ # [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html
2399
+ # [3]: https://docs.aws.amazon.com/xray/latest/api/API_BatchGetTraces.html
2400
+ #
2401
+ # @option params [required, Array<String>] :trace_ids
2402
+ # Specify the trace IDs of the traces to be retrieved.
2403
+ #
2404
+ # @option params [required, Time,DateTime,Date,Integer,String] :start_time
2405
+ # The start of the time range to retrieve traces. The range is
2406
+ # inclusive, so the specified start time is included in the query.
2407
+ # Specified as epoch time, the number of seconds since January 1, 1970,
2408
+ # 00:00:00 UTC.
2409
+ #
2410
+ # @option params [required, Time,DateTime,Date,Integer,String] :end_time
2411
+ # The end of the time range to retrieve traces. The range is inclusive,
2412
+ # so the specified end time is included in the query. Specified as epoch
2413
+ # time, the number of seconds since January 1, 1970, 00:00:00 UTC.
2414
+ #
2415
+ # @return [Types::StartTraceRetrievalResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2416
+ #
2417
+ # * {Types::StartTraceRetrievalResult#retrieval_token #retrieval_token} => String
2418
+ #
2419
+ # @example Request syntax with placeholder values
2420
+ #
2421
+ # resp = client.start_trace_retrieval({
2422
+ # trace_ids: ["TraceId"], # required
2423
+ # start_time: Time.now, # required
2424
+ # end_time: Time.now, # required
2425
+ # })
2426
+ #
2427
+ # @example Response structure
2428
+ #
2429
+ # resp.retrieval_token #=> String
2430
+ #
2431
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/StartTraceRetrieval AWS API Documentation
2432
+ #
2433
+ # @overload start_trace_retrieval(params = {})
2434
+ # @param [Hash] params ({})
2435
+ def start_trace_retrieval(params = {}, options = {})
2436
+ req = build_request(:start_trace_retrieval, params)
2437
+ req.send_request(options)
2438
+ end
2439
+
2081
2440
  # Applies tags to an existing Amazon Web Services X-Ray group or
2082
2441
  # sampling rule.
2083
2442
  #
@@ -2216,6 +2575,53 @@ module Aws::XRay
2216
2575
  req.send_request(options)
2217
2576
  end
2218
2577
 
2578
+ # Modifies an indexing rule’s configuration.
2579
+ #
2580
+ # Indexing rules are used for determining the sampling rate for spans
2581
+ # indexed from CloudWatch Logs. For more information, see [Transaction
2582
+ # Search][1].
2583
+ #
2584
+ #
2585
+ #
2586
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Transaction-Search.html
2587
+ #
2588
+ # @option params [required, String] :name
2589
+ # Name of the indexing rule to be updated.
2590
+ #
2591
+ # @option params [required, Types::IndexingRuleValueUpdate] :rule
2592
+ # Rule configuration to be updated.
2593
+ #
2594
+ # @return [Types::UpdateIndexingRuleResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2595
+ #
2596
+ # * {Types::UpdateIndexingRuleResult#indexing_rule #indexing_rule} => Types::IndexingRule
2597
+ #
2598
+ # @example Request syntax with placeholder values
2599
+ #
2600
+ # resp = client.update_indexing_rule({
2601
+ # name: "String", # required
2602
+ # rule: { # required
2603
+ # probabilistic: {
2604
+ # desired_sampling_percentage: 1.0, # required
2605
+ # },
2606
+ # },
2607
+ # })
2608
+ #
2609
+ # @example Response structure
2610
+ #
2611
+ # resp.indexing_rule.name #=> String
2612
+ # resp.indexing_rule.modified_at #=> Time
2613
+ # resp.indexing_rule.rule.probabilistic.desired_sampling_percentage #=> Float
2614
+ # resp.indexing_rule.rule.probabilistic.actual_sampling_percentage #=> Float
2615
+ #
2616
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/UpdateIndexingRule AWS API Documentation
2617
+ #
2618
+ # @overload update_indexing_rule(params = {})
2619
+ # @param [Hash] params ({})
2620
+ def update_indexing_rule(params = {}, options = {})
2621
+ req = build_request(:update_indexing_rule, params)
2622
+ req.send_request(options)
2623
+ end
2624
+
2219
2625
  # Modifies a sampling rule's configuration.
2220
2626
  #
2221
2627
  # @option params [required, Types::SamplingRuleUpdate] :sampling_rule_update
@@ -2274,6 +2680,42 @@ module Aws::XRay
2274
2680
  req.send_request(options)
2275
2681
  end
2276
2682
 
2683
+ # Modifies the destination of data sent to `PutTraceSegments`. The
2684
+ # Transaction Search feature requires the CloudWatchLogs destination.
2685
+ # For more information, see [Transaction Search][1].
2686
+ #
2687
+ #
2688
+ #
2689
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Transaction-Search.html
2690
+ #
2691
+ # @option params [String] :destination
2692
+ # The configured destination of trace segments.
2693
+ #
2694
+ # @return [Types::UpdateTraceSegmentDestinationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2695
+ #
2696
+ # * {Types::UpdateTraceSegmentDestinationResult#destination #destination} => String
2697
+ # * {Types::UpdateTraceSegmentDestinationResult#status #status} => String
2698
+ #
2699
+ # @example Request syntax with placeholder values
2700
+ #
2701
+ # resp = client.update_trace_segment_destination({
2702
+ # destination: "XRay", # accepts XRay, CloudWatchLogs
2703
+ # })
2704
+ #
2705
+ # @example Response structure
2706
+ #
2707
+ # resp.destination #=> String, one of "XRay", "CloudWatchLogs"
2708
+ # resp.status #=> String, one of "PENDING", "ACTIVE"
2709
+ #
2710
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/UpdateTraceSegmentDestination AWS API Documentation
2711
+ #
2712
+ # @overload update_trace_segment_destination(params = {})
2713
+ # @param [Hash] params ({})
2714
+ def update_trace_segment_destination(params = {}, options = {})
2715
+ req = build_request(:update_trace_segment_destination, params)
2716
+ req.send_request(options)
2717
+ end
2718
+
2277
2719
  # @!endgroup
2278
2720
 
2279
2721
  # @param params ({})
@@ -2292,7 +2734,7 @@ module Aws::XRay
2292
2734
  tracer: tracer
2293
2735
  )
2294
2736
  context[:gem_name] = 'aws-sdk-xray'
2295
- context[:gem_version] = '1.77.0'
2737
+ context[:gem_version] = '1.78.0'
2296
2738
  Seahorse::Client::Request.new(handlers, context)
2297
2739
  end
2298
2740