@aws-sdk/client-xray 3.35.0 → 3.38.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 (295) hide show
  1. package/CHANGELOG.md +47 -0
  2. package/dist-cjs/XRay.js +0 -5
  3. package/dist-cjs/XRayClient.js +0 -10
  4. package/dist-cjs/commands/BatchGetTracesCommand.js +0 -27
  5. package/dist-cjs/commands/CreateGroupCommand.js +0 -25
  6. package/dist-cjs/commands/CreateSamplingRuleCommand.js +0 -31
  7. package/dist-cjs/commands/DeleteGroupCommand.js +0 -25
  8. package/dist-cjs/commands/DeleteSamplingRuleCommand.js +0 -25
  9. package/dist-cjs/commands/GetEncryptionConfigCommand.js +0 -25
  10. package/dist-cjs/commands/GetGroupCommand.js +0 -25
  11. package/dist-cjs/commands/GetGroupsCommand.js +0 -25
  12. package/dist-cjs/commands/GetInsightCommand.js +0 -27
  13. package/dist-cjs/commands/GetInsightEventsCommand.js +0 -27
  14. package/dist-cjs/commands/GetInsightImpactGraphCommand.js +0 -26
  15. package/dist-cjs/commands/GetInsightSummariesCommand.js +0 -25
  16. package/dist-cjs/commands/GetSamplingRulesCommand.js +0 -25
  17. package/dist-cjs/commands/GetSamplingStatisticSummariesCommand.js +0 -25
  18. package/dist-cjs/commands/GetSamplingTargetsCommand.js +0 -26
  19. package/dist-cjs/commands/GetServiceGraphCommand.js +0 -29
  20. package/dist-cjs/commands/GetTimeSeriesServiceStatisticsCommand.js +0 -26
  21. package/dist-cjs/commands/GetTraceGraphCommand.js +0 -25
  22. package/dist-cjs/commands/GetTraceSummariesCommand.js +0 -41
  23. package/dist-cjs/commands/ListTagsForResourceCommand.js +0 -25
  24. package/dist-cjs/commands/PutEncryptionConfigCommand.js +0 -25
  25. package/dist-cjs/commands/PutTelemetryRecordsCommand.js +0 -25
  26. package/dist-cjs/commands/PutTraceSegmentsCommand.js +0 -87
  27. package/dist-cjs/commands/TagResourceCommand.js +0 -25
  28. package/dist-cjs/commands/UntagResourceCommand.js +0 -26
  29. package/dist-cjs/commands/UpdateGroupCommand.js +0 -25
  30. package/dist-cjs/commands/UpdateSamplingRuleCommand.js +0 -25
  31. package/dist-cjs/commands/index.js +30 -0
  32. package/dist-cjs/endpoints.js +1 -2
  33. package/dist-cjs/index.js +4 -41
  34. package/dist-cjs/models/index.js +0 -1
  35. package/dist-cjs/models/models_0.js +0 -340
  36. package/dist-cjs/pagination/BatchGetTracesPaginator.js +0 -11
  37. package/dist-cjs/pagination/GetGroupsPaginator.js +0 -11
  38. package/dist-cjs/pagination/GetInsightEventsPaginator.js +0 -11
  39. package/dist-cjs/pagination/GetInsightSummariesPaginator.js +0 -11
  40. package/dist-cjs/pagination/GetSamplingRulesPaginator.js +0 -11
  41. package/dist-cjs/pagination/GetSamplingStatisticSummariesPaginator.js +0 -11
  42. package/dist-cjs/pagination/GetServiceGraphPaginator.js +0 -11
  43. package/dist-cjs/pagination/GetTimeSeriesServiceStatisticsPaginator.js +0 -11
  44. package/dist-cjs/pagination/GetTraceGraphPaginator.js +0 -11
  45. package/dist-cjs/pagination/GetTraceSummariesPaginator.js +0 -11
  46. package/dist-cjs/pagination/Interfaces.js +0 -1
  47. package/dist-cjs/pagination/index.js +14 -0
  48. package/dist-cjs/protocols/Aws_restJson1.js +0 -6
  49. package/dist-cjs/runtimeConfig.browser.js +1 -6
  50. package/dist-cjs/runtimeConfig.js +2 -7
  51. package/dist-cjs/runtimeConfig.native.js +0 -4
  52. package/dist-cjs/runtimeConfig.shared.js +0 -4
  53. package/dist-es/XRay.js +0 -1
  54. package/dist-es/XRayClient.js +0 -1
  55. package/dist-es/commands/BatchGetTracesCommand.js +0 -1
  56. package/dist-es/commands/CreateGroupCommand.js +0 -1
  57. package/dist-es/commands/CreateSamplingRuleCommand.js +0 -1
  58. package/dist-es/commands/DeleteGroupCommand.js +0 -1
  59. package/dist-es/commands/DeleteSamplingRuleCommand.js +0 -1
  60. package/dist-es/commands/GetEncryptionConfigCommand.js +0 -1
  61. package/dist-es/commands/GetGroupCommand.js +0 -1
  62. package/dist-es/commands/GetGroupsCommand.js +0 -1
  63. package/dist-es/commands/GetInsightCommand.js +0 -1
  64. package/dist-es/commands/GetInsightEventsCommand.js +0 -1
  65. package/dist-es/commands/GetInsightImpactGraphCommand.js +0 -1
  66. package/dist-es/commands/GetInsightSummariesCommand.js +0 -1
  67. package/dist-es/commands/GetSamplingRulesCommand.js +0 -1
  68. package/dist-es/commands/GetSamplingStatisticSummariesCommand.js +0 -1
  69. package/dist-es/commands/GetSamplingTargetsCommand.js +0 -1
  70. package/dist-es/commands/GetServiceGraphCommand.js +0 -1
  71. package/dist-es/commands/GetTimeSeriesServiceStatisticsCommand.js +0 -1
  72. package/dist-es/commands/GetTraceGraphCommand.js +0 -1
  73. package/dist-es/commands/GetTraceSummariesCommand.js +0 -1
  74. package/dist-es/commands/ListTagsForResourceCommand.js +0 -1
  75. package/dist-es/commands/PutEncryptionConfigCommand.js +0 -1
  76. package/dist-es/commands/PutTelemetryRecordsCommand.js +0 -1
  77. package/dist-es/commands/PutTraceSegmentsCommand.js +0 -1
  78. package/dist-es/commands/TagResourceCommand.js +0 -1
  79. package/dist-es/commands/UntagResourceCommand.js +0 -1
  80. package/dist-es/commands/UpdateGroupCommand.js +0 -1
  81. package/dist-es/commands/UpdateSamplingRuleCommand.js +0 -1
  82. package/dist-es/commands/index.js +27 -0
  83. package/dist-es/endpoints.js +1 -2
  84. package/dist-es/index.js +4 -41
  85. package/dist-es/models/index.js +0 -1
  86. package/dist-es/models/models_0.js +0 -1
  87. package/dist-es/pagination/BatchGetTracesPaginator.js +0 -1
  88. package/dist-es/pagination/GetGroupsPaginator.js +0 -1
  89. package/dist-es/pagination/GetInsightEventsPaginator.js +0 -1
  90. package/dist-es/pagination/GetInsightSummariesPaginator.js +0 -1
  91. package/dist-es/pagination/GetSamplingRulesPaginator.js +0 -1
  92. package/dist-es/pagination/GetSamplingStatisticSummariesPaginator.js +0 -1
  93. package/dist-es/pagination/GetServiceGraphPaginator.js +0 -1
  94. package/dist-es/pagination/GetTimeSeriesServiceStatisticsPaginator.js +0 -1
  95. package/dist-es/pagination/GetTraceGraphPaginator.js +0 -1
  96. package/dist-es/pagination/GetTraceSummariesPaginator.js +0 -1
  97. package/dist-es/pagination/Interfaces.js +0 -1
  98. package/dist-es/pagination/index.js +11 -0
  99. package/dist-es/protocols/Aws_restJson1.js +0 -1
  100. package/dist-es/runtimeConfig.browser.js +1 -2
  101. package/dist-es/runtimeConfig.js +2 -3
  102. package/dist-es/runtimeConfig.native.js +0 -1
  103. package/dist-es/runtimeConfig.shared.js +0 -1
  104. package/dist-types/commands/index.d.ts +27 -0
  105. package/dist-types/index.d.ts +4 -40
  106. package/dist-types/pagination/index.d.ts +11 -0
  107. package/dist-types/ts3.4/XRay.d.ts +28 -183
  108. package/dist-types/ts3.4/XRayClient.d.ts +24 -90
  109. package/dist-types/ts3.4/commands/BatchGetTracesCommand.d.ts +2 -22
  110. package/dist-types/ts3.4/commands/CreateGroupCommand.d.ts +2 -20
  111. package/dist-types/ts3.4/commands/CreateSamplingRuleCommand.d.ts +2 -26
  112. package/dist-types/ts3.4/commands/DeleteGroupCommand.d.ts +2 -20
  113. package/dist-types/ts3.4/commands/DeleteSamplingRuleCommand.d.ts +2 -20
  114. package/dist-types/ts3.4/commands/GetEncryptionConfigCommand.d.ts +2 -20
  115. package/dist-types/ts3.4/commands/GetGroupCommand.d.ts +2 -20
  116. package/dist-types/ts3.4/commands/GetGroupsCommand.d.ts +2 -20
  117. package/dist-types/ts3.4/commands/GetInsightCommand.d.ts +2 -22
  118. package/dist-types/ts3.4/commands/GetInsightEventsCommand.d.ts +2 -22
  119. package/dist-types/ts3.4/commands/GetInsightImpactGraphCommand.d.ts +2 -21
  120. package/dist-types/ts3.4/commands/GetInsightSummariesCommand.d.ts +2 -20
  121. package/dist-types/ts3.4/commands/GetSamplingRulesCommand.d.ts +2 -20
  122. package/dist-types/ts3.4/commands/GetSamplingStatisticSummariesCommand.d.ts +2 -20
  123. package/dist-types/ts3.4/commands/GetSamplingTargetsCommand.d.ts +2 -21
  124. package/dist-types/ts3.4/commands/GetServiceGraphCommand.d.ts +2 -24
  125. package/dist-types/ts3.4/commands/GetTimeSeriesServiceStatisticsCommand.d.ts +2 -21
  126. package/dist-types/ts3.4/commands/GetTraceGraphCommand.d.ts +2 -20
  127. package/dist-types/ts3.4/commands/GetTraceSummariesCommand.d.ts +2 -36
  128. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +2 -20
  129. package/dist-types/ts3.4/commands/PutEncryptionConfigCommand.d.ts +2 -20
  130. package/dist-types/ts3.4/commands/PutTelemetryRecordsCommand.d.ts +2 -20
  131. package/dist-types/ts3.4/commands/PutTraceSegmentsCommand.d.ts +2 -82
  132. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +2 -20
  133. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +2 -21
  134. package/dist-types/ts3.4/commands/UpdateGroupCommand.d.ts +2 -20
  135. package/dist-types/ts3.4/commands/UpdateSamplingRuleCommand.d.ts +2 -20
  136. package/dist-types/ts3.4/commands/index.d.ts +27 -0
  137. package/dist-types/ts3.4/index.d.ts +4 -40
  138. package/dist-types/ts3.4/models/models_0.d.ts +540 -1902
  139. package/dist-types/ts3.4/pagination/index.d.ts +11 -0
  140. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
  141. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
  142. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
  143. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
  144. package/package.json +33 -30
  145. package/dist-cjs/XRay.js.map +0 -1
  146. package/dist-cjs/XRayClient.js.map +0 -1
  147. package/dist-cjs/commands/BatchGetTracesCommand.js.map +0 -1
  148. package/dist-cjs/commands/CreateGroupCommand.js.map +0 -1
  149. package/dist-cjs/commands/CreateSamplingRuleCommand.js.map +0 -1
  150. package/dist-cjs/commands/DeleteGroupCommand.js.map +0 -1
  151. package/dist-cjs/commands/DeleteSamplingRuleCommand.js.map +0 -1
  152. package/dist-cjs/commands/GetEncryptionConfigCommand.js.map +0 -1
  153. package/dist-cjs/commands/GetGroupCommand.js.map +0 -1
  154. package/dist-cjs/commands/GetGroupsCommand.js.map +0 -1
  155. package/dist-cjs/commands/GetInsightCommand.js.map +0 -1
  156. package/dist-cjs/commands/GetInsightEventsCommand.js.map +0 -1
  157. package/dist-cjs/commands/GetInsightImpactGraphCommand.js.map +0 -1
  158. package/dist-cjs/commands/GetInsightSummariesCommand.js.map +0 -1
  159. package/dist-cjs/commands/GetSamplingRulesCommand.js.map +0 -1
  160. package/dist-cjs/commands/GetSamplingStatisticSummariesCommand.js.map +0 -1
  161. package/dist-cjs/commands/GetSamplingTargetsCommand.js.map +0 -1
  162. package/dist-cjs/commands/GetServiceGraphCommand.js.map +0 -1
  163. package/dist-cjs/commands/GetTimeSeriesServiceStatisticsCommand.js.map +0 -1
  164. package/dist-cjs/commands/GetTraceGraphCommand.js.map +0 -1
  165. package/dist-cjs/commands/GetTraceSummariesCommand.js.map +0 -1
  166. package/dist-cjs/commands/ListTagsForResourceCommand.js.map +0 -1
  167. package/dist-cjs/commands/PutEncryptionConfigCommand.js.map +0 -1
  168. package/dist-cjs/commands/PutTelemetryRecordsCommand.js.map +0 -1
  169. package/dist-cjs/commands/PutTraceSegmentsCommand.js.map +0 -1
  170. package/dist-cjs/commands/TagResourceCommand.js.map +0 -1
  171. package/dist-cjs/commands/UntagResourceCommand.js.map +0 -1
  172. package/dist-cjs/commands/UpdateGroupCommand.js.map +0 -1
  173. package/dist-cjs/commands/UpdateSamplingRuleCommand.js.map +0 -1
  174. package/dist-cjs/endpoints.js.map +0 -1
  175. package/dist-cjs/index.js.map +0 -1
  176. package/dist-cjs/models/index.js.map +0 -1
  177. package/dist-cjs/models/models_0.js.map +0 -1
  178. package/dist-cjs/pagination/BatchGetTracesPaginator.js.map +0 -1
  179. package/dist-cjs/pagination/GetGroupsPaginator.js.map +0 -1
  180. package/dist-cjs/pagination/GetInsightEventsPaginator.js.map +0 -1
  181. package/dist-cjs/pagination/GetInsightSummariesPaginator.js.map +0 -1
  182. package/dist-cjs/pagination/GetSamplingRulesPaginator.js.map +0 -1
  183. package/dist-cjs/pagination/GetSamplingStatisticSummariesPaginator.js.map +0 -1
  184. package/dist-cjs/pagination/GetServiceGraphPaginator.js.map +0 -1
  185. package/dist-cjs/pagination/GetTimeSeriesServiceStatisticsPaginator.js.map +0 -1
  186. package/dist-cjs/pagination/GetTraceGraphPaginator.js.map +0 -1
  187. package/dist-cjs/pagination/GetTraceSummariesPaginator.js.map +0 -1
  188. package/dist-cjs/pagination/Interfaces.js.map +0 -1
  189. package/dist-cjs/protocols/Aws_restJson1.js.map +0 -1
  190. package/dist-cjs/runtimeConfig.browser.js.map +0 -1
  191. package/dist-cjs/runtimeConfig.js.map +0 -1
  192. package/dist-cjs/runtimeConfig.native.js.map +0 -1
  193. package/dist-cjs/runtimeConfig.shared.js.map +0 -1
  194. package/dist-es/XRay.js.map +0 -1
  195. package/dist-es/XRayClient.js.map +0 -1
  196. package/dist-es/commands/BatchGetTracesCommand.js.map +0 -1
  197. package/dist-es/commands/CreateGroupCommand.js.map +0 -1
  198. package/dist-es/commands/CreateSamplingRuleCommand.js.map +0 -1
  199. package/dist-es/commands/DeleteGroupCommand.js.map +0 -1
  200. package/dist-es/commands/DeleteSamplingRuleCommand.js.map +0 -1
  201. package/dist-es/commands/GetEncryptionConfigCommand.js.map +0 -1
  202. package/dist-es/commands/GetGroupCommand.js.map +0 -1
  203. package/dist-es/commands/GetGroupsCommand.js.map +0 -1
  204. package/dist-es/commands/GetInsightCommand.js.map +0 -1
  205. package/dist-es/commands/GetInsightEventsCommand.js.map +0 -1
  206. package/dist-es/commands/GetInsightImpactGraphCommand.js.map +0 -1
  207. package/dist-es/commands/GetInsightSummariesCommand.js.map +0 -1
  208. package/dist-es/commands/GetSamplingRulesCommand.js.map +0 -1
  209. package/dist-es/commands/GetSamplingStatisticSummariesCommand.js.map +0 -1
  210. package/dist-es/commands/GetSamplingTargetsCommand.js.map +0 -1
  211. package/dist-es/commands/GetServiceGraphCommand.js.map +0 -1
  212. package/dist-es/commands/GetTimeSeriesServiceStatisticsCommand.js.map +0 -1
  213. package/dist-es/commands/GetTraceGraphCommand.js.map +0 -1
  214. package/dist-es/commands/GetTraceSummariesCommand.js.map +0 -1
  215. package/dist-es/commands/ListTagsForResourceCommand.js.map +0 -1
  216. package/dist-es/commands/PutEncryptionConfigCommand.js.map +0 -1
  217. package/dist-es/commands/PutTelemetryRecordsCommand.js.map +0 -1
  218. package/dist-es/commands/PutTraceSegmentsCommand.js.map +0 -1
  219. package/dist-es/commands/TagResourceCommand.js.map +0 -1
  220. package/dist-es/commands/UntagResourceCommand.js.map +0 -1
  221. package/dist-es/commands/UpdateGroupCommand.js.map +0 -1
  222. package/dist-es/commands/UpdateSamplingRuleCommand.js.map +0 -1
  223. package/dist-es/endpoints.js.map +0 -1
  224. package/dist-es/index.js.map +0 -1
  225. package/dist-es/models/index.js.map +0 -1
  226. package/dist-es/models/models_0.js.map +0 -1
  227. package/dist-es/pagination/BatchGetTracesPaginator.js.map +0 -1
  228. package/dist-es/pagination/GetGroupsPaginator.js.map +0 -1
  229. package/dist-es/pagination/GetInsightEventsPaginator.js.map +0 -1
  230. package/dist-es/pagination/GetInsightSummariesPaginator.js.map +0 -1
  231. package/dist-es/pagination/GetSamplingRulesPaginator.js.map +0 -1
  232. package/dist-es/pagination/GetSamplingStatisticSummariesPaginator.js.map +0 -1
  233. package/dist-es/pagination/GetServiceGraphPaginator.js.map +0 -1
  234. package/dist-es/pagination/GetTimeSeriesServiceStatisticsPaginator.js.map +0 -1
  235. package/dist-es/pagination/GetTraceGraphPaginator.js.map +0 -1
  236. package/dist-es/pagination/GetTraceSummariesPaginator.js.map +0 -1
  237. package/dist-es/pagination/Interfaces.js.map +0 -1
  238. package/dist-es/protocols/Aws_restJson1.js.map +0 -1
  239. package/dist-es/runtimeConfig.browser.js.map +0 -1
  240. package/dist-es/runtimeConfig.js.map +0 -1
  241. package/dist-es/runtimeConfig.native.js.map +0 -1
  242. package/dist-es/runtimeConfig.shared.js.map +0 -1
  243. package/jest.config.js +0 -4
  244. package/src/XRay.ts +0 -1036
  245. package/src/XRayClient.ts +0 -342
  246. package/src/commands/BatchGetTracesCommand.ts +0 -97
  247. package/src/commands/CreateGroupCommand.ts +0 -95
  248. package/src/commands/CreateSamplingRuleCommand.ts +0 -101
  249. package/src/commands/DeleteGroupCommand.ts +0 -95
  250. package/src/commands/DeleteSamplingRuleCommand.ts +0 -95
  251. package/src/commands/GetEncryptionConfigCommand.ts +0 -95
  252. package/src/commands/GetGroupCommand.ts +0 -91
  253. package/src/commands/GetGroupsCommand.ts +0 -95
  254. package/src/commands/GetInsightCommand.ts +0 -97
  255. package/src/commands/GetInsightEventsCommand.ts +0 -97
  256. package/src/commands/GetInsightImpactGraphCommand.ts +0 -96
  257. package/src/commands/GetInsightSummariesCommand.ts +0 -95
  258. package/src/commands/GetSamplingRulesCommand.ts +0 -95
  259. package/src/commands/GetSamplingStatisticSummariesCommand.ts +0 -100
  260. package/src/commands/GetSamplingTargetsCommand.ts +0 -96
  261. package/src/commands/GetServiceGraphCommand.ts +0 -99
  262. package/src/commands/GetTimeSeriesServiceStatisticsCommand.ts +0 -104
  263. package/src/commands/GetTraceGraphCommand.ts +0 -95
  264. package/src/commands/GetTraceSummariesCommand.ts +0 -111
  265. package/src/commands/ListTagsForResourceCommand.ts +0 -95
  266. package/src/commands/PutEncryptionConfigCommand.ts +0 -95
  267. package/src/commands/PutTelemetryRecordsCommand.ts +0 -95
  268. package/src/commands/PutTraceSegmentsCommand.ts +0 -157
  269. package/src/commands/TagResourceCommand.ts +0 -95
  270. package/src/commands/UntagResourceCommand.ts +0 -96
  271. package/src/commands/UpdateGroupCommand.ts +0 -95
  272. package/src/commands/UpdateSamplingRuleCommand.ts +0 -95
  273. package/src/endpoints.ts +0 -86
  274. package/src/index.ts +0 -41
  275. package/src/models/index.ts +0 -1
  276. package/src/models/models_0.ts +0 -3647
  277. package/src/pagination/BatchGetTracesPaginator.ts +0 -58
  278. package/src/pagination/GetGroupsPaginator.ts +0 -54
  279. package/src/pagination/GetInsightEventsPaginator.ts +0 -59
  280. package/src/pagination/GetInsightSummariesPaginator.ts +0 -59
  281. package/src/pagination/GetSamplingRulesPaginator.ts +0 -58
  282. package/src/pagination/GetSamplingStatisticSummariesPaginator.ts +0 -58
  283. package/src/pagination/GetServiceGraphPaginator.ts +0 -58
  284. package/src/pagination/GetTimeSeriesServiceStatisticsPaginator.ts +0 -58
  285. package/src/pagination/GetTraceGraphPaginator.ts +0 -58
  286. package/src/pagination/GetTraceSummariesPaginator.ts +0 -58
  287. package/src/pagination/Interfaces.ts +0 -8
  288. package/src/protocols/Aws_restJson1.ts +0 -4338
  289. package/src/runtimeConfig.browser.ts +0 -41
  290. package/src/runtimeConfig.native.ts +0 -17
  291. package/src/runtimeConfig.shared.ts +0 -17
  292. package/src/runtimeConfig.ts +0 -46
  293. package/tsconfig.es.json +0 -10
  294. package/tsconfig.json +0 -33
  295. package/tsconfig.types.json +0 -9
@@ -1,3647 +0,0 @@
1
- import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
2
-
3
- /**
4
- * <p>An alias for an edge.</p>
5
- */
6
- export interface Alias {
7
- /**
8
- * <p>The canonical name of the alias.</p>
9
- */
10
- Name?: string;
11
-
12
- /**
13
- * <p>A list of names for the alias, including the canonical name.</p>
14
- */
15
- Names?: string[];
16
-
17
- /**
18
- * <p>The type of the alias.</p>
19
- */
20
- Type?: string;
21
- }
22
-
23
- export namespace Alias {
24
- /**
25
- * @internal
26
- */
27
- export const filterSensitiveLog = (obj: Alias): any => ({
28
- ...obj,
29
- });
30
- }
31
-
32
- /**
33
- * <p>Value of a segment annotation. Has one of three value types: Number, Boolean, or String.</p>
34
- */
35
- export type AnnotationValue =
36
- | AnnotationValue.BooleanValueMember
37
- | AnnotationValue.NumberValueMember
38
- | AnnotationValue.StringValueMember
39
- | AnnotationValue.$UnknownMember;
40
-
41
- export namespace AnnotationValue {
42
- /**
43
- * <p>Value for a Number annotation.</p>
44
- */
45
- export interface NumberValueMember {
46
- NumberValue: number;
47
- BooleanValue?: never;
48
- StringValue?: never;
49
- $unknown?: never;
50
- }
51
-
52
- /**
53
- * <p>Value for a Boolean annotation.</p>
54
- */
55
- export interface BooleanValueMember {
56
- NumberValue?: never;
57
- BooleanValue: boolean;
58
- StringValue?: never;
59
- $unknown?: never;
60
- }
61
-
62
- /**
63
- * <p>Value for a String annotation.</p>
64
- */
65
- export interface StringValueMember {
66
- NumberValue?: never;
67
- BooleanValue?: never;
68
- StringValue: string;
69
- $unknown?: never;
70
- }
71
-
72
- export interface $UnknownMember {
73
- NumberValue?: never;
74
- BooleanValue?: never;
75
- StringValue?: never;
76
- $unknown: [string, any];
77
- }
78
-
79
- export interface Visitor<T> {
80
- NumberValue: (value: number) => T;
81
- BooleanValue: (value: boolean) => T;
82
- StringValue: (value: string) => T;
83
- _: (name: string, value: any) => T;
84
- }
85
-
86
- export const visit = <T>(value: AnnotationValue, visitor: Visitor<T>): T => {
87
- if (value.NumberValue !== undefined) return visitor.NumberValue(value.NumberValue);
88
- if (value.BooleanValue !== undefined) return visitor.BooleanValue(value.BooleanValue);
89
- if (value.StringValue !== undefined) return visitor.StringValue(value.StringValue);
90
- return visitor._(value.$unknown[0], value.$unknown[1]);
91
- };
92
-
93
- /**
94
- * @internal
95
- */
96
- export const filterSensitiveLog = (obj: AnnotationValue): any => {
97
- if (obj.NumberValue !== undefined) return { NumberValue: obj.NumberValue };
98
- if (obj.BooleanValue !== undefined) return { BooleanValue: obj.BooleanValue };
99
- if (obj.StringValue !== undefined) return { StringValue: obj.StringValue };
100
- if (obj.$unknown !== undefined) return { [obj.$unknown[0]]: "UNKNOWN" };
101
- };
102
- }
103
-
104
- /**
105
- * <p></p>
106
- */
107
- export interface ServiceId {
108
- /**
109
- * <p></p>
110
- */
111
- Name?: string;
112
-
113
- /**
114
- * <p></p>
115
- */
116
- Names?: string[];
117
-
118
- /**
119
- * <p></p>
120
- */
121
- AccountId?: string;
122
-
123
- /**
124
- * <p></p>
125
- */
126
- Type?: string;
127
- }
128
-
129
- export namespace ServiceId {
130
- /**
131
- * @internal
132
- */
133
- export const filterSensitiveLog = (obj: ServiceId): any => ({
134
- ...obj,
135
- });
136
- }
137
-
138
- /**
139
- * <p>Information about a segment annotation.</p>
140
- */
141
- export interface ValueWithServiceIds {
142
- /**
143
- * <p>Values of the annotation.</p>
144
- */
145
- AnnotationValue?: AnnotationValue;
146
-
147
- /**
148
- * <p>Services to which the annotation applies.</p>
149
- */
150
- ServiceIds?: ServiceId[];
151
- }
152
-
153
- export namespace ValueWithServiceIds {
154
- /**
155
- * @internal
156
- */
157
- export const filterSensitiveLog = (obj: ValueWithServiceIds): any => ({
158
- ...obj,
159
- ...(obj.AnnotationValue && { AnnotationValue: AnnotationValue.filterSensitiveLog(obj.AnnotationValue) }),
160
- });
161
- }
162
-
163
- /**
164
- * <p>The service within the service graph that has anomalously high fault rates. </p>
165
- */
166
- export interface AnomalousService {
167
- /**
168
- * <p></p>
169
- */
170
- ServiceId?: ServiceId;
171
- }
172
-
173
- export namespace AnomalousService {
174
- /**
175
- * @internal
176
- */
177
- export const filterSensitiveLog = (obj: AnomalousService): any => ({
178
- ...obj,
179
- });
180
- }
181
-
182
- /**
183
- * <p>A list of Availability Zones corresponding to the segments in a trace.</p>
184
- */
185
- export interface AvailabilityZoneDetail {
186
- /**
187
- * <p>The name of a corresponding Availability Zone.</p>
188
- */
189
- Name?: string;
190
- }
191
-
192
- export namespace AvailabilityZoneDetail {
193
- /**
194
- * @internal
195
- */
196
- export const filterSensitiveLog = (obj: AvailabilityZoneDetail): any => ({
197
- ...obj,
198
- });
199
- }
200
-
201
- export interface BatchGetTracesRequest {
202
- /**
203
- * <p>Specify the trace IDs of requests for which to retrieve segments.</p>
204
- */
205
- TraceIds: string[] | undefined;
206
-
207
- /**
208
- * <p>Pagination token.</p>
209
- */
210
- NextToken?: string;
211
- }
212
-
213
- export namespace BatchGetTracesRequest {
214
- /**
215
- * @internal
216
- */
217
- export const filterSensitiveLog = (obj: BatchGetTracesRequest): any => ({
218
- ...obj,
219
- });
220
- }
221
-
222
- /**
223
- * <p>A segment from a trace that has been ingested by the X-Ray service. The segment can be
224
- * compiled from documents uploaded with <a href="https://docs.aws.amazon.com/xray/latest/api/API_PutTraceSegments.html">PutTraceSegments</a>, or an
225
- * <code>inferred</code> segment for a downstream service, generated from a subsegment sent by
226
- * the service that called it.</p>
227
- * <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
228
- * Documents</a> in the <i>Amazon Web Services X-Ray Developer Guide</i>.</p>
229
- */
230
- export interface Segment {
231
- /**
232
- * <p>The segment's ID.</p>
233
- */
234
- Id?: string;
235
-
236
- /**
237
- * <p>The segment document.</p>
238
- */
239
- Document?: string;
240
- }
241
-
242
- export namespace Segment {
243
- /**
244
- * @internal
245
- */
246
- export const filterSensitiveLog = (obj: Segment): any => ({
247
- ...obj,
248
- });
249
- }
250
-
251
- /**
252
- * <p>A collection of segment documents with matching trace IDs.</p>
253
- */
254
- export interface Trace {
255
- /**
256
- * <p>The unique identifier for the request that generated the trace's segments and
257
- * subsegments.</p>
258
- */
259
- Id?: string;
260
-
261
- /**
262
- * <p>The length of time in seconds between the start time of the root segment and the end
263
- * time of the last segment that completed.</p>
264
- */
265
- Duration?: number;
266
-
267
- /**
268
- * <p>LimitExceeded is set to true when the trace has exceeded one of the defined quotas. For
269
- * more information about quotas, see <a href="https://docs.aws.amazon.com/general/latest/gr/xray.html">Amazon Web Services X-Ray endpoints and quotas</a>.</p>
270
- */
271
- LimitExceeded?: boolean;
272
-
273
- /**
274
- * <p>Segment documents for the segments and subsegments that comprise the trace.</p>
275
- */
276
- Segments?: Segment[];
277
- }
278
-
279
- export namespace Trace {
280
- /**
281
- * @internal
282
- */
283
- export const filterSensitiveLog = (obj: Trace): any => ({
284
- ...obj,
285
- });
286
- }
287
-
288
- export interface BatchGetTracesResult {
289
- /**
290
- * <p>Full traces for the specified requests.</p>
291
- */
292
- Traces?: Trace[];
293
-
294
- /**
295
- * <p>Trace IDs of requests that haven't been processed.</p>
296
- */
297
- UnprocessedTraceIds?: string[];
298
-
299
- /**
300
- * <p>Pagination token.</p>
301
- */
302
- NextToken?: string;
303
- }
304
-
305
- export namespace BatchGetTracesResult {
306
- /**
307
- * @internal
308
- */
309
- export const filterSensitiveLog = (obj: BatchGetTracesResult): any => ({
310
- ...obj,
311
- });
312
- }
313
-
314
- /**
315
- * <p>The request is missing required parameters or has invalid parameters.</p>
316
- */
317
- export interface InvalidRequestException extends __SmithyException, $MetadataBearer {
318
- name: "InvalidRequestException";
319
- $fault: "client";
320
- Message?: string;
321
- }
322
-
323
- export namespace InvalidRequestException {
324
- /**
325
- * @internal
326
- */
327
- export const filterSensitiveLog = (obj: InvalidRequestException): any => ({
328
- ...obj,
329
- });
330
- }
331
-
332
- /**
333
- * <p>The request exceeds the maximum number of requests per second.</p>
334
- */
335
- export interface ThrottledException extends __SmithyException, $MetadataBearer {
336
- name: "ThrottledException";
337
- $fault: "client";
338
- Message?: string;
339
- }
340
-
341
- export namespace ThrottledException {
342
- /**
343
- * @internal
344
- */
345
- export const filterSensitiveLog = (obj: ThrottledException): any => ({
346
- ...obj,
347
- });
348
- }
349
-
350
- /**
351
- * <p>The structure containing configurations related to insights.</p>
352
- */
353
- export interface InsightsConfiguration {
354
- /**
355
- * <p>Set the InsightsEnabled value to true to enable insights or false to disable
356
- * insights.</p>
357
- */
358
- InsightsEnabled?: boolean;
359
-
360
- /**
361
- * <p>Set the NotificationsEnabled value to true to enable insights notifications. Notifications can only be
362
- * enabled on a group with InsightsEnabled set to true.</p>
363
- */
364
- NotificationsEnabled?: boolean;
365
- }
366
-
367
- export namespace InsightsConfiguration {
368
- /**
369
- * @internal
370
- */
371
- export const filterSensitiveLog = (obj: InsightsConfiguration): any => ({
372
- ...obj,
373
- });
374
- }
375
-
376
- /**
377
- * <p>A map that contains tag keys and tag values to attach to an Amazon Web Services X-Ray group or sampling
378
- * 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>
379
- * in the <i>Amazon Web Services General Reference</i>.</p>
380
- * <p>The following restrictions apply to tags:</p>
381
- * <ul>
382
- * <li>
383
- * <p>Maximum number of user-applied tags per resource: 50</p>
384
- * </li>
385
- * <li>
386
- * <p>Tag keys and values are case sensitive.</p>
387
- * </li>
388
- * <li>
389
- * <p>Don't use <code>aws:</code> as a prefix for keys; it's reserved for Amazon Web Services use. You
390
- * cannot edit or delete system tags.</p>
391
- * </li>
392
- * </ul>
393
- */
394
- export interface Tag {
395
- /**
396
- * <p>A tag key, such as <code>Stage</code> or <code>Name</code>. A tag key cannot be empty. The
397
- * key can be a maximum of 128 characters, and can contain only Unicode letters, numbers, or separators,
398
- * or the following special characters: <code>+ - = . _ : /</code>
399
- * </p>
400
- */
401
- Key: string | undefined;
402
-
403
- /**
404
- * <p>An optional tag value, such as <code>Production</code> or <code>test-only</code>. The value can be
405
- * a maximum of 255 characters, and contain only Unicode letters, numbers, or separators, or the following
406
- * special characters: <code>+ - = . _ : /</code>
407
- * </p>
408
- */
409
- Value: string | undefined;
410
- }
411
-
412
- export namespace Tag {
413
- /**
414
- * @internal
415
- */
416
- export const filterSensitiveLog = (obj: Tag): any => ({
417
- ...obj,
418
- });
419
- }
420
-
421
- export interface CreateGroupRequest {
422
- /**
423
- * <p>The case-sensitive name of the new group. Default is a reserved name and names must
424
- * be unique.</p>
425
- */
426
- GroupName: string | undefined;
427
-
428
- /**
429
- * <p>The filter expression defining criteria by which to group traces.</p>
430
- */
431
- FilterExpression?: string;
432
-
433
- /**
434
- * <p>The structure containing configurations related to insights.</p>
435
- * <ul>
436
- * <li>
437
- * <p>The InsightsEnabled boolean can be set to true to enable insights for the
438
- * new group or false to disable insights for the new group.</p>
439
- * </li>
440
- * <li>
441
- * <p>The NotifcationsEnabled boolean can be set to true to enable insights
442
- * notifications for the new group. Notifications may only be enabled on a group
443
- * with InsightsEnabled set to true.</p>
444
- * </li>
445
- * </ul>
446
- */
447
- InsightsConfiguration?: InsightsConfiguration;
448
-
449
- /**
450
- * <p>A map that contains one or more tag keys and tag values to attach to an X-Ray group.
451
- * 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
452
- * resources</a> in the <i>Amazon Web Services General Reference</i>.</p>
453
- * <p>The following restrictions apply to tags:</p>
454
- * <ul>
455
- * <li>
456
- * <p>Maximum number of user-applied tags per resource: 50</p>
457
- * </li>
458
- * <li>
459
- * <p>Maximum tag key length: 128 Unicode characters</p>
460
- * </li>
461
- * <li>
462
- * <p>Maximum tag value length: 256 Unicode characters</p>
463
- * </li>
464
- * <li>
465
- * <p>Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . :
466
- * / = + - and @</p>
467
- * </li>
468
- * <li>
469
- * <p>Tag keys and values are case sensitive.</p>
470
- * </li>
471
- * <li>
472
- * <p>Don't use <code>aws:</code> as a prefix for keys; it's reserved for Amazon Web Services
473
- * use.</p>
474
- * </li>
475
- * </ul>
476
- */
477
- Tags?: Tag[];
478
- }
479
-
480
- export namespace CreateGroupRequest {
481
- /**
482
- * @internal
483
- */
484
- export const filterSensitiveLog = (obj: CreateGroupRequest): any => ({
485
- ...obj,
486
- });
487
- }
488
-
489
- /**
490
- * <p>Details and metadata for a group.</p>
491
- */
492
- export interface Group {
493
- /**
494
- * <p>The unique case-sensitive name of the group.</p>
495
- */
496
- GroupName?: string;
497
-
498
- /**
499
- * <p>The Amazon Resource Name (ARN) of the group generated based on the GroupName.</p>
500
- */
501
- GroupARN?: string;
502
-
503
- /**
504
- * <p>The filter expression defining the parameters to include traces.</p>
505
- */
506
- FilterExpression?: string;
507
-
508
- /**
509
- * <p>The structure containing configurations related to insights.</p>
510
- * <ul>
511
- * <li>
512
- * <p>The InsightsEnabled boolean can be set to true to enable insights for the
513
- * group or false to disable insights for the group.</p>
514
- * </li>
515
- * <li>
516
- * <p>The NotificationsEnabled boolean can be set to true to enable insights
517
- * notifications through Amazon EventBridge for the group.</p>
518
- * </li>
519
- * </ul>
520
- */
521
- InsightsConfiguration?: InsightsConfiguration;
522
- }
523
-
524
- export namespace Group {
525
- /**
526
- * @internal
527
- */
528
- export const filterSensitiveLog = (obj: Group): any => ({
529
- ...obj,
530
- });
531
- }
532
-
533
- export interface CreateGroupResult {
534
- /**
535
- * <p>The group that was created. Contains the name of the group that was created, the Amazon Resource Name
536
- * (ARN) of the group that was generated based on the group name, the filter expression, and the insight
537
- * configuration that was assigned to the group.</p>
538
- */
539
- Group?: Group;
540
- }
541
-
542
- export namespace CreateGroupResult {
543
- /**
544
- * @internal
545
- */
546
- export const filterSensitiveLog = (obj: CreateGroupResult): any => ({
547
- ...obj,
548
- });
549
- }
550
-
551
- /**
552
- * <p>A sampling rule that services use to decide whether to instrument a request. Rule
553
- * fields can match properties of the service, or properties of a request. The service can ignore
554
- * rules that don't match its properties.</p>
555
- */
556
- export interface SamplingRule {
557
- /**
558
- * <p>The name of the sampling rule. Specify a rule by either name or ARN, but not both.</p>
559
- */
560
- RuleName?: string;
561
-
562
- /**
563
- * <p>The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.</p>
564
- */
565
- RuleARN?: string;
566
-
567
- /**
568
- * <p>Matches the ARN of the Amazon Web Services resource on which the service runs.</p>
569
- */
570
- ResourceARN: string | undefined;
571
-
572
- /**
573
- * <p>The priority of the sampling rule.</p>
574
- */
575
- Priority: number | undefined;
576
-
577
- /**
578
- * <p>The percentage of matching requests to instrument, after the reservoir is
579
- * exhausted.</p>
580
- */
581
- FixedRate: number | undefined;
582
-
583
- /**
584
- * <p>A fixed number of matching requests to instrument per second, prior to applying the
585
- * fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.</p>
586
- */
587
- ReservoirSize: number | undefined;
588
-
589
- /**
590
- * <p>Matches the <code>name</code> that the service uses to identify itself in segments.</p>
591
- */
592
- ServiceName: string | undefined;
593
-
594
- /**
595
- * <p>Matches the <code>origin</code> that the service uses to identify its type in segments.</p>
596
- */
597
- ServiceType: string | undefined;
598
-
599
- /**
600
- * <p>Matches the hostname from a request URL.</p>
601
- */
602
- Host: string | undefined;
603
-
604
- /**
605
- * <p>Matches the HTTP method of a request.</p>
606
- */
607
- HTTPMethod: string | undefined;
608
-
609
- /**
610
- * <p>Matches the path from a request URL.</p>
611
- */
612
- URLPath: string | undefined;
613
-
614
- /**
615
- * <p>The version of the sampling rule format (<code>1</code>).</p>
616
- */
617
- Version: number | undefined;
618
-
619
- /**
620
- * <p>Matches attributes derived from the request.</p>
621
- */
622
- Attributes?: { [key: string]: string };
623
- }
624
-
625
- export namespace SamplingRule {
626
- /**
627
- * @internal
628
- */
629
- export const filterSensitiveLog = (obj: SamplingRule): any => ({
630
- ...obj,
631
- });
632
- }
633
-
634
- export interface CreateSamplingRuleRequest {
635
- /**
636
- * <p>The rule definition.</p>
637
- */
638
- SamplingRule: SamplingRule | undefined;
639
-
640
- /**
641
- * <p>A map that contains one or more tag keys and tag values to attach to an X-Ray sampling
642
- * 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
643
- * resources</a> in the <i>Amazon Web Services General Reference</i>.</p>
644
- * <p>The following restrictions apply to tags:</p>
645
- * <ul>
646
- * <li>
647
- * <p>Maximum number of user-applied tags per resource: 50</p>
648
- * </li>
649
- * <li>
650
- * <p>Maximum tag key length: 128 Unicode characters</p>
651
- * </li>
652
- * <li>
653
- * <p>Maximum tag value length: 256 Unicode characters</p>
654
- * </li>
655
- * <li>
656
- * <p>Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . :
657
- * / = + - and @</p>
658
- * </li>
659
- * <li>
660
- * <p>Tag keys and values are case sensitive.</p>
661
- * </li>
662
- * <li>
663
- * <p>Don't use <code>aws:</code> as a prefix for keys; it's reserved for Amazon Web Services
664
- * use.</p>
665
- * </li>
666
- * </ul>
667
- */
668
- Tags?: Tag[];
669
- }
670
-
671
- export namespace CreateSamplingRuleRequest {
672
- /**
673
- * @internal
674
- */
675
- export const filterSensitiveLog = (obj: CreateSamplingRuleRequest): any => ({
676
- ...obj,
677
- });
678
- }
679
-
680
- /**
681
- * <p>A <a href="https://docs.aws.amazon.com/xray/latest/api/API_SamplingRule.html">SamplingRule</a> and its metadata.</p>
682
- */
683
- export interface SamplingRuleRecord {
684
- /**
685
- * <p>The sampling rule.</p>
686
- */
687
- SamplingRule?: SamplingRule;
688
-
689
- /**
690
- * <p>When the rule was created.</p>
691
- */
692
- CreatedAt?: Date;
693
-
694
- /**
695
- * <p>When the rule was last modified.</p>
696
- */
697
- ModifiedAt?: Date;
698
- }
699
-
700
- export namespace SamplingRuleRecord {
701
- /**
702
- * @internal
703
- */
704
- export const filterSensitiveLog = (obj: SamplingRuleRecord): any => ({
705
- ...obj,
706
- });
707
- }
708
-
709
- export interface CreateSamplingRuleResult {
710
- /**
711
- * <p>The saved rule definition and metadata.</p>
712
- */
713
- SamplingRuleRecord?: SamplingRuleRecord;
714
- }
715
-
716
- export namespace CreateSamplingRuleResult {
717
- /**
718
- * @internal
719
- */
720
- export const filterSensitiveLog = (obj: CreateSamplingRuleResult): any => ({
721
- ...obj,
722
- });
723
- }
724
-
725
- /**
726
- * <p>You have reached the maximum number of sampling rules.</p>
727
- */
728
- export interface RuleLimitExceededException extends __SmithyException, $MetadataBearer {
729
- name: "RuleLimitExceededException";
730
- $fault: "client";
731
- Message?: string;
732
- }
733
-
734
- export namespace RuleLimitExceededException {
735
- /**
736
- * @internal
737
- */
738
- export const filterSensitiveLog = (obj: RuleLimitExceededException): any => ({
739
- ...obj,
740
- });
741
- }
742
-
743
- export interface DeleteGroupRequest {
744
- /**
745
- * <p>The case-sensitive name of the group.</p>
746
- */
747
- GroupName?: string;
748
-
749
- /**
750
- * <p>The ARN of the group that was generated on creation.</p>
751
- */
752
- GroupARN?: string;
753
- }
754
-
755
- export namespace DeleteGroupRequest {
756
- /**
757
- * @internal
758
- */
759
- export const filterSensitiveLog = (obj: DeleteGroupRequest): any => ({
760
- ...obj,
761
- });
762
- }
763
-
764
- export interface DeleteGroupResult {}
765
-
766
- export namespace DeleteGroupResult {
767
- /**
768
- * @internal
769
- */
770
- export const filterSensitiveLog = (obj: DeleteGroupResult): any => ({
771
- ...obj,
772
- });
773
- }
774
-
775
- export interface DeleteSamplingRuleRequest {
776
- /**
777
- * <p>The name of the sampling rule. Specify a rule by either name or ARN, but not both.</p>
778
- */
779
- RuleName?: string;
780
-
781
- /**
782
- * <p>The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.</p>
783
- */
784
- RuleARN?: string;
785
- }
786
-
787
- export namespace DeleteSamplingRuleRequest {
788
- /**
789
- * @internal
790
- */
791
- export const filterSensitiveLog = (obj: DeleteSamplingRuleRequest): any => ({
792
- ...obj,
793
- });
794
- }
795
-
796
- export interface DeleteSamplingRuleResult {
797
- /**
798
- * <p>The deleted rule definition and metadata.</p>
799
- */
800
- SamplingRuleRecord?: SamplingRuleRecord;
801
- }
802
-
803
- export namespace DeleteSamplingRuleResult {
804
- /**
805
- * @internal
806
- */
807
- export const filterSensitiveLog = (obj: DeleteSamplingRuleResult): any => ({
808
- ...obj,
809
- });
810
- }
811
-
812
- export interface GetEncryptionConfigRequest {}
813
-
814
- export namespace GetEncryptionConfigRequest {
815
- /**
816
- * @internal
817
- */
818
- export const filterSensitiveLog = (obj: GetEncryptionConfigRequest): any => ({
819
- ...obj,
820
- });
821
- }
822
-
823
- export enum EncryptionStatus {
824
- ACTIVE = "ACTIVE",
825
- UPDATING = "UPDATING",
826
- }
827
-
828
- export enum EncryptionType {
829
- KMS = "KMS",
830
- NONE = "NONE",
831
- }
832
-
833
- /**
834
- * <p>A configuration document that specifies encryption configuration settings.</p>
835
- */
836
- export interface EncryptionConfig {
837
- /**
838
- * <p>The ID of the KMS key used for encryption, if applicable.</p>
839
- */
840
- KeyId?: string;
841
-
842
- /**
843
- * <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>
844
- */
845
- Status?: EncryptionStatus | string;
846
-
847
- /**
848
- * <p>The type of encryption. Set to <code>KMS</code> for encryption with KMS keys. Set to <code>NONE</code> for
849
- * default encryption.</p>
850
- */
851
- Type?: EncryptionType | string;
852
- }
853
-
854
- export namespace EncryptionConfig {
855
- /**
856
- * @internal
857
- */
858
- export const filterSensitiveLog = (obj: EncryptionConfig): any => ({
859
- ...obj,
860
- });
861
- }
862
-
863
- export interface GetEncryptionConfigResult {
864
- /**
865
- * <p>The encryption configuration document.</p>
866
- */
867
- EncryptionConfig?: EncryptionConfig;
868
- }
869
-
870
- export namespace GetEncryptionConfigResult {
871
- /**
872
- * @internal
873
- */
874
- export const filterSensitiveLog = (obj: GetEncryptionConfigResult): any => ({
875
- ...obj,
876
- });
877
- }
878
-
879
- export interface GetGroupRequest {
880
- /**
881
- * <p>The case-sensitive name of the group.</p>
882
- */
883
- GroupName?: string;
884
-
885
- /**
886
- * <p>The ARN of the group that was generated on creation.</p>
887
- */
888
- GroupARN?: string;
889
- }
890
-
891
- export namespace GetGroupRequest {
892
- /**
893
- * @internal
894
- */
895
- export const filterSensitiveLog = (obj: GetGroupRequest): any => ({
896
- ...obj,
897
- });
898
- }
899
-
900
- export interface GetGroupResult {
901
- /**
902
- * <p>The group that was requested. Contains the name of the group, the ARN of the group,
903
- * the filter expression, and the insight configuration assigned to the group.</p>
904
- */
905
- Group?: Group;
906
- }
907
-
908
- export namespace GetGroupResult {
909
- /**
910
- * @internal
911
- */
912
- export const filterSensitiveLog = (obj: GetGroupResult): any => ({
913
- ...obj,
914
- });
915
- }
916
-
917
- export interface GetGroupsRequest {
918
- /**
919
- * <p>Pagination token.</p>
920
- */
921
- NextToken?: string;
922
- }
923
-
924
- export namespace GetGroupsRequest {
925
- /**
926
- * @internal
927
- */
928
- export const filterSensitiveLog = (obj: GetGroupsRequest): any => ({
929
- ...obj,
930
- });
931
- }
932
-
933
- /**
934
- * <p>Details for a group without metadata.</p>
935
- */
936
- export interface GroupSummary {
937
- /**
938
- * <p>The unique case-sensitive name of the group.</p>
939
- */
940
- GroupName?: string;
941
-
942
- /**
943
- * <p>The ARN of the group generated based on the GroupName.</p>
944
- */
945
- GroupARN?: string;
946
-
947
- /**
948
- * <p>The filter expression defining the parameters to include traces.</p>
949
- */
950
- FilterExpression?: string;
951
-
952
- /**
953
- * <p>The structure containing configurations related to insights.</p>
954
- * <ul>
955
- * <li>
956
- * <p>The InsightsEnabled boolean can be set to true to enable insights for the
957
- * group or false to disable insights for the group.</p>
958
- * </li>
959
- * <li>
960
- * <p>The NotificationsEnabled boolean can be set to true to enable insights notifications.
961
- * Notifications can only be enabled on a group with InsightsEnabled set to true.</p>
962
- * </li>
963
- * </ul>
964
- */
965
- InsightsConfiguration?: InsightsConfiguration;
966
- }
967
-
968
- export namespace GroupSummary {
969
- /**
970
- * @internal
971
- */
972
- export const filterSensitiveLog = (obj: GroupSummary): any => ({
973
- ...obj,
974
- });
975
- }
976
-
977
- export interface GetGroupsResult {
978
- /**
979
- * <p>The collection of all active groups.</p>
980
- */
981
- Groups?: GroupSummary[];
982
-
983
- /**
984
- * <p>Pagination token.</p>
985
- */
986
- NextToken?: string;
987
- }
988
-
989
- export namespace GetGroupsResult {
990
- /**
991
- * @internal
992
- */
993
- export const filterSensitiveLog = (obj: GetGroupsResult): any => ({
994
- ...obj,
995
- });
996
- }
997
-
998
- export interface GetInsightRequest {
999
- /**
1000
- * <p>The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.</p>
1001
- */
1002
- InsightId: string | undefined;
1003
- }
1004
-
1005
- export namespace GetInsightRequest {
1006
- /**
1007
- * @internal
1008
- */
1009
- export const filterSensitiveLog = (obj: GetInsightRequest): any => ({
1010
- ...obj,
1011
- });
1012
- }
1013
-
1014
- export enum InsightCategory {
1015
- FAULT = "FAULT",
1016
- }
1017
-
1018
- /**
1019
- * <p>Statistics that describe how the incident has impacted a service.</p>
1020
- */
1021
- export interface RequestImpactStatistics {
1022
- /**
1023
- * <p>The number of requests that have resulted in a fault,</p>
1024
- */
1025
- FaultCount?: number;
1026
-
1027
- /**
1028
- * <p>The number of successful requests.</p>
1029
- */
1030
- OkCount?: number;
1031
-
1032
- /**
1033
- * <p>The total number of requests to the service.</p>
1034
- */
1035
- TotalCount?: number;
1036
- }
1037
-
1038
- export namespace RequestImpactStatistics {
1039
- /**
1040
- * @internal
1041
- */
1042
- export const filterSensitiveLog = (obj: RequestImpactStatistics): any => ({
1043
- ...obj,
1044
- });
1045
- }
1046
-
1047
- export enum InsightState {
1048
- ACTIVE = "ACTIVE",
1049
- CLOSED = "CLOSED",
1050
- }
1051
-
1052
- /**
1053
- * <p>When fault rates go outside of the expected range, X-Ray creates an insight. Insights
1054
- * tracks emergent issues within your applications.</p>
1055
- */
1056
- export interface Insight {
1057
- /**
1058
- * <p>The insights unique identifier. </p>
1059
- */
1060
- InsightId?: string;
1061
-
1062
- /**
1063
- * <p>The Amazon Resource Name (ARN) of the group that the insight belongs to.</p>
1064
- */
1065
- GroupARN?: string;
1066
-
1067
- /**
1068
- * <p>The name of the group that the insight belongs to.</p>
1069
- */
1070
- GroupName?: string;
1071
-
1072
- /**
1073
- * <p></p>
1074
- */
1075
- RootCauseServiceId?: ServiceId;
1076
-
1077
- /**
1078
- * <p>The categories that label and describe the type of insight.</p>
1079
- */
1080
- Categories?: (InsightCategory | string)[];
1081
-
1082
- /**
1083
- * <p>The current state of the insight.</p>
1084
- */
1085
- State?: InsightState | string;
1086
-
1087
- /**
1088
- * <p>The time, in Unix seconds, at which the insight began.</p>
1089
- */
1090
- StartTime?: Date;
1091
-
1092
- /**
1093
- * <p>The time, in Unix seconds, at which the insight ended.</p>
1094
- */
1095
- EndTime?: Date;
1096
-
1097
- /**
1098
- * <p>A brief description of the insight.</p>
1099
- */
1100
- Summary?: string;
1101
-
1102
- /**
1103
- * <p>The impact statistics of the client side service. This includes the number of requests to the client service
1104
- * and whether the requests were faults or okay.</p>
1105
- */
1106
- ClientRequestImpactStatistics?: RequestImpactStatistics;
1107
-
1108
- /**
1109
- * <p>The impact statistics of the root cause service. This includes the number of requests to the client service
1110
- * and whether the requests were faults or okay.</p>
1111
- */
1112
- RootCauseServiceRequestImpactStatistics?: RequestImpactStatistics;
1113
-
1114
- /**
1115
- * <p>The service within the insight that is most impacted by the incident.</p>
1116
- */
1117
- TopAnomalousServices?: AnomalousService[];
1118
- }
1119
-
1120
- export namespace Insight {
1121
- /**
1122
- * @internal
1123
- */
1124
- export const filterSensitiveLog = (obj: Insight): any => ({
1125
- ...obj,
1126
- });
1127
- }
1128
-
1129
- export interface GetInsightResult {
1130
- /**
1131
- * <p>The summary information of an insight.</p>
1132
- */
1133
- Insight?: Insight;
1134
- }
1135
-
1136
- export namespace GetInsightResult {
1137
- /**
1138
- * @internal
1139
- */
1140
- export const filterSensitiveLog = (obj: GetInsightResult): any => ({
1141
- ...obj,
1142
- });
1143
- }
1144
-
1145
- export interface GetInsightEventsRequest {
1146
- /**
1147
- * <p>The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.</p>
1148
- */
1149
- InsightId: string | undefined;
1150
-
1151
- /**
1152
- * <p>Used to retrieve at most the specified value of events.</p>
1153
- */
1154
- MaxResults?: number;
1155
-
1156
- /**
1157
- * <p>Specify the pagination token returned by a previous request to retrieve the next page of events. </p>
1158
- */
1159
- NextToken?: string;
1160
- }
1161
-
1162
- export namespace GetInsightEventsRequest {
1163
- /**
1164
- * @internal
1165
- */
1166
- export const filterSensitiveLog = (obj: GetInsightEventsRequest): any => ({
1167
- ...obj,
1168
- });
1169
- }
1170
-
1171
- /**
1172
- * <p>X-Ray reevaluates insights periodically until they are resolved, and records each intermediate state in an
1173
- * event. You can review incident events in the Impact Timeline on the Inspect page in the X-Ray console.</p>
1174
- */
1175
- export interface InsightEvent {
1176
- /**
1177
- * <p>A brief description of the event.</p>
1178
- */
1179
- Summary?: string;
1180
-
1181
- /**
1182
- * <p>The time, in Unix seconds, at which the event was recorded.</p>
1183
- */
1184
- EventTime?: Date;
1185
-
1186
- /**
1187
- * <p>The impact statistics of the client side service. This includes the number of requests to the client service
1188
- * and whether the requests were faults or okay.</p>
1189
- */
1190
- ClientRequestImpactStatistics?: RequestImpactStatistics;
1191
-
1192
- /**
1193
- * <p>The impact statistics of the root cause service. This includes the number of requests to the client service
1194
- * and whether the requests were faults or okay.</p>
1195
- */
1196
- RootCauseServiceRequestImpactStatistics?: RequestImpactStatistics;
1197
-
1198
- /**
1199
- * <p>The service during the event that is most impacted by the incident.</p>
1200
- */
1201
- TopAnomalousServices?: AnomalousService[];
1202
- }
1203
-
1204
- export namespace InsightEvent {
1205
- /**
1206
- * @internal
1207
- */
1208
- export const filterSensitiveLog = (obj: InsightEvent): any => ({
1209
- ...obj,
1210
- });
1211
- }
1212
-
1213
- export interface GetInsightEventsResult {
1214
- /**
1215
- * <p>A detailed description of the event. This includes the time of the event, client and
1216
- * root cause impact statistics, and the top anomalous service at the time of the
1217
- * event.</p>
1218
- */
1219
- InsightEvents?: InsightEvent[];
1220
-
1221
- /**
1222
- * <p>Use this token to retrieve the next page of insight events.</p>
1223
- */
1224
- NextToken?: string;
1225
- }
1226
-
1227
- export namespace GetInsightEventsResult {
1228
- /**
1229
- * @internal
1230
- */
1231
- export const filterSensitiveLog = (obj: GetInsightEventsResult): any => ({
1232
- ...obj,
1233
- });
1234
- }
1235
-
1236
- export interface GetInsightImpactGraphRequest {
1237
- /**
1238
- * <p>The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.</p>
1239
- */
1240
- InsightId: string | undefined;
1241
-
1242
- /**
1243
- * <p>The estimated start time of the insight, in Unix time seconds. The StartTime is inclusive of the value
1244
- * provided and can't be more than 30 days old.</p>
1245
- */
1246
- StartTime: Date | undefined;
1247
-
1248
- /**
1249
- * <p>The estimated end time of the insight, in Unix time seconds. The EndTime is exclusive of the value provided.
1250
- * The time range between the start time and end time can't be more than six hours. </p>
1251
- */
1252
- EndTime: Date | undefined;
1253
-
1254
- /**
1255
- * <p>Specify the pagination token returned by a previous request to retrieve the next page of results. </p>
1256
- */
1257
- NextToken?: string;
1258
- }
1259
-
1260
- export namespace GetInsightImpactGraphRequest {
1261
- /**
1262
- * @internal
1263
- */
1264
- export const filterSensitiveLog = (obj: GetInsightImpactGraphRequest): any => ({
1265
- ...obj,
1266
- });
1267
- }
1268
-
1269
- /**
1270
- * <p>The connection between two service in an insight impact graph.</p>
1271
- */
1272
- export interface InsightImpactGraphEdge {
1273
- /**
1274
- * <p>Identifier of the edge. Unique within a service map.</p>
1275
- */
1276
- ReferenceId?: number;
1277
- }
1278
-
1279
- export namespace InsightImpactGraphEdge {
1280
- /**
1281
- * @internal
1282
- */
1283
- export const filterSensitiveLog = (obj: InsightImpactGraphEdge): any => ({
1284
- ...obj,
1285
- });
1286
- }
1287
-
1288
- /**
1289
- * <p>Information about an application that processed requests, users that made requests, or downstream services,
1290
- * resources, and applications that an application used. </p>
1291
- */
1292
- export interface InsightImpactGraphService {
1293
- /**
1294
- * <p>Identifier for the service. Unique within the service map.</p>
1295
- */
1296
- ReferenceId?: number;
1297
-
1298
- /**
1299
- * <p>Identifier for the service. Unique within the service map.</p>
1300
- * <ul>
1301
- * <li>
1302
- * <p>Amazon Web Services Resource - The type of an Amazon Web Services resource. For example, AWS::EC2::Instance for an application running
1303
- * on Amazon EC2 or AWS::DynamoDB::Table for an Amazon DynamoDB table that the application used. </p>
1304
- * </li>
1305
- * <li>
1306
- * <p>Amazon Web Services Service - The type of an Amazon Web Services service. For example, AWS::DynamoDB for downstream calls to Amazon
1307
- * DynamoDB that didn't target a specific table. </p>
1308
- * </li>
1309
- * <li>
1310
- * <p>Amazon Web Services Service - The type of an Amazon Web Services service. For example, AWS::DynamoDB for downstream calls to Amazon
1311
- * DynamoDB that didn't target a specific table. </p>
1312
- * </li>
1313
- * <li>
1314
- * <p>remote - A downstream service of indeterminate type.</p>
1315
- * </li>
1316
- * </ul>
1317
- */
1318
- Type?: string;
1319
-
1320
- /**
1321
- * <p>The canonical name of the service.</p>
1322
- */
1323
- Name?: string;
1324
-
1325
- /**
1326
- * <p>A list of names for the service, including the canonical name.</p>
1327
- */
1328
- Names?: string[];
1329
-
1330
- /**
1331
- * <p>Identifier of the Amazon Web Services account in which the service runs.</p>
1332
- */
1333
- AccountId?: string;
1334
-
1335
- /**
1336
- * <p>Connections to downstream services.</p>
1337
- */
1338
- Edges?: InsightImpactGraphEdge[];
1339
- }
1340
-
1341
- export namespace InsightImpactGraphService {
1342
- /**
1343
- * @internal
1344
- */
1345
- export const filterSensitiveLog = (obj: InsightImpactGraphService): any => ({
1346
- ...obj,
1347
- });
1348
- }
1349
-
1350
- export interface GetInsightImpactGraphResult {
1351
- /**
1352
- * <p>The insight's unique identifier.</p>
1353
- */
1354
- InsightId?: string;
1355
-
1356
- /**
1357
- * <p>The provided start time.</p>
1358
- */
1359
- StartTime?: Date;
1360
-
1361
- /**
1362
- * <p>The provided end time. </p>
1363
- */
1364
- EndTime?: Date;
1365
-
1366
- /**
1367
- * <p>The time, in Unix seconds, at which the service graph started.</p>
1368
- */
1369
- ServiceGraphStartTime?: Date;
1370
-
1371
- /**
1372
- * <p>The time, in Unix seconds, at which the service graph ended.</p>
1373
- */
1374
- ServiceGraphEndTime?: Date;
1375
-
1376
- /**
1377
- * <p>The Amazon Web Services instrumented services related to the insight.</p>
1378
- */
1379
- Services?: InsightImpactGraphService[];
1380
-
1381
- /**
1382
- * <p>Pagination token.</p>
1383
- */
1384
- NextToken?: string;
1385
- }
1386
-
1387
- export namespace GetInsightImpactGraphResult {
1388
- /**
1389
- * @internal
1390
- */
1391
- export const filterSensitiveLog = (obj: GetInsightImpactGraphResult): any => ({
1392
- ...obj,
1393
- });
1394
- }
1395
-
1396
- export interface GetInsightSummariesRequest {
1397
- /**
1398
- * <p>The list of insight states. </p>
1399
- */
1400
- States?: (InsightState | string)[];
1401
-
1402
- /**
1403
- * <p>The Amazon Resource Name (ARN) of the group. Required if the GroupName isn't provided.</p>
1404
- */
1405
- GroupARN?: string;
1406
-
1407
- /**
1408
- * <p>The name of the group. Required if the GroupARN isn't provided.</p>
1409
- */
1410
- GroupName?: string;
1411
-
1412
- /**
1413
- * <p>The beginning of the time frame in which the insights started. The start time can't be more than 30 days
1414
- * old.</p>
1415
- */
1416
- StartTime: Date | undefined;
1417
-
1418
- /**
1419
- * <p>The end of the time frame in which the insights ended. The end time can't be more than 30 days old.</p>
1420
- */
1421
- EndTime: Date | undefined;
1422
-
1423
- /**
1424
- * <p>The maximum number of results to display.</p>
1425
- */
1426
- MaxResults?: number;
1427
-
1428
- /**
1429
- * <p>Pagination token.</p>
1430
- */
1431
- NextToken?: string;
1432
- }
1433
-
1434
- export namespace GetInsightSummariesRequest {
1435
- /**
1436
- * @internal
1437
- */
1438
- export const filterSensitiveLog = (obj: GetInsightSummariesRequest): any => ({
1439
- ...obj,
1440
- });
1441
- }
1442
-
1443
- /**
1444
- * <p>Information that describes an insight.</p>
1445
- */
1446
- export interface InsightSummary {
1447
- /**
1448
- * <p>The insights unique identifier. </p>
1449
- */
1450
- InsightId?: string;
1451
-
1452
- /**
1453
- * <p>The Amazon Resource Name (ARN) of the group that the insight belongs to.</p>
1454
- */
1455
- GroupARN?: string;
1456
-
1457
- /**
1458
- * <p>The name of the group that the insight belongs to.</p>
1459
- */
1460
- GroupName?: string;
1461
-
1462
- /**
1463
- * <p></p>
1464
- */
1465
- RootCauseServiceId?: ServiceId;
1466
-
1467
- /**
1468
- * <p> Categories The categories that label and describe the type of insight.</p>
1469
- */
1470
- Categories?: (InsightCategory | string)[];
1471
-
1472
- /**
1473
- * <p>The current state of the insight.</p>
1474
- */
1475
- State?: InsightState | string;
1476
-
1477
- /**
1478
- * <p>The time, in Unix seconds, at which the insight began.</p>
1479
- */
1480
- StartTime?: Date;
1481
-
1482
- /**
1483
- * <p>The time, in Unix seconds, at which the insight ended.</p>
1484
- */
1485
- EndTime?: Date;
1486
-
1487
- /**
1488
- * <p>A brief description of the insight.</p>
1489
- */
1490
- Summary?: string;
1491
-
1492
- /**
1493
- * <p>The impact statistics of the client side service. This includes the number of requests
1494
- * to the client service and whether the requests were faults or okay. </p>
1495
- */
1496
- ClientRequestImpactStatistics?: RequestImpactStatistics;
1497
-
1498
- /**
1499
- * <p>The impact statistics of the root cause service. This includes the number of requests to
1500
- * the client service and whether the requests were faults or okay. </p>
1501
- */
1502
- RootCauseServiceRequestImpactStatistics?: RequestImpactStatistics;
1503
-
1504
- /**
1505
- * <p>The service within the insight that is most impacted by the incident.</p>
1506
- */
1507
- TopAnomalousServices?: AnomalousService[];
1508
-
1509
- /**
1510
- * <p>The time, in Unix seconds, that the insight was last updated.</p>
1511
- */
1512
- LastUpdateTime?: Date;
1513
- }
1514
-
1515
- export namespace InsightSummary {
1516
- /**
1517
- * @internal
1518
- */
1519
- export const filterSensitiveLog = (obj: InsightSummary): any => ({
1520
- ...obj,
1521
- });
1522
- }
1523
-
1524
- export interface GetInsightSummariesResult {
1525
- /**
1526
- * <p>The summary of each insight within the group matching the provided filters. The summary
1527
- * contains the InsightID, start and end time, the root cause service, the root cause and
1528
- * client impact statistics, the top anomalous services, and the status of the insight.</p>
1529
- */
1530
- InsightSummaries?: InsightSummary[];
1531
-
1532
- /**
1533
- * <p>Pagination token.</p>
1534
- */
1535
- NextToken?: string;
1536
- }
1537
-
1538
- export namespace GetInsightSummariesResult {
1539
- /**
1540
- * @internal
1541
- */
1542
- export const filterSensitiveLog = (obj: GetInsightSummariesResult): any => ({
1543
- ...obj,
1544
- });
1545
- }
1546
-
1547
- export interface GetSamplingRulesRequest {
1548
- /**
1549
- * <p>Pagination token.</p>
1550
- */
1551
- NextToken?: string;
1552
- }
1553
-
1554
- export namespace GetSamplingRulesRequest {
1555
- /**
1556
- * @internal
1557
- */
1558
- export const filterSensitiveLog = (obj: GetSamplingRulesRequest): any => ({
1559
- ...obj,
1560
- });
1561
- }
1562
-
1563
- export interface GetSamplingRulesResult {
1564
- /**
1565
- * <p>Rule definitions and metadata.</p>
1566
- */
1567
- SamplingRuleRecords?: SamplingRuleRecord[];
1568
-
1569
- /**
1570
- * <p>Pagination token.</p>
1571
- */
1572
- NextToken?: string;
1573
- }
1574
-
1575
- export namespace GetSamplingRulesResult {
1576
- /**
1577
- * @internal
1578
- */
1579
- export const filterSensitiveLog = (obj: GetSamplingRulesResult): any => ({
1580
- ...obj,
1581
- });
1582
- }
1583
-
1584
- export interface GetSamplingStatisticSummariesRequest {
1585
- /**
1586
- * <p>Pagination token.</p>
1587
- */
1588
- NextToken?: string;
1589
- }
1590
-
1591
- export namespace GetSamplingStatisticSummariesRequest {
1592
- /**
1593
- * @internal
1594
- */
1595
- export const filterSensitiveLog = (obj: GetSamplingStatisticSummariesRequest): any => ({
1596
- ...obj,
1597
- });
1598
- }
1599
-
1600
- /**
1601
- * <p>Aggregated request sampling data for a sampling rule across all services for a 10-second window.</p>
1602
- */
1603
- export interface SamplingStatisticSummary {
1604
- /**
1605
- * <p>The name of the sampling rule.</p>
1606
- */
1607
- RuleName?: string;
1608
-
1609
- /**
1610
- * <p>The start time of the reporting window.</p>
1611
- */
1612
- Timestamp?: Date;
1613
-
1614
- /**
1615
- * <p>The number of requests that matched the rule.</p>
1616
- */
1617
- RequestCount?: number;
1618
-
1619
- /**
1620
- * <p>The number of requests recorded with borrowed reservoir quota.</p>
1621
- */
1622
- BorrowCount?: number;
1623
-
1624
- /**
1625
- * <p>The number of requests recorded.</p>
1626
- */
1627
- SampledCount?: number;
1628
- }
1629
-
1630
- export namespace SamplingStatisticSummary {
1631
- /**
1632
- * @internal
1633
- */
1634
- export const filterSensitiveLog = (obj: SamplingStatisticSummary): any => ({
1635
- ...obj,
1636
- });
1637
- }
1638
-
1639
- export interface GetSamplingStatisticSummariesResult {
1640
- /**
1641
- * <p>Information about the number of requests instrumented for each sampling
1642
- * rule.</p>
1643
- */
1644
- SamplingStatisticSummaries?: SamplingStatisticSummary[];
1645
-
1646
- /**
1647
- * <p>Pagination token.</p>
1648
- */
1649
- NextToken?: string;
1650
- }
1651
-
1652
- export namespace GetSamplingStatisticSummariesResult {
1653
- /**
1654
- * @internal
1655
- */
1656
- export const filterSensitiveLog = (obj: GetSamplingStatisticSummariesResult): any => ({
1657
- ...obj,
1658
- });
1659
- }
1660
-
1661
- /**
1662
- * <p>Request sampling results for a single rule from a service. Results are for the last 10
1663
- * seconds unless the service has been assigned a longer reporting interval after a previous call
1664
- * to <a href="https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html">GetSamplingTargets</a>.</p>
1665
- */
1666
- export interface SamplingStatisticsDocument {
1667
- /**
1668
- * <p>The name of the sampling rule.</p>
1669
- */
1670
- RuleName: string | undefined;
1671
-
1672
- /**
1673
- * <p>A unique identifier for the service in hexadecimal.</p>
1674
- */
1675
- ClientID: string | undefined;
1676
-
1677
- /**
1678
- * <p>The current time.</p>
1679
- */
1680
- Timestamp: Date | undefined;
1681
-
1682
- /**
1683
- * <p>The number of requests that matched the rule.</p>
1684
- */
1685
- RequestCount: number | undefined;
1686
-
1687
- /**
1688
- * <p>The number of requests recorded.</p>
1689
- */
1690
- SampledCount: number | undefined;
1691
-
1692
- /**
1693
- * <p>The number of requests recorded with borrowed reservoir quota.</p>
1694
- */
1695
- BorrowCount?: number;
1696
- }
1697
-
1698
- export namespace SamplingStatisticsDocument {
1699
- /**
1700
- * @internal
1701
- */
1702
- export const filterSensitiveLog = (obj: SamplingStatisticsDocument): any => ({
1703
- ...obj,
1704
- });
1705
- }
1706
-
1707
- export interface GetSamplingTargetsRequest {
1708
- /**
1709
- * <p>Information about rules that the service is using to sample requests.</p>
1710
- */
1711
- SamplingStatisticsDocuments: SamplingStatisticsDocument[] | undefined;
1712
- }
1713
-
1714
- export namespace GetSamplingTargetsRequest {
1715
- /**
1716
- * @internal
1717
- */
1718
- export const filterSensitiveLog = (obj: GetSamplingTargetsRequest): any => ({
1719
- ...obj,
1720
- });
1721
- }
1722
-
1723
- /**
1724
- * <p>Temporary changes to a sampling rule configuration. To meet the global sampling target for a rule, X-Ray
1725
- * calculates a new reservoir for each service based on the recent sampling results of all services that called
1726
- * <a href="https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html">GetSamplingTargets</a>.</p>
1727
- */
1728
- export interface SamplingTargetDocument {
1729
- /**
1730
- * <p>The name of the sampling rule.</p>
1731
- */
1732
- RuleName?: string;
1733
-
1734
- /**
1735
- * <p>The percentage of matching requests to instrument, after the reservoir is
1736
- * exhausted.</p>
1737
- */
1738
- FixedRate?: number;
1739
-
1740
- /**
1741
- * <p>The number of requests per second that X-Ray allocated for this service.</p>
1742
- */
1743
- ReservoirQuota?: number;
1744
-
1745
- /**
1746
- * <p>When the reservoir quota expires.</p>
1747
- */
1748
- ReservoirQuotaTTL?: Date;
1749
-
1750
- /**
1751
- * <p>The number of seconds for the service to wait before getting sampling targets
1752
- * again.</p>
1753
- */
1754
- Interval?: number;
1755
- }
1756
-
1757
- export namespace SamplingTargetDocument {
1758
- /**
1759
- * @internal
1760
- */
1761
- export const filterSensitiveLog = (obj: SamplingTargetDocument): any => ({
1762
- ...obj,
1763
- });
1764
- }
1765
-
1766
- /**
1767
- * <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
1768
- * could not process.</p>
1769
- */
1770
- export interface UnprocessedStatistics {
1771
- /**
1772
- * <p>The name of the sampling rule.</p>
1773
- */
1774
- RuleName?: string;
1775
-
1776
- /**
1777
- * <p>The error code.</p>
1778
- */
1779
- ErrorCode?: string;
1780
-
1781
- /**
1782
- * <p>The error message.</p>
1783
- */
1784
- Message?: string;
1785
- }
1786
-
1787
- export namespace UnprocessedStatistics {
1788
- /**
1789
- * @internal
1790
- */
1791
- export const filterSensitiveLog = (obj: UnprocessedStatistics): any => ({
1792
- ...obj,
1793
- });
1794
- }
1795
-
1796
- export interface GetSamplingTargetsResult {
1797
- /**
1798
- * <p>Updated rules that the service should use to sample requests.</p>
1799
- */
1800
- SamplingTargetDocuments?: SamplingTargetDocument[];
1801
-
1802
- /**
1803
- * <p>The last time a user changed the sampling rule configuration. If
1804
- * the sampling rule configuration changed since the service last retrieved it, the service
1805
- * should call <a href="https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingRules.html">GetSamplingRules</a> to get the latest version.</p>
1806
- */
1807
- LastRuleModification?: Date;
1808
-
1809
- /**
1810
- * <p>Information about <a href="https://docs.aws.amazon.com/xray/latest/api/API_SamplingStatisticsDocument.html">SamplingStatisticsDocument</a> that X-Ray could not
1811
- * process.</p>
1812
- */
1813
- UnprocessedStatistics?: UnprocessedStatistics[];
1814
- }
1815
-
1816
- export namespace GetSamplingTargetsResult {
1817
- /**
1818
- * @internal
1819
- */
1820
- export const filterSensitiveLog = (obj: GetSamplingTargetsResult): any => ({
1821
- ...obj,
1822
- });
1823
- }
1824
-
1825
- export interface GetServiceGraphRequest {
1826
- /**
1827
- * <p>The start of the time frame for which to generate a graph.</p>
1828
- */
1829
- StartTime: Date | undefined;
1830
-
1831
- /**
1832
- * <p>The end of the timeframe for which to generate a graph.</p>
1833
- */
1834
- EndTime: Date | undefined;
1835
-
1836
- /**
1837
- * <p>The name of a group based on which you want to generate a graph.</p>
1838
- */
1839
- GroupName?: string;
1840
-
1841
- /**
1842
- * <p>The Amazon Resource Name (ARN) of a group based on which you want to generate a graph.</p>
1843
- */
1844
- GroupARN?: string;
1845
-
1846
- /**
1847
- * <p>Pagination token.</p>
1848
- */
1849
- NextToken?: string;
1850
- }
1851
-
1852
- export namespace GetServiceGraphRequest {
1853
- /**
1854
- * @internal
1855
- */
1856
- export const filterSensitiveLog = (obj: GetServiceGraphRequest): any => ({
1857
- ...obj,
1858
- });
1859
- }
1860
-
1861
- /**
1862
- * <p>An entry in a histogram for a statistic. A histogram maps the range of observed values
1863
- * on the X axis, and the prevalence of each value on the Y axis.</p>
1864
- */
1865
- export interface HistogramEntry {
1866
- /**
1867
- * <p>The value of the entry.</p>
1868
- */
1869
- Value?: number;
1870
-
1871
- /**
1872
- * <p>The prevalence of the entry.</p>
1873
- */
1874
- Count?: number;
1875
- }
1876
-
1877
- export namespace HistogramEntry {
1878
- /**
1879
- * @internal
1880
- */
1881
- export const filterSensitiveLog = (obj: HistogramEntry): any => ({
1882
- ...obj,
1883
- });
1884
- }
1885
-
1886
- /**
1887
- * <p>Information about requests that failed with a 4xx Client Error status code.</p>
1888
- */
1889
- export interface ErrorStatistics {
1890
- /**
1891
- * <p>The number of requests that failed with a 419 throttling status code.</p>
1892
- */
1893
- ThrottleCount?: number;
1894
-
1895
- /**
1896
- * <p>The number of requests that failed with untracked 4xx Client Error status
1897
- * codes.</p>
1898
- */
1899
- OtherCount?: number;
1900
-
1901
- /**
1902
- * <p>The total number of requests that failed with a 4xx Client Error status code.</p>
1903
- */
1904
- TotalCount?: number;
1905
- }
1906
-
1907
- export namespace ErrorStatistics {
1908
- /**
1909
- * @internal
1910
- */
1911
- export const filterSensitiveLog = (obj: ErrorStatistics): any => ({
1912
- ...obj,
1913
- });
1914
- }
1915
-
1916
- /**
1917
- * <p>Information about requests that failed with a 5xx Server Error status code.</p>
1918
- */
1919
- export interface FaultStatistics {
1920
- /**
1921
- * <p>The number of requests that failed with untracked 5xx Server Error status
1922
- * codes.</p>
1923
- */
1924
- OtherCount?: number;
1925
-
1926
- /**
1927
- * <p>The total number of requests that failed with a 5xx Server Error status code.</p>
1928
- */
1929
- TotalCount?: number;
1930
- }
1931
-
1932
- export namespace FaultStatistics {
1933
- /**
1934
- * @internal
1935
- */
1936
- export const filterSensitiveLog = (obj: FaultStatistics): any => ({
1937
- ...obj,
1938
- });
1939
- }
1940
-
1941
- /**
1942
- * <p>Response statistics for an edge.</p>
1943
- */
1944
- export interface EdgeStatistics {
1945
- /**
1946
- * <p>The number of requests that completed with a 2xx Success status code.</p>
1947
- */
1948
- OkCount?: number;
1949
-
1950
- /**
1951
- * <p>Information about requests that failed with a 4xx Client Error status code.</p>
1952
- */
1953
- ErrorStatistics?: ErrorStatistics;
1954
-
1955
- /**
1956
- * <p>Information about requests that failed with a 5xx Server Error status code.</p>
1957
- */
1958
- FaultStatistics?: FaultStatistics;
1959
-
1960
- /**
1961
- * <p>The total number of completed requests.</p>
1962
- */
1963
- TotalCount?: number;
1964
-
1965
- /**
1966
- * <p>The aggregate response time of completed requests.</p>
1967
- */
1968
- TotalResponseTime?: number;
1969
- }
1970
-
1971
- export namespace EdgeStatistics {
1972
- /**
1973
- * @internal
1974
- */
1975
- export const filterSensitiveLog = (obj: EdgeStatistics): any => ({
1976
- ...obj,
1977
- });
1978
- }
1979
-
1980
- /**
1981
- * <p>Information about a connection between two services.</p>
1982
- */
1983
- export interface Edge {
1984
- /**
1985
- * <p>Identifier of the edge. Unique within a service map.</p>
1986
- */
1987
- ReferenceId?: number;
1988
-
1989
- /**
1990
- * <p>The start time of the first segment on the edge.</p>
1991
- */
1992
- StartTime?: Date;
1993
-
1994
- /**
1995
- * <p>The end time of the last segment on the edge.</p>
1996
- */
1997
- EndTime?: Date;
1998
-
1999
- /**
2000
- * <p>Response statistics for segments on the edge.</p>
2001
- */
2002
- SummaryStatistics?: EdgeStatistics;
2003
-
2004
- /**
2005
- * <p>A histogram that maps the spread of client response times on an edge.</p>
2006
- */
2007
- ResponseTimeHistogram?: HistogramEntry[];
2008
-
2009
- /**
2010
- * <p>Aliases for the edge.</p>
2011
- */
2012
- Aliases?: Alias[];
2013
- }
2014
-
2015
- export namespace Edge {
2016
- /**
2017
- * @internal
2018
- */
2019
- export const filterSensitiveLog = (obj: Edge): any => ({
2020
- ...obj,
2021
- });
2022
- }
2023
-
2024
- /**
2025
- * <p>Response statistics for a service.</p>
2026
- */
2027
- export interface ServiceStatistics {
2028
- /**
2029
- * <p>The number of requests that completed with a 2xx Success status code.</p>
2030
- */
2031
- OkCount?: number;
2032
-
2033
- /**
2034
- * <p>Information about requests that failed with a 4xx Client Error status code.</p>
2035
- */
2036
- ErrorStatistics?: ErrorStatistics;
2037
-
2038
- /**
2039
- * <p>Information about requests that failed with a 5xx Server Error status code.</p>
2040
- */
2041
- FaultStatistics?: FaultStatistics;
2042
-
2043
- /**
2044
- * <p>The total number of completed requests.</p>
2045
- */
2046
- TotalCount?: number;
2047
-
2048
- /**
2049
- * <p>The aggregate response time of completed requests.</p>
2050
- */
2051
- TotalResponseTime?: number;
2052
- }
2053
-
2054
- export namespace ServiceStatistics {
2055
- /**
2056
- * @internal
2057
- */
2058
- export const filterSensitiveLog = (obj: ServiceStatistics): any => ({
2059
- ...obj,
2060
- });
2061
- }
2062
-
2063
- /**
2064
- * <p>Information about an application that processed requests, users that made requests, or downstream services,
2065
- * resources, and applications that an application used.</p>
2066
- */
2067
- export interface Service {
2068
- /**
2069
- * <p>Identifier for the service. Unique within the service map.</p>
2070
- */
2071
- ReferenceId?: number;
2072
-
2073
- /**
2074
- * <p>The canonical name of the service.</p>
2075
- */
2076
- Name?: string;
2077
-
2078
- /**
2079
- * <p>A list of names for the service, including the canonical name.</p>
2080
- */
2081
- Names?: string[];
2082
-
2083
- /**
2084
- * <p>Indicates that the service was the first service to process a request.</p>
2085
- */
2086
- Root?: boolean;
2087
-
2088
- /**
2089
- * <p>Identifier of the Amazon Web Services account in which the service runs.</p>
2090
- */
2091
- AccountId?: string;
2092
-
2093
- /**
2094
- * <p>The type of service.</p>
2095
- * <ul>
2096
- * <li>
2097
- * <p>Amazon Web Services Resource - The type of an Amazon Web Services resource. For example, <code>AWS::EC2::Instance</code> for an
2098
- * application running on Amazon EC2 or <code>AWS::DynamoDB::Table</code> for an Amazon DynamoDB table that the
2099
- * application used.</p>
2100
- * </li>
2101
- * <li>
2102
- * <p>Amazon Web Services Service - The type of an Amazon Web Services service. For example, <code>AWS::DynamoDB</code>
2103
- * for downstream calls to Amazon DynamoDB that didn't target a specific table.</p>
2104
- * </li>
2105
- * <li>
2106
- * <p>
2107
- * <code>client</code> - Represents the clients that sent requests to a root
2108
- * service.</p>
2109
- * </li>
2110
- * <li>
2111
- * <p>
2112
- * <code>remote</code> - A downstream service of indeterminate type.</p>
2113
- * </li>
2114
- * </ul>
2115
- */
2116
- Type?: string;
2117
-
2118
- /**
2119
- * <p>The service's state.</p>
2120
- */
2121
- State?: string;
2122
-
2123
- /**
2124
- * <p>The start time of the first segment that the service generated.</p>
2125
- */
2126
- StartTime?: Date;
2127
-
2128
- /**
2129
- * <p>The end time of the last segment that the service generated.</p>
2130
- */
2131
- EndTime?: Date;
2132
-
2133
- /**
2134
- * <p>Connections to downstream services.</p>
2135
- */
2136
- Edges?: Edge[];
2137
-
2138
- /**
2139
- * <p>Aggregated statistics for the service.</p>
2140
- */
2141
- SummaryStatistics?: ServiceStatistics;
2142
-
2143
- /**
2144
- * <p>A histogram that maps the spread of service durations.</p>
2145
- */
2146
- DurationHistogram?: HistogramEntry[];
2147
-
2148
- /**
2149
- * <p>A histogram that maps the spread of service response times.</p>
2150
- */
2151
- ResponseTimeHistogram?: HistogramEntry[];
2152
- }
2153
-
2154
- export namespace Service {
2155
- /**
2156
- * @internal
2157
- */
2158
- export const filterSensitiveLog = (obj: Service): any => ({
2159
- ...obj,
2160
- });
2161
- }
2162
-
2163
- export interface GetServiceGraphResult {
2164
- /**
2165
- * <p>The start of the time frame for which the graph was generated.</p>
2166
- */
2167
- StartTime?: Date;
2168
-
2169
- /**
2170
- * <p>The end of the time frame for which the graph was generated.</p>
2171
- */
2172
- EndTime?: Date;
2173
-
2174
- /**
2175
- * <p>The services that have processed a traced request during the specified time
2176
- * frame.</p>
2177
- */
2178
- Services?: Service[];
2179
-
2180
- /**
2181
- * <p>A flag indicating whether the group's filter expression has been consistent, or
2182
- * if the returned service graph may show traces from an older version of the group's filter
2183
- * expression.</p>
2184
- */
2185
- ContainsOldGroupVersions?: boolean;
2186
-
2187
- /**
2188
- * <p>Pagination token.</p>
2189
- */
2190
- NextToken?: string;
2191
- }
2192
-
2193
- export namespace GetServiceGraphResult {
2194
- /**
2195
- * @internal
2196
- */
2197
- export const filterSensitiveLog = (obj: GetServiceGraphResult): any => ({
2198
- ...obj,
2199
- });
2200
- }
2201
-
2202
- export interface GetTimeSeriesServiceStatisticsRequest {
2203
- /**
2204
- * <p>The start of the time frame for which to aggregate statistics.</p>
2205
- */
2206
- StartTime: Date | undefined;
2207
-
2208
- /**
2209
- * <p>The end of the time frame for which to aggregate statistics.</p>
2210
- */
2211
- EndTime: Date | undefined;
2212
-
2213
- /**
2214
- * <p>The case-sensitive name of the group for which to pull statistics from.</p>
2215
- */
2216
- GroupName?: string;
2217
-
2218
- /**
2219
- * <p>The Amazon Resource Name (ARN) of the group for which to pull statistics from.</p>
2220
- */
2221
- GroupARN?: string;
2222
-
2223
- /**
2224
- * <p>A filter expression defining entities that will be aggregated for statistics.
2225
- * Supports ID, service, and edge functions. If no selector expression is specified, edge
2226
- * statistics are returned. </p>
2227
- */
2228
- EntitySelectorExpression?: string;
2229
-
2230
- /**
2231
- * <p>Aggregation period in seconds.</p>
2232
- */
2233
- Period?: number;
2234
-
2235
- /**
2236
- * <p>The forecasted high and low fault count values. Forecast enabled requests require the
2237
- * EntitySelectorExpression ID be provided.</p>
2238
- */
2239
- ForecastStatistics?: boolean;
2240
-
2241
- /**
2242
- * <p>Pagination token.</p>
2243
- */
2244
- NextToken?: string;
2245
- }
2246
-
2247
- export namespace GetTimeSeriesServiceStatisticsRequest {
2248
- /**
2249
- * @internal
2250
- */
2251
- export const filterSensitiveLog = (obj: GetTimeSeriesServiceStatisticsRequest): any => ({
2252
- ...obj,
2253
- });
2254
- }
2255
-
2256
- /**
2257
- * <p>The predicted high and low fault count. This is used to determine if a service has
2258
- * become anomalous and if an insight should be created.</p>
2259
- */
2260
- export interface ForecastStatistics {
2261
- /**
2262
- * <p>The upper limit of fault counts for a service.</p>
2263
- */
2264
- FaultCountHigh?: number;
2265
-
2266
- /**
2267
- * <p>The lower limit of fault counts for a service.</p>
2268
- */
2269
- FaultCountLow?: number;
2270
- }
2271
-
2272
- export namespace ForecastStatistics {
2273
- /**
2274
- * @internal
2275
- */
2276
- export const filterSensitiveLog = (obj: ForecastStatistics): any => ({
2277
- ...obj,
2278
- });
2279
- }
2280
-
2281
- /**
2282
- * <p>A list of TimeSeriesStatistic structures.</p>
2283
- */
2284
- export interface TimeSeriesServiceStatistics {
2285
- /**
2286
- * <p>Timestamp of the window for which statistics are aggregated.</p>
2287
- */
2288
- Timestamp?: Date;
2289
-
2290
- /**
2291
- * <p>Response statistics for an edge.</p>
2292
- */
2293
- EdgeSummaryStatistics?: EdgeStatistics;
2294
-
2295
- /**
2296
- * <p>Response statistics for a service.</p>
2297
- */
2298
- ServiceSummaryStatistics?: ServiceStatistics;
2299
-
2300
- /**
2301
- * <p>The forecasted high and low fault count values.</p>
2302
- */
2303
- ServiceForecastStatistics?: ForecastStatistics;
2304
-
2305
- /**
2306
- * <p>The response time histogram for the selected entities.</p>
2307
- */
2308
- ResponseTimeHistogram?: HistogramEntry[];
2309
- }
2310
-
2311
- export namespace TimeSeriesServiceStatistics {
2312
- /**
2313
- * @internal
2314
- */
2315
- export const filterSensitiveLog = (obj: TimeSeriesServiceStatistics): any => ({
2316
- ...obj,
2317
- });
2318
- }
2319
-
2320
- export interface GetTimeSeriesServiceStatisticsResult {
2321
- /**
2322
- * <p>The collection of statistics.</p>
2323
- */
2324
- TimeSeriesServiceStatistics?: TimeSeriesServiceStatistics[];
2325
-
2326
- /**
2327
- * <p>A flag indicating whether or not a group's filter expression has been consistent, or if a returned
2328
- * aggregation might show statistics from an older version of the group's filter expression.</p>
2329
- */
2330
- ContainsOldGroupVersions?: boolean;
2331
-
2332
- /**
2333
- * <p>Pagination token.</p>
2334
- */
2335
- NextToken?: string;
2336
- }
2337
-
2338
- export namespace GetTimeSeriesServiceStatisticsResult {
2339
- /**
2340
- * @internal
2341
- */
2342
- export const filterSensitiveLog = (obj: GetTimeSeriesServiceStatisticsResult): any => ({
2343
- ...obj,
2344
- });
2345
- }
2346
-
2347
- export interface GetTraceGraphRequest {
2348
- /**
2349
- * <p>Trace IDs of requests for which to generate a service graph.</p>
2350
- */
2351
- TraceIds: string[] | undefined;
2352
-
2353
- /**
2354
- * <p>Pagination token.</p>
2355
- */
2356
- NextToken?: string;
2357
- }
2358
-
2359
- export namespace GetTraceGraphRequest {
2360
- /**
2361
- * @internal
2362
- */
2363
- export const filterSensitiveLog = (obj: GetTraceGraphRequest): any => ({
2364
- ...obj,
2365
- });
2366
- }
2367
-
2368
- export interface GetTraceGraphResult {
2369
- /**
2370
- * <p>The services that have processed one of the specified requests.</p>
2371
- */
2372
- Services?: Service[];
2373
-
2374
- /**
2375
- * <p>Pagination token.</p>
2376
- */
2377
- NextToken?: string;
2378
- }
2379
-
2380
- export namespace GetTraceGraphResult {
2381
- /**
2382
- * @internal
2383
- */
2384
- export const filterSensitiveLog = (obj: GetTraceGraphResult): any => ({
2385
- ...obj,
2386
- });
2387
- }
2388
-
2389
- export enum SamplingStrategyName {
2390
- FixedRate = "FixedRate",
2391
- PartialScan = "PartialScan",
2392
- }
2393
-
2394
- /**
2395
- * <p>The name and value of a sampling rule to apply to a trace summary.</p>
2396
- */
2397
- export interface SamplingStrategy {
2398
- /**
2399
- * <p>The name of a sampling rule.</p>
2400
- */
2401
- Name?: SamplingStrategyName | string;
2402
-
2403
- /**
2404
- * <p>The value of a sampling rule.</p>
2405
- */
2406
- Value?: number;
2407
- }
2408
-
2409
- export namespace SamplingStrategy {
2410
- /**
2411
- * @internal
2412
- */
2413
- export const filterSensitiveLog = (obj: SamplingStrategy): any => ({
2414
- ...obj,
2415
- });
2416
- }
2417
-
2418
- export enum TimeRangeType {
2419
- Event = "Event",
2420
- TraceId = "TraceId",
2421
- }
2422
-
2423
- export interface GetTraceSummariesRequest {
2424
- /**
2425
- * <p>The start of the time frame for which to retrieve traces.</p>
2426
- */
2427
- StartTime: Date | undefined;
2428
-
2429
- /**
2430
- * <p>The end of the time frame for which to retrieve traces.</p>
2431
- */
2432
- EndTime: Date | undefined;
2433
-
2434
- /**
2435
- * <p>A parameter to indicate whether to query trace summaries by TraceId or Event time.</p>
2436
- */
2437
- TimeRangeType?: TimeRangeType | string;
2438
-
2439
- /**
2440
- * <p>Set to <code>true</code> to get summaries for only a subset of available
2441
- * traces.</p>
2442
- */
2443
- Sampling?: boolean;
2444
-
2445
- /**
2446
- * <p>A parameter to indicate whether to enable sampling on trace summaries. Input parameters are Name and
2447
- * Value.</p>
2448
- */
2449
- SamplingStrategy?: SamplingStrategy;
2450
-
2451
- /**
2452
- * <p>Specify a filter expression to retrieve trace summaries for services or requests that
2453
- * meet certain requirements.</p>
2454
- */
2455
- FilterExpression?: string;
2456
-
2457
- /**
2458
- * <p>Specify the pagination token returned by a previous request to retrieve the next page
2459
- * of results.</p>
2460
- */
2461
- NextToken?: string;
2462
- }
2463
-
2464
- export namespace GetTraceSummariesRequest {
2465
- /**
2466
- * @internal
2467
- */
2468
- export const filterSensitiveLog = (obj: GetTraceSummariesRequest): any => ({
2469
- ...obj,
2470
- });
2471
- }
2472
-
2473
- /**
2474
- * <p>The exception associated with a root cause.</p>
2475
- */
2476
- export interface RootCauseException {
2477
- /**
2478
- * <p>The name of the exception.</p>
2479
- */
2480
- Name?: string;
2481
-
2482
- /**
2483
- * <p>The message of the exception.</p>
2484
- */
2485
- Message?: string;
2486
- }
2487
-
2488
- export namespace RootCauseException {
2489
- /**
2490
- * @internal
2491
- */
2492
- export const filterSensitiveLog = (obj: RootCauseException): any => ({
2493
- ...obj,
2494
- });
2495
- }
2496
-
2497
- /**
2498
- * <p>A collection of segments and corresponding subsegments associated to a trace summary
2499
- * error.</p>
2500
- */
2501
- export interface ErrorRootCauseEntity {
2502
- /**
2503
- * <p>The name of the entity.</p>
2504
- */
2505
- Name?: string;
2506
-
2507
- /**
2508
- * <p>The types and messages of the exceptions.</p>
2509
- */
2510
- Exceptions?: RootCauseException[];
2511
-
2512
- /**
2513
- * <p>A flag that denotes a remote subsegment.</p>
2514
- */
2515
- Remote?: boolean;
2516
- }
2517
-
2518
- export namespace ErrorRootCauseEntity {
2519
- /**
2520
- * @internal
2521
- */
2522
- export const filterSensitiveLog = (obj: ErrorRootCauseEntity): any => ({
2523
- ...obj,
2524
- });
2525
- }
2526
-
2527
- /**
2528
- * <p>A collection of fields identifying the services in a trace summary error.</p>
2529
- */
2530
- export interface ErrorRootCauseService {
2531
- /**
2532
- * <p>The service name.</p>
2533
- */
2534
- Name?: string;
2535
-
2536
- /**
2537
- * <p>A collection of associated service names.</p>
2538
- */
2539
- Names?: string[];
2540
-
2541
- /**
2542
- * <p>The type associated to the service.</p>
2543
- */
2544
- Type?: string;
2545
-
2546
- /**
2547
- * <p>The account ID associated to the service.</p>
2548
- */
2549
- AccountId?: string;
2550
-
2551
- /**
2552
- * <p>The path of root cause entities found on the service. </p>
2553
- */
2554
- EntityPath?: ErrorRootCauseEntity[];
2555
-
2556
- /**
2557
- * <p>A Boolean value indicating if the service is inferred from the trace.</p>
2558
- */
2559
- Inferred?: boolean;
2560
- }
2561
-
2562
- export namespace ErrorRootCauseService {
2563
- /**
2564
- * @internal
2565
- */
2566
- export const filterSensitiveLog = (obj: ErrorRootCauseService): any => ({
2567
- ...obj,
2568
- });
2569
- }
2570
-
2571
- /**
2572
- * <p>The root cause of a trace summary error.</p>
2573
- */
2574
- export interface ErrorRootCause {
2575
- /**
2576
- * <p>A list of services corresponding to an error. A service identifies a segment and it
2577
- * contains a name, account ID, type, and inferred flag.</p>
2578
- */
2579
- Services?: ErrorRootCauseService[];
2580
-
2581
- /**
2582
- * <p>A flag that denotes that the root cause impacts the trace client.</p>
2583
- */
2584
- ClientImpacting?: boolean;
2585
- }
2586
-
2587
- export namespace ErrorRootCause {
2588
- /**
2589
- * @internal
2590
- */
2591
- export const filterSensitiveLog = (obj: ErrorRootCause): any => ({
2592
- ...obj,
2593
- });
2594
- }
2595
-
2596
- /**
2597
- * <p>A collection of segments and corresponding subsegments associated to a trace summary
2598
- * fault error.</p>
2599
- */
2600
- export interface FaultRootCauseEntity {
2601
- /**
2602
- * <p>The name of the entity.</p>
2603
- */
2604
- Name?: string;
2605
-
2606
- /**
2607
- * <p>The types and messages of the exceptions.</p>
2608
- */
2609
- Exceptions?: RootCauseException[];
2610
-
2611
- /**
2612
- * <p>A flag that denotes a remote subsegment.</p>
2613
- */
2614
- Remote?: boolean;
2615
- }
2616
-
2617
- export namespace FaultRootCauseEntity {
2618
- /**
2619
- * @internal
2620
- */
2621
- export const filterSensitiveLog = (obj: FaultRootCauseEntity): any => ({
2622
- ...obj,
2623
- });
2624
- }
2625
-
2626
- /**
2627
- * <p>A collection of fields identifying the services in a trace summary fault.</p>
2628
- */
2629
- export interface FaultRootCauseService {
2630
- /**
2631
- * <p>The service name.</p>
2632
- */
2633
- Name?: string;
2634
-
2635
- /**
2636
- * <p>A collection of associated service names.</p>
2637
- */
2638
- Names?: string[];
2639
-
2640
- /**
2641
- * <p>The type associated to the service.</p>
2642
- */
2643
- Type?: string;
2644
-
2645
- /**
2646
- * <p>The account ID associated to the service.</p>
2647
- */
2648
- AccountId?: string;
2649
-
2650
- /**
2651
- * <p>The path of root cause entities found on the service. </p>
2652
- */
2653
- EntityPath?: FaultRootCauseEntity[];
2654
-
2655
- /**
2656
- * <p>A Boolean value indicating if the service is inferred from the trace.</p>
2657
- */
2658
- Inferred?: boolean;
2659
- }
2660
-
2661
- export namespace FaultRootCauseService {
2662
- /**
2663
- * @internal
2664
- */
2665
- export const filterSensitiveLog = (obj: FaultRootCauseService): any => ({
2666
- ...obj,
2667
- });
2668
- }
2669
-
2670
- /**
2671
- * <p>The root cause information for a trace summary fault.</p>
2672
- */
2673
- export interface FaultRootCause {
2674
- /**
2675
- * <p>A list of corresponding services. A service identifies a segment and it contains a
2676
- * name, account ID, type, and inferred flag.</p>
2677
- */
2678
- Services?: FaultRootCauseService[];
2679
-
2680
- /**
2681
- * <p>A flag that denotes that the root cause impacts the trace client.</p>
2682
- */
2683
- ClientImpacting?: boolean;
2684
- }
2685
-
2686
- export namespace FaultRootCause {
2687
- /**
2688
- * @internal
2689
- */
2690
- export const filterSensitiveLog = (obj: FaultRootCause): any => ({
2691
- ...obj,
2692
- });
2693
- }
2694
-
2695
- /**
2696
- * <p>Information about an HTTP request.</p>
2697
- */
2698
- export interface Http {
2699
- /**
2700
- * <p>The request URL.</p>
2701
- */
2702
- HttpURL?: string;
2703
-
2704
- /**
2705
- * <p>The response status.</p>
2706
- */
2707
- HttpStatus?: number;
2708
-
2709
- /**
2710
- * <p>The request method.</p>
2711
- */
2712
- HttpMethod?: string;
2713
-
2714
- /**
2715
- * <p>The request's user agent string.</p>
2716
- */
2717
- UserAgent?: string;
2718
-
2719
- /**
2720
- * <p>The IP address of the requestor.</p>
2721
- */
2722
- ClientIp?: string;
2723
- }
2724
-
2725
- export namespace Http {
2726
- /**
2727
- * @internal
2728
- */
2729
- export const filterSensitiveLog = (obj: Http): any => ({
2730
- ...obj,
2731
- });
2732
- }
2733
-
2734
- /**
2735
- * <p>A list of EC2 instance IDs corresponding to the segments in a trace. </p>
2736
- */
2737
- export interface InstanceIdDetail {
2738
- /**
2739
- * <p>The ID of a corresponding EC2 instance.</p>
2740
- */
2741
- Id?: string;
2742
- }
2743
-
2744
- export namespace InstanceIdDetail {
2745
- /**
2746
- * @internal
2747
- */
2748
- export const filterSensitiveLog = (obj: InstanceIdDetail): any => ({
2749
- ...obj,
2750
- });
2751
- }
2752
-
2753
- /**
2754
- * <p>A list of resources ARNs corresponding to the segments in a trace.</p>
2755
- */
2756
- export interface ResourceARNDetail {
2757
- /**
2758
- * <p>The ARN of a corresponding resource.</p>
2759
- */
2760
- ARN?: string;
2761
- }
2762
-
2763
- export namespace ResourceARNDetail {
2764
- /**
2765
- * @internal
2766
- */
2767
- export const filterSensitiveLog = (obj: ResourceARNDetail): any => ({
2768
- ...obj,
2769
- });
2770
- }
2771
-
2772
- /**
2773
- * <p>A collection of segments and corresponding subsegments associated to a response time
2774
- * warning.</p>
2775
- */
2776
- export interface ResponseTimeRootCauseEntity {
2777
- /**
2778
- * <p>The name of the entity.</p>
2779
- */
2780
- Name?: string;
2781
-
2782
- /**
2783
- * <p>The type and messages of the exceptions.</p>
2784
- */
2785
- Coverage?: number;
2786
-
2787
- /**
2788
- * <p>A flag that denotes a remote subsegment.</p>
2789
- */
2790
- Remote?: boolean;
2791
- }
2792
-
2793
- export namespace ResponseTimeRootCauseEntity {
2794
- /**
2795
- * @internal
2796
- */
2797
- export const filterSensitiveLog = (obj: ResponseTimeRootCauseEntity): any => ({
2798
- ...obj,
2799
- });
2800
- }
2801
-
2802
- /**
2803
- * <p>A collection of fields identifying the service in a response time warning.</p>
2804
- */
2805
- export interface ResponseTimeRootCauseService {
2806
- /**
2807
- * <p>The service name.</p>
2808
- */
2809
- Name?: string;
2810
-
2811
- /**
2812
- * <p>A collection of associated service names.</p>
2813
- */
2814
- Names?: string[];
2815
-
2816
- /**
2817
- * <p>The type associated to the service.</p>
2818
- */
2819
- Type?: string;
2820
-
2821
- /**
2822
- * <p>The account ID associated to the service.</p>
2823
- */
2824
- AccountId?: string;
2825
-
2826
- /**
2827
- * <p>The path of root cause entities found on the service. </p>
2828
- */
2829
- EntityPath?: ResponseTimeRootCauseEntity[];
2830
-
2831
- /**
2832
- * <p>A Boolean value indicating if the service is inferred from the trace.</p>
2833
- */
2834
- Inferred?: boolean;
2835
- }
2836
-
2837
- export namespace ResponseTimeRootCauseService {
2838
- /**
2839
- * @internal
2840
- */
2841
- export const filterSensitiveLog = (obj: ResponseTimeRootCauseService): any => ({
2842
- ...obj,
2843
- });
2844
- }
2845
-
2846
- /**
2847
- * <p>The root cause information for a response time warning.</p>
2848
- */
2849
- export interface ResponseTimeRootCause {
2850
- /**
2851
- * <p>A list of corresponding services. A service identifies a segment and contains a name,
2852
- * account ID, type, and inferred flag.</p>
2853
- */
2854
- Services?: ResponseTimeRootCauseService[];
2855
-
2856
- /**
2857
- * <p>A flag that denotes that the root cause impacts the trace client.</p>
2858
- */
2859
- ClientImpacting?: boolean;
2860
- }
2861
-
2862
- export namespace ResponseTimeRootCause {
2863
- /**
2864
- * @internal
2865
- */
2866
- export const filterSensitiveLog = (obj: ResponseTimeRootCause): any => ({
2867
- ...obj,
2868
- });
2869
- }
2870
-
2871
- /**
2872
- * <p>Information about a user recorded in segment documents.</p>
2873
- */
2874
- export interface TraceUser {
2875
- /**
2876
- * <p>The user's name.</p>
2877
- */
2878
- UserName?: string;
2879
-
2880
- /**
2881
- * <p>Services that the user's request hit.</p>
2882
- */
2883
- ServiceIds?: ServiceId[];
2884
- }
2885
-
2886
- export namespace TraceUser {
2887
- /**
2888
- * @internal
2889
- */
2890
- export const filterSensitiveLog = (obj: TraceUser): any => ({
2891
- ...obj,
2892
- });
2893
- }
2894
-
2895
- /**
2896
- * <p>Metadata generated from the segment documents in a trace.</p>
2897
- */
2898
- export interface TraceSummary {
2899
- /**
2900
- * <p>The unique identifier for the request that generated the trace's segments and
2901
- * subsegments.</p>
2902
- */
2903
- Id?: string;
2904
-
2905
- /**
2906
- * <p>The length of time in seconds between the start time of the root segment and the end
2907
- * time of the last segment that completed.</p>
2908
- */
2909
- Duration?: number;
2910
-
2911
- /**
2912
- * <p>The length of time in seconds between the start and end times of the root segment. If
2913
- * the service performs work asynchronously, the response time measures the time before the
2914
- * response is sent to the user, while the duration measures the amount of time before the last
2915
- * traced activity completes.</p>
2916
- */
2917
- ResponseTime?: number;
2918
-
2919
- /**
2920
- * <p>The root segment document has a 500 series error.</p>
2921
- */
2922
- HasFault?: boolean;
2923
-
2924
- /**
2925
- * <p>The root segment document has a 400 series error.</p>
2926
- */
2927
- HasError?: boolean;
2928
-
2929
- /**
2930
- * <p>One or more of the segment documents has a 429 throttling error.</p>
2931
- */
2932
- HasThrottle?: boolean;
2933
-
2934
- /**
2935
- * <p>One or more of the segment documents is in progress.</p>
2936
- */
2937
- IsPartial?: boolean;
2938
-
2939
- /**
2940
- * <p>Information about the HTTP request served by the trace.</p>
2941
- */
2942
- Http?: Http;
2943
-
2944
- /**
2945
- * <p>Annotations from the trace's segment documents.</p>
2946
- */
2947
- Annotations?: { [key: string]: ValueWithServiceIds[] };
2948
-
2949
- /**
2950
- * <p>Users from the trace's segment documents.</p>
2951
- */
2952
- Users?: TraceUser[];
2953
-
2954
- /**
2955
- * <p>Service IDs from the trace's segment documents.</p>
2956
- */
2957
- ServiceIds?: ServiceId[];
2958
-
2959
- /**
2960
- * <p>A list of resource ARNs for any resource corresponding to the trace segments.</p>
2961
- */
2962
- ResourceARNs?: ResourceARNDetail[];
2963
-
2964
- /**
2965
- * <p>A list of EC2 instance IDs for any instance corresponding to the trace
2966
- * segments.</p>
2967
- */
2968
- InstanceIds?: InstanceIdDetail[];
2969
-
2970
- /**
2971
- * <p>A list of Availability Zones for any zone corresponding to the trace segments.</p>
2972
- */
2973
- AvailabilityZones?: AvailabilityZoneDetail[];
2974
-
2975
- /**
2976
- * <p>The root of a trace.</p>
2977
- */
2978
- EntryPoint?: ServiceId;
2979
-
2980
- /**
2981
- * <p>A collection of FaultRootCause structures corresponding to the trace segments.</p>
2982
- */
2983
- FaultRootCauses?: FaultRootCause[];
2984
-
2985
- /**
2986
- * <p>A collection of ErrorRootCause structures corresponding to the trace
2987
- * segments.</p>
2988
- */
2989
- ErrorRootCauses?: ErrorRootCause[];
2990
-
2991
- /**
2992
- * <p>A collection of ResponseTimeRootCause structures corresponding to the trace
2993
- * segments.</p>
2994
- */
2995
- ResponseTimeRootCauses?: ResponseTimeRootCause[];
2996
-
2997
- /**
2998
- * <p>The revision number of a trace.</p>
2999
- */
3000
- Revision?: number;
3001
-
3002
- /**
3003
- * <p>The matched time stamp of a defined event.</p>
3004
- */
3005
- MatchedEventTime?: Date;
3006
- }
3007
-
3008
- export namespace TraceSummary {
3009
- /**
3010
- * @internal
3011
- */
3012
- export const filterSensitiveLog = (obj: TraceSummary): any => ({
3013
- ...obj,
3014
- ...(obj.Annotations && {
3015
- Annotations: Object.entries(obj.Annotations).reduce(
3016
- (acc: any, [key, value]: [string, ValueWithServiceIds[]]) => ({
3017
- ...acc,
3018
- [key]: value.map((item) => ValueWithServiceIds.filterSensitiveLog(item)),
3019
- }),
3020
- {}
3021
- ),
3022
- }),
3023
- });
3024
- }
3025
-
3026
- export interface GetTraceSummariesResult {
3027
- /**
3028
- * <p>Trace IDs and annotations for traces that were found in the specified time
3029
- * frame.</p>
3030
- */
3031
- TraceSummaries?: TraceSummary[];
3032
-
3033
- /**
3034
- * <p>The start time of this page of results.</p>
3035
- */
3036
- ApproximateTime?: Date;
3037
-
3038
- /**
3039
- * <p>The total number of traces processed, including traces that did not match the specified
3040
- * filter expression.</p>
3041
- */
3042
- TracesProcessedCount?: number;
3043
-
3044
- /**
3045
- * <p>If the requested time frame contained more than one page of results, you can use this token to retrieve the
3046
- * next page. The first page contains the most recent results, closest to the end of the time frame.</p>
3047
- */
3048
- NextToken?: string;
3049
- }
3050
-
3051
- export namespace GetTraceSummariesResult {
3052
- /**
3053
- * @internal
3054
- */
3055
- export const filterSensitiveLog = (obj: GetTraceSummariesResult): any => ({
3056
- ...obj,
3057
- });
3058
- }
3059
-
3060
- export interface ListTagsForResourceRequest {
3061
- /**
3062
- * <p>The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.</p>
3063
- */
3064
- ResourceARN: string | undefined;
3065
-
3066
- /**
3067
- * <p>A pagination token. If multiple pages of results are returned, use the <code>NextToken</code> value returned with
3068
- * the current page of results as the value of this parameter to get the next page of results.</p>
3069
- */
3070
- NextToken?: string;
3071
- }
3072
-
3073
- export namespace ListTagsForResourceRequest {
3074
- /**
3075
- * @internal
3076
- */
3077
- export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({
3078
- ...obj,
3079
- });
3080
- }
3081
-
3082
- export interface ListTagsForResourceResponse {
3083
- /**
3084
- * <p>A list of tags, as key and value pairs, that is associated with the specified X-Ray group or sampling rule.</p>
3085
- */
3086
- Tags?: Tag[];
3087
-
3088
- /**
3089
- * <p>A pagination token. If multiple pages of results are returned, use the <code>NextToken</code> value returned with
3090
- * the current page of results to get the next page of results.</p>
3091
- */
3092
- NextToken?: string;
3093
- }
3094
-
3095
- export namespace ListTagsForResourceResponse {
3096
- /**
3097
- * @internal
3098
- */
3099
- export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({
3100
- ...obj,
3101
- });
3102
- }
3103
-
3104
- /**
3105
- * <p>The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is
3106
- * correct.</p>
3107
- */
3108
- export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
3109
- name: "ResourceNotFoundException";
3110
- $fault: "client";
3111
- Message?: string;
3112
- ResourceName?: string;
3113
- }
3114
-
3115
- export namespace ResourceNotFoundException {
3116
- /**
3117
- * @internal
3118
- */
3119
- export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({
3120
- ...obj,
3121
- });
3122
- }
3123
-
3124
- export interface PutEncryptionConfigRequest {
3125
- /**
3126
- * <p>An Amazon Web Services KMS key in one of the following formats:</p>
3127
- * <ul>
3128
- * <li>
3129
- * <p>
3130
- * <b>Alias</b> - The name of the key. For example,
3131
- * <code>alias/MyKey</code>.</p>
3132
- * </li>
3133
- * <li>
3134
- * <p>
3135
- * <b>Key ID</b> - The KMS key ID of the key. For example,
3136
- * <code>ae4aa6d49-a4d8-9df9-a475-4ff6d7898456</code>. Amazon Web Services X-Ray does not support asymmetric KMS keys.</p>
3137
- * </li>
3138
- * <li>
3139
- * <p>
3140
- * <b>ARN</b> - The full Amazon Resource Name of the key ID or alias.
3141
- * For example,
3142
- * <code>arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456</code>.
3143
- * Use this format to specify a key in a different account.</p>
3144
- * </li>
3145
- * </ul>
3146
- * <p>Omit this key if you set <code>Type</code> to <code>NONE</code>.</p>
3147
- */
3148
- KeyId?: string;
3149
-
3150
- /**
3151
- * <p>The type of encryption. Set to <code>KMS</code> to use your own key for encryption. Set
3152
- * to <code>NONE</code> for default encryption.</p>
3153
- */
3154
- Type: EncryptionType | string | undefined;
3155
- }
3156
-
3157
- export namespace PutEncryptionConfigRequest {
3158
- /**
3159
- * @internal
3160
- */
3161
- export const filterSensitiveLog = (obj: PutEncryptionConfigRequest): any => ({
3162
- ...obj,
3163
- });
3164
- }
3165
-
3166
- export interface PutEncryptionConfigResult {
3167
- /**
3168
- * <p>The new encryption configuration.</p>
3169
- */
3170
- EncryptionConfig?: EncryptionConfig;
3171
- }
3172
-
3173
- export namespace PutEncryptionConfigResult {
3174
- /**
3175
- * @internal
3176
- */
3177
- export const filterSensitiveLog = (obj: PutEncryptionConfigResult): any => ({
3178
- ...obj,
3179
- });
3180
- }
3181
-
3182
- /**
3183
- * <p></p>
3184
- */
3185
- export interface BackendConnectionErrors {
3186
- /**
3187
- * <p></p>
3188
- */
3189
- TimeoutCount?: number;
3190
-
3191
- /**
3192
- * <p></p>
3193
- */
3194
- ConnectionRefusedCount?: number;
3195
-
3196
- /**
3197
- * <p></p>
3198
- */
3199
- HTTPCode4XXCount?: number;
3200
-
3201
- /**
3202
- * <p></p>
3203
- */
3204
- HTTPCode5XXCount?: number;
3205
-
3206
- /**
3207
- * <p></p>
3208
- */
3209
- UnknownHostCount?: number;
3210
-
3211
- /**
3212
- * <p></p>
3213
- */
3214
- OtherCount?: number;
3215
- }
3216
-
3217
- export namespace BackendConnectionErrors {
3218
- /**
3219
- * @internal
3220
- */
3221
- export const filterSensitiveLog = (obj: BackendConnectionErrors): any => ({
3222
- ...obj,
3223
- });
3224
- }
3225
-
3226
- /**
3227
- * <p></p>
3228
- */
3229
- export interface TelemetryRecord {
3230
- /**
3231
- * <p></p>
3232
- */
3233
- Timestamp: Date | undefined;
3234
-
3235
- /**
3236
- * <p></p>
3237
- */
3238
- SegmentsReceivedCount?: number;
3239
-
3240
- /**
3241
- * <p></p>
3242
- */
3243
- SegmentsSentCount?: number;
3244
-
3245
- /**
3246
- * <p></p>
3247
- */
3248
- SegmentsSpilloverCount?: number;
3249
-
3250
- /**
3251
- * <p></p>
3252
- */
3253
- SegmentsRejectedCount?: number;
3254
-
3255
- /**
3256
- * <p></p>
3257
- */
3258
- BackendConnectionErrors?: BackendConnectionErrors;
3259
- }
3260
-
3261
- export namespace TelemetryRecord {
3262
- /**
3263
- * @internal
3264
- */
3265
- export const filterSensitiveLog = (obj: TelemetryRecord): any => ({
3266
- ...obj,
3267
- });
3268
- }
3269
-
3270
- export interface PutTelemetryRecordsRequest {
3271
- /**
3272
- * <p></p>
3273
- */
3274
- TelemetryRecords: TelemetryRecord[] | undefined;
3275
-
3276
- /**
3277
- * <p></p>
3278
- */
3279
- EC2InstanceId?: string;
3280
-
3281
- /**
3282
- * <p></p>
3283
- */
3284
- Hostname?: string;
3285
-
3286
- /**
3287
- * <p></p>
3288
- */
3289
- ResourceARN?: string;
3290
- }
3291
-
3292
- export namespace PutTelemetryRecordsRequest {
3293
- /**
3294
- * @internal
3295
- */
3296
- export const filterSensitiveLog = (obj: PutTelemetryRecordsRequest): any => ({
3297
- ...obj,
3298
- });
3299
- }
3300
-
3301
- export interface PutTelemetryRecordsResult {}
3302
-
3303
- export namespace PutTelemetryRecordsResult {
3304
- /**
3305
- * @internal
3306
- */
3307
- export const filterSensitiveLog = (obj: PutTelemetryRecordsResult): any => ({
3308
- ...obj,
3309
- });
3310
- }
3311
-
3312
- export interface PutTraceSegmentsRequest {
3313
- /**
3314
- * <p>A string containing a JSON document defining one or more segments or
3315
- * subsegments.</p>
3316
- */
3317
- TraceSegmentDocuments: string[] | undefined;
3318
- }
3319
-
3320
- export namespace PutTraceSegmentsRequest {
3321
- /**
3322
- * @internal
3323
- */
3324
- export const filterSensitiveLog = (obj: PutTraceSegmentsRequest): any => ({
3325
- ...obj,
3326
- });
3327
- }
3328
-
3329
- /**
3330
- * <p>Information about a segment that failed processing.</p>
3331
- */
3332
- export interface UnprocessedTraceSegment {
3333
- /**
3334
- * <p>The segment's ID.</p>
3335
- */
3336
- Id?: string;
3337
-
3338
- /**
3339
- * <p>The error that caused processing to fail.</p>
3340
- */
3341
- ErrorCode?: string;
3342
-
3343
- /**
3344
- * <p>The error message.</p>
3345
- */
3346
- Message?: string;
3347
- }
3348
-
3349
- export namespace UnprocessedTraceSegment {
3350
- /**
3351
- * @internal
3352
- */
3353
- export const filterSensitiveLog = (obj: UnprocessedTraceSegment): any => ({
3354
- ...obj,
3355
- });
3356
- }
3357
-
3358
- export interface PutTraceSegmentsResult {
3359
- /**
3360
- * <p>Segments that failed processing.</p>
3361
- */
3362
- UnprocessedTraceSegments?: UnprocessedTraceSegment[];
3363
- }
3364
-
3365
- export namespace PutTraceSegmentsResult {
3366
- /**
3367
- * @internal
3368
- */
3369
- export const filterSensitiveLog = (obj: PutTraceSegmentsResult): any => ({
3370
- ...obj,
3371
- });
3372
- }
3373
-
3374
- export interface TagResourceRequest {
3375
- /**
3376
- * <p>The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.</p>
3377
- */
3378
- ResourceARN: string | undefined;
3379
-
3380
- /**
3381
- * <p>A map that contains one or more tag keys and tag values to attach to an X-Ray group or
3382
- * 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>
3383
- * in the <i>Amazon Web Services General Reference</i>.</p>
3384
- * <p>The following restrictions apply to tags:</p>
3385
- * <ul>
3386
- * <li>
3387
- * <p>Maximum number of user-applied tags per resource: 50</p>
3388
- * </li>
3389
- * <li>
3390
- * <p>Maximum tag key length: 128 Unicode characters</p>
3391
- * </li>
3392
- * <li>
3393
- * <p>Maximum tag value length: 256 Unicode characters</p>
3394
- * </li>
3395
- * <li>
3396
- * <p>Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . :
3397
- * / = + - and @</p>
3398
- * </li>
3399
- * <li>
3400
- * <p>Tag keys and values are case sensitive.</p>
3401
- * </li>
3402
- * <li>
3403
- * <p>Don't use <code>aws:</code> as a prefix for keys; it's reserved for Amazon Web Services use. You
3404
- * cannot edit or delete system tags.</p>
3405
- * </li>
3406
- * </ul>
3407
- */
3408
- Tags: Tag[] | undefined;
3409
- }
3410
-
3411
- export namespace TagResourceRequest {
3412
- /**
3413
- * @internal
3414
- */
3415
- export const filterSensitiveLog = (obj: TagResourceRequest): any => ({
3416
- ...obj,
3417
- });
3418
- }
3419
-
3420
- export interface TagResourceResponse {}
3421
-
3422
- export namespace TagResourceResponse {
3423
- /**
3424
- * @internal
3425
- */
3426
- export const filterSensitiveLog = (obj: TagResourceResponse): any => ({
3427
- ...obj,
3428
- });
3429
- }
3430
-
3431
- /**
3432
- * <p>You have exceeded the maximum number of tags you can apply to this resource.</p>
3433
- */
3434
- export interface TooManyTagsException extends __SmithyException, $MetadataBearer {
3435
- name: "TooManyTagsException";
3436
- $fault: "client";
3437
- Message?: string;
3438
- ResourceName?: string;
3439
- }
3440
-
3441
- export namespace TooManyTagsException {
3442
- /**
3443
- * @internal
3444
- */
3445
- export const filterSensitiveLog = (obj: TooManyTagsException): any => ({
3446
- ...obj,
3447
- });
3448
- }
3449
-
3450
- export interface UntagResourceRequest {
3451
- /**
3452
- * <p>The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.</p>
3453
- */
3454
- ResourceARN: string | undefined;
3455
-
3456
- /**
3457
- * <p>Keys for one or more tags that you want to remove from an X-Ray group or sampling rule.</p>
3458
- */
3459
- TagKeys: string[] | undefined;
3460
- }
3461
-
3462
- export namespace UntagResourceRequest {
3463
- /**
3464
- * @internal
3465
- */
3466
- export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({
3467
- ...obj,
3468
- });
3469
- }
3470
-
3471
- export interface UntagResourceResponse {}
3472
-
3473
- export namespace UntagResourceResponse {
3474
- /**
3475
- * @internal
3476
- */
3477
- export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({
3478
- ...obj,
3479
- });
3480
- }
3481
-
3482
- export interface UpdateGroupRequest {
3483
- /**
3484
- * <p>The case-sensitive name of the group.</p>
3485
- */
3486
- GroupName?: string;
3487
-
3488
- /**
3489
- * <p>The ARN that was generated upon creation.</p>
3490
- */
3491
- GroupARN?: string;
3492
-
3493
- /**
3494
- * <p>The updated filter expression defining criteria by which to group traces.</p>
3495
- */
3496
- FilterExpression?: string;
3497
-
3498
- /**
3499
- * <p>The structure containing configurations related to insights.</p>
3500
- * <ul>
3501
- * <li>
3502
- * <p>The InsightsEnabled boolean can be set to true to enable insights for the
3503
- * group or false to disable insights for the group.</p>
3504
- * </li>
3505
- * <li>
3506
- * <p>The NotifcationsEnabled boolean can be set to true to enable insights notifications for the group.
3507
- * Notifications can only be enabled on a group with InsightsEnabled set to true.</p>
3508
- * </li>
3509
- * </ul>
3510
- */
3511
- InsightsConfiguration?: InsightsConfiguration;
3512
- }
3513
-
3514
- export namespace UpdateGroupRequest {
3515
- /**
3516
- * @internal
3517
- */
3518
- export const filterSensitiveLog = (obj: UpdateGroupRequest): any => ({
3519
- ...obj,
3520
- });
3521
- }
3522
-
3523
- export interface UpdateGroupResult {
3524
- /**
3525
- * <p>The group that was updated. Contains the name of the group that was updated, the
3526
- * ARN of the group that was updated, the updated filter expression, and the updated insight
3527
- * configuration assigned to the group.</p>
3528
- */
3529
- Group?: Group;
3530
- }
3531
-
3532
- export namespace UpdateGroupResult {
3533
- /**
3534
- * @internal
3535
- */
3536
- export const filterSensitiveLog = (obj: UpdateGroupResult): any => ({
3537
- ...obj,
3538
- });
3539
- }
3540
-
3541
- /**
3542
- * <p>A document specifying changes to a sampling rule's configuration.</p>
3543
- */
3544
- export interface SamplingRuleUpdate {
3545
- /**
3546
- * <p>The name of the sampling rule. Specify a rule by either name or ARN, but not both.</p>
3547
- */
3548
- RuleName?: string;
3549
-
3550
- /**
3551
- * <p>The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.</p>
3552
- */
3553
- RuleARN?: string;
3554
-
3555
- /**
3556
- * <p>Matches the ARN of the Amazon Web Services resource on which the service runs.</p>
3557
- */
3558
- ResourceARN?: string;
3559
-
3560
- /**
3561
- * <p>The priority of the sampling rule.</p>
3562
- */
3563
- Priority?: number;
3564
-
3565
- /**
3566
- * <p>The percentage of matching requests to instrument, after the reservoir is
3567
- * exhausted.</p>
3568
- */
3569
- FixedRate?: number;
3570
-
3571
- /**
3572
- * <p>A fixed number of matching requests to instrument per second, prior to applying the
3573
- * fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.</p>
3574
- */
3575
- ReservoirSize?: number;
3576
-
3577
- /**
3578
- * <p>Matches the hostname from a request URL.</p>
3579
- */
3580
- Host?: string;
3581
-
3582
- /**
3583
- * <p>Matches the <code>name</code> that the service uses to identify itself in segments.</p>
3584
- */
3585
- ServiceName?: string;
3586
-
3587
- /**
3588
- * <p>Matches the <code>origin</code> that the service uses to identify its type in segments.</p>
3589
- */
3590
- ServiceType?: string;
3591
-
3592
- /**
3593
- * <p>Matches the HTTP method of a request.</p>
3594
- */
3595
- HTTPMethod?: string;
3596
-
3597
- /**
3598
- * <p>Matches the path from a request URL.</p>
3599
- */
3600
- URLPath?: string;
3601
-
3602
- /**
3603
- * <p>Matches attributes derived from the request.</p>
3604
- */
3605
- Attributes?: { [key: string]: string };
3606
- }
3607
-
3608
- export namespace SamplingRuleUpdate {
3609
- /**
3610
- * @internal
3611
- */
3612
- export const filterSensitiveLog = (obj: SamplingRuleUpdate): any => ({
3613
- ...obj,
3614
- });
3615
- }
3616
-
3617
- export interface UpdateSamplingRuleRequest {
3618
- /**
3619
- * <p>The rule and fields to change.</p>
3620
- */
3621
- SamplingRuleUpdate: SamplingRuleUpdate | undefined;
3622
- }
3623
-
3624
- export namespace UpdateSamplingRuleRequest {
3625
- /**
3626
- * @internal
3627
- */
3628
- export const filterSensitiveLog = (obj: UpdateSamplingRuleRequest): any => ({
3629
- ...obj,
3630
- });
3631
- }
3632
-
3633
- export interface UpdateSamplingRuleResult {
3634
- /**
3635
- * <p>The updated rule definition and metadata.</p>
3636
- */
3637
- SamplingRuleRecord?: SamplingRuleRecord;
3638
- }
3639
-
3640
- export namespace UpdateSamplingRuleResult {
3641
- /**
3642
- * @internal
3643
- */
3644
- export const filterSensitiveLog = (obj: UpdateSamplingRuleResult): any => ({
3645
- ...obj,
3646
- });
3647
- }