@aws-sdk/client-rum 3.192.0 → 3.194.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.
- package/CHANGELOG.md +19 -0
- package/README.md +7 -7
- package/dist-cjs/RUM.js +105 -0
- package/dist-cjs/RUMClient.js +11 -8
- package/dist-cjs/commands/BatchCreateRumMetricDefinitionsCommand.js +46 -0
- package/dist-cjs/commands/BatchDeleteRumMetricDefinitionsCommand.js +46 -0
- package/dist-cjs/commands/BatchGetRumMetricDefinitionsCommand.js +46 -0
- package/dist-cjs/commands/CreateAppMonitorCommand.js +10 -0
- package/dist-cjs/commands/DeleteAppMonitorCommand.js +10 -0
- package/dist-cjs/commands/DeleteRumMetricsDestinationCommand.js +46 -0
- package/dist-cjs/commands/GetAppMonitorCommand.js +10 -0
- package/dist-cjs/commands/GetAppMonitorDataCommand.js +10 -0
- package/dist-cjs/commands/ListAppMonitorsCommand.js +10 -0
- package/dist-cjs/commands/ListRumMetricsDestinationsCommand.js +46 -0
- package/dist-cjs/commands/ListTagsForResourceCommand.js +10 -0
- package/dist-cjs/commands/PutRumEventsCommand.js +10 -0
- package/dist-cjs/commands/PutRumMetricsDestinationCommand.js +46 -0
- package/dist-cjs/commands/TagResourceCommand.js +10 -0
- package/dist-cjs/commands/UntagResourceCommand.js +10 -0
- package/dist-cjs/commands/UpdateAppMonitorCommand.js +10 -0
- package/dist-cjs/commands/UpdateRumMetricDefinitionCommand.js +46 -0
- package/dist-cjs/commands/index.js +7 -0
- package/dist-cjs/endpoint/EndpointParameters.js +13 -0
- package/dist-cjs/endpoint/endpointResolver.js +12 -0
- package/dist-cjs/endpoint/ruleset.js +318 -0
- package/dist-cjs/models/models_0.js +98 -16
- package/dist-cjs/pagination/BatchGetRumMetricDefinitionsPaginator.js +36 -0
- package/dist-cjs/pagination/ListRumMetricsDestinationsPaginator.js +36 -0
- package/dist-cjs/pagination/index.js +2 -0
- package/dist-cjs/protocols/Aws_restJson1.js +675 -17
- package/dist-cjs/runtimeConfig.shared.js +3 -3
- package/dist-es/RUM.js +105 -0
- package/dist-es/RUMClient.js +12 -9
- package/dist-es/commands/BatchCreateRumMetricDefinitionsCommand.js +42 -0
- package/dist-es/commands/BatchDeleteRumMetricDefinitionsCommand.js +42 -0
- package/dist-es/commands/BatchGetRumMetricDefinitionsCommand.js +42 -0
- package/dist-es/commands/CreateAppMonitorCommand.js +10 -0
- package/dist-es/commands/DeleteAppMonitorCommand.js +10 -0
- package/dist-es/commands/DeleteRumMetricsDestinationCommand.js +42 -0
- package/dist-es/commands/GetAppMonitorCommand.js +10 -0
- package/dist-es/commands/GetAppMonitorDataCommand.js +10 -0
- package/dist-es/commands/ListAppMonitorsCommand.js +10 -0
- package/dist-es/commands/ListRumMetricsDestinationsCommand.js +42 -0
- package/dist-es/commands/ListTagsForResourceCommand.js +10 -0
- package/dist-es/commands/PutRumEventsCommand.js +10 -0
- package/dist-es/commands/PutRumMetricsDestinationCommand.js +42 -0
- package/dist-es/commands/TagResourceCommand.js +10 -0
- package/dist-es/commands/UntagResourceCommand.js +10 -0
- package/dist-es/commands/UpdateAppMonitorCommand.js +10 -0
- package/dist-es/commands/UpdateRumMetricDefinitionCommand.js +42 -0
- package/dist-es/commands/index.js +7 -0
- package/dist-es/endpoint/EndpointParameters.js +8 -0
- package/dist-es/endpoint/endpointResolver.js +8 -0
- package/dist-es/endpoint/ruleset.js +315 -0
- package/dist-es/models/models_0.js +76 -14
- package/dist-es/pagination/BatchGetRumMetricDefinitionsPaginator.js +32 -0
- package/dist-es/pagination/ListRumMetricsDestinationsPaginator.js +32 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +657 -13
- package/dist-es/runtimeConfig.shared.js +2 -2
- package/dist-types/RUM.d.ts +83 -0
- package/dist-types/RUMClient.d.ts +15 -11
- package/dist-types/commands/BatchCreateRumMetricDefinitionsCommand.d.ts +60 -0
- package/dist-types/commands/BatchDeleteRumMetricDefinitionsCommand.d.ts +42 -0
- package/dist-types/commands/BatchGetRumMetricDefinitionsCommand.d.ts +37 -0
- package/dist-types/commands/CreateAppMonitorCommand.d.ts +2 -0
- package/dist-types/commands/DeleteAppMonitorCommand.d.ts +2 -0
- package/dist-types/commands/DeleteRumMetricsDestinationCommand.d.ts +38 -0
- package/dist-types/commands/GetAppMonitorCommand.d.ts +2 -0
- package/dist-types/commands/GetAppMonitorDataCommand.d.ts +2 -0
- package/dist-types/commands/ListAppMonitorsCommand.d.ts +2 -0
- package/dist-types/commands/ListRumMetricsDestinationsCommand.d.ts +39 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -0
- package/dist-types/commands/PutRumEventsCommand.d.ts +2 -0
- package/dist-types/commands/PutRumMetricsDestinationCommand.d.ts +39 -0
- package/dist-types/commands/TagResourceCommand.d.ts +2 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -0
- package/dist-types/commands/UpdateAppMonitorCommand.d.ts +2 -0
- package/dist-types/commands/UpdateRumMetricDefinitionCommand.d.ts +38 -0
- package/dist-types/commands/index.d.ts +7 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +19 -0
- package/dist-types/endpoint/endpointResolver.d.ts +5 -0
- package/dist-types/endpoint/ruleset.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +719 -57
- package/dist-types/pagination/BatchGetRumMetricDefinitionsPaginator.d.ts +4 -0
- package/dist-types/pagination/ListRumMetricsDestinationsPaginator.d.ts +4 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +21 -0
- package/dist-types/runtimeConfig.browser.d.ts +4 -2
- package/dist-types/runtimeConfig.d.ts +4 -2
- package/dist-types/runtimeConfig.native.d.ts +4 -2
- package/dist-types/runtimeConfig.shared.d.ts +3 -1
- package/dist-types/ts3.4/RUM.d.ts +119 -0
- package/dist-types/ts3.4/RUMClient.d.ts +59 -10
- package/dist-types/ts3.4/commands/BatchCreateRumMetricDefinitionsCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/BatchDeleteRumMetricDefinitionsCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/BatchGetRumMetricDefinitionsCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/CreateAppMonitorCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/DeleteAppMonitorCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/DeleteRumMetricsDestinationCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/GetAppMonitorCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/GetAppMonitorDataCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/ListAppMonitorsCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/ListRumMetricsDestinationsCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/PutRumEventsCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/PutRumMetricsDestinationCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/UpdateAppMonitorCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/UpdateRumMetricDefinitionCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/index.d.ts +7 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +26 -0
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
- package/dist-types/ts3.4/models/models_0.d.ts +170 -18
- package/dist-types/ts3.4/pagination/BatchGetRumMetricDefinitionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListRumMetricsDestinationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +84 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +14 -4
- package/dist-types/ts3.4/runtimeConfig.d.ts +14 -4
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +14 -3
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +6 -1
- package/package.json +28 -26
- package/dist-cjs/endpoints.js +0 -132
- package/dist-es/endpoints.js +0 -128
- package/dist-types/endpoints.d.ts +0 -2
- package/dist-types/ts3.4/endpoints.d.ts +0 -2
|
@@ -46,14 +46,16 @@ export interface AppMonitorConfiguration {
|
|
|
46
46
|
*/
|
|
47
47
|
IncludedPages?: string[];
|
|
48
48
|
/**
|
|
49
|
-
* <p>A list of pages in
|
|
49
|
+
* <p>A list of pages in your application that are to be displayed with a "favorite" icon
|
|
50
|
+
* in the CloudWatch RUM console.</p>
|
|
50
51
|
*/
|
|
51
52
|
FavoritePages?: string[];
|
|
52
53
|
/**
|
|
53
|
-
* <p>Specifies the
|
|
54
|
+
* <p>Specifies the portion of user sessions to use for RUM data collection. Choosing a higher portion gives you
|
|
54
55
|
* more data but also incurs more costs.</p>
|
|
55
|
-
* <p>The
|
|
56
|
-
*
|
|
56
|
+
* <p>The range for this value is 0 to 1 inclusive. Setting this to 1 means that 100% of user sessions are sampled, and setting
|
|
57
|
+
* it to 0.1 means that 10% of user sessions are sampled.</p>
|
|
58
|
+
* <p>If you omit this parameter, the default of 0.1 is used, and 10% of sessions will be sampled.</p>
|
|
57
59
|
*/
|
|
58
60
|
SessionSampleRate?: number;
|
|
59
61
|
/**
|
|
@@ -190,69 +192,388 @@ export interface AppMonitorDetails {
|
|
|
190
192
|
*/
|
|
191
193
|
version?: string;
|
|
192
194
|
}
|
|
195
|
+
export declare enum MetricDestination {
|
|
196
|
+
CloudWatch = "CloudWatch",
|
|
197
|
+
Evidently = "Evidently"
|
|
198
|
+
}
|
|
193
199
|
/**
|
|
194
|
-
* <p>
|
|
200
|
+
* <p>Use this structure to define one extended metric that RUM will send
|
|
201
|
+
* to CloudWatch or CloudWatch Evidently. For more information, see
|
|
202
|
+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-vended-metrics.html">
|
|
203
|
+
* Additional metrics that you can send to CloudWatch and CloudWatch Evidently</a>.</p>
|
|
204
|
+
* <p>Only certain combinations of values for <code>Name</code>, <code>ValueKey</code>, and <code>EventPattern</code>
|
|
205
|
+
* are valid. In addition to what is displayed in the list below, the <code>EventPattern</code> can also include information
|
|
206
|
+
* used by the <code>DimensionKeys</code> field.</p>
|
|
207
|
+
* <ul>
|
|
208
|
+
* <li>
|
|
209
|
+
* <p>If <code>Name</code> is <code>PerformanceNavigationDuration</code>, then
|
|
210
|
+
* <code>ValueKey</code>must be <code>event_details.duration</code> and the <code>EventPattern</code>
|
|
211
|
+
* must include <code>{"event_type":["com.amazon.rum.performance_navigation_event"]}</code>
|
|
212
|
+
* </p>
|
|
213
|
+
* </li>
|
|
214
|
+
* <li>
|
|
215
|
+
* <p>If <code>Name</code> is <code>PerformanceResourceDuration</code>, then
|
|
216
|
+
* <code>ValueKey</code>must be <code>event_details.duration</code> and the <code>EventPattern</code>
|
|
217
|
+
* must include <code>{"event_type":["com.amazon.rum.performance_resource_event"]}</code>
|
|
218
|
+
* </p>
|
|
219
|
+
* </li>
|
|
220
|
+
* <li>
|
|
221
|
+
* <p>If <code>Name</code> is <code>NavigationSatisfiedTransaction</code>, then
|
|
222
|
+
* <code>ValueKey</code>must be null and the <code>EventPattern</code>
|
|
223
|
+
* must include <code>{
|
|
224
|
+
* "event_type": ["com.amazon.rum.performance_navigation_event"],
|
|
225
|
+
* "event_details": {
|
|
226
|
+
* "duration": [{
|
|
227
|
+
* "numeric": [">",2000]
|
|
228
|
+
* }]
|
|
229
|
+
* }
|
|
230
|
+
* }</code>
|
|
231
|
+
* </p>
|
|
232
|
+
* </li>
|
|
233
|
+
* <li>
|
|
234
|
+
* <p>If <code>Name</code> is <code>NavigationToleratedTransaction</code>, then
|
|
235
|
+
* <code>ValueKey</code>must be null and the <code>EventPattern</code>
|
|
236
|
+
* must include <code>{
|
|
237
|
+
* "event_type": ["com.amazon.rum.performance_navigation_event"],
|
|
238
|
+
* "event_details": {
|
|
239
|
+
* "duration": [{
|
|
240
|
+
* "numeric": [">=",2000,"<"8000]
|
|
241
|
+
* }]
|
|
242
|
+
* }
|
|
243
|
+
* }</code>
|
|
244
|
+
* </p>
|
|
245
|
+
* </li>
|
|
246
|
+
* <li>
|
|
247
|
+
* <p>If <code>Name</code> is <code>NavigationFrustratedTransaction</code>, then
|
|
248
|
+
* <code>ValueKey</code>must be null and the <code>EventPattern</code>
|
|
249
|
+
* must include <code>{
|
|
250
|
+
* "event_type": ["com.amazon.rum.performance_navigation_event"],
|
|
251
|
+
* "event_details": {
|
|
252
|
+
* "duration": [{
|
|
253
|
+
* "numeric": [">=",8000]
|
|
254
|
+
* }]
|
|
255
|
+
* }
|
|
256
|
+
* }</code>
|
|
257
|
+
* </p>
|
|
258
|
+
* </li>
|
|
259
|
+
* <li>
|
|
260
|
+
* <p>If <code>Name</code> is <code>WebVitalsCumulativeLayoutShift</code>, then
|
|
261
|
+
* <code>ValueKey</code>must be <code>event_details.value</code> and the <code>EventPattern</code>
|
|
262
|
+
* must include <code>{"event_type":["com.amazon.rum.cumulative_layout_shift_event"]}</code>
|
|
263
|
+
* </p>
|
|
264
|
+
* </li>
|
|
265
|
+
* <li>
|
|
266
|
+
* <p>If <code>Name</code> is <code>WebVitalsFirstInputDelay</code>, then
|
|
267
|
+
* <code>ValueKey</code>must be <code>event_details.value</code> and the <code>EventPattern</code>
|
|
268
|
+
* must include <code>{"event_type":["com.amazon.rum.first_input_delay_event"]}</code>
|
|
269
|
+
* </p>
|
|
270
|
+
* </li>
|
|
271
|
+
* <li>
|
|
272
|
+
* <p>If <code>Name</code> is <code>WebVitalsLargestContentfulPaint</code>, then
|
|
273
|
+
* <code>ValueKey</code>must be <code>event_details.value</code> and the <code>EventPattern</code>
|
|
274
|
+
* must include <code>{"event_type":["com.amazon.rum.largest_contentful_paint_event"]}</code>
|
|
275
|
+
* </p>
|
|
276
|
+
* </li>
|
|
277
|
+
* <li>
|
|
278
|
+
* <p>If <code>Name</code> is <code>JsErrorCount</code>, then
|
|
279
|
+
* <code>ValueKey</code>must be null and the <code>EventPattern</code>
|
|
280
|
+
* must include <code>{"event_type":["com.amazon.rum.js_error_event"]}</code>
|
|
281
|
+
* </p>
|
|
282
|
+
* </li>
|
|
283
|
+
* <li>
|
|
284
|
+
* <p>If <code>Name</code> is <code>HttpErrorCount</code>, then
|
|
285
|
+
* <code>ValueKey</code>must be null and the <code>EventPattern</code>
|
|
286
|
+
* must include <code>{"event_type":["com.amazon.rum.http_event"]}</code>
|
|
287
|
+
* </p>
|
|
288
|
+
* </li>
|
|
289
|
+
* <li>
|
|
290
|
+
* <p>If <code>Name</code> is <code>SessionCount</code>, then
|
|
291
|
+
* <code>ValueKey</code>must be null and the <code>EventPattern</code>
|
|
292
|
+
* must include <code>{"event_type":["com.amazon.rum.session_start_event"]}</code>
|
|
293
|
+
* </p>
|
|
294
|
+
* </li>
|
|
295
|
+
* </ul>
|
|
195
296
|
*/
|
|
196
|
-
export
|
|
197
|
-
readonly name: "ConflictException";
|
|
198
|
-
readonly $fault: "client";
|
|
297
|
+
export interface MetricDefinitionRequest {
|
|
199
298
|
/**
|
|
200
|
-
* <p>The name
|
|
299
|
+
* <p>The name for the metric that is defined in this structure. Valid values are the following:</p>
|
|
300
|
+
* <ul>
|
|
301
|
+
* <li>
|
|
302
|
+
* <p>
|
|
303
|
+
* <code>PerformanceNavigationDuration</code>
|
|
304
|
+
* </p>
|
|
305
|
+
* </li>
|
|
306
|
+
* <li>
|
|
307
|
+
* <p>
|
|
308
|
+
* <code>PerformanceResourceDuration
|
|
309
|
+
* </code>
|
|
310
|
+
* </p>
|
|
311
|
+
* </li>
|
|
312
|
+
* <li>
|
|
313
|
+
* <p>
|
|
314
|
+
* <code>NavigationSatisfiedTransaction</code>
|
|
315
|
+
* </p>
|
|
316
|
+
* </li>
|
|
317
|
+
* <li>
|
|
318
|
+
* <p>
|
|
319
|
+
* <code>NavigationToleratedTransaction</code>
|
|
320
|
+
* </p>
|
|
321
|
+
* </li>
|
|
322
|
+
* <li>
|
|
323
|
+
* <p>
|
|
324
|
+
* <code>NavigationFrustratedTransaction</code>
|
|
325
|
+
* </p>
|
|
326
|
+
* </li>
|
|
327
|
+
* <li>
|
|
328
|
+
* <p>
|
|
329
|
+
* <code>WebVitalsCumulativeLayoutShift</code>
|
|
330
|
+
* </p>
|
|
331
|
+
* </li>
|
|
332
|
+
* <li>
|
|
333
|
+
* <p>
|
|
334
|
+
* <code>WebVitalsFirstInputDelay</code>
|
|
335
|
+
* </p>
|
|
336
|
+
* </li>
|
|
337
|
+
* <li>
|
|
338
|
+
* <p>
|
|
339
|
+
* <code>WebVitalsLargestContentfulPaint</code>
|
|
340
|
+
* </p>
|
|
341
|
+
* </li>
|
|
342
|
+
* <li>
|
|
343
|
+
* <p>
|
|
344
|
+
* <code>JsErrorCount</code>
|
|
345
|
+
* </p>
|
|
346
|
+
* </li>
|
|
347
|
+
* <li>
|
|
348
|
+
* <p>
|
|
349
|
+
* <code>HttpErrorCount</code>
|
|
350
|
+
* </p>
|
|
351
|
+
* </li>
|
|
352
|
+
* <li>
|
|
353
|
+
* <p>
|
|
354
|
+
* <code>SessionCount</code>
|
|
355
|
+
* </p>
|
|
356
|
+
* </li>
|
|
357
|
+
* </ul>
|
|
201
358
|
*/
|
|
202
|
-
|
|
359
|
+
Name: string | undefined;
|
|
203
360
|
/**
|
|
204
|
-
* <p>The
|
|
361
|
+
* <p>The field within the event object that the metric value is sourced from.</p>
|
|
362
|
+
* <p>If you omit this field, a hardcoded value of 1 is pushed as the metric value. This is useful if you
|
|
363
|
+
* just want to count the number of events that the filter catches. </p>
|
|
364
|
+
* <p>If this metric is sent to CloudWatch Evidently, this field will be passed to Evidently raw and Evidently
|
|
365
|
+
* will handle data extraction from the event.</p>
|
|
205
366
|
*/
|
|
206
|
-
|
|
367
|
+
ValueKey?: string;
|
|
207
368
|
/**
|
|
208
|
-
*
|
|
369
|
+
* <p>The CloudWatch metric unit to use for this metric. If you omit this field, the metric
|
|
370
|
+
* is recorded with no unit.</p>
|
|
209
371
|
*/
|
|
210
|
-
|
|
372
|
+
UnitLabel?: string;
|
|
373
|
+
/**
|
|
374
|
+
* <p>Use this field only if you are sending the metric to CloudWatch.</p>
|
|
375
|
+
* <p>This field is a map of field paths to dimension names. It defines the dimensions to associate with this
|
|
376
|
+
* metric in CloudWatch. Valid values for the entries in this field are the following:</p>
|
|
377
|
+
* <ul>
|
|
378
|
+
* <li>
|
|
379
|
+
* <p>
|
|
380
|
+
* <code>"metadata.pageId": "PageId"</code>
|
|
381
|
+
* </p>
|
|
382
|
+
* </li>
|
|
383
|
+
* <li>
|
|
384
|
+
* <p>
|
|
385
|
+
* <code>"metadata.browserName": "BrowserName"</code>
|
|
386
|
+
* </p>
|
|
387
|
+
* </li>
|
|
388
|
+
* <li>
|
|
389
|
+
* <p>
|
|
390
|
+
* <code>"metadata.deviceType": "DeviceType"</code>
|
|
391
|
+
* </p>
|
|
392
|
+
* </li>
|
|
393
|
+
* <li>
|
|
394
|
+
* <p>
|
|
395
|
+
* <code>"metadata.osName": "OSName"</code>
|
|
396
|
+
* </p>
|
|
397
|
+
* </li>
|
|
398
|
+
* <li>
|
|
399
|
+
* <p>
|
|
400
|
+
* <code>"metadata.countryCode": "CountryCode"</code>
|
|
401
|
+
* </p>
|
|
402
|
+
* </li>
|
|
403
|
+
* <li>
|
|
404
|
+
* <p>
|
|
405
|
+
* <code>"event_details.fileType": "FileType"</code>
|
|
406
|
+
* </p>
|
|
407
|
+
* </li>
|
|
408
|
+
* </ul>
|
|
409
|
+
*
|
|
410
|
+
* <p> All dimensions listed in this field
|
|
411
|
+
* must also be included in <code>EventPattern</code>.</p>
|
|
412
|
+
*/
|
|
413
|
+
DimensionKeys?: Record<string, string>;
|
|
414
|
+
/**
|
|
415
|
+
* <p>The pattern that defines the metric, specified as a JSON object. RUM checks events that happen in a user's session
|
|
416
|
+
* against the pattern, and events that match the pattern are sent to the metric destination.</p>
|
|
417
|
+
* <p>When you define extended metrics, the metric definition is not valid if <code>EventPattern</code>
|
|
418
|
+
* is omitted.</p>
|
|
419
|
+
* <p>Example event patterns:</p>
|
|
420
|
+
* <ul>
|
|
421
|
+
* <li>
|
|
422
|
+
* <p>
|
|
423
|
+
* <code>'{
|
|
424
|
+
* "event_type": ["com.amazon.rum.js_error_event"],
|
|
425
|
+
* "metadata": {
|
|
426
|
+
* "browserName": [ "Chrome", "Safari" ], } }'</code>
|
|
427
|
+
* </p>
|
|
428
|
+
* </li>
|
|
429
|
+
* <li>
|
|
430
|
+
* <p>
|
|
431
|
+
* <code>'{
|
|
432
|
+
* "event_type": ["com.amazon.rum.performance_navigation_event"],
|
|
433
|
+
* "metadata": {
|
|
434
|
+
* "browserName": [ "Chrome", "Firefox" ]
|
|
435
|
+
* },
|
|
436
|
+
* "event_details": {
|
|
437
|
+
* "duration": [{
|
|
438
|
+
* "numeric": [ "<", 2000 ]
|
|
439
|
+
* }]
|
|
440
|
+
* }
|
|
441
|
+
* }'</code>
|
|
442
|
+
* </p>
|
|
443
|
+
* </li>
|
|
444
|
+
* <li>
|
|
445
|
+
* <p>
|
|
446
|
+
* <code>'{
|
|
447
|
+
* "event_type": ["com.amazon.rum.performance_navigation_event"],
|
|
448
|
+
* "metadata": {
|
|
449
|
+
* "browserName": [ "Chrome", "Safari" ],
|
|
450
|
+
* "countryCode": [ "US" ]
|
|
451
|
+
* },
|
|
452
|
+
* "event_details": {
|
|
453
|
+
* "duration": [{
|
|
454
|
+
* "numeric": [ ">=", 2000, "<", 8000 ]
|
|
455
|
+
* }]
|
|
456
|
+
* }
|
|
457
|
+
* }'</code>
|
|
458
|
+
* </p>
|
|
459
|
+
* </li>
|
|
460
|
+
* </ul>
|
|
461
|
+
* <p>If the metrics destination'
|
|
462
|
+
* is <code>CloudWatch</code> and the event
|
|
463
|
+
* also matches a value in <code>DimensionKeys</code>, then the metric is published with the specified dimensions. </p>
|
|
464
|
+
*/
|
|
465
|
+
EventPattern?: string;
|
|
211
466
|
}
|
|
212
|
-
export interface
|
|
467
|
+
export interface BatchCreateRumMetricDefinitionsRequest {
|
|
213
468
|
/**
|
|
214
|
-
* <p>
|
|
469
|
+
* <p>The name of the CloudWatch RUM app monitor that is to send the metrics.</p>
|
|
470
|
+
*/
|
|
471
|
+
AppMonitorName: string | undefined;
|
|
472
|
+
/**
|
|
473
|
+
* <p>The destination to send the metrics to. Valid values are <code>CloudWatch</code> and <code>Evidently</code>. If
|
|
474
|
+
* you specify <code>Evidently</code>, you must also specify the ARN of the CloudWatchEvidently experiment
|
|
475
|
+
* that will receive
|
|
476
|
+
* the metrics and an IAM role that has permission to write to the experiment.</p>
|
|
477
|
+
*/
|
|
478
|
+
Destination: MetricDestination | string | undefined;
|
|
479
|
+
/**
|
|
480
|
+
* <p>This parameter is required if <code>Destination</code> is <code>Evidently</code>. If <code>Destination</code> is
|
|
481
|
+
* <code>CloudWatch</code>, do not use this parameter.</p>
|
|
482
|
+
* <p>This parameter specifies the ARN of the Evidently experiment that is to receive the metrics. You must have already defined this
|
|
483
|
+
* experiment as a valid destination. For more information, see <a href="https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_PutRumMetricsDestination.html">PutRumMetricsDestination</a>.</p>
|
|
484
|
+
*/
|
|
485
|
+
DestinationArn?: string;
|
|
486
|
+
/**
|
|
487
|
+
* <p>An array of structures which define the metrics that you want to send.</p>
|
|
488
|
+
*/
|
|
489
|
+
MetricDefinitions: MetricDefinitionRequest[] | undefined;
|
|
490
|
+
}
|
|
491
|
+
/**
|
|
492
|
+
* <p>A structure that defines one error caused by a
|
|
493
|
+
* <a href="https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_BatchCreateRumMetricsDefinitions.html">BatchCreateRumMetricsDefinitions</a>
|
|
494
|
+
* operation.</p>
|
|
495
|
+
*/
|
|
496
|
+
export interface BatchCreateRumMetricDefinitionsError {
|
|
497
|
+
/**
|
|
498
|
+
* <p>The metric definition that caused this error.</p>
|
|
499
|
+
*/
|
|
500
|
+
MetricDefinition: MetricDefinitionRequest | undefined;
|
|
501
|
+
/**
|
|
502
|
+
* <p>The error code.</p>
|
|
503
|
+
*/
|
|
504
|
+
ErrorCode: string | undefined;
|
|
505
|
+
/**
|
|
506
|
+
* <p>The error message for this metric definition.</p>
|
|
507
|
+
*/
|
|
508
|
+
ErrorMessage: string | undefined;
|
|
509
|
+
}
|
|
510
|
+
/**
|
|
511
|
+
* <p>A structure that displays the definition of one extended metric that RUM sends
|
|
512
|
+
* to CloudWatch or CloudWatch Evidently. For more information, see
|
|
513
|
+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-vended-metrics.html">
|
|
514
|
+
* Additional metrics that you can send to CloudWatch and CloudWatch Evidently</a>.</p>
|
|
515
|
+
*/
|
|
516
|
+
export interface MetricDefinition {
|
|
517
|
+
/**
|
|
518
|
+
* <p>The ID of this metric definition.</p>
|
|
519
|
+
*/
|
|
520
|
+
MetricDefinitionId: string | undefined;
|
|
521
|
+
/**
|
|
522
|
+
* <p>The name of the metric that is defined in this structure.</p>
|
|
215
523
|
*/
|
|
216
524
|
Name: string | undefined;
|
|
217
525
|
/**
|
|
218
|
-
* <p>The
|
|
526
|
+
* <p>The field within the event object that the metric value is sourced from.</p>
|
|
219
527
|
*/
|
|
220
|
-
|
|
528
|
+
ValueKey?: string;
|
|
221
529
|
/**
|
|
222
|
-
* <p>
|
|
223
|
-
*
|
|
224
|
-
* permissions by granting a user
|
|
225
|
-
* permission to access or change only resources with certain tag values.</p>
|
|
226
|
-
* <p>Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.</p>
|
|
227
|
-
*
|
|
228
|
-
* <p>You can associate as many as 50 tags with an app monitor.</p>
|
|
229
|
-
* <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>
|
|
530
|
+
* <p>Use this field only if you are sending this metric to CloudWatch. It defines
|
|
531
|
+
* the CloudWatch metric unit that this metric is measured in. </p>
|
|
230
532
|
*/
|
|
231
|
-
|
|
533
|
+
UnitLabel?: string;
|
|
232
534
|
/**
|
|
233
|
-
* <p>
|
|
234
|
-
*
|
|
235
|
-
*
|
|
236
|
-
* authorization method. For more information, see
|
|
237
|
-
* <a href="https://docs.aws.amazon.com/monitoring/CloudWatch-RUM-get-started-authorization.html">Authorize your application
|
|
238
|
-
* to send data to Amazon Web Services</a>.</p>
|
|
239
|
-
* <p>If you omit this argument, the sample rate used for RUM is set to 10% of the user sessions.</p>
|
|
535
|
+
* <p>This field is a map of field paths to dimension names. It defines the dimensions to associate with this
|
|
536
|
+
* metric in CloudWatch The value of this field is used only if the metric destination is <code>CloudWatch</code>.
|
|
537
|
+
* If the metric destination is <code>Evidently</code>, the value of <code>DimensionKeys</code> is ignored.</p>
|
|
240
538
|
*/
|
|
241
|
-
|
|
539
|
+
DimensionKeys?: Record<string, string>;
|
|
242
540
|
/**
|
|
243
|
-
* <p>
|
|
244
|
-
*
|
|
245
|
-
*
|
|
246
|
-
*
|
|
247
|
-
*
|
|
541
|
+
* <p>The pattern that defines the metric. RUM checks events that happen in a user's session
|
|
542
|
+
* against the pattern, and events that match the pattern are sent to the metric destination.</p>
|
|
543
|
+
* <p>If the metrics destination
|
|
544
|
+
* is <code>CloudWatch</code> and the event
|
|
545
|
+
* also matches a value in <code>DimensionKeys</code>, then the metric is published with the specified dimensions. </p>
|
|
248
546
|
*/
|
|
249
|
-
|
|
547
|
+
EventPattern?: string;
|
|
250
548
|
}
|
|
251
|
-
export interface
|
|
549
|
+
export interface BatchCreateRumMetricDefinitionsResponse {
|
|
252
550
|
/**
|
|
253
|
-
* <p>
|
|
551
|
+
* <p>An array of error objects, if the operation caused any errors.</p>
|
|
254
552
|
*/
|
|
255
|
-
|
|
553
|
+
Errors: BatchCreateRumMetricDefinitionsError[] | undefined;
|
|
554
|
+
/**
|
|
555
|
+
* <p>An array of structures that define the extended metrics.</p>
|
|
556
|
+
*/
|
|
557
|
+
MetricDefinitions?: MetricDefinition[];
|
|
558
|
+
}
|
|
559
|
+
/**
|
|
560
|
+
* <p>This operation attempted to create a resource that already exists.</p>
|
|
561
|
+
*/
|
|
562
|
+
export declare class ConflictException extends __BaseException {
|
|
563
|
+
readonly name: "ConflictException";
|
|
564
|
+
readonly $fault: "client";
|
|
565
|
+
/**
|
|
566
|
+
* <p>The name of the resource that is associated with the error.</p>
|
|
567
|
+
*/
|
|
568
|
+
resourceName: string | undefined;
|
|
569
|
+
/**
|
|
570
|
+
* <p>The type of the resource that is associated with the error.</p>
|
|
571
|
+
*/
|
|
572
|
+
resourceType?: string;
|
|
573
|
+
/**
|
|
574
|
+
* @internal
|
|
575
|
+
*/
|
|
576
|
+
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
256
577
|
}
|
|
257
578
|
/**
|
|
258
579
|
* <p>Internal service exception.</p>
|
|
@@ -270,6 +591,25 @@ export declare class InternalServerException extends __BaseException {
|
|
|
270
591
|
*/
|
|
271
592
|
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
272
593
|
}
|
|
594
|
+
/**
|
|
595
|
+
* <p>Resource not found.</p>
|
|
596
|
+
*/
|
|
597
|
+
export declare class ResourceNotFoundException extends __BaseException {
|
|
598
|
+
readonly name: "ResourceNotFoundException";
|
|
599
|
+
readonly $fault: "client";
|
|
600
|
+
/**
|
|
601
|
+
* <p>The name of the resource that is associated with the error.</p>
|
|
602
|
+
*/
|
|
603
|
+
resourceName: string | undefined;
|
|
604
|
+
/**
|
|
605
|
+
* <p>The type of the resource that is associated with the error.</p>
|
|
606
|
+
*/
|
|
607
|
+
resourceType?: string;
|
|
608
|
+
/**
|
|
609
|
+
* @internal
|
|
610
|
+
*/
|
|
611
|
+
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
612
|
+
}
|
|
273
613
|
/**
|
|
274
614
|
* <p>This request exceeds a service quota.</p>
|
|
275
615
|
*/
|
|
@@ -318,6 +658,145 @@ export declare class ValidationException extends __BaseException {
|
|
|
318
658
|
*/
|
|
319
659
|
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
320
660
|
}
|
|
661
|
+
export interface BatchDeleteRumMetricDefinitionsRequest {
|
|
662
|
+
/**
|
|
663
|
+
* <p>The name of the CloudWatch RUM app monitor that is sending these metrics.</p>
|
|
664
|
+
*/
|
|
665
|
+
AppMonitorName: string | undefined;
|
|
666
|
+
/**
|
|
667
|
+
* <p>Defines the destination where you want to stop sending the specified metrics. Valid values are <code>CloudWatch</code> and
|
|
668
|
+
* <code>Evidently</code>. If
|
|
669
|
+
* you specify <code>Evidently</code>, you must also specify the ARN of the CloudWatchEvidently experiment that is to
|
|
670
|
+
* be the destination and an IAM role that has permission to write to the experiment.</p>
|
|
671
|
+
*/
|
|
672
|
+
Destination: MetricDestination | string | undefined;
|
|
673
|
+
/**
|
|
674
|
+
* <p>This parameter is required if <code>Destination</code> is <code>Evidently</code>. If <code>Destination</code> is
|
|
675
|
+
* <code>CloudWatch</code>, do not use this parameter. </p>
|
|
676
|
+
* <p>This parameter specifies
|
|
677
|
+
* the ARN of the Evidently experiment that was receiving the metrics that are being deleted.</p>
|
|
678
|
+
*/
|
|
679
|
+
DestinationArn?: string;
|
|
680
|
+
/**
|
|
681
|
+
* <p>An array of structures which define the metrics that you want to stop sending.</p>
|
|
682
|
+
*/
|
|
683
|
+
MetricDefinitionIds: string[] | undefined;
|
|
684
|
+
}
|
|
685
|
+
/**
|
|
686
|
+
* <p>A structure that defines one error caused by a
|
|
687
|
+
* <a href="https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_BatchDeleteRumMetricsDefinitions.html">BatchCreateRumMetricsDefinitions</a>
|
|
688
|
+
* operation.</p>
|
|
689
|
+
*/
|
|
690
|
+
export interface BatchDeleteRumMetricDefinitionsError {
|
|
691
|
+
/**
|
|
692
|
+
* <p>The ID of the metric definition that caused this error.</p>
|
|
693
|
+
*/
|
|
694
|
+
MetricDefinitionId: string | undefined;
|
|
695
|
+
/**
|
|
696
|
+
* <p>The error code.</p>
|
|
697
|
+
*/
|
|
698
|
+
ErrorCode: string | undefined;
|
|
699
|
+
/**
|
|
700
|
+
* <p>The error message for this metric definition.</p>
|
|
701
|
+
*/
|
|
702
|
+
ErrorMessage: string | undefined;
|
|
703
|
+
}
|
|
704
|
+
export interface BatchDeleteRumMetricDefinitionsResponse {
|
|
705
|
+
/**
|
|
706
|
+
* <p>An array of error objects, if the operation caused any errors.</p>
|
|
707
|
+
*/
|
|
708
|
+
Errors: BatchDeleteRumMetricDefinitionsError[] | undefined;
|
|
709
|
+
/**
|
|
710
|
+
* <p>The IDs of the metric definitions that were deleted.</p>
|
|
711
|
+
*/
|
|
712
|
+
MetricDefinitionIds?: string[];
|
|
713
|
+
}
|
|
714
|
+
export interface BatchGetRumMetricDefinitionsRequest {
|
|
715
|
+
/**
|
|
716
|
+
* <p>The name of the CloudWatch RUM app monitor that is sending the metrics.</p>
|
|
717
|
+
*/
|
|
718
|
+
AppMonitorName: string | undefined;
|
|
719
|
+
/**
|
|
720
|
+
* <p>The type of destination that you want to view metrics for. Valid values are <code>CloudWatch</code>
|
|
721
|
+
* and <code>Evidently</code>.</p>
|
|
722
|
+
*/
|
|
723
|
+
Destination: MetricDestination | string | undefined;
|
|
724
|
+
/**
|
|
725
|
+
* <p>This parameter is required if <code>Destination</code> is <code>Evidently</code>. If <code>Destination</code> is
|
|
726
|
+
* <code>CloudWatch</code>, do not use this parameter.</p>
|
|
727
|
+
* <p>This parameter
|
|
728
|
+
* specifies the ARN of the Evidently experiment that corresponds to the destination.</p>
|
|
729
|
+
*/
|
|
730
|
+
DestinationArn?: string;
|
|
731
|
+
/**
|
|
732
|
+
* <p>The maximum number of results to return in one operation. The default is 50. The maximum that you can
|
|
733
|
+
* specify is 100.</p>
|
|
734
|
+
* <p>To retrieve the remaining results, make another call with the returned
|
|
735
|
+
* <code>NextToken</code> value. </p>
|
|
736
|
+
*/
|
|
737
|
+
MaxResults?: number;
|
|
738
|
+
/**
|
|
739
|
+
* <p>Use the token returned by the previous operation to request the next page of results.</p>
|
|
740
|
+
*/
|
|
741
|
+
NextToken?: string;
|
|
742
|
+
}
|
|
743
|
+
export interface BatchGetRumMetricDefinitionsResponse {
|
|
744
|
+
/**
|
|
745
|
+
* <p>An array of structures that display information about the metrics that are sent by the specified
|
|
746
|
+
* app monitor to the specified destination.</p>
|
|
747
|
+
*/
|
|
748
|
+
MetricDefinitions?: MetricDefinition[];
|
|
749
|
+
/**
|
|
750
|
+
* <p>A token that you can use in a subsequent operation to
|
|
751
|
+
* retrieve the next set of results.</p>
|
|
752
|
+
*/
|
|
753
|
+
NextToken?: string;
|
|
754
|
+
}
|
|
755
|
+
export interface CreateAppMonitorRequest {
|
|
756
|
+
/**
|
|
757
|
+
* <p>A name for the app monitor.</p>
|
|
758
|
+
*/
|
|
759
|
+
Name: string | undefined;
|
|
760
|
+
/**
|
|
761
|
+
* <p>The top-level internet domain name for which your application has administrative authority.</p>
|
|
762
|
+
*/
|
|
763
|
+
Domain: string | undefined;
|
|
764
|
+
/**
|
|
765
|
+
* <p>Assigns one or more tags (key-value pairs) to the app monitor.</p>
|
|
766
|
+
* <p>Tags can help you organize and categorize your resources. You can also use them to scope user
|
|
767
|
+
* permissions by granting a user
|
|
768
|
+
* permission to access or change only resources with certain tag values.</p>
|
|
769
|
+
* <p>Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.</p>
|
|
770
|
+
*
|
|
771
|
+
* <p>You can associate as many as 50 tags with an app monitor.</p>
|
|
772
|
+
* <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>
|
|
773
|
+
*/
|
|
774
|
+
Tags?: Record<string, string>;
|
|
775
|
+
/**
|
|
776
|
+
* <p>A structure that contains much of the configuration data for the app monitor. If you are using
|
|
777
|
+
* Amazon Cognito for authorization, you must include this structure in your request, and it must include the ID of the
|
|
778
|
+
* Amazon Cognito identity pool to use for authorization. If you don't include <code>AppMonitorConfiguration</code>, you must set up your own
|
|
779
|
+
* authorization method. For more information, see
|
|
780
|
+
* <a href="https://docs.aws.amazon.com/monitoring/CloudWatch-RUM-get-started-authorization.html">Authorize your application
|
|
781
|
+
* to send data to Amazon Web Services</a>.</p>
|
|
782
|
+
* <p>If you omit this argument, the sample rate used for RUM is set to 10% of the user sessions.</p>
|
|
783
|
+
*/
|
|
784
|
+
AppMonitorConfiguration?: AppMonitorConfiguration;
|
|
785
|
+
/**
|
|
786
|
+
* <p>Data collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM
|
|
787
|
+
* sends a copy of this telemetry data to Amazon CloudWatch Logs
|
|
788
|
+
* in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur
|
|
789
|
+
* Amazon CloudWatch Logs charges.</p>
|
|
790
|
+
* <p>If you omit this parameter, the default is <code>false</code>.</p>
|
|
791
|
+
*/
|
|
792
|
+
CwLogEnabled?: boolean;
|
|
793
|
+
}
|
|
794
|
+
export interface CreateAppMonitorResponse {
|
|
795
|
+
/**
|
|
796
|
+
* <p>The unique ID of the new app monitor.</p>
|
|
797
|
+
*/
|
|
798
|
+
Id?: string;
|
|
799
|
+
}
|
|
321
800
|
export interface DeleteAppMonitorRequest {
|
|
322
801
|
/**
|
|
323
802
|
* <p>The name of the app monitor to delete.</p>
|
|
@@ -326,24 +805,23 @@ export interface DeleteAppMonitorRequest {
|
|
|
326
805
|
}
|
|
327
806
|
export interface DeleteAppMonitorResponse {
|
|
328
807
|
}
|
|
329
|
-
|
|
330
|
-
* <p>Resource not found.</p>
|
|
331
|
-
*/
|
|
332
|
-
export declare class ResourceNotFoundException extends __BaseException {
|
|
333
|
-
readonly name: "ResourceNotFoundException";
|
|
334
|
-
readonly $fault: "client";
|
|
808
|
+
export interface DeleteRumMetricsDestinationRequest {
|
|
335
809
|
/**
|
|
336
|
-
* <p>The name of the
|
|
810
|
+
* <p>The name of the app monitor that is sending metrics to the destination that you want to delete.</p>
|
|
337
811
|
*/
|
|
338
|
-
|
|
812
|
+
AppMonitorName: string | undefined;
|
|
339
813
|
/**
|
|
340
|
-
* <p>The type of
|
|
814
|
+
* <p>The type of destination to delete. Valid values are <code>CloudWatch</code> and <code>Evidently</code>.</p>
|
|
341
815
|
*/
|
|
342
|
-
|
|
816
|
+
Destination: MetricDestination | string | undefined;
|
|
343
817
|
/**
|
|
344
|
-
*
|
|
818
|
+
* <p>This parameter is required if <code>Destination</code> is <code>Evidently</code>. If <code>Destination</code> is
|
|
819
|
+
* <code>CloudWatch</code>, do not use this parameter. This parameter
|
|
820
|
+
* specifies the ARN of the Evidently experiment that corresponds to the destination to delete.</p>
|
|
345
821
|
*/
|
|
346
|
-
|
|
822
|
+
DestinationArn?: string;
|
|
823
|
+
}
|
|
824
|
+
export interface DeleteRumMetricsDestinationResponse {
|
|
347
825
|
}
|
|
348
826
|
export interface GetAppMonitorRequest {
|
|
349
827
|
/**
|
|
@@ -435,7 +913,8 @@ export interface GetAppMonitorDataResponse {
|
|
|
435
913
|
}
|
|
436
914
|
export interface ListAppMonitorsRequest {
|
|
437
915
|
/**
|
|
438
|
-
* <p>The maximum number of results to return in one operation.
|
|
916
|
+
* <p>The maximum number of results to return in one operation. The default is 50. The maximum that you can
|
|
917
|
+
* specify is 100.</p>
|
|
439
918
|
*/
|
|
440
919
|
MaxResults?: number;
|
|
441
920
|
/**
|
|
@@ -479,6 +958,83 @@ export interface ListAppMonitorsResponse {
|
|
|
479
958
|
*/
|
|
480
959
|
AppMonitorSummaries?: AppMonitorSummary[];
|
|
481
960
|
}
|
|
961
|
+
export interface ListRumMetricsDestinationsRequest {
|
|
962
|
+
/**
|
|
963
|
+
* <p>The name of the app monitor associated with the destinations that you want to retrieve.</p>
|
|
964
|
+
*/
|
|
965
|
+
AppMonitorName: string | undefined;
|
|
966
|
+
/**
|
|
967
|
+
* <p>The maximum number of results to return in one operation. The default is 50. The maximum that you can
|
|
968
|
+
* specify is 100.</p>
|
|
969
|
+
* <p>To retrieve the remaining results, make another call with the returned
|
|
970
|
+
* <code>NextToken</code> value. </p>
|
|
971
|
+
*/
|
|
972
|
+
MaxResults?: number;
|
|
973
|
+
/**
|
|
974
|
+
* <p>Use the token returned by the previous operation to request the next page of results.</p>
|
|
975
|
+
*/
|
|
976
|
+
NextToken?: string;
|
|
977
|
+
}
|
|
978
|
+
/**
|
|
979
|
+
* <p>A structure that displays information about one destination that CloudWatch RUM sends
|
|
980
|
+
* extended metrics to.</p>
|
|
981
|
+
*/
|
|
982
|
+
export interface MetricDestinationSummary {
|
|
983
|
+
/**
|
|
984
|
+
* <p>Specifies whether the destination is <code>CloudWatch</code> or <code>Evidently</code>.</p>
|
|
985
|
+
*/
|
|
986
|
+
Destination?: MetricDestination | string;
|
|
987
|
+
/**
|
|
988
|
+
* <p>If the destination is <code>Evidently</code>, this specifies the ARN of the Evidently experiment that receives
|
|
989
|
+
* the metrics.</p>
|
|
990
|
+
*/
|
|
991
|
+
DestinationArn?: string;
|
|
992
|
+
/**
|
|
993
|
+
* <p>This field appears only when the destination is <code>Evidently</code>. It specifies
|
|
994
|
+
* the ARN of the IAM role that is used to write to the Evidently experiment that receives the metrics.</p>
|
|
995
|
+
*/
|
|
996
|
+
IamRoleArn?: string;
|
|
997
|
+
}
|
|
998
|
+
export interface ListRumMetricsDestinationsResponse {
|
|
999
|
+
/**
|
|
1000
|
+
* <p>The list of CloudWatch RUM extended metrics destinations associated with the app monitor that
|
|
1001
|
+
* you specified.</p>
|
|
1002
|
+
*/
|
|
1003
|
+
Destinations?: MetricDestinationSummary[];
|
|
1004
|
+
/**
|
|
1005
|
+
* <p>A token that you can use in a subsequent operation to
|
|
1006
|
+
* retrieve the next set of results.</p>
|
|
1007
|
+
*/
|
|
1008
|
+
NextToken?: string;
|
|
1009
|
+
}
|
|
1010
|
+
export interface PutRumMetricsDestinationRequest {
|
|
1011
|
+
/**
|
|
1012
|
+
* <p>The name of the CloudWatch RUM app monitor that will send the metrics.</p>
|
|
1013
|
+
*/
|
|
1014
|
+
AppMonitorName: string | undefined;
|
|
1015
|
+
/**
|
|
1016
|
+
* <p>Defines the destination to send the metrics to. Valid values are <code>CloudWatch</code> and
|
|
1017
|
+
* <code>Evidently</code>. If
|
|
1018
|
+
* you specify <code>Evidently</code>, you must also specify the ARN of the CloudWatchEvidently experiment that is to
|
|
1019
|
+
* be the destination and an IAM role that has permission to write to the experiment.</p>
|
|
1020
|
+
*/
|
|
1021
|
+
Destination: MetricDestination | string | undefined;
|
|
1022
|
+
/**
|
|
1023
|
+
* <p>Use this parameter only if <code>Destination</code> is <code>Evidently</code>. This parameter specifies
|
|
1024
|
+
* the ARN of the Evidently experiment that will receive the extended metrics.</p>
|
|
1025
|
+
*/
|
|
1026
|
+
DestinationArn?: string;
|
|
1027
|
+
/**
|
|
1028
|
+
* <p>This parameter is required if <code>Destination</code> is <code>Evidently</code>. If <code>Destination</code> is
|
|
1029
|
+
* <code>CloudWatch</code>, do not use this parameter.</p>
|
|
1030
|
+
* <p>This parameter specifies
|
|
1031
|
+
* the ARN of an IAM role that RUM will assume to write to the Evidently
|
|
1032
|
+
* experiment that you are sending metrics to. This role must have permission to write to that experiment.</p>
|
|
1033
|
+
*/
|
|
1034
|
+
IamRoleArn?: string;
|
|
1035
|
+
}
|
|
1036
|
+
export interface PutRumMetricsDestinationResponse {
|
|
1037
|
+
}
|
|
482
1038
|
export interface UpdateAppMonitorRequest {
|
|
483
1039
|
/**
|
|
484
1040
|
* <p>The name of the app monitor to update.</p>
|
|
@@ -507,6 +1063,36 @@ export interface UpdateAppMonitorRequest {
|
|
|
507
1063
|
}
|
|
508
1064
|
export interface UpdateAppMonitorResponse {
|
|
509
1065
|
}
|
|
1066
|
+
export interface UpdateRumMetricDefinitionRequest {
|
|
1067
|
+
/**
|
|
1068
|
+
* <p>The name of the CloudWatch RUM app monitor that sends these metrics.</p>
|
|
1069
|
+
*/
|
|
1070
|
+
AppMonitorName: string | undefined;
|
|
1071
|
+
/**
|
|
1072
|
+
* <p>The destination to send the metrics to. Valid values are <code>CloudWatch</code> and <code>Evidently</code>. If
|
|
1073
|
+
* you specify <code>Evidently</code>, you must also specify the ARN of the CloudWatchEvidently experiment
|
|
1074
|
+
* that will receive
|
|
1075
|
+
* the metrics and an IAM role that has permission to write to the experiment.</p>
|
|
1076
|
+
*/
|
|
1077
|
+
Destination: MetricDestination | string | undefined;
|
|
1078
|
+
/**
|
|
1079
|
+
* <p>This parameter is required if <code>Destination</code> is <code>Evidently</code>. If <code>Destination</code> is
|
|
1080
|
+
* <code>CloudWatch</code>, do not use this parameter.</p>
|
|
1081
|
+
* <p>This parameter specifies the ARN of the Evidently experiment that is to receive the metrics. You must have already defined this
|
|
1082
|
+
* experiment as a valid destination. For more information, see <a href="https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_PutRumMetricsDestination.html">PutRumMetricsDestination</a>.</p>
|
|
1083
|
+
*/
|
|
1084
|
+
DestinationArn?: string;
|
|
1085
|
+
/**
|
|
1086
|
+
* <p>A structure that contains the new definition that you want to use for this metric.</p>
|
|
1087
|
+
*/
|
|
1088
|
+
MetricDefinition: MetricDefinitionRequest | undefined;
|
|
1089
|
+
/**
|
|
1090
|
+
* <p>The ID of the metric definition to update.</p>
|
|
1091
|
+
*/
|
|
1092
|
+
MetricDefinitionId: string | undefined;
|
|
1093
|
+
}
|
|
1094
|
+
export interface UpdateRumMetricDefinitionResponse {
|
|
1095
|
+
}
|
|
510
1096
|
export interface ListTagsForResourceRequest {
|
|
511
1097
|
/**
|
|
512
1098
|
* <p>The ARN of the resource that you want to see the tags of.</p>
|
|
@@ -633,6 +1219,46 @@ export declare const AppMonitorFilterSensitiveLog: (obj: AppMonitor) => any;
|
|
|
633
1219
|
* @internal
|
|
634
1220
|
*/
|
|
635
1221
|
export declare const AppMonitorDetailsFilterSensitiveLog: (obj: AppMonitorDetails) => any;
|
|
1222
|
+
/**
|
|
1223
|
+
* @internal
|
|
1224
|
+
*/
|
|
1225
|
+
export declare const MetricDefinitionRequestFilterSensitiveLog: (obj: MetricDefinitionRequest) => any;
|
|
1226
|
+
/**
|
|
1227
|
+
* @internal
|
|
1228
|
+
*/
|
|
1229
|
+
export declare const BatchCreateRumMetricDefinitionsRequestFilterSensitiveLog: (obj: BatchCreateRumMetricDefinitionsRequest) => any;
|
|
1230
|
+
/**
|
|
1231
|
+
* @internal
|
|
1232
|
+
*/
|
|
1233
|
+
export declare const BatchCreateRumMetricDefinitionsErrorFilterSensitiveLog: (obj: BatchCreateRumMetricDefinitionsError) => any;
|
|
1234
|
+
/**
|
|
1235
|
+
* @internal
|
|
1236
|
+
*/
|
|
1237
|
+
export declare const MetricDefinitionFilterSensitiveLog: (obj: MetricDefinition) => any;
|
|
1238
|
+
/**
|
|
1239
|
+
* @internal
|
|
1240
|
+
*/
|
|
1241
|
+
export declare const BatchCreateRumMetricDefinitionsResponseFilterSensitiveLog: (obj: BatchCreateRumMetricDefinitionsResponse) => any;
|
|
1242
|
+
/**
|
|
1243
|
+
* @internal
|
|
1244
|
+
*/
|
|
1245
|
+
export declare const BatchDeleteRumMetricDefinitionsRequestFilterSensitiveLog: (obj: BatchDeleteRumMetricDefinitionsRequest) => any;
|
|
1246
|
+
/**
|
|
1247
|
+
* @internal
|
|
1248
|
+
*/
|
|
1249
|
+
export declare const BatchDeleteRumMetricDefinitionsErrorFilterSensitiveLog: (obj: BatchDeleteRumMetricDefinitionsError) => any;
|
|
1250
|
+
/**
|
|
1251
|
+
* @internal
|
|
1252
|
+
*/
|
|
1253
|
+
export declare const BatchDeleteRumMetricDefinitionsResponseFilterSensitiveLog: (obj: BatchDeleteRumMetricDefinitionsResponse) => any;
|
|
1254
|
+
/**
|
|
1255
|
+
* @internal
|
|
1256
|
+
*/
|
|
1257
|
+
export declare const BatchGetRumMetricDefinitionsRequestFilterSensitiveLog: (obj: BatchGetRumMetricDefinitionsRequest) => any;
|
|
1258
|
+
/**
|
|
1259
|
+
* @internal
|
|
1260
|
+
*/
|
|
1261
|
+
export declare const BatchGetRumMetricDefinitionsResponseFilterSensitiveLog: (obj: BatchGetRumMetricDefinitionsResponse) => any;
|
|
636
1262
|
/**
|
|
637
1263
|
* @internal
|
|
638
1264
|
*/
|
|
@@ -649,6 +1275,14 @@ export declare const DeleteAppMonitorRequestFilterSensitiveLog: (obj: DeleteAppM
|
|
|
649
1275
|
* @internal
|
|
650
1276
|
*/
|
|
651
1277
|
export declare const DeleteAppMonitorResponseFilterSensitiveLog: (obj: DeleteAppMonitorResponse) => any;
|
|
1278
|
+
/**
|
|
1279
|
+
* @internal
|
|
1280
|
+
*/
|
|
1281
|
+
export declare const DeleteRumMetricsDestinationRequestFilterSensitiveLog: (obj: DeleteRumMetricsDestinationRequest) => any;
|
|
1282
|
+
/**
|
|
1283
|
+
* @internal
|
|
1284
|
+
*/
|
|
1285
|
+
export declare const DeleteRumMetricsDestinationResponseFilterSensitiveLog: (obj: DeleteRumMetricsDestinationResponse) => any;
|
|
652
1286
|
/**
|
|
653
1287
|
* @internal
|
|
654
1288
|
*/
|
|
@@ -685,6 +1319,26 @@ export declare const AppMonitorSummaryFilterSensitiveLog: (obj: AppMonitorSummar
|
|
|
685
1319
|
* @internal
|
|
686
1320
|
*/
|
|
687
1321
|
export declare const ListAppMonitorsResponseFilterSensitiveLog: (obj: ListAppMonitorsResponse) => any;
|
|
1322
|
+
/**
|
|
1323
|
+
* @internal
|
|
1324
|
+
*/
|
|
1325
|
+
export declare const ListRumMetricsDestinationsRequestFilterSensitiveLog: (obj: ListRumMetricsDestinationsRequest) => any;
|
|
1326
|
+
/**
|
|
1327
|
+
* @internal
|
|
1328
|
+
*/
|
|
1329
|
+
export declare const MetricDestinationSummaryFilterSensitiveLog: (obj: MetricDestinationSummary) => any;
|
|
1330
|
+
/**
|
|
1331
|
+
* @internal
|
|
1332
|
+
*/
|
|
1333
|
+
export declare const ListRumMetricsDestinationsResponseFilterSensitiveLog: (obj: ListRumMetricsDestinationsResponse) => any;
|
|
1334
|
+
/**
|
|
1335
|
+
* @internal
|
|
1336
|
+
*/
|
|
1337
|
+
export declare const PutRumMetricsDestinationRequestFilterSensitiveLog: (obj: PutRumMetricsDestinationRequest) => any;
|
|
1338
|
+
/**
|
|
1339
|
+
* @internal
|
|
1340
|
+
*/
|
|
1341
|
+
export declare const PutRumMetricsDestinationResponseFilterSensitiveLog: (obj: PutRumMetricsDestinationResponse) => any;
|
|
688
1342
|
/**
|
|
689
1343
|
* @internal
|
|
690
1344
|
*/
|
|
@@ -693,6 +1347,14 @@ export declare const UpdateAppMonitorRequestFilterSensitiveLog: (obj: UpdateAppM
|
|
|
693
1347
|
* @internal
|
|
694
1348
|
*/
|
|
695
1349
|
export declare const UpdateAppMonitorResponseFilterSensitiveLog: (obj: UpdateAppMonitorResponse) => any;
|
|
1350
|
+
/**
|
|
1351
|
+
* @internal
|
|
1352
|
+
*/
|
|
1353
|
+
export declare const UpdateRumMetricDefinitionRequestFilterSensitiveLog: (obj: UpdateRumMetricDefinitionRequest) => any;
|
|
1354
|
+
/**
|
|
1355
|
+
* @internal
|
|
1356
|
+
*/
|
|
1357
|
+
export declare const UpdateRumMetricDefinitionResponseFilterSensitiveLog: (obj: UpdateRumMetricDefinitionResponse) => any;
|
|
696
1358
|
/**
|
|
697
1359
|
* @internal
|
|
698
1360
|
*/
|