aws-sdk-xray 1.0.0.rc2 → 1.0.0.rc3

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
  SHA1:
3
- metadata.gz: b2e5e9f4252a43efd98ee7b553dd6423f6ccd399
4
- data.tar.gz: 39c9b1d07176225be068202d57816afacd302fee
3
+ metadata.gz: a25b00e8136734abd3e1431b10844b44a09d93e7
4
+ data.tar.gz: e88d015578c64d5be3dba89ffc1a7572cce29e1f
5
5
  SHA512:
6
- metadata.gz: a8ac7705cf232cf0ea23cac539552672e65031d0ea5e9cea7c7266686b533d8f908717850170e4946a8871e58af036431ceeea08ab0649bcc24367aa2f78eb4c
7
- data.tar.gz: e6790a7b38818fe2ea0db804d5f00ae219640a93f7c1e7de6a1087886f2285a624bddff49715a47442ab48796a74e21b06287b838caf6b320b8c8f933c7a6226
6
+ metadata.gz: e795f0ba5df7dc364b0b43371464a4d0c343edef63a80b72d5df9eac988b6e56930e23f139d3e5857767f47fad312e6ec064ee4a561203cff965055819939782
7
+ data.tar.gz: e56983c0fb15fd5f05bbea4b6953097112a40f1ba31a4599784fd8f5542f2210d581cfe8f0eb01763260b2fe0e17052ab941d7be7664454cc76b02566ae0b8e4
@@ -1,6 +1,6 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
3
+ # This file is generated. See the contributing guide for more information:
4
4
  # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
5
  #
6
6
  # WARNING ABOUT GENERATED CODE
@@ -42,6 +42,6 @@ require_relative 'aws-sdk-xray/customizations'
42
42
  # @service
43
43
  module Aws::XRay
44
44
 
45
- GEM_VERSION = '1.0.0.rc2'
45
+ GEM_VERSION = '1.0.0.rc3'
46
46
 
47
47
  end
@@ -1,6 +1,6 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
3
+ # This file is generated. See the contributing guide for more information:
4
4
  # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
5
  #
6
6
  # WARNING ABOUT GENERATED CODE
@@ -18,518 +18,584 @@ require 'aws-sdk-core/plugins/regional_endpoint.rb'
18
18
  require 'aws-sdk-core/plugins/response_paging.rb'
19
19
  require 'aws-sdk-core/plugins/stub_responses.rb'
20
20
  require 'aws-sdk-core/plugins/idempotency_token.rb'
21
+ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
21
22
  require 'aws-sdk-core/plugins/signature_v4.rb'
22
23
  require 'aws-sdk-core/plugins/protocols/rest_json.rb'
23
24
 
24
25
  Aws::Plugins::GlobalConfiguration.add_identifier(:xray)
25
26
 
26
- module Aws
27
- module XRay
28
- class Client < Seahorse::Client::Base
27
+ module Aws::XRay
28
+ class Client < Seahorse::Client::Base
29
29
 
30
- include Aws::ClientStubs
30
+ include Aws::ClientStubs
31
31
 
32
- @identifier = :xray
32
+ @identifier = :xray
33
33
 
34
- set_api(ClientApi::API)
34
+ set_api(ClientApi::API)
35
35
 
36
- add_plugin(Seahorse::Client::Plugins::ContentLength)
37
- add_plugin(Aws::Plugins::CredentialsConfiguration)
38
- add_plugin(Aws::Plugins::Logging)
39
- add_plugin(Aws::Plugins::ParamConverter)
40
- add_plugin(Aws::Plugins::ParamValidator)
41
- add_plugin(Aws::Plugins::UserAgent)
42
- add_plugin(Aws::Plugins::HelpfulSocketErrors)
43
- add_plugin(Aws::Plugins::RetryErrors)
44
- add_plugin(Aws::Plugins::GlobalConfiguration)
45
- add_plugin(Aws::Plugins::RegionalEndpoint)
46
- add_plugin(Aws::Plugins::ResponsePaging)
47
- add_plugin(Aws::Plugins::StubResponses)
48
- add_plugin(Aws::Plugins::IdempotencyToken)
49
- add_plugin(Aws::Plugins::SignatureV4)
50
- add_plugin(Aws::Plugins::Protocols::RestJson)
36
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
37
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
38
+ add_plugin(Aws::Plugins::Logging)
39
+ add_plugin(Aws::Plugins::ParamConverter)
40
+ add_plugin(Aws::Plugins::ParamValidator)
41
+ add_plugin(Aws::Plugins::UserAgent)
42
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
43
+ add_plugin(Aws::Plugins::RetryErrors)
44
+ add_plugin(Aws::Plugins::GlobalConfiguration)
45
+ add_plugin(Aws::Plugins::RegionalEndpoint)
46
+ add_plugin(Aws::Plugins::ResponsePaging)
47
+ add_plugin(Aws::Plugins::StubResponses)
48
+ add_plugin(Aws::Plugins::IdempotencyToken)
49
+ add_plugin(Aws::Plugins::JsonvalueConverter)
50
+ add_plugin(Aws::Plugins::SignatureV4)
51
+ add_plugin(Aws::Plugins::Protocols::RestJson)
51
52
 
52
- # @option options [required, Aws::CredentialProvider] :credentials
53
- # Your AWS credentials. This can be an instance of any one of the
54
- # following classes:
55
- #
56
- # * `Aws::Credentials` - Used for configuring static, non-refreshing
57
- # credentials.
58
- #
59
- # * `Aws::InstanceProfileCredentials` - Used for loading credentials
60
- # from an EC2 IMDS on an EC2 instance.
61
- #
62
- # * `Aws::SharedCredentials` - Used for loading credentials from a
63
- # shared file, such as `~/.aws/config`.
64
- #
65
- # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
66
- #
67
- # When `:credentials` are not configured directly, the following
68
- # locations will be searched for credentials:
69
- #
70
- # * `Aws.config[:credentials]`
71
- # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
72
- # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
73
- # * `~/.aws/credentials`
74
- # * `~/.aws/config`
75
- # * EC2 IMDS instance profile - When used by default, the timeouts are
76
- # very aggressive. Construct and pass an instance of
77
- # `Aws::InstanceProfileCredentails` to enable retries and extended
78
- # timeouts.
79
- # @option options [required, String] :region
80
- # The AWS region to connect to. The configured `:region` is
81
- # used to determine the service `:endpoint`. When not passed,
82
- # a default `:region` is search for in the following locations:
83
- #
84
- # * `Aws.config[:region]`
85
- # * `ENV['AWS_REGION']`
86
- # * `ENV['AMAZON_REGION']`
87
- # * `ENV['AWS_DEFAULT_REGION']`
88
- # * `~/.aws/credentials`
89
- # * `~/.aws/config`
90
- # @option options [String] :access_key_id
91
- # @option options [Boolean] :convert_params (true)
92
- # When `true`, an attempt is made to coerce request parameters into
93
- # the required types.
94
- # @option options [String] :endpoint
95
- # The client endpoint is normally constructed from the `:region`
96
- # option. You should only configure an `:endpoint` when connecting
97
- # to test endpoints. This should be avalid HTTP(S) URI.
98
- # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
99
- # The log formatter.
100
- # @option options [Symbol] :log_level (:info)
101
- # The log level to send messages to the `:logger` at.
102
- # @option options [Logger] :logger
103
- # The Logger instance to send log messages to. If this option
104
- # is not set, logging will be disabled.
105
- # @option options [String] :profile ("default")
106
- # Used when loading credentials from the shared credentials file
107
- # at HOME/.aws/credentials. When not specified, 'default' is used.
108
- # @option options [Integer] :retry_limit (3)
109
- # The maximum number of times to retry failed requests. Only
110
- # ~ 500 level server errors and certain ~ 400 level client errors
111
- # are retried. Generally, these are throttling errors, data
112
- # checksum errors, networking errors, timeout errors and auth
113
- # errors from expired credentials.
114
- # @option options [String] :secret_access_key
115
- # @option options [String] :session_token
116
- # @option options [Boolean] :stub_responses (false)
117
- # Causes the client to return stubbed responses. By default
118
- # fake responses are generated and returned. You can specify
119
- # the response data to return or errors to raise by calling
120
- # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
121
- #
122
- # ** Please note ** When response stubbing is enabled, no HTTP
123
- # requests are made, and retries are disabled.
124
- # @option options [Boolean] :validate_params (true)
125
- # When `true`, request parameters are validated before
126
- # sending the request.
127
- def initialize(*args)
128
- super
129
- end
130
-
131
- # @!group API Operations
53
+ # @option options [required, Aws::CredentialProvider] :credentials
54
+ # Your AWS credentials. This can be an instance of any one of the
55
+ # following classes:
56
+ #
57
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
58
+ # credentials.
59
+ #
60
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
61
+ # from an EC2 IMDS on an EC2 instance.
62
+ #
63
+ # * `Aws::SharedCredentials` - Used for loading credentials from a
64
+ # shared file, such as `~/.aws/config`.
65
+ #
66
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
67
+ #
68
+ # When `:credentials` are not configured directly, the following
69
+ # locations will be searched for credentials:
70
+ #
71
+ # * `Aws.config[:credentials]`
72
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
73
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
74
+ # * `~/.aws/credentials`
75
+ # * `~/.aws/config`
76
+ # * EC2 IMDS instance profile - When used by default, the timeouts are
77
+ # very aggressive. Construct and pass an instance of
78
+ # `Aws::InstanceProfileCredentails` to enable retries and extended
79
+ # timeouts.
80
+ #
81
+ # @option options [required, String] :region
82
+ # The AWS region to connect to. The configured `:region` is
83
+ # used to determine the service `:endpoint`. When not passed,
84
+ # a default `:region` is search for in the following locations:
85
+ #
86
+ # * `Aws.config[:region]`
87
+ # * `ENV['AWS_REGION']`
88
+ # * `ENV['AMAZON_REGION']`
89
+ # * `ENV['AWS_DEFAULT_REGION']`
90
+ # * `~/.aws/credentials`
91
+ # * `~/.aws/config`
92
+ #
93
+ # @option options [String] :access_key_id
94
+ #
95
+ # @option options [Boolean] :convert_params (true)
96
+ # When `true`, an attempt is made to coerce request parameters into
97
+ # the required types.
98
+ #
99
+ # @option options [String] :endpoint
100
+ # The client endpoint is normally constructed from the `:region`
101
+ # option. You should only configure an `:endpoint` when connecting
102
+ # to test endpoints. This should be avalid HTTP(S) URI.
103
+ #
104
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
105
+ # The log formatter.
106
+ #
107
+ # @option options [Symbol] :log_level (:info)
108
+ # The log level to send messages to the `:logger` at.
109
+ #
110
+ # @option options [Logger] :logger
111
+ # The Logger instance to send log messages to. If this option
112
+ # is not set, logging will be disabled.
113
+ #
114
+ # @option options [String] :profile ("default")
115
+ # Used when loading credentials from the shared credentials file
116
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
117
+ #
118
+ # @option options [Integer] :retry_limit (3)
119
+ # The maximum number of times to retry failed requests. Only
120
+ # ~ 500 level server errors and certain ~ 400 level client errors
121
+ # are retried. Generally, these are throttling errors, data
122
+ # checksum errors, networking errors, timeout errors and auth
123
+ # errors from expired credentials.
124
+ #
125
+ # @option options [String] :secret_access_key
126
+ #
127
+ # @option options [String] :session_token
128
+ #
129
+ # @option options [Boolean] :stub_responses (false)
130
+ # Causes the client to return stubbed responses. By default
131
+ # fake responses are generated and returned. You can specify
132
+ # the response data to return or errors to raise by calling
133
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
134
+ #
135
+ # ** Please note ** When response stubbing is enabled, no HTTP
136
+ # requests are made, and retries are disabled.
137
+ #
138
+ # @option options [Boolean] :validate_params (true)
139
+ # When `true`, request parameters are validated before
140
+ # sending the request.
141
+ #
142
+ def initialize(*args)
143
+ super
144
+ end
132
145
 
133
- # Retrieves a list of traces specified by ID. Each trace is a collection
134
- # of segment documents that originates from a single request. Use
135
- # `GetTraceSummaries` to get a list of trace IDs.
136
- # @option params [required, Array<String>] :trace_ids
137
- # Specify the trace IDs of requests for which to retrieve segments.
138
- # @option params [String] :next_token
139
- # Pagination token. Not used.
140
- # @return [Types::BatchGetTracesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
141
- #
142
- # * {Types::BatchGetTracesResult#traces #Traces} => Array&lt;Types::Trace&gt;
143
- # * {Types::BatchGetTracesResult#unprocessed_trace_ids #UnprocessedTraceIds} => Array&lt;String&gt;
144
- # * {Types::BatchGetTracesResult#next_token #NextToken} => String
145
- #
146
- # @example Request syntax with placeholder values
147
- # resp = client.batch_get_traces({
148
- # trace_ids: ["TraceId"], # required
149
- # next_token: "String",
150
- # })
151
- #
152
- # @example Response structure
153
- # resp.traces #=> Array
154
- # resp.traces[0].id #=> String
155
- # resp.traces[0].duration #=> Float
156
- # resp.traces[0].segments #=> Array
157
- # resp.traces[0].segments[0].id #=> String
158
- # resp.traces[0].segments[0].document #=> String
159
- # resp.unprocessed_trace_ids #=> Array
160
- # resp.unprocessed_trace_ids[0] #=> String
161
- # resp.next_token #=> String
162
- # @overload batch_get_traces(params = {})
163
- # @param [Hash] params ({})
164
- def batch_get_traces(params = {}, options = {})
165
- req = build_request(:batch_get_traces, params)
166
- req.send_request(options)
167
- end
146
+ # @!group API Operations
168
147
 
169
- # Retrieves a document that describes services that process incoming
170
- # requests, and downstream services that they call as a result. Root
171
- # services process incoming requests and make calls to downstream
172
- # services. Root services are applications that use the AWS X-Ray SDK.
173
- # Downstream services can be other applications, AWS resources, HTTP web
174
- # APIs, or SQL databases.
175
- # @option params [required, Time,DateTime,Date,Integer,String] :start_time
176
- # The start of the time frame for which to generate a graph.
177
- # @option params [required, Time,DateTime,Date,Integer,String] :end_time
178
- # The end of the time frame for which to generate a graph.
179
- # @option params [String] :next_token
180
- # Pagination token. Not used.
181
- # @return [Types::GetServiceGraphResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
182
- #
183
- # * {Types::GetServiceGraphResult#start_time #StartTime} => Time
184
- # * {Types::GetServiceGraphResult#end_time #EndTime} => Time
185
- # * {Types::GetServiceGraphResult#services #Services} => Array&lt;Types::Service&gt;
186
- # * {Types::GetServiceGraphResult#next_token #NextToken} => String
187
- #
188
- # @example Request syntax with placeholder values
189
- # resp = client.get_service_graph({
190
- # start_time: Time.now, # required
191
- # end_time: Time.now, # required
192
- # next_token: "String",
193
- # })
194
- #
195
- # @example Response structure
196
- # resp.start_time #=> Time
197
- # resp.end_time #=> Time
198
- # resp.services #=> Array
199
- # resp.services[0].reference_id #=> Integer
200
- # resp.services[0].name #=> String
201
- # resp.services[0].names #=> Array
202
- # resp.services[0].names[0] #=> String
203
- # resp.services[0].root #=> Boolean
204
- # resp.services[0].account_id #=> String
205
- # resp.services[0].type #=> String
206
- # resp.services[0].state #=> String
207
- # resp.services[0].start_time #=> Time
208
- # resp.services[0].end_time #=> Time
209
- # resp.services[0].edges #=> Array
210
- # resp.services[0].edges[0].reference_id #=> Integer
211
- # resp.services[0].edges[0].start_time #=> Time
212
- # resp.services[0].edges[0].end_time #=> Time
213
- # resp.services[0].edges[0].summary_statistics.ok_count #=> Integer
214
- # resp.services[0].edges[0].summary_statistics.error_statistics.throttle_count #=> Integer
215
- # resp.services[0].edges[0].summary_statistics.error_statistics.other_count #=> Integer
216
- # resp.services[0].edges[0].summary_statistics.error_statistics.total_count #=> Integer
217
- # resp.services[0].edges[0].summary_statistics.fault_statistics.other_count #=> Integer
218
- # resp.services[0].edges[0].summary_statistics.fault_statistics.total_count #=> Integer
219
- # resp.services[0].edges[0].summary_statistics.total_count #=> Integer
220
- # resp.services[0].edges[0].summary_statistics.total_response_time #=> Float
221
- # resp.services[0].edges[0].response_time_histogram #=> Array
222
- # resp.services[0].edges[0].response_time_histogram[0].value #=> Float
223
- # resp.services[0].edges[0].response_time_histogram[0].count #=> Integer
224
- # resp.services[0].edges[0].aliases #=> Array
225
- # resp.services[0].edges[0].aliases[0].name #=> String
226
- # resp.services[0].edges[0].aliases[0].names #=> Array
227
- # resp.services[0].edges[0].aliases[0].names[0] #=> String
228
- # resp.services[0].edges[0].aliases[0].type #=> String
229
- # resp.services[0].summary_statistics.ok_count #=> Integer
230
- # resp.services[0].summary_statistics.error_statistics.throttle_count #=> Integer
231
- # resp.services[0].summary_statistics.error_statistics.other_count #=> Integer
232
- # resp.services[0].summary_statistics.error_statistics.total_count #=> Integer
233
- # resp.services[0].summary_statistics.fault_statistics.other_count #=> Integer
234
- # resp.services[0].summary_statistics.fault_statistics.total_count #=> Integer
235
- # resp.services[0].summary_statistics.total_count #=> Integer
236
- # resp.services[0].summary_statistics.total_response_time #=> Float
237
- # resp.services[0].duration_histogram #=> Array
238
- # resp.services[0].duration_histogram[0].value #=> Float
239
- # resp.services[0].duration_histogram[0].count #=> Integer
240
- # resp.next_token #=> String
241
- # @overload get_service_graph(params = {})
242
- # @param [Hash] params ({})
243
- def get_service_graph(params = {}, options = {})
244
- req = build_request(:get_service_graph, params)
245
- req.send_request(options)
246
- end
148
+ # Retrieves a list of traces specified by ID. Each trace is a collection
149
+ # of segment documents that originates from a single request. Use
150
+ # `GetTraceSummaries` to get a list of trace IDs.
151
+ #
152
+ # @option params [required, Array<String>] :trace_ids
153
+ # Specify the trace IDs of requests for which to retrieve segments.
154
+ #
155
+ # @option params [String] :next_token
156
+ # Pagination token. Not used.
157
+ #
158
+ # @return [Types::BatchGetTracesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
159
+ #
160
+ # * {Types::BatchGetTracesResult#traces #traces} => Array&lt;Types::Trace&gt;
161
+ # * {Types::BatchGetTracesResult#unprocessed_trace_ids #unprocessed_trace_ids} => Array&lt;String&gt;
162
+ # * {Types::BatchGetTracesResult#next_token #next_token} => String
163
+ #
164
+ # @example Request syntax with placeholder values
165
+ #
166
+ # resp = client.batch_get_traces({
167
+ # trace_ids: ["TraceId"], # required
168
+ # next_token: "String",
169
+ # })
170
+ #
171
+ # @example Response structure
172
+ #
173
+ # resp.traces #=> Array
174
+ # resp.traces[0].id #=> String
175
+ # resp.traces[0].duration #=> Float
176
+ # resp.traces[0].segments #=> Array
177
+ # resp.traces[0].segments[0].id #=> String
178
+ # resp.traces[0].segments[0].document #=> String
179
+ # resp.unprocessed_trace_ids #=> Array
180
+ # resp.unprocessed_trace_ids[0] #=> String
181
+ # resp.next_token #=> String
182
+ #
183
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/BatchGetTraces AWS API Documentation
184
+ #
185
+ # @overload batch_get_traces(params = {})
186
+ # @param [Hash] params ({})
187
+ def batch_get_traces(params = {}, options = {})
188
+ req = build_request(:batch_get_traces, params)
189
+ req.send_request(options)
190
+ end
247
191
 
248
- # Retrieves a service graph for one or more specific trace IDs.
249
- # @option params [required, Array<String>] :trace_ids
250
- # Trace IDs of requests for which to generate a service graph.
251
- # @option params [String] :next_token
252
- # Pagination token. Not used.
253
- # @return [Types::GetTraceGraphResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
254
- #
255
- # * {Types::GetTraceGraphResult#services #Services} => Array&lt;Types::Service&gt;
256
- # * {Types::GetTraceGraphResult#next_token #NextToken} => String
257
- #
258
- # @example Request syntax with placeholder values
259
- # resp = client.get_trace_graph({
260
- # trace_ids: ["TraceId"], # required
261
- # next_token: "String",
262
- # })
263
- #
264
- # @example Response structure
265
- # resp.services #=> Array
266
- # resp.services[0].reference_id #=> Integer
267
- # resp.services[0].name #=> String
268
- # resp.services[0].names #=> Array
269
- # resp.services[0].names[0] #=> String
270
- # resp.services[0].root #=> Boolean
271
- # resp.services[0].account_id #=> String
272
- # resp.services[0].type #=> String
273
- # resp.services[0].state #=> String
274
- # resp.services[0].start_time #=> Time
275
- # resp.services[0].end_time #=> Time
276
- # resp.services[0].edges #=> Array
277
- # resp.services[0].edges[0].reference_id #=> Integer
278
- # resp.services[0].edges[0].start_time #=> Time
279
- # resp.services[0].edges[0].end_time #=> Time
280
- # resp.services[0].edges[0].summary_statistics.ok_count #=> Integer
281
- # resp.services[0].edges[0].summary_statistics.error_statistics.throttle_count #=> Integer
282
- # resp.services[0].edges[0].summary_statistics.error_statistics.other_count #=> Integer
283
- # resp.services[0].edges[0].summary_statistics.error_statistics.total_count #=> Integer
284
- # resp.services[0].edges[0].summary_statistics.fault_statistics.other_count #=> Integer
285
- # resp.services[0].edges[0].summary_statistics.fault_statistics.total_count #=> Integer
286
- # resp.services[0].edges[0].summary_statistics.total_count #=> Integer
287
- # resp.services[0].edges[0].summary_statistics.total_response_time #=> Float
288
- # resp.services[0].edges[0].response_time_histogram #=> Array
289
- # resp.services[0].edges[0].response_time_histogram[0].value #=> Float
290
- # resp.services[0].edges[0].response_time_histogram[0].count #=> Integer
291
- # resp.services[0].edges[0].aliases #=> Array
292
- # resp.services[0].edges[0].aliases[0].name #=> String
293
- # resp.services[0].edges[0].aliases[0].names #=> Array
294
- # resp.services[0].edges[0].aliases[0].names[0] #=> String
295
- # resp.services[0].edges[0].aliases[0].type #=> String
296
- # resp.services[0].summary_statistics.ok_count #=> Integer
297
- # resp.services[0].summary_statistics.error_statistics.throttle_count #=> Integer
298
- # resp.services[0].summary_statistics.error_statistics.other_count #=> Integer
299
- # resp.services[0].summary_statistics.error_statistics.total_count #=> Integer
300
- # resp.services[0].summary_statistics.fault_statistics.other_count #=> Integer
301
- # resp.services[0].summary_statistics.fault_statistics.total_count #=> Integer
302
- # resp.services[0].summary_statistics.total_count #=> Integer
303
- # resp.services[0].summary_statistics.total_response_time #=> Float
304
- # resp.services[0].duration_histogram #=> Array
305
- # resp.services[0].duration_histogram[0].value #=> Float
306
- # resp.services[0].duration_histogram[0].count #=> Integer
307
- # resp.next_token #=> String
308
- # @overload get_trace_graph(params = {})
309
- # @param [Hash] params ({})
310
- def get_trace_graph(params = {}, options = {})
311
- req = build_request(:get_trace_graph, params)
312
- req.send_request(options)
313
- end
192
+ # Retrieves a document that describes services that process incoming
193
+ # requests, and downstream services that they call as a result. Root
194
+ # services process incoming requests and make calls to downstream
195
+ # services. Root services are applications that use the AWS X-Ray SDK.
196
+ # Downstream services can be other applications, AWS resources, HTTP web
197
+ # APIs, or SQL databases.
198
+ #
199
+ # @option params [required, Time,DateTime,Date,Integer,String] :start_time
200
+ # The start of the time frame for which to generate a graph.
201
+ #
202
+ # @option params [required, Time,DateTime,Date,Integer,String] :end_time
203
+ # The end of the time frame for which to generate a graph.
204
+ #
205
+ # @option params [String] :next_token
206
+ # Pagination token. Not used.
207
+ #
208
+ # @return [Types::GetServiceGraphResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
209
+ #
210
+ # * {Types::GetServiceGraphResult#start_time #start_time} => Time
211
+ # * {Types::GetServiceGraphResult#end_time #end_time} => Time
212
+ # * {Types::GetServiceGraphResult#services #services} => Array&lt;Types::Service&gt;
213
+ # * {Types::GetServiceGraphResult#next_token #next_token} => String
214
+ #
215
+ # @example Request syntax with placeholder values
216
+ #
217
+ # resp = client.get_service_graph({
218
+ # start_time: Time.now, # required
219
+ # end_time: Time.now, # required
220
+ # next_token: "String",
221
+ # })
222
+ #
223
+ # @example Response structure
224
+ #
225
+ # resp.start_time #=> Time
226
+ # resp.end_time #=> Time
227
+ # resp.services #=> Array
228
+ # resp.services[0].reference_id #=> Integer
229
+ # resp.services[0].name #=> String
230
+ # resp.services[0].names #=> Array
231
+ # resp.services[0].names[0] #=> String
232
+ # resp.services[0].root #=> Boolean
233
+ # resp.services[0].account_id #=> String
234
+ # resp.services[0].type #=> String
235
+ # resp.services[0].state #=> String
236
+ # resp.services[0].start_time #=> Time
237
+ # resp.services[0].end_time #=> Time
238
+ # resp.services[0].edges #=> Array
239
+ # resp.services[0].edges[0].reference_id #=> Integer
240
+ # resp.services[0].edges[0].start_time #=> Time
241
+ # resp.services[0].edges[0].end_time #=> Time
242
+ # resp.services[0].edges[0].summary_statistics.ok_count #=> Integer
243
+ # resp.services[0].edges[0].summary_statistics.error_statistics.throttle_count #=> Integer
244
+ # resp.services[0].edges[0].summary_statistics.error_statistics.other_count #=> Integer
245
+ # resp.services[0].edges[0].summary_statistics.error_statistics.total_count #=> Integer
246
+ # resp.services[0].edges[0].summary_statistics.fault_statistics.other_count #=> Integer
247
+ # resp.services[0].edges[0].summary_statistics.fault_statistics.total_count #=> Integer
248
+ # resp.services[0].edges[0].summary_statistics.total_count #=> Integer
249
+ # resp.services[0].edges[0].summary_statistics.total_response_time #=> Float
250
+ # resp.services[0].edges[0].response_time_histogram #=> Array
251
+ # resp.services[0].edges[0].response_time_histogram[0].value #=> Float
252
+ # resp.services[0].edges[0].response_time_histogram[0].count #=> Integer
253
+ # resp.services[0].edges[0].aliases #=> Array
254
+ # resp.services[0].edges[0].aliases[0].name #=> String
255
+ # resp.services[0].edges[0].aliases[0].names #=> Array
256
+ # resp.services[0].edges[0].aliases[0].names[0] #=> String
257
+ # resp.services[0].edges[0].aliases[0].type #=> String
258
+ # resp.services[0].summary_statistics.ok_count #=> Integer
259
+ # resp.services[0].summary_statistics.error_statistics.throttle_count #=> Integer
260
+ # resp.services[0].summary_statistics.error_statistics.other_count #=> Integer
261
+ # resp.services[0].summary_statistics.error_statistics.total_count #=> Integer
262
+ # resp.services[0].summary_statistics.fault_statistics.other_count #=> Integer
263
+ # resp.services[0].summary_statistics.fault_statistics.total_count #=> Integer
264
+ # resp.services[0].summary_statistics.total_count #=> Integer
265
+ # resp.services[0].summary_statistics.total_response_time #=> Float
266
+ # resp.services[0].duration_histogram #=> Array
267
+ # resp.services[0].duration_histogram[0].value #=> Float
268
+ # resp.services[0].duration_histogram[0].count #=> Integer
269
+ # resp.next_token #=> String
270
+ #
271
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetServiceGraph AWS API Documentation
272
+ #
273
+ # @overload get_service_graph(params = {})
274
+ # @param [Hash] params ({})
275
+ def get_service_graph(params = {}, options = {})
276
+ req = build_request(:get_service_graph, params)
277
+ req.send_request(options)
278
+ end
314
279
 
315
- # Retrieves IDs and metadata for traces available for a specified time
316
- # frame using an optional filter. To get the full traces, pass the trace
317
- # IDs to `BatchGetTraces`.
318
- # @option params [required, Time,DateTime,Date,Integer,String] :start_time
319
- # The start of the time frame for which to retrieve traces.
320
- # @option params [required, Time,DateTime,Date,Integer,String] :end_time
321
- # The end of the time frame for which to retrieve traces.
322
- # @option params [Boolean] :sampling
323
- # Set to `true` to get summaries for only a subset of available traces.
324
- # @option params [String] :filter_expression
325
- # Specify a filter expression to retrieve trace summaries for services
326
- # or requests that meet certain requirements.
327
- # @option params [String] :next_token
328
- # Specify the pagination token returned by a previous request to
329
- # retrieve the next page of results.
330
- # @return [Types::GetTraceSummariesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
331
- #
332
- # * {Types::GetTraceSummariesResult#trace_summaries #TraceSummaries} => Array&lt;Types::TraceSummary&gt;
333
- # * {Types::GetTraceSummariesResult#approximate_time #ApproximateTime} => Time
334
- # * {Types::GetTraceSummariesResult#traces_processed_count #TracesProcessedCount} => Integer
335
- # * {Types::GetTraceSummariesResult#next_token #NextToken} => String
336
- #
337
- # @example Request syntax with placeholder values
338
- # resp = client.get_trace_summaries({
339
- # start_time: Time.now, # required
340
- # end_time: Time.now, # required
341
- # sampling: false,
342
- # filter_expression: "FilterExpression",
343
- # next_token: "String",
344
- # })
345
- #
346
- # @example Response structure
347
- # resp.trace_summaries #=> Array
348
- # resp.trace_summaries[0].id #=> String
349
- # resp.trace_summaries[0].duration #=> Float
350
- # resp.trace_summaries[0].response_time #=> Float
351
- # resp.trace_summaries[0].has_fault #=> Boolean
352
- # resp.trace_summaries[0].has_error #=> Boolean
353
- # resp.trace_summaries[0].has_throttle #=> Boolean
354
- # resp.trace_summaries[0].is_partial #=> Boolean
355
- # resp.trace_summaries[0].http.http_url #=> String
356
- # resp.trace_summaries[0].http.http_status #=> Integer
357
- # resp.trace_summaries[0].http.http_method #=> String
358
- # resp.trace_summaries[0].http.user_agent #=> String
359
- # resp.trace_summaries[0].http.client_ip #=> String
360
- # resp.trace_summaries[0].annotations #=> Hash
361
- # resp.trace_summaries[0].annotations["AnnotationKey"] #=> Array
362
- # resp.trace_summaries[0].annotations["AnnotationKey"][0].annotation_value.number_value #=> Float
363
- # resp.trace_summaries[0].annotations["AnnotationKey"][0].annotation_value.boolean_value #=> Boolean
364
- # resp.trace_summaries[0].annotations["AnnotationKey"][0].annotation_value.string_value #=> String
365
- # resp.trace_summaries[0].annotations["AnnotationKey"][0].service_ids #=> Array
366
- # resp.trace_summaries[0].annotations["AnnotationKey"][0].service_ids[0].name #=> String
367
- # resp.trace_summaries[0].annotations["AnnotationKey"][0].service_ids[0].names #=> Array
368
- # resp.trace_summaries[0].annotations["AnnotationKey"][0].service_ids[0].names[0] #=> String
369
- # resp.trace_summaries[0].annotations["AnnotationKey"][0].service_ids[0].account_id #=> String
370
- # resp.trace_summaries[0].annotations["AnnotationKey"][0].service_ids[0].type #=> String
371
- # resp.trace_summaries[0].users #=> Array
372
- # resp.trace_summaries[0].users[0].user_name #=> String
373
- # resp.trace_summaries[0].users[0].service_ids #=> Array
374
- # resp.trace_summaries[0].users[0].service_ids[0].name #=> String
375
- # resp.trace_summaries[0].users[0].service_ids[0].names #=> Array
376
- # resp.trace_summaries[0].users[0].service_ids[0].names[0] #=> String
377
- # resp.trace_summaries[0].users[0].service_ids[0].account_id #=> String
378
- # resp.trace_summaries[0].users[0].service_ids[0].type #=> String
379
- # resp.trace_summaries[0].service_ids #=> Array
380
- # resp.trace_summaries[0].service_ids[0].name #=> String
381
- # resp.trace_summaries[0].service_ids[0].names #=> Array
382
- # resp.trace_summaries[0].service_ids[0].names[0] #=> String
383
- # resp.trace_summaries[0].service_ids[0].account_id #=> String
384
- # resp.trace_summaries[0].service_ids[0].type #=> String
385
- # resp.approximate_time #=> Time
386
- # resp.traces_processed_count #=> Integer
387
- # resp.next_token #=> String
388
- # @overload get_trace_summaries(params = {})
389
- # @param [Hash] params ({})
390
- def get_trace_summaries(params = {}, options = {})
391
- req = build_request(:get_trace_summaries, params)
392
- req.send_request(options)
393
- end
280
+ # Retrieves a service graph for one or more specific trace IDs.
281
+ #
282
+ # @option params [required, Array<String>] :trace_ids
283
+ # Trace IDs of requests for which to generate a service graph.
284
+ #
285
+ # @option params [String] :next_token
286
+ # Pagination token. Not used.
287
+ #
288
+ # @return [Types::GetTraceGraphResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
289
+ #
290
+ # * {Types::GetTraceGraphResult#services #services} => Array&lt;Types::Service&gt;
291
+ # * {Types::GetTraceGraphResult#next_token #next_token} => String
292
+ #
293
+ # @example Request syntax with placeholder values
294
+ #
295
+ # resp = client.get_trace_graph({
296
+ # trace_ids: ["TraceId"], # required
297
+ # next_token: "String",
298
+ # })
299
+ #
300
+ # @example Response structure
301
+ #
302
+ # resp.services #=> Array
303
+ # resp.services[0].reference_id #=> Integer
304
+ # resp.services[0].name #=> String
305
+ # resp.services[0].names #=> Array
306
+ # resp.services[0].names[0] #=> String
307
+ # resp.services[0].root #=> Boolean
308
+ # resp.services[0].account_id #=> String
309
+ # resp.services[0].type #=> String
310
+ # resp.services[0].state #=> String
311
+ # resp.services[0].start_time #=> Time
312
+ # resp.services[0].end_time #=> Time
313
+ # resp.services[0].edges #=> Array
314
+ # resp.services[0].edges[0].reference_id #=> Integer
315
+ # resp.services[0].edges[0].start_time #=> Time
316
+ # resp.services[0].edges[0].end_time #=> Time
317
+ # resp.services[0].edges[0].summary_statistics.ok_count #=> Integer
318
+ # resp.services[0].edges[0].summary_statistics.error_statistics.throttle_count #=> Integer
319
+ # resp.services[0].edges[0].summary_statistics.error_statistics.other_count #=> Integer
320
+ # resp.services[0].edges[0].summary_statistics.error_statistics.total_count #=> Integer
321
+ # resp.services[0].edges[0].summary_statistics.fault_statistics.other_count #=> Integer
322
+ # resp.services[0].edges[0].summary_statistics.fault_statistics.total_count #=> Integer
323
+ # resp.services[0].edges[0].summary_statistics.total_count #=> Integer
324
+ # resp.services[0].edges[0].summary_statistics.total_response_time #=> Float
325
+ # resp.services[0].edges[0].response_time_histogram #=> Array
326
+ # resp.services[0].edges[0].response_time_histogram[0].value #=> Float
327
+ # resp.services[0].edges[0].response_time_histogram[0].count #=> Integer
328
+ # resp.services[0].edges[0].aliases #=> Array
329
+ # resp.services[0].edges[0].aliases[0].name #=> String
330
+ # resp.services[0].edges[0].aliases[0].names #=> Array
331
+ # resp.services[0].edges[0].aliases[0].names[0] #=> String
332
+ # resp.services[0].edges[0].aliases[0].type #=> String
333
+ # resp.services[0].summary_statistics.ok_count #=> Integer
334
+ # resp.services[0].summary_statistics.error_statistics.throttle_count #=> Integer
335
+ # resp.services[0].summary_statistics.error_statistics.other_count #=> Integer
336
+ # resp.services[0].summary_statistics.error_statistics.total_count #=> Integer
337
+ # resp.services[0].summary_statistics.fault_statistics.other_count #=> Integer
338
+ # resp.services[0].summary_statistics.fault_statistics.total_count #=> Integer
339
+ # resp.services[0].summary_statistics.total_count #=> Integer
340
+ # resp.services[0].summary_statistics.total_response_time #=> Float
341
+ # resp.services[0].duration_histogram #=> Array
342
+ # resp.services[0].duration_histogram[0].value #=> Float
343
+ # resp.services[0].duration_histogram[0].count #=> Integer
344
+ # resp.next_token #=> String
345
+ #
346
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetTraceGraph AWS API Documentation
347
+ #
348
+ # @overload get_trace_graph(params = {})
349
+ # @param [Hash] params ({})
350
+ def get_trace_graph(params = {}, options = {})
351
+ req = build_request(:get_trace_graph, params)
352
+ req.send_request(options)
353
+ end
394
354
 
395
- # Used by the AWS X-Ray daemon to upload telemetry.
396
- # @option params [required, Array<Types::TelemetryRecord>] :telemetry_records
397
- # @option params [String] :ec2_instance_id
398
- # @option params [String] :hostname
399
- # @option params [String] :resource_arn
400
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
401
- #
402
- # @example Request syntax with placeholder values
403
- # resp = client.put_telemetry_records({
404
- # telemetry_records: [ # required
405
- # {
406
- # timestamp: Time.now,
407
- # segments_received_count: 1,
408
- # segments_sent_count: 1,
409
- # segments_spillover_count: 1,
410
- # segments_rejected_count: 1,
411
- # backend_connection_errors: {
412
- # timeout_count: 1,
413
- # connection_refused_count: 1,
414
- # http_code_4_xx_count: 1,
415
- # http_code_5_xx_count: 1,
416
- # unknown_host_count: 1,
417
- # other_count: 1,
418
- # },
419
- # },
420
- # ],
421
- # ec2_instance_id: "String",
422
- # hostname: "String",
423
- # resource_arn: "String",
424
- # })
425
- # @overload put_telemetry_records(params = {})
426
- # @param [Hash] params ({})
427
- def put_telemetry_records(params = {}, options = {})
428
- req = build_request(:put_telemetry_records, params)
429
- req.send_request(options)
430
- end
355
+ # Retrieves IDs and metadata for traces available for a specified time
356
+ # frame using an optional filter. To get the full traces, pass the trace
357
+ # IDs to `BatchGetTraces`.
358
+ #
359
+ # @option params [required, Time,DateTime,Date,Integer,String] :start_time
360
+ # The start of the time frame for which to retrieve traces.
361
+ #
362
+ # @option params [required, Time,DateTime,Date,Integer,String] :end_time
363
+ # The end of the time frame for which to retrieve traces.
364
+ #
365
+ # @option params [Boolean] :sampling
366
+ # Set to `true` to get summaries for only a subset of available traces.
367
+ #
368
+ # @option params [String] :filter_expression
369
+ # Specify a filter expression to retrieve trace summaries for services
370
+ # or requests that meet certain requirements.
371
+ #
372
+ # @option params [String] :next_token
373
+ # Specify the pagination token returned by a previous request to
374
+ # retrieve the next page of results.
375
+ #
376
+ # @return [Types::GetTraceSummariesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
377
+ #
378
+ # * {Types::GetTraceSummariesResult#trace_summaries #trace_summaries} => Array&lt;Types::TraceSummary&gt;
379
+ # * {Types::GetTraceSummariesResult#approximate_time #approximate_time} => Time
380
+ # * {Types::GetTraceSummariesResult#traces_processed_count #traces_processed_count} => Integer
381
+ # * {Types::GetTraceSummariesResult#next_token #next_token} => String
382
+ #
383
+ # @example Request syntax with placeholder values
384
+ #
385
+ # resp = client.get_trace_summaries({
386
+ # start_time: Time.now, # required
387
+ # end_time: Time.now, # required
388
+ # sampling: false,
389
+ # filter_expression: "FilterExpression",
390
+ # next_token: "String",
391
+ # })
392
+ #
393
+ # @example Response structure
394
+ #
395
+ # resp.trace_summaries #=> Array
396
+ # resp.trace_summaries[0].id #=> String
397
+ # resp.trace_summaries[0].duration #=> Float
398
+ # resp.trace_summaries[0].response_time #=> Float
399
+ # resp.trace_summaries[0].has_fault #=> Boolean
400
+ # resp.trace_summaries[0].has_error #=> Boolean
401
+ # resp.trace_summaries[0].has_throttle #=> Boolean
402
+ # resp.trace_summaries[0].is_partial #=> Boolean
403
+ # resp.trace_summaries[0].http.http_url #=> String
404
+ # resp.trace_summaries[0].http.http_status #=> Integer
405
+ # resp.trace_summaries[0].http.http_method #=> String
406
+ # resp.trace_summaries[0].http.user_agent #=> String
407
+ # resp.trace_summaries[0].http.client_ip #=> String
408
+ # resp.trace_summaries[0].annotations #=> Hash
409
+ # resp.trace_summaries[0].annotations["AnnotationKey"] #=> Array
410
+ # resp.trace_summaries[0].annotations["AnnotationKey"][0].annotation_value.number_value #=> Float
411
+ # resp.trace_summaries[0].annotations["AnnotationKey"][0].annotation_value.boolean_value #=> Boolean
412
+ # resp.trace_summaries[0].annotations["AnnotationKey"][0].annotation_value.string_value #=> String
413
+ # resp.trace_summaries[0].annotations["AnnotationKey"][0].service_ids #=> Array
414
+ # resp.trace_summaries[0].annotations["AnnotationKey"][0].service_ids[0].name #=> String
415
+ # resp.trace_summaries[0].annotations["AnnotationKey"][0].service_ids[0].names #=> Array
416
+ # resp.trace_summaries[0].annotations["AnnotationKey"][0].service_ids[0].names[0] #=> String
417
+ # resp.trace_summaries[0].annotations["AnnotationKey"][0].service_ids[0].account_id #=> String
418
+ # resp.trace_summaries[0].annotations["AnnotationKey"][0].service_ids[0].type #=> String
419
+ # resp.trace_summaries[0].users #=> Array
420
+ # resp.trace_summaries[0].users[0].user_name #=> String
421
+ # resp.trace_summaries[0].users[0].service_ids #=> Array
422
+ # resp.trace_summaries[0].users[0].service_ids[0].name #=> String
423
+ # resp.trace_summaries[0].users[0].service_ids[0].names #=> Array
424
+ # resp.trace_summaries[0].users[0].service_ids[0].names[0] #=> String
425
+ # resp.trace_summaries[0].users[0].service_ids[0].account_id #=> String
426
+ # resp.trace_summaries[0].users[0].service_ids[0].type #=> String
427
+ # resp.trace_summaries[0].service_ids #=> Array
428
+ # resp.trace_summaries[0].service_ids[0].name #=> String
429
+ # resp.trace_summaries[0].service_ids[0].names #=> Array
430
+ # resp.trace_summaries[0].service_ids[0].names[0] #=> String
431
+ # resp.trace_summaries[0].service_ids[0].account_id #=> String
432
+ # resp.trace_summaries[0].service_ids[0].type #=> String
433
+ # resp.approximate_time #=> Time
434
+ # resp.traces_processed_count #=> Integer
435
+ # resp.next_token #=> String
436
+ #
437
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetTraceSummaries AWS API Documentation
438
+ #
439
+ # @overload get_trace_summaries(params = {})
440
+ # @param [Hash] params ({})
441
+ def get_trace_summaries(params = {}, options = {})
442
+ req = build_request(:get_trace_summaries, params)
443
+ req.send_request(options)
444
+ end
431
445
 
432
- # Uploads segment documents to AWS X-Ray. The X-Ray SDK generates
433
- # segment documents and sends them to the X-Ray daemon, which uploads
434
- # them in batches. A segment document can be a completed segment, an
435
- # in-progress segment, or an array of subsegments.
436
- # @option params [required, Array<String>] :trace_segment_documents
437
- # A JSON document defining one or more segments or subsegments. Segments
438
- # must include the following fields.
439
- #
440
- # **Required Segment Document Fields**
441
- #
442
- # * `name` - The name of the service that handled the request.
443
- #
444
- # * `id` - A 64-bit identifier for the segment, unique among segments in
445
- # the same trace, in 16 hexadecimal digits.
446
- #
447
- # * `trace_id` - A unique identifier that connects all segments and
448
- # subsegments originating from a single client request.
449
- #
450
- # * `start_time` - Time the segment or subsegment was created, in
451
- # floating point seconds in epoch time, accurate to milliseconds. For
452
- # example, `1480615200.010` or `1.480615200010E9`.
453
- #
454
- # * `end_time` - Time the segment or subsegment was closed. For example,
455
- # `1480615200.090` or `1.480615200090E9`. Specify either an `end_time`
456
- # or `in_progress`.
457
- #
458
- # * `in_progress` - Set to `true` instead of specifying an `end_time` to
459
- # record that a segment has been started, but is not complete. Send an
460
- # in progress segment when your application receives a request that
461
- # will take a long time to serve, to trace the fact that the request
462
- # was received. When the response is sent, send the complete segment
463
- # to overwrite the in-progress segment.
464
- #
465
- # A `trace_id` consists of three numbers separated by hyphens. For
466
- # example, 1-58406520-a006649127e371903a2de979. This includes:
467
- #
468
- # **Trace ID Format**
469
- #
470
- # * The version number, i.e. `1`.
471
- #
472
- # * The time of the original request, in Unix epoch time, in 8
473
- # hexadecimal digits. For example, 10:00AM December 2nd, 2016 PST in
474
- # epoch time is `1480615200` seconds, or `58406520` in hexadecimal.
475
- #
476
- # * A 96-bit identifier for the trace, globally unique, in 24
477
- # hexadecimal digits.
478
- # @return [Types::PutTraceSegmentsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
479
- #
480
- # * {Types::PutTraceSegmentsResult#unprocessed_trace_segments #UnprocessedTraceSegments} => Array&lt;Types::UnprocessedTraceSegment&gt;
481
- #
482
- # @example Request syntax with placeholder values
483
- # resp = client.put_trace_segments({
484
- # trace_segment_documents: ["TraceSegmentDocument"], # required
485
- # })
486
- #
487
- # @example Response structure
488
- # resp.unprocessed_trace_segments #=> Array
489
- # resp.unprocessed_trace_segments[0].id #=> String
490
- # resp.unprocessed_trace_segments[0].error_code #=> String
491
- # resp.unprocessed_trace_segments[0].message #=> String
492
- # @overload put_trace_segments(params = {})
493
- # @param [Hash] params ({})
494
- def put_trace_segments(params = {}, options = {})
495
- req = build_request(:put_trace_segments, params)
496
- req.send_request(options)
497
- end
446
+ # Used by the AWS X-Ray daemon to upload telemetry.
447
+ #
448
+ # @option params [required, Array<Types::TelemetryRecord>] :telemetry_records
449
+ #
450
+ # @option params [String] :ec2_instance_id
451
+ #
452
+ # @option params [String] :hostname
453
+ #
454
+ # @option params [String] :resource_arn
455
+ #
456
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
457
+ #
458
+ # @example Request syntax with placeholder values
459
+ #
460
+ # resp = client.put_telemetry_records({
461
+ # telemetry_records: [ # required
462
+ # {
463
+ # timestamp: Time.now,
464
+ # segments_received_count: 1,
465
+ # segments_sent_count: 1,
466
+ # segments_spillover_count: 1,
467
+ # segments_rejected_count: 1,
468
+ # backend_connection_errors: {
469
+ # timeout_count: 1,
470
+ # connection_refused_count: 1,
471
+ # http_code_4_xx_count: 1,
472
+ # http_code_5_xx_count: 1,
473
+ # unknown_host_count: 1,
474
+ # other_count: 1,
475
+ # },
476
+ # },
477
+ # ],
478
+ # ec2_instance_id: "String",
479
+ # hostname: "String",
480
+ # resource_arn: "String",
481
+ # })
482
+ #
483
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/PutTelemetryRecords AWS API Documentation
484
+ #
485
+ # @overload put_telemetry_records(params = {})
486
+ # @param [Hash] params ({})
487
+ def put_telemetry_records(params = {}, options = {})
488
+ req = build_request(:put_telemetry_records, params)
489
+ req.send_request(options)
490
+ end
498
491
 
499
- # @!endgroup
492
+ # Uploads segment documents to AWS X-Ray. The X-Ray SDK generates
493
+ # segment documents and sends them to the X-Ray daemon, which uploads
494
+ # them in batches. A segment document can be a completed segment, an
495
+ # in-progress segment, or an array of subsegments.
496
+ #
497
+ # @option params [required, Array<String>] :trace_segment_documents
498
+ # A JSON document defining one or more segments or subsegments. Segments
499
+ # must include the following fields.
500
+ #
501
+ # **Required Segment Document Fields**
502
+ #
503
+ # * `name` - The name of the service that handled the request.
504
+ #
505
+ # * `id` - A 64-bit identifier for the segment, unique among segments in
506
+ # the same trace, in 16 hexadecimal digits.
507
+ #
508
+ # * `trace_id` - A unique identifier that connects all segments and
509
+ # subsegments originating from a single client request.
510
+ #
511
+ # * `start_time` - Time the segment or subsegment was created, in
512
+ # floating point seconds in epoch time, accurate to milliseconds. For
513
+ # example, `1480615200.010` or `1.480615200010E9`.
514
+ #
515
+ # * `end_time` - Time the segment or subsegment was closed. For example,
516
+ # `1480615200.090` or `1.480615200090E9`. Specify either an `end_time`
517
+ # or `in_progress`.
518
+ #
519
+ # * `in_progress` - Set to `true` instead of specifying an `end_time` to
520
+ # record that a segment has been started, but is not complete. Send an
521
+ # in progress segment when your application receives a request that
522
+ # will take a long time to serve, to trace the fact that the request
523
+ # was received. When the response is sent, send the complete segment
524
+ # to overwrite the in-progress segment.
525
+ #
526
+ # A `trace_id` consists of three numbers separated by hyphens. For
527
+ # example, 1-58406520-a006649127e371903a2de979. This includes:
528
+ #
529
+ # **Trace ID Format**
530
+ #
531
+ # * The version number, i.e. `1`.
532
+ #
533
+ # * The time of the original request, in Unix epoch time, in 8
534
+ # hexadecimal digits. For example, 10:00AM December 2nd, 2016 PST in
535
+ # epoch time is `1480615200` seconds, or `58406520` in hexadecimal.
536
+ #
537
+ # * A 96-bit identifier for the trace, globally unique, in 24
538
+ # hexadecimal digits.
539
+ #
540
+ # @return [Types::PutTraceSegmentsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
541
+ #
542
+ # * {Types::PutTraceSegmentsResult#unprocessed_trace_segments #unprocessed_trace_segments} => Array&lt;Types::UnprocessedTraceSegment&gt;
543
+ #
544
+ # @example Request syntax with placeholder values
545
+ #
546
+ # resp = client.put_trace_segments({
547
+ # trace_segment_documents: ["TraceSegmentDocument"], # required
548
+ # })
549
+ #
550
+ # @example Response structure
551
+ #
552
+ # resp.unprocessed_trace_segments #=> Array
553
+ # resp.unprocessed_trace_segments[0].id #=> String
554
+ # resp.unprocessed_trace_segments[0].error_code #=> String
555
+ # resp.unprocessed_trace_segments[0].message #=> String
556
+ #
557
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/PutTraceSegments AWS API Documentation
558
+ #
559
+ # @overload put_trace_segments(params = {})
560
+ # @param [Hash] params ({})
561
+ def put_trace_segments(params = {}, options = {})
562
+ req = build_request(:put_trace_segments, params)
563
+ req.send_request(options)
564
+ end
500
565
 
501
- # @param params ({})
502
- # @api private
503
- def build_request(operation_name, params = {})
504
- handlers = @handlers.for(operation_name)
505
- context = Seahorse::Client::RequestContext.new(
506
- operation_name: operation_name,
507
- operation: config.api.operation(operation_name),
508
- client: self,
509
- params: params,
510
- config: config)
511
- context[:gem_name] = 'aws-sdk-xray'
512
- context[:gem_version] = '1.0.0.rc2'
513
- Seahorse::Client::Request.new(handlers, context)
514
- end
566
+ # @!endgroup
515
567
 
516
- # @api private
517
- # @deprecated
518
- def waiter_names
519
- []
520
- end
568
+ # @param params ({})
569
+ # @api private
570
+ def build_request(operation_name, params = {})
571
+ handlers = @handlers.for(operation_name)
572
+ context = Seahorse::Client::RequestContext.new(
573
+ operation_name: operation_name,
574
+ operation: config.api.operation(operation_name),
575
+ client: self,
576
+ params: params,
577
+ config: config)
578
+ context[:gem_name] = 'aws-sdk-xray'
579
+ context[:gem_version] = '1.0.0.rc3'
580
+ Seahorse::Client::Request.new(handlers, context)
581
+ end
521
582
 
522
- class << self
583
+ # @api private
584
+ # @deprecated
585
+ def waiter_names
586
+ []
587
+ end
523
588
 
524
- # @api private
525
- attr_reader :identifier
589
+ class << self
526
590
 
527
- # @api private
528
- def errors_module
529
- Errors
530
- end
591
+ # @api private
592
+ attr_reader :identifier
531
593
 
594
+ # @api private
595
+ def errors_module
596
+ Errors
532
597
  end
598
+
533
599
  end
534
600
  end
535
601
  end