@aws-sdk/client-rum 3.44.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 (108) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/LICENSE +201 -0
  3. package/README.md +211 -0
  4. package/dist-cjs/RUM.js +157 -0
  5. package/dist-cjs/RUMClient.js +35 -0
  6. package/dist-cjs/commands/CreateAppMonitorCommand.js +36 -0
  7. package/dist-cjs/commands/DeleteAppMonitorCommand.js +36 -0
  8. package/dist-cjs/commands/GetAppMonitorCommand.js +36 -0
  9. package/dist-cjs/commands/GetAppMonitorDataCommand.js +36 -0
  10. package/dist-cjs/commands/ListAppMonitorsCommand.js +36 -0
  11. package/dist-cjs/commands/ListTagsForResourceCommand.js +36 -0
  12. package/dist-cjs/commands/PutRumEventsCommand.js +36 -0
  13. package/dist-cjs/commands/TagResourceCommand.js +36 -0
  14. package/dist-cjs/commands/UntagResourceCommand.js +36 -0
  15. package/dist-cjs/commands/UpdateAppMonitorCommand.js +36 -0
  16. package/dist-cjs/commands/index.js +13 -0
  17. package/dist-cjs/endpoints.js +130 -0
  18. package/dist-cjs/index.js +8 -0
  19. package/dist-cjs/models/index.js +4 -0
  20. package/dist-cjs/models/models_0.js +237 -0
  21. package/dist-cjs/pagination/GetAppMonitorDataPaginator.js +35 -0
  22. package/dist-cjs/pagination/Interfaces.js +2 -0
  23. package/dist-cjs/pagination/ListAppMonitorsPaginator.js +35 -0
  24. package/dist-cjs/pagination/index.js +6 -0
  25. package/dist-cjs/protocols/Aws_restJson1.js +1502 -0
  26. package/dist-cjs/runtimeConfig.browser.js +40 -0
  27. package/dist-cjs/runtimeConfig.js +44 -0
  28. package/dist-cjs/runtimeConfig.native.js +16 -0
  29. package/dist-cjs/runtimeConfig.shared.js +17 -0
  30. package/dist-es/RUM.js +160 -0
  31. package/dist-es/RUMClient.js +37 -0
  32. package/dist-es/commands/CreateAppMonitorCommand.js +39 -0
  33. package/dist-es/commands/DeleteAppMonitorCommand.js +39 -0
  34. package/dist-es/commands/GetAppMonitorCommand.js +39 -0
  35. package/dist-es/commands/GetAppMonitorDataCommand.js +39 -0
  36. package/dist-es/commands/ListAppMonitorsCommand.js +39 -0
  37. package/dist-es/commands/ListTagsForResourceCommand.js +39 -0
  38. package/dist-es/commands/PutRumEventsCommand.js +39 -0
  39. package/dist-es/commands/TagResourceCommand.js +39 -0
  40. package/dist-es/commands/UntagResourceCommand.js +39 -0
  41. package/dist-es/commands/UpdateAppMonitorCommand.js +39 -0
  42. package/dist-es/commands/index.js +10 -0
  43. package/dist-es/endpoints.js +126 -0
  44. package/dist-es/index.js +5 -0
  45. package/dist-es/models/index.js +1 -0
  46. package/dist-es/models/models_0.js +161 -0
  47. package/dist-es/pagination/GetAppMonitorDataPaginator.js +74 -0
  48. package/dist-es/pagination/Interfaces.js +1 -0
  49. package/dist-es/pagination/ListAppMonitorsPaginator.js +74 -0
  50. package/dist-es/pagination/index.js +3 -0
  51. package/dist-es/protocols/Aws_restJson1.js +1652 -0
  52. package/dist-es/runtimeConfig.browser.js +17 -0
  53. package/dist-es/runtimeConfig.js +21 -0
  54. package/dist-es/runtimeConfig.native.js +8 -0
  55. package/dist-es/runtimeConfig.shared.js +13 -0
  56. package/dist-types/RUM.d.ts +120 -0
  57. package/dist-types/RUMClient.d.ts +158 -0
  58. package/dist-types/commands/CreateAppMonitorCommand.d.ts +43 -0
  59. package/dist-types/commands/DeleteAppMonitorCommand.d.ts +35 -0
  60. package/dist-types/commands/GetAppMonitorCommand.d.ts +35 -0
  61. package/dist-types/commands/GetAppMonitorDataCommand.d.ts +36 -0
  62. package/dist-types/commands/ListAppMonitorsCommand.d.ts +35 -0
  63. package/dist-types/commands/ListTagsForResourceCommand.d.ts +35 -0
  64. package/dist-types/commands/PutRumEventsCommand.d.ts +38 -0
  65. package/dist-types/commands/TagResourceCommand.d.ts +48 -0
  66. package/dist-types/commands/UntagResourceCommand.d.ts +35 -0
  67. package/dist-types/commands/UpdateAppMonitorCommand.d.ts +45 -0
  68. package/dist-types/commands/index.d.ts +10 -0
  69. package/dist-types/endpoints.d.ts +2 -0
  70. package/dist-types/index.d.ts +5 -0
  71. package/dist-types/models/index.d.ts +1 -0
  72. package/dist-types/models/models_0.d.ts +824 -0
  73. package/dist-types/pagination/GetAppMonitorDataPaginator.d.ts +4 -0
  74. package/dist-types/pagination/Interfaces.d.ts +6 -0
  75. package/dist-types/pagination/ListAppMonitorsPaginator.d.ts +4 -0
  76. package/dist-types/pagination/index.d.ts +3 -0
  77. package/dist-types/protocols/Aws_restJson1.d.ts +32 -0
  78. package/dist-types/runtimeConfig.browser.d.ts +39 -0
  79. package/dist-types/runtimeConfig.d.ts +39 -0
  80. package/dist-types/runtimeConfig.native.d.ts +38 -0
  81. package/dist-types/runtimeConfig.shared.d.ts +13 -0
  82. package/dist-types/ts3.4/RUM.d.ts +55 -0
  83. package/dist-types/ts3.4/RUMClient.d.ts +81 -0
  84. package/dist-types/ts3.4/commands/CreateAppMonitorCommand.d.ts +17 -0
  85. package/dist-types/ts3.4/commands/DeleteAppMonitorCommand.d.ts +17 -0
  86. package/dist-types/ts3.4/commands/GetAppMonitorCommand.d.ts +17 -0
  87. package/dist-types/ts3.4/commands/GetAppMonitorDataCommand.d.ts +17 -0
  88. package/dist-types/ts3.4/commands/ListAppMonitorsCommand.d.ts +17 -0
  89. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +17 -0
  90. package/dist-types/ts3.4/commands/PutRumEventsCommand.d.ts +17 -0
  91. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +17 -0
  92. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +17 -0
  93. package/dist-types/ts3.4/commands/UpdateAppMonitorCommand.d.ts +17 -0
  94. package/dist-types/ts3.4/commands/index.d.ts +10 -0
  95. package/dist-types/ts3.4/endpoints.d.ts +2 -0
  96. package/dist-types/ts3.4/index.d.ts +5 -0
  97. package/dist-types/ts3.4/models/index.d.ts +1 -0
  98. package/dist-types/ts3.4/models/models_0.d.ts +455 -0
  99. package/dist-types/ts3.4/pagination/GetAppMonitorDataPaginator.d.ts +4 -0
  100. package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
  101. package/dist-types/ts3.4/pagination/ListAppMonitorsPaginator.d.ts +4 -0
  102. package/dist-types/ts3.4/pagination/index.d.ts +3 -0
  103. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +32 -0
  104. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +37 -0
  105. package/dist-types/ts3.4/runtimeConfig.d.ts +37 -0
  106. package/dist-types/ts3.4/runtimeConfig.native.d.ts +36 -0
  107. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +11 -0
  108. package/package.json +94 -0
@@ -0,0 +1,824 @@
1
+ import { LazyJsonString as __LazyJsonString } from "@aws-sdk/smithy-client";
2
+ import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
3
+ /**
4
+ * <p>You don't have sufficient permissions to perform this action.</p>
5
+ */
6
+ export interface AccessDeniedException extends __SmithyException, $MetadataBearer {
7
+ name: "AccessDeniedException";
8
+ $fault: "client";
9
+ message: string | undefined;
10
+ }
11
+ export declare namespace AccessDeniedException {
12
+ /**
13
+ * @internal
14
+ */
15
+ const filterSensitiveLog: (obj: AccessDeniedException) => any;
16
+ }
17
+ export declare enum Telemetry {
18
+ /**
19
+ * Includes JS error event plugin
20
+ */
21
+ ERRORS = "errors",
22
+ /**
23
+ * Includes X-Ray Xhr and X-Ray Fetch plugin
24
+ */
25
+ HTTP = "http",
26
+ /**
27
+ * Includes navigation, paint, resource and web vital event plugins
28
+ */
29
+ PERFORMANCE = "performance"
30
+ }
31
+ /**
32
+ * <p>This structure contains much of the configuration data for the app monitor.</p>
33
+ */
34
+ export interface AppMonitorConfiguration {
35
+ /**
36
+ * <p>The ID of the Amazon Cognito identity pool
37
+ * that is used to authorize the sending of data to RUM.</p>
38
+ */
39
+ IdentityPoolId?: string;
40
+ /**
41
+ * <p>A list of URLs in your website or application to exclude from RUM data collection.</p>
42
+ * <p>You can't include both <code>ExcludedPages</code> and <code>IncludedPages</code> in the same operation.</p>
43
+ */
44
+ ExcludedPages?: string[];
45
+ /**
46
+ * <p>If this app monitor is to collect data from only certain pages in your application, this structure lists those pages. </p>
47
+ *
48
+ * <p>You can't include both <code>ExcludedPages</code> and <code>IncludedPages</code> in the same operation.</p>
49
+ */
50
+ IncludedPages?: string[];
51
+ /**
52
+ * <p>A list of pages in the CloudWatch RUM console that are to be displayed with a "favorite" icon.</p>
53
+ */
54
+ FavoritePages?: string[];
55
+ /**
56
+ * <p>Specifies the percentage of user sessions to use for RUM data collection. Choosing a higher percentage gives you
57
+ * more data but also incurs more costs.</p>
58
+ * <p>The number you specify is the percentage of user sessions that will be used.</p>
59
+ * <p>If you omit this parameter, the default of 10 is used.</p>
60
+ */
61
+ SessionSampleRate?: number;
62
+ /**
63
+ * <p>The ARN of the guest IAM role that is attached to the Amazon Cognito identity pool
64
+ * that is used to authorize the sending of data to RUM.</p>
65
+ */
66
+ GuestRoleArn?: string;
67
+ /**
68
+ * <p>If you set this to <code>true</code>, the RUM web client sets two cookies, a session
69
+ * cookie and a user cookie. The cookies allow the RUM web client to collect data relating to
70
+ * the number of users an application has and the behavior of the application across a
71
+ * sequence of events. Cookies are stored in the top-level domain of the current page.</p>
72
+ */
73
+ AllowCookies?: boolean;
74
+ /**
75
+ * <p>An array that lists the types of telemetry data that this app monitor is to collect.</p>
76
+ * <ul>
77
+ * <li>
78
+ * <p>
79
+ * <code>errors</code> indicates that RUM collects data about unhandled JavaScript errors raised
80
+ * by your application.</p>
81
+ * </li>
82
+ * <li>
83
+ * <p>
84
+ * <code>performance</code> indicates that RUM collects performance data about how your application
85
+ * and its resources are loaded and rendered. This includes Core Web Vitals.</p>
86
+ * </li>
87
+ * <li>
88
+ * <p>
89
+ * <code>http</code> indicates that RUM collects data about HTTP errors thrown by your application.</p>
90
+ * </li>
91
+ * </ul>
92
+ */
93
+ Telemetries?: (Telemetry | string)[];
94
+ /**
95
+ * <p>If you set this to <code>true</code>, RUM enables X-Ray tracing for
96
+ * the user sessions that RUM samples. RUM adds an X-Ray trace header to allowed
97
+ * HTTP requests. It also records an X-Ray segment for allowed HTTP requests.
98
+ * You can see traces and segments from these user sessions in the X-Ray console
99
+ * and the CloudWatch ServiceLens console. For more information, see <a href="https://docs.aws.amazon.com/xray/latest/devguide/aws-xray.html">What is X-Ray?</a>
100
+ * </p>
101
+ */
102
+ EnableXRay?: boolean;
103
+ }
104
+ export declare namespace AppMonitorConfiguration {
105
+ /**
106
+ * @internal
107
+ */
108
+ const filterSensitiveLog: (obj: AppMonitorConfiguration) => any;
109
+ }
110
+ /**
111
+ * <p>A structure that contains the information about whether the app monitor stores copies of the data
112
+ * that RUM collects in CloudWatch Logs. If it does, this structure also contains the name of the log group.</p>
113
+ */
114
+ export interface CwLog {
115
+ /**
116
+ * <p>Indicated whether the app monitor stores copies of the data
117
+ * that RUM collects in CloudWatch Logs.</p>
118
+ */
119
+ CwLogEnabled?: boolean;
120
+ /**
121
+ * <p>The name of the log group where the copies are stored.</p>
122
+ */
123
+ CwLogGroup?: string;
124
+ }
125
+ export declare namespace CwLog {
126
+ /**
127
+ * @internal
128
+ */
129
+ const filterSensitiveLog: (obj: CwLog) => any;
130
+ }
131
+ /**
132
+ * <p>A structure that contains information about whether this app monitor stores a copy of
133
+ * the telemetry data that RUM collects using CloudWatch Logs.</p>
134
+ */
135
+ export interface DataStorage {
136
+ /**
137
+ * <p>A structure that contains the information about whether the app monitor stores copies of the data
138
+ * that RUM collects in CloudWatch Logs. If it does, this structure also contains the name of the log group.</p>
139
+ */
140
+ CwLog?: CwLog;
141
+ }
142
+ export declare namespace DataStorage {
143
+ /**
144
+ * @internal
145
+ */
146
+ const filterSensitiveLog: (obj: DataStorage) => any;
147
+ }
148
+ export declare enum StateEnum {
149
+ ACTIVE = "ACTIVE",
150
+ CREATED = "CREATED",
151
+ DELETING = "DELETING"
152
+ }
153
+ /**
154
+ * <p>A RUM app monitor collects telemetry data from your application and sends that
155
+ * data to RUM. The data includes performance and reliability information such as page load time, client-side errors,
156
+ * and user behavior.</p>
157
+ */
158
+ export interface AppMonitor {
159
+ /**
160
+ * <p>The name of the app monitor.</p>
161
+ */
162
+ Name?: string;
163
+ /**
164
+ * <p>The top-level internet domain name for which your application has administrative authority.</p>
165
+ */
166
+ Domain?: string;
167
+ /**
168
+ * <p>The unique ID of this app monitor.</p>
169
+ */
170
+ Id?: string;
171
+ /**
172
+ * <p>The date and time that this app monitor was created.</p>
173
+ */
174
+ Created?: string;
175
+ /**
176
+ * <p>The date and time of the most recent changes to this app monitor's configuration.</p>
177
+ */
178
+ LastModified?: string;
179
+ /**
180
+ * <p>The list of tag keys and values associated with this app monitor.</p>
181
+ */
182
+ Tags?: {
183
+ [key: string]: string;
184
+ };
185
+ /**
186
+ * <p>The current state of the app monitor.</p>
187
+ */
188
+ State?: StateEnum | string;
189
+ /**
190
+ * <p>A structure that contains much of the configuration data for the app monitor.</p>
191
+ */
192
+ AppMonitorConfiguration?: AppMonitorConfiguration;
193
+ /**
194
+ * <p>A structure that contains information about whether this app monitor stores a copy of
195
+ * the telemetry data that RUM collects using CloudWatch Logs.</p>
196
+ */
197
+ DataStorage?: DataStorage;
198
+ }
199
+ export declare namespace AppMonitor {
200
+ /**
201
+ * @internal
202
+ */
203
+ const filterSensitiveLog: (obj: AppMonitor) => any;
204
+ }
205
+ /**
206
+ * <p>A structure that contains information about the RUM app monitor.</p>
207
+ */
208
+ export interface AppMonitorDetails {
209
+ /**
210
+ * <p>The name of the app monitor.</p>
211
+ */
212
+ name?: string;
213
+ /**
214
+ * <p>The unique ID of the app monitor.</p>
215
+ */
216
+ id?: string;
217
+ /**
218
+ * <p>The version of the app monitor.</p>
219
+ */
220
+ version?: string;
221
+ }
222
+ export declare namespace AppMonitorDetails {
223
+ /**
224
+ * @internal
225
+ */
226
+ const filterSensitiveLog: (obj: AppMonitorDetails) => any;
227
+ }
228
+ /**
229
+ * <p>This operation attempted to create a resource that already exists.</p>
230
+ */
231
+ export interface ConflictException extends __SmithyException, $MetadataBearer {
232
+ name: "ConflictException";
233
+ $fault: "client";
234
+ message: string | undefined;
235
+ /**
236
+ * <p>The name of the resource that is associated with the error.</p>
237
+ */
238
+ resourceName: string | undefined;
239
+ /**
240
+ * <p>The type of the resource that is associated with the error.</p>
241
+ */
242
+ resourceType?: string;
243
+ }
244
+ export declare namespace ConflictException {
245
+ /**
246
+ * @internal
247
+ */
248
+ const filterSensitiveLog: (obj: ConflictException) => any;
249
+ }
250
+ export interface CreateAppMonitorRequest {
251
+ /**
252
+ * <p>A name for the app monitor.</p>
253
+ */
254
+ Name: string | undefined;
255
+ /**
256
+ * <p>The top-level internet domain name for which your application has administrative authority.</p>
257
+ */
258
+ Domain: string | undefined;
259
+ /**
260
+ * <p>Assigns one or more tags (key-value pairs) to the app monitor.</p>
261
+ * <p>Tags can help you organize and categorize your resources. You can also use them to scope user
262
+ * permissions by granting a user
263
+ * permission to access or change only resources with certain tag values.</p>
264
+ * <p>Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.</p>
265
+ *
266
+ * <p>You can associate as many as 50 tags with an app monitor.</p>
267
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
268
+ */
269
+ Tags?: {
270
+ [key: string]: string;
271
+ };
272
+ /**
273
+ * <p>A structure that contains much of the configuration data for the app monitor. If you are using
274
+ * Amazon Cognito for authorization, you must include this structure in your request, and it must include the ID of the
275
+ * Amazon Cognito identity pool to use for authorization. If you don't include <code>AppMonitorConfiguration</code>, you must set up your own
276
+ * authorization method. For more information, see
277
+ * <a href="https://docs.aws.amazon.com/monitoring/CloudWatch-RUM-get-started-authorization.html">Authorize your application
278
+ * to send data to Amazon Web Services</a>.</p>
279
+ * <p>If you omit this argument, the sample rate used for RUM is set to 10% of the user sessions.</p>
280
+ */
281
+ AppMonitorConfiguration?: AppMonitorConfiguration;
282
+ /**
283
+ * <p>Data collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM
284
+ * sends a copy of this telemetry data to Amazon CloudWatch Logs
285
+ * in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur
286
+ * Amazon CloudWatch Logs charges.</p>
287
+ * <p>If you omit this parameter, the default is <code>false</code>.</p>
288
+ */
289
+ CwLogEnabled?: boolean;
290
+ }
291
+ export declare namespace CreateAppMonitorRequest {
292
+ /**
293
+ * @internal
294
+ */
295
+ const filterSensitiveLog: (obj: CreateAppMonitorRequest) => any;
296
+ }
297
+ export interface CreateAppMonitorResponse {
298
+ /**
299
+ * <p>The unique ID of the new app monitor.</p>
300
+ */
301
+ Id?: string;
302
+ }
303
+ export declare namespace CreateAppMonitorResponse {
304
+ /**
305
+ * @internal
306
+ */
307
+ const filterSensitiveLog: (obj: CreateAppMonitorResponse) => any;
308
+ }
309
+ /**
310
+ * <p>Internal service exception.</p>
311
+ */
312
+ export interface InternalServerException extends __SmithyException, $MetadataBearer {
313
+ name: "InternalServerException";
314
+ $fault: "server";
315
+ $retryable: {};
316
+ message: string | undefined;
317
+ /**
318
+ * <p>The value of a parameter in the request caused an error.</p>
319
+ */
320
+ retryAfterSeconds?: number;
321
+ }
322
+ export declare namespace InternalServerException {
323
+ /**
324
+ * @internal
325
+ */
326
+ const filterSensitiveLog: (obj: InternalServerException) => any;
327
+ }
328
+ /**
329
+ * <p>This request exceeds a service quota.</p>
330
+ */
331
+ export interface ServiceQuotaExceededException extends __SmithyException, $MetadataBearer {
332
+ name: "ServiceQuotaExceededException";
333
+ $fault: "client";
334
+ message: string | undefined;
335
+ }
336
+ export declare namespace ServiceQuotaExceededException {
337
+ /**
338
+ * @internal
339
+ */
340
+ const filterSensitiveLog: (obj: ServiceQuotaExceededException) => any;
341
+ }
342
+ /**
343
+ * <p>The request was throttled because of quota limits.</p>
344
+ */
345
+ export interface ThrottlingException extends __SmithyException, $MetadataBearer {
346
+ name: "ThrottlingException";
347
+ $fault: "client";
348
+ $retryable: {
349
+ throttling: true;
350
+ };
351
+ message: string | undefined;
352
+ /**
353
+ * <p>The ID of the service that is associated with the error.</p>
354
+ */
355
+ serviceCode?: string;
356
+ /**
357
+ * <p>The ID of the service quota that was exceeded.</p>
358
+ */
359
+ quotaCode?: string;
360
+ /**
361
+ * <p>The value of a parameter in the request caused an error.</p>
362
+ */
363
+ retryAfterSeconds?: number;
364
+ }
365
+ export declare namespace ThrottlingException {
366
+ /**
367
+ * @internal
368
+ */
369
+ const filterSensitiveLog: (obj: ThrottlingException) => any;
370
+ }
371
+ /**
372
+ * <p>One of the arguments for the request is not valid.</p>
373
+ */
374
+ export interface ValidationException extends __SmithyException, $MetadataBearer {
375
+ name: "ValidationException";
376
+ $fault: "client";
377
+ message: string | undefined;
378
+ }
379
+ export declare namespace ValidationException {
380
+ /**
381
+ * @internal
382
+ */
383
+ const filterSensitiveLog: (obj: ValidationException) => any;
384
+ }
385
+ export interface DeleteAppMonitorRequest {
386
+ /**
387
+ * <p>The name of the app monitor to delete.</p>
388
+ */
389
+ Name: string | undefined;
390
+ }
391
+ export declare namespace DeleteAppMonitorRequest {
392
+ /**
393
+ * @internal
394
+ */
395
+ const filterSensitiveLog: (obj: DeleteAppMonitorRequest) => any;
396
+ }
397
+ export interface DeleteAppMonitorResponse {
398
+ }
399
+ export declare namespace DeleteAppMonitorResponse {
400
+ /**
401
+ * @internal
402
+ */
403
+ const filterSensitiveLog: (obj: DeleteAppMonitorResponse) => any;
404
+ }
405
+ /**
406
+ * <p>Resource not found.</p>
407
+ */
408
+ export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
409
+ name: "ResourceNotFoundException";
410
+ $fault: "client";
411
+ message: string | undefined;
412
+ /**
413
+ * <p>The name of the resource that is associated with the error.</p>
414
+ */
415
+ resourceName: string | undefined;
416
+ /**
417
+ * <p>The type of the resource that is associated with the error.</p>
418
+ */
419
+ resourceType?: string;
420
+ }
421
+ export declare namespace ResourceNotFoundException {
422
+ /**
423
+ * @internal
424
+ */
425
+ const filterSensitiveLog: (obj: ResourceNotFoundException) => any;
426
+ }
427
+ export interface GetAppMonitorRequest {
428
+ /**
429
+ * <p>The app monitor to retrieve information for.</p>
430
+ */
431
+ Name: string | undefined;
432
+ }
433
+ export declare namespace GetAppMonitorRequest {
434
+ /**
435
+ * @internal
436
+ */
437
+ const filterSensitiveLog: (obj: GetAppMonitorRequest) => any;
438
+ }
439
+ export interface GetAppMonitorResponse {
440
+ /**
441
+ * <p>A structure containing all the configuration information for the app monitor.</p>
442
+ */
443
+ AppMonitor?: AppMonitor;
444
+ }
445
+ export declare namespace GetAppMonitorResponse {
446
+ /**
447
+ * @internal
448
+ */
449
+ const filterSensitiveLog: (obj: GetAppMonitorResponse) => any;
450
+ }
451
+ /**
452
+ * <p>A structure that defines a key and values that you can use to filter the results. The
453
+ * only performance events that are returned are those that have values matching the ones that
454
+ * you specify in one of your <code>QueryFilter</code> structures.</p>
455
+ * <p>For example, you could specify <code>Browser</code> as the <code>Name</code>
456
+ * and specify <code>Chrome,Firefox</code> as the <code>Values</code> to return
457
+ * events generated only from those browsers.</p>
458
+ * <p>Specifying <code>Invert</code> as the <code>Name</code>
459
+ * works as a "not equal to" filter. For example, specify <code>Invert</code> as the <code>Name</code>
460
+ * and specify <code>Chrome</code> as the value to return all events except events from
461
+ * user sessions with the Chrome browser.</p>
462
+ */
463
+ export interface QueryFilter {
464
+ /**
465
+ * <p>The name of a key to search for.
466
+ * The filter returns only the events that match the <code>Name</code>
467
+ * and <code>Values</code> that you specify.
468
+ * </p>
469
+ * <p>Valid values for <code>Name</code> are <code>Browser</code> | <code>Device</code> | <code>Country</code> |
470
+ * <code>Page</code> | <code>OS</code> | <code>EventType</code> | <code>Invert</code>
471
+ * </p>
472
+ */
473
+ Name?: string;
474
+ /**
475
+ * <p>The values of the <code>Name</code> that are to be be included in the returned results.</p>
476
+ */
477
+ Values?: string[];
478
+ }
479
+ export declare namespace QueryFilter {
480
+ /**
481
+ * @internal
482
+ */
483
+ const filterSensitiveLog: (obj: QueryFilter) => any;
484
+ }
485
+ /**
486
+ * <p>A structure that defines the time range that you want to retrieve results from.</p>
487
+ */
488
+ export interface TimeRange {
489
+ /**
490
+ * <p>The beginning of the time range to retrieve performance events from.</p>
491
+ */
492
+ After: number | undefined;
493
+ /**
494
+ * <p>The end of the time range to retrieve performance events from. If you omit this, the time
495
+ * range extends to the time that this operation is performed.</p>
496
+ */
497
+ Before?: number;
498
+ }
499
+ export declare namespace TimeRange {
500
+ /**
501
+ * @internal
502
+ */
503
+ const filterSensitiveLog: (obj: TimeRange) => any;
504
+ }
505
+ export interface GetAppMonitorDataRequest {
506
+ /**
507
+ * <p>The name of the app monitor that collected the data that you want to retrieve.</p>
508
+ */
509
+ Name: string | undefined;
510
+ /**
511
+ * <p>A structure that defines the time range that you want to retrieve results from.</p>
512
+ */
513
+ TimeRange: TimeRange | undefined;
514
+ /**
515
+ * <p>An array of structures that you can use to filter the results to those that match one or
516
+ * more sets of key-value pairs that you specify.</p>
517
+ */
518
+ Filters?: QueryFilter[];
519
+ /**
520
+ * <p>The maximum number of results to return in one operation. </p>
521
+ */
522
+ MaxResults?: number;
523
+ /**
524
+ * <p>Use the token returned by the previous operation to request the next page of results.</p>
525
+ */
526
+ NextToken?: string;
527
+ }
528
+ export declare namespace GetAppMonitorDataRequest {
529
+ /**
530
+ * @internal
531
+ */
532
+ const filterSensitiveLog: (obj: GetAppMonitorDataRequest) => any;
533
+ }
534
+ export interface GetAppMonitorDataResponse {
535
+ /**
536
+ * <p>The events that RUM collected that match your request.</p>
537
+ */
538
+ Events?: string[];
539
+ /**
540
+ * <p>A token that you can use in a subsequent operation to retrieve the next set of
541
+ * results.</p>
542
+ */
543
+ NextToken?: string;
544
+ }
545
+ export declare namespace GetAppMonitorDataResponse {
546
+ /**
547
+ * @internal
548
+ */
549
+ const filterSensitiveLog: (obj: GetAppMonitorDataResponse) => any;
550
+ }
551
+ export interface ListAppMonitorsRequest {
552
+ /**
553
+ * <p>The maximum number of results to return in one operation. </p>
554
+ */
555
+ MaxResults?: number;
556
+ /**
557
+ * <p>Use the token returned by the previous operation to request the next page of results.</p>
558
+ */
559
+ NextToken?: string;
560
+ }
561
+ export declare namespace ListAppMonitorsRequest {
562
+ /**
563
+ * @internal
564
+ */
565
+ const filterSensitiveLog: (obj: ListAppMonitorsRequest) => any;
566
+ }
567
+ /**
568
+ * <p>A structure that includes some data about app monitors and their settings.</p>
569
+ */
570
+ export interface AppMonitorSummary {
571
+ /**
572
+ * <p>The name of this app monitor.</p>
573
+ */
574
+ Name?: string;
575
+ /**
576
+ * <p>The unique ID of this app monitor.</p>
577
+ */
578
+ Id?: string;
579
+ /**
580
+ * <p>The date and time that the app monitor was created.</p>
581
+ */
582
+ Created?: string;
583
+ /**
584
+ * <p>The date and time of the most recent changes to this app monitor's configuration.</p>
585
+ */
586
+ LastModified?: string;
587
+ /**
588
+ * <p>The current state of this app monitor.</p>
589
+ */
590
+ State?: StateEnum | string;
591
+ }
592
+ export declare namespace AppMonitorSummary {
593
+ /**
594
+ * @internal
595
+ */
596
+ const filterSensitiveLog: (obj: AppMonitorSummary) => any;
597
+ }
598
+ export interface ListAppMonitorsResponse {
599
+ /**
600
+ * <p>A token that you can use in a subsequent operation to retrieve the next set of
601
+ * results.</p>
602
+ */
603
+ NextToken?: string;
604
+ /**
605
+ * <p>An array of structures that contain information about the returned app monitors.</p>
606
+ */
607
+ AppMonitorSummaries?: AppMonitorSummary[];
608
+ }
609
+ export declare namespace ListAppMonitorsResponse {
610
+ /**
611
+ * @internal
612
+ */
613
+ const filterSensitiveLog: (obj: ListAppMonitorsResponse) => any;
614
+ }
615
+ export interface UpdateAppMonitorRequest {
616
+ /**
617
+ * <p>The name of the app monitor to update.</p>
618
+ */
619
+ Name: string | undefined;
620
+ /**
621
+ * <p>The top-level internet domain name for which your application has administrative authority.</p>
622
+ */
623
+ Domain?: string;
624
+ /**
625
+ * <p>A structure that contains much of the configuration data for the app monitor. If you are using
626
+ * Amazon Cognito for authorization, you must include this structure in your request, and it must include the ID of the
627
+ * Amazon Cognito identity pool to use for authorization. If you don't include <code>AppMonitorConfiguration</code>, you must set up your own
628
+ * authorization method. For more information, see
629
+ * <a href="https://docs.aws.amazon.com/monitoring/CloudWatch-RUM-get-started-authorization.html">Authorize your application
630
+ * to send data to Amazon Web Services</a>.</p>
631
+ */
632
+ AppMonitorConfiguration?: AppMonitorConfiguration;
633
+ /**
634
+ * <p>Data collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM
635
+ * sends a copy of this telemetry data to Amazon CloudWatch Logs
636
+ * in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur
637
+ * Amazon CloudWatch Logs charges.</p>
638
+ */
639
+ CwLogEnabled?: boolean;
640
+ }
641
+ export declare namespace UpdateAppMonitorRequest {
642
+ /**
643
+ * @internal
644
+ */
645
+ const filterSensitiveLog: (obj: UpdateAppMonitorRequest) => any;
646
+ }
647
+ export interface UpdateAppMonitorResponse {
648
+ }
649
+ export declare namespace UpdateAppMonitorResponse {
650
+ /**
651
+ * @internal
652
+ */
653
+ const filterSensitiveLog: (obj: UpdateAppMonitorResponse) => any;
654
+ }
655
+ export interface ListTagsForResourceRequest {
656
+ /**
657
+ * <p>The ARN of the resource that you want to see the tags of.</p>
658
+ */
659
+ ResourceArn: string | undefined;
660
+ }
661
+ export declare namespace ListTagsForResourceRequest {
662
+ /**
663
+ * @internal
664
+ */
665
+ const filterSensitiveLog: (obj: ListTagsForResourceRequest) => any;
666
+ }
667
+ export interface ListTagsForResourceResponse {
668
+ /**
669
+ * <p>The ARN of the resource that you are viewing.</p>
670
+ */
671
+ ResourceArn: string | undefined;
672
+ /**
673
+ * <p>The list of tag keys and values associated with the resource you specified.</p>
674
+ */
675
+ Tags: {
676
+ [key: string]: string;
677
+ } | undefined;
678
+ }
679
+ export declare namespace ListTagsForResourceResponse {
680
+ /**
681
+ * @internal
682
+ */
683
+ const filterSensitiveLog: (obj: ListTagsForResourceResponse) => any;
684
+ }
685
+ /**
686
+ * <p>A structure that contains the information for one performance event that RUM collects from a user session with your
687
+ * application.</p>
688
+ */
689
+ export interface RumEvent {
690
+ /**
691
+ * <p>A unique ID for this event.</p>
692
+ */
693
+ id: string | undefined;
694
+ /**
695
+ * <p>The exact time that this event occurred.</p>
696
+ */
697
+ timestamp: Date | undefined;
698
+ /**
699
+ * <p>The JSON schema that denotes the type of event this is, such as a page load or a new session.</p>
700
+ */
701
+ type: string | undefined;
702
+ /**
703
+ * <p>Metadata about this event, which contains a JSON serialization of the identity of the user for
704
+ * this session. The user information comes from information such as the HTTP user-agent request header
705
+ * and document interface.</p>
706
+ */
707
+ metadata?: __LazyJsonString | string;
708
+ /**
709
+ * <p>A string containing details about the event.</p>
710
+ */
711
+ details: __LazyJsonString | string | undefined;
712
+ }
713
+ export declare namespace RumEvent {
714
+ /**
715
+ * @internal
716
+ */
717
+ const filterSensitiveLog: (obj: RumEvent) => any;
718
+ }
719
+ /**
720
+ * <p>A structure that contains information about the user session that this batch of events was collected from.</p>
721
+ */
722
+ export interface UserDetails {
723
+ /**
724
+ * <p>The ID of the user for this user session. This ID is generated by RUM and does not include any
725
+ * personally identifiable information about the user.</p>
726
+ */
727
+ userId?: string;
728
+ /**
729
+ * <p>The session ID that the performance events are from.</p>
730
+ */
731
+ sessionId?: string;
732
+ }
733
+ export declare namespace UserDetails {
734
+ /**
735
+ * @internal
736
+ */
737
+ const filterSensitiveLog: (obj: UserDetails) => any;
738
+ }
739
+ export interface PutRumEventsRequest {
740
+ /**
741
+ * <p>The ID of the app monitor that is sending this data.</p>
742
+ */
743
+ Id: string | undefined;
744
+ /**
745
+ * <p>A unique identifier for this batch of RUM event data.</p>
746
+ */
747
+ BatchId: string | undefined;
748
+ /**
749
+ * <p>A structure that contains information about the app monitor that collected this telemetry information.</p>
750
+ */
751
+ AppMonitorDetails: AppMonitorDetails | undefined;
752
+ /**
753
+ * <p>A structure that contains information about the user session that this batch of events was collected from.</p>
754
+ */
755
+ UserDetails: UserDetails | undefined;
756
+ /**
757
+ * <p>An array of structures that contain the telemetry event data.</p>
758
+ */
759
+ RumEvents: RumEvent[] | undefined;
760
+ }
761
+ export declare namespace PutRumEventsRequest {
762
+ /**
763
+ * @internal
764
+ */
765
+ const filterSensitiveLog: (obj: PutRumEventsRequest) => any;
766
+ }
767
+ export interface PutRumEventsResponse {
768
+ }
769
+ export declare namespace PutRumEventsResponse {
770
+ /**
771
+ * @internal
772
+ */
773
+ const filterSensitiveLog: (obj: PutRumEventsResponse) => any;
774
+ }
775
+ export interface TagResourceRequest {
776
+ /**
777
+ * <p>The ARN of the CloudWatch RUM resource that you're adding tags to.</p>
778
+ */
779
+ ResourceArn: string | undefined;
780
+ /**
781
+ * <p>The list of key-value pairs to associate with the resource.</p>
782
+ */
783
+ Tags: {
784
+ [key: string]: string;
785
+ } | undefined;
786
+ }
787
+ export declare namespace TagResourceRequest {
788
+ /**
789
+ * @internal
790
+ */
791
+ const filterSensitiveLog: (obj: TagResourceRequest) => any;
792
+ }
793
+ export interface TagResourceResponse {
794
+ }
795
+ export declare namespace TagResourceResponse {
796
+ /**
797
+ * @internal
798
+ */
799
+ const filterSensitiveLog: (obj: TagResourceResponse) => any;
800
+ }
801
+ export interface UntagResourceRequest {
802
+ /**
803
+ * <p>The ARN of the CloudWatch RUM resource that you're removing tags from.</p>
804
+ */
805
+ ResourceArn: string | undefined;
806
+ /**
807
+ * <p>The list of tag keys to remove from the resource.</p>
808
+ */
809
+ TagKeys: string[] | undefined;
810
+ }
811
+ export declare namespace UntagResourceRequest {
812
+ /**
813
+ * @internal
814
+ */
815
+ const filterSensitiveLog: (obj: UntagResourceRequest) => any;
816
+ }
817
+ export interface UntagResourceResponse {
818
+ }
819
+ export declare namespace UntagResourceResponse {
820
+ /**
821
+ * @internal
822
+ */
823
+ const filterSensitiveLog: (obj: UntagResourceResponse) => any;
824
+ }