aws-sdk-xray 1.4.0 → 1.62.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 +5 -5
- data/CHANGELOG.md +380 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-xray/client.rb +1348 -114
- data/lib/aws-sdk-xray/client_api.rb +730 -1
- data/lib/aws-sdk-xray/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-xray/endpoint_provider.rb +54 -0
- data/lib/aws-sdk-xray/endpoints.rb +436 -0
- data/lib/aws-sdk-xray/errors.rb +195 -1
- data/lib/aws-sdk-xray/plugins/endpoints.rb +129 -0
- data/lib/aws-sdk-xray/resource.rb +4 -1
- data/lib/aws-sdk-xray/types.rb +2121 -419
- data/lib/aws-sdk-xray.rb +16 -6
- metadata +23 -11
data/lib/aws-sdk-xray/types.rb
CHANGED
@@ -1,7 +1,9 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
4
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
5
7
|
#
|
6
8
|
# WARNING ABOUT GENERATED CODE
|
7
9
|
|
@@ -28,11 +30,12 @@ module Aws::XRay
|
|
28
30
|
:name,
|
29
31
|
:names,
|
30
32
|
:type)
|
33
|
+
SENSITIVE = []
|
31
34
|
include Aws::Structure
|
32
35
|
end
|
33
36
|
|
34
37
|
# Value of a segment annotation. Has one of three value types: Number,
|
35
|
-
# Boolean or String.
|
38
|
+
# Boolean, or String.
|
36
39
|
#
|
37
40
|
# @!attribute [rw] number_value
|
38
41
|
# Value for a Number annotation.
|
@@ -52,21 +55,38 @@ module Aws::XRay
|
|
52
55
|
:number_value,
|
53
56
|
:boolean_value,
|
54
57
|
:string_value)
|
58
|
+
SENSITIVE = []
|
59
|
+
include Aws::Structure
|
60
|
+
end
|
61
|
+
|
62
|
+
# The service within the service graph that has anomalously high fault
|
63
|
+
# rates.
|
64
|
+
#
|
65
|
+
# @!attribute [rw] service_id
|
66
|
+
# @return [Types::ServiceId]
|
67
|
+
#
|
68
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/AnomalousService AWS API Documentation
|
69
|
+
#
|
70
|
+
class AnomalousService < Struct.new(
|
71
|
+
:service_id)
|
72
|
+
SENSITIVE = []
|
55
73
|
include Aws::Structure
|
56
74
|
end
|
57
75
|
|
58
|
-
#
|
59
|
-
#
|
76
|
+
# A list of Availability Zones corresponding to the segments in a trace.
|
77
|
+
#
|
78
|
+
# @!attribute [rw] name
|
79
|
+
# The name of a corresponding Availability Zone.
|
80
|
+
# @return [String]
|
60
81
|
#
|
61
|
-
#
|
62
|
-
# timeout_count: 1,
|
63
|
-
# connection_refused_count: 1,
|
64
|
-
# http_code_4_xx_count: 1,
|
65
|
-
# http_code_5_xx_count: 1,
|
66
|
-
# unknown_host_count: 1,
|
67
|
-
# other_count: 1,
|
68
|
-
# }
|
82
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/AvailabilityZoneDetail AWS API Documentation
|
69
83
|
#
|
84
|
+
class AvailabilityZoneDetail < Struct.new(
|
85
|
+
:name)
|
86
|
+
SENSITIVE = []
|
87
|
+
include Aws::Structure
|
88
|
+
end
|
89
|
+
|
70
90
|
# @!attribute [rw] timeout_count
|
71
91
|
# @return [Integer]
|
72
92
|
#
|
@@ -94,23 +114,16 @@ module Aws::XRay
|
|
94
114
|
:http_code_5_xx_count,
|
95
115
|
:unknown_host_count,
|
96
116
|
:other_count)
|
117
|
+
SENSITIVE = []
|
97
118
|
include Aws::Structure
|
98
119
|
end
|
99
120
|
|
100
|
-
# @note When making an API call, you may pass BatchGetTracesRequest
|
101
|
-
# data as a hash:
|
102
|
-
#
|
103
|
-
# {
|
104
|
-
# trace_ids: ["TraceId"], # required
|
105
|
-
# next_token: "String",
|
106
|
-
# }
|
107
|
-
#
|
108
121
|
# @!attribute [rw] trace_ids
|
109
122
|
# Specify the trace IDs of requests for which to retrieve segments.
|
110
123
|
# @return [Array<String>]
|
111
124
|
#
|
112
125
|
# @!attribute [rw] next_token
|
113
|
-
# Pagination token.
|
126
|
+
# Pagination token.
|
114
127
|
# @return [String]
|
115
128
|
#
|
116
129
|
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/BatchGetTracesRequest AWS API Documentation
|
@@ -118,6 +131,7 @@ module Aws::XRay
|
|
118
131
|
class BatchGetTracesRequest < Struct.new(
|
119
132
|
:trace_ids,
|
120
133
|
:next_token)
|
134
|
+
SENSITIVE = []
|
121
135
|
include Aws::Structure
|
122
136
|
end
|
123
137
|
|
@@ -130,7 +144,7 @@ module Aws::XRay
|
|
130
144
|
# @return [Array<String>]
|
131
145
|
#
|
132
146
|
# @!attribute [rw] next_token
|
133
|
-
# Pagination token.
|
147
|
+
# Pagination token.
|
134
148
|
# @return [String]
|
135
149
|
#
|
136
150
|
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/BatchGetTracesResult AWS API Documentation
|
@@ -139,40 +153,120 @@ module Aws::XRay
|
|
139
153
|
:traces,
|
140
154
|
:unprocessed_trace_ids,
|
141
155
|
:next_token)
|
156
|
+
SENSITIVE = []
|
142
157
|
include Aws::Structure
|
143
158
|
end
|
144
159
|
|
145
|
-
#
|
146
|
-
#
|
147
|
-
#
|
148
|
-
#
|
149
|
-
#
|
150
|
-
#
|
151
|
-
#
|
152
|
-
#
|
153
|
-
#
|
154
|
-
#
|
155
|
-
#
|
156
|
-
#
|
157
|
-
#
|
158
|
-
#
|
159
|
-
#
|
160
|
-
#
|
161
|
-
#
|
162
|
-
#
|
163
|
-
#
|
164
|
-
#
|
165
|
-
#
|
166
|
-
#
|
160
|
+
# @!attribute [rw] group_name
|
161
|
+
# The case-sensitive name of the new group. Default is a reserved name
|
162
|
+
# and names must be unique.
|
163
|
+
# @return [String]
|
164
|
+
#
|
165
|
+
# @!attribute [rw] filter_expression
|
166
|
+
# The filter expression defining criteria by which to group traces.
|
167
|
+
# @return [String]
|
168
|
+
#
|
169
|
+
# @!attribute [rw] insights_configuration
|
170
|
+
# The structure containing configurations related to insights.
|
171
|
+
#
|
172
|
+
# * The InsightsEnabled boolean can be set to true to enable insights
|
173
|
+
# for the new group or false to disable insights for the new group.
|
174
|
+
#
|
175
|
+
# * The NotificationsEnabled boolean can be set to true to enable
|
176
|
+
# insights notifications for the new group. Notifications may only
|
177
|
+
# be enabled on a group with InsightsEnabled set to true.
|
178
|
+
# @return [Types::InsightsConfiguration]
|
179
|
+
#
|
180
|
+
# @!attribute [rw] tags
|
181
|
+
# A map that contains one or more tag keys and tag values to attach to
|
182
|
+
# an X-Ray group. For more information about ways to use tags, see
|
183
|
+
# [Tagging Amazon Web Services resources][1] in the *Amazon Web
|
184
|
+
# Services General Reference*.
|
185
|
+
#
|
186
|
+
# The following restrictions apply to tags:
|
187
|
+
#
|
188
|
+
# * Maximum number of user-applied tags per resource: 50
|
189
|
+
#
|
190
|
+
# * Maximum tag key length: 128 Unicode characters
|
191
|
+
#
|
192
|
+
# * Maximum tag value length: 256 Unicode characters
|
193
|
+
#
|
194
|
+
# * Valid values for key and value: a-z, A-Z, 0-9, space, and the
|
195
|
+
# following characters: \_ . : / = + - and @
|
196
|
+
#
|
197
|
+
# * Tag keys and values are case sensitive.
|
198
|
+
#
|
199
|
+
# * Don't use `aws:` as a prefix for keys; it's reserved for Amazon
|
200
|
+
# Web Services use.
|
201
|
+
#
|
202
|
+
#
|
167
203
|
#
|
204
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
205
|
+
# @return [Array<Types::Tag>]
|
206
|
+
#
|
207
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/CreateGroupRequest AWS API Documentation
|
208
|
+
#
|
209
|
+
class CreateGroupRequest < Struct.new(
|
210
|
+
:group_name,
|
211
|
+
:filter_expression,
|
212
|
+
:insights_configuration,
|
213
|
+
:tags)
|
214
|
+
SENSITIVE = []
|
215
|
+
include Aws::Structure
|
216
|
+
end
|
217
|
+
|
218
|
+
# @!attribute [rw] group
|
219
|
+
# The group that was created. Contains the name of the group that was
|
220
|
+
# created, the Amazon Resource Name (ARN) of the group that was
|
221
|
+
# generated based on the group name, the filter expression, and the
|
222
|
+
# insight configuration that was assigned to the group.
|
223
|
+
# @return [Types::Group]
|
224
|
+
#
|
225
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/CreateGroupResult AWS API Documentation
|
226
|
+
#
|
227
|
+
class CreateGroupResult < Struct.new(
|
228
|
+
:group)
|
229
|
+
SENSITIVE = []
|
230
|
+
include Aws::Structure
|
231
|
+
end
|
232
|
+
|
168
233
|
# @!attribute [rw] sampling_rule
|
169
234
|
# The rule definition.
|
170
235
|
# @return [Types::SamplingRule]
|
171
236
|
#
|
237
|
+
# @!attribute [rw] tags
|
238
|
+
# A map that contains one or more tag keys and tag values to attach to
|
239
|
+
# an X-Ray sampling rule. For more information about ways to use tags,
|
240
|
+
# see [Tagging Amazon Web Services resources][1] in the *Amazon Web
|
241
|
+
# Services General Reference*.
|
242
|
+
#
|
243
|
+
# The following restrictions apply to tags:
|
244
|
+
#
|
245
|
+
# * Maximum number of user-applied tags per resource: 50
|
246
|
+
#
|
247
|
+
# * Maximum tag key length: 128 Unicode characters
|
248
|
+
#
|
249
|
+
# * Maximum tag value length: 256 Unicode characters
|
250
|
+
#
|
251
|
+
# * Valid values for key and value: a-z, A-Z, 0-9, space, and the
|
252
|
+
# following characters: \_ . : / = + - and @
|
253
|
+
#
|
254
|
+
# * Tag keys and values are case sensitive.
|
255
|
+
#
|
256
|
+
# * Don't use `aws:` as a prefix for keys; it's reserved for Amazon
|
257
|
+
# Web Services use.
|
258
|
+
#
|
259
|
+
#
|
260
|
+
#
|
261
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
262
|
+
# @return [Array<Types::Tag>]
|
263
|
+
#
|
172
264
|
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/CreateSamplingRuleRequest AWS API Documentation
|
173
265
|
#
|
174
266
|
class CreateSamplingRuleRequest < Struct.new(
|
175
|
-
:sampling_rule
|
267
|
+
:sampling_rule,
|
268
|
+
:tags)
|
269
|
+
SENSITIVE = []
|
176
270
|
include Aws::Structure
|
177
271
|
end
|
178
272
|
|
@@ -184,17 +278,55 @@ module Aws::XRay
|
|
184
278
|
#
|
185
279
|
class CreateSamplingRuleResult < Struct.new(
|
186
280
|
:sampling_rule_record)
|
281
|
+
SENSITIVE = []
|
282
|
+
include Aws::Structure
|
283
|
+
end
|
284
|
+
|
285
|
+
# @!attribute [rw] group_name
|
286
|
+
# The case-sensitive name of the group.
|
287
|
+
# @return [String]
|
288
|
+
#
|
289
|
+
# @!attribute [rw] group_arn
|
290
|
+
# The ARN of the group that was generated on creation.
|
291
|
+
# @return [String]
|
292
|
+
#
|
293
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/DeleteGroupRequest AWS API Documentation
|
294
|
+
#
|
295
|
+
class DeleteGroupRequest < Struct.new(
|
296
|
+
:group_name,
|
297
|
+
:group_arn)
|
298
|
+
SENSITIVE = []
|
187
299
|
include Aws::Structure
|
188
300
|
end
|
189
301
|
|
190
|
-
# @
|
191
|
-
#
|
302
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/DeleteGroupResult AWS API Documentation
|
303
|
+
#
|
304
|
+
class DeleteGroupResult < Aws::EmptyStructure; end
|
305
|
+
|
306
|
+
# @!attribute [rw] policy_name
|
307
|
+
# The name of the resource policy to delete.
|
308
|
+
# @return [String]
|
192
309
|
#
|
193
|
-
#
|
194
|
-
#
|
195
|
-
#
|
196
|
-
#
|
310
|
+
# @!attribute [rw] policy_revision_id
|
311
|
+
# Specifies a specific policy revision to delete. Provide a
|
312
|
+
# `PolicyRevisionId` to ensure an atomic delete operation. If the
|
313
|
+
# provided revision id does not match the latest policy revision id,
|
314
|
+
# an `InvalidPolicyRevisionIdException` exception is returned.
|
315
|
+
# @return [String]
|
316
|
+
#
|
317
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/DeleteResourcePolicyRequest AWS API Documentation
|
318
|
+
#
|
319
|
+
class DeleteResourcePolicyRequest < Struct.new(
|
320
|
+
:policy_name,
|
321
|
+
:policy_revision_id)
|
322
|
+
SENSITIVE = []
|
323
|
+
include Aws::Structure
|
324
|
+
end
|
325
|
+
|
326
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/DeleteResourcePolicyResult AWS API Documentation
|
197
327
|
#
|
328
|
+
class DeleteResourcePolicyResult < Aws::EmptyStructure; end
|
329
|
+
|
198
330
|
# @!attribute [rw] rule_name
|
199
331
|
# The name of the sampling rule. Specify a rule by either name or ARN,
|
200
332
|
# but not both.
|
@@ -210,6 +342,7 @@ module Aws::XRay
|
|
210
342
|
class DeleteSamplingRuleRequest < Struct.new(
|
211
343
|
:rule_name,
|
212
344
|
:rule_arn)
|
345
|
+
SENSITIVE = []
|
213
346
|
include Aws::Structure
|
214
347
|
end
|
215
348
|
|
@@ -221,10 +354,14 @@ module Aws::XRay
|
|
221
354
|
#
|
222
355
|
class DeleteSamplingRuleResult < Struct.new(
|
223
356
|
:sampling_rule_record)
|
357
|
+
SENSITIVE = []
|
224
358
|
include Aws::Structure
|
225
359
|
end
|
226
360
|
|
227
|
-
# Information about a connection between two services.
|
361
|
+
# Information about a connection between two services. An edge can be a
|
362
|
+
# synchronous connection, such as typical call between client and
|
363
|
+
# service, or an asynchronous link, such as a Lambda function which
|
364
|
+
# retrieves an event from an SNS queue.
|
228
365
|
#
|
229
366
|
# @!attribute [rw] reference_id
|
230
367
|
# Identifier of the edge. Unique within a service map.
|
@@ -244,13 +381,23 @@ module Aws::XRay
|
|
244
381
|
#
|
245
382
|
# @!attribute [rw] response_time_histogram
|
246
383
|
# A histogram that maps the spread of client response times on an
|
247
|
-
# edge.
|
384
|
+
# edge. Only populated for synchronous edges.
|
248
385
|
# @return [Array<Types::HistogramEntry>]
|
249
386
|
#
|
250
387
|
# @!attribute [rw] aliases
|
251
388
|
# Aliases for the edge.
|
252
389
|
# @return [Array<Types::Alias>]
|
253
390
|
#
|
391
|
+
# @!attribute [rw] edge_type
|
392
|
+
# Describes an asynchronous connection, with a value of `link`.
|
393
|
+
# @return [String]
|
394
|
+
#
|
395
|
+
# @!attribute [rw] received_event_age_histogram
|
396
|
+
# A histogram that maps the spread of event age when received by
|
397
|
+
# consumers. Age is calculated each time an event is received. Only
|
398
|
+
# populated when *EdgeType* is `link`.
|
399
|
+
# @return [Array<Types::HistogramEntry>]
|
400
|
+
#
|
254
401
|
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/Edge AWS API Documentation
|
255
402
|
#
|
256
403
|
class Edge < Struct.new(
|
@@ -259,7 +406,10 @@ module Aws::XRay
|
|
259
406
|
:end_time,
|
260
407
|
:summary_statistics,
|
261
408
|
:response_time_histogram,
|
262
|
-
:aliases
|
409
|
+
:aliases,
|
410
|
+
:edge_type,
|
411
|
+
:received_event_age_histogram)
|
412
|
+
SENSITIVE = []
|
263
413
|
include Aws::Structure
|
264
414
|
end
|
265
415
|
|
@@ -296,6 +446,7 @@ module Aws::XRay
|
|
296
446
|
:fault_statistics,
|
297
447
|
:total_count,
|
298
448
|
:total_response_time)
|
449
|
+
SENSITIVE = []
|
299
450
|
include Aws::Structure
|
300
451
|
end
|
301
452
|
|
@@ -303,8 +454,7 @@ module Aws::XRay
|
|
303
454
|
# settings.
|
304
455
|
#
|
305
456
|
# @!attribute [rw] key_id
|
306
|
-
# The ID of the
|
307
|
-
# applicable.
|
457
|
+
# The ID of the KMS key used for encryption, if applicable.
|
308
458
|
# @return [String]
|
309
459
|
#
|
310
460
|
# @!attribute [rw] status
|
@@ -313,8 +463,8 @@ module Aws::XRay
|
|
313
463
|
# @return [String]
|
314
464
|
#
|
315
465
|
# @!attribute [rw] type
|
316
|
-
# The type of encryption. Set to `KMS` for encryption with
|
317
|
-
# to `NONE` for default encryption.
|
466
|
+
# The type of encryption. Set to `KMS` for encryption with KMS keys.
|
467
|
+
# Set to `NONE` for default encryption.
|
318
468
|
# @return [String]
|
319
469
|
#
|
320
470
|
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/EncryptionConfig AWS API Documentation
|
@@ -323,6 +473,93 @@ module Aws::XRay
|
|
323
473
|
:key_id,
|
324
474
|
:status,
|
325
475
|
:type)
|
476
|
+
SENSITIVE = []
|
477
|
+
include Aws::Structure
|
478
|
+
end
|
479
|
+
|
480
|
+
# The root cause of a trace summary error.
|
481
|
+
#
|
482
|
+
# @!attribute [rw] services
|
483
|
+
# A list of services corresponding to an error. A service identifies a
|
484
|
+
# segment and it contains a name, account ID, type, and inferred flag.
|
485
|
+
# @return [Array<Types::ErrorRootCauseService>]
|
486
|
+
#
|
487
|
+
# @!attribute [rw] client_impacting
|
488
|
+
# A flag that denotes that the root cause impacts the trace client.
|
489
|
+
# @return [Boolean]
|
490
|
+
#
|
491
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/ErrorRootCause AWS API Documentation
|
492
|
+
#
|
493
|
+
class ErrorRootCause < Struct.new(
|
494
|
+
:services,
|
495
|
+
:client_impacting)
|
496
|
+
SENSITIVE = []
|
497
|
+
include Aws::Structure
|
498
|
+
end
|
499
|
+
|
500
|
+
# A collection of segments and corresponding subsegments associated to a
|
501
|
+
# trace summary error.
|
502
|
+
#
|
503
|
+
# @!attribute [rw] name
|
504
|
+
# The name of the entity.
|
505
|
+
# @return [String]
|
506
|
+
#
|
507
|
+
# @!attribute [rw] exceptions
|
508
|
+
# The types and messages of the exceptions.
|
509
|
+
# @return [Array<Types::RootCauseException>]
|
510
|
+
#
|
511
|
+
# @!attribute [rw] remote
|
512
|
+
# A flag that denotes a remote subsegment.
|
513
|
+
# @return [Boolean]
|
514
|
+
#
|
515
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/ErrorRootCauseEntity AWS API Documentation
|
516
|
+
#
|
517
|
+
class ErrorRootCauseEntity < Struct.new(
|
518
|
+
:name,
|
519
|
+
:exceptions,
|
520
|
+
:remote)
|
521
|
+
SENSITIVE = []
|
522
|
+
include Aws::Structure
|
523
|
+
end
|
524
|
+
|
525
|
+
# A collection of fields identifying the services in a trace summary
|
526
|
+
# error.
|
527
|
+
#
|
528
|
+
# @!attribute [rw] name
|
529
|
+
# The service name.
|
530
|
+
# @return [String]
|
531
|
+
#
|
532
|
+
# @!attribute [rw] names
|
533
|
+
# A collection of associated service names.
|
534
|
+
# @return [Array<String>]
|
535
|
+
#
|
536
|
+
# @!attribute [rw] type
|
537
|
+
# The type associated to the service.
|
538
|
+
# @return [String]
|
539
|
+
#
|
540
|
+
# @!attribute [rw] account_id
|
541
|
+
# The account ID associated to the service.
|
542
|
+
# @return [String]
|
543
|
+
#
|
544
|
+
# @!attribute [rw] entity_path
|
545
|
+
# The path of root cause entities found on the service.
|
546
|
+
# @return [Array<Types::ErrorRootCauseEntity>]
|
547
|
+
#
|
548
|
+
# @!attribute [rw] inferred
|
549
|
+
# A Boolean value indicating if the service is inferred from the
|
550
|
+
# trace.
|
551
|
+
# @return [Boolean]
|
552
|
+
#
|
553
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/ErrorRootCauseService AWS API Documentation
|
554
|
+
#
|
555
|
+
class ErrorRootCauseService < Struct.new(
|
556
|
+
:name,
|
557
|
+
:names,
|
558
|
+
:type,
|
559
|
+
:account_id,
|
560
|
+
:entity_path,
|
561
|
+
:inferred)
|
562
|
+
SENSITIVE = []
|
326
563
|
include Aws::Structure
|
327
564
|
end
|
328
565
|
|
@@ -350,6 +587,93 @@ module Aws::XRay
|
|
350
587
|
:throttle_count,
|
351
588
|
:other_count,
|
352
589
|
:total_count)
|
590
|
+
SENSITIVE = []
|
591
|
+
include Aws::Structure
|
592
|
+
end
|
593
|
+
|
594
|
+
# The root cause information for a trace summary fault.
|
595
|
+
#
|
596
|
+
# @!attribute [rw] services
|
597
|
+
# A list of corresponding services. A service identifies a segment and
|
598
|
+
# it contains a name, account ID, type, and inferred flag.
|
599
|
+
# @return [Array<Types::FaultRootCauseService>]
|
600
|
+
#
|
601
|
+
# @!attribute [rw] client_impacting
|
602
|
+
# A flag that denotes that the root cause impacts the trace client.
|
603
|
+
# @return [Boolean]
|
604
|
+
#
|
605
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/FaultRootCause AWS API Documentation
|
606
|
+
#
|
607
|
+
class FaultRootCause < Struct.new(
|
608
|
+
:services,
|
609
|
+
:client_impacting)
|
610
|
+
SENSITIVE = []
|
611
|
+
include Aws::Structure
|
612
|
+
end
|
613
|
+
|
614
|
+
# A collection of segments and corresponding subsegments associated to a
|
615
|
+
# trace summary fault error.
|
616
|
+
#
|
617
|
+
# @!attribute [rw] name
|
618
|
+
# The name of the entity.
|
619
|
+
# @return [String]
|
620
|
+
#
|
621
|
+
# @!attribute [rw] exceptions
|
622
|
+
# The types and messages of the exceptions.
|
623
|
+
# @return [Array<Types::RootCauseException>]
|
624
|
+
#
|
625
|
+
# @!attribute [rw] remote
|
626
|
+
# A flag that denotes a remote subsegment.
|
627
|
+
# @return [Boolean]
|
628
|
+
#
|
629
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/FaultRootCauseEntity AWS API Documentation
|
630
|
+
#
|
631
|
+
class FaultRootCauseEntity < Struct.new(
|
632
|
+
:name,
|
633
|
+
:exceptions,
|
634
|
+
:remote)
|
635
|
+
SENSITIVE = []
|
636
|
+
include Aws::Structure
|
637
|
+
end
|
638
|
+
|
639
|
+
# A collection of fields identifying the services in a trace summary
|
640
|
+
# fault.
|
641
|
+
#
|
642
|
+
# @!attribute [rw] name
|
643
|
+
# The service name.
|
644
|
+
# @return [String]
|
645
|
+
#
|
646
|
+
# @!attribute [rw] names
|
647
|
+
# A collection of associated service names.
|
648
|
+
# @return [Array<String>]
|
649
|
+
#
|
650
|
+
# @!attribute [rw] type
|
651
|
+
# The type associated to the service.
|
652
|
+
# @return [String]
|
653
|
+
#
|
654
|
+
# @!attribute [rw] account_id
|
655
|
+
# The account ID associated to the service.
|
656
|
+
# @return [String]
|
657
|
+
#
|
658
|
+
# @!attribute [rw] entity_path
|
659
|
+
# The path of root cause entities found on the service.
|
660
|
+
# @return [Array<Types::FaultRootCauseEntity>]
|
661
|
+
#
|
662
|
+
# @!attribute [rw] inferred
|
663
|
+
# A Boolean value indicating if the service is inferred from the
|
664
|
+
# trace.
|
665
|
+
# @return [Boolean]
|
666
|
+
#
|
667
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/FaultRootCauseService AWS API Documentation
|
668
|
+
#
|
669
|
+
class FaultRootCauseService < Struct.new(
|
670
|
+
:name,
|
671
|
+
:names,
|
672
|
+
:type,
|
673
|
+
:account_id,
|
674
|
+
:entity_path,
|
675
|
+
:inferred)
|
676
|
+
SENSITIVE = []
|
353
677
|
include Aws::Structure
|
354
678
|
end
|
355
679
|
|
@@ -371,6 +695,27 @@ module Aws::XRay
|
|
371
695
|
class FaultStatistics < Struct.new(
|
372
696
|
:other_count,
|
373
697
|
:total_count)
|
698
|
+
SENSITIVE = []
|
699
|
+
include Aws::Structure
|
700
|
+
end
|
701
|
+
|
702
|
+
# The predicted high and low fault count. This is used to determine if a
|
703
|
+
# service has become anomalous and if an insight should be created.
|
704
|
+
#
|
705
|
+
# @!attribute [rw] fault_count_high
|
706
|
+
# The upper limit of fault counts for a service.
|
707
|
+
# @return [Integer]
|
708
|
+
#
|
709
|
+
# @!attribute [rw] fault_count_low
|
710
|
+
# The lower limit of fault counts for a service.
|
711
|
+
# @return [Integer]
|
712
|
+
#
|
713
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/ForecastStatistics AWS API Documentation
|
714
|
+
#
|
715
|
+
class ForecastStatistics < Struct.new(
|
716
|
+
:fault_count_high,
|
717
|
+
:fault_count_low)
|
718
|
+
SENSITIVE = []
|
374
719
|
include Aws::Structure
|
375
720
|
end
|
376
721
|
|
@@ -388,202 +733,535 @@ module Aws::XRay
|
|
388
733
|
#
|
389
734
|
class GetEncryptionConfigResult < Struct.new(
|
390
735
|
:encryption_config)
|
736
|
+
SENSITIVE = []
|
391
737
|
include Aws::Structure
|
392
738
|
end
|
393
739
|
|
394
|
-
#
|
395
|
-
#
|
396
|
-
#
|
397
|
-
# {
|
398
|
-
# next_token: "String",
|
399
|
-
# }
|
740
|
+
# @!attribute [rw] group_name
|
741
|
+
# The case-sensitive name of the group.
|
742
|
+
# @return [String]
|
400
743
|
#
|
401
|
-
# @!attribute [rw]
|
402
|
-
#
|
744
|
+
# @!attribute [rw] group_arn
|
745
|
+
# The ARN of the group that was generated on creation.
|
403
746
|
# @return [String]
|
404
747
|
#
|
405
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/
|
748
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetGroupRequest AWS API Documentation
|
406
749
|
#
|
407
|
-
class
|
408
|
-
:
|
750
|
+
class GetGroupRequest < Struct.new(
|
751
|
+
:group_name,
|
752
|
+
:group_arn)
|
753
|
+
SENSITIVE = []
|
409
754
|
include Aws::Structure
|
410
755
|
end
|
411
756
|
|
412
|
-
# @!attribute [rw]
|
413
|
-
#
|
414
|
-
#
|
415
|
-
#
|
416
|
-
#
|
417
|
-
# Pagination token. Not used.
|
418
|
-
# @return [String]
|
757
|
+
# @!attribute [rw] group
|
758
|
+
# The group that was requested. Contains the name of the group, the
|
759
|
+
# ARN of the group, the filter expression, and the insight
|
760
|
+
# configuration assigned to the group.
|
761
|
+
# @return [Types::Group]
|
419
762
|
#
|
420
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/
|
763
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetGroupResult AWS API Documentation
|
421
764
|
#
|
422
|
-
class
|
423
|
-
:
|
424
|
-
|
765
|
+
class GetGroupResult < Struct.new(
|
766
|
+
:group)
|
767
|
+
SENSITIVE = []
|
425
768
|
include Aws::Structure
|
426
769
|
end
|
427
770
|
|
428
|
-
# @note When making an API call, you may pass GetSamplingStatisticSummariesRequest
|
429
|
-
# data as a hash:
|
430
|
-
#
|
431
|
-
# {
|
432
|
-
# next_token: "String",
|
433
|
-
# }
|
434
|
-
#
|
435
771
|
# @!attribute [rw] next_token
|
436
|
-
# Pagination token.
|
772
|
+
# Pagination token.
|
437
773
|
# @return [String]
|
438
774
|
#
|
439
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/
|
775
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetGroupsRequest AWS API Documentation
|
440
776
|
#
|
441
|
-
class
|
777
|
+
class GetGroupsRequest < Struct.new(
|
442
778
|
:next_token)
|
779
|
+
SENSITIVE = []
|
443
780
|
include Aws::Structure
|
444
781
|
end
|
445
782
|
|
446
|
-
# @!attribute [rw]
|
447
|
-
#
|
448
|
-
#
|
449
|
-
# @return [Array<Types::SamplingStatisticSummary>]
|
783
|
+
# @!attribute [rw] groups
|
784
|
+
# The collection of all active groups.
|
785
|
+
# @return [Array<Types::GroupSummary>]
|
450
786
|
#
|
451
787
|
# @!attribute [rw] next_token
|
452
|
-
# Pagination token.
|
788
|
+
# Pagination token.
|
453
789
|
# @return [String]
|
454
790
|
#
|
455
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/
|
791
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetGroupsResult AWS API Documentation
|
456
792
|
#
|
457
|
-
class
|
458
|
-
:
|
793
|
+
class GetGroupsResult < Struct.new(
|
794
|
+
:groups,
|
459
795
|
:next_token)
|
796
|
+
SENSITIVE = []
|
460
797
|
include Aws::Structure
|
461
798
|
end
|
462
799
|
|
463
|
-
#
|
464
|
-
#
|
800
|
+
# @!attribute [rw] insight_id
|
801
|
+
# The insight's unique identifier. Use the GetInsightSummaries action
|
802
|
+
# to retrieve an InsightId.
|
803
|
+
# @return [String]
|
465
804
|
#
|
466
|
-
#
|
467
|
-
#
|
468
|
-
#
|
469
|
-
# rule_name: "RuleName", # required
|
470
|
-
# client_id: "ClientID", # required
|
471
|
-
# timestamp: Time.now, # required
|
472
|
-
# request_count: 1, # required
|
473
|
-
# sampled_count: 1, # required
|
474
|
-
# borrow_count: 1,
|
475
|
-
# },
|
476
|
-
# ],
|
477
|
-
# }
|
805
|
+
# @!attribute [rw] max_results
|
806
|
+
# Used to retrieve at most the specified value of events.
|
807
|
+
# @return [Integer]
|
478
808
|
#
|
479
|
-
# @!attribute [rw]
|
480
|
-
#
|
481
|
-
#
|
482
|
-
# @return [
|
809
|
+
# @!attribute [rw] next_token
|
810
|
+
# Specify the pagination token returned by a previous request to
|
811
|
+
# retrieve the next page of events.
|
812
|
+
# @return [String]
|
483
813
|
#
|
484
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/
|
814
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetInsightEventsRequest AWS API Documentation
|
485
815
|
#
|
486
|
-
class
|
487
|
-
:
|
816
|
+
class GetInsightEventsRequest < Struct.new(
|
817
|
+
:insight_id,
|
818
|
+
:max_results,
|
819
|
+
:next_token)
|
820
|
+
SENSITIVE = []
|
488
821
|
include Aws::Structure
|
489
822
|
end
|
490
823
|
|
491
|
-
# @!attribute [rw]
|
492
|
-
#
|
493
|
-
#
|
494
|
-
#
|
495
|
-
#
|
496
|
-
# The last time a user changed the sampling rule configuration. If the
|
497
|
-
# sampling rule configuration changed since the service last retrieved
|
498
|
-
# it, the service should call GetSamplingRules to get the latest
|
499
|
-
# version.
|
500
|
-
# @return [Time]
|
824
|
+
# @!attribute [rw] insight_events
|
825
|
+
# A detailed description of the event. This includes the time of the
|
826
|
+
# event, client and root cause impact statistics, and the top
|
827
|
+
# anomalous service at the time of the event.
|
828
|
+
# @return [Array<Types::InsightEvent>]
|
501
829
|
#
|
502
|
-
# @!attribute [rw]
|
503
|
-
#
|
504
|
-
#
|
505
|
-
# @return [Array<Types::UnprocessedStatistics>]
|
830
|
+
# @!attribute [rw] next_token
|
831
|
+
# Use this token to retrieve the next page of insight events.
|
832
|
+
# @return [String]
|
506
833
|
#
|
507
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/
|
834
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetInsightEventsResult AWS API Documentation
|
508
835
|
#
|
509
|
-
class
|
510
|
-
:
|
511
|
-
:
|
512
|
-
|
836
|
+
class GetInsightEventsResult < Struct.new(
|
837
|
+
:insight_events,
|
838
|
+
:next_token)
|
839
|
+
SENSITIVE = []
|
513
840
|
include Aws::Structure
|
514
841
|
end
|
515
842
|
|
516
|
-
#
|
517
|
-
#
|
518
|
-
#
|
519
|
-
#
|
520
|
-
# start_time: Time.now, # required
|
521
|
-
# end_time: Time.now, # required
|
522
|
-
# next_token: "String",
|
523
|
-
# }
|
843
|
+
# @!attribute [rw] insight_id
|
844
|
+
# The insight's unique identifier. Use the GetInsightSummaries action
|
845
|
+
# to retrieve an InsightId.
|
846
|
+
# @return [String]
|
524
847
|
#
|
525
848
|
# @!attribute [rw] start_time
|
526
|
-
# The start of the
|
849
|
+
# The estimated start time of the insight, in Unix time seconds. The
|
850
|
+
# StartTime is inclusive of the value provided and can't be more than
|
851
|
+
# 30 days old.
|
527
852
|
# @return [Time]
|
528
853
|
#
|
529
854
|
# @!attribute [rw] end_time
|
530
|
-
# The end of the
|
855
|
+
# The estimated end time of the insight, in Unix time seconds. The
|
856
|
+
# EndTime is exclusive of the value provided. The time range between
|
857
|
+
# the start time and end time can't be more than six hours.
|
531
858
|
# @return [Time]
|
532
859
|
#
|
533
860
|
# @!attribute [rw] next_token
|
534
|
-
#
|
861
|
+
# Specify the pagination token returned by a previous request to
|
862
|
+
# retrieve the next page of results.
|
535
863
|
# @return [String]
|
536
864
|
#
|
537
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/
|
865
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetInsightImpactGraphRequest AWS API Documentation
|
538
866
|
#
|
539
|
-
class
|
867
|
+
class GetInsightImpactGraphRequest < Struct.new(
|
868
|
+
:insight_id,
|
540
869
|
:start_time,
|
541
870
|
:end_time,
|
542
871
|
:next_token)
|
872
|
+
SENSITIVE = []
|
543
873
|
include Aws::Structure
|
544
874
|
end
|
545
875
|
|
876
|
+
# @!attribute [rw] insight_id
|
877
|
+
# The insight's unique identifier.
|
878
|
+
# @return [String]
|
879
|
+
#
|
546
880
|
# @!attribute [rw] start_time
|
547
|
-
# The start
|
881
|
+
# The provided start time.
|
548
882
|
# @return [Time]
|
549
883
|
#
|
550
884
|
# @!attribute [rw] end_time
|
551
|
-
# The end
|
885
|
+
# The provided end time.
|
886
|
+
# @return [Time]
|
887
|
+
#
|
888
|
+
# @!attribute [rw] service_graph_start_time
|
889
|
+
# The time, in Unix seconds, at which the service graph started.
|
890
|
+
# @return [Time]
|
891
|
+
#
|
892
|
+
# @!attribute [rw] service_graph_end_time
|
893
|
+
# The time, in Unix seconds, at which the service graph ended.
|
552
894
|
# @return [Time]
|
553
895
|
#
|
554
896
|
# @!attribute [rw] services
|
555
|
-
# The
|
556
|
-
#
|
557
|
-
# @return [Array<Types::
|
897
|
+
# The Amazon Web Services instrumented services related to the
|
898
|
+
# insight.
|
899
|
+
# @return [Array<Types::InsightImpactGraphService>]
|
558
900
|
#
|
559
901
|
# @!attribute [rw] next_token
|
560
|
-
# Pagination token.
|
902
|
+
# Pagination token.
|
561
903
|
# @return [String]
|
562
904
|
#
|
563
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/
|
905
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetInsightImpactGraphResult AWS API Documentation
|
906
|
+
#
|
907
|
+
class GetInsightImpactGraphResult < Struct.new(
|
908
|
+
:insight_id,
|
909
|
+
:start_time,
|
910
|
+
:end_time,
|
911
|
+
:service_graph_start_time,
|
912
|
+
:service_graph_end_time,
|
913
|
+
:services,
|
914
|
+
:next_token)
|
915
|
+
SENSITIVE = []
|
916
|
+
include Aws::Structure
|
917
|
+
end
|
918
|
+
|
919
|
+
# @!attribute [rw] insight_id
|
920
|
+
# The insight's unique identifier. Use the GetInsightSummaries action
|
921
|
+
# to retrieve an InsightId.
|
922
|
+
# @return [String]
|
923
|
+
#
|
924
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetInsightRequest AWS API Documentation
|
925
|
+
#
|
926
|
+
class GetInsightRequest < Struct.new(
|
927
|
+
:insight_id)
|
928
|
+
SENSITIVE = []
|
929
|
+
include Aws::Structure
|
930
|
+
end
|
931
|
+
|
932
|
+
# @!attribute [rw] insight
|
933
|
+
# The summary information of an insight.
|
934
|
+
# @return [Types::Insight]
|
935
|
+
#
|
936
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetInsightResult AWS API Documentation
|
937
|
+
#
|
938
|
+
class GetInsightResult < Struct.new(
|
939
|
+
:insight)
|
940
|
+
SENSITIVE = []
|
941
|
+
include Aws::Structure
|
942
|
+
end
|
943
|
+
|
944
|
+
# @!attribute [rw] states
|
945
|
+
# The list of insight states.
|
946
|
+
# @return [Array<String>]
|
947
|
+
#
|
948
|
+
# @!attribute [rw] group_arn
|
949
|
+
# The Amazon Resource Name (ARN) of the group. Required if the
|
950
|
+
# GroupName isn't provided.
|
951
|
+
# @return [String]
|
952
|
+
#
|
953
|
+
# @!attribute [rw] group_name
|
954
|
+
# The name of the group. Required if the GroupARN isn't provided.
|
955
|
+
# @return [String]
|
956
|
+
#
|
957
|
+
# @!attribute [rw] start_time
|
958
|
+
# The beginning of the time frame in which the insights started. The
|
959
|
+
# start time can't be more than 30 days old.
|
960
|
+
# @return [Time]
|
961
|
+
#
|
962
|
+
# @!attribute [rw] end_time
|
963
|
+
# The end of the time frame in which the insights ended. The end time
|
964
|
+
# can't be more than 30 days old.
|
965
|
+
# @return [Time]
|
966
|
+
#
|
967
|
+
# @!attribute [rw] max_results
|
968
|
+
# The maximum number of results to display.
|
969
|
+
# @return [Integer]
|
970
|
+
#
|
971
|
+
# @!attribute [rw] next_token
|
972
|
+
# Pagination token.
|
973
|
+
# @return [String]
|
974
|
+
#
|
975
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetInsightSummariesRequest AWS API Documentation
|
976
|
+
#
|
977
|
+
class GetInsightSummariesRequest < Struct.new(
|
978
|
+
:states,
|
979
|
+
:group_arn,
|
980
|
+
:group_name,
|
981
|
+
:start_time,
|
982
|
+
:end_time,
|
983
|
+
:max_results,
|
984
|
+
:next_token)
|
985
|
+
SENSITIVE = []
|
986
|
+
include Aws::Structure
|
987
|
+
end
|
988
|
+
|
989
|
+
# @!attribute [rw] insight_summaries
|
990
|
+
# The summary of each insight within the group matching the provided
|
991
|
+
# filters. The summary contains the InsightID, start and end time, the
|
992
|
+
# root cause service, the root cause and client impact statistics, the
|
993
|
+
# top anomalous services, and the status of the insight.
|
994
|
+
# @return [Array<Types::InsightSummary>]
|
995
|
+
#
|
996
|
+
# @!attribute [rw] next_token
|
997
|
+
# Pagination token.
|
998
|
+
# @return [String]
|
999
|
+
#
|
1000
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetInsightSummariesResult AWS API Documentation
|
1001
|
+
#
|
1002
|
+
class GetInsightSummariesResult < Struct.new(
|
1003
|
+
:insight_summaries,
|
1004
|
+
:next_token)
|
1005
|
+
SENSITIVE = []
|
1006
|
+
include Aws::Structure
|
1007
|
+
end
|
1008
|
+
|
1009
|
+
# @!attribute [rw] next_token
|
1010
|
+
# Pagination token.
|
1011
|
+
# @return [String]
|
1012
|
+
#
|
1013
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetSamplingRulesRequest AWS API Documentation
|
1014
|
+
#
|
1015
|
+
class GetSamplingRulesRequest < Struct.new(
|
1016
|
+
:next_token)
|
1017
|
+
SENSITIVE = []
|
1018
|
+
include Aws::Structure
|
1019
|
+
end
|
1020
|
+
|
1021
|
+
# @!attribute [rw] sampling_rule_records
|
1022
|
+
# Rule definitions and metadata.
|
1023
|
+
# @return [Array<Types::SamplingRuleRecord>]
|
1024
|
+
#
|
1025
|
+
# @!attribute [rw] next_token
|
1026
|
+
# Pagination token.
|
1027
|
+
# @return [String]
|
1028
|
+
#
|
1029
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetSamplingRulesResult AWS API Documentation
|
1030
|
+
#
|
1031
|
+
class GetSamplingRulesResult < Struct.new(
|
1032
|
+
:sampling_rule_records,
|
1033
|
+
:next_token)
|
1034
|
+
SENSITIVE = []
|
1035
|
+
include Aws::Structure
|
1036
|
+
end
|
1037
|
+
|
1038
|
+
# @!attribute [rw] next_token
|
1039
|
+
# Pagination token.
|
1040
|
+
# @return [String]
|
1041
|
+
#
|
1042
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetSamplingStatisticSummariesRequest AWS API Documentation
|
1043
|
+
#
|
1044
|
+
class GetSamplingStatisticSummariesRequest < Struct.new(
|
1045
|
+
:next_token)
|
1046
|
+
SENSITIVE = []
|
1047
|
+
include Aws::Structure
|
1048
|
+
end
|
1049
|
+
|
1050
|
+
# @!attribute [rw] sampling_statistic_summaries
|
1051
|
+
# Information about the number of requests instrumented for each
|
1052
|
+
# sampling rule.
|
1053
|
+
# @return [Array<Types::SamplingStatisticSummary>]
|
1054
|
+
#
|
1055
|
+
# @!attribute [rw] next_token
|
1056
|
+
# Pagination token.
|
1057
|
+
# @return [String]
|
1058
|
+
#
|
1059
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetSamplingStatisticSummariesResult AWS API Documentation
|
1060
|
+
#
|
1061
|
+
class GetSamplingStatisticSummariesResult < Struct.new(
|
1062
|
+
:sampling_statistic_summaries,
|
1063
|
+
:next_token)
|
1064
|
+
SENSITIVE = []
|
1065
|
+
include Aws::Structure
|
1066
|
+
end
|
1067
|
+
|
1068
|
+
# @!attribute [rw] sampling_statistics_documents
|
1069
|
+
# Information about rules that the service is using to sample
|
1070
|
+
# requests.
|
1071
|
+
# @return [Array<Types::SamplingStatisticsDocument>]
|
1072
|
+
#
|
1073
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetSamplingTargetsRequest AWS API Documentation
|
1074
|
+
#
|
1075
|
+
class GetSamplingTargetsRequest < Struct.new(
|
1076
|
+
:sampling_statistics_documents)
|
1077
|
+
SENSITIVE = []
|
1078
|
+
include Aws::Structure
|
1079
|
+
end
|
1080
|
+
|
1081
|
+
# @!attribute [rw] sampling_target_documents
|
1082
|
+
# Updated rules that the service should use to sample requests.
|
1083
|
+
# @return [Array<Types::SamplingTargetDocument>]
|
1084
|
+
#
|
1085
|
+
# @!attribute [rw] last_rule_modification
|
1086
|
+
# The last time a user changed the sampling rule configuration. If the
|
1087
|
+
# sampling rule configuration changed since the service last retrieved
|
1088
|
+
# it, the service should call [GetSamplingRules][1] to get the latest
|
1089
|
+
# version.
|
1090
|
+
#
|
1091
|
+
#
|
1092
|
+
#
|
1093
|
+
# [1]: https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingRules.html
|
1094
|
+
# @return [Time]
|
1095
|
+
#
|
1096
|
+
# @!attribute [rw] unprocessed_statistics
|
1097
|
+
# Information about [SamplingStatisticsDocument][1] that X-Ray could
|
1098
|
+
# not process.
|
1099
|
+
#
|
1100
|
+
#
|
1101
|
+
#
|
1102
|
+
# [1]: https://docs.aws.amazon.com/xray/latest/api/API_SamplingStatisticsDocument.html
|
1103
|
+
# @return [Array<Types::UnprocessedStatistics>]
|
1104
|
+
#
|
1105
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetSamplingTargetsResult AWS API Documentation
|
1106
|
+
#
|
1107
|
+
class GetSamplingTargetsResult < Struct.new(
|
1108
|
+
:sampling_target_documents,
|
1109
|
+
:last_rule_modification,
|
1110
|
+
:unprocessed_statistics)
|
1111
|
+
SENSITIVE = []
|
1112
|
+
include Aws::Structure
|
1113
|
+
end
|
1114
|
+
|
1115
|
+
# @!attribute [rw] start_time
|
1116
|
+
# The start of the time frame for which to generate a graph.
|
1117
|
+
# @return [Time]
|
1118
|
+
#
|
1119
|
+
# @!attribute [rw] end_time
|
1120
|
+
# The end of the timeframe for which to generate a graph.
|
1121
|
+
# @return [Time]
|
1122
|
+
#
|
1123
|
+
# @!attribute [rw] group_name
|
1124
|
+
# The name of a group based on which you want to generate a graph.
|
1125
|
+
# @return [String]
|
1126
|
+
#
|
1127
|
+
# @!attribute [rw] group_arn
|
1128
|
+
# The Amazon Resource Name (ARN) of a group based on which you want to
|
1129
|
+
# generate a graph.
|
1130
|
+
# @return [String]
|
1131
|
+
#
|
1132
|
+
# @!attribute [rw] next_token
|
1133
|
+
# Pagination token.
|
1134
|
+
# @return [String]
|
1135
|
+
#
|
1136
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetServiceGraphRequest AWS API Documentation
|
1137
|
+
#
|
1138
|
+
class GetServiceGraphRequest < Struct.new(
|
1139
|
+
:start_time,
|
1140
|
+
:end_time,
|
1141
|
+
:group_name,
|
1142
|
+
:group_arn,
|
1143
|
+
:next_token)
|
1144
|
+
SENSITIVE = []
|
1145
|
+
include Aws::Structure
|
1146
|
+
end
|
1147
|
+
|
1148
|
+
# @!attribute [rw] start_time
|
1149
|
+
# The start of the time frame for which the graph was generated.
|
1150
|
+
# @return [Time]
|
1151
|
+
#
|
1152
|
+
# @!attribute [rw] end_time
|
1153
|
+
# The end of the time frame for which the graph was generated.
|
1154
|
+
# @return [Time]
|
1155
|
+
#
|
1156
|
+
# @!attribute [rw] services
|
1157
|
+
# The services that have processed a traced request during the
|
1158
|
+
# specified time frame.
|
1159
|
+
# @return [Array<Types::Service>]
|
1160
|
+
#
|
1161
|
+
# @!attribute [rw] contains_old_group_versions
|
1162
|
+
# A flag indicating whether the group's filter expression has been
|
1163
|
+
# consistent, or if the returned service graph may show traces from an
|
1164
|
+
# older version of the group's filter expression.
|
1165
|
+
# @return [Boolean]
|
1166
|
+
#
|
1167
|
+
# @!attribute [rw] next_token
|
1168
|
+
# Pagination token.
|
1169
|
+
# @return [String]
|
1170
|
+
#
|
1171
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetServiceGraphResult AWS API Documentation
|
564
1172
|
#
|
565
1173
|
class GetServiceGraphResult < Struct.new(
|
566
1174
|
:start_time,
|
567
1175
|
:end_time,
|
568
1176
|
:services,
|
1177
|
+
:contains_old_group_versions,
|
1178
|
+
:next_token)
|
1179
|
+
SENSITIVE = []
|
1180
|
+
include Aws::Structure
|
1181
|
+
end
|
1182
|
+
|
1183
|
+
# @!attribute [rw] start_time
|
1184
|
+
# The start of the time frame for which to aggregate statistics.
|
1185
|
+
# @return [Time]
|
1186
|
+
#
|
1187
|
+
# @!attribute [rw] end_time
|
1188
|
+
# The end of the time frame for which to aggregate statistics.
|
1189
|
+
# @return [Time]
|
1190
|
+
#
|
1191
|
+
# @!attribute [rw] group_name
|
1192
|
+
# The case-sensitive name of the group for which to pull statistics
|
1193
|
+
# from.
|
1194
|
+
# @return [String]
|
1195
|
+
#
|
1196
|
+
# @!attribute [rw] group_arn
|
1197
|
+
# The Amazon Resource Name (ARN) of the group for which to pull
|
1198
|
+
# statistics from.
|
1199
|
+
# @return [String]
|
1200
|
+
#
|
1201
|
+
# @!attribute [rw] entity_selector_expression
|
1202
|
+
# A filter expression defining entities that will be aggregated for
|
1203
|
+
# statistics. Supports ID, service, and edge functions. If no selector
|
1204
|
+
# expression is specified, edge statistics are returned.
|
1205
|
+
# @return [String]
|
1206
|
+
#
|
1207
|
+
# @!attribute [rw] period
|
1208
|
+
# Aggregation period in seconds.
|
1209
|
+
# @return [Integer]
|
1210
|
+
#
|
1211
|
+
# @!attribute [rw] forecast_statistics
|
1212
|
+
# The forecasted high and low fault count values. Forecast enabled
|
1213
|
+
# requests require the EntitySelectorExpression ID be provided.
|
1214
|
+
# @return [Boolean]
|
1215
|
+
#
|
1216
|
+
# @!attribute [rw] next_token
|
1217
|
+
# Pagination token.
|
1218
|
+
# @return [String]
|
1219
|
+
#
|
1220
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetTimeSeriesServiceStatisticsRequest AWS API Documentation
|
1221
|
+
#
|
1222
|
+
class GetTimeSeriesServiceStatisticsRequest < Struct.new(
|
1223
|
+
:start_time,
|
1224
|
+
:end_time,
|
1225
|
+
:group_name,
|
1226
|
+
:group_arn,
|
1227
|
+
:entity_selector_expression,
|
1228
|
+
:period,
|
1229
|
+
:forecast_statistics,
|
569
1230
|
:next_token)
|
1231
|
+
SENSITIVE = []
|
570
1232
|
include Aws::Structure
|
571
1233
|
end
|
572
1234
|
|
573
|
-
#
|
574
|
-
#
|
1235
|
+
# @!attribute [rw] time_series_service_statistics
|
1236
|
+
# The collection of statistics.
|
1237
|
+
# @return [Array<Types::TimeSeriesServiceStatistics>]
|
1238
|
+
#
|
1239
|
+
# @!attribute [rw] contains_old_group_versions
|
1240
|
+
# A flag indicating whether or not a group's filter expression has
|
1241
|
+
# been consistent, or if a returned aggregation might show statistics
|
1242
|
+
# from an older version of the group's filter expression.
|
1243
|
+
# @return [Boolean]
|
575
1244
|
#
|
576
|
-
#
|
577
|
-
#
|
578
|
-
#
|
579
|
-
# }
|
1245
|
+
# @!attribute [rw] next_token
|
1246
|
+
# Pagination token.
|
1247
|
+
# @return [String]
|
580
1248
|
#
|
1249
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetTimeSeriesServiceStatisticsResult AWS API Documentation
|
1250
|
+
#
|
1251
|
+
class GetTimeSeriesServiceStatisticsResult < Struct.new(
|
1252
|
+
:time_series_service_statistics,
|
1253
|
+
:contains_old_group_versions,
|
1254
|
+
:next_token)
|
1255
|
+
SENSITIVE = []
|
1256
|
+
include Aws::Structure
|
1257
|
+
end
|
1258
|
+
|
581
1259
|
# @!attribute [rw] trace_ids
|
582
1260
|
# Trace IDs of requests for which to generate a service graph.
|
583
1261
|
# @return [Array<String>]
|
584
1262
|
#
|
585
1263
|
# @!attribute [rw] next_token
|
586
|
-
# Pagination token.
|
1264
|
+
# Pagination token.
|
587
1265
|
# @return [String]
|
588
1266
|
#
|
589
1267
|
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetTraceGraphRequest AWS API Documentation
|
@@ -591,6 +1269,7 @@ module Aws::XRay
|
|
591
1269
|
class GetTraceGraphRequest < Struct.new(
|
592
1270
|
:trace_ids,
|
593
1271
|
:next_token)
|
1272
|
+
SENSITIVE = []
|
594
1273
|
include Aws::Structure
|
595
1274
|
end
|
596
1275
|
|
@@ -599,7 +1278,7 @@ module Aws::XRay
|
|
599
1278
|
# @return [Array<Types::Service>]
|
600
1279
|
#
|
601
1280
|
# @!attribute [rw] next_token
|
602
|
-
# Pagination token.
|
1281
|
+
# Pagination token.
|
603
1282
|
# @return [String]
|
604
1283
|
#
|
605
1284
|
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetTraceGraphResult AWS API Documentation
|
@@ -607,20 +1286,10 @@ module Aws::XRay
|
|
607
1286
|
class GetTraceGraphResult < Struct.new(
|
608
1287
|
:services,
|
609
1288
|
:next_token)
|
1289
|
+
SENSITIVE = []
|
610
1290
|
include Aws::Structure
|
611
1291
|
end
|
612
1292
|
|
613
|
-
# @note When making an API call, you may pass GetTraceSummariesRequest
|
614
|
-
# data as a hash:
|
615
|
-
#
|
616
|
-
# {
|
617
|
-
# start_time: Time.now, # required
|
618
|
-
# end_time: Time.now, # required
|
619
|
-
# sampling: false,
|
620
|
-
# filter_expression: "FilterExpression",
|
621
|
-
# next_token: "String",
|
622
|
-
# }
|
623
|
-
#
|
624
1293
|
# @!attribute [rw] start_time
|
625
1294
|
# The start of the time frame for which to retrieve traces.
|
626
1295
|
# @return [Time]
|
@@ -629,11 +1298,21 @@ module Aws::XRay
|
|
629
1298
|
# The end of the time frame for which to retrieve traces.
|
630
1299
|
# @return [Time]
|
631
1300
|
#
|
1301
|
+
# @!attribute [rw] time_range_type
|
1302
|
+
# A parameter to indicate whether to query trace summaries by TraceId,
|
1303
|
+
# Event (trace update time), or Service (segment end time).
|
1304
|
+
# @return [String]
|
1305
|
+
#
|
632
1306
|
# @!attribute [rw] sampling
|
633
1307
|
# Set to `true` to get summaries for only a subset of available
|
634
1308
|
# traces.
|
635
1309
|
# @return [Boolean]
|
636
1310
|
#
|
1311
|
+
# @!attribute [rw] sampling_strategy
|
1312
|
+
# A parameter to indicate whether to enable sampling on trace
|
1313
|
+
# summaries. Input parameters are Name and Value.
|
1314
|
+
# @return [Types::SamplingStrategy]
|
1315
|
+
#
|
637
1316
|
# @!attribute [rw] filter_expression
|
638
1317
|
# Specify a filter expression to retrieve trace summaries for services
|
639
1318
|
# or requests that meet certain requirements.
|
@@ -649,15 +1328,18 @@ module Aws::XRay
|
|
649
1328
|
class GetTraceSummariesRequest < Struct.new(
|
650
1329
|
:start_time,
|
651
1330
|
:end_time,
|
1331
|
+
:time_range_type,
|
652
1332
|
:sampling,
|
1333
|
+
:sampling_strategy,
|
653
1334
|
:filter_expression,
|
654
1335
|
:next_token)
|
1336
|
+
SENSITIVE = []
|
655
1337
|
include Aws::Structure
|
656
1338
|
end
|
657
1339
|
|
658
1340
|
# @!attribute [rw] trace_summaries
|
659
|
-
# Trace IDs and
|
660
|
-
# time frame.
|
1341
|
+
# Trace IDs and annotations for traces that were found in the
|
1342
|
+
# specified time frame.
|
661
1343
|
# @return [Array<Types::TraceSummary>]
|
662
1344
|
#
|
663
1345
|
# @!attribute [rw] approximate_time
|
@@ -672,8 +1354,8 @@ module Aws::XRay
|
|
672
1354
|
# @!attribute [rw] next_token
|
673
1355
|
# If the requested time frame contained more than one page of results,
|
674
1356
|
# you can use this token to retrieve the next page. The first page
|
675
|
-
# contains the most
|
676
|
-
#
|
1357
|
+
# contains the most recent results, closest to the end of the time
|
1358
|
+
# frame.
|
677
1359
|
# @return [String]
|
678
1360
|
#
|
679
1361
|
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetTraceSummariesResult AWS API Documentation
|
@@ -683,190 +1365,952 @@ module Aws::XRay
|
|
683
1365
|
:approximate_time,
|
684
1366
|
:traces_processed_count,
|
685
1367
|
:next_token)
|
1368
|
+
SENSITIVE = []
|
686
1369
|
include Aws::Structure
|
687
1370
|
end
|
688
1371
|
|
689
|
-
#
|
690
|
-
# observed values on the X axis, and the prevalence of each value on the
|
691
|
-
# Y axis.
|
1372
|
+
# Details and metadata for a group.
|
692
1373
|
#
|
693
|
-
# @!attribute [rw]
|
694
|
-
# The
|
695
|
-
# @return [
|
1374
|
+
# @!attribute [rw] group_name
|
1375
|
+
# The unique case-sensitive name of the group.
|
1376
|
+
# @return [String]
|
696
1377
|
#
|
697
|
-
# @!attribute [rw]
|
698
|
-
# The
|
699
|
-
#
|
1378
|
+
# @!attribute [rw] group_arn
|
1379
|
+
# The Amazon Resource Name (ARN) of the group generated based on the
|
1380
|
+
# GroupName.
|
1381
|
+
# @return [String]
|
700
1382
|
#
|
701
|
-
#
|
1383
|
+
# @!attribute [rw] filter_expression
|
1384
|
+
# The filter expression defining the parameters to include traces.
|
1385
|
+
# @return [String]
|
702
1386
|
#
|
703
|
-
|
704
|
-
|
705
|
-
|
1387
|
+
# @!attribute [rw] insights_configuration
|
1388
|
+
# The structure containing configurations related to insights.
|
1389
|
+
#
|
1390
|
+
# * The InsightsEnabled boolean can be set to true to enable insights
|
1391
|
+
# for the group or false to disable insights for the group.
|
1392
|
+
#
|
1393
|
+
# * The NotificationsEnabled boolean can be set to true to enable
|
1394
|
+
# insights notifications through Amazon EventBridge for the group.
|
1395
|
+
# @return [Types::InsightsConfiguration]
|
1396
|
+
#
|
1397
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/Group AWS API Documentation
|
1398
|
+
#
|
1399
|
+
class Group < Struct.new(
|
1400
|
+
:group_name,
|
1401
|
+
:group_arn,
|
1402
|
+
:filter_expression,
|
1403
|
+
:insights_configuration)
|
1404
|
+
SENSITIVE = []
|
706
1405
|
include Aws::Structure
|
707
1406
|
end
|
708
1407
|
|
709
|
-
#
|
1408
|
+
# Details for a group without metadata.
|
710
1409
|
#
|
711
|
-
# @!attribute [rw]
|
712
|
-
# The
|
1410
|
+
# @!attribute [rw] group_name
|
1411
|
+
# The unique case-sensitive name of the group.
|
713
1412
|
# @return [String]
|
714
1413
|
#
|
715
|
-
# @!attribute [rw]
|
716
|
-
# The
|
717
|
-
# @return [
|
718
|
-
#
|
719
|
-
# @!attribute [rw]
|
720
|
-
# The
|
1414
|
+
# @!attribute [rw] group_arn
|
1415
|
+
# The ARN of the group generated based on the GroupName.
|
1416
|
+
# @return [String]
|
1417
|
+
#
|
1418
|
+
# @!attribute [rw] filter_expression
|
1419
|
+
# The filter expression defining the parameters to include traces.
|
1420
|
+
# @return [String]
|
1421
|
+
#
|
1422
|
+
# @!attribute [rw] insights_configuration
|
1423
|
+
# The structure containing configurations related to insights.
|
1424
|
+
#
|
1425
|
+
# * The InsightsEnabled boolean can be set to true to enable insights
|
1426
|
+
# for the group or false to disable insights for the group.
|
1427
|
+
#
|
1428
|
+
# * The NotificationsEnabled boolean can be set to true to enable
|
1429
|
+
# insights notifications. Notifications can only be enabled on a
|
1430
|
+
# group with InsightsEnabled set to true.
|
1431
|
+
# @return [Types::InsightsConfiguration]
|
1432
|
+
#
|
1433
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GroupSummary AWS API Documentation
|
1434
|
+
#
|
1435
|
+
class GroupSummary < Struct.new(
|
1436
|
+
:group_name,
|
1437
|
+
:group_arn,
|
1438
|
+
:filter_expression,
|
1439
|
+
:insights_configuration)
|
1440
|
+
SENSITIVE = []
|
1441
|
+
include Aws::Structure
|
1442
|
+
end
|
1443
|
+
|
1444
|
+
# An entry in a histogram for a statistic. A histogram maps the range of
|
1445
|
+
# observed values on the X axis, and the prevalence of each value on the
|
1446
|
+
# Y axis.
|
1447
|
+
#
|
1448
|
+
# @!attribute [rw] value
|
1449
|
+
# The value of the entry.
|
1450
|
+
# @return [Float]
|
1451
|
+
#
|
1452
|
+
# @!attribute [rw] count
|
1453
|
+
# The prevalence of the entry.
|
1454
|
+
# @return [Integer]
|
1455
|
+
#
|
1456
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/HistogramEntry AWS API Documentation
|
1457
|
+
#
|
1458
|
+
class HistogramEntry < Struct.new(
|
1459
|
+
:value,
|
1460
|
+
:count)
|
1461
|
+
SENSITIVE = []
|
1462
|
+
include Aws::Structure
|
1463
|
+
end
|
1464
|
+
|
1465
|
+
# Information about an HTTP request.
|
1466
|
+
#
|
1467
|
+
# @!attribute [rw] http_url
|
1468
|
+
# The request URL.
|
1469
|
+
# @return [String]
|
1470
|
+
#
|
1471
|
+
# @!attribute [rw] http_status
|
1472
|
+
# The response status.
|
1473
|
+
# @return [Integer]
|
1474
|
+
#
|
1475
|
+
# @!attribute [rw] http_method
|
1476
|
+
# The request method.
|
721
1477
|
# @return [String]
|
722
1478
|
#
|
723
1479
|
# @!attribute [rw] user_agent
|
724
1480
|
# The request's user agent string.
|
725
1481
|
# @return [String]
|
726
1482
|
#
|
727
|
-
# @!attribute [rw] client_ip
|
728
|
-
# The IP address of the requestor.
|
1483
|
+
# @!attribute [rw] client_ip
|
1484
|
+
# The IP address of the requestor.
|
1485
|
+
# @return [String]
|
1486
|
+
#
|
1487
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/Http AWS API Documentation
|
1488
|
+
#
|
1489
|
+
class Http < Struct.new(
|
1490
|
+
:http_url,
|
1491
|
+
:http_status,
|
1492
|
+
:http_method,
|
1493
|
+
:user_agent,
|
1494
|
+
:client_ip)
|
1495
|
+
SENSITIVE = []
|
1496
|
+
include Aws::Structure
|
1497
|
+
end
|
1498
|
+
|
1499
|
+
# When fault rates go outside of the expected range, X-Ray creates an
|
1500
|
+
# insight. Insights tracks emergent issues within your applications.
|
1501
|
+
#
|
1502
|
+
# @!attribute [rw] insight_id
|
1503
|
+
# The insights unique identifier.
|
1504
|
+
# @return [String]
|
1505
|
+
#
|
1506
|
+
# @!attribute [rw] group_arn
|
1507
|
+
# The Amazon Resource Name (ARN) of the group that the insight belongs
|
1508
|
+
# to.
|
1509
|
+
# @return [String]
|
1510
|
+
#
|
1511
|
+
# @!attribute [rw] group_name
|
1512
|
+
# The name of the group that the insight belongs to.
|
1513
|
+
# @return [String]
|
1514
|
+
#
|
1515
|
+
# @!attribute [rw] root_cause_service_id
|
1516
|
+
# @return [Types::ServiceId]
|
1517
|
+
#
|
1518
|
+
# @!attribute [rw] categories
|
1519
|
+
# The categories that label and describe the type of insight.
|
1520
|
+
# @return [Array<String>]
|
1521
|
+
#
|
1522
|
+
# @!attribute [rw] state
|
1523
|
+
# The current state of the insight.
|
1524
|
+
# @return [String]
|
1525
|
+
#
|
1526
|
+
# @!attribute [rw] start_time
|
1527
|
+
# The time, in Unix seconds, at which the insight began.
|
1528
|
+
# @return [Time]
|
1529
|
+
#
|
1530
|
+
# @!attribute [rw] end_time
|
1531
|
+
# The time, in Unix seconds, at which the insight ended.
|
1532
|
+
# @return [Time]
|
1533
|
+
#
|
1534
|
+
# @!attribute [rw] summary
|
1535
|
+
# A brief description of the insight.
|
1536
|
+
# @return [String]
|
1537
|
+
#
|
1538
|
+
# @!attribute [rw] client_request_impact_statistics
|
1539
|
+
# The impact statistics of the client side service. This includes the
|
1540
|
+
# number of requests to the client service and whether the requests
|
1541
|
+
# were faults or okay.
|
1542
|
+
# @return [Types::RequestImpactStatistics]
|
1543
|
+
#
|
1544
|
+
# @!attribute [rw] root_cause_service_request_impact_statistics
|
1545
|
+
# The impact statistics of the root cause service. This includes the
|
1546
|
+
# number of requests to the client service and whether the requests
|
1547
|
+
# were faults or okay.
|
1548
|
+
# @return [Types::RequestImpactStatistics]
|
1549
|
+
#
|
1550
|
+
# @!attribute [rw] top_anomalous_services
|
1551
|
+
# The service within the insight that is most impacted by the
|
1552
|
+
# incident.
|
1553
|
+
# @return [Array<Types::AnomalousService>]
|
1554
|
+
#
|
1555
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/Insight AWS API Documentation
|
1556
|
+
#
|
1557
|
+
class Insight < Struct.new(
|
1558
|
+
:insight_id,
|
1559
|
+
:group_arn,
|
1560
|
+
:group_name,
|
1561
|
+
:root_cause_service_id,
|
1562
|
+
:categories,
|
1563
|
+
:state,
|
1564
|
+
:start_time,
|
1565
|
+
:end_time,
|
1566
|
+
:summary,
|
1567
|
+
:client_request_impact_statistics,
|
1568
|
+
:root_cause_service_request_impact_statistics,
|
1569
|
+
:top_anomalous_services)
|
1570
|
+
SENSITIVE = []
|
1571
|
+
include Aws::Structure
|
1572
|
+
end
|
1573
|
+
|
1574
|
+
# X-Ray reevaluates insights periodically until they are resolved, and
|
1575
|
+
# records each intermediate state in an event. You can review incident
|
1576
|
+
# events in the Impact Timeline on the Inspect page in the X-Ray
|
1577
|
+
# console.
|
1578
|
+
#
|
1579
|
+
# @!attribute [rw] summary
|
1580
|
+
# A brief description of the event.
|
1581
|
+
# @return [String]
|
1582
|
+
#
|
1583
|
+
# @!attribute [rw] event_time
|
1584
|
+
# The time, in Unix seconds, at which the event was recorded.
|
1585
|
+
# @return [Time]
|
1586
|
+
#
|
1587
|
+
# @!attribute [rw] client_request_impact_statistics
|
1588
|
+
# The impact statistics of the client side service. This includes the
|
1589
|
+
# number of requests to the client service and whether the requests
|
1590
|
+
# were faults or okay.
|
1591
|
+
# @return [Types::RequestImpactStatistics]
|
1592
|
+
#
|
1593
|
+
# @!attribute [rw] root_cause_service_request_impact_statistics
|
1594
|
+
# The impact statistics of the root cause service. This includes the
|
1595
|
+
# number of requests to the client service and whether the requests
|
1596
|
+
# were faults or okay.
|
1597
|
+
# @return [Types::RequestImpactStatistics]
|
1598
|
+
#
|
1599
|
+
# @!attribute [rw] top_anomalous_services
|
1600
|
+
# The service during the event that is most impacted by the incident.
|
1601
|
+
# @return [Array<Types::AnomalousService>]
|
1602
|
+
#
|
1603
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/InsightEvent AWS API Documentation
|
1604
|
+
#
|
1605
|
+
class InsightEvent < Struct.new(
|
1606
|
+
:summary,
|
1607
|
+
:event_time,
|
1608
|
+
:client_request_impact_statistics,
|
1609
|
+
:root_cause_service_request_impact_statistics,
|
1610
|
+
:top_anomalous_services)
|
1611
|
+
SENSITIVE = []
|
1612
|
+
include Aws::Structure
|
1613
|
+
end
|
1614
|
+
|
1615
|
+
# The connection between two service in an insight impact graph.
|
1616
|
+
#
|
1617
|
+
# @!attribute [rw] reference_id
|
1618
|
+
# Identifier of the edge. Unique within a service map.
|
1619
|
+
# @return [Integer]
|
1620
|
+
#
|
1621
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/InsightImpactGraphEdge AWS API Documentation
|
1622
|
+
#
|
1623
|
+
class InsightImpactGraphEdge < Struct.new(
|
1624
|
+
:reference_id)
|
1625
|
+
SENSITIVE = []
|
1626
|
+
include Aws::Structure
|
1627
|
+
end
|
1628
|
+
|
1629
|
+
# Information about an application that processed requests, users that
|
1630
|
+
# made requests, or downstream services, resources, and applications
|
1631
|
+
# that an application used.
|
1632
|
+
#
|
1633
|
+
# @!attribute [rw] reference_id
|
1634
|
+
# Identifier for the service. Unique within the service map.
|
1635
|
+
# @return [Integer]
|
1636
|
+
#
|
1637
|
+
# @!attribute [rw] type
|
1638
|
+
# Identifier for the service. Unique within the service map.
|
1639
|
+
#
|
1640
|
+
# * Amazon Web Services Resource - The type of an Amazon Web Services
|
1641
|
+
# resource. For example, AWS::EC2::Instance for an application
|
1642
|
+
# running on Amazon EC2 or AWS::DynamoDB::Table for an Amazon
|
1643
|
+
# DynamoDB table that the application used.
|
1644
|
+
#
|
1645
|
+
# * Amazon Web Services Service - The type of an Amazon Web Services
|
1646
|
+
# service. For example, AWS::DynamoDB for downstream calls to Amazon
|
1647
|
+
# DynamoDB that didn't target a specific table.
|
1648
|
+
#
|
1649
|
+
# * Amazon Web Services Service - The type of an Amazon Web Services
|
1650
|
+
# service. For example, AWS::DynamoDB for downstream calls to Amazon
|
1651
|
+
# DynamoDB that didn't target a specific table.
|
1652
|
+
#
|
1653
|
+
# * remote - A downstream service of indeterminate type.
|
1654
|
+
# @return [String]
|
1655
|
+
#
|
1656
|
+
# @!attribute [rw] name
|
1657
|
+
# The canonical name of the service.
|
1658
|
+
# @return [String]
|
1659
|
+
#
|
1660
|
+
# @!attribute [rw] names
|
1661
|
+
# A list of names for the service, including the canonical name.
|
1662
|
+
# @return [Array<String>]
|
1663
|
+
#
|
1664
|
+
# @!attribute [rw] account_id
|
1665
|
+
# Identifier of the Amazon Web Services account in which the service
|
1666
|
+
# runs.
|
1667
|
+
# @return [String]
|
1668
|
+
#
|
1669
|
+
# @!attribute [rw] edges
|
1670
|
+
# Connections to downstream services.
|
1671
|
+
# @return [Array<Types::InsightImpactGraphEdge>]
|
1672
|
+
#
|
1673
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/InsightImpactGraphService AWS API Documentation
|
1674
|
+
#
|
1675
|
+
class InsightImpactGraphService < Struct.new(
|
1676
|
+
:reference_id,
|
1677
|
+
:type,
|
1678
|
+
:name,
|
1679
|
+
:names,
|
1680
|
+
:account_id,
|
1681
|
+
:edges)
|
1682
|
+
SENSITIVE = []
|
1683
|
+
include Aws::Structure
|
1684
|
+
end
|
1685
|
+
|
1686
|
+
# Information that describes an insight.
|
1687
|
+
#
|
1688
|
+
# @!attribute [rw] insight_id
|
1689
|
+
# The insights unique identifier.
|
1690
|
+
# @return [String]
|
1691
|
+
#
|
1692
|
+
# @!attribute [rw] group_arn
|
1693
|
+
# The Amazon Resource Name (ARN) of the group that the insight belongs
|
1694
|
+
# to.
|
1695
|
+
# @return [String]
|
1696
|
+
#
|
1697
|
+
# @!attribute [rw] group_name
|
1698
|
+
# The name of the group that the insight belongs to.
|
1699
|
+
# @return [String]
|
1700
|
+
#
|
1701
|
+
# @!attribute [rw] root_cause_service_id
|
1702
|
+
# @return [Types::ServiceId]
|
1703
|
+
#
|
1704
|
+
# @!attribute [rw] categories
|
1705
|
+
# Categories The categories that label and describe the type of
|
1706
|
+
# insight.
|
1707
|
+
# @return [Array<String>]
|
1708
|
+
#
|
1709
|
+
# @!attribute [rw] state
|
1710
|
+
# The current state of the insight.
|
1711
|
+
# @return [String]
|
1712
|
+
#
|
1713
|
+
# @!attribute [rw] start_time
|
1714
|
+
# The time, in Unix seconds, at which the insight began.
|
1715
|
+
# @return [Time]
|
1716
|
+
#
|
1717
|
+
# @!attribute [rw] end_time
|
1718
|
+
# The time, in Unix seconds, at which the insight ended.
|
1719
|
+
# @return [Time]
|
1720
|
+
#
|
1721
|
+
# @!attribute [rw] summary
|
1722
|
+
# A brief description of the insight.
|
1723
|
+
# @return [String]
|
1724
|
+
#
|
1725
|
+
# @!attribute [rw] client_request_impact_statistics
|
1726
|
+
# The impact statistics of the client side service. This includes the
|
1727
|
+
# number of requests to the client service and whether the requests
|
1728
|
+
# were faults or okay.
|
1729
|
+
# @return [Types::RequestImpactStatistics]
|
1730
|
+
#
|
1731
|
+
# @!attribute [rw] root_cause_service_request_impact_statistics
|
1732
|
+
# The impact statistics of the root cause service. This includes the
|
1733
|
+
# number of requests to the client service and whether the requests
|
1734
|
+
# were faults or okay.
|
1735
|
+
# @return [Types::RequestImpactStatistics]
|
1736
|
+
#
|
1737
|
+
# @!attribute [rw] top_anomalous_services
|
1738
|
+
# The service within the insight that is most impacted by the
|
1739
|
+
# incident.
|
1740
|
+
# @return [Array<Types::AnomalousService>]
|
1741
|
+
#
|
1742
|
+
# @!attribute [rw] last_update_time
|
1743
|
+
# The time, in Unix seconds, that the insight was last updated.
|
1744
|
+
# @return [Time]
|
1745
|
+
#
|
1746
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/InsightSummary AWS API Documentation
|
1747
|
+
#
|
1748
|
+
class InsightSummary < Struct.new(
|
1749
|
+
:insight_id,
|
1750
|
+
:group_arn,
|
1751
|
+
:group_name,
|
1752
|
+
:root_cause_service_id,
|
1753
|
+
:categories,
|
1754
|
+
:state,
|
1755
|
+
:start_time,
|
1756
|
+
:end_time,
|
1757
|
+
:summary,
|
1758
|
+
:client_request_impact_statistics,
|
1759
|
+
:root_cause_service_request_impact_statistics,
|
1760
|
+
:top_anomalous_services,
|
1761
|
+
:last_update_time)
|
1762
|
+
SENSITIVE = []
|
1763
|
+
include Aws::Structure
|
1764
|
+
end
|
1765
|
+
|
1766
|
+
# The structure containing configurations related to insights.
|
1767
|
+
#
|
1768
|
+
# @!attribute [rw] insights_enabled
|
1769
|
+
# Set the InsightsEnabled value to true to enable insights or false to
|
1770
|
+
# disable insights.
|
1771
|
+
# @return [Boolean]
|
1772
|
+
#
|
1773
|
+
# @!attribute [rw] notifications_enabled
|
1774
|
+
# Set the NotificationsEnabled value to true to enable insights
|
1775
|
+
# notifications. Notifications can only be enabled on a group with
|
1776
|
+
# InsightsEnabled set to true.
|
1777
|
+
# @return [Boolean]
|
1778
|
+
#
|
1779
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/InsightsConfiguration AWS API Documentation
|
1780
|
+
#
|
1781
|
+
class InsightsConfiguration < Struct.new(
|
1782
|
+
:insights_enabled,
|
1783
|
+
:notifications_enabled)
|
1784
|
+
SENSITIVE = []
|
1785
|
+
include Aws::Structure
|
1786
|
+
end
|
1787
|
+
|
1788
|
+
# A list of EC2 instance IDs corresponding to the segments in a trace.
|
1789
|
+
#
|
1790
|
+
# @!attribute [rw] id
|
1791
|
+
# The ID of a corresponding EC2 instance.
|
1792
|
+
# @return [String]
|
1793
|
+
#
|
1794
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/InstanceIdDetail AWS API Documentation
|
1795
|
+
#
|
1796
|
+
class InstanceIdDetail < Struct.new(
|
1797
|
+
:id)
|
1798
|
+
SENSITIVE = []
|
1799
|
+
include Aws::Structure
|
1800
|
+
end
|
1801
|
+
|
1802
|
+
# A policy revision id was provided which does not match the latest
|
1803
|
+
# policy revision. This exception is also if a policy revision id of 0
|
1804
|
+
# is provided via `PutResourcePolicy` and a policy with the same name
|
1805
|
+
# already exists.
|
1806
|
+
#
|
1807
|
+
# @!attribute [rw] message
|
1808
|
+
# @return [String]
|
1809
|
+
#
|
1810
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/InvalidPolicyRevisionIdException AWS API Documentation
|
1811
|
+
#
|
1812
|
+
class InvalidPolicyRevisionIdException < Struct.new(
|
1813
|
+
:message)
|
1814
|
+
SENSITIVE = []
|
1815
|
+
include Aws::Structure
|
1816
|
+
end
|
1817
|
+
|
1818
|
+
# The request is missing required parameters or has invalid parameters.
|
1819
|
+
#
|
1820
|
+
# @!attribute [rw] message
|
1821
|
+
# @return [String]
|
1822
|
+
#
|
1823
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/InvalidRequestException AWS API Documentation
|
1824
|
+
#
|
1825
|
+
class InvalidRequestException < Struct.new(
|
1826
|
+
:message)
|
1827
|
+
SENSITIVE = []
|
1828
|
+
include Aws::Structure
|
1829
|
+
end
|
1830
|
+
|
1831
|
+
# @!attribute [rw] next_token
|
1832
|
+
# Not currently supported.
|
1833
|
+
# @return [String]
|
1834
|
+
#
|
1835
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/ListResourcePoliciesRequest AWS API Documentation
|
1836
|
+
#
|
1837
|
+
class ListResourcePoliciesRequest < Struct.new(
|
1838
|
+
:next_token)
|
1839
|
+
SENSITIVE = []
|
1840
|
+
include Aws::Structure
|
1841
|
+
end
|
1842
|
+
|
1843
|
+
# @!attribute [rw] resource_policies
|
1844
|
+
# The list of resource policies in the target Amazon Web Services
|
1845
|
+
# account.
|
1846
|
+
# @return [Array<Types::ResourcePolicy>]
|
1847
|
+
#
|
1848
|
+
# @!attribute [rw] next_token
|
1849
|
+
# Pagination token. Not currently supported.
|
1850
|
+
# @return [String]
|
1851
|
+
#
|
1852
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/ListResourcePoliciesResult AWS API Documentation
|
1853
|
+
#
|
1854
|
+
class ListResourcePoliciesResult < Struct.new(
|
1855
|
+
:resource_policies,
|
1856
|
+
:next_token)
|
1857
|
+
SENSITIVE = []
|
1858
|
+
include Aws::Structure
|
1859
|
+
end
|
1860
|
+
|
1861
|
+
# @!attribute [rw] resource_arn
|
1862
|
+
# The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.
|
1863
|
+
# @return [String]
|
1864
|
+
#
|
1865
|
+
# @!attribute [rw] next_token
|
1866
|
+
# A pagination token. If multiple pages of results are returned, use
|
1867
|
+
# the `NextToken` value returned with the current page of results as
|
1868
|
+
# the value of this parameter to get the next page of results.
|
1869
|
+
# @return [String]
|
1870
|
+
#
|
1871
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/ListTagsForResourceRequest AWS API Documentation
|
1872
|
+
#
|
1873
|
+
class ListTagsForResourceRequest < Struct.new(
|
1874
|
+
:resource_arn,
|
1875
|
+
:next_token)
|
1876
|
+
SENSITIVE = []
|
1877
|
+
include Aws::Structure
|
1878
|
+
end
|
1879
|
+
|
1880
|
+
# @!attribute [rw] tags
|
1881
|
+
# A list of tags, as key and value pairs, that is associated with the
|
1882
|
+
# specified X-Ray group or sampling rule.
|
1883
|
+
# @return [Array<Types::Tag>]
|
1884
|
+
#
|
1885
|
+
# @!attribute [rw] next_token
|
1886
|
+
# A pagination token. If multiple pages of results are returned, use
|
1887
|
+
# the `NextToken` value returned with the current page of results to
|
1888
|
+
# get the next page of results.
|
1889
|
+
# @return [String]
|
1890
|
+
#
|
1891
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/ListTagsForResourceResponse AWS API Documentation
|
1892
|
+
#
|
1893
|
+
class ListTagsForResourceResponse < Struct.new(
|
1894
|
+
:tags,
|
1895
|
+
:next_token)
|
1896
|
+
SENSITIVE = []
|
1897
|
+
include Aws::Structure
|
1898
|
+
end
|
1899
|
+
|
1900
|
+
# The provided resource policy would prevent the caller of this request
|
1901
|
+
# from calling PutResourcePolicy in the future.
|
1902
|
+
#
|
1903
|
+
# @!attribute [rw] message
|
1904
|
+
# @return [String]
|
1905
|
+
#
|
1906
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/LockoutPreventionException AWS API Documentation
|
1907
|
+
#
|
1908
|
+
class LockoutPreventionException < Struct.new(
|
1909
|
+
:message)
|
1910
|
+
SENSITIVE = []
|
1911
|
+
include Aws::Structure
|
1912
|
+
end
|
1913
|
+
|
1914
|
+
# Invalid policy document provided in request.
|
1915
|
+
#
|
1916
|
+
# @!attribute [rw] message
|
1917
|
+
# @return [String]
|
1918
|
+
#
|
1919
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/MalformedPolicyDocumentException AWS API Documentation
|
1920
|
+
#
|
1921
|
+
class MalformedPolicyDocumentException < Struct.new(
|
1922
|
+
:message)
|
1923
|
+
SENSITIVE = []
|
1924
|
+
include Aws::Structure
|
1925
|
+
end
|
1926
|
+
|
1927
|
+
# Exceeded the maximum number of resource policies for a target Amazon
|
1928
|
+
# Web Services account.
|
1929
|
+
#
|
1930
|
+
# @!attribute [rw] message
|
1931
|
+
# @return [String]
|
1932
|
+
#
|
1933
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/PolicyCountLimitExceededException AWS API Documentation
|
1934
|
+
#
|
1935
|
+
class PolicyCountLimitExceededException < Struct.new(
|
1936
|
+
:message)
|
1937
|
+
SENSITIVE = []
|
1938
|
+
include Aws::Structure
|
1939
|
+
end
|
1940
|
+
|
1941
|
+
# Exceeded the maximum size for a resource policy.
|
1942
|
+
#
|
1943
|
+
# @!attribute [rw] message
|
1944
|
+
# @return [String]
|
1945
|
+
#
|
1946
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/PolicySizeLimitExceededException AWS API Documentation
|
1947
|
+
#
|
1948
|
+
class PolicySizeLimitExceededException < Struct.new(
|
1949
|
+
:message)
|
1950
|
+
SENSITIVE = []
|
1951
|
+
include Aws::Structure
|
1952
|
+
end
|
1953
|
+
|
1954
|
+
# @!attribute [rw] key_id
|
1955
|
+
# An Amazon Web Services KMS key in one of the following formats:
|
1956
|
+
#
|
1957
|
+
# * **Alias** - The name of the key. For example, `alias/MyKey`.
|
1958
|
+
#
|
1959
|
+
# * **Key ID** - The KMS key ID of the key. For example,
|
1960
|
+
# `ae4aa6d49-a4d8-9df9-a475-4ff6d7898456`. Amazon Web Services X-Ray
|
1961
|
+
# does not support asymmetric KMS keys.
|
1962
|
+
#
|
1963
|
+
# * **ARN** - The full Amazon Resource Name of the key ID or alias.
|
1964
|
+
# For example,
|
1965
|
+
# `arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456`.
|
1966
|
+
# Use this format to specify a key in a different account.
|
1967
|
+
#
|
1968
|
+
# Omit this key if you set `Type` to `NONE`.
|
1969
|
+
# @return [String]
|
1970
|
+
#
|
1971
|
+
# @!attribute [rw] type
|
1972
|
+
# The type of encryption. Set to `KMS` to use your own key for
|
1973
|
+
# encryption. Set to `NONE` for default encryption.
|
1974
|
+
# @return [String]
|
1975
|
+
#
|
1976
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/PutEncryptionConfigRequest AWS API Documentation
|
1977
|
+
#
|
1978
|
+
class PutEncryptionConfigRequest < Struct.new(
|
1979
|
+
:key_id,
|
1980
|
+
:type)
|
1981
|
+
SENSITIVE = []
|
1982
|
+
include Aws::Structure
|
1983
|
+
end
|
1984
|
+
|
1985
|
+
# @!attribute [rw] encryption_config
|
1986
|
+
# The new encryption configuration.
|
1987
|
+
# @return [Types::EncryptionConfig]
|
1988
|
+
#
|
1989
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/PutEncryptionConfigResult AWS API Documentation
|
1990
|
+
#
|
1991
|
+
class PutEncryptionConfigResult < Struct.new(
|
1992
|
+
:encryption_config)
|
1993
|
+
SENSITIVE = []
|
1994
|
+
include Aws::Structure
|
1995
|
+
end
|
1996
|
+
|
1997
|
+
# @!attribute [rw] policy_name
|
1998
|
+
# The name of the resource policy. Must be unique within a specific
|
1999
|
+
# Amazon Web Services account.
|
2000
|
+
# @return [String]
|
2001
|
+
#
|
2002
|
+
# @!attribute [rw] policy_document
|
2003
|
+
# The resource policy document, which can be up to 5kb in size.
|
2004
|
+
# @return [String]
|
2005
|
+
#
|
2006
|
+
# @!attribute [rw] policy_revision_id
|
2007
|
+
# Specifies a specific policy revision, to ensure an atomic create
|
2008
|
+
# operation. By default the resource policy is created if it does not
|
2009
|
+
# exist, or updated with an incremented revision id. The revision id
|
2010
|
+
# is unique to each policy in the account.
|
2011
|
+
#
|
2012
|
+
# If the policy revision id does not match the latest revision id, the
|
2013
|
+
# operation will fail with an `InvalidPolicyRevisionIdException`
|
2014
|
+
# exception. You can also provide a `PolicyRevisionId` of 0. In this
|
2015
|
+
# case, the operation will fail with an
|
2016
|
+
# `InvalidPolicyRevisionIdException` exception if a resource policy
|
2017
|
+
# with the same name already exists.
|
2018
|
+
# @return [String]
|
2019
|
+
#
|
2020
|
+
# @!attribute [rw] bypass_policy_lockout_check
|
2021
|
+
# A flag to indicate whether to bypass the resource policy lockout
|
2022
|
+
# safety check.
|
2023
|
+
#
|
2024
|
+
# Setting this value to true increases the risk that the policy
|
2025
|
+
# becomes unmanageable. Do not set this value to true
|
2026
|
+
# indiscriminately.
|
2027
|
+
#
|
2028
|
+
# Use this parameter only when you include a policy in the request and
|
2029
|
+
# you intend to prevent the principal that is making the request from
|
2030
|
+
# making a subsequent `PutResourcePolicy` request.
|
2031
|
+
#
|
2032
|
+
# The default value is false.
|
2033
|
+
# @return [Boolean]
|
2034
|
+
#
|
2035
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/PutResourcePolicyRequest AWS API Documentation
|
2036
|
+
#
|
2037
|
+
class PutResourcePolicyRequest < Struct.new(
|
2038
|
+
:policy_name,
|
2039
|
+
:policy_document,
|
2040
|
+
:policy_revision_id,
|
2041
|
+
:bypass_policy_lockout_check)
|
2042
|
+
SENSITIVE = []
|
2043
|
+
include Aws::Structure
|
2044
|
+
end
|
2045
|
+
|
2046
|
+
# @!attribute [rw] resource_policy
|
2047
|
+
# The resource policy document, as provided in the
|
2048
|
+
# `PutResourcePolicyRequest`.
|
2049
|
+
# @return [Types::ResourcePolicy]
|
2050
|
+
#
|
2051
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/PutResourcePolicyResult AWS API Documentation
|
2052
|
+
#
|
2053
|
+
class PutResourcePolicyResult < Struct.new(
|
2054
|
+
:resource_policy)
|
2055
|
+
SENSITIVE = []
|
2056
|
+
include Aws::Structure
|
2057
|
+
end
|
2058
|
+
|
2059
|
+
# @!attribute [rw] telemetry_records
|
2060
|
+
# @return [Array<Types::TelemetryRecord>]
|
2061
|
+
#
|
2062
|
+
# @!attribute [rw] ec2_instance_id
|
2063
|
+
# @return [String]
|
2064
|
+
#
|
2065
|
+
# @!attribute [rw] hostname
|
2066
|
+
# @return [String]
|
2067
|
+
#
|
2068
|
+
# @!attribute [rw] resource_arn
|
2069
|
+
# @return [String]
|
2070
|
+
#
|
2071
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/PutTelemetryRecordsRequest AWS API Documentation
|
2072
|
+
#
|
2073
|
+
class PutTelemetryRecordsRequest < Struct.new(
|
2074
|
+
:telemetry_records,
|
2075
|
+
:ec2_instance_id,
|
2076
|
+
:hostname,
|
2077
|
+
:resource_arn)
|
2078
|
+
SENSITIVE = []
|
2079
|
+
include Aws::Structure
|
2080
|
+
end
|
2081
|
+
|
2082
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/PutTelemetryRecordsResult AWS API Documentation
|
2083
|
+
#
|
2084
|
+
class PutTelemetryRecordsResult < Aws::EmptyStructure; end
|
2085
|
+
|
2086
|
+
# @!attribute [rw] trace_segment_documents
|
2087
|
+
# A string containing a JSON document defining one or more segments or
|
2088
|
+
# subsegments.
|
2089
|
+
# @return [Array<String>]
|
2090
|
+
#
|
2091
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/PutTraceSegmentsRequest AWS API Documentation
|
2092
|
+
#
|
2093
|
+
class PutTraceSegmentsRequest < Struct.new(
|
2094
|
+
:trace_segment_documents)
|
2095
|
+
SENSITIVE = []
|
2096
|
+
include Aws::Structure
|
2097
|
+
end
|
2098
|
+
|
2099
|
+
# @!attribute [rw] unprocessed_trace_segments
|
2100
|
+
# Segments that failed processing.
|
2101
|
+
# @return [Array<Types::UnprocessedTraceSegment>]
|
2102
|
+
#
|
2103
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/PutTraceSegmentsResult AWS API Documentation
|
2104
|
+
#
|
2105
|
+
class PutTraceSegmentsResult < Struct.new(
|
2106
|
+
:unprocessed_trace_segments)
|
2107
|
+
SENSITIVE = []
|
2108
|
+
include Aws::Structure
|
2109
|
+
end
|
2110
|
+
|
2111
|
+
# Statistics that describe how the incident has impacted a service.
|
2112
|
+
#
|
2113
|
+
# @!attribute [rw] fault_count
|
2114
|
+
# The number of requests that have resulted in a fault,
|
2115
|
+
# @return [Integer]
|
2116
|
+
#
|
2117
|
+
# @!attribute [rw] ok_count
|
2118
|
+
# The number of successful requests.
|
2119
|
+
# @return [Integer]
|
2120
|
+
#
|
2121
|
+
# @!attribute [rw] total_count
|
2122
|
+
# The total number of requests to the service.
|
2123
|
+
# @return [Integer]
|
2124
|
+
#
|
2125
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/RequestImpactStatistics AWS API Documentation
|
2126
|
+
#
|
2127
|
+
class RequestImpactStatistics < Struct.new(
|
2128
|
+
:fault_count,
|
2129
|
+
:ok_count,
|
2130
|
+
:total_count)
|
2131
|
+
SENSITIVE = []
|
2132
|
+
include Aws::Structure
|
2133
|
+
end
|
2134
|
+
|
2135
|
+
# A list of resources ARNs corresponding to the segments in a trace.
|
2136
|
+
#
|
2137
|
+
# @!attribute [rw] arn
|
2138
|
+
# The ARN of a corresponding resource.
|
2139
|
+
# @return [String]
|
2140
|
+
#
|
2141
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/ResourceARNDetail AWS API Documentation
|
2142
|
+
#
|
2143
|
+
class ResourceARNDetail < Struct.new(
|
2144
|
+
:arn)
|
2145
|
+
SENSITIVE = []
|
2146
|
+
include Aws::Structure
|
2147
|
+
end
|
2148
|
+
|
2149
|
+
# The resource was not found. Verify that the name or Amazon Resource
|
2150
|
+
# Name (ARN) of the resource is correct.
|
2151
|
+
#
|
2152
|
+
# @!attribute [rw] message
|
2153
|
+
# @return [String]
|
2154
|
+
#
|
2155
|
+
# @!attribute [rw] resource_name
|
729
2156
|
# @return [String]
|
730
2157
|
#
|
731
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/
|
2158
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/ResourceNotFoundException AWS API Documentation
|
732
2159
|
#
|
733
|
-
class
|
734
|
-
:
|
735
|
-
:
|
736
|
-
|
737
|
-
:user_agent,
|
738
|
-
:client_ip)
|
2160
|
+
class ResourceNotFoundException < Struct.new(
|
2161
|
+
:message,
|
2162
|
+
:resource_name)
|
2163
|
+
SENSITIVE = []
|
739
2164
|
include Aws::Structure
|
740
2165
|
end
|
741
2166
|
|
742
|
-
#
|
743
|
-
#
|
2167
|
+
# A resource policy grants one or more Amazon Web Services services and
|
2168
|
+
# accounts permissions to access X-Ray. Each resource policy is
|
2169
|
+
# associated with a specific Amazon Web Services account.
|
744
2170
|
#
|
745
|
-
#
|
746
|
-
#
|
747
|
-
#
|
748
|
-
#
|
2171
|
+
# @!attribute [rw] policy_name
|
2172
|
+
# The name of the resource policy. Must be unique within a specific
|
2173
|
+
# Amazon Web Services account.
|
2174
|
+
# @return [String]
|
749
2175
|
#
|
750
|
-
# @!attribute [rw]
|
751
|
-
#
|
752
|
-
#
|
2176
|
+
# @!attribute [rw] policy_document
|
2177
|
+
# The resource policy document, which can be up to 5kb in size.
|
2178
|
+
# @return [String]
|
753
2179
|
#
|
754
|
-
#
|
2180
|
+
# @!attribute [rw] policy_revision_id
|
2181
|
+
# Returns the current policy revision id for this policy name.
|
2182
|
+
# @return [String]
|
755
2183
|
#
|
756
|
-
#
|
757
|
-
#
|
2184
|
+
# @!attribute [rw] last_updated_time
|
2185
|
+
# When the policy was last updated, in Unix time seconds.
|
2186
|
+
# @return [Time]
|
758
2187
|
#
|
759
|
-
#
|
760
|
-
# For example,
|
761
|
-
# `arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456`.
|
762
|
-
# Use this format to specify a key in a different account.
|
2188
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/ResourcePolicy AWS API Documentation
|
763
2189
|
#
|
764
|
-
|
765
|
-
|
2190
|
+
class ResourcePolicy < Struct.new(
|
2191
|
+
:policy_name,
|
2192
|
+
:policy_document,
|
2193
|
+
:policy_revision_id,
|
2194
|
+
:last_updated_time)
|
2195
|
+
SENSITIVE = []
|
2196
|
+
include Aws::Structure
|
2197
|
+
end
|
2198
|
+
|
2199
|
+
# The root cause information for a response time warning.
|
766
2200
|
#
|
767
|
-
# @!attribute [rw]
|
768
|
-
#
|
769
|
-
#
|
770
|
-
# @return [
|
2201
|
+
# @!attribute [rw] services
|
2202
|
+
# A list of corresponding services. A service identifies a segment and
|
2203
|
+
# contains a name, account ID, type, and inferred flag.
|
2204
|
+
# @return [Array<Types::ResponseTimeRootCauseService>]
|
771
2205
|
#
|
772
|
-
#
|
2206
|
+
# @!attribute [rw] client_impacting
|
2207
|
+
# A flag that denotes that the root cause impacts the trace client.
|
2208
|
+
# @return [Boolean]
|
773
2209
|
#
|
774
|
-
|
775
|
-
|
776
|
-
|
2210
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/ResponseTimeRootCause AWS API Documentation
|
2211
|
+
#
|
2212
|
+
class ResponseTimeRootCause < Struct.new(
|
2213
|
+
:services,
|
2214
|
+
:client_impacting)
|
2215
|
+
SENSITIVE = []
|
777
2216
|
include Aws::Structure
|
778
2217
|
end
|
779
2218
|
|
780
|
-
#
|
781
|
-
#
|
782
|
-
# @return [Types::EncryptionConfig]
|
2219
|
+
# A collection of segments and corresponding subsegments associated to a
|
2220
|
+
# response time warning.
|
783
2221
|
#
|
784
|
-
#
|
2222
|
+
# @!attribute [rw] name
|
2223
|
+
# The name of the entity.
|
2224
|
+
# @return [String]
|
785
2225
|
#
|
786
|
-
|
787
|
-
|
2226
|
+
# @!attribute [rw] coverage
|
2227
|
+
# The type and messages of the exceptions.
|
2228
|
+
# @return [Float]
|
2229
|
+
#
|
2230
|
+
# @!attribute [rw] remote
|
2231
|
+
# A flag that denotes a remote subsegment.
|
2232
|
+
# @return [Boolean]
|
2233
|
+
#
|
2234
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/ResponseTimeRootCauseEntity AWS API Documentation
|
2235
|
+
#
|
2236
|
+
class ResponseTimeRootCauseEntity < Struct.new(
|
2237
|
+
:name,
|
2238
|
+
:coverage,
|
2239
|
+
:remote)
|
2240
|
+
SENSITIVE = []
|
788
2241
|
include Aws::Structure
|
789
2242
|
end
|
790
2243
|
|
791
|
-
#
|
792
|
-
#
|
793
|
-
#
|
794
|
-
# {
|
795
|
-
# telemetry_records: [ # required
|
796
|
-
# {
|
797
|
-
# timestamp: Time.now, # required
|
798
|
-
# segments_received_count: 1,
|
799
|
-
# segments_sent_count: 1,
|
800
|
-
# segments_spillover_count: 1,
|
801
|
-
# segments_rejected_count: 1,
|
802
|
-
# backend_connection_errors: {
|
803
|
-
# timeout_count: 1,
|
804
|
-
# connection_refused_count: 1,
|
805
|
-
# http_code_4_xx_count: 1,
|
806
|
-
# http_code_5_xx_count: 1,
|
807
|
-
# unknown_host_count: 1,
|
808
|
-
# other_count: 1,
|
809
|
-
# },
|
810
|
-
# },
|
811
|
-
# ],
|
812
|
-
# ec2_instance_id: "EC2InstanceId",
|
813
|
-
# hostname: "Hostname",
|
814
|
-
# resource_arn: "ResourceARN",
|
815
|
-
# }
|
816
|
-
#
|
817
|
-
# @!attribute [rw] telemetry_records
|
818
|
-
# @return [Array<Types::TelemetryRecord>]
|
2244
|
+
# A collection of fields identifying the service in a response time
|
2245
|
+
# warning.
|
819
2246
|
#
|
820
|
-
# @!attribute [rw]
|
2247
|
+
# @!attribute [rw] name
|
2248
|
+
# The service name.
|
821
2249
|
# @return [String]
|
822
2250
|
#
|
823
|
-
# @!attribute [rw]
|
2251
|
+
# @!attribute [rw] names
|
2252
|
+
# A collection of associated service names.
|
2253
|
+
# @return [Array<String>]
|
2254
|
+
#
|
2255
|
+
# @!attribute [rw] type
|
2256
|
+
# The type associated to the service.
|
824
2257
|
# @return [String]
|
825
2258
|
#
|
826
|
-
# @!attribute [rw]
|
2259
|
+
# @!attribute [rw] account_id
|
2260
|
+
# The account ID associated to the service.
|
827
2261
|
# @return [String]
|
828
2262
|
#
|
829
|
-
#
|
2263
|
+
# @!attribute [rw] entity_path
|
2264
|
+
# The path of root cause entities found on the service.
|
2265
|
+
# @return [Array<Types::ResponseTimeRootCauseEntity>]
|
830
2266
|
#
|
831
|
-
|
832
|
-
|
833
|
-
|
834
|
-
|
835
|
-
|
2267
|
+
# @!attribute [rw] inferred
|
2268
|
+
# A Boolean value indicating if the service is inferred from the
|
2269
|
+
# trace.
|
2270
|
+
# @return [Boolean]
|
2271
|
+
#
|
2272
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/ResponseTimeRootCauseService AWS API Documentation
|
2273
|
+
#
|
2274
|
+
class ResponseTimeRootCauseService < Struct.new(
|
2275
|
+
:name,
|
2276
|
+
:names,
|
2277
|
+
:type,
|
2278
|
+
:account_id,
|
2279
|
+
:entity_path,
|
2280
|
+
:inferred)
|
2281
|
+
SENSITIVE = []
|
836
2282
|
include Aws::Structure
|
837
2283
|
end
|
838
2284
|
|
839
|
-
#
|
840
|
-
#
|
841
|
-
class PutTelemetryRecordsResult < Aws::EmptyStructure; end
|
842
|
-
|
843
|
-
# @note When making an API call, you may pass PutTraceSegmentsRequest
|
844
|
-
# data as a hash:
|
2285
|
+
# The exception associated with a root cause.
|
845
2286
|
#
|
846
|
-
#
|
847
|
-
#
|
848
|
-
#
|
2287
|
+
# @!attribute [rw] name
|
2288
|
+
# The name of the exception.
|
2289
|
+
# @return [String]
|
849
2290
|
#
|
850
|
-
# @!attribute [rw]
|
851
|
-
#
|
852
|
-
#
|
853
|
-
# @return [Array<String>]
|
2291
|
+
# @!attribute [rw] message
|
2292
|
+
# The message of the exception.
|
2293
|
+
# @return [String]
|
854
2294
|
#
|
855
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/
|
2295
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/RootCauseException AWS API Documentation
|
856
2296
|
#
|
857
|
-
class
|
858
|
-
:
|
2297
|
+
class RootCauseException < Struct.new(
|
2298
|
+
:name,
|
2299
|
+
:message)
|
2300
|
+
SENSITIVE = []
|
859
2301
|
include Aws::Structure
|
860
2302
|
end
|
861
2303
|
|
862
|
-
#
|
863
|
-
# Segments that failed processing.
|
864
|
-
# @return [Array<Types::UnprocessedTraceSegment>]
|
2304
|
+
# You have reached the maximum number of sampling rules.
|
865
2305
|
#
|
866
|
-
#
|
2306
|
+
# @!attribute [rw] message
|
2307
|
+
# @return [String]
|
867
2308
|
#
|
868
|
-
|
869
|
-
|
2309
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/RuleLimitExceededException AWS API Documentation
|
2310
|
+
#
|
2311
|
+
class RuleLimitExceededException < Struct.new(
|
2312
|
+
:message)
|
2313
|
+
SENSITIVE = []
|
870
2314
|
include Aws::Structure
|
871
2315
|
end
|
872
2316
|
|
@@ -875,27 +2319,6 @@ module Aws::XRay
|
|
875
2319
|
# properties of a request. The service can ignore rules that don't
|
876
2320
|
# match its properties.
|
877
2321
|
#
|
878
|
-
# @note When making an API call, you may pass SamplingRule
|
879
|
-
# data as a hash:
|
880
|
-
#
|
881
|
-
# {
|
882
|
-
# rule_name: "RuleName",
|
883
|
-
# rule_arn: "String",
|
884
|
-
# resource_arn: "ResourceARN", # required
|
885
|
-
# priority: 1, # required
|
886
|
-
# fixed_rate: 1.0, # required
|
887
|
-
# reservoir_size: 1, # required
|
888
|
-
# service_name: "ServiceName", # required
|
889
|
-
# service_type: "ServiceType", # required
|
890
|
-
# host: "Host", # required
|
891
|
-
# http_method: "HTTPMethod", # required
|
892
|
-
# url_path: "URLPath", # required
|
893
|
-
# version: 1, # required
|
894
|
-
# attributes: {
|
895
|
-
# "AttributeKey" => "AttributeValue",
|
896
|
-
# },
|
897
|
-
# }
|
898
|
-
#
|
899
2322
|
# @!attribute [rw] rule_name
|
900
2323
|
# The name of the sampling rule. Specify a rule by either name or ARN,
|
901
2324
|
# but not both.
|
@@ -907,7 +2330,8 @@ module Aws::XRay
|
|
907
2330
|
# @return [String]
|
908
2331
|
#
|
909
2332
|
# @!attribute [rw] resource_arn
|
910
|
-
# Matches the ARN of the
|
2333
|
+
# Matches the ARN of the Amazon Web Services resource on which the
|
2334
|
+
# service runs.
|
911
2335
|
# @return [String]
|
912
2336
|
#
|
913
2337
|
# @!attribute [rw] priority
|
@@ -971,10 +2395,15 @@ module Aws::XRay
|
|
971
2395
|
:url_path,
|
972
2396
|
:version,
|
973
2397
|
:attributes)
|
2398
|
+
SENSITIVE = []
|
974
2399
|
include Aws::Structure
|
975
2400
|
end
|
976
2401
|
|
977
|
-
# A SamplingRule and its metadata.
|
2402
|
+
# A [SamplingRule][1] and its metadata.
|
2403
|
+
#
|
2404
|
+
#
|
2405
|
+
#
|
2406
|
+
# [1]: https://docs.aws.amazon.com/xray/latest/api/API_SamplingRule.html
|
978
2407
|
#
|
979
2408
|
# @!attribute [rw] sampling_rule
|
980
2409
|
# The sampling rule.
|
@@ -994,31 +2423,12 @@ module Aws::XRay
|
|
994
2423
|
:sampling_rule,
|
995
2424
|
:created_at,
|
996
2425
|
:modified_at)
|
2426
|
+
SENSITIVE = []
|
997
2427
|
include Aws::Structure
|
998
2428
|
end
|
999
2429
|
|
1000
2430
|
# A document specifying changes to a sampling rule's configuration.
|
1001
2431
|
#
|
1002
|
-
# @note When making an API call, you may pass SamplingRuleUpdate
|
1003
|
-
# data as a hash:
|
1004
|
-
#
|
1005
|
-
# {
|
1006
|
-
# rule_name: "RuleName",
|
1007
|
-
# rule_arn: "String",
|
1008
|
-
# resource_arn: "ResourceARN",
|
1009
|
-
# priority: 1,
|
1010
|
-
# fixed_rate: 1.0,
|
1011
|
-
# reservoir_size: 1,
|
1012
|
-
# host: "Host",
|
1013
|
-
# service_name: "ServiceName",
|
1014
|
-
# service_type: "ServiceType",
|
1015
|
-
# http_method: "HTTPMethod",
|
1016
|
-
# url_path: "URLPath",
|
1017
|
-
# attributes: {
|
1018
|
-
# "AttributeKey" => "AttributeValue",
|
1019
|
-
# },
|
1020
|
-
# }
|
1021
|
-
#
|
1022
2432
|
# @!attribute [rw] rule_name
|
1023
2433
|
# The name of the sampling rule. Specify a rule by either name or ARN,
|
1024
2434
|
# but not both.
|
@@ -1030,7 +2440,8 @@ module Aws::XRay
|
|
1030
2440
|
# @return [String]
|
1031
2441
|
#
|
1032
2442
|
# @!attribute [rw] resource_arn
|
1033
|
-
# Matches the ARN of the
|
2443
|
+
# Matches the ARN of the Amazon Web Services resource on which the
|
2444
|
+
# service runs.
|
1034
2445
|
# @return [String]
|
1035
2446
|
#
|
1036
2447
|
# @!attribute [rw] priority
|
@@ -1089,11 +2500,12 @@ module Aws::XRay
|
|
1089
2500
|
:http_method,
|
1090
2501
|
:url_path,
|
1091
2502
|
:attributes)
|
2503
|
+
SENSITIVE = []
|
1092
2504
|
include Aws::Structure
|
1093
2505
|
end
|
1094
2506
|
|
1095
2507
|
# Aggregated request sampling data for a sampling rule across all
|
1096
|
-
# services for a 10
|
2508
|
+
# services for a 10-second window.
|
1097
2509
|
#
|
1098
2510
|
# @!attribute [rw] rule_name
|
1099
2511
|
# The name of the sampling rule.
|
@@ -1123,24 +2535,17 @@ module Aws::XRay
|
|
1123
2535
|
:request_count,
|
1124
2536
|
:borrow_count,
|
1125
2537
|
:sampled_count)
|
2538
|
+
SENSITIVE = []
|
1126
2539
|
include Aws::Structure
|
1127
2540
|
end
|
1128
2541
|
|
1129
2542
|
# Request sampling results for a single rule from a service. Results are
|
1130
2543
|
# for the last 10 seconds unless the service has been assigned a longer
|
1131
|
-
# reporting interval after a previous call to GetSamplingTargets.
|
2544
|
+
# reporting interval after a previous call to [GetSamplingTargets][1].
|
2545
|
+
#
|
1132
2546
|
#
|
1133
|
-
# @note When making an API call, you may pass SamplingStatisticsDocument
|
1134
|
-
# data as a hash:
|
1135
2547
|
#
|
1136
|
-
#
|
1137
|
-
# rule_name: "RuleName", # required
|
1138
|
-
# client_id: "ClientID", # required
|
1139
|
-
# timestamp: Time.now, # required
|
1140
|
-
# request_count: 1, # required
|
1141
|
-
# sampled_count: 1, # required
|
1142
|
-
# borrow_count: 1,
|
1143
|
-
# }
|
2548
|
+
# [1]: https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html
|
1144
2549
|
#
|
1145
2550
|
# @!attribute [rw] rule_name
|
1146
2551
|
# The name of the sampling rule.
|
@@ -1175,13 +2580,37 @@ module Aws::XRay
|
|
1175
2580
|
:request_count,
|
1176
2581
|
:sampled_count,
|
1177
2582
|
:borrow_count)
|
2583
|
+
SENSITIVE = []
|
2584
|
+
include Aws::Structure
|
2585
|
+
end
|
2586
|
+
|
2587
|
+
# The name and value of a sampling rule to apply to a trace summary.
|
2588
|
+
#
|
2589
|
+
# @!attribute [rw] name
|
2590
|
+
# The name of a sampling rule.
|
2591
|
+
# @return [String]
|
2592
|
+
#
|
2593
|
+
# @!attribute [rw] value
|
2594
|
+
# The value of a sampling rule.
|
2595
|
+
# @return [Float]
|
2596
|
+
#
|
2597
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/SamplingStrategy AWS API Documentation
|
2598
|
+
#
|
2599
|
+
class SamplingStrategy < Struct.new(
|
2600
|
+
:name,
|
2601
|
+
:value)
|
2602
|
+
SENSITIVE = []
|
1178
2603
|
include Aws::Structure
|
1179
2604
|
end
|
1180
2605
|
|
1181
2606
|
# Temporary changes to a sampling rule configuration. To meet the global
|
1182
2607
|
# sampling target for a rule, X-Ray calculates a new reservoir for each
|
1183
2608
|
# service based on the recent sampling results of all services that
|
1184
|
-
# called GetSamplingTargets.
|
2609
|
+
# called [GetSamplingTargets][1].
|
2610
|
+
#
|
2611
|
+
#
|
2612
|
+
#
|
2613
|
+
# [1]: https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html
|
1185
2614
|
#
|
1186
2615
|
# @!attribute [rw] rule_name
|
1187
2616
|
# The name of the sampling rule.
|
@@ -1193,7 +2622,8 @@ module Aws::XRay
|
|
1193
2622
|
# @return [Float]
|
1194
2623
|
#
|
1195
2624
|
# @!attribute [rw] reservoir_quota
|
1196
|
-
# The number of requests per second that X-Ray allocated this
|
2625
|
+
# The number of requests per second that X-Ray allocated for this
|
2626
|
+
# service.
|
1197
2627
|
# @return [Integer]
|
1198
2628
|
#
|
1199
2629
|
# @!attribute [rw] reservoir_quota_ttl
|
@@ -1213,20 +2643,24 @@ module Aws::XRay
|
|
1213
2643
|
:reservoir_quota,
|
1214
2644
|
:reservoir_quota_ttl,
|
1215
2645
|
:interval)
|
2646
|
+
SENSITIVE = []
|
1216
2647
|
include Aws::Structure
|
1217
2648
|
end
|
1218
2649
|
|
1219
2650
|
# A segment from a trace that has been ingested by the X-Ray service.
|
1220
2651
|
# The segment can be compiled from documents uploaded with
|
1221
|
-
# PutTraceSegments, or an `inferred` segment for a downstream
|
1222
|
-
# generated from a subsegment sent by the service that called
|
2652
|
+
# [PutTraceSegments][1], or an `inferred` segment for a downstream
|
2653
|
+
# service, generated from a subsegment sent by the service that called
|
2654
|
+
# it.
|
1223
2655
|
#
|
1224
|
-
# For the full segment document schema, see [
|
1225
|
-
# Documents][
|
2656
|
+
# For the full segment document schema, see [Amazon Web Services X-Ray
|
2657
|
+
# Segment Documents][2] in the *Amazon Web Services X-Ray Developer
|
2658
|
+
# Guide*.
|
1226
2659
|
#
|
1227
2660
|
#
|
1228
2661
|
#
|
1229
|
-
# [1]: https://docs.aws.amazon.com/xray/latest/
|
2662
|
+
# [1]: https://docs.aws.amazon.com/xray/latest/api/API_PutTraceSegments.html
|
2663
|
+
# [2]: https://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html
|
1230
2664
|
#
|
1231
2665
|
# @!attribute [rw] id
|
1232
2666
|
# The segment's ID.
|
@@ -1241,12 +2675,13 @@ module Aws::XRay
|
|
1241
2675
|
class Segment < Struct.new(
|
1242
2676
|
:id,
|
1243
2677
|
:document)
|
2678
|
+
SENSITIVE = []
|
1244
2679
|
include Aws::Structure
|
1245
2680
|
end
|
1246
2681
|
|
1247
2682
|
# Information about an application that processed requests, users that
|
1248
|
-
# made requests, or downstream services, resources and applications
|
1249
|
-
# an application used.
|
2683
|
+
# made requests, or downstream services, resources, and applications
|
2684
|
+
# that an application used.
|
1250
2685
|
#
|
1251
2686
|
# @!attribute [rw] reference_id
|
1252
2687
|
# Identifier for the service. Unique within the service map.
|
@@ -1266,20 +2701,21 @@ module Aws::XRay
|
|
1266
2701
|
# @return [Boolean]
|
1267
2702
|
#
|
1268
2703
|
# @!attribute [rw] account_id
|
1269
|
-
# Identifier of the
|
2704
|
+
# Identifier of the Amazon Web Services account in which the service
|
2705
|
+
# runs.
|
1270
2706
|
# @return [String]
|
1271
2707
|
#
|
1272
2708
|
# @!attribute [rw] type
|
1273
2709
|
# The type of service.
|
1274
2710
|
#
|
1275
|
-
# *
|
1276
|
-
# `AWS::EC2::Instance` for
|
1277
|
-
# `AWS::DynamoDB::Table` for an Amazon
|
1278
|
-
# application used.
|
2711
|
+
# * Amazon Web Services Resource - The type of an Amazon Web Services
|
2712
|
+
# resource. For example, `AWS::EC2::Instance` for an application
|
2713
|
+
# running on Amazon EC2 or `AWS::DynamoDB::Table` for an Amazon
|
2714
|
+
# DynamoDB table that the application used.
|
1279
2715
|
#
|
1280
|
-
# *
|
1281
|
-
# `AWS::DynamoDB` for downstream calls to
|
1282
|
-
# didn't target a specific table.
|
2716
|
+
# * Amazon Web Services Service - The type of an Amazon Web Services
|
2717
|
+
# service. For example, `AWS::DynamoDB` for downstream calls to
|
2718
|
+
# Amazon DynamoDB that didn't target a specific table.
|
1283
2719
|
#
|
1284
2720
|
# * `client` - Represents the clients that sent requests to a root
|
1285
2721
|
# service.
|
@@ -1331,6 +2767,7 @@ module Aws::XRay
|
|
1331
2767
|
:summary_statistics,
|
1332
2768
|
:duration_histogram,
|
1333
2769
|
:response_time_histogram)
|
2770
|
+
SENSITIVE = []
|
1334
2771
|
include Aws::Structure
|
1335
2772
|
end
|
1336
2773
|
|
@@ -1353,6 +2790,7 @@ module Aws::XRay
|
|
1353
2790
|
:names,
|
1354
2791
|
:account_id,
|
1355
2792
|
:type)
|
2793
|
+
SENSITIVE = []
|
1356
2794
|
include Aws::Structure
|
1357
2795
|
end
|
1358
2796
|
|
@@ -1389,28 +2827,95 @@ module Aws::XRay
|
|
1389
2827
|
:fault_statistics,
|
1390
2828
|
:total_count,
|
1391
2829
|
:total_response_time)
|
2830
|
+
SENSITIVE = []
|
2831
|
+
include Aws::Structure
|
2832
|
+
end
|
2833
|
+
|
2834
|
+
# A map that contains tag keys and tag values to attach to an Amazon Web
|
2835
|
+
# Services X-Ray group or sampling rule. For more information about ways
|
2836
|
+
# to use tags, see [Tagging Amazon Web Services resources][1] in the
|
2837
|
+
# *Amazon Web Services General Reference*.
|
2838
|
+
#
|
2839
|
+
# The following restrictions apply to tags:
|
2840
|
+
#
|
2841
|
+
# * Maximum number of user-applied tags per resource: 50
|
2842
|
+
#
|
2843
|
+
# * Tag keys and values are case sensitive.
|
2844
|
+
#
|
2845
|
+
# * Don't use `aws:` as a prefix for keys; it's reserved for Amazon
|
2846
|
+
# Web Services use. You cannot edit or delete system tags.
|
2847
|
+
#
|
2848
|
+
#
|
2849
|
+
#
|
2850
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
2851
|
+
#
|
2852
|
+
# @!attribute [rw] key
|
2853
|
+
# A tag key, such as `Stage` or `Name`. A tag key cannot be empty. The
|
2854
|
+
# key can be a maximum of 128 characters, and can contain only Unicode
|
2855
|
+
# letters, numbers, or separators, or the following special
|
2856
|
+
# characters: `+ - = . _ : /`
|
2857
|
+
# @return [String]
|
2858
|
+
#
|
2859
|
+
# @!attribute [rw] value
|
2860
|
+
# An optional tag value, such as `Production` or `test-only`. The
|
2861
|
+
# value can be a maximum of 255 characters, and contain only Unicode
|
2862
|
+
# letters, numbers, or separators, or the following special
|
2863
|
+
# characters: `+ - = . _ : /`
|
2864
|
+
# @return [String]
|
2865
|
+
#
|
2866
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/Tag AWS API Documentation
|
2867
|
+
#
|
2868
|
+
class Tag < Struct.new(
|
2869
|
+
:key,
|
2870
|
+
:value)
|
2871
|
+
SENSITIVE = []
|
1392
2872
|
include Aws::Structure
|
1393
2873
|
end
|
1394
2874
|
|
1395
|
-
#
|
1396
|
-
#
|
2875
|
+
# @!attribute [rw] resource_arn
|
2876
|
+
# The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.
|
2877
|
+
# @return [String]
|
1397
2878
|
#
|
1398
|
-
#
|
1399
|
-
#
|
1400
|
-
#
|
1401
|
-
#
|
1402
|
-
#
|
1403
|
-
#
|
1404
|
-
#
|
1405
|
-
#
|
1406
|
-
#
|
1407
|
-
#
|
1408
|
-
#
|
1409
|
-
#
|
1410
|
-
#
|
1411
|
-
#
|
1412
|
-
#
|
2879
|
+
# @!attribute [rw] tags
|
2880
|
+
# A map that contains one or more tag keys and tag values to attach to
|
2881
|
+
# an X-Ray group or sampling rule. For more information about ways to
|
2882
|
+
# use tags, see [Tagging Amazon Web Services resources][1] in the
|
2883
|
+
# *Amazon Web Services General Reference*.
|
2884
|
+
#
|
2885
|
+
# The following restrictions apply to tags:
|
2886
|
+
#
|
2887
|
+
# * Maximum number of user-applied tags per resource: 50
|
2888
|
+
#
|
2889
|
+
# * Maximum tag key length: 128 Unicode characters
|
2890
|
+
#
|
2891
|
+
# * Maximum tag value length: 256 Unicode characters
|
2892
|
+
#
|
2893
|
+
# * Valid values for key and value: a-z, A-Z, 0-9, space, and the
|
2894
|
+
# following characters: \_ . : / = + - and @
|
2895
|
+
#
|
2896
|
+
# * Tag keys and values are case sensitive.
|
2897
|
+
#
|
2898
|
+
# * Don't use `aws:` as a prefix for keys; it's reserved for Amazon
|
2899
|
+
# Web Services use. You cannot edit or delete system tags.
|
2900
|
+
#
|
2901
|
+
#
|
2902
|
+
#
|
2903
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
2904
|
+
# @return [Array<Types::Tag>]
|
2905
|
+
#
|
2906
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/TagResourceRequest AWS API Documentation
|
2907
|
+
#
|
2908
|
+
class TagResourceRequest < Struct.new(
|
2909
|
+
:resource_arn,
|
2910
|
+
:tags)
|
2911
|
+
SENSITIVE = []
|
2912
|
+
include Aws::Structure
|
2913
|
+
end
|
2914
|
+
|
2915
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/TagResourceResponse AWS API Documentation
|
1413
2916
|
#
|
2917
|
+
class TagResourceResponse < Aws::EmptyStructure; end
|
2918
|
+
|
1414
2919
|
# @!attribute [rw] timestamp
|
1415
2920
|
# @return [Time]
|
1416
2921
|
#
|
@@ -1438,6 +2943,72 @@ module Aws::XRay
|
|
1438
2943
|
:segments_spillover_count,
|
1439
2944
|
:segments_rejected_count,
|
1440
2945
|
:backend_connection_errors)
|
2946
|
+
SENSITIVE = []
|
2947
|
+
include Aws::Structure
|
2948
|
+
end
|
2949
|
+
|
2950
|
+
# The request exceeds the maximum number of requests per second.
|
2951
|
+
#
|
2952
|
+
# @!attribute [rw] message
|
2953
|
+
# @return [String]
|
2954
|
+
#
|
2955
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/ThrottledException AWS API Documentation
|
2956
|
+
#
|
2957
|
+
class ThrottledException < Struct.new(
|
2958
|
+
:message)
|
2959
|
+
SENSITIVE = []
|
2960
|
+
include Aws::Structure
|
2961
|
+
end
|
2962
|
+
|
2963
|
+
# A list of TimeSeriesStatistic structures.
|
2964
|
+
#
|
2965
|
+
# @!attribute [rw] timestamp
|
2966
|
+
# Timestamp of the window for which statistics are aggregated.
|
2967
|
+
# @return [Time]
|
2968
|
+
#
|
2969
|
+
# @!attribute [rw] edge_summary_statistics
|
2970
|
+
# Response statistics for an edge.
|
2971
|
+
# @return [Types::EdgeStatistics]
|
2972
|
+
#
|
2973
|
+
# @!attribute [rw] service_summary_statistics
|
2974
|
+
# Response statistics for a service.
|
2975
|
+
# @return [Types::ServiceStatistics]
|
2976
|
+
#
|
2977
|
+
# @!attribute [rw] service_forecast_statistics
|
2978
|
+
# The forecasted high and low fault count values.
|
2979
|
+
# @return [Types::ForecastStatistics]
|
2980
|
+
#
|
2981
|
+
# @!attribute [rw] response_time_histogram
|
2982
|
+
# The response time histogram for the selected entities.
|
2983
|
+
# @return [Array<Types::HistogramEntry>]
|
2984
|
+
#
|
2985
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/TimeSeriesServiceStatistics AWS API Documentation
|
2986
|
+
#
|
2987
|
+
class TimeSeriesServiceStatistics < Struct.new(
|
2988
|
+
:timestamp,
|
2989
|
+
:edge_summary_statistics,
|
2990
|
+
:service_summary_statistics,
|
2991
|
+
:service_forecast_statistics,
|
2992
|
+
:response_time_histogram)
|
2993
|
+
SENSITIVE = []
|
2994
|
+
include Aws::Structure
|
2995
|
+
end
|
2996
|
+
|
2997
|
+
# You have exceeded the maximum number of tags you can apply to this
|
2998
|
+
# resource.
|
2999
|
+
#
|
3000
|
+
# @!attribute [rw] message
|
3001
|
+
# @return [String]
|
3002
|
+
#
|
3003
|
+
# @!attribute [rw] resource_name
|
3004
|
+
# @return [String]
|
3005
|
+
#
|
3006
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/TooManyTagsException AWS API Documentation
|
3007
|
+
#
|
3008
|
+
class TooManyTagsException < Struct.new(
|
3009
|
+
:message,
|
3010
|
+
:resource_name)
|
3011
|
+
SENSITIVE = []
|
1441
3012
|
include Aws::Structure
|
1442
3013
|
end
|
1443
3014
|
|
@@ -1453,6 +3024,17 @@ module Aws::XRay
|
|
1453
3024
|
# segment and the end time of the last segment that completed.
|
1454
3025
|
# @return [Float]
|
1455
3026
|
#
|
3027
|
+
# @!attribute [rw] limit_exceeded
|
3028
|
+
# LimitExceeded is set to true when the trace has exceeded the `Trace
|
3029
|
+
# document size` limit. For more information about this limit and
|
3030
|
+
# other X-Ray limits and quotas, see [Amazon Web Services X-Ray
|
3031
|
+
# endpoints and quotas][1].
|
3032
|
+
#
|
3033
|
+
#
|
3034
|
+
#
|
3035
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/xray.html
|
3036
|
+
# @return [Boolean]
|
3037
|
+
#
|
1456
3038
|
# @!attribute [rw] segments
|
1457
3039
|
# Segment documents for the segments and subsegments that comprise the
|
1458
3040
|
# trace.
|
@@ -1463,7 +3045,9 @@ module Aws::XRay
|
|
1463
3045
|
class Trace < Struct.new(
|
1464
3046
|
:id,
|
1465
3047
|
:duration,
|
3048
|
+
:limit_exceeded,
|
1466
3049
|
:segments)
|
3050
|
+
SENSITIVE = []
|
1467
3051
|
include Aws::Structure
|
1468
3052
|
end
|
1469
3053
|
|
@@ -1474,6 +3058,11 @@ module Aws::XRay
|
|
1474
3058
|
# segments and subsegments.
|
1475
3059
|
# @return [String]
|
1476
3060
|
#
|
3061
|
+
# @!attribute [rw] start_time
|
3062
|
+
# The start time of a trace, based on the earliest trace segment start
|
3063
|
+
# time.
|
3064
|
+
# @return [Time]
|
3065
|
+
#
|
1477
3066
|
# @!attribute [rw] duration
|
1478
3067
|
# The length of time in seconds between the start time of the root
|
1479
3068
|
# segment and the end time of the last segment that completed.
|
@@ -1488,11 +3077,11 @@ module Aws::XRay
|
|
1488
3077
|
# @return [Float]
|
1489
3078
|
#
|
1490
3079
|
# @!attribute [rw] has_fault
|
1491
|
-
#
|
3080
|
+
# The root segment document has a 500 series error.
|
1492
3081
|
# @return [Boolean]
|
1493
3082
|
#
|
1494
3083
|
# @!attribute [rw] has_error
|
1495
|
-
#
|
3084
|
+
# The root segment document has a 400 series error.
|
1496
3085
|
# @return [Boolean]
|
1497
3086
|
#
|
1498
3087
|
# @!attribute [rw] has_throttle
|
@@ -1519,10 +3108,53 @@ module Aws::XRay
|
|
1519
3108
|
# Service IDs from the trace's segment documents.
|
1520
3109
|
# @return [Array<Types::ServiceId>]
|
1521
3110
|
#
|
3111
|
+
# @!attribute [rw] resource_arns
|
3112
|
+
# A list of resource ARNs for any resource corresponding to the trace
|
3113
|
+
# segments.
|
3114
|
+
# @return [Array<Types::ResourceARNDetail>]
|
3115
|
+
#
|
3116
|
+
# @!attribute [rw] instance_ids
|
3117
|
+
# A list of EC2 instance IDs for any instance corresponding to the
|
3118
|
+
# trace segments.
|
3119
|
+
# @return [Array<Types::InstanceIdDetail>]
|
3120
|
+
#
|
3121
|
+
# @!attribute [rw] availability_zones
|
3122
|
+
# A list of Availability Zones for any zone corresponding to the trace
|
3123
|
+
# segments.
|
3124
|
+
# @return [Array<Types::AvailabilityZoneDetail>]
|
3125
|
+
#
|
3126
|
+
# @!attribute [rw] entry_point
|
3127
|
+
# The root of a trace.
|
3128
|
+
# @return [Types::ServiceId]
|
3129
|
+
#
|
3130
|
+
# @!attribute [rw] fault_root_causes
|
3131
|
+
# A collection of FaultRootCause structures corresponding to the trace
|
3132
|
+
# segments.
|
3133
|
+
# @return [Array<Types::FaultRootCause>]
|
3134
|
+
#
|
3135
|
+
# @!attribute [rw] error_root_causes
|
3136
|
+
# A collection of ErrorRootCause structures corresponding to the trace
|
3137
|
+
# segments.
|
3138
|
+
# @return [Array<Types::ErrorRootCause>]
|
3139
|
+
#
|
3140
|
+
# @!attribute [rw] response_time_root_causes
|
3141
|
+
# A collection of ResponseTimeRootCause structures corresponding to
|
3142
|
+
# the trace segments.
|
3143
|
+
# @return [Array<Types::ResponseTimeRootCause>]
|
3144
|
+
#
|
3145
|
+
# @!attribute [rw] revision
|
3146
|
+
# The revision number of a trace.
|
3147
|
+
# @return [Integer]
|
3148
|
+
#
|
3149
|
+
# @!attribute [rw] matched_event_time
|
3150
|
+
# The matched time stamp of a defined event.
|
3151
|
+
# @return [Time]
|
3152
|
+
#
|
1522
3153
|
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/TraceSummary AWS API Documentation
|
1523
3154
|
#
|
1524
3155
|
class TraceSummary < Struct.new(
|
1525
3156
|
:id,
|
3157
|
+
:start_time,
|
1526
3158
|
:duration,
|
1527
3159
|
:response_time,
|
1528
3160
|
:has_fault,
|
@@ -1532,7 +3164,17 @@ module Aws::XRay
|
|
1532
3164
|
:http,
|
1533
3165
|
:annotations,
|
1534
3166
|
:users,
|
1535
|
-
:service_ids
|
3167
|
+
:service_ids,
|
3168
|
+
:resource_arns,
|
3169
|
+
:instance_ids,
|
3170
|
+
:availability_zones,
|
3171
|
+
:entry_point,
|
3172
|
+
:fault_root_causes,
|
3173
|
+
:error_root_causes,
|
3174
|
+
:response_time_root_causes,
|
3175
|
+
:revision,
|
3176
|
+
:matched_event_time)
|
3177
|
+
SENSITIVE = []
|
1536
3178
|
include Aws::Structure
|
1537
3179
|
end
|
1538
3180
|
|
@@ -1551,11 +3193,16 @@ module Aws::XRay
|
|
1551
3193
|
class TraceUser < Struct.new(
|
1552
3194
|
:user_name,
|
1553
3195
|
:service_ids)
|
3196
|
+
SENSITIVE = []
|
1554
3197
|
include Aws::Structure
|
1555
3198
|
end
|
1556
3199
|
|
1557
|
-
# Sampling statistics from a call to GetSamplingTargets that X-Ray
|
1558
|
-
# not process.
|
3200
|
+
# Sampling statistics from a call to [GetSamplingTargets][1] that X-Ray
|
3201
|
+
# could not process.
|
3202
|
+
#
|
3203
|
+
#
|
3204
|
+
#
|
3205
|
+
# [1]: https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html
|
1559
3206
|
#
|
1560
3207
|
# @!attribute [rw] rule_name
|
1561
3208
|
# The name of the sampling rule.
|
@@ -1575,6 +3222,7 @@ module Aws::XRay
|
|
1575
3222
|
:rule_name,
|
1576
3223
|
:error_code,
|
1577
3224
|
:message)
|
3225
|
+
SENSITIVE = []
|
1578
3226
|
include Aws::Structure
|
1579
3227
|
end
|
1580
3228
|
|
@@ -1598,31 +3246,82 @@ module Aws::XRay
|
|
1598
3246
|
:id,
|
1599
3247
|
:error_code,
|
1600
3248
|
:message)
|
3249
|
+
SENSITIVE = []
|
3250
|
+
include Aws::Structure
|
3251
|
+
end
|
3252
|
+
|
3253
|
+
# @!attribute [rw] resource_arn
|
3254
|
+
# The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.
|
3255
|
+
# @return [String]
|
3256
|
+
#
|
3257
|
+
# @!attribute [rw] tag_keys
|
3258
|
+
# Keys for one or more tags that you want to remove from an X-Ray
|
3259
|
+
# group or sampling rule.
|
3260
|
+
# @return [Array<String>]
|
3261
|
+
#
|
3262
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/UntagResourceRequest AWS API Documentation
|
3263
|
+
#
|
3264
|
+
class UntagResourceRequest < Struct.new(
|
3265
|
+
:resource_arn,
|
3266
|
+
:tag_keys)
|
3267
|
+
SENSITIVE = []
|
1601
3268
|
include Aws::Structure
|
1602
3269
|
end
|
1603
3270
|
|
1604
|
-
# @
|
1605
|
-
#
|
1606
|
-
|
1607
|
-
|
1608
|
-
#
|
1609
|
-
#
|
1610
|
-
#
|
1611
|
-
#
|
1612
|
-
#
|
1613
|
-
#
|
1614
|
-
#
|
1615
|
-
#
|
1616
|
-
#
|
1617
|
-
#
|
1618
|
-
#
|
1619
|
-
#
|
1620
|
-
#
|
1621
|
-
#
|
1622
|
-
#
|
1623
|
-
#
|
1624
|
-
#
|
3271
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/UntagResourceResponse AWS API Documentation
|
3272
|
+
#
|
3273
|
+
class UntagResourceResponse < Aws::EmptyStructure; end
|
3274
|
+
|
3275
|
+
# @!attribute [rw] group_name
|
3276
|
+
# The case-sensitive name of the group.
|
3277
|
+
# @return [String]
|
3278
|
+
#
|
3279
|
+
# @!attribute [rw] group_arn
|
3280
|
+
# The ARN that was generated upon creation.
|
3281
|
+
# @return [String]
|
3282
|
+
#
|
3283
|
+
# @!attribute [rw] filter_expression
|
3284
|
+
# The updated filter expression defining criteria by which to group
|
3285
|
+
# traces.
|
3286
|
+
# @return [String]
|
3287
|
+
#
|
3288
|
+
# @!attribute [rw] insights_configuration
|
3289
|
+
# The structure containing configurations related to insights.
|
3290
|
+
#
|
3291
|
+
# * The InsightsEnabled boolean can be set to true to enable insights
|
3292
|
+
# for the group or false to disable insights for the group.
|
3293
|
+
#
|
3294
|
+
# * The NotificationsEnabled boolean can be set to true to enable
|
3295
|
+
# insights notifications for the group. Notifications can only be
|
3296
|
+
# enabled on a group with InsightsEnabled set to true.
|
3297
|
+
# @return [Types::InsightsConfiguration]
|
1625
3298
|
#
|
3299
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/UpdateGroupRequest AWS API Documentation
|
3300
|
+
#
|
3301
|
+
class UpdateGroupRequest < Struct.new(
|
3302
|
+
:group_name,
|
3303
|
+
:group_arn,
|
3304
|
+
:filter_expression,
|
3305
|
+
:insights_configuration)
|
3306
|
+
SENSITIVE = []
|
3307
|
+
include Aws::Structure
|
3308
|
+
end
|
3309
|
+
|
3310
|
+
# @!attribute [rw] group
|
3311
|
+
# The group that was updated. Contains the name of the group that was
|
3312
|
+
# updated, the ARN of the group that was updated, the updated filter
|
3313
|
+
# expression, and the updated insight configuration assigned to the
|
3314
|
+
# group.
|
3315
|
+
# @return [Types::Group]
|
3316
|
+
#
|
3317
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/UpdateGroupResult AWS API Documentation
|
3318
|
+
#
|
3319
|
+
class UpdateGroupResult < Struct.new(
|
3320
|
+
:group)
|
3321
|
+
SENSITIVE = []
|
3322
|
+
include Aws::Structure
|
3323
|
+
end
|
3324
|
+
|
1626
3325
|
# @!attribute [rw] sampling_rule_update
|
1627
3326
|
# The rule and fields to change.
|
1628
3327
|
# @return [Types::SamplingRuleUpdate]
|
@@ -1631,6 +3330,7 @@ module Aws::XRay
|
|
1631
3330
|
#
|
1632
3331
|
class UpdateSamplingRuleRequest < Struct.new(
|
1633
3332
|
:sampling_rule_update)
|
3333
|
+
SENSITIVE = []
|
1634
3334
|
include Aws::Structure
|
1635
3335
|
end
|
1636
3336
|
|
@@ -1642,6 +3342,7 @@ module Aws::XRay
|
|
1642
3342
|
#
|
1643
3343
|
class UpdateSamplingRuleResult < Struct.new(
|
1644
3344
|
:sampling_rule_record)
|
3345
|
+
SENSITIVE = []
|
1645
3346
|
include Aws::Structure
|
1646
3347
|
end
|
1647
3348
|
|
@@ -1660,6 +3361,7 @@ module Aws::XRay
|
|
1660
3361
|
class ValueWithServiceIds < Struct.new(
|
1661
3362
|
:annotation_value,
|
1662
3363
|
:service_ids)
|
3364
|
+
SENSITIVE = []
|
1663
3365
|
include Aws::Structure
|
1664
3366
|
end
|
1665
3367
|
|