lib/aws-sdk-xray/client.rb in aws-sdk-xray-1.21.0 vs lib/aws-sdk-xray/client.rb in aws-sdk-xray-1.22.0
- old
+ new
@@ -260,11 +260,11 @@
#
# @option params [required, Array<String>] :trace_ids
# Specify the trace IDs of requests for which to retrieve segments.
#
# @option params [String] :next_token
- # Pagination token. Not used.
+ # Pagination token.
#
# @return [Types::BatchGetTracesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::BatchGetTracesResult#traces #traces} => Array<Types::Trace>
# * {Types::BatchGetTracesResult#unprocessed_trace_ids #unprocessed_trace_ids} => Array<String>
@@ -530,11 +530,11 @@
end
# Retrieves all active group details.
#
# @option params [String] :next_token
- # Pagination token. Not used.
+ # Pagination token.
#
# @return [Types::GetGroupsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetGroupsResult#groups #groups} => Array<Types::GroupSummary>
# * {Types::GetGroupsResult#next_token #next_token} => String
@@ -563,11 +563,11 @@
end
# Retrieves all sampling rules.
#
# @option params [String] :next_token
- # Pagination token. Not used.
+ # Pagination token.
#
# @return [Types::GetSamplingRulesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetSamplingRulesResult#sampling_rule_records #sampling_rule_records} => Array<Types::SamplingRuleRecord>
# * {Types::GetSamplingRulesResult#next_token #next_token} => String
@@ -610,11 +610,11 @@
# Retrieves information about recent sampling results for all sampling
# rules.
#
# @option params [String] :next_token
- # Pagination token. Not used.
+ # Pagination token.
#
# @return [Types::GetSamplingStatisticSummariesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetSamplingStatisticSummariesResult#sampling_statistic_summaries #sampling_statistic_summaries} => Array<Types::SamplingStatisticSummary>
# * {Types::GetSamplingStatisticSummariesResult#next_token #next_token} => String
@@ -695,14 +695,18 @@
end
# 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.
+ # services. Root services are applications that use the [AWS X-Ray
+ # SDK][1]. Downstream services can be other applications, AWS resources,
+ # HTTP web APIs, or SQL databases.
#
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/xray/index.html
+ #
# @option params [required, Time,DateTime,Date,Integer,String] :start_time
# The start of the time frame for which to generate a graph.
#
# @option params [required, Time,DateTime,Date,Integer,String] :end_time
# The end of the timeframe for which to generate a graph.
@@ -712,11 +716,11 @@
#
# @option params [String] :group_arn
# The ARN of a group to generate a graph based on.
#
# @option params [String] :next_token
- # Pagination token. Not used.
+ # Pagination token.
#
# @return [Types::GetServiceGraphResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetServiceGraphResult#start_time #start_time} => Time
# * {Types::GetServiceGraphResult#end_time #end_time} => Time
@@ -818,11 +822,11 @@
#
# @option params [Integer] :period
# Aggregation period in seconds.
#
# @option params [String] :next_token
- # Pagination token. Not used.
+ # Pagination token.
#
# @return [Types::GetTimeSeriesServiceStatisticsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetTimeSeriesServiceStatisticsResult#time_series_service_statistics #time_series_service_statistics} => Array<Types::TimeSeriesServiceStatistics>
# * {Types::GetTimeSeriesServiceStatisticsResult#contains_old_group_versions #contains_old_group_versions} => Boolean
@@ -879,11 +883,11 @@
#
# @option params [required, Array<String>] :trace_ids
# Trace IDs of requests for which to generate a service graph.
#
# @option params [String] :next_token
- # Pagination token. Not used.
+ # Pagination token.
#
# @return [Types::GetTraceGraphResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetTraceGraphResult#services #services} => Array<Types::Service>
# * {Types::GetTraceGraphResult#next_token #next_token} => String
@@ -951,13 +955,13 @@
def get_trace_graph(params = {}, options = {})
req = build_request(:get_trace_graph, params)
req.send_request(options)
end
- # Retrieves IDs and metadata for traces available for a specified time
- # frame using an optional filter. To get the full traces, pass the trace
- # IDs to `BatchGetTraces`.
+ # 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`\:
@@ -1136,11 +1140,12 @@
# 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`.
+ # `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.
@@ -1221,17 +1226,17 @@
def put_telemetry_records(params = {}, options = {})
req = build_request(:put_telemetry_records, params)
req.send_request(options)
end
- # Uploads segment documents to AWS X-Ray. The X-Ray SDK generates
+ # Uploads segment documents to AWS X-Ray. The [X-Ray SDK][1] 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][1] in the *AWS
+ # document schema, see [AWS X-Ray Segment Documents][2] in the *AWS
# X-Ray Developer Guide*.
#
# **Required Segment Document Fields**
#
# * `name` - The name of the service that handled the request.
@@ -1271,11 +1276,12 @@
# * A 96-bit identifier for the trace, globally unique, in 24
# hexadecimal digits.
#
#
#
- # [1]: https://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html
+ # [1]: https://docs.aws.amazon.com/xray/index.html
+ # [2]: https://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html
#
# @option params [required, Array<String>] :trace_segment_documents
# A string containing a JSON document defining one or more segments or
# subsegments.
#
@@ -1413,10 +1419,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-xray'
- context[:gem_version] = '1.21.0'
+ context[:gem_version] = '1.22.0'
Seahorse::Client::Request.new(handlers, context)
end
# @api private
# @deprecated