@aws-sdk/client-xray 3.529.1 → 3.535.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (73) hide show
  1. package/dist-types/XRay.d.ts +10 -1
  2. package/dist-types/XRayClient.d.ts +1 -1
  3. package/dist-types/commands/BatchGetTracesCommand.d.ts +2 -1
  4. package/dist-types/commands/CreateGroupCommand.d.ts +2 -1
  5. package/dist-types/commands/CreateSamplingRuleCommand.d.ts +2 -1
  6. package/dist-types/commands/DeleteGroupCommand.d.ts +2 -1
  7. package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +2 -1
  8. package/dist-types/commands/DeleteSamplingRuleCommand.d.ts +2 -1
  9. package/dist-types/commands/GetEncryptionConfigCommand.d.ts +2 -1
  10. package/dist-types/commands/GetGroupCommand.d.ts +2 -1
  11. package/dist-types/commands/GetGroupsCommand.d.ts +2 -1
  12. package/dist-types/commands/GetInsightCommand.d.ts +2 -1
  13. package/dist-types/commands/GetInsightEventsCommand.d.ts +2 -1
  14. package/dist-types/commands/GetInsightImpactGraphCommand.d.ts +2 -1
  15. package/dist-types/commands/GetInsightSummariesCommand.d.ts +2 -1
  16. package/dist-types/commands/GetSamplingRulesCommand.d.ts +2 -1
  17. package/dist-types/commands/GetSamplingStatisticSummariesCommand.d.ts +2 -1
  18. package/dist-types/commands/GetSamplingTargetsCommand.d.ts +2 -1
  19. package/dist-types/commands/GetServiceGraphCommand.d.ts +2 -1
  20. package/dist-types/commands/GetTimeSeriesServiceStatisticsCommand.d.ts +2 -1
  21. package/dist-types/commands/GetTraceGraphCommand.d.ts +2 -1
  22. package/dist-types/commands/GetTraceSummariesCommand.d.ts +2 -1
  23. package/dist-types/commands/ListResourcePoliciesCommand.d.ts +2 -1
  24. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
  25. package/dist-types/commands/PutEncryptionConfigCommand.d.ts +2 -1
  26. package/dist-types/commands/PutResourcePolicyCommand.d.ts +2 -1
  27. package/dist-types/commands/PutTelemetryRecordsCommand.d.ts +2 -1
  28. package/dist-types/commands/PutTraceSegmentsCommand.d.ts +2 -1
  29. package/dist-types/commands/TagResourceCommand.d.ts +2 -1
  30. package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
  31. package/dist-types/commands/UpdateGroupCommand.d.ts +2 -1
  32. package/dist-types/commands/UpdateSamplingRuleCommand.d.ts +2 -1
  33. package/dist-types/models/models_0.d.ts +450 -450
  34. package/dist-types/runtimeConfig.browser.d.ts +2 -2
  35. package/dist-types/runtimeConfig.d.ts +2 -2
  36. package/dist-types/runtimeConfig.native.d.ts +2 -2
  37. package/dist-types/runtimeConfig.shared.d.ts +2 -2
  38. package/dist-types/ts3.4/XRay.d.ts +9 -0
  39. package/dist-types/ts3.4/commands/BatchGetTracesCommand.d.ts +9 -0
  40. package/dist-types/ts3.4/commands/CreateGroupCommand.d.ts +9 -0
  41. package/dist-types/ts3.4/commands/CreateSamplingRuleCommand.d.ts +9 -0
  42. package/dist-types/ts3.4/commands/DeleteGroupCommand.d.ts +9 -0
  43. package/dist-types/ts3.4/commands/DeleteResourcePolicyCommand.d.ts +9 -0
  44. package/dist-types/ts3.4/commands/DeleteSamplingRuleCommand.d.ts +9 -0
  45. package/dist-types/ts3.4/commands/GetEncryptionConfigCommand.d.ts +9 -0
  46. package/dist-types/ts3.4/commands/GetGroupCommand.d.ts +9 -0
  47. package/dist-types/ts3.4/commands/GetGroupsCommand.d.ts +9 -0
  48. package/dist-types/ts3.4/commands/GetInsightCommand.d.ts +9 -0
  49. package/dist-types/ts3.4/commands/GetInsightEventsCommand.d.ts +9 -0
  50. package/dist-types/ts3.4/commands/GetInsightImpactGraphCommand.d.ts +9 -0
  51. package/dist-types/ts3.4/commands/GetInsightSummariesCommand.d.ts +9 -0
  52. package/dist-types/ts3.4/commands/GetSamplingRulesCommand.d.ts +9 -0
  53. package/dist-types/ts3.4/commands/GetSamplingStatisticSummariesCommand.d.ts +9 -0
  54. package/dist-types/ts3.4/commands/GetSamplingTargetsCommand.d.ts +9 -0
  55. package/dist-types/ts3.4/commands/GetServiceGraphCommand.d.ts +9 -0
  56. package/dist-types/ts3.4/commands/GetTimeSeriesServiceStatisticsCommand.d.ts +9 -0
  57. package/dist-types/ts3.4/commands/GetTraceGraphCommand.d.ts +9 -0
  58. package/dist-types/ts3.4/commands/GetTraceSummariesCommand.d.ts +9 -0
  59. package/dist-types/ts3.4/commands/ListResourcePoliciesCommand.d.ts +9 -0
  60. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
  61. package/dist-types/ts3.4/commands/PutEncryptionConfigCommand.d.ts +9 -0
  62. package/dist-types/ts3.4/commands/PutResourcePolicyCommand.d.ts +9 -0
  63. package/dist-types/ts3.4/commands/PutTelemetryRecordsCommand.d.ts +9 -0
  64. package/dist-types/ts3.4/commands/PutTraceSegmentsCommand.d.ts +9 -0
  65. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
  66. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
  67. package/dist-types/ts3.4/commands/UpdateGroupCommand.d.ts +9 -0
  68. package/dist-types/ts3.4/commands/UpdateSamplingRuleCommand.d.ts +9 -0
  69. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -2
  70. package/dist-types/ts3.4/runtimeConfig.d.ts +2 -2
  71. package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -2
  72. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -2
  73. package/package.json +40 -40
@@ -1,29 +1,29 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
2
  import { XRayServiceException as __BaseException } from "./XRayServiceException";
3
3
  /**
4
- * @public
5
4
  * <p>An alias for an edge.</p>
5
+ * @public
6
6
  */
7
7
  export interface Alias {
8
8
  /**
9
- * @public
10
9
  * <p>The canonical name of the alias.</p>
10
+ * @public
11
11
  */
12
12
  Name?: string;
13
13
  /**
14
- * @public
15
14
  * <p>A list of names for the alias, including the canonical name.</p>
15
+ * @public
16
16
  */
17
17
  Names?: string[];
18
18
  /**
19
- * @public
20
19
  * <p>The type of the alias.</p>
20
+ * @public
21
21
  */
22
22
  Type?: string;
23
23
  }
24
24
  /**
25
- * @public
26
25
  * <p>Value of a segment annotation. Has one of three value types: Number, Boolean, or String.</p>
26
+ * @public
27
27
  */
28
28
  export type AnnotationValue = AnnotationValue.BooleanValueMember | AnnotationValue.NumberValueMember | AnnotationValue.StringValueMember | AnnotationValue.$UnknownMember;
29
29
  /**
@@ -31,8 +31,8 @@ export type AnnotationValue = AnnotationValue.BooleanValueMember | AnnotationVal
31
31
  */
32
32
  export declare namespace AnnotationValue {
33
33
  /**
34
- * @public
35
34
  * <p>Value for a Number annotation.</p>
35
+ * @public
36
36
  */
37
37
  interface NumberValueMember {
38
38
  NumberValue: number;
@@ -41,8 +41,8 @@ export declare namespace AnnotationValue {
41
41
  $unknown?: never;
42
42
  }
43
43
  /**
44
- * @public
45
44
  * <p>Value for a Boolean annotation.</p>
45
+ * @public
46
46
  */
47
47
  interface BooleanValueMember {
48
48
  NumberValue?: never;
@@ -51,8 +51,8 @@ export declare namespace AnnotationValue {
51
51
  $unknown?: never;
52
52
  }
53
53
  /**
54
- * @public
55
54
  * <p>Value for a String annotation.</p>
55
+ * @public
56
56
  */
57
57
  interface StringValueMember {
58
58
  NumberValue?: never;
@@ -78,66 +78,66 @@ export declare namespace AnnotationValue {
78
78
  const visit: <T>(value: AnnotationValue, visitor: Visitor<T>) => T;
79
79
  }
80
80
  /**
81
- * @public
82
81
  * <p></p>
82
+ * @public
83
83
  */
84
84
  export interface ServiceId {
85
85
  /**
86
- * @public
87
86
  * <p></p>
87
+ * @public
88
88
  */
89
89
  Name?: string;
90
90
  /**
91
- * @public
92
91
  * <p></p>
92
+ * @public
93
93
  */
94
94
  Names?: string[];
95
95
  /**
96
- * @public
97
96
  * <p></p>
97
+ * @public
98
98
  */
99
99
  AccountId?: string;
100
100
  /**
101
- * @public
102
101
  * <p></p>
102
+ * @public
103
103
  */
104
104
  Type?: string;
105
105
  }
106
106
  /**
107
- * @public
108
107
  * <p>Information about a segment annotation.</p>
108
+ * @public
109
109
  */
110
110
  export interface ValueWithServiceIds {
111
111
  /**
112
- * @public
113
112
  * <p>Values of the annotation.</p>
113
+ * @public
114
114
  */
115
115
  AnnotationValue?: AnnotationValue;
116
116
  /**
117
- * @public
118
117
  * <p>Services to which the annotation applies.</p>
118
+ * @public
119
119
  */
120
120
  ServiceIds?: ServiceId[];
121
121
  }
122
122
  /**
123
- * @public
124
123
  * <p>The service within the service graph that has anomalously high fault rates. </p>
124
+ * @public
125
125
  */
126
126
  export interface AnomalousService {
127
127
  /**
128
- * @public
129
128
  * <p></p>
129
+ * @public
130
130
  */
131
131
  ServiceId?: ServiceId;
132
132
  }
133
133
  /**
134
- * @public
135
134
  * <p>A list of Availability Zones corresponding to the segments in a trace.</p>
135
+ * @public
136
136
  */
137
137
  export interface AvailabilityZoneDetail {
138
138
  /**
139
- * @public
140
139
  * <p>The name of a corresponding Availability Zone.</p>
140
+ * @public
141
141
  */
142
142
  Name?: string;
143
143
  }
@@ -146,63 +146,63 @@ export interface AvailabilityZoneDetail {
146
146
  */
147
147
  export interface BatchGetTracesRequest {
148
148
  /**
149
- * @public
150
149
  * <p>Specify the trace IDs of requests for which to retrieve segments.</p>
150
+ * @public
151
151
  */
152
152
  TraceIds: string[] | undefined;
153
153
  /**
154
- * @public
155
154
  * <p>Pagination token.</p>
155
+ * @public
156
156
  */
157
157
  NextToken?: string;
158
158
  }
159
159
  /**
160
- * @public
161
160
  * <p>A segment from a trace that has been ingested by the X-Ray service. The segment can be
162
161
  * compiled from documents uploaded with <a href="https://docs.aws.amazon.com/xray/latest/api/API_PutTraceSegments.html">PutTraceSegments</a>, or an
163
162
  * <code>inferred</code> segment for a downstream service, generated from a subsegment sent by
164
163
  * the service that called it.</p>
165
164
  * <p>For the full segment document schema, see <a href="https://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html">Amazon Web Services X-Ray Segment
166
165
  * Documents</a> in the <i>Amazon Web Services X-Ray Developer Guide</i>.</p>
166
+ * @public
167
167
  */
168
168
  export interface Segment {
169
169
  /**
170
- * @public
171
170
  * <p>The segment's ID.</p>
171
+ * @public
172
172
  */
173
173
  Id?: string;
174
174
  /**
175
- * @public
176
175
  * <p>The segment document.</p>
176
+ * @public
177
177
  */
178
178
  Document?: string;
179
179
  }
180
180
  /**
181
- * @public
182
181
  * <p>A collection of segment documents with matching trace IDs.</p>
182
+ * @public
183
183
  */
184
184
  export interface Trace {
185
185
  /**
186
- * @public
187
186
  * <p>The unique identifier for the request that generated the trace's segments and
188
187
  * subsegments.</p>
188
+ * @public
189
189
  */
190
190
  Id?: string;
191
191
  /**
192
- * @public
193
192
  * <p>The length of time in seconds between the start time of the root segment and the end
194
193
  * time of the last segment that completed.</p>
194
+ * @public
195
195
  */
196
196
  Duration?: number;
197
197
  /**
198
- * @public
199
198
  * <p>LimitExceeded is set to true when the trace has exceeded the <code>Trace document size</code> limit. For
200
199
  * more information about this limit and other X-Ray limits and quotas, see <a href="https://docs.aws.amazon.com/general/latest/gr/xray.html">Amazon Web Services X-Ray endpoints and quotas</a>.</p>
200
+ * @public
201
201
  */
202
202
  LimitExceeded?: boolean;
203
203
  /**
204
- * @public
205
204
  * <p>Segment documents for the segments and subsegments that comprise the trace.</p>
205
+ * @public
206
206
  */
207
207
  Segments?: Segment[];
208
208
  }
@@ -211,24 +211,24 @@ export interface Trace {
211
211
  */
212
212
  export interface BatchGetTracesResult {
213
213
  /**
214
- * @public
215
214
  * <p>Full traces for the specified requests.</p>
215
+ * @public
216
216
  */
217
217
  Traces?: Trace[];
218
218
  /**
219
- * @public
220
219
  * <p>Trace IDs of requests that haven't been processed.</p>
220
+ * @public
221
221
  */
222
222
  UnprocessedTraceIds?: string[];
223
223
  /**
224
- * @public
225
224
  * <p>Pagination token.</p>
225
+ * @public
226
226
  */
227
227
  NextToken?: string;
228
228
  }
229
229
  /**
230
- * @public
231
230
  * <p>The request is missing required parameters or has invalid parameters.</p>
231
+ * @public
232
232
  */
233
233
  export declare class InvalidRequestException extends __BaseException {
234
234
  readonly name: "InvalidRequestException";
@@ -240,8 +240,8 @@ export declare class InvalidRequestException extends __BaseException {
240
240
  constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
241
241
  }
242
242
  /**
243
- * @public
244
243
  * <p>The request exceeds the maximum number of requests per second.</p>
244
+ * @public
245
245
  */
246
246
  export declare class ThrottledException extends __BaseException {
247
247
  readonly name: "ThrottledException";
@@ -253,25 +253,24 @@ export declare class ThrottledException extends __BaseException {
253
253
  constructor(opts: __ExceptionOptionType<ThrottledException, __BaseException>);
254
254
  }
255
255
  /**
256
- * @public
257
256
  * <p>The structure containing configurations related to insights.</p>
257
+ * @public
258
258
  */
259
259
  export interface InsightsConfiguration {
260
260
  /**
261
- * @public
262
261
  * <p>Set the InsightsEnabled value to true to enable insights or false to disable
263
262
  * insights.</p>
263
+ * @public
264
264
  */
265
265
  InsightsEnabled?: boolean;
266
266
  /**
267
- * @public
268
267
  * <p>Set the NotificationsEnabled value to true to enable insights notifications. Notifications can only be
269
268
  * enabled on a group with InsightsEnabled set to true.</p>
269
+ * @public
270
270
  */
271
271
  NotificationsEnabled?: boolean;
272
272
  }
273
273
  /**
274
- * @public
275
274
  * <p>A map that contains tag keys and tag values to attach to an Amazon Web Services X-Ray group or sampling
276
275
  * rule. For more information about ways to use tags, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>
277
276
  * in the <i>Amazon Web Services General Reference</i>.</p>
@@ -288,22 +287,23 @@ export interface InsightsConfiguration {
288
287
  * cannot edit or delete system tags.</p>
289
288
  * </li>
290
289
  * </ul>
290
+ * @public
291
291
  */
292
292
  export interface Tag {
293
293
  /**
294
- * @public
295
294
  * <p>A tag key, such as <code>Stage</code> or <code>Name</code>. A tag key cannot be empty. The
296
295
  * key can be a maximum of 128 characters, and can contain only Unicode letters, numbers, or separators,
297
296
  * or the following special characters: <code>+ - = . _ : /</code>
298
297
  * </p>
298
+ * @public
299
299
  */
300
300
  Key: string | undefined;
301
301
  /**
302
- * @public
303
302
  * <p>An optional tag value, such as <code>Production</code> or <code>test-only</code>. The value can be
304
303
  * a maximum of 255 characters, and contain only Unicode letters, numbers, or separators, or the following
305
304
  * special characters: <code>+ - = . _ : /</code>
306
305
  * </p>
306
+ * @public
307
307
  */
308
308
  Value: string | undefined;
309
309
  }
@@ -312,18 +312,17 @@ export interface Tag {
312
312
  */
313
313
  export interface CreateGroupRequest {
314
314
  /**
315
- * @public
316
315
  * <p>The case-sensitive name of the new group. Default is a reserved name and names must
317
316
  * be unique.</p>
317
+ * @public
318
318
  */
319
319
  GroupName: string | undefined;
320
320
  /**
321
- * @public
322
321
  * <p>The filter expression defining criteria by which to group traces.</p>
322
+ * @public
323
323
  */
324
324
  FilterExpression?: string;
325
325
  /**
326
- * @public
327
326
  * <p>The structure containing configurations related to insights.</p>
328
327
  * <ul>
329
328
  * <li>
@@ -336,10 +335,10 @@ export interface CreateGroupRequest {
336
335
  * with InsightsEnabled set to true.</p>
337
336
  * </li>
338
337
  * </ul>
338
+ * @public
339
339
  */
340
340
  InsightsConfiguration?: InsightsConfiguration;
341
341
  /**
342
- * @public
343
342
  * <p>A map that contains one or more tag keys and tag values to attach to an X-Ray group.
344
343
  * For more information about ways to use tags, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services
345
344
  * resources</a> in the <i>Amazon Web Services General Reference</i>.</p>
@@ -366,31 +365,31 @@ export interface CreateGroupRequest {
366
365
  * use.</p>
367
366
  * </li>
368
367
  * </ul>
368
+ * @public
369
369
  */
370
370
  Tags?: Tag[];
371
371
  }
372
372
  /**
373
- * @public
374
373
  * <p>Details and metadata for a group.</p>
374
+ * @public
375
375
  */
376
376
  export interface Group {
377
377
  /**
378
- * @public
379
378
  * <p>The unique case-sensitive name of the group.</p>
379
+ * @public
380
380
  */
381
381
  GroupName?: string;
382
382
  /**
383
- * @public
384
383
  * <p>The Amazon Resource Name (ARN) of the group generated based on the GroupName.</p>
384
+ * @public
385
385
  */
386
386
  GroupARN?: string;
387
387
  /**
388
- * @public
389
388
  * <p>The filter expression defining the parameters to include traces.</p>
389
+ * @public
390
390
  */
391
391
  FilterExpression?: string;
392
392
  /**
393
- * @public
394
393
  * <p>The structure containing configurations related to insights.</p>
395
394
  * <ul>
396
395
  * <li>
@@ -402,6 +401,7 @@ export interface Group {
402
401
  * notifications through Amazon EventBridge for the group.</p>
403
402
  * </li>
404
403
  * </ul>
404
+ * @public
405
405
  */
406
406
  InsightsConfiguration?: InsightsConfiguration;
407
407
  }
@@ -410,85 +410,85 @@ export interface Group {
410
410
  */
411
411
  export interface CreateGroupResult {
412
412
  /**
413
- * @public
414
413
  * <p>The group that was created. Contains the name of the group that was created, the Amazon Resource Name
415
414
  * (ARN) of the group that was generated based on the group name, the filter expression, and the insight
416
415
  * configuration that was assigned to the group.</p>
416
+ * @public
417
417
  */
418
418
  Group?: Group;
419
419
  }
420
420
  /**
421
- * @public
422
421
  * <p>A sampling rule that services use to decide whether to instrument a request. Rule
423
422
  * fields can match properties of the service, or properties of a request. The service can ignore
424
423
  * rules that don't match its properties.</p>
424
+ * @public
425
425
  */
426
426
  export interface SamplingRule {
427
427
  /**
428
- * @public
429
428
  * <p>The name of the sampling rule. Specify a rule by either name or ARN, but not both.</p>
429
+ * @public
430
430
  */
431
431
  RuleName?: string;
432
432
  /**
433
- * @public
434
433
  * <p>The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.</p>
434
+ * @public
435
435
  */
436
436
  RuleARN?: string;
437
437
  /**
438
- * @public
439
438
  * <p>Matches the ARN of the Amazon Web Services resource on which the service runs.</p>
439
+ * @public
440
440
  */
441
441
  ResourceARN: string | undefined;
442
442
  /**
443
- * @public
444
443
  * <p>The priority of the sampling rule.</p>
444
+ * @public
445
445
  */
446
446
  Priority: number | undefined;
447
447
  /**
448
- * @public
449
448
  * <p>The percentage of matching requests to instrument, after the reservoir is
450
449
  * exhausted.</p>
450
+ * @public
451
451
  */
452
452
  FixedRate: number | undefined;
453
453
  /**
454
- * @public
455
454
  * <p>A fixed number of matching requests to instrument per second, prior to applying the
456
455
  * fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.</p>
456
+ * @public
457
457
  */
458
458
  ReservoirSize: number | undefined;
459
459
  /**
460
- * @public
461
460
  * <p>Matches the <code>name</code> that the service uses to identify itself in segments.</p>
461
+ * @public
462
462
  */
463
463
  ServiceName: string | undefined;
464
464
  /**
465
- * @public
466
465
  * <p>Matches the <code>origin</code> that the service uses to identify its type in segments.</p>
466
+ * @public
467
467
  */
468
468
  ServiceType: string | undefined;
469
469
  /**
470
- * @public
471
470
  * <p>Matches the hostname from a request URL.</p>
471
+ * @public
472
472
  */
473
473
  Host: string | undefined;
474
474
  /**
475
- * @public
476
475
  * <p>Matches the HTTP method of a request.</p>
476
+ * @public
477
477
  */
478
478
  HTTPMethod: string | undefined;
479
479
  /**
480
- * @public
481
480
  * <p>Matches the path from a request URL.</p>
481
+ * @public
482
482
  */
483
483
  URLPath: string | undefined;
484
484
  /**
485
- * @public
486
485
  * <p>The version of the sampling rule format (<code>1</code>).</p>
486
+ * @public
487
487
  */
488
488
  Version: number | undefined;
489
489
  /**
490
- * @public
491
490
  * <p>Matches attributes derived from the request.</p>
491
+ * @public
492
492
  */
493
493
  Attributes?: Record<string, string>;
494
494
  }
@@ -497,12 +497,11 @@ export interface SamplingRule {
497
497
  */
498
498
  export interface CreateSamplingRuleRequest {
499
499
  /**
500
- * @public
501
500
  * <p>The rule definition.</p>
501
+ * @public
502
502
  */
503
503
  SamplingRule: SamplingRule | undefined;
504
504
  /**
505
- * @public
506
505
  * <p>A map that contains one or more tag keys and tag values to attach to an X-Ray sampling
507
506
  * rule. For more information about ways to use tags, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services
508
507
  * resources</a> in the <i>Amazon Web Services General Reference</i>.</p>
@@ -529,27 +528,28 @@ export interface CreateSamplingRuleRequest {
529
528
  * use.</p>
530
529
  * </li>
531
530
  * </ul>
531
+ * @public
532
532
  */
533
533
  Tags?: Tag[];
534
534
  }
535
535
  /**
536
- * @public
537
536
  * <p>A <a href="https://docs.aws.amazon.com/xray/latest/api/API_SamplingRule.html">SamplingRule</a> and its metadata.</p>
537
+ * @public
538
538
  */
539
539
  export interface SamplingRuleRecord {
540
540
  /**
541
- * @public
542
541
  * <p>The sampling rule.</p>
542
+ * @public
543
543
  */
544
544
  SamplingRule?: SamplingRule;
545
545
  /**
546
- * @public
547
546
  * <p>When the rule was created.</p>
547
+ * @public
548
548
  */
549
549
  CreatedAt?: Date;
550
550
  /**
551
- * @public
552
551
  * <p>When the rule was last modified.</p>
552
+ * @public
553
553
  */
554
554
  ModifiedAt?: Date;
555
555
  }
@@ -558,14 +558,14 @@ export interface SamplingRuleRecord {
558
558
  */
559
559
  export interface CreateSamplingRuleResult {
560
560
  /**
561
- * @public
562
561
  * <p>The saved rule definition and metadata.</p>
562
+ * @public
563
563
  */
564
564
  SamplingRuleRecord?: SamplingRuleRecord;
565
565
  }
566
566
  /**
567
- * @public
568
567
  * <p>You have reached the maximum number of sampling rules.</p>
568
+ * @public
569
569
  */
570
570
  export declare class RuleLimitExceededException extends __BaseException {
571
571
  readonly name: "RuleLimitExceededException";
@@ -581,13 +581,13 @@ export declare class RuleLimitExceededException extends __BaseException {
581
581
  */
582
582
  export interface DeleteGroupRequest {
583
583
  /**
584
- * @public
585
584
  * <p>The case-sensitive name of the group.</p>
585
+ * @public
586
586
  */
587
587
  GroupName?: string;
588
588
  /**
589
- * @public
590
589
  * <p>The ARN of the group that was generated on creation.</p>
590
+ * @public
591
591
  */
592
592
  GroupARN?: string;
593
593
  }
@@ -601,15 +601,15 @@ export interface DeleteGroupResult {
601
601
  */
602
602
  export interface DeleteResourcePolicyRequest {
603
603
  /**
604
- * @public
605
604
  * <p>The name of the resource policy to delete.</p>
605
+ * @public
606
606
  */
607
607
  PolicyName: string | undefined;
608
608
  /**
609
- * @public
610
609
  * <p>Specifies a specific policy revision to delete. Provide a <code>PolicyRevisionId</code> to ensure an atomic delete operation. If the provided revision id does
611
610
  * not match the latest policy revision id, an <code>InvalidPolicyRevisionIdException</code> exception is returned.
612
611
  * </p>
612
+ * @public
613
613
  */
614
614
  PolicyRevisionId?: string;
615
615
  }
@@ -619,9 +619,9 @@ export interface DeleteResourcePolicyRequest {
619
619
  export interface DeleteResourcePolicyResult {
620
620
  }
621
621
  /**
622
- * @public
623
622
  * <p>A policy revision id was provided which does not match the latest policy revision. This exception is also
624
623
  * if a policy revision id of 0 is provided via <code>PutResourcePolicy</code> and a policy with the same name already exists.</p>
624
+ * @public
625
625
  */
626
626
  export declare class InvalidPolicyRevisionIdException extends __BaseException {
627
627
  readonly name: "InvalidPolicyRevisionIdException";
@@ -637,13 +637,13 @@ export declare class InvalidPolicyRevisionIdException extends __BaseException {
637
637
  */
638
638
  export interface DeleteSamplingRuleRequest {
639
639
  /**
640
- * @public
641
640
  * <p>The name of the sampling rule. Specify a rule by either name or ARN, but not both.</p>
641
+ * @public
642
642
  */
643
643
  RuleName?: string;
644
644
  /**
645
- * @public
646
645
  * <p>The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.</p>
646
+ * @public
647
647
  */
648
648
  RuleARN?: string;
649
649
  }
@@ -652,8 +652,8 @@ export interface DeleteSamplingRuleRequest {
652
652
  */
653
653
  export interface DeleteSamplingRuleResult {
654
654
  /**
655
- * @public
656
655
  * <p>The deleted rule definition and metadata.</p>
656
+ * @public
657
657
  */
658
658
  SamplingRuleRecord?: SamplingRuleRecord;
659
659
  }
@@ -687,24 +687,24 @@ export declare const EncryptionType: {
687
687
  */
688
688
  export type EncryptionType = (typeof EncryptionType)[keyof typeof EncryptionType];
689
689
  /**
690
- * @public
691
690
  * <p>A configuration document that specifies encryption configuration settings.</p>
691
+ * @public
692
692
  */
693
693
  export interface EncryptionConfig {
694
694
  /**
695
- * @public
696
695
  * <p>The ID of the KMS key used for encryption, if applicable.</p>
696
+ * @public
697
697
  */
698
698
  KeyId?: string;
699
699
  /**
700
- * @public
701
700
  * <p>The encryption status. While the status is <code>UPDATING</code>, X-Ray may encrypt data with a combination of the new and old settings.</p>
701
+ * @public
702
702
  */
703
703
  Status?: EncryptionStatus;
704
704
  /**
705
- * @public
706
705
  * <p>The type of encryption. Set to <code>KMS</code> for encryption with KMS keys. Set to <code>NONE</code> for
707
706
  * default encryption.</p>
707
+ * @public
708
708
  */
709
709
  Type?: EncryptionType;
710
710
  }
@@ -713,8 +713,8 @@ export interface EncryptionConfig {
713
713
  */
714
714
  export interface GetEncryptionConfigResult {
715
715
  /**
716
- * @public
717
716
  * <p>The encryption configuration document.</p>
717
+ * @public
718
718
  */
719
719
  EncryptionConfig?: EncryptionConfig;
720
720
  }
@@ -723,13 +723,13 @@ export interface GetEncryptionConfigResult {
723
723
  */
724
724
  export interface GetGroupRequest {
725
725
  /**
726
- * @public
727
726
  * <p>The case-sensitive name of the group.</p>
727
+ * @public
728
728
  */
729
729
  GroupName?: string;
730
730
  /**
731
- * @public
732
731
  * <p>The ARN of the group that was generated on creation.</p>
732
+ * @public
733
733
  */
734
734
  GroupARN?: string;
735
735
  }
@@ -738,9 +738,9 @@ export interface GetGroupRequest {
738
738
  */
739
739
  export interface GetGroupResult {
740
740
  /**
741
- * @public
742
741
  * <p>The group that was requested. Contains the name of the group, the ARN of the group,
743
742
  * the filter expression, and the insight configuration assigned to the group.</p>
743
+ * @public
744
744
  */
745
745
  Group?: Group;
746
746
  }
@@ -749,33 +749,32 @@ export interface GetGroupResult {
749
749
  */
750
750
  export interface GetGroupsRequest {
751
751
  /**
752
- * @public
753
752
  * <p>Pagination token.</p>
753
+ * @public
754
754
  */
755
755
  NextToken?: string;
756
756
  }
757
757
  /**
758
- * @public
759
758
  * <p>Details for a group without metadata.</p>
759
+ * @public
760
760
  */
761
761
  export interface GroupSummary {
762
762
  /**
763
- * @public
764
763
  * <p>The unique case-sensitive name of the group.</p>
764
+ * @public
765
765
  */
766
766
  GroupName?: string;
767
767
  /**
768
- * @public
769
768
  * <p>The ARN of the group generated based on the GroupName.</p>
769
+ * @public
770
770
  */
771
771
  GroupARN?: string;
772
772
  /**
773
- * @public
774
773
  * <p>The filter expression defining the parameters to include traces.</p>
774
+ * @public
775
775
  */
776
776
  FilterExpression?: string;
777
777
  /**
778
- * @public
779
778
  * <p>The structure containing configurations related to insights.</p>
780
779
  * <ul>
781
780
  * <li>
@@ -787,6 +786,7 @@ export interface GroupSummary {
787
786
  * Notifications can only be enabled on a group with InsightsEnabled set to true.</p>
788
787
  * </li>
789
788
  * </ul>
789
+ * @public
790
790
  */
791
791
  InsightsConfiguration?: InsightsConfiguration;
792
792
  }
@@ -795,13 +795,13 @@ export interface GroupSummary {
795
795
  */
796
796
  export interface GetGroupsResult {
797
797
  /**
798
- * @public
799
798
  * <p>The collection of all active groups.</p>
799
+ * @public
800
800
  */
801
801
  Groups?: GroupSummary[];
802
802
  /**
803
- * @public
804
803
  * <p>Pagination token.</p>
804
+ * @public
805
805
  */
806
806
  NextToken?: string;
807
807
  }
@@ -810,8 +810,8 @@ export interface GetGroupsResult {
810
810
  */
811
811
  export interface GetInsightRequest {
812
812
  /**
813
- * @public
814
813
  * <p>The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.</p>
814
+ * @public
815
815
  */
816
816
  InsightId: string | undefined;
817
817
  }
@@ -827,23 +827,23 @@ export declare const InsightCategory: {
827
827
  */
828
828
  export type InsightCategory = (typeof InsightCategory)[keyof typeof InsightCategory];
829
829
  /**
830
- * @public
831
830
  * <p>Statistics that describe how the incident has impacted a service.</p>
831
+ * @public
832
832
  */
833
833
  export interface RequestImpactStatistics {
834
834
  /**
835
- * @public
836
835
  * <p>The number of requests that have resulted in a fault,</p>
836
+ * @public
837
837
  */
838
838
  FaultCount?: number;
839
839
  /**
840
- * @public
841
840
  * <p>The number of successful requests.</p>
841
+ * @public
842
842
  */
843
843
  OkCount?: number;
844
844
  /**
845
- * @public
846
845
  * <p>The total number of requests to the service.</p>
846
+ * @public
847
847
  */
848
848
  TotalCount?: number;
849
849
  }
@@ -860,71 +860,71 @@ export declare const InsightState: {
860
860
  */
861
861
  export type InsightState = (typeof InsightState)[keyof typeof InsightState];
862
862
  /**
863
- * @public
864
863
  * <p>When fault rates go outside of the expected range, X-Ray creates an insight. Insights
865
864
  * tracks emergent issues within your applications.</p>
865
+ * @public
866
866
  */
867
867
  export interface Insight {
868
868
  /**
869
- * @public
870
869
  * <p>The insights unique identifier. </p>
870
+ * @public
871
871
  */
872
872
  InsightId?: string;
873
873
  /**
874
- * @public
875
874
  * <p>The Amazon Resource Name (ARN) of the group that the insight belongs to.</p>
875
+ * @public
876
876
  */
877
877
  GroupARN?: string;
878
878
  /**
879
- * @public
880
879
  * <p>The name of the group that the insight belongs to.</p>
880
+ * @public
881
881
  */
882
882
  GroupName?: string;
883
883
  /**
884
- * @public
885
884
  * <p></p>
885
+ * @public
886
886
  */
887
887
  RootCauseServiceId?: ServiceId;
888
888
  /**
889
- * @public
890
889
  * <p>The categories that label and describe the type of insight.</p>
890
+ * @public
891
891
  */
892
892
  Categories?: InsightCategory[];
893
893
  /**
894
- * @public
895
894
  * <p>The current state of the insight.</p>
895
+ * @public
896
896
  */
897
897
  State?: InsightState;
898
898
  /**
899
- * @public
900
899
  * <p>The time, in Unix seconds, at which the insight began.</p>
900
+ * @public
901
901
  */
902
902
  StartTime?: Date;
903
903
  /**
904
- * @public
905
904
  * <p>The time, in Unix seconds, at which the insight ended.</p>
905
+ * @public
906
906
  */
907
907
  EndTime?: Date;
908
908
  /**
909
- * @public
910
909
  * <p>A brief description of the insight.</p>
910
+ * @public
911
911
  */
912
912
  Summary?: string;
913
913
  /**
914
- * @public
915
914
  * <p>The impact statistics of the client side service. This includes the number of requests to the client service
916
915
  * and whether the requests were faults or okay.</p>
916
+ * @public
917
917
  */
918
918
  ClientRequestImpactStatistics?: RequestImpactStatistics;
919
919
  /**
920
- * @public
921
920
  * <p>The impact statistics of the root cause service. This includes the number of requests to the client service
922
921
  * and whether the requests were faults or okay.</p>
922
+ * @public
923
923
  */
924
924
  RootCauseServiceRequestImpactStatistics?: RequestImpactStatistics;
925
925
  /**
926
- * @public
927
926
  * <p>The service within the insight that is most impacted by the incident.</p>
927
+ * @public
928
928
  */
929
929
  TopAnomalousServices?: AnomalousService[];
930
930
  }
@@ -933,8 +933,8 @@ export interface Insight {
933
933
  */
934
934
  export interface GetInsightResult {
935
935
  /**
936
- * @public
937
936
  * <p>The summary information of an insight.</p>
937
+ * @public
938
938
  */
939
939
  Insight?: Insight;
940
940
  }
@@ -943,52 +943,52 @@ export interface GetInsightResult {
943
943
  */
944
944
  export interface GetInsightEventsRequest {
945
945
  /**
946
- * @public
947
946
  * <p>The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.</p>
947
+ * @public
948
948
  */
949
949
  InsightId: string | undefined;
950
950
  /**
951
- * @public
952
951
  * <p>Used to retrieve at most the specified value of events.</p>
952
+ * @public
953
953
  */
954
954
  MaxResults?: number;
955
955
  /**
956
- * @public
957
956
  * <p>Specify the pagination token returned by a previous request to retrieve the next page of events. </p>
957
+ * @public
958
958
  */
959
959
  NextToken?: string;
960
960
  }
961
961
  /**
962
- * @public
963
962
  * <p>X-Ray reevaluates insights periodically until they are resolved, and records each intermediate state in an
964
963
  * event. You can review incident events in the Impact Timeline on the Inspect page in the X-Ray console.</p>
964
+ * @public
965
965
  */
966
966
  export interface InsightEvent {
967
967
  /**
968
- * @public
969
968
  * <p>A brief description of the event.</p>
969
+ * @public
970
970
  */
971
971
  Summary?: string;
972
972
  /**
973
- * @public
974
973
  * <p>The time, in Unix seconds, at which the event was recorded.</p>
974
+ * @public
975
975
  */
976
976
  EventTime?: Date;
977
977
  /**
978
- * @public
979
978
  * <p>The impact statistics of the client side service. This includes the number of requests to the client service
980
979
  * and whether the requests were faults or okay.</p>
980
+ * @public
981
981
  */
982
982
  ClientRequestImpactStatistics?: RequestImpactStatistics;
983
983
  /**
984
- * @public
985
984
  * <p>The impact statistics of the root cause service. This includes the number of requests to the client service
986
985
  * and whether the requests were faults or okay.</p>
986
+ * @public
987
987
  */
988
988
  RootCauseServiceRequestImpactStatistics?: RequestImpactStatistics;
989
989
  /**
990
- * @public
991
990
  * <p>The service during the event that is most impacted by the incident.</p>
991
+ * @public
992
992
  */
993
993
  TopAnomalousServices?: AnomalousService[];
994
994
  }
@@ -997,15 +997,15 @@ export interface InsightEvent {
997
997
  */
998
998
  export interface GetInsightEventsResult {
999
999
  /**
1000
- * @public
1001
1000
  * <p>A detailed description of the event. This includes the time of the event, client and
1002
1001
  * root cause impact statistics, and the top anomalous service at the time of the
1003
1002
  * event.</p>
1003
+ * @public
1004
1004
  */
1005
1005
  InsightEvents?: InsightEvent[];
1006
1006
  /**
1007
- * @public
1008
1007
  * <p>Use this token to retrieve the next page of insight events.</p>
1008
+ * @public
1009
1009
  */
1010
1010
  NextToken?: string;
1011
1011
  }
@@ -1014,52 +1014,51 @@ export interface GetInsightEventsResult {
1014
1014
  */
1015
1015
  export interface GetInsightImpactGraphRequest {
1016
1016
  /**
1017
- * @public
1018
1017
  * <p>The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.</p>
1018
+ * @public
1019
1019
  */
1020
1020
  InsightId: string | undefined;
1021
1021
  /**
1022
- * @public
1023
1022
  * <p>The estimated start time of the insight, in Unix time seconds. The StartTime is inclusive of the value
1024
1023
  * provided and can't be more than 30 days old.</p>
1024
+ * @public
1025
1025
  */
1026
1026
  StartTime: Date | undefined;
1027
1027
  /**
1028
- * @public
1029
1028
  * <p>The estimated end time of the insight, in Unix time seconds. The EndTime is exclusive of the value provided.
1030
1029
  * The time range between the start time and end time can't be more than six hours. </p>
1030
+ * @public
1031
1031
  */
1032
1032
  EndTime: Date | undefined;
1033
1033
  /**
1034
- * @public
1035
1034
  * <p>Specify the pagination token returned by a previous request to retrieve the next page of results. </p>
1035
+ * @public
1036
1036
  */
1037
1037
  NextToken?: string;
1038
1038
  }
1039
1039
  /**
1040
- * @public
1041
1040
  * <p>The connection between two service in an insight impact graph.</p>
1041
+ * @public
1042
1042
  */
1043
1043
  export interface InsightImpactGraphEdge {
1044
1044
  /**
1045
- * @public
1046
1045
  * <p>Identifier of the edge. Unique within a service map.</p>
1046
+ * @public
1047
1047
  */
1048
1048
  ReferenceId?: number;
1049
1049
  }
1050
1050
  /**
1051
- * @public
1052
1051
  * <p>Information about an application that processed requests, users that made requests, or downstream services,
1053
1052
  * resources, and applications that an application used. </p>
1053
+ * @public
1054
1054
  */
1055
1055
  export interface InsightImpactGraphService {
1056
1056
  /**
1057
- * @public
1058
1057
  * <p>Identifier for the service. Unique within the service map.</p>
1058
+ * @public
1059
1059
  */
1060
1060
  ReferenceId?: number;
1061
1061
  /**
1062
- * @public
1063
1062
  * <p>Identifier for the service. Unique within the service map.</p>
1064
1063
  * <ul>
1065
1064
  * <li>
@@ -1078,26 +1077,27 @@ export interface InsightImpactGraphService {
1078
1077
  * <p>remote - A downstream service of indeterminate type.</p>
1079
1078
  * </li>
1080
1079
  * </ul>
1080
+ * @public
1081
1081
  */
1082
1082
  Type?: string;
1083
1083
  /**
1084
- * @public
1085
1084
  * <p>The canonical name of the service.</p>
1085
+ * @public
1086
1086
  */
1087
1087
  Name?: string;
1088
1088
  /**
1089
- * @public
1090
1089
  * <p>A list of names for the service, including the canonical name.</p>
1090
+ * @public
1091
1091
  */
1092
1092
  Names?: string[];
1093
1093
  /**
1094
- * @public
1095
1094
  * <p>Identifier of the Amazon Web Services account in which the service runs.</p>
1095
+ * @public
1096
1096
  */
1097
1097
  AccountId?: string;
1098
1098
  /**
1099
- * @public
1100
1099
  * <p>Connections to downstream services.</p>
1100
+ * @public
1101
1101
  */
1102
1102
  Edges?: InsightImpactGraphEdge[];
1103
1103
  }
@@ -1106,38 +1106,38 @@ export interface InsightImpactGraphService {
1106
1106
  */
1107
1107
  export interface GetInsightImpactGraphResult {
1108
1108
  /**
1109
- * @public
1110
1109
  * <p>The insight's unique identifier.</p>
1110
+ * @public
1111
1111
  */
1112
1112
  InsightId?: string;
1113
1113
  /**
1114
- * @public
1115
1114
  * <p>The provided start time.</p>
1115
+ * @public
1116
1116
  */
1117
1117
  StartTime?: Date;
1118
1118
  /**
1119
- * @public
1120
1119
  * <p>The provided end time. </p>
1120
+ * @public
1121
1121
  */
1122
1122
  EndTime?: Date;
1123
1123
  /**
1124
- * @public
1125
1124
  * <p>The time, in Unix seconds, at which the service graph started.</p>
1125
+ * @public
1126
1126
  */
1127
1127
  ServiceGraphStartTime?: Date;
1128
1128
  /**
1129
- * @public
1130
1129
  * <p>The time, in Unix seconds, at which the service graph ended.</p>
1130
+ * @public
1131
1131
  */
1132
1132
  ServiceGraphEndTime?: Date;
1133
1133
  /**
1134
- * @public
1135
1134
  * <p>The Amazon Web Services instrumented services related to the insight.</p>
1135
+ * @public
1136
1136
  */
1137
1137
  Services?: InsightImpactGraphService[];
1138
1138
  /**
1139
- * @public
1140
1139
  * <p>Pagination token.</p>
1140
+ * @public
1141
1141
  */
1142
1142
  NextToken?: string;
1143
1143
  }
@@ -1146,112 +1146,112 @@ export interface GetInsightImpactGraphResult {
1146
1146
  */
1147
1147
  export interface GetInsightSummariesRequest {
1148
1148
  /**
1149
- * @public
1150
1149
  * <p>The list of insight states. </p>
1150
+ * @public
1151
1151
  */
1152
1152
  States?: InsightState[];
1153
1153
  /**
1154
- * @public
1155
1154
  * <p>The Amazon Resource Name (ARN) of the group. Required if the GroupName isn't provided.</p>
1155
+ * @public
1156
1156
  */
1157
1157
  GroupARN?: string;
1158
1158
  /**
1159
- * @public
1160
1159
  * <p>The name of the group. Required if the GroupARN isn't provided.</p>
1160
+ * @public
1161
1161
  */
1162
1162
  GroupName?: string;
1163
1163
  /**
1164
- * @public
1165
1164
  * <p>The beginning of the time frame in which the insights started. The start time can't be more than 30 days
1166
1165
  * old.</p>
1166
+ * @public
1167
1167
  */
1168
1168
  StartTime: Date | undefined;
1169
1169
  /**
1170
- * @public
1171
1170
  * <p>The end of the time frame in which the insights ended. The end time can't be more than 30 days old.</p>
1171
+ * @public
1172
1172
  */
1173
1173
  EndTime: Date | undefined;
1174
1174
  /**
1175
- * @public
1176
1175
  * <p>The maximum number of results to display.</p>
1176
+ * @public
1177
1177
  */
1178
1178
  MaxResults?: number;
1179
1179
  /**
1180
- * @public
1181
1180
  * <p>Pagination token.</p>
1181
+ * @public
1182
1182
  */
1183
1183
  NextToken?: string;
1184
1184
  }
1185
1185
  /**
1186
- * @public
1187
1186
  * <p>Information that describes an insight.</p>
1187
+ * @public
1188
1188
  */
1189
1189
  export interface InsightSummary {
1190
1190
  /**
1191
- * @public
1192
1191
  * <p>The insights unique identifier. </p>
1192
+ * @public
1193
1193
  */
1194
1194
  InsightId?: string;
1195
1195
  /**
1196
- * @public
1197
1196
  * <p>The Amazon Resource Name (ARN) of the group that the insight belongs to.</p>
1197
+ * @public
1198
1198
  */
1199
1199
  GroupARN?: string;
1200
1200
  /**
1201
- * @public
1202
1201
  * <p>The name of the group that the insight belongs to.</p>
1202
+ * @public
1203
1203
  */
1204
1204
  GroupName?: string;
1205
1205
  /**
1206
- * @public
1207
1206
  * <p></p>
1207
+ * @public
1208
1208
  */
1209
1209
  RootCauseServiceId?: ServiceId;
1210
1210
  /**
1211
- * @public
1212
1211
  * <p> Categories The categories that label and describe the type of insight.</p>
1212
+ * @public
1213
1213
  */
1214
1214
  Categories?: InsightCategory[];
1215
1215
  /**
1216
- * @public
1217
1216
  * <p>The current state of the insight.</p>
1217
+ * @public
1218
1218
  */
1219
1219
  State?: InsightState;
1220
1220
  /**
1221
- * @public
1222
1221
  * <p>The time, in Unix seconds, at which the insight began.</p>
1222
+ * @public
1223
1223
  */
1224
1224
  StartTime?: Date;
1225
1225
  /**
1226
- * @public
1227
1226
  * <p>The time, in Unix seconds, at which the insight ended.</p>
1227
+ * @public
1228
1228
  */
1229
1229
  EndTime?: Date;
1230
1230
  /**
1231
- * @public
1232
1231
  * <p>A brief description of the insight.</p>
1232
+ * @public
1233
1233
  */
1234
1234
  Summary?: string;
1235
1235
  /**
1236
- * @public
1237
1236
  * <p>The impact statistics of the client side service. This includes the number of requests
1238
1237
  * to the client service and whether the requests were faults or okay. </p>
1238
+ * @public
1239
1239
  */
1240
1240
  ClientRequestImpactStatistics?: RequestImpactStatistics;
1241
1241
  /**
1242
- * @public
1243
1242
  * <p>The impact statistics of the root cause service. This includes the number of requests to
1244
1243
  * the client service and whether the requests were faults or okay. </p>
1244
+ * @public
1245
1245
  */
1246
1246
  RootCauseServiceRequestImpactStatistics?: RequestImpactStatistics;
1247
1247
  /**
1248
- * @public
1249
1248
  * <p>The service within the insight that is most impacted by the incident.</p>
1249
+ * @public
1250
1250
  */
1251
1251
  TopAnomalousServices?: AnomalousService[];
1252
1252
  /**
1253
- * @public
1254
1253
  * <p>The time, in Unix seconds, that the insight was last updated.</p>
1254
+ * @public
1255
1255
  */
1256
1256
  LastUpdateTime?: Date;
1257
1257
  }
@@ -1260,15 +1260,15 @@ export interface InsightSummary {
1260
1260
  */
1261
1261
  export interface GetInsightSummariesResult {
1262
1262
  /**
1263
- * @public
1264
1263
  * <p>The summary of each insight within the group matching the provided filters. The summary
1265
1264
  * contains the InsightID, start and end time, the root cause service, the root cause and
1266
1265
  * client impact statistics, the top anomalous services, and the status of the insight.</p>
1266
+ * @public
1267
1267
  */
1268
1268
  InsightSummaries?: InsightSummary[];
1269
1269
  /**
1270
- * @public
1271
1270
  * <p>Pagination token.</p>
1271
+ * @public
1272
1272
  */
1273
1273
  NextToken?: string;
1274
1274
  }
@@ -1277,8 +1277,8 @@ export interface GetInsightSummariesResult {
1277
1277
  */
1278
1278
  export interface GetSamplingRulesRequest {
1279
1279
  /**
1280
- * @public
1281
1280
  * <p>Pagination token.</p>
1281
+ * @public
1282
1282
  */
1283
1283
  NextToken?: string;
1284
1284
  }
@@ -1287,13 +1287,13 @@ export interface GetSamplingRulesRequest {
1287
1287
  */
1288
1288
  export interface GetSamplingRulesResult {
1289
1289
  /**
1290
- * @public
1291
1290
  * <p>Rule definitions and metadata.</p>
1291
+ * @public
1292
1292
  */
1293
1293
  SamplingRuleRecords?: SamplingRuleRecord[];
1294
1294
  /**
1295
- * @public
1296
1295
  * <p>Pagination token.</p>
1296
+ * @public
1297
1297
  */
1298
1298
  NextToken?: string;
1299
1299
  }
@@ -1302,39 +1302,39 @@ export interface GetSamplingRulesResult {
1302
1302
  */
1303
1303
  export interface GetSamplingStatisticSummariesRequest {
1304
1304
  /**
1305
- * @public
1306
1305
  * <p>Pagination token.</p>
1306
+ * @public
1307
1307
  */
1308
1308
  NextToken?: string;
1309
1309
  }
1310
1310
  /**
1311
- * @public
1312
1311
  * <p>Aggregated request sampling data for a sampling rule across all services for a 10-second window.</p>
1312
+ * @public
1313
1313
  */
1314
1314
  export interface SamplingStatisticSummary {
1315
1315
  /**
1316
- * @public
1317
1316
  * <p>The name of the sampling rule.</p>
1317
+ * @public
1318
1318
  */
1319
1319
  RuleName?: string;
1320
1320
  /**
1321
- * @public
1322
1321
  * <p>The start time of the reporting window.</p>
1322
+ * @public
1323
1323
  */
1324
1324
  Timestamp?: Date;
1325
1325
  /**
1326
- * @public
1327
1326
  * <p>The number of requests that matched the rule.</p>
1327
+ * @public
1328
1328
  */
1329
1329
  RequestCount?: number;
1330
1330
  /**
1331
- * @public
1332
1331
  * <p>The number of requests recorded with borrowed reservoir quota.</p>
1332
+ * @public
1333
1333
  */
1334
1334
  BorrowCount?: number;
1335
1335
  /**
1336
- * @public
1337
1336
  * <p>The number of requests recorded.</p>
1337
+ * @public
1338
1338
  */
1339
1339
  SampledCount?: number;
1340
1340
  }
@@ -1343,52 +1343,52 @@ export interface SamplingStatisticSummary {
1343
1343
  */
1344
1344
  export interface GetSamplingStatisticSummariesResult {
1345
1345
  /**
1346
- * @public
1347
1346
  * <p>Information about the number of requests instrumented for each sampling
1348
1347
  * rule.</p>
1348
+ * @public
1349
1349
  */
1350
1350
  SamplingStatisticSummaries?: SamplingStatisticSummary[];
1351
1351
  /**
1352
- * @public
1353
1352
  * <p>Pagination token.</p>
1353
+ * @public
1354
1354
  */
1355
1355
  NextToken?: string;
1356
1356
  }
1357
1357
  /**
1358
- * @public
1359
1358
  * <p>Request sampling results for a single rule from a service. Results are for the last 10
1360
1359
  * seconds unless the service has been assigned a longer reporting interval after a previous call
1361
1360
  * to <a href="https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html">GetSamplingTargets</a>.</p>
1361
+ * @public
1362
1362
  */
1363
1363
  export interface SamplingStatisticsDocument {
1364
1364
  /**
1365
- * @public
1366
1365
  * <p>The name of the sampling rule.</p>
1366
+ * @public
1367
1367
  */
1368
1368
  RuleName: string | undefined;
1369
1369
  /**
1370
- * @public
1371
1370
  * <p>A unique identifier for the service in hexadecimal.</p>
1371
+ * @public
1372
1372
  */
1373
1373
  ClientID: string | undefined;
1374
1374
  /**
1375
- * @public
1376
1375
  * <p>The current time.</p>
1376
+ * @public
1377
1377
  */
1378
1378
  Timestamp: Date | undefined;
1379
1379
  /**
1380
- * @public
1381
1380
  * <p>The number of requests that matched the rule.</p>
1381
+ * @public
1382
1382
  */
1383
1383
  RequestCount: number | undefined;
1384
1384
  /**
1385
- * @public
1386
1385
  * <p>The number of requests recorded.</p>
1386
+ * @public
1387
1387
  */
1388
1388
  SampledCount: number | undefined;
1389
1389
  /**
1390
- * @public
1391
1390
  * <p>The number of requests recorded with borrowed reservoir quota.</p>
1391
+ * @public
1392
1392
  */
1393
1393
  BorrowCount?: number;
1394
1394
  }
@@ -1397,65 +1397,65 @@ export interface SamplingStatisticsDocument {
1397
1397
  */
1398
1398
  export interface GetSamplingTargetsRequest {
1399
1399
  /**
1400
- * @public
1401
1400
  * <p>Information about rules that the service is using to sample requests.</p>
1401
+ * @public
1402
1402
  */
1403
1403
  SamplingStatisticsDocuments: SamplingStatisticsDocument[] | undefined;
1404
1404
  }
1405
1405
  /**
1406
- * @public
1407
1406
  * <p>Temporary changes to a sampling rule configuration. To meet the global sampling target for a rule, X-Ray
1408
1407
  * calculates a new reservoir for each service based on the recent sampling results of all services that called
1409
1408
  * <a href="https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html">GetSamplingTargets</a>.</p>
1409
+ * @public
1410
1410
  */
1411
1411
  export interface SamplingTargetDocument {
1412
1412
  /**
1413
- * @public
1414
1413
  * <p>The name of the sampling rule.</p>
1414
+ * @public
1415
1415
  */
1416
1416
  RuleName?: string;
1417
1417
  /**
1418
- * @public
1419
1418
  * <p>The percentage of matching requests to instrument, after the reservoir is
1420
1419
  * exhausted.</p>
1420
+ * @public
1421
1421
  */
1422
1422
  FixedRate?: number;
1423
1423
  /**
1424
- * @public
1425
1424
  * <p>The number of requests per second that X-Ray allocated for this service.</p>
1425
+ * @public
1426
1426
  */
1427
1427
  ReservoirQuota?: number;
1428
1428
  /**
1429
- * @public
1430
1429
  * <p>When the reservoir quota expires.</p>
1430
+ * @public
1431
1431
  */
1432
1432
  ReservoirQuotaTTL?: Date;
1433
1433
  /**
1434
- * @public
1435
1434
  * <p>The number of seconds for the service to wait before getting sampling targets
1436
1435
  * again.</p>
1436
+ * @public
1437
1437
  */
1438
1438
  Interval?: number;
1439
1439
  }
1440
1440
  /**
1441
- * @public
1442
1441
  * <p>Sampling statistics from a call to <a href="https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html">GetSamplingTargets</a> that X-Ray
1443
1442
  * could not process.</p>
1443
+ * @public
1444
1444
  */
1445
1445
  export interface UnprocessedStatistics {
1446
1446
  /**
1447
- * @public
1448
1447
  * <p>The name of the sampling rule.</p>
1448
+ * @public
1449
1449
  */
1450
1450
  RuleName?: string;
1451
1451
  /**
1452
- * @public
1453
1452
  * <p>The error code.</p>
1453
+ * @public
1454
1454
  */
1455
1455
  ErrorCode?: string;
1456
1456
  /**
1457
- * @public
1458
1457
  * <p>The error message.</p>
1458
+ * @public
1459
1459
  */
1460
1460
  Message?: string;
1461
1461
  }
@@ -1464,21 +1464,21 @@ export interface UnprocessedStatistics {
1464
1464
  */
1465
1465
  export interface GetSamplingTargetsResult {
1466
1466
  /**
1467
- * @public
1468
1467
  * <p>Updated rules that the service should use to sample requests.</p>
1468
+ * @public
1469
1469
  */
1470
1470
  SamplingTargetDocuments?: SamplingTargetDocument[];
1471
1471
  /**
1472
- * @public
1473
1472
  * <p>The last time a user changed the sampling rule configuration. If
1474
1473
  * the sampling rule configuration changed since the service last retrieved it, the service
1475
1474
  * should call <a href="https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingRules.html">GetSamplingRules</a> to get the latest version.</p>
1475
+ * @public
1476
1476
  */
1477
1477
  LastRuleModification?: Date;
1478
1478
  /**
1479
- * @public
1480
1479
  * <p>Information about <a href="https://docs.aws.amazon.com/xray/latest/api/API_SamplingStatisticsDocument.html">SamplingStatisticsDocument</a> that X-Ray could not
1481
1480
  * process.</p>
1481
+ * @public
1482
1482
  */
1483
1483
  UnprocessedStatistics?: UnprocessedStatistics[];
1484
1484
  }
@@ -1487,233 +1487,232 @@ export interface GetSamplingTargetsResult {
1487
1487
  */
1488
1488
  export interface GetServiceGraphRequest {
1489
1489
  /**
1490
- * @public
1491
1490
  * <p>The start of the time frame for which to generate a graph.</p>
1491
+ * @public
1492
1492
  */
1493
1493
  StartTime: Date | undefined;
1494
1494
  /**
1495
- * @public
1496
1495
  * <p>The end of the timeframe for which to generate a graph.</p>
1496
+ * @public
1497
1497
  */
1498
1498
  EndTime: Date | undefined;
1499
1499
  /**
1500
- * @public
1501
1500
  * <p>The name of a group based on which you want to generate a graph.</p>
1501
+ * @public
1502
1502
  */
1503
1503
  GroupName?: string;
1504
1504
  /**
1505
- * @public
1506
1505
  * <p>The Amazon Resource Name (ARN) of a group based on which you want to generate a graph.</p>
1506
+ * @public
1507
1507
  */
1508
1508
  GroupARN?: string;
1509
1509
  /**
1510
- * @public
1511
1510
  * <p>Pagination token.</p>
1511
+ * @public
1512
1512
  */
1513
1513
  NextToken?: string;
1514
1514
  }
1515
1515
  /**
1516
- * @public
1517
1516
  * <p>An entry in a histogram for a statistic. A histogram maps the range of observed values
1518
1517
  * on the X axis, and the prevalence of each value on the Y axis.</p>
1518
+ * @public
1519
1519
  */
1520
1520
  export interface HistogramEntry {
1521
1521
  /**
1522
- * @public
1523
1522
  * <p>The value of the entry.</p>
1523
+ * @public
1524
1524
  */
1525
1525
  Value?: number;
1526
1526
  /**
1527
- * @public
1528
1527
  * <p>The prevalence of the entry.</p>
1528
+ * @public
1529
1529
  */
1530
1530
  Count?: number;
1531
1531
  }
1532
1532
  /**
1533
- * @public
1534
1533
  * <p>Information about requests that failed with a 4xx Client Error status code.</p>
1534
+ * @public
1535
1535
  */
1536
1536
  export interface ErrorStatistics {
1537
1537
  /**
1538
- * @public
1539
1538
  * <p>The number of requests that failed with a 419 throttling status code.</p>
1539
+ * @public
1540
1540
  */
1541
1541
  ThrottleCount?: number;
1542
1542
  /**
1543
- * @public
1544
1543
  * <p>The number of requests that failed with untracked 4xx Client Error status
1545
1544
  * codes.</p>
1545
+ * @public
1546
1546
  */
1547
1547
  OtherCount?: number;
1548
1548
  /**
1549
- * @public
1550
1549
  * <p>The total number of requests that failed with a 4xx Client Error status code.</p>
1550
+ * @public
1551
1551
  */
1552
1552
  TotalCount?: number;
1553
1553
  }
1554
1554
  /**
1555
- * @public
1556
1555
  * <p>Information about requests that failed with a 5xx Server Error status code.</p>
1556
+ * @public
1557
1557
  */
1558
1558
  export interface FaultStatistics {
1559
1559
  /**
1560
- * @public
1561
1560
  * <p>The number of requests that failed with untracked 5xx Server Error status
1562
1561
  * codes.</p>
1562
+ * @public
1563
1563
  */
1564
1564
  OtherCount?: number;
1565
1565
  /**
1566
- * @public
1567
1566
  * <p>The total number of requests that failed with a 5xx Server Error status code.</p>
1567
+ * @public
1568
1568
  */
1569
1569
  TotalCount?: number;
1570
1570
  }
1571
1571
  /**
1572
- * @public
1573
1572
  * <p>Response statistics for an edge.</p>
1573
+ * @public
1574
1574
  */
1575
1575
  export interface EdgeStatistics {
1576
1576
  /**
1577
- * @public
1578
1577
  * <p>The number of requests that completed with a 2xx Success status code.</p>
1578
+ * @public
1579
1579
  */
1580
1580
  OkCount?: number;
1581
1581
  /**
1582
- * @public
1583
1582
  * <p>Information about requests that failed with a 4xx Client Error status code.</p>
1583
+ * @public
1584
1584
  */
1585
1585
  ErrorStatistics?: ErrorStatistics;
1586
1586
  /**
1587
- * @public
1588
1587
  * <p>Information about requests that failed with a 5xx Server Error status code.</p>
1588
+ * @public
1589
1589
  */
1590
1590
  FaultStatistics?: FaultStatistics;
1591
1591
  /**
1592
- * @public
1593
1592
  * <p>The total number of completed requests.</p>
1593
+ * @public
1594
1594
  */
1595
1595
  TotalCount?: number;
1596
1596
  /**
1597
- * @public
1598
1597
  * <p>The aggregate response time of completed requests.</p>
1598
+ * @public
1599
1599
  */
1600
1600
  TotalResponseTime?: number;
1601
1601
  }
1602
1602
  /**
1603
- * @public
1604
1603
  * <p>Information about a connection between two services. An edge can be a synchronous connection, such as typical
1605
1604
  * call between client and service, or an asynchronous link, such as a Lambda function which retrieves an event from an
1606
1605
  * SNS queue.</p>
1606
+ * @public
1607
1607
  */
1608
1608
  export interface Edge {
1609
1609
  /**
1610
- * @public
1611
1610
  * <p>Identifier of the edge. Unique within a service map.</p>
1611
+ * @public
1612
1612
  */
1613
1613
  ReferenceId?: number;
1614
1614
  /**
1615
- * @public
1616
1615
  * <p>The start time of the first segment on the edge.</p>
1616
+ * @public
1617
1617
  */
1618
1618
  StartTime?: Date;
1619
1619
  /**
1620
- * @public
1621
1620
  * <p>The end time of the last segment on the edge.</p>
1621
+ * @public
1622
1622
  */
1623
1623
  EndTime?: Date;
1624
1624
  /**
1625
- * @public
1626
1625
  * <p>Response statistics for segments on the edge.</p>
1626
+ * @public
1627
1627
  */
1628
1628
  SummaryStatistics?: EdgeStatistics;
1629
1629
  /**
1630
- * @public
1631
1630
  * <p>A histogram that maps the spread of client response times on an edge. Only populated
1632
1631
  * for synchronous edges.</p>
1632
+ * @public
1633
1633
  */
1634
1634
  ResponseTimeHistogram?: HistogramEntry[];
1635
1635
  /**
1636
- * @public
1637
1636
  * <p>Aliases for the edge.</p>
1637
+ * @public
1638
1638
  */
1639
1639
  Aliases?: Alias[];
1640
1640
  /**
1641
- * @public
1642
1641
  * <p>Describes an asynchronous connection, with a value of <code>link</code>.</p>
1642
+ * @public
1643
1643
  */
1644
1644
  EdgeType?: string;
1645
1645
  /**
1646
- * @public
1647
1646
  * <p>A histogram that maps the spread of event age when received by consumers.
1648
1647
  * Age is calculated each time an event is received. Only populated when <i>EdgeType</i> is
1649
1648
  * <code>link</code>.</p>
1649
+ * @public
1650
1650
  */
1651
1651
  ReceivedEventAgeHistogram?: HistogramEntry[];
1652
1652
  }
1653
1653
  /**
1654
- * @public
1655
1654
  * <p>Response statistics for a service.</p>
1655
+ * @public
1656
1656
  */
1657
1657
  export interface ServiceStatistics {
1658
1658
  /**
1659
- * @public
1660
1659
  * <p>The number of requests that completed with a 2xx Success status code.</p>
1660
+ * @public
1661
1661
  */
1662
1662
  OkCount?: number;
1663
1663
  /**
1664
- * @public
1665
1664
  * <p>Information about requests that failed with a 4xx Client Error status code.</p>
1665
+ * @public
1666
1666
  */
1667
1667
  ErrorStatistics?: ErrorStatistics;
1668
1668
  /**
1669
- * @public
1670
1669
  * <p>Information about requests that failed with a 5xx Server Error status code.</p>
1670
+ * @public
1671
1671
  */
1672
1672
  FaultStatistics?: FaultStatistics;
1673
1673
  /**
1674
- * @public
1675
1674
  * <p>The total number of completed requests.</p>
1675
+ * @public
1676
1676
  */
1677
1677
  TotalCount?: number;
1678
1678
  /**
1679
- * @public
1680
1679
  * <p>The aggregate response time of completed requests.</p>
1680
+ * @public
1681
1681
  */
1682
1682
  TotalResponseTime?: number;
1683
1683
  }
1684
1684
  /**
1685
- * @public
1686
1685
  * <p>Information about an application that processed requests, users that made requests, or downstream services,
1687
1686
  * resources, and applications that an application used.</p>
1687
+ * @public
1688
1688
  */
1689
1689
  export interface Service {
1690
1690
  /**
1691
- * @public
1692
1691
  * <p>Identifier for the service. Unique within the service map.</p>
1692
+ * @public
1693
1693
  */
1694
1694
  ReferenceId?: number;
1695
1695
  /**
1696
- * @public
1697
1696
  * <p>The canonical name of the service.</p>
1697
+ * @public
1698
1698
  */
1699
1699
  Name?: string;
1700
1700
  /**
1701
- * @public
1702
1701
  * <p>A list of names for the service, including the canonical name.</p>
1702
+ * @public
1703
1703
  */
1704
1704
  Names?: string[];
1705
1705
  /**
1706
- * @public
1707
1706
  * <p>Indicates that the service was the first service to process a request.</p>
1707
+ * @public
1708
1708
  */
1709
1709
  Root?: boolean;
1710
1710
  /**
1711
- * @public
1712
1711
  * <p>Identifier of the Amazon Web Services account in which the service runs.</p>
1712
+ * @public
1713
1713
  */
1714
1714
  AccountId?: string;
1715
1715
  /**
1716
- * @public
1717
1716
  * <p>The type of service.</p>
1718
1717
  * <ul>
1719
1718
  * <li>
@@ -1735,41 +1734,42 @@ export interface Service {
1735
1734
  * <code>remote</code> - A downstream service of indeterminate type.</p>
1736
1735
  * </li>
1737
1736
  * </ul>
1737
+ * @public
1738
1738
  */
1739
1739
  Type?: string;
1740
1740
  /**
1741
- * @public
1742
1741
  * <p>The service's state.</p>
1742
+ * @public
1743
1743
  */
1744
1744
  State?: string;
1745
1745
  /**
1746
- * @public
1747
1746
  * <p>The start time of the first segment that the service generated.</p>
1747
+ * @public
1748
1748
  */
1749
1749
  StartTime?: Date;
1750
1750
  /**
1751
- * @public
1752
1751
  * <p>The end time of the last segment that the service generated.</p>
1752
+ * @public
1753
1753
  */
1754
1754
  EndTime?: Date;
1755
1755
  /**
1756
- * @public
1757
1756
  * <p>Connections to downstream services.</p>
1757
+ * @public
1758
1758
  */
1759
1759
  Edges?: Edge[];
1760
1760
  /**
1761
- * @public
1762
1761
  * <p>Aggregated statistics for the service.</p>
1762
+ * @public
1763
1763
  */
1764
1764
  SummaryStatistics?: ServiceStatistics;
1765
1765
  /**
1766
- * @public
1767
1766
  * <p>A histogram that maps the spread of service durations.</p>
1767
+ * @public
1768
1768
  */
1769
1769
  DurationHistogram?: HistogramEntry[];
1770
1770
  /**
1771
- * @public
1772
1771
  * <p>A histogram that maps the spread of service response times.</p>
1772
+ * @public
1773
1773
  */
1774
1774
  ResponseTimeHistogram?: HistogramEntry[];
1775
1775
  }
@@ -1778,31 +1778,31 @@ export interface Service {
1778
1778
  */
1779
1779
  export interface GetServiceGraphResult {
1780
1780
  /**
1781
- * @public
1782
1781
  * <p>The start of the time frame for which the graph was generated.</p>
1782
+ * @public
1783
1783
  */
1784
1784
  StartTime?: Date;
1785
1785
  /**
1786
- * @public
1787
1786
  * <p>The end of the time frame for which the graph was generated.</p>
1787
+ * @public
1788
1788
  */
1789
1789
  EndTime?: Date;
1790
1790
  /**
1791
- * @public
1792
1791
  * <p>The services that have processed a traced request during the specified time
1793
1792
  * frame.</p>
1793
+ * @public
1794
1794
  */
1795
1795
  Services?: Service[];
1796
1796
  /**
1797
- * @public
1798
1797
  * <p>A flag indicating whether the group's filter expression has been consistent, or
1799
1798
  * if the returned service graph may show traces from an older version of the group's filter
1800
1799
  * expression.</p>
1800
+ * @public
1801
1801
  */
1802
1802
  ContainsOldGroupVersions?: boolean;
1803
1803
  /**
1804
- * @public
1805
1804
  * <p>Pagination token.</p>
1805
+ * @public
1806
1806
  */
1807
1807
  NextToken?: string;
1808
1808
  }
@@ -1811,94 +1811,94 @@ export interface GetServiceGraphResult {
1811
1811
  */
1812
1812
  export interface GetTimeSeriesServiceStatisticsRequest {
1813
1813
  /**
1814
- * @public
1815
1814
  * <p>The start of the time frame for which to aggregate statistics.</p>
1815
+ * @public
1816
1816
  */
1817
1817
  StartTime: Date | undefined;
1818
1818
  /**
1819
- * @public
1820
1819
  * <p>The end of the time frame for which to aggregate statistics.</p>
1820
+ * @public
1821
1821
  */
1822
1822
  EndTime: Date | undefined;
1823
1823
  /**
1824
- * @public
1825
1824
  * <p>The case-sensitive name of the group for which to pull statistics from.</p>
1825
+ * @public
1826
1826
  */
1827
1827
  GroupName?: string;
1828
1828
  /**
1829
- * @public
1830
1829
  * <p>The Amazon Resource Name (ARN) of the group for which to pull statistics from.</p>
1830
+ * @public
1831
1831
  */
1832
1832
  GroupARN?: string;
1833
1833
  /**
1834
- * @public
1835
1834
  * <p>A filter expression defining entities that will be aggregated for statistics.
1836
1835
  * Supports ID, service, and edge functions. If no selector expression is specified, edge
1837
1836
  * statistics are returned. </p>
1837
+ * @public
1838
1838
  */
1839
1839
  EntitySelectorExpression?: string;
1840
1840
  /**
1841
- * @public
1842
1841
  * <p>Aggregation period in seconds.</p>
1842
+ * @public
1843
1843
  */
1844
1844
  Period?: number;
1845
1845
  /**
1846
- * @public
1847
1846
  * <p>The forecasted high and low fault count values. Forecast enabled requests require the
1848
1847
  * EntitySelectorExpression ID be provided.</p>
1848
+ * @public
1849
1849
  */
1850
1850
  ForecastStatistics?: boolean;
1851
1851
  /**
1852
- * @public
1853
1852
  * <p>Pagination token.</p>
1853
+ * @public
1854
1854
  */
1855
1855
  NextToken?: string;
1856
1856
  }
1857
1857
  /**
1858
- * @public
1859
1858
  * <p>The predicted high and low fault count. This is used to determine if a service has
1860
1859
  * become anomalous and if an insight should be created.</p>
1860
+ * @public
1861
1861
  */
1862
1862
  export interface ForecastStatistics {
1863
1863
  /**
1864
- * @public
1865
1864
  * <p>The upper limit of fault counts for a service.</p>
1865
+ * @public
1866
1866
  */
1867
1867
  FaultCountHigh?: number;
1868
1868
  /**
1869
- * @public
1870
1869
  * <p>The lower limit of fault counts for a service.</p>
1870
+ * @public
1871
1871
  */
1872
1872
  FaultCountLow?: number;
1873
1873
  }
1874
1874
  /**
1875
- * @public
1876
1875
  * <p>A list of TimeSeriesStatistic structures.</p>
1876
+ * @public
1877
1877
  */
1878
1878
  export interface TimeSeriesServiceStatistics {
1879
1879
  /**
1880
- * @public
1881
1880
  * <p>Timestamp of the window for which statistics are aggregated.</p>
1881
+ * @public
1882
1882
  */
1883
1883
  Timestamp?: Date;
1884
1884
  /**
1885
- * @public
1886
1885
  * <p>Response statistics for an edge.</p>
1886
+ * @public
1887
1887
  */
1888
1888
  EdgeSummaryStatistics?: EdgeStatistics;
1889
1889
  /**
1890
- * @public
1891
1890
  * <p>Response statistics for a service.</p>
1891
+ * @public
1892
1892
  */
1893
1893
  ServiceSummaryStatistics?: ServiceStatistics;
1894
1894
  /**
1895
- * @public
1896
1895
  * <p>The forecasted high and low fault count values.</p>
1896
+ * @public
1897
1897
  */
1898
1898
  ServiceForecastStatistics?: ForecastStatistics;
1899
1899
  /**
1900
- * @public
1901
1900
  * <p>The response time histogram for the selected entities.</p>
1901
+ * @public
1902
1902
  */
1903
1903
  ResponseTimeHistogram?: HistogramEntry[];
1904
1904
  }
@@ -1907,19 +1907,19 @@ export interface TimeSeriesServiceStatistics {
1907
1907
  */
1908
1908
  export interface GetTimeSeriesServiceStatisticsResult {
1909
1909
  /**
1910
- * @public
1911
1910
  * <p>The collection of statistics.</p>
1911
+ * @public
1912
1912
  */
1913
1913
  TimeSeriesServiceStatistics?: TimeSeriesServiceStatistics[];
1914
1914
  /**
1915
- * @public
1916
1915
  * <p>A flag indicating whether or not a group's filter expression has been consistent, or if a returned
1917
1916
  * aggregation might show statistics from an older version of the group's filter expression.</p>
1917
+ * @public
1918
1918
  */
1919
1919
  ContainsOldGroupVersions?: boolean;
1920
1920
  /**
1921
- * @public
1922
1921
  * <p>Pagination token.</p>
1922
+ * @public
1923
1923
  */
1924
1924
  NextToken?: string;
1925
1925
  }
@@ -1928,13 +1928,13 @@ export interface GetTimeSeriesServiceStatisticsResult {
1928
1928
  */
1929
1929
  export interface GetTraceGraphRequest {
1930
1930
  /**
1931
- * @public
1932
1931
  * <p>Trace IDs of requests for which to generate a service graph.</p>
1932
+ * @public
1933
1933
  */
1934
1934
  TraceIds: string[] | undefined;
1935
1935
  /**
1936
- * @public
1937
1936
  * <p>Pagination token.</p>
1937
+ * @public
1938
1938
  */
1939
1939
  NextToken?: string;
1940
1940
  }
@@ -1943,13 +1943,13 @@ export interface GetTraceGraphRequest {
1943
1943
  */
1944
1944
  export interface GetTraceGraphResult {
1945
1945
  /**
1946
- * @public
1947
1946
  * <p>The services that have processed one of the specified requests.</p>
1947
+ * @public
1948
1948
  */
1949
1949
  Services?: Service[];
1950
1950
  /**
1951
- * @public
1952
1951
  * <p>Pagination token.</p>
1952
+ * @public
1953
1953
  */
1954
1954
  NextToken?: string;
1955
1955
  }
@@ -1966,18 +1966,18 @@ export declare const SamplingStrategyName: {
1966
1966
  */
1967
1967
  export type SamplingStrategyName = (typeof SamplingStrategyName)[keyof typeof SamplingStrategyName];
1968
1968
  /**
1969
- * @public
1970
1969
  * <p>The name and value of a sampling rule to apply to a trace summary.</p>
1970
+ * @public
1971
1971
  */
1972
1972
  export interface SamplingStrategy {
1973
1973
  /**
1974
- * @public
1975
1974
  * <p>The name of a sampling rule.</p>
1975
+ * @public
1976
1976
  */
1977
1977
  Name?: SamplingStrategyName;
1978
1978
  /**
1979
- * @public
1980
1979
  * <p>The value of a sampling rule.</p>
1980
+ * @public
1981
1981
  */
1982
1982
  Value?: number;
1983
1983
  }
@@ -1999,471 +1999,471 @@ export type TimeRangeType = (typeof TimeRangeType)[keyof typeof TimeRangeType];
1999
1999
  */
2000
2000
  export interface GetTraceSummariesRequest {
2001
2001
  /**
2002
- * @public
2003
2002
  * <p>The start of the time frame for which to retrieve traces.</p>
2003
+ * @public
2004
2004
  */
2005
2005
  StartTime: Date | undefined;
2006
2006
  /**
2007
- * @public
2008
2007
  * <p>The end of the time frame for which to retrieve traces.</p>
2008
+ * @public
2009
2009
  */
2010
2010
  EndTime: Date | undefined;
2011
2011
  /**
2012
- * @public
2013
2012
  * <p>A parameter to indicate whether to query trace summaries by TraceId, Event (trace update time), or Service (segment end time).</p>
2013
+ * @public
2014
2014
  */
2015
2015
  TimeRangeType?: TimeRangeType;
2016
2016
  /**
2017
- * @public
2018
2017
  * <p>Set to <code>true</code> to get summaries for only a subset of available
2019
2018
  * traces.</p>
2019
+ * @public
2020
2020
  */
2021
2021
  Sampling?: boolean;
2022
2022
  /**
2023
- * @public
2024
2023
  * <p>A parameter to indicate whether to enable sampling on trace summaries. Input parameters are Name and
2025
2024
  * Value.</p>
2025
+ * @public
2026
2026
  */
2027
2027
  SamplingStrategy?: SamplingStrategy;
2028
2028
  /**
2029
- * @public
2030
2029
  * <p>Specify a filter expression to retrieve trace summaries for services or requests that
2031
2030
  * meet certain requirements.</p>
2031
+ * @public
2032
2032
  */
2033
2033
  FilterExpression?: string;
2034
2034
  /**
2035
- * @public
2036
2035
  * <p>Specify the pagination token returned by a previous request to retrieve the next page
2037
2036
  * of results.</p>
2037
+ * @public
2038
2038
  */
2039
2039
  NextToken?: string;
2040
2040
  }
2041
2041
  /**
2042
- * @public
2043
2042
  * <p>The exception associated with a root cause.</p>
2043
+ * @public
2044
2044
  */
2045
2045
  export interface RootCauseException {
2046
2046
  /**
2047
- * @public
2048
2047
  * <p>The name of the exception.</p>
2048
+ * @public
2049
2049
  */
2050
2050
  Name?: string;
2051
2051
  /**
2052
- * @public
2053
2052
  * <p>The message of the exception.</p>
2053
+ * @public
2054
2054
  */
2055
2055
  Message?: string;
2056
2056
  }
2057
2057
  /**
2058
- * @public
2059
2058
  * <p>A collection of segments and corresponding subsegments associated to a trace summary
2060
2059
  * error.</p>
2060
+ * @public
2061
2061
  */
2062
2062
  export interface ErrorRootCauseEntity {
2063
2063
  /**
2064
- * @public
2065
2064
  * <p>The name of the entity.</p>
2065
+ * @public
2066
2066
  */
2067
2067
  Name?: string;
2068
2068
  /**
2069
- * @public
2070
2069
  * <p>The types and messages of the exceptions.</p>
2070
+ * @public
2071
2071
  */
2072
2072
  Exceptions?: RootCauseException[];
2073
2073
  /**
2074
- * @public
2075
2074
  * <p>A flag that denotes a remote subsegment.</p>
2075
+ * @public
2076
2076
  */
2077
2077
  Remote?: boolean;
2078
2078
  }
2079
2079
  /**
2080
- * @public
2081
2080
  * <p>A collection of fields identifying the services in a trace summary error.</p>
2081
+ * @public
2082
2082
  */
2083
2083
  export interface ErrorRootCauseService {
2084
2084
  /**
2085
- * @public
2086
2085
  * <p>The service name.</p>
2086
+ * @public
2087
2087
  */
2088
2088
  Name?: string;
2089
2089
  /**
2090
- * @public
2091
2090
  * <p>A collection of associated service names.</p>
2091
+ * @public
2092
2092
  */
2093
2093
  Names?: string[];
2094
2094
  /**
2095
- * @public
2096
2095
  * <p>The type associated to the service.</p>
2096
+ * @public
2097
2097
  */
2098
2098
  Type?: string;
2099
2099
  /**
2100
- * @public
2101
2100
  * <p>The account ID associated to the service.</p>
2101
+ * @public
2102
2102
  */
2103
2103
  AccountId?: string;
2104
2104
  /**
2105
- * @public
2106
2105
  * <p>The path of root cause entities found on the service. </p>
2106
+ * @public
2107
2107
  */
2108
2108
  EntityPath?: ErrorRootCauseEntity[];
2109
2109
  /**
2110
- * @public
2111
2110
  * <p>A Boolean value indicating if the service is inferred from the trace.</p>
2111
+ * @public
2112
2112
  */
2113
2113
  Inferred?: boolean;
2114
2114
  }
2115
2115
  /**
2116
- * @public
2117
2116
  * <p>The root cause of a trace summary error.</p>
2117
+ * @public
2118
2118
  */
2119
2119
  export interface ErrorRootCause {
2120
2120
  /**
2121
- * @public
2122
2121
  * <p>A list of services corresponding to an error. A service identifies a segment and it
2123
2122
  * contains a name, account ID, type, and inferred flag.</p>
2123
+ * @public
2124
2124
  */
2125
2125
  Services?: ErrorRootCauseService[];
2126
2126
  /**
2127
- * @public
2128
2127
  * <p>A flag that denotes that the root cause impacts the trace client.</p>
2128
+ * @public
2129
2129
  */
2130
2130
  ClientImpacting?: boolean;
2131
2131
  }
2132
2132
  /**
2133
- * @public
2134
2133
  * <p>A collection of segments and corresponding subsegments associated to a trace summary
2135
2134
  * fault error.</p>
2135
+ * @public
2136
2136
  */
2137
2137
  export interface FaultRootCauseEntity {
2138
2138
  /**
2139
- * @public
2140
2139
  * <p>The name of the entity.</p>
2140
+ * @public
2141
2141
  */
2142
2142
  Name?: string;
2143
2143
  /**
2144
- * @public
2145
2144
  * <p>The types and messages of the exceptions.</p>
2145
+ * @public
2146
2146
  */
2147
2147
  Exceptions?: RootCauseException[];
2148
2148
  /**
2149
- * @public
2150
2149
  * <p>A flag that denotes a remote subsegment.</p>
2150
+ * @public
2151
2151
  */
2152
2152
  Remote?: boolean;
2153
2153
  }
2154
2154
  /**
2155
- * @public
2156
2155
  * <p>A collection of fields identifying the services in a trace summary fault.</p>
2156
+ * @public
2157
2157
  */
2158
2158
  export interface FaultRootCauseService {
2159
2159
  /**
2160
- * @public
2161
2160
  * <p>The service name.</p>
2161
+ * @public
2162
2162
  */
2163
2163
  Name?: string;
2164
2164
  /**
2165
- * @public
2166
2165
  * <p>A collection of associated service names.</p>
2166
+ * @public
2167
2167
  */
2168
2168
  Names?: string[];
2169
2169
  /**
2170
- * @public
2171
2170
  * <p>The type associated to the service.</p>
2171
+ * @public
2172
2172
  */
2173
2173
  Type?: string;
2174
2174
  /**
2175
- * @public
2176
2175
  * <p>The account ID associated to the service.</p>
2176
+ * @public
2177
2177
  */
2178
2178
  AccountId?: string;
2179
2179
  /**
2180
- * @public
2181
2180
  * <p>The path of root cause entities found on the service. </p>
2181
+ * @public
2182
2182
  */
2183
2183
  EntityPath?: FaultRootCauseEntity[];
2184
2184
  /**
2185
- * @public
2186
2185
  * <p>A Boolean value indicating if the service is inferred from the trace.</p>
2186
+ * @public
2187
2187
  */
2188
2188
  Inferred?: boolean;
2189
2189
  }
2190
2190
  /**
2191
- * @public
2192
2191
  * <p>The root cause information for a trace summary fault.</p>
2192
+ * @public
2193
2193
  */
2194
2194
  export interface FaultRootCause {
2195
2195
  /**
2196
- * @public
2197
2196
  * <p>A list of corresponding services. A service identifies a segment and it contains a
2198
2197
  * name, account ID, type, and inferred flag.</p>
2198
+ * @public
2199
2199
  */
2200
2200
  Services?: FaultRootCauseService[];
2201
2201
  /**
2202
- * @public
2203
2202
  * <p>A flag that denotes that the root cause impacts the trace client.</p>
2203
+ * @public
2204
2204
  */
2205
2205
  ClientImpacting?: boolean;
2206
2206
  }
2207
2207
  /**
2208
- * @public
2209
2208
  * <p>Information about an HTTP request.</p>
2209
+ * @public
2210
2210
  */
2211
2211
  export interface Http {
2212
2212
  /**
2213
- * @public
2214
2213
  * <p>The request URL.</p>
2214
+ * @public
2215
2215
  */
2216
2216
  HttpURL?: string;
2217
2217
  /**
2218
- * @public
2219
2218
  * <p>The response status.</p>
2219
+ * @public
2220
2220
  */
2221
2221
  HttpStatus?: number;
2222
2222
  /**
2223
- * @public
2224
2223
  * <p>The request method.</p>
2224
+ * @public
2225
2225
  */
2226
2226
  HttpMethod?: string;
2227
2227
  /**
2228
- * @public
2229
2228
  * <p>The request's user agent string.</p>
2229
+ * @public
2230
2230
  */
2231
2231
  UserAgent?: string;
2232
2232
  /**
2233
- * @public
2234
2233
  * <p>The IP address of the requestor.</p>
2234
+ * @public
2235
2235
  */
2236
2236
  ClientIp?: string;
2237
2237
  }
2238
2238
  /**
2239
- * @public
2240
2239
  * <p>A list of EC2 instance IDs corresponding to the segments in a trace. </p>
2240
+ * @public
2241
2241
  */
2242
2242
  export interface InstanceIdDetail {
2243
2243
  /**
2244
- * @public
2245
2244
  * <p>The ID of a corresponding EC2 instance.</p>
2245
+ * @public
2246
2246
  */
2247
2247
  Id?: string;
2248
2248
  }
2249
2249
  /**
2250
- * @public
2251
2250
  * <p>A list of resources ARNs corresponding to the segments in a trace.</p>
2251
+ * @public
2252
2252
  */
2253
2253
  export interface ResourceARNDetail {
2254
2254
  /**
2255
- * @public
2256
2255
  * <p>The ARN of a corresponding resource.</p>
2256
+ * @public
2257
2257
  */
2258
2258
  ARN?: string;
2259
2259
  }
2260
2260
  /**
2261
- * @public
2262
2261
  * <p>A collection of segments and corresponding subsegments associated to a response time
2263
2262
  * warning.</p>
2263
+ * @public
2264
2264
  */
2265
2265
  export interface ResponseTimeRootCauseEntity {
2266
2266
  /**
2267
- * @public
2268
2267
  * <p>The name of the entity.</p>
2268
+ * @public
2269
2269
  */
2270
2270
  Name?: string;
2271
2271
  /**
2272
- * @public
2273
2272
  * <p>The type and messages of the exceptions.</p>
2273
+ * @public
2274
2274
  */
2275
2275
  Coverage?: number;
2276
2276
  /**
2277
- * @public
2278
2277
  * <p>A flag that denotes a remote subsegment.</p>
2278
+ * @public
2279
2279
  */
2280
2280
  Remote?: boolean;
2281
2281
  }
2282
2282
  /**
2283
- * @public
2284
2283
  * <p>A collection of fields identifying the service in a response time warning.</p>
2284
+ * @public
2285
2285
  */
2286
2286
  export interface ResponseTimeRootCauseService {
2287
2287
  /**
2288
- * @public
2289
2288
  * <p>The service name.</p>
2289
+ * @public
2290
2290
  */
2291
2291
  Name?: string;
2292
2292
  /**
2293
- * @public
2294
2293
  * <p>A collection of associated service names.</p>
2294
+ * @public
2295
2295
  */
2296
2296
  Names?: string[];
2297
2297
  /**
2298
- * @public
2299
2298
  * <p>The type associated to the service.</p>
2299
+ * @public
2300
2300
  */
2301
2301
  Type?: string;
2302
2302
  /**
2303
- * @public
2304
2303
  * <p>The account ID associated to the service.</p>
2304
+ * @public
2305
2305
  */
2306
2306
  AccountId?: string;
2307
2307
  /**
2308
- * @public
2309
2308
  * <p>The path of root cause entities found on the service. </p>
2309
+ * @public
2310
2310
  */
2311
2311
  EntityPath?: ResponseTimeRootCauseEntity[];
2312
2312
  /**
2313
- * @public
2314
2313
  * <p>A Boolean value indicating if the service is inferred from the trace.</p>
2314
+ * @public
2315
2315
  */
2316
2316
  Inferred?: boolean;
2317
2317
  }
2318
2318
  /**
2319
- * @public
2320
2319
  * <p>The root cause information for a response time warning.</p>
2320
+ * @public
2321
2321
  */
2322
2322
  export interface ResponseTimeRootCause {
2323
2323
  /**
2324
- * @public
2325
2324
  * <p>A list of corresponding services. A service identifies a segment and contains a name,
2326
2325
  * account ID, type, and inferred flag.</p>
2326
+ * @public
2327
2327
  */
2328
2328
  Services?: ResponseTimeRootCauseService[];
2329
2329
  /**
2330
- * @public
2331
2330
  * <p>A flag that denotes that the root cause impacts the trace client.</p>
2331
+ * @public
2332
2332
  */
2333
2333
  ClientImpacting?: boolean;
2334
2334
  }
2335
2335
  /**
2336
- * @public
2337
2336
  * <p>Information about a user recorded in segment documents.</p>
2337
+ * @public
2338
2338
  */
2339
2339
  export interface TraceUser {
2340
2340
  /**
2341
- * @public
2342
2341
  * <p>The user's name.</p>
2342
+ * @public
2343
2343
  */
2344
2344
  UserName?: string;
2345
2345
  /**
2346
- * @public
2347
2346
  * <p>Services that the user's request hit.</p>
2347
+ * @public
2348
2348
  */
2349
2349
  ServiceIds?: ServiceId[];
2350
2350
  }
2351
2351
  /**
2352
- * @public
2353
2352
  * <p>Metadata generated from the segment documents in a trace.</p>
2353
+ * @public
2354
2354
  */
2355
2355
  export interface TraceSummary {
2356
2356
  /**
2357
- * @public
2358
2357
  * <p>The unique identifier for the request that generated the trace's segments and
2359
2358
  * subsegments.</p>
2359
+ * @public
2360
2360
  */
2361
2361
  Id?: string;
2362
2362
  /**
2363
- * @public
2364
2363
  * <p>The start time of a trace, based on the earliest trace segment start time.</p>
2364
+ * @public
2365
2365
  */
2366
2366
  StartTime?: Date;
2367
2367
  /**
2368
- * @public
2369
2368
  * <p>The length of time in seconds between the start time of the root segment and the end
2370
2369
  * time of the last segment that completed.</p>
2370
+ * @public
2371
2371
  */
2372
2372
  Duration?: number;
2373
2373
  /**
2374
- * @public
2375
2374
  * <p>The length of time in seconds between the start and end times of the root segment. If
2376
2375
  * the service performs work asynchronously, the response time measures the time before the
2377
2376
  * response is sent to the user, while the duration measures the amount of time before the last
2378
2377
  * traced activity completes.</p>
2378
+ * @public
2379
2379
  */
2380
2380
  ResponseTime?: number;
2381
2381
  /**
2382
- * @public
2383
2382
  * <p>The root segment document has a 500 series error.</p>
2383
+ * @public
2384
2384
  */
2385
2385
  HasFault?: boolean;
2386
2386
  /**
2387
- * @public
2388
2387
  * <p>The root segment document has a 400 series error.</p>
2388
+ * @public
2389
2389
  */
2390
2390
  HasError?: boolean;
2391
2391
  /**
2392
- * @public
2393
2392
  * <p>One or more of the segment documents has a 429 throttling error.</p>
2393
+ * @public
2394
2394
  */
2395
2395
  HasThrottle?: boolean;
2396
2396
  /**
2397
- * @public
2398
2397
  * <p>One or more of the segment documents is in progress.</p>
2398
+ * @public
2399
2399
  */
2400
2400
  IsPartial?: boolean;
2401
2401
  /**
2402
- * @public
2403
2402
  * <p>Information about the HTTP request served by the trace.</p>
2403
+ * @public
2404
2404
  */
2405
2405
  Http?: Http;
2406
2406
  /**
2407
- * @public
2408
2407
  * <p>Annotations from the trace's segment documents.</p>
2408
+ * @public
2409
2409
  */
2410
2410
  Annotations?: Record<string, ValueWithServiceIds[]>;
2411
2411
  /**
2412
- * @public
2413
2412
  * <p>Users from the trace's segment documents.</p>
2413
+ * @public
2414
2414
  */
2415
2415
  Users?: TraceUser[];
2416
2416
  /**
2417
- * @public
2418
2417
  * <p>Service IDs from the trace's segment documents.</p>
2418
+ * @public
2419
2419
  */
2420
2420
  ServiceIds?: ServiceId[];
2421
2421
  /**
2422
- * @public
2423
2422
  * <p>A list of resource ARNs for any resource corresponding to the trace segments.</p>
2423
+ * @public
2424
2424
  */
2425
2425
  ResourceARNs?: ResourceARNDetail[];
2426
2426
  /**
2427
- * @public
2428
2427
  * <p>A list of EC2 instance IDs for any instance corresponding to the trace
2429
2428
  * segments.</p>
2429
+ * @public
2430
2430
  */
2431
2431
  InstanceIds?: InstanceIdDetail[];
2432
2432
  /**
2433
- * @public
2434
2433
  * <p>A list of Availability Zones for any zone corresponding to the trace segments.</p>
2434
+ * @public
2435
2435
  */
2436
2436
  AvailabilityZones?: AvailabilityZoneDetail[];
2437
2437
  /**
2438
- * @public
2439
2438
  * <p>The root of a trace.</p>
2439
+ * @public
2440
2440
  */
2441
2441
  EntryPoint?: ServiceId;
2442
2442
  /**
2443
- * @public
2444
2443
  * <p>A collection of FaultRootCause structures corresponding to the trace segments.</p>
2444
+ * @public
2445
2445
  */
2446
2446
  FaultRootCauses?: FaultRootCause[];
2447
2447
  /**
2448
- * @public
2449
2448
  * <p>A collection of ErrorRootCause structures corresponding to the trace
2450
2449
  * segments.</p>
2450
+ * @public
2451
2451
  */
2452
2452
  ErrorRootCauses?: ErrorRootCause[];
2453
2453
  /**
2454
- * @public
2455
2454
  * <p>A collection of ResponseTimeRootCause structures corresponding to the trace
2456
2455
  * segments.</p>
2456
+ * @public
2457
2457
  */
2458
2458
  ResponseTimeRootCauses?: ResponseTimeRootCause[];
2459
2459
  /**
2460
- * @public
2461
2460
  * <p>The revision number of a trace.</p>
2461
+ * @public
2462
2462
  */
2463
2463
  Revision?: number;
2464
2464
  /**
2465
- * @public
2466
2465
  * <p>The matched time stamp of a defined event.</p>
2466
+ * @public
2467
2467
  */
2468
2468
  MatchedEventTime?: Date;
2469
2469
  }
@@ -2472,26 +2472,26 @@ export interface TraceSummary {
2472
2472
  */
2473
2473
  export interface GetTraceSummariesResult {
2474
2474
  /**
2475
- * @public
2476
2475
  * <p>Trace IDs and annotations for traces that were found in the specified time
2477
2476
  * frame.</p>
2477
+ * @public
2478
2478
  */
2479
2479
  TraceSummaries?: TraceSummary[];
2480
2480
  /**
2481
- * @public
2482
2481
  * <p>The start time of this page of results.</p>
2482
+ * @public
2483
2483
  */
2484
2484
  ApproximateTime?: Date;
2485
2485
  /**
2486
- * @public
2487
2486
  * <p>The total number of traces processed, including traces that did not match the specified
2488
2487
  * filter expression.</p>
2488
+ * @public
2489
2489
  */
2490
2490
  TracesProcessedCount?: number;
2491
2491
  /**
2492
- * @public
2493
2492
  * <p>If the requested time frame contained more than one page of results, you can use this token to retrieve the
2494
2493
  * next page. The first page contains the most recent results, closest to the end of the time frame.</p>
2494
+ * @public
2495
2495
  */
2496
2496
  NextToken?: string;
2497
2497
  }
@@ -2500,36 +2500,36 @@ export interface GetTraceSummariesResult {
2500
2500
  */
2501
2501
  export interface ListResourcePoliciesRequest {
2502
2502
  /**
2503
- * @public
2504
2503
  * <p>Not currently supported.</p>
2504
+ * @public
2505
2505
  */
2506
2506
  NextToken?: string;
2507
2507
  }
2508
2508
  /**
2509
- * @public
2510
2509
  * <p>A resource policy grants one or more Amazon Web Services services and accounts permissions
2511
2510
  * to access X-Ray. Each resource policy is associated with a
2512
2511
  * specific Amazon Web Services account.</p>
2512
+ * @public
2513
2513
  */
2514
2514
  export interface ResourcePolicy {
2515
2515
  /**
2516
- * @public
2517
2516
  * <p>The name of the resource policy. Must be unique within a specific Amazon Web Services account.</p>
2517
+ * @public
2518
2518
  */
2519
2519
  PolicyName?: string;
2520
2520
  /**
2521
- * @public
2522
2521
  * <p>The resource policy document, which can be up to 5kb in size.</p>
2522
+ * @public
2523
2523
  */
2524
2524
  PolicyDocument?: string;
2525
2525
  /**
2526
- * @public
2527
2526
  * <p>Returns the current policy revision id for this policy name.</p>
2527
+ * @public
2528
2528
  */
2529
2529
  PolicyRevisionId?: string;
2530
2530
  /**
2531
- * @public
2532
2531
  * <p>When the policy was last updated, in Unix time seconds.</p>
2532
+ * @public
2533
2533
  */
2534
2534
  LastUpdatedTime?: Date;
2535
2535
  }
@@ -2538,13 +2538,13 @@ export interface ResourcePolicy {
2538
2538
  */
2539
2539
  export interface ListResourcePoliciesResult {
2540
2540
  /**
2541
- * @public
2542
2541
  * <p>The list of resource policies in the target Amazon Web Services account.</p>
2542
+ * @public
2543
2543
  */
2544
2544
  ResourcePolicies?: ResourcePolicy[];
2545
2545
  /**
2546
- * @public
2547
2546
  * <p>Pagination token. Not currently supported.</p>
2547
+ * @public
2548
2548
  */
2549
2549
  NextToken?: string;
2550
2550
  }
@@ -2553,14 +2553,14 @@ export interface ListResourcePoliciesResult {
2553
2553
  */
2554
2554
  export interface ListTagsForResourceRequest {
2555
2555
  /**
2556
- * @public
2557
2556
  * <p>The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.</p>
2557
+ * @public
2558
2558
  */
2559
2559
  ResourceARN: string | undefined;
2560
2560
  /**
2561
- * @public
2562
2561
  * <p>A pagination token. If multiple pages of results are returned, use the <code>NextToken</code> value returned with
2563
2562
  * the current page of results as the value of this parameter to get the next page of results.</p>
2563
+ * @public
2564
2564
  */
2565
2565
  NextToken?: string;
2566
2566
  }
@@ -2569,21 +2569,21 @@ export interface ListTagsForResourceRequest {
2569
2569
  */
2570
2570
  export interface ListTagsForResourceResponse {
2571
2571
  /**
2572
- * @public
2573
2572
  * <p>A list of tags, as key and value pairs, that is associated with the specified X-Ray group or sampling rule.</p>
2573
+ * @public
2574
2574
  */
2575
2575
  Tags?: Tag[];
2576
2576
  /**
2577
- * @public
2578
2577
  * <p>A pagination token. If multiple pages of results are returned, use the <code>NextToken</code> value returned with
2579
2578
  * the current page of results to get the next page of results.</p>
2579
+ * @public
2580
2580
  */
2581
2581
  NextToken?: string;
2582
2582
  }
2583
2583
  /**
2584
- * @public
2585
2584
  * <p>The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is
2586
2585
  * correct.</p>
2586
+ * @public
2587
2587
  */
2588
2588
  export declare class ResourceNotFoundException extends __BaseException {
2589
2589
  readonly name: "ResourceNotFoundException";
@@ -2600,7 +2600,6 @@ export declare class ResourceNotFoundException extends __BaseException {
2600
2600
  */
2601
2601
  export interface PutEncryptionConfigRequest {
2602
2602
  /**
2603
- * @public
2604
2603
  * <p>An Amazon Web Services KMS key in one of the following formats:</p>
2605
2604
  * <ul>
2606
2605
  * <li>
@@ -2622,12 +2621,13 @@ export interface PutEncryptionConfigRequest {
2622
2621
  * </li>
2623
2622
  * </ul>
2624
2623
  * <p>Omit this key if you set <code>Type</code> to <code>NONE</code>.</p>
2624
+ * @public
2625
2625
  */
2626
2626
  KeyId?: string;
2627
2627
  /**
2628
- * @public
2629
2628
  * <p>The type of encryption. Set to <code>KMS</code> to use your own key for encryption. Set
2630
2629
  * to <code>NONE</code> for default encryption.</p>
2630
+ * @public
2631
2631
  */
2632
2632
  Type: EncryptionType | undefined;
2633
2633
  }
@@ -2636,14 +2636,14 @@ export interface PutEncryptionConfigRequest {
2636
2636
  */
2637
2637
  export interface PutEncryptionConfigResult {
2638
2638
  /**
2639
- * @public
2640
2639
  * <p>The new encryption configuration.</p>
2640
+ * @public
2641
2641
  */
2642
2642
  EncryptionConfig?: EncryptionConfig;
2643
2643
  }
2644
2644
  /**
2645
- * @public
2646
2645
  * <p>The provided resource policy would prevent the caller of this request from calling PutResourcePolicy in the future.</p>
2646
+ * @public
2647
2647
  */
2648
2648
  export declare class LockoutPreventionException extends __BaseException {
2649
2649
  readonly name: "LockoutPreventionException";
@@ -2655,8 +2655,8 @@ export declare class LockoutPreventionException extends __BaseException {
2655
2655
  constructor(opts: __ExceptionOptionType<LockoutPreventionException, __BaseException>);
2656
2656
  }
2657
2657
  /**
2658
- * @public
2659
2658
  * <p>Invalid policy document provided in request.</p>
2659
+ * @public
2660
2660
  */
2661
2661
  export declare class MalformedPolicyDocumentException extends __BaseException {
2662
2662
  readonly name: "MalformedPolicyDocumentException";
@@ -2668,8 +2668,8 @@ export declare class MalformedPolicyDocumentException extends __BaseException {
2668
2668
  constructor(opts: __ExceptionOptionType<MalformedPolicyDocumentException, __BaseException>);
2669
2669
  }
2670
2670
  /**
2671
- * @public
2672
2671
  * <p>Exceeded the maximum number of resource policies for a target Amazon Web Services account.</p>
2672
+ * @public
2673
2673
  */
2674
2674
  export declare class PolicyCountLimitExceededException extends __BaseException {
2675
2675
  readonly name: "PolicyCountLimitExceededException";
@@ -2681,8 +2681,8 @@ export declare class PolicyCountLimitExceededException extends __BaseException {
2681
2681
  constructor(opts: __ExceptionOptionType<PolicyCountLimitExceededException, __BaseException>);
2682
2682
  }
2683
2683
  /**
2684
- * @public
2685
2684
  * <p>Exceeded the maximum size for a resource policy.</p>
2685
+ * @public
2686
2686
  */
2687
2687
  export declare class PolicySizeLimitExceededException extends __BaseException {
2688
2688
  readonly name: "PolicySizeLimitExceededException";
@@ -2698,32 +2698,32 @@ export declare class PolicySizeLimitExceededException extends __BaseException {
2698
2698
  */
2699
2699
  export interface PutResourcePolicyRequest {
2700
2700
  /**
2701
- * @public
2702
2701
  * <p>The name of the resource policy. Must be unique within a specific Amazon Web Services account.</p>
2702
+ * @public
2703
2703
  */
2704
2704
  PolicyName: string | undefined;
2705
2705
  /**
2706
- * @public
2707
2706
  * <p>The resource policy document, which can be up to 5kb in size.</p>
2707
+ * @public
2708
2708
  */
2709
2709
  PolicyDocument: string | undefined;
2710
2710
  /**
2711
- * @public
2712
2711
  * <p>Specifies a specific policy revision, to ensure an atomic create operation. By default the resource policy is created if it does not exist, or updated with an incremented revision id.
2713
2712
  * The revision id is unique to each policy in the account.</p>
2714
2713
  * <p>If the policy revision id does not match the latest revision id, the operation will fail with an <code>InvalidPolicyRevisionIdException</code> exception. You can also provide a
2715
2714
  * <code>PolicyRevisionId</code> of 0. In this case, the operation will fail with an <code>InvalidPolicyRevisionIdException</code> exception if a resource policy with the same name already exists.
2716
2715
  * </p>
2716
+ * @public
2717
2717
  */
2718
2718
  PolicyRevisionId?: string;
2719
2719
  /**
2720
- * @public
2721
2720
  * <p>A flag to indicate whether to bypass the resource policy lockout safety check.</p>
2722
2721
  * <important>
2723
2722
  * <p>Setting this value to true increases the risk that the policy becomes unmanageable. Do not set this value to true indiscriminately.</p>
2724
2723
  * </important>
2725
2724
  * <p>Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent <code>PutResourcePolicy</code> request.</p>
2726
2725
  * <p>The default value is false.</p>
2726
+ * @public
2727
2727
  */
2728
2728
  BypassPolicyLockoutCheck?: boolean;
2729
2729
  }
@@ -2732,80 +2732,80 @@ export interface PutResourcePolicyRequest {
2732
2732
  */
2733
2733
  export interface PutResourcePolicyResult {
2734
2734
  /**
2735
- * @public
2736
2735
  * <p>The resource policy document, as provided in the <code>PutResourcePolicyRequest</code>.</p>
2736
+ * @public
2737
2737
  */
2738
2738
  ResourcePolicy?: ResourcePolicy;
2739
2739
  }
2740
2740
  /**
2741
- * @public
2742
2741
  * <p></p>
2742
+ * @public
2743
2743
  */
2744
2744
  export interface BackendConnectionErrors {
2745
2745
  /**
2746
- * @public
2747
2746
  * <p></p>
2747
+ * @public
2748
2748
  */
2749
2749
  TimeoutCount?: number;
2750
2750
  /**
2751
- * @public
2752
2751
  * <p></p>
2752
+ * @public
2753
2753
  */
2754
2754
  ConnectionRefusedCount?: number;
2755
2755
  /**
2756
- * @public
2757
2756
  * <p></p>
2757
+ * @public
2758
2758
  */
2759
2759
  HTTPCode4XXCount?: number;
2760
2760
  /**
2761
- * @public
2762
2761
  * <p></p>
2762
+ * @public
2763
2763
  */
2764
2764
  HTTPCode5XXCount?: number;
2765
2765
  /**
2766
- * @public
2767
2766
  * <p></p>
2767
+ * @public
2768
2768
  */
2769
2769
  UnknownHostCount?: number;
2770
2770
  /**
2771
- * @public
2772
2771
  * <p></p>
2772
+ * @public
2773
2773
  */
2774
2774
  OtherCount?: number;
2775
2775
  }
2776
2776
  /**
2777
- * @public
2778
2777
  * <p></p>
2778
+ * @public
2779
2779
  */
2780
2780
  export interface TelemetryRecord {
2781
2781
  /**
2782
- * @public
2783
2782
  * <p></p>
2783
+ * @public
2784
2784
  */
2785
2785
  Timestamp: Date | undefined;
2786
2786
  /**
2787
- * @public
2788
2787
  * <p></p>
2788
+ * @public
2789
2789
  */
2790
2790
  SegmentsReceivedCount?: number;
2791
2791
  /**
2792
- * @public
2793
2792
  * <p></p>
2793
+ * @public
2794
2794
  */
2795
2795
  SegmentsSentCount?: number;
2796
2796
  /**
2797
- * @public
2798
2797
  * <p></p>
2798
+ * @public
2799
2799
  */
2800
2800
  SegmentsSpilloverCount?: number;
2801
2801
  /**
2802
- * @public
2803
2802
  * <p></p>
2803
+ * @public
2804
2804
  */
2805
2805
  SegmentsRejectedCount?: number;
2806
2806
  /**
2807
- * @public
2808
2807
  * <p></p>
2808
+ * @public
2809
2809
  */
2810
2810
  BackendConnectionErrors?: BackendConnectionErrors;
2811
2811
  }
@@ -2814,23 +2814,23 @@ export interface TelemetryRecord {
2814
2814
  */
2815
2815
  export interface PutTelemetryRecordsRequest {
2816
2816
  /**
2817
- * @public
2818
2817
  * <p></p>
2818
+ * @public
2819
2819
  */
2820
2820
  TelemetryRecords: TelemetryRecord[] | undefined;
2821
2821
  /**
2822
- * @public
2823
2822
  * <p></p>
2823
+ * @public
2824
2824
  */
2825
2825
  EC2InstanceId?: string;
2826
2826
  /**
2827
- * @public
2828
2827
  * <p></p>
2828
+ * @public
2829
2829
  */
2830
2830
  Hostname?: string;
2831
2831
  /**
2832
- * @public
2833
2832
  * <p></p>
2833
+ * @public
2834
2834
  */
2835
2835
  ResourceARN?: string;
2836
2836
  }
@@ -2844,30 +2844,30 @@ export interface PutTelemetryRecordsResult {
2844
2844
  */
2845
2845
  export interface PutTraceSegmentsRequest {
2846
2846
  /**
2847
- * @public
2848
2847
  * <p>A string containing a JSON document defining one or more segments or
2849
2848
  * subsegments.</p>
2849
+ * @public
2850
2850
  */
2851
2851
  TraceSegmentDocuments: string[] | undefined;
2852
2852
  }
2853
2853
  /**
2854
- * @public
2855
2854
  * <p>Information about a segment that failed processing.</p>
2855
+ * @public
2856
2856
  */
2857
2857
  export interface UnprocessedTraceSegment {
2858
2858
  /**
2859
- * @public
2860
2859
  * <p>The segment's ID.</p>
2860
+ * @public
2861
2861
  */
2862
2862
  Id?: string;
2863
2863
  /**
2864
- * @public
2865
2864
  * <p>The error that caused processing to fail.</p>
2865
+ * @public
2866
2866
  */
2867
2867
  ErrorCode?: string;
2868
2868
  /**
2869
- * @public
2870
2869
  * <p>The error message.</p>
2870
+ * @public
2871
2871
  */
2872
2872
  Message?: string;
2873
2873
  }
@@ -2876,8 +2876,8 @@ export interface UnprocessedTraceSegment {
2876
2876
  */
2877
2877
  export interface PutTraceSegmentsResult {
2878
2878
  /**
2879
- * @public
2880
2879
  * <p>Segments that failed processing.</p>
2880
+ * @public
2881
2881
  */
2882
2882
  UnprocessedTraceSegments?: UnprocessedTraceSegment[];
2883
2883
  }
@@ -2886,12 +2886,11 @@ export interface PutTraceSegmentsResult {
2886
2886
  */
2887
2887
  export interface TagResourceRequest {
2888
2888
  /**
2889
- * @public
2890
2889
  * <p>The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.</p>
2890
+ * @public
2891
2891
  */
2892
2892
  ResourceARN: string | undefined;
2893
2893
  /**
2894
- * @public
2895
2894
  * <p>A map that contains one or more tag keys and tag values to attach to an X-Ray group or
2896
2895
  * sampling rule. For more information about ways to use tags, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>
2897
2896
  * in the <i>Amazon Web Services General Reference</i>.</p>
@@ -2918,6 +2917,7 @@ export interface TagResourceRequest {
2918
2917
  * cannot edit or delete system tags.</p>
2919
2918
  * </li>
2920
2919
  * </ul>
2920
+ * @public
2921
2921
  */
2922
2922
  Tags: Tag[] | undefined;
2923
2923
  }
@@ -2927,8 +2927,8 @@ export interface TagResourceRequest {
2927
2927
  export interface TagResourceResponse {
2928
2928
  }
2929
2929
  /**
2930
- * @public
2931
2930
  * <p>You have exceeded the maximum number of tags you can apply to this resource.</p>
2931
+ * @public
2932
2932
  */
2933
2933
  export declare class TooManyTagsException extends __BaseException {
2934
2934
  readonly name: "TooManyTagsException";
@@ -2945,13 +2945,13 @@ export declare class TooManyTagsException extends __BaseException {
2945
2945
  */
2946
2946
  export interface UntagResourceRequest {
2947
2947
  /**
2948
- * @public
2949
2948
  * <p>The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.</p>
2949
+ * @public
2950
2950
  */
2951
2951
  ResourceARN: string | undefined;
2952
2952
  /**
2953
- * @public
2954
2953
  * <p>Keys for one or more tags that you want to remove from an X-Ray group or sampling rule.</p>
2954
+ * @public
2955
2955
  */
2956
2956
  TagKeys: string[] | undefined;
2957
2957
  }
@@ -2965,22 +2965,21 @@ export interface UntagResourceResponse {
2965
2965
  */
2966
2966
  export interface UpdateGroupRequest {
2967
2967
  /**
2968
- * @public
2969
2968
  * <p>The case-sensitive name of the group.</p>
2969
+ * @public
2970
2970
  */
2971
2971
  GroupName?: string;
2972
2972
  /**
2973
- * @public
2974
2973
  * <p>The ARN that was generated upon creation.</p>
2974
+ * @public
2975
2975
  */
2976
2976
  GroupARN?: string;
2977
2977
  /**
2978
- * @public
2979
2978
  * <p>The updated filter expression defining criteria by which to group traces.</p>
2979
+ * @public
2980
2980
  */
2981
2981
  FilterExpression?: string;
2982
2982
  /**
2983
- * @public
2984
2983
  * <p>The structure containing configurations related to insights.</p>
2985
2984
  * <ul>
2986
2985
  * <li>
@@ -2992,6 +2991,7 @@ export interface UpdateGroupRequest {
2992
2991
  * Notifications can only be enabled on a group with InsightsEnabled set to true.</p>
2993
2992
  * </li>
2994
2993
  * </ul>
2994
+ * @public
2995
2995
  */
2996
2996
  InsightsConfiguration?: InsightsConfiguration;
2997
2997
  }
@@ -3000,78 +3000,78 @@ export interface UpdateGroupRequest {
3000
3000
  */
3001
3001
  export interface UpdateGroupResult {
3002
3002
  /**
3003
- * @public
3004
3003
  * <p>The group that was updated. Contains the name of the group that was updated, the
3005
3004
  * ARN of the group that was updated, the updated filter expression, and the updated insight
3006
3005
  * configuration assigned to the group.</p>
3006
+ * @public
3007
3007
  */
3008
3008
  Group?: Group;
3009
3009
  }
3010
3010
  /**
3011
- * @public
3012
3011
  * <p>A document specifying changes to a sampling rule's configuration.</p>
3012
+ * @public
3013
3013
  */
3014
3014
  export interface SamplingRuleUpdate {
3015
3015
  /**
3016
- * @public
3017
3016
  * <p>The name of the sampling rule. Specify a rule by either name or ARN, but not both.</p>
3017
+ * @public
3018
3018
  */
3019
3019
  RuleName?: string;
3020
3020
  /**
3021
- * @public
3022
3021
  * <p>The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.</p>
3022
+ * @public
3023
3023
  */
3024
3024
  RuleARN?: string;
3025
3025
  /**
3026
- * @public
3027
3026
  * <p>Matches the ARN of the Amazon Web Services resource on which the service runs.</p>
3027
+ * @public
3028
3028
  */
3029
3029
  ResourceARN?: string;
3030
3030
  /**
3031
- * @public
3032
3031
  * <p>The priority of the sampling rule.</p>
3032
+ * @public
3033
3033
  */
3034
3034
  Priority?: number;
3035
3035
  /**
3036
- * @public
3037
3036
  * <p>The percentage of matching requests to instrument, after the reservoir is
3038
3037
  * exhausted.</p>
3038
+ * @public
3039
3039
  */
3040
3040
  FixedRate?: number;
3041
3041
  /**
3042
- * @public
3043
3042
  * <p>A fixed number of matching requests to instrument per second, prior to applying the
3044
3043
  * fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.</p>
3044
+ * @public
3045
3045
  */
3046
3046
  ReservoirSize?: number;
3047
3047
  /**
3048
- * @public
3049
3048
  * <p>Matches the hostname from a request URL.</p>
3049
+ * @public
3050
3050
  */
3051
3051
  Host?: string;
3052
3052
  /**
3053
- * @public
3054
3053
  * <p>Matches the <code>name</code> that the service uses to identify itself in segments.</p>
3054
+ * @public
3055
3055
  */
3056
3056
  ServiceName?: string;
3057
3057
  /**
3058
- * @public
3059
3058
  * <p>Matches the <code>origin</code> that the service uses to identify its type in segments.</p>
3059
+ * @public
3060
3060
  */
3061
3061
  ServiceType?: string;
3062
3062
  /**
3063
- * @public
3064
3063
  * <p>Matches the HTTP method of a request.</p>
3064
+ * @public
3065
3065
  */
3066
3066
  HTTPMethod?: string;
3067
3067
  /**
3068
- * @public
3069
3068
  * <p>Matches the path from a request URL.</p>
3069
+ * @public
3070
3070
  */
3071
3071
  URLPath?: string;
3072
3072
  /**
3073
- * @public
3074
3073
  * <p>Matches attributes derived from the request.</p>
3074
+ * @public
3075
3075
  */
3076
3076
  Attributes?: Record<string, string>;
3077
3077
  }
@@ -3080,8 +3080,8 @@ export interface SamplingRuleUpdate {
3080
3080
  */
3081
3081
  export interface UpdateSamplingRuleRequest {
3082
3082
  /**
3083
- * @public
3084
3083
  * <p>The rule and fields to change.</p>
3084
+ * @public
3085
3085
  */
3086
3086
  SamplingRuleUpdate: SamplingRuleUpdate | undefined;
3087
3087
  }
@@ -3090,8 +3090,8 @@ export interface UpdateSamplingRuleRequest {
3090
3090
  */
3091
3091
  export interface UpdateSamplingRuleResult {
3092
3092
  /**
3093
- * @public
3094
3093
  * <p>The updated rule definition and metadata.</p>
3094
+ * @public
3095
3095
  */
3096
3096
  SamplingRuleRecord?: SamplingRuleRecord;
3097
3097
  }