@aws-sdk/client-rum 3.533.0 → 3.535.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/RUM.d.ts +2 -1
- package/dist-types/RUMClient.d.ts +1 -1
- package/dist-types/commands/BatchCreateRumMetricDefinitionsCommand.d.ts +2 -1
- package/dist-types/commands/BatchDeleteRumMetricDefinitionsCommand.d.ts +2 -1
- package/dist-types/commands/BatchGetRumMetricDefinitionsCommand.d.ts +2 -1
- package/dist-types/commands/CreateAppMonitorCommand.d.ts +2 -1
- package/dist-types/commands/DeleteAppMonitorCommand.d.ts +2 -1
- package/dist-types/commands/DeleteRumMetricsDestinationCommand.d.ts +2 -1
- package/dist-types/commands/GetAppMonitorCommand.d.ts +2 -1
- package/dist-types/commands/GetAppMonitorDataCommand.d.ts +2 -1
- package/dist-types/commands/ListAppMonitorsCommand.d.ts +2 -1
- package/dist-types/commands/ListRumMetricsDestinationsCommand.d.ts +2 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/PutRumEventsCommand.d.ts +2 -1
- package/dist-types/commands/PutRumMetricsDestinationCommand.d.ts +2 -1
- package/dist-types/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateAppMonitorCommand.d.ts +2 -1
- package/dist-types/commands/UpdateRumMetricDefinitionCommand.d.ts +2 -1
- package/dist-types/models/models_0.d.ts +169 -169
- package/dist-types/ts3.4/RUM.d.ts +1 -0
- package/dist-types/ts3.4/commands/BatchCreateRumMetricDefinitionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/BatchDeleteRumMetricDefinitionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/BatchGetRumMetricDefinitionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateAppMonitorCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteAppMonitorCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteRumMetricsDestinationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetAppMonitorCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetAppMonitorDataCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListAppMonitorsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListRumMetricsDestinationsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutRumEventsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutRumMetricsDestinationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateAppMonitorCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateRumMetricDefinitionCommand.d.ts +9 -0
- package/package.json +40 -40
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType, LazyJsonString as __LazyJsonString } from "@smithy/smithy-client";
|
|
2
2
|
import { RUMServiceException as __BaseException } from "./RUMServiceException";
|
|
3
3
|
/**
|
|
4
|
-
* @public
|
|
5
4
|
* <p>You don't have sufficient permissions to perform this action.</p>
|
|
5
|
+
* @public
|
|
6
6
|
*/
|
|
7
7
|
export declare class AccessDeniedException extends __BaseException {
|
|
8
8
|
readonly name: "AccessDeniedException";
|
|
@@ -35,45 +35,44 @@ export declare const Telemetry: {
|
|
|
35
35
|
*/
|
|
36
36
|
export type Telemetry = (typeof Telemetry)[keyof typeof Telemetry];
|
|
37
37
|
/**
|
|
38
|
-
* @public
|
|
39
38
|
* <p>This structure contains much of the configuration data for the app monitor.</p>
|
|
39
|
+
* @public
|
|
40
40
|
*/
|
|
41
41
|
export interface AppMonitorConfiguration {
|
|
42
42
|
/**
|
|
43
|
-
* @public
|
|
44
43
|
* <p>The ID of the Amazon Cognito identity pool
|
|
45
44
|
* that is used to authorize the sending of data to RUM.</p>
|
|
45
|
+
* @public
|
|
46
46
|
*/
|
|
47
47
|
IdentityPoolId?: string;
|
|
48
48
|
/**
|
|
49
|
-
* @public
|
|
50
49
|
* <p>A list of URLs in your website or application to exclude from RUM data collection.</p>
|
|
51
50
|
* <p>You can't include both <code>ExcludedPages</code> and <code>IncludedPages</code> in the same operation.</p>
|
|
51
|
+
* @public
|
|
52
52
|
*/
|
|
53
53
|
ExcludedPages?: string[];
|
|
54
54
|
/**
|
|
55
|
-
* @public
|
|
56
55
|
* <p>If this app monitor is to collect data from only certain pages in your application, this structure lists those pages. </p>
|
|
57
56
|
* <p>You can't include both <code>ExcludedPages</code> and <code>IncludedPages</code> in the same operation.</p>
|
|
57
|
+
* @public
|
|
58
58
|
*/
|
|
59
59
|
IncludedPages?: string[];
|
|
60
60
|
/**
|
|
61
|
-
* @public
|
|
62
61
|
* <p>A list of pages in your application that are to be displayed with a "favorite" icon
|
|
63
62
|
* in the CloudWatch RUM console.</p>
|
|
63
|
+
* @public
|
|
64
64
|
*/
|
|
65
65
|
FavoritePages?: string[];
|
|
66
66
|
/**
|
|
67
|
-
* @public
|
|
68
67
|
* <p>Specifies the portion of user sessions to use for RUM data collection. Choosing a higher portion gives you
|
|
69
68
|
* more data but also incurs more costs.</p>
|
|
70
69
|
* <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
|
|
71
70
|
* it to 0.1 means that 10% of user sessions are sampled.</p>
|
|
72
71
|
* <p>If you omit this parameter, the default of 0.1 is used, and 10% of sessions will be sampled.</p>
|
|
72
|
+
* @public
|
|
73
73
|
*/
|
|
74
74
|
SessionSampleRate?: number;
|
|
75
75
|
/**
|
|
76
|
-
* @public
|
|
77
76
|
* <p>The ARN of the guest IAM role that is attached to the Amazon Cognito identity pool
|
|
78
77
|
* that is used to authorize the sending of data to RUM.</p>
|
|
79
78
|
* <note>
|
|
@@ -95,18 +94,18 @@ export interface AppMonitorConfiguration {
|
|
|
95
94
|
* </li>
|
|
96
95
|
* </ul>
|
|
97
96
|
* </note>
|
|
97
|
+
* @public
|
|
98
98
|
*/
|
|
99
99
|
GuestRoleArn?: string;
|
|
100
100
|
/**
|
|
101
|
-
* @public
|
|
102
101
|
* <p>If you set this to <code>true</code>, the RUM web client sets two cookies, a session
|
|
103
102
|
* cookie and a user cookie. The cookies allow the RUM web client to collect data relating to
|
|
104
103
|
* the number of users an application has and the behavior of the application across a
|
|
105
104
|
* sequence of events. Cookies are stored in the top-level domain of the current page.</p>
|
|
105
|
+
* @public
|
|
106
106
|
*/
|
|
107
107
|
AllowCookies?: boolean;
|
|
108
108
|
/**
|
|
109
|
-
* @public
|
|
110
109
|
* <p>An array that lists the types of telemetry data that this app monitor is to collect.</p>
|
|
111
110
|
* <ul>
|
|
112
111
|
* <li>
|
|
@@ -124,16 +123,17 @@ export interface AppMonitorConfiguration {
|
|
|
124
123
|
* <code>http</code> indicates that RUM collects data about HTTP errors thrown by your application.</p>
|
|
125
124
|
* </li>
|
|
126
125
|
* </ul>
|
|
126
|
+
* @public
|
|
127
127
|
*/
|
|
128
128
|
Telemetries?: Telemetry[];
|
|
129
129
|
/**
|
|
130
|
-
* @public
|
|
131
130
|
* <p>If you set this to <code>true</code>, RUM enables X-Ray tracing for
|
|
132
131
|
* the user sessions that RUM samples. RUM adds an X-Ray trace header to allowed
|
|
133
132
|
* HTTP requests. It also records an X-Ray segment for allowed HTTP requests.
|
|
134
133
|
* You can see traces and segments from these user sessions in the X-Ray console
|
|
135
134
|
* 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>
|
|
136
135
|
* </p>
|
|
136
|
+
* @public
|
|
137
137
|
*/
|
|
138
138
|
EnableXRay?: boolean;
|
|
139
139
|
}
|
|
@@ -150,45 +150,45 @@ export declare const CustomEventsStatus: {
|
|
|
150
150
|
*/
|
|
151
151
|
export type CustomEventsStatus = (typeof CustomEventsStatus)[keyof typeof CustomEventsStatus];
|
|
152
152
|
/**
|
|
153
|
-
* @public
|
|
154
153
|
* <p>A structure that contains information about custom events for this app monitor.</p>
|
|
154
|
+
* @public
|
|
155
155
|
*/
|
|
156
156
|
export interface CustomEvents {
|
|
157
157
|
/**
|
|
158
|
-
* @public
|
|
159
158
|
* <p>Specifies whether this app monitor allows the web client to define and send
|
|
160
159
|
* custom events. The default is for custom events to be <code>DISABLED</code>.</p>
|
|
160
|
+
* @public
|
|
161
161
|
*/
|
|
162
162
|
Status?: CustomEventsStatus;
|
|
163
163
|
}
|
|
164
164
|
/**
|
|
165
|
-
* @public
|
|
166
165
|
* <p>A structure that contains the information about whether the app monitor stores copies of the data
|
|
167
166
|
* that RUM collects in CloudWatch Logs. If it does, this structure also contains the name of the log group.</p>
|
|
167
|
+
* @public
|
|
168
168
|
*/
|
|
169
169
|
export interface CwLog {
|
|
170
170
|
/**
|
|
171
|
-
* @public
|
|
172
171
|
* <p>Indicated whether the app monitor stores copies of the data
|
|
173
172
|
* that RUM collects in CloudWatch Logs.</p>
|
|
173
|
+
* @public
|
|
174
174
|
*/
|
|
175
175
|
CwLogEnabled?: boolean;
|
|
176
176
|
/**
|
|
177
|
-
* @public
|
|
178
177
|
* <p>The name of the log group where the copies are stored.</p>
|
|
178
|
+
* @public
|
|
179
179
|
*/
|
|
180
180
|
CwLogGroup?: string;
|
|
181
181
|
}
|
|
182
182
|
/**
|
|
183
|
-
* @public
|
|
184
183
|
* <p>A structure that contains information about whether this app monitor stores a copy of
|
|
185
184
|
* the telemetry data that RUM collects using CloudWatch Logs.</p>
|
|
185
|
+
* @public
|
|
186
186
|
*/
|
|
187
187
|
export interface DataStorage {
|
|
188
188
|
/**
|
|
189
|
-
* @public
|
|
190
189
|
* <p>A structure that contains the information about whether the app monitor stores copies of the data
|
|
191
190
|
* that RUM collects in CloudWatch Logs. If it does, this structure also contains the name of the log group.</p>
|
|
191
|
+
* @public
|
|
192
192
|
*/
|
|
193
193
|
CwLog?: CwLog;
|
|
194
194
|
}
|
|
@@ -206,85 +206,85 @@ export declare const StateEnum: {
|
|
|
206
206
|
*/
|
|
207
207
|
export type StateEnum = (typeof StateEnum)[keyof typeof StateEnum];
|
|
208
208
|
/**
|
|
209
|
-
* @public
|
|
210
209
|
* <p>A RUM app monitor collects telemetry data from your application and sends that
|
|
211
210
|
* data to RUM. The data includes performance and reliability information such as page load time, client-side errors,
|
|
212
211
|
* and user behavior.</p>
|
|
212
|
+
* @public
|
|
213
213
|
*/
|
|
214
214
|
export interface AppMonitor {
|
|
215
215
|
/**
|
|
216
|
-
* @public
|
|
217
216
|
* <p>The name of the app monitor.</p>
|
|
217
|
+
* @public
|
|
218
218
|
*/
|
|
219
219
|
Name?: string;
|
|
220
220
|
/**
|
|
221
|
-
* @public
|
|
222
221
|
* <p>The top-level internet domain name for which your application has administrative authority.</p>
|
|
222
|
+
* @public
|
|
223
223
|
*/
|
|
224
224
|
Domain?: string;
|
|
225
225
|
/**
|
|
226
|
-
* @public
|
|
227
226
|
* <p>The unique ID of this app monitor.</p>
|
|
227
|
+
* @public
|
|
228
228
|
*/
|
|
229
229
|
Id?: string;
|
|
230
230
|
/**
|
|
231
|
-
* @public
|
|
232
231
|
* <p>The date and time that this app monitor was created.</p>
|
|
232
|
+
* @public
|
|
233
233
|
*/
|
|
234
234
|
Created?: string;
|
|
235
235
|
/**
|
|
236
|
-
* @public
|
|
237
236
|
* <p>The date and time of the most recent changes to this app monitor's configuration.</p>
|
|
237
|
+
* @public
|
|
238
238
|
*/
|
|
239
239
|
LastModified?: string;
|
|
240
240
|
/**
|
|
241
|
-
* @public
|
|
242
241
|
* <p>The list of tag keys and values associated with this app monitor.</p>
|
|
242
|
+
* @public
|
|
243
243
|
*/
|
|
244
244
|
Tags?: Record<string, string>;
|
|
245
245
|
/**
|
|
246
|
-
* @public
|
|
247
246
|
* <p>The current state of the app monitor.</p>
|
|
247
|
+
* @public
|
|
248
248
|
*/
|
|
249
249
|
State?: StateEnum;
|
|
250
250
|
/**
|
|
251
|
-
* @public
|
|
252
251
|
* <p>A structure that contains much of the configuration data for the app monitor.</p>
|
|
252
|
+
* @public
|
|
253
253
|
*/
|
|
254
254
|
AppMonitorConfiguration?: AppMonitorConfiguration;
|
|
255
255
|
/**
|
|
256
|
-
* @public
|
|
257
256
|
* <p>A structure that contains information about whether this app monitor stores a copy of
|
|
258
257
|
* the telemetry data that RUM collects using CloudWatch Logs.</p>
|
|
258
|
+
* @public
|
|
259
259
|
*/
|
|
260
260
|
DataStorage?: DataStorage;
|
|
261
261
|
/**
|
|
262
|
-
* @public
|
|
263
262
|
* <p>Specifies whether this app monitor allows the web client to define and send
|
|
264
263
|
* custom events.</p>
|
|
265
264
|
* <p>For more information about custom events, see
|
|
266
265
|
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-custom-events.html">Send custom events</a>.</p>
|
|
266
|
+
* @public
|
|
267
267
|
*/
|
|
268
268
|
CustomEvents?: CustomEvents;
|
|
269
269
|
}
|
|
270
270
|
/**
|
|
271
|
-
* @public
|
|
272
271
|
* <p>A structure that contains information about the RUM app monitor.</p>
|
|
272
|
+
* @public
|
|
273
273
|
*/
|
|
274
274
|
export interface AppMonitorDetails {
|
|
275
275
|
/**
|
|
276
|
-
* @public
|
|
277
276
|
* <p>The name of the app monitor.</p>
|
|
277
|
+
* @public
|
|
278
278
|
*/
|
|
279
279
|
name?: string;
|
|
280
280
|
/**
|
|
281
|
-
* @public
|
|
282
281
|
* <p>The unique ID of the app monitor.</p>
|
|
282
|
+
* @public
|
|
283
283
|
*/
|
|
284
284
|
id?: string;
|
|
285
285
|
/**
|
|
286
|
-
* @public
|
|
287
286
|
* <p>The version of the app monitor.</p>
|
|
287
|
+
* @public
|
|
288
288
|
*/
|
|
289
289
|
version?: string;
|
|
290
290
|
}
|
|
@@ -301,7 +301,6 @@ export declare const MetricDestination: {
|
|
|
301
301
|
*/
|
|
302
302
|
export type MetricDestination = (typeof MetricDestination)[keyof typeof MetricDestination];
|
|
303
303
|
/**
|
|
304
|
-
* @public
|
|
305
304
|
* <p>Use this structure to define one extended metric or custom metric that RUM will send
|
|
306
305
|
* to CloudWatch or CloudWatch Evidently. For more information, see
|
|
307
306
|
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-custom-and-extended-metrics.html">
|
|
@@ -543,10 +542,10 @@ export type MetricDestination = (typeof MetricDestination)[keyof typeof MetricDe
|
|
|
543
542
|
* </p>
|
|
544
543
|
* </li>
|
|
545
544
|
* </ul>
|
|
545
|
+
* @public
|
|
546
546
|
*/
|
|
547
547
|
export interface MetricDefinitionRequest {
|
|
548
548
|
/**
|
|
549
|
-
* @public
|
|
550
549
|
* <p>The name for the metric that is defined in this structure. For custom metrics, you can specify
|
|
551
550
|
* any name that you like. For extended metrics, valid values are the following:</p>
|
|
552
551
|
* <ul>
|
|
@@ -607,25 +606,25 @@ export interface MetricDefinitionRequest {
|
|
|
607
606
|
* </p>
|
|
608
607
|
* </li>
|
|
609
608
|
* </ul>
|
|
609
|
+
* @public
|
|
610
610
|
*/
|
|
611
611
|
Name: string | undefined;
|
|
612
612
|
/**
|
|
613
|
-
* @public
|
|
614
613
|
* <p>The field within the event object that the metric value is sourced from.</p>
|
|
615
614
|
* <p>If you omit this field, a hardcoded value of 1 is pushed as the metric value. This is
|
|
616
615
|
* useful if you want to count the number of events that the filter catches. </p>
|
|
617
616
|
* <p>If this metric is sent to CloudWatch Evidently, this field will be passed to
|
|
618
617
|
* Evidently raw. Evidently will handle data extraction from the event.</p>
|
|
618
|
+
* @public
|
|
619
619
|
*/
|
|
620
620
|
ValueKey?: string;
|
|
621
621
|
/**
|
|
622
|
-
* @public
|
|
623
622
|
* <p>The CloudWatch metric unit to use for this metric. If you omit this field, the metric
|
|
624
623
|
* is recorded with no unit.</p>
|
|
624
|
+
* @public
|
|
625
625
|
*/
|
|
626
626
|
UnitLabel?: string;
|
|
627
627
|
/**
|
|
628
|
-
* @public
|
|
629
628
|
* <p>Use this field only if you are sending the metric to CloudWatch.</p>
|
|
630
629
|
* <p>This field is a map of field paths to dimension names. It defines the dimensions to associate with this
|
|
631
630
|
* metric in CloudWatch. For extended metrics, valid values for the entries in this field are the following:</p>
|
|
@@ -664,10 +663,10 @@ export interface MetricDefinitionRequest {
|
|
|
664
663
|
* <p> For both extended metrics and custom metrics,
|
|
665
664
|
* all dimensions listed in this field
|
|
666
665
|
* must also be included in <code>EventPattern</code>.</p>
|
|
666
|
+
* @public
|
|
667
667
|
*/
|
|
668
668
|
DimensionKeys?: Record<string, string>;
|
|
669
669
|
/**
|
|
670
|
-
* @public
|
|
671
670
|
* <p>The pattern that defines the metric, specified as a JSON object. RUM checks events that happen in a user's session
|
|
672
671
|
* against the pattern, and events that match the pattern are sent to the metric destination.</p>
|
|
673
672
|
* <p>When you define extended metrics, the metric definition is not valid if <code>EventPattern</code>
|
|
@@ -716,13 +715,14 @@ export interface MetricDefinitionRequest {
|
|
|
716
715
|
* </ul>
|
|
717
716
|
* <p>If the metrics destination is <code>CloudWatch</code> and the event also matches a value
|
|
718
717
|
* in <code>DimensionKeys</code>, then the metric is published with the specified dimensions. </p>
|
|
718
|
+
* @public
|
|
719
719
|
*/
|
|
720
720
|
EventPattern?: string;
|
|
721
721
|
/**
|
|
722
|
-
* @public
|
|
723
722
|
* <p>If this structure is for a custom metric instead of an extended metrics, use this parameter to define the
|
|
724
723
|
* metric namespace for that custom metric. Do not specify this parameter if this structure is for an extended metric.</p>
|
|
725
724
|
* <p>You cannot use any string that starts with <code>AWS/</code> for your namespace.</p>
|
|
725
|
+
* @public
|
|
726
726
|
*/
|
|
727
727
|
Namespace?: string;
|
|
728
728
|
}
|
|
@@ -731,105 +731,105 @@ export interface MetricDefinitionRequest {
|
|
|
731
731
|
*/
|
|
732
732
|
export interface BatchCreateRumMetricDefinitionsRequest {
|
|
733
733
|
/**
|
|
734
|
-
* @public
|
|
735
734
|
* <p>The name of the CloudWatch RUM app monitor that is to send the metrics.</p>
|
|
735
|
+
* @public
|
|
736
736
|
*/
|
|
737
737
|
AppMonitorName: string | undefined;
|
|
738
738
|
/**
|
|
739
|
-
* @public
|
|
740
739
|
* <p>The destination to send the metrics to. Valid values are <code>CloudWatch</code> and
|
|
741
740
|
* <code>Evidently</code>. If you specify <code>Evidently</code>, you must also specify the
|
|
742
741
|
* Amazon Resource Name (ARN) of the CloudWatchEvidently experiment that will receive
|
|
743
742
|
* the metrics and an IAM role that has permission to write to the
|
|
744
743
|
* experiment.</p>
|
|
744
|
+
* @public
|
|
745
745
|
*/
|
|
746
746
|
Destination: MetricDestination | undefined;
|
|
747
747
|
/**
|
|
748
|
-
* @public
|
|
749
748
|
* <p>This parameter is required if <code>Destination</code> is <code>Evidently</code>. If <code>Destination</code> is
|
|
750
749
|
* <code>CloudWatch</code>, do not use this parameter.</p>
|
|
751
750
|
* <p>This parameter specifies the ARN of the Evidently experiment that is to receive the metrics. You must have already defined this
|
|
752
751
|
* 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>
|
|
752
|
+
* @public
|
|
753
753
|
*/
|
|
754
754
|
DestinationArn?: string;
|
|
755
755
|
/**
|
|
756
|
-
* @public
|
|
757
756
|
* <p>An array of structures which define the metrics that you want to send.</p>
|
|
757
|
+
* @public
|
|
758
758
|
*/
|
|
759
759
|
MetricDefinitions: MetricDefinitionRequest[] | undefined;
|
|
760
760
|
}
|
|
761
761
|
/**
|
|
762
|
-
* @public
|
|
763
762
|
* <p>A structure that defines one error caused by a
|
|
764
763
|
* <a href="https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_BatchCreateRumMetricsDefinitions.html">BatchCreateRumMetricsDefinitions</a>
|
|
765
764
|
* operation.</p>
|
|
765
|
+
* @public
|
|
766
766
|
*/
|
|
767
767
|
export interface BatchCreateRumMetricDefinitionsError {
|
|
768
768
|
/**
|
|
769
|
-
* @public
|
|
770
769
|
* <p>The metric definition that caused this error.</p>
|
|
770
|
+
* @public
|
|
771
771
|
*/
|
|
772
772
|
MetricDefinition: MetricDefinitionRequest | undefined;
|
|
773
773
|
/**
|
|
774
|
-
* @public
|
|
775
774
|
* <p>The error code.</p>
|
|
775
|
+
* @public
|
|
776
776
|
*/
|
|
777
777
|
ErrorCode: string | undefined;
|
|
778
778
|
/**
|
|
779
|
-
* @public
|
|
780
779
|
* <p>The error message for this metric definition.</p>
|
|
780
|
+
* @public
|
|
781
781
|
*/
|
|
782
782
|
ErrorMessage: string | undefined;
|
|
783
783
|
}
|
|
784
784
|
/**
|
|
785
|
-
* @public
|
|
786
785
|
* <p>A structure that displays the definition of one extended metric that RUM sends
|
|
787
786
|
* to CloudWatch or CloudWatch Evidently. For more information, see
|
|
788
787
|
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-vended-metrics.html">
|
|
789
788
|
* Additional metrics that you can send to CloudWatch and CloudWatch Evidently</a>.</p>
|
|
789
|
+
* @public
|
|
790
790
|
*/
|
|
791
791
|
export interface MetricDefinition {
|
|
792
792
|
/**
|
|
793
|
-
* @public
|
|
794
793
|
* <p>The ID of this metric definition.</p>
|
|
794
|
+
* @public
|
|
795
795
|
*/
|
|
796
796
|
MetricDefinitionId: string | undefined;
|
|
797
797
|
/**
|
|
798
|
-
* @public
|
|
799
798
|
* <p>The name of the metric that is defined in this structure.</p>
|
|
799
|
+
* @public
|
|
800
800
|
*/
|
|
801
801
|
Name: string | undefined;
|
|
802
802
|
/**
|
|
803
|
-
* @public
|
|
804
803
|
* <p>The field within the event object that the metric value is sourced from.</p>
|
|
804
|
+
* @public
|
|
805
805
|
*/
|
|
806
806
|
ValueKey?: string;
|
|
807
807
|
/**
|
|
808
|
-
* @public
|
|
809
808
|
* <p>Use this field only if you are sending this metric to CloudWatch. It defines
|
|
810
809
|
* the CloudWatch metric unit that this metric is measured in. </p>
|
|
810
|
+
* @public
|
|
811
811
|
*/
|
|
812
812
|
UnitLabel?: string;
|
|
813
813
|
/**
|
|
814
|
-
* @public
|
|
815
814
|
* <p>This field is a map of field paths to dimension names. It defines the dimensions to associate with this
|
|
816
815
|
* metric in CloudWatch The value of this field is used only if the metric destination is <code>CloudWatch</code>.
|
|
817
816
|
* If the metric destination is <code>Evidently</code>, the value of <code>DimensionKeys</code> is ignored.</p>
|
|
817
|
+
* @public
|
|
818
818
|
*/
|
|
819
819
|
DimensionKeys?: Record<string, string>;
|
|
820
820
|
/**
|
|
821
|
-
* @public
|
|
822
821
|
* <p>The pattern that defines the metric. RUM checks events that happen in a user's session
|
|
823
822
|
* against the pattern, and events that match the pattern are sent to the metric destination.</p>
|
|
824
823
|
* <p>If the metrics destination
|
|
825
824
|
* is <code>CloudWatch</code> and the event
|
|
826
825
|
* also matches a value in <code>DimensionKeys</code>, then the metric is published with the specified dimensions. </p>
|
|
826
|
+
* @public
|
|
827
827
|
*/
|
|
828
828
|
EventPattern?: string;
|
|
829
829
|
/**
|
|
830
|
-
* @public
|
|
831
830
|
* <p>If this metric definition is for a custom metric instead of an extended metric, this field displays
|
|
832
831
|
* the metric namespace that the custom metric is published to.</p>
|
|
832
|
+
* @public
|
|
833
833
|
*/
|
|
834
834
|
Namespace?: string;
|
|
835
835
|
}
|
|
@@ -838,31 +838,31 @@ export interface MetricDefinition {
|
|
|
838
838
|
*/
|
|
839
839
|
export interface BatchCreateRumMetricDefinitionsResponse {
|
|
840
840
|
/**
|
|
841
|
-
* @public
|
|
842
841
|
* <p>An array of error objects, if the operation caused any errors.</p>
|
|
842
|
+
* @public
|
|
843
843
|
*/
|
|
844
844
|
Errors: BatchCreateRumMetricDefinitionsError[] | undefined;
|
|
845
845
|
/**
|
|
846
|
-
* @public
|
|
847
846
|
* <p>An array of structures that define the extended metrics.</p>
|
|
847
|
+
* @public
|
|
848
848
|
*/
|
|
849
849
|
MetricDefinitions?: MetricDefinition[];
|
|
850
850
|
}
|
|
851
851
|
/**
|
|
852
|
-
* @public
|
|
853
852
|
* <p>This operation attempted to create a resource that already exists.</p>
|
|
853
|
+
* @public
|
|
854
854
|
*/
|
|
855
855
|
export declare class ConflictException extends __BaseException {
|
|
856
856
|
readonly name: "ConflictException";
|
|
857
857
|
readonly $fault: "client";
|
|
858
858
|
/**
|
|
859
|
-
* @public
|
|
860
859
|
* <p>The name of the resource that is associated with the error.</p>
|
|
860
|
+
* @public
|
|
861
861
|
*/
|
|
862
862
|
resourceName: string | undefined;
|
|
863
863
|
/**
|
|
864
|
-
* @public
|
|
865
864
|
* <p>The type of the resource that is associated with the error.</p>
|
|
865
|
+
* @public
|
|
866
866
|
*/
|
|
867
867
|
resourceType?: string;
|
|
868
868
|
/**
|
|
@@ -871,16 +871,16 @@ export declare class ConflictException extends __BaseException {
|
|
|
871
871
|
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
872
872
|
}
|
|
873
873
|
/**
|
|
874
|
-
* @public
|
|
875
874
|
* <p>Internal service exception.</p>
|
|
875
|
+
* @public
|
|
876
876
|
*/
|
|
877
877
|
export declare class InternalServerException extends __BaseException {
|
|
878
878
|
readonly name: "InternalServerException";
|
|
879
879
|
readonly $fault: "server";
|
|
880
880
|
$retryable: {};
|
|
881
881
|
/**
|
|
882
|
-
* @public
|
|
883
882
|
* <p>The value of a parameter in the request caused an error.</p>
|
|
883
|
+
* @public
|
|
884
884
|
*/
|
|
885
885
|
retryAfterSeconds?: number;
|
|
886
886
|
/**
|
|
@@ -889,20 +889,20 @@ export declare class InternalServerException extends __BaseException {
|
|
|
889
889
|
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
890
890
|
}
|
|
891
891
|
/**
|
|
892
|
-
* @public
|
|
893
892
|
* <p>Resource not found.</p>
|
|
893
|
+
* @public
|
|
894
894
|
*/
|
|
895
895
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
896
896
|
readonly name: "ResourceNotFoundException";
|
|
897
897
|
readonly $fault: "client";
|
|
898
898
|
/**
|
|
899
|
-
* @public
|
|
900
899
|
* <p>The name of the resource that is associated with the error.</p>
|
|
900
|
+
* @public
|
|
901
901
|
*/
|
|
902
902
|
resourceName: string | undefined;
|
|
903
903
|
/**
|
|
904
|
-
* @public
|
|
905
904
|
* <p>The type of the resource that is associated with the error.</p>
|
|
905
|
+
* @public
|
|
906
906
|
*/
|
|
907
907
|
resourceType?: string;
|
|
908
908
|
/**
|
|
@@ -911,8 +911,8 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
911
911
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
912
912
|
}
|
|
913
913
|
/**
|
|
914
|
-
* @public
|
|
915
914
|
* <p>This request exceeds a service quota.</p>
|
|
915
|
+
* @public
|
|
916
916
|
*/
|
|
917
917
|
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
918
918
|
readonly name: "ServiceQuotaExceededException";
|
|
@@ -923,8 +923,8 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
923
923
|
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
924
924
|
}
|
|
925
925
|
/**
|
|
926
|
-
* @public
|
|
927
926
|
* <p>The request was throttled because of quota limits.</p>
|
|
927
|
+
* @public
|
|
928
928
|
*/
|
|
929
929
|
export declare class ThrottlingException extends __BaseException {
|
|
930
930
|
readonly name: "ThrottlingException";
|
|
@@ -933,18 +933,18 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
933
933
|
throttling: boolean;
|
|
934
934
|
};
|
|
935
935
|
/**
|
|
936
|
-
* @public
|
|
937
936
|
* <p>The ID of the service that is associated with the error.</p>
|
|
937
|
+
* @public
|
|
938
938
|
*/
|
|
939
939
|
serviceCode?: string;
|
|
940
940
|
/**
|
|
941
|
-
* @public
|
|
942
941
|
* <p>The ID of the service quota that was exceeded.</p>
|
|
942
|
+
* @public
|
|
943
943
|
*/
|
|
944
944
|
quotaCode?: string;
|
|
945
945
|
/**
|
|
946
|
-
* @public
|
|
947
946
|
* <p>The value of a parameter in the request caused an error.</p>
|
|
947
|
+
* @public
|
|
948
948
|
*/
|
|
949
949
|
retryAfterSeconds?: number;
|
|
950
950
|
/**
|
|
@@ -953,8 +953,8 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
953
953
|
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
954
954
|
}
|
|
955
955
|
/**
|
|
956
|
-
* @public
|
|
957
956
|
* <p>One of the arguments for the request is not valid.</p>
|
|
957
|
+
* @public
|
|
958
958
|
*/
|
|
959
959
|
export declare class ValidationException extends __BaseException {
|
|
960
960
|
readonly name: "ValidationException";
|
|
@@ -969,52 +969,52 @@ export declare class ValidationException extends __BaseException {
|
|
|
969
969
|
*/
|
|
970
970
|
export interface BatchDeleteRumMetricDefinitionsRequest {
|
|
971
971
|
/**
|
|
972
|
-
* @public
|
|
973
972
|
* <p>The name of the CloudWatch RUM app monitor that is sending these metrics.</p>
|
|
973
|
+
* @public
|
|
974
974
|
*/
|
|
975
975
|
AppMonitorName: string | undefined;
|
|
976
976
|
/**
|
|
977
|
-
* @public
|
|
978
977
|
* <p>Defines the destination where you want to stop sending the specified metrics. Valid values are <code>CloudWatch</code> and
|
|
979
978
|
* <code>Evidently</code>. If
|
|
980
979
|
* you specify <code>Evidently</code>, you must also specify the ARN of the CloudWatchEvidently experiment that is to
|
|
981
980
|
* be the destination and an IAM role that has permission to write to the experiment.</p>
|
|
981
|
+
* @public
|
|
982
982
|
*/
|
|
983
983
|
Destination: MetricDestination | undefined;
|
|
984
984
|
/**
|
|
985
|
-
* @public
|
|
986
985
|
* <p>This parameter is required if <code>Destination</code> is <code>Evidently</code>. If <code>Destination</code> is
|
|
987
986
|
* <code>CloudWatch</code>, do not use this parameter. </p>
|
|
988
987
|
* <p>This parameter specifies
|
|
989
988
|
* the ARN of the Evidently experiment that was receiving the metrics that are being deleted.</p>
|
|
989
|
+
* @public
|
|
990
990
|
*/
|
|
991
991
|
DestinationArn?: string;
|
|
992
992
|
/**
|
|
993
|
-
* @public
|
|
994
993
|
* <p>An array of structures which define the metrics that you want to stop sending.</p>
|
|
994
|
+
* @public
|
|
995
995
|
*/
|
|
996
996
|
MetricDefinitionIds: string[] | undefined;
|
|
997
997
|
}
|
|
998
998
|
/**
|
|
999
|
-
* @public
|
|
1000
999
|
* <p>A structure that defines one error caused by a
|
|
1001
1000
|
* <a href="https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_BatchDeleteRumMetricsDefinitions.html">BatchCreateRumMetricsDefinitions</a>
|
|
1002
1001
|
* operation.</p>
|
|
1002
|
+
* @public
|
|
1003
1003
|
*/
|
|
1004
1004
|
export interface BatchDeleteRumMetricDefinitionsError {
|
|
1005
1005
|
/**
|
|
1006
|
-
* @public
|
|
1007
1006
|
* <p>The ID of the metric definition that caused this error.</p>
|
|
1007
|
+
* @public
|
|
1008
1008
|
*/
|
|
1009
1009
|
MetricDefinitionId: string | undefined;
|
|
1010
1010
|
/**
|
|
1011
|
-
* @public
|
|
1012
1011
|
* <p>The error code.</p>
|
|
1012
|
+
* @public
|
|
1013
1013
|
*/
|
|
1014
1014
|
ErrorCode: string | undefined;
|
|
1015
1015
|
/**
|
|
1016
|
-
* @public
|
|
1017
1016
|
* <p>The error message for this metric definition.</p>
|
|
1017
|
+
* @public
|
|
1018
1018
|
*/
|
|
1019
1019
|
ErrorMessage: string | undefined;
|
|
1020
1020
|
}
|
|
@@ -1023,13 +1023,13 @@ export interface BatchDeleteRumMetricDefinitionsError {
|
|
|
1023
1023
|
*/
|
|
1024
1024
|
export interface BatchDeleteRumMetricDefinitionsResponse {
|
|
1025
1025
|
/**
|
|
1026
|
-
* @public
|
|
1027
1026
|
* <p>An array of error objects, if the operation caused any errors.</p>
|
|
1027
|
+
* @public
|
|
1028
1028
|
*/
|
|
1029
1029
|
Errors: BatchDeleteRumMetricDefinitionsError[] | undefined;
|
|
1030
1030
|
/**
|
|
1031
|
-
* @public
|
|
1032
1031
|
* <p>The IDs of the metric definitions that were deleted.</p>
|
|
1032
|
+
* @public
|
|
1033
1033
|
*/
|
|
1034
1034
|
MetricDefinitionIds?: string[];
|
|
1035
1035
|
}
|
|
@@ -1038,35 +1038,35 @@ export interface BatchDeleteRumMetricDefinitionsResponse {
|
|
|
1038
1038
|
*/
|
|
1039
1039
|
export interface BatchGetRumMetricDefinitionsRequest {
|
|
1040
1040
|
/**
|
|
1041
|
-
* @public
|
|
1042
1041
|
* <p>The name of the CloudWatch RUM app monitor that is sending the metrics.</p>
|
|
1042
|
+
* @public
|
|
1043
1043
|
*/
|
|
1044
1044
|
AppMonitorName: string | undefined;
|
|
1045
1045
|
/**
|
|
1046
|
-
* @public
|
|
1047
1046
|
* <p>The type of destination that you want to view metrics for. Valid values are <code>CloudWatch</code>
|
|
1048
1047
|
* and <code>Evidently</code>.</p>
|
|
1048
|
+
* @public
|
|
1049
1049
|
*/
|
|
1050
1050
|
Destination: MetricDestination | undefined;
|
|
1051
1051
|
/**
|
|
1052
|
-
* @public
|
|
1053
1052
|
* <p>This parameter is required if <code>Destination</code> is <code>Evidently</code>. If <code>Destination</code> is
|
|
1054
1053
|
* <code>CloudWatch</code>, do not use this parameter.</p>
|
|
1055
1054
|
* <p>This parameter
|
|
1056
1055
|
* specifies the ARN of the Evidently experiment that corresponds to the destination.</p>
|
|
1056
|
+
* @public
|
|
1057
1057
|
*/
|
|
1058
1058
|
DestinationArn?: string;
|
|
1059
1059
|
/**
|
|
1060
|
-
* @public
|
|
1061
1060
|
* <p>The maximum number of results to return in one operation. The default is 50. The maximum that you can
|
|
1062
1061
|
* specify is 100.</p>
|
|
1063
1062
|
* <p>To retrieve the remaining results, make another call with the returned
|
|
1064
1063
|
* <code>NextToken</code> value. </p>
|
|
1064
|
+
* @public
|
|
1065
1065
|
*/
|
|
1066
1066
|
MaxResults?: number;
|
|
1067
1067
|
/**
|
|
1068
|
-
* @public
|
|
1069
1068
|
* <p>Use the token returned by the previous operation to request the next page of results.</p>
|
|
1069
|
+
* @public
|
|
1070
1070
|
*/
|
|
1071
1071
|
NextToken?: string;
|
|
1072
1072
|
}
|
|
@@ -1075,15 +1075,15 @@ export interface BatchGetRumMetricDefinitionsRequest {
|
|
|
1075
1075
|
*/
|
|
1076
1076
|
export interface BatchGetRumMetricDefinitionsResponse {
|
|
1077
1077
|
/**
|
|
1078
|
-
* @public
|
|
1079
1078
|
* <p>An array of structures that display information about the metrics that are sent by the specified
|
|
1080
1079
|
* app monitor to the specified destination.</p>
|
|
1080
|
+
* @public
|
|
1081
1081
|
*/
|
|
1082
1082
|
MetricDefinitions?: MetricDefinition[];
|
|
1083
1083
|
/**
|
|
1084
|
-
* @public
|
|
1085
1084
|
* <p>A token that you can use in a subsequent operation to
|
|
1086
1085
|
* retrieve the next set of results.</p>
|
|
1086
|
+
* @public
|
|
1087
1087
|
*/
|
|
1088
1088
|
NextToken?: string;
|
|
1089
1089
|
}
|
|
@@ -1092,17 +1092,16 @@ export interface BatchGetRumMetricDefinitionsResponse {
|
|
|
1092
1092
|
*/
|
|
1093
1093
|
export interface CreateAppMonitorRequest {
|
|
1094
1094
|
/**
|
|
1095
|
-
* @public
|
|
1096
1095
|
* <p>A name for the app monitor.</p>
|
|
1096
|
+
* @public
|
|
1097
1097
|
*/
|
|
1098
1098
|
Name: string | undefined;
|
|
1099
1099
|
/**
|
|
1100
|
-
* @public
|
|
1101
1100
|
* <p>The top-level internet domain name for which your application has administrative authority.</p>
|
|
1101
|
+
* @public
|
|
1102
1102
|
*/
|
|
1103
1103
|
Domain: string | undefined;
|
|
1104
1104
|
/**
|
|
1105
|
-
* @public
|
|
1106
1105
|
* <p>Assigns one or more tags (key-value pairs) to the app monitor.</p>
|
|
1107
1106
|
* <p>Tags can help you organize and categorize your resources. You can also use them to scope user
|
|
1108
1107
|
* permissions by granting a user
|
|
@@ -1110,10 +1109,10 @@ export interface CreateAppMonitorRequest {
|
|
|
1110
1109
|
* <p>Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.</p>
|
|
1111
1110
|
* <p>You can associate as many as 50 tags with an app monitor.</p>
|
|
1112
1111
|
* <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>
|
|
1112
|
+
* @public
|
|
1113
1113
|
*/
|
|
1114
1114
|
Tags?: Record<string, string>;
|
|
1115
1115
|
/**
|
|
1116
|
-
* @public
|
|
1117
1116
|
* <p>A structure that contains much of the configuration data for the app monitor. If you are using
|
|
1118
1117
|
* Amazon Cognito for authorization, you must include this structure in your request, and it must include the ID of the
|
|
1119
1118
|
* Amazon Cognito identity pool to use for authorization. If you don't include <code>AppMonitorConfiguration</code>, you must set up your own
|
|
@@ -1121,23 +1120,24 @@ export interface CreateAppMonitorRequest {
|
|
|
1121
1120
|
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-get-started-authorization.html">Authorize your application
|
|
1122
1121
|
* to send data to Amazon Web Services</a>.</p>
|
|
1123
1122
|
* <p>If you omit this argument, the sample rate used for RUM is set to 10% of the user sessions.</p>
|
|
1123
|
+
* @public
|
|
1124
1124
|
*/
|
|
1125
1125
|
AppMonitorConfiguration?: AppMonitorConfiguration;
|
|
1126
1126
|
/**
|
|
1127
|
-
* @public
|
|
1128
1127
|
* <p>Data collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM
|
|
1129
1128
|
* sends a copy of this telemetry data to Amazon CloudWatch Logs
|
|
1130
1129
|
* in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur
|
|
1131
1130
|
* Amazon CloudWatch Logs charges.</p>
|
|
1132
1131
|
* <p>If you omit this parameter, the default is <code>false</code>.</p>
|
|
1132
|
+
* @public
|
|
1133
1133
|
*/
|
|
1134
1134
|
CwLogEnabled?: boolean;
|
|
1135
1135
|
/**
|
|
1136
|
-
* @public
|
|
1137
1136
|
* <p>Specifies whether this app monitor allows the web client to define and send
|
|
1138
1137
|
* custom events. If you omit this parameter, custom events are <code>DISABLED</code>.</p>
|
|
1139
1138
|
* <p>For more information about custom events, see
|
|
1140
1139
|
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-custom-events.html">Send custom events</a>.</p>
|
|
1140
|
+
* @public
|
|
1141
1141
|
*/
|
|
1142
1142
|
CustomEvents?: CustomEvents;
|
|
1143
1143
|
}
|
|
@@ -1146,8 +1146,8 @@ export interface CreateAppMonitorRequest {
|
|
|
1146
1146
|
*/
|
|
1147
1147
|
export interface CreateAppMonitorResponse {
|
|
1148
1148
|
/**
|
|
1149
|
-
* @public
|
|
1150
1149
|
* <p>The unique ID of the new app monitor.</p>
|
|
1150
|
+
* @public
|
|
1151
1151
|
*/
|
|
1152
1152
|
Id?: string;
|
|
1153
1153
|
}
|
|
@@ -1156,8 +1156,8 @@ export interface CreateAppMonitorResponse {
|
|
|
1156
1156
|
*/
|
|
1157
1157
|
export interface DeleteAppMonitorRequest {
|
|
1158
1158
|
/**
|
|
1159
|
-
* @public
|
|
1160
1159
|
* <p>The name of the app monitor to delete.</p>
|
|
1160
|
+
* @public
|
|
1161
1161
|
*/
|
|
1162
1162
|
Name: string | undefined;
|
|
1163
1163
|
}
|
|
@@ -1171,20 +1171,20 @@ export interface DeleteAppMonitorResponse {
|
|
|
1171
1171
|
*/
|
|
1172
1172
|
export interface DeleteRumMetricsDestinationRequest {
|
|
1173
1173
|
/**
|
|
1174
|
-
* @public
|
|
1175
1174
|
* <p>The name of the app monitor that is sending metrics to the destination that you want to delete.</p>
|
|
1175
|
+
* @public
|
|
1176
1176
|
*/
|
|
1177
1177
|
AppMonitorName: string | undefined;
|
|
1178
1178
|
/**
|
|
1179
|
-
* @public
|
|
1180
1179
|
* <p>The type of destination to delete. Valid values are <code>CloudWatch</code> and <code>Evidently</code>.</p>
|
|
1180
|
+
* @public
|
|
1181
1181
|
*/
|
|
1182
1182
|
Destination: MetricDestination | undefined;
|
|
1183
1183
|
/**
|
|
1184
|
-
* @public
|
|
1185
1184
|
* <p>This parameter is required if <code>Destination</code> is <code>Evidently</code>. If <code>Destination</code> is
|
|
1186
1185
|
* <code>CloudWatch</code>, do not use this parameter. This parameter
|
|
1187
1186
|
* specifies the ARN of the Evidently experiment that corresponds to the destination to delete.</p>
|
|
1187
|
+
* @public
|
|
1188
1188
|
*/
|
|
1189
1189
|
DestinationArn?: string;
|
|
1190
1190
|
}
|
|
@@ -1198,8 +1198,8 @@ export interface DeleteRumMetricsDestinationResponse {
|
|
|
1198
1198
|
*/
|
|
1199
1199
|
export interface GetAppMonitorRequest {
|
|
1200
1200
|
/**
|
|
1201
|
-
* @public
|
|
1202
1201
|
* <p>The app monitor to retrieve information for.</p>
|
|
1202
|
+
* @public
|
|
1203
1203
|
*/
|
|
1204
1204
|
Name: string | undefined;
|
|
1205
1205
|
}
|
|
@@ -1208,13 +1208,12 @@ export interface GetAppMonitorRequest {
|
|
|
1208
1208
|
*/
|
|
1209
1209
|
export interface GetAppMonitorResponse {
|
|
1210
1210
|
/**
|
|
1211
|
-
* @public
|
|
1212
1211
|
* <p>A structure containing all the configuration information for the app monitor.</p>
|
|
1212
|
+
* @public
|
|
1213
1213
|
*/
|
|
1214
1214
|
AppMonitor?: AppMonitor;
|
|
1215
1215
|
}
|
|
1216
1216
|
/**
|
|
1217
|
-
* @public
|
|
1218
1217
|
* <p>A structure that defines a key and values that you can use to filter the results. The
|
|
1219
1218
|
* only performance events that are returned are those that have values matching the ones that
|
|
1220
1219
|
* you specify in one of your <code>QueryFilter</code> structures.</p>
|
|
@@ -1225,10 +1224,10 @@ export interface GetAppMonitorResponse {
|
|
|
1225
1224
|
* works as a "not equal to" filter. For example, specify <code>Invert</code> as the <code>Name</code>
|
|
1226
1225
|
* and specify <code>Chrome</code> as the value to return all events except events from
|
|
1227
1226
|
* user sessions with the Chrome browser.</p>
|
|
1227
|
+
* @public
|
|
1228
1228
|
*/
|
|
1229
1229
|
export interface QueryFilter {
|
|
1230
1230
|
/**
|
|
1231
|
-
* @public
|
|
1232
1231
|
* <p>The name of a key to search for.
|
|
1233
1232
|
* The filter returns only the events that match the <code>Name</code>
|
|
1234
1233
|
* and <code>Values</code> that you specify.
|
|
@@ -1236,28 +1235,29 @@ export interface QueryFilter {
|
|
|
1236
1235
|
* <p>Valid values for <code>Name</code> are <code>Browser</code> | <code>Device</code> | <code>Country</code> |
|
|
1237
1236
|
* <code>Page</code> | <code>OS</code> | <code>EventType</code> | <code>Invert</code>
|
|
1238
1237
|
* </p>
|
|
1238
|
+
* @public
|
|
1239
1239
|
*/
|
|
1240
1240
|
Name?: string;
|
|
1241
1241
|
/**
|
|
1242
|
-
* @public
|
|
1243
1242
|
* <p>The values of the <code>Name</code> that are to be be included in the returned results.</p>
|
|
1243
|
+
* @public
|
|
1244
1244
|
*/
|
|
1245
1245
|
Values?: string[];
|
|
1246
1246
|
}
|
|
1247
1247
|
/**
|
|
1248
|
-
* @public
|
|
1249
1248
|
* <p>A structure that defines the time range that you want to retrieve results from.</p>
|
|
1249
|
+
* @public
|
|
1250
1250
|
*/
|
|
1251
1251
|
export interface TimeRange {
|
|
1252
1252
|
/**
|
|
1253
|
-
* @public
|
|
1254
1253
|
* <p>The beginning of the time range to retrieve performance events from.</p>
|
|
1254
|
+
* @public
|
|
1255
1255
|
*/
|
|
1256
1256
|
After: number | undefined;
|
|
1257
1257
|
/**
|
|
1258
|
-
* @public
|
|
1259
1258
|
* <p>The end of the time range to retrieve performance events from. If you omit this, the time
|
|
1260
1259
|
* range extends to the time that this operation is performed.</p>
|
|
1260
|
+
* @public
|
|
1261
1261
|
*/
|
|
1262
1262
|
Before?: number;
|
|
1263
1263
|
}
|
|
@@ -1266,29 +1266,29 @@ export interface TimeRange {
|
|
|
1266
1266
|
*/
|
|
1267
1267
|
export interface GetAppMonitorDataRequest {
|
|
1268
1268
|
/**
|
|
1269
|
-
* @public
|
|
1270
1269
|
* <p>The name of the app monitor that collected the data that you want to retrieve.</p>
|
|
1270
|
+
* @public
|
|
1271
1271
|
*/
|
|
1272
1272
|
Name: string | undefined;
|
|
1273
1273
|
/**
|
|
1274
|
-
* @public
|
|
1275
1274
|
* <p>A structure that defines the time range that you want to retrieve results from.</p>
|
|
1275
|
+
* @public
|
|
1276
1276
|
*/
|
|
1277
1277
|
TimeRange: TimeRange | undefined;
|
|
1278
1278
|
/**
|
|
1279
|
-
* @public
|
|
1280
1279
|
* <p>An array of structures that you can use to filter the results to those that match one or
|
|
1281
1280
|
* more sets of key-value pairs that you specify.</p>
|
|
1281
|
+
* @public
|
|
1282
1282
|
*/
|
|
1283
1283
|
Filters?: QueryFilter[];
|
|
1284
1284
|
/**
|
|
1285
|
-
* @public
|
|
1286
1285
|
* <p>The maximum number of results to return in one operation. </p>
|
|
1286
|
+
* @public
|
|
1287
1287
|
*/
|
|
1288
1288
|
MaxResults?: number;
|
|
1289
1289
|
/**
|
|
1290
|
-
* @public
|
|
1291
1290
|
* <p>Use the token returned by the previous operation to request the next page of results.</p>
|
|
1291
|
+
* @public
|
|
1292
1292
|
*/
|
|
1293
1293
|
NextToken?: string;
|
|
1294
1294
|
}
|
|
@@ -1297,14 +1297,14 @@ export interface GetAppMonitorDataRequest {
|
|
|
1297
1297
|
*/
|
|
1298
1298
|
export interface GetAppMonitorDataResponse {
|
|
1299
1299
|
/**
|
|
1300
|
-
* @public
|
|
1301
1300
|
* <p>The events that RUM collected that match your request.</p>
|
|
1301
|
+
* @public
|
|
1302
1302
|
*/
|
|
1303
1303
|
Events?: string[];
|
|
1304
1304
|
/**
|
|
1305
|
-
* @public
|
|
1306
1305
|
* <p>A token that you can use in a subsequent operation to retrieve the next set of
|
|
1307
1306
|
* results.</p>
|
|
1307
|
+
* @public
|
|
1308
1308
|
*/
|
|
1309
1309
|
NextToken?: string;
|
|
1310
1310
|
}
|
|
@@ -1313,45 +1313,45 @@ export interface GetAppMonitorDataResponse {
|
|
|
1313
1313
|
*/
|
|
1314
1314
|
export interface ListAppMonitorsRequest {
|
|
1315
1315
|
/**
|
|
1316
|
-
* @public
|
|
1317
1316
|
* <p>The maximum number of results to return in one operation. The default is 50. The maximum that you can
|
|
1318
1317
|
* specify is 100.</p>
|
|
1318
|
+
* @public
|
|
1319
1319
|
*/
|
|
1320
1320
|
MaxResults?: number;
|
|
1321
1321
|
/**
|
|
1322
|
-
* @public
|
|
1323
1322
|
* <p>Use the token returned by the previous operation to request the next page of results.</p>
|
|
1323
|
+
* @public
|
|
1324
1324
|
*/
|
|
1325
1325
|
NextToken?: string;
|
|
1326
1326
|
}
|
|
1327
1327
|
/**
|
|
1328
|
-
* @public
|
|
1329
1328
|
* <p>A structure that includes some data about app monitors and their settings.</p>
|
|
1329
|
+
* @public
|
|
1330
1330
|
*/
|
|
1331
1331
|
export interface AppMonitorSummary {
|
|
1332
1332
|
/**
|
|
1333
|
-
* @public
|
|
1334
1333
|
* <p>The name of this app monitor.</p>
|
|
1334
|
+
* @public
|
|
1335
1335
|
*/
|
|
1336
1336
|
Name?: string;
|
|
1337
1337
|
/**
|
|
1338
|
-
* @public
|
|
1339
1338
|
* <p>The unique ID of this app monitor.</p>
|
|
1339
|
+
* @public
|
|
1340
1340
|
*/
|
|
1341
1341
|
Id?: string;
|
|
1342
1342
|
/**
|
|
1343
|
-
* @public
|
|
1344
1343
|
* <p>The date and time that the app monitor was created.</p>
|
|
1344
|
+
* @public
|
|
1345
1345
|
*/
|
|
1346
1346
|
Created?: string;
|
|
1347
1347
|
/**
|
|
1348
|
-
* @public
|
|
1349
1348
|
* <p>The date and time of the most recent changes to this app monitor's configuration.</p>
|
|
1349
|
+
* @public
|
|
1350
1350
|
*/
|
|
1351
1351
|
LastModified?: string;
|
|
1352
1352
|
/**
|
|
1353
|
-
* @public
|
|
1354
1353
|
* <p>The current state of this app monitor.</p>
|
|
1354
|
+
* @public
|
|
1355
1355
|
*/
|
|
1356
1356
|
State?: StateEnum;
|
|
1357
1357
|
}
|
|
@@ -1360,14 +1360,14 @@ export interface AppMonitorSummary {
|
|
|
1360
1360
|
*/
|
|
1361
1361
|
export interface ListAppMonitorsResponse {
|
|
1362
1362
|
/**
|
|
1363
|
-
* @public
|
|
1364
1363
|
* <p>A token that you can use in a subsequent operation to retrieve the next set of
|
|
1365
1364
|
* results.</p>
|
|
1365
|
+
* @public
|
|
1366
1366
|
*/
|
|
1367
1367
|
NextToken?: string;
|
|
1368
1368
|
/**
|
|
1369
|
-
* @public
|
|
1370
1369
|
* <p>An array of structures that contain information about the returned app monitors.</p>
|
|
1370
|
+
* @public
|
|
1371
1371
|
*/
|
|
1372
1372
|
AppMonitorSummaries?: AppMonitorSummary[];
|
|
1373
1373
|
}
|
|
@@ -1376,45 +1376,45 @@ export interface ListAppMonitorsResponse {
|
|
|
1376
1376
|
*/
|
|
1377
1377
|
export interface ListRumMetricsDestinationsRequest {
|
|
1378
1378
|
/**
|
|
1379
|
-
* @public
|
|
1380
1379
|
* <p>The name of the app monitor associated with the destinations that you want to retrieve.</p>
|
|
1380
|
+
* @public
|
|
1381
1381
|
*/
|
|
1382
1382
|
AppMonitorName: string | undefined;
|
|
1383
1383
|
/**
|
|
1384
|
-
* @public
|
|
1385
1384
|
* <p>The maximum number of results to return in one operation. The default is 50. The maximum that you can
|
|
1386
1385
|
* specify is 100.</p>
|
|
1387
1386
|
* <p>To retrieve the remaining results, make another call with the returned
|
|
1388
1387
|
* <code>NextToken</code> value. </p>
|
|
1388
|
+
* @public
|
|
1389
1389
|
*/
|
|
1390
1390
|
MaxResults?: number;
|
|
1391
1391
|
/**
|
|
1392
|
-
* @public
|
|
1393
1392
|
* <p>Use the token returned by the previous operation to request the next page of results.</p>
|
|
1393
|
+
* @public
|
|
1394
1394
|
*/
|
|
1395
1395
|
NextToken?: string;
|
|
1396
1396
|
}
|
|
1397
1397
|
/**
|
|
1398
|
-
* @public
|
|
1399
1398
|
* <p>A structure that displays information about one destination that CloudWatch RUM sends
|
|
1400
1399
|
* extended metrics to.</p>
|
|
1400
|
+
* @public
|
|
1401
1401
|
*/
|
|
1402
1402
|
export interface MetricDestinationSummary {
|
|
1403
1403
|
/**
|
|
1404
|
-
* @public
|
|
1405
1404
|
* <p>Specifies whether the destination is <code>CloudWatch</code> or <code>Evidently</code>.</p>
|
|
1405
|
+
* @public
|
|
1406
1406
|
*/
|
|
1407
1407
|
Destination?: MetricDestination;
|
|
1408
1408
|
/**
|
|
1409
|
-
* @public
|
|
1410
1409
|
* <p>If the destination is <code>Evidently</code>, this specifies the ARN of the Evidently experiment that receives
|
|
1411
1410
|
* the metrics.</p>
|
|
1411
|
+
* @public
|
|
1412
1412
|
*/
|
|
1413
1413
|
DestinationArn?: string;
|
|
1414
1414
|
/**
|
|
1415
|
-
* @public
|
|
1416
1415
|
* <p>This field appears only when the destination is <code>Evidently</code>. It specifies
|
|
1417
1416
|
* the ARN of the IAM role that is used to write to the Evidently experiment that receives the metrics.</p>
|
|
1417
|
+
* @public
|
|
1418
1418
|
*/
|
|
1419
1419
|
IamRoleArn?: string;
|
|
1420
1420
|
}
|
|
@@ -1423,15 +1423,15 @@ export interface MetricDestinationSummary {
|
|
|
1423
1423
|
*/
|
|
1424
1424
|
export interface ListRumMetricsDestinationsResponse {
|
|
1425
1425
|
/**
|
|
1426
|
-
* @public
|
|
1427
1426
|
* <p>The list of CloudWatch RUM extended metrics destinations associated with the app monitor that
|
|
1428
1427
|
* you specified.</p>
|
|
1428
|
+
* @public
|
|
1429
1429
|
*/
|
|
1430
1430
|
Destinations?: MetricDestinationSummary[];
|
|
1431
1431
|
/**
|
|
1432
|
-
* @public
|
|
1433
1432
|
* <p>A token that you can use in a subsequent operation to
|
|
1434
1433
|
* retrieve the next set of results.</p>
|
|
1434
|
+
* @public
|
|
1435
1435
|
*/
|
|
1436
1436
|
NextToken?: string;
|
|
1437
1437
|
}
|
|
@@ -1440,26 +1440,25 @@ export interface ListRumMetricsDestinationsResponse {
|
|
|
1440
1440
|
*/
|
|
1441
1441
|
export interface PutRumMetricsDestinationRequest {
|
|
1442
1442
|
/**
|
|
1443
|
-
* @public
|
|
1444
1443
|
* <p>The name of the CloudWatch RUM app monitor that will send the metrics.</p>
|
|
1444
|
+
* @public
|
|
1445
1445
|
*/
|
|
1446
1446
|
AppMonitorName: string | undefined;
|
|
1447
1447
|
/**
|
|
1448
|
-
* @public
|
|
1449
1448
|
* <p>Defines the destination to send the metrics to. Valid values are <code>CloudWatch</code> and
|
|
1450
1449
|
* <code>Evidently</code>. If
|
|
1451
1450
|
* you specify <code>Evidently</code>, you must also specify the ARN of the CloudWatchEvidently experiment that is to
|
|
1452
1451
|
* be the destination and an IAM role that has permission to write to the experiment.</p>
|
|
1452
|
+
* @public
|
|
1453
1453
|
*/
|
|
1454
1454
|
Destination: MetricDestination | undefined;
|
|
1455
1455
|
/**
|
|
1456
|
-
* @public
|
|
1457
1456
|
* <p>Use this parameter only if <code>Destination</code> is <code>Evidently</code>. This parameter specifies
|
|
1458
1457
|
* the ARN of the Evidently experiment that will receive the extended metrics.</p>
|
|
1458
|
+
* @public
|
|
1459
1459
|
*/
|
|
1460
1460
|
DestinationArn?: string;
|
|
1461
1461
|
/**
|
|
1462
|
-
* @public
|
|
1463
1462
|
* <p>This parameter is required if <code>Destination</code> is <code>Evidently</code>. If <code>Destination</code> is
|
|
1464
1463
|
* <code>CloudWatch</code>, don't use this parameter.</p>
|
|
1465
1464
|
* <p>This parameter specifies
|
|
@@ -1470,6 +1469,7 @@ export interface PutRumMetricsDestinationRequest {
|
|
|
1470
1469
|
* CloudWatchAmazonCloudWatchRUMFullAccess</a>
|
|
1471
1470
|
* policy doesn't include <code>PassRole</code>
|
|
1472
1471
|
* permissions.</p>
|
|
1472
|
+
* @public
|
|
1473
1473
|
*/
|
|
1474
1474
|
IamRoleArn?: string;
|
|
1475
1475
|
}
|
|
@@ -1483,39 +1483,39 @@ export interface PutRumMetricsDestinationResponse {
|
|
|
1483
1483
|
*/
|
|
1484
1484
|
export interface UpdateAppMonitorRequest {
|
|
1485
1485
|
/**
|
|
1486
|
-
* @public
|
|
1487
1486
|
* <p>The name of the app monitor to update.</p>
|
|
1487
|
+
* @public
|
|
1488
1488
|
*/
|
|
1489
1489
|
Name: string | undefined;
|
|
1490
1490
|
/**
|
|
1491
|
-
* @public
|
|
1492
1491
|
* <p>The top-level internet domain name for which your application has administrative authority.</p>
|
|
1492
|
+
* @public
|
|
1493
1493
|
*/
|
|
1494
1494
|
Domain?: string;
|
|
1495
1495
|
/**
|
|
1496
|
-
* @public
|
|
1497
1496
|
* <p>A structure that contains much of the configuration data for the app monitor. If you are using
|
|
1498
1497
|
* Amazon Cognito for authorization, you must include this structure in your request, and it must include the ID of the
|
|
1499
1498
|
* Amazon Cognito identity pool to use for authorization. If you don't include <code>AppMonitorConfiguration</code>, you must set up your own
|
|
1500
1499
|
* authorization method. For more information, see
|
|
1501
1500
|
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-get-started-authorization.html">Authorize your application
|
|
1502
1501
|
* to send data to Amazon Web Services</a>.</p>
|
|
1502
|
+
* @public
|
|
1503
1503
|
*/
|
|
1504
1504
|
AppMonitorConfiguration?: AppMonitorConfiguration;
|
|
1505
1505
|
/**
|
|
1506
|
-
* @public
|
|
1507
1506
|
* <p>Data collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM
|
|
1508
1507
|
* sends a copy of this telemetry data to Amazon CloudWatch Logs
|
|
1509
1508
|
* in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur
|
|
1510
1509
|
* Amazon CloudWatch Logs charges.</p>
|
|
1510
|
+
* @public
|
|
1511
1511
|
*/
|
|
1512
1512
|
CwLogEnabled?: boolean;
|
|
1513
1513
|
/**
|
|
1514
|
-
* @public
|
|
1515
1514
|
* <p>Specifies whether this app monitor allows the web client to define and send
|
|
1516
1515
|
* custom events. The default is for custom events to be <code>DISABLED</code>.</p>
|
|
1517
1516
|
* <p>For more information about custom events, see
|
|
1518
1517
|
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-custom-events.html">Send custom events</a>.</p>
|
|
1518
|
+
* @public
|
|
1519
1519
|
*/
|
|
1520
1520
|
CustomEvents?: CustomEvents;
|
|
1521
1521
|
}
|
|
@@ -1529,34 +1529,34 @@ export interface UpdateAppMonitorResponse {
|
|
|
1529
1529
|
*/
|
|
1530
1530
|
export interface UpdateRumMetricDefinitionRequest {
|
|
1531
1531
|
/**
|
|
1532
|
-
* @public
|
|
1533
1532
|
* <p>The name of the CloudWatch RUM app monitor that sends these metrics.</p>
|
|
1533
|
+
* @public
|
|
1534
1534
|
*/
|
|
1535
1535
|
AppMonitorName: string | undefined;
|
|
1536
1536
|
/**
|
|
1537
|
-
* @public
|
|
1538
1537
|
* <p>The destination to send the metrics to. Valid values are <code>CloudWatch</code> and <code>Evidently</code>. If
|
|
1539
1538
|
* you specify <code>Evidently</code>, you must also specify the ARN of the CloudWatchEvidently experiment
|
|
1540
1539
|
* that will receive
|
|
1541
1540
|
* the metrics and an IAM role that has permission to write to the experiment.</p>
|
|
1541
|
+
* @public
|
|
1542
1542
|
*/
|
|
1543
1543
|
Destination: MetricDestination | undefined;
|
|
1544
1544
|
/**
|
|
1545
|
-
* @public
|
|
1546
1545
|
* <p>This parameter is required if <code>Destination</code> is <code>Evidently</code>. If <code>Destination</code> is
|
|
1547
1546
|
* <code>CloudWatch</code>, do not use this parameter.</p>
|
|
1548
1547
|
* <p>This parameter specifies the ARN of the Evidently experiment that is to receive the metrics. You must have already defined this
|
|
1549
1548
|
* 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>
|
|
1549
|
+
* @public
|
|
1550
1550
|
*/
|
|
1551
1551
|
DestinationArn?: string;
|
|
1552
1552
|
/**
|
|
1553
|
-
* @public
|
|
1554
1553
|
* <p>A structure that contains the new definition that you want to use for this metric.</p>
|
|
1554
|
+
* @public
|
|
1555
1555
|
*/
|
|
1556
1556
|
MetricDefinition: MetricDefinitionRequest | undefined;
|
|
1557
1557
|
/**
|
|
1558
|
-
* @public
|
|
1559
1558
|
* <p>The ID of the metric definition to update.</p>
|
|
1559
|
+
* @public
|
|
1560
1560
|
*/
|
|
1561
1561
|
MetricDefinitionId: string | undefined;
|
|
1562
1562
|
}
|
|
@@ -1570,8 +1570,8 @@ export interface UpdateRumMetricDefinitionResponse {
|
|
|
1570
1570
|
*/
|
|
1571
1571
|
export interface ListTagsForResourceRequest {
|
|
1572
1572
|
/**
|
|
1573
|
-
* @public
|
|
1574
1573
|
* <p>The ARN of the resource that you want to see the tags of.</p>
|
|
1574
|
+
* @public
|
|
1575
1575
|
*/
|
|
1576
1576
|
ResourceArn: string | undefined;
|
|
1577
1577
|
}
|
|
@@ -1580,64 +1580,64 @@ export interface ListTagsForResourceRequest {
|
|
|
1580
1580
|
*/
|
|
1581
1581
|
export interface ListTagsForResourceResponse {
|
|
1582
1582
|
/**
|
|
1583
|
-
* @public
|
|
1584
1583
|
* <p>The ARN of the resource that you are viewing.</p>
|
|
1584
|
+
* @public
|
|
1585
1585
|
*/
|
|
1586
1586
|
ResourceArn: string | undefined;
|
|
1587
1587
|
/**
|
|
1588
|
-
* @public
|
|
1589
1588
|
* <p>The list of tag keys and values associated with the resource you specified.</p>
|
|
1589
|
+
* @public
|
|
1590
1590
|
*/
|
|
1591
1591
|
Tags: Record<string, string> | undefined;
|
|
1592
1592
|
}
|
|
1593
1593
|
/**
|
|
1594
|
-
* @public
|
|
1595
1594
|
* <p>A structure that contains the information for one performance event that RUM collects from a user session with your
|
|
1596
1595
|
* application.</p>
|
|
1596
|
+
* @public
|
|
1597
1597
|
*/
|
|
1598
1598
|
export interface RumEvent {
|
|
1599
1599
|
/**
|
|
1600
|
-
* @public
|
|
1601
1600
|
* <p>A unique ID for this event.</p>
|
|
1601
|
+
* @public
|
|
1602
1602
|
*/
|
|
1603
1603
|
id: string | undefined;
|
|
1604
1604
|
/**
|
|
1605
|
-
* @public
|
|
1606
1605
|
* <p>The exact time that this event occurred.</p>
|
|
1606
|
+
* @public
|
|
1607
1607
|
*/
|
|
1608
1608
|
timestamp: Date | undefined;
|
|
1609
1609
|
/**
|
|
1610
|
-
* @public
|
|
1611
1610
|
* <p>The JSON schema that denotes the type of event this is, such as a page load or a new session.</p>
|
|
1611
|
+
* @public
|
|
1612
1612
|
*/
|
|
1613
1613
|
type: string | undefined;
|
|
1614
1614
|
/**
|
|
1615
|
-
* @public
|
|
1616
1615
|
* <p>Metadata about this event, which contains a JSON serialization of the identity of the user for
|
|
1617
1616
|
* this session. The user information comes from information such as the HTTP user-agent request header
|
|
1618
1617
|
* and document interface.</p>
|
|
1618
|
+
* @public
|
|
1619
1619
|
*/
|
|
1620
1620
|
metadata?: __LazyJsonString | string;
|
|
1621
1621
|
/**
|
|
1622
|
-
* @public
|
|
1623
1622
|
* <p>A string containing details about the event.</p>
|
|
1623
|
+
* @public
|
|
1624
1624
|
*/
|
|
1625
1625
|
details: __LazyJsonString | string | undefined;
|
|
1626
1626
|
}
|
|
1627
1627
|
/**
|
|
1628
|
-
* @public
|
|
1629
1628
|
* <p>A structure that contains information about the user session that this batch of events was collected from.</p>
|
|
1629
|
+
* @public
|
|
1630
1630
|
*/
|
|
1631
1631
|
export interface UserDetails {
|
|
1632
1632
|
/**
|
|
1633
|
-
* @public
|
|
1634
1633
|
* <p>The ID of the user for this user session. This ID is generated by RUM and does not include any
|
|
1635
1634
|
* personally identifiable information about the user.</p>
|
|
1635
|
+
* @public
|
|
1636
1636
|
*/
|
|
1637
1637
|
userId?: string;
|
|
1638
1638
|
/**
|
|
1639
|
-
* @public
|
|
1640
1639
|
* <p>The session ID that the performance events are from.</p>
|
|
1640
|
+
* @public
|
|
1641
1641
|
*/
|
|
1642
1642
|
sessionId?: string;
|
|
1643
1643
|
}
|
|
@@ -1646,28 +1646,28 @@ export interface UserDetails {
|
|
|
1646
1646
|
*/
|
|
1647
1647
|
export interface PutRumEventsRequest {
|
|
1648
1648
|
/**
|
|
1649
|
-
* @public
|
|
1650
1649
|
* <p>The ID of the app monitor that is sending this data.</p>
|
|
1650
|
+
* @public
|
|
1651
1651
|
*/
|
|
1652
1652
|
Id: string | undefined;
|
|
1653
1653
|
/**
|
|
1654
|
-
* @public
|
|
1655
1654
|
* <p>A unique identifier for this batch of RUM event data.</p>
|
|
1655
|
+
* @public
|
|
1656
1656
|
*/
|
|
1657
1657
|
BatchId: string | undefined;
|
|
1658
1658
|
/**
|
|
1659
|
-
* @public
|
|
1660
1659
|
* <p>A structure that contains information about the app monitor that collected this telemetry information.</p>
|
|
1660
|
+
* @public
|
|
1661
1661
|
*/
|
|
1662
1662
|
AppMonitorDetails: AppMonitorDetails | undefined;
|
|
1663
1663
|
/**
|
|
1664
|
-
* @public
|
|
1665
1664
|
* <p>A structure that contains information about the user session that this batch of events was collected from.</p>
|
|
1665
|
+
* @public
|
|
1666
1666
|
*/
|
|
1667
1667
|
UserDetails: UserDetails | undefined;
|
|
1668
1668
|
/**
|
|
1669
|
-
* @public
|
|
1670
1669
|
* <p>An array of structures that contain the telemetry event data.</p>
|
|
1670
|
+
* @public
|
|
1671
1671
|
*/
|
|
1672
1672
|
RumEvents: RumEvent[] | undefined;
|
|
1673
1673
|
}
|
|
@@ -1681,13 +1681,13 @@ export interface PutRumEventsResponse {
|
|
|
1681
1681
|
*/
|
|
1682
1682
|
export interface TagResourceRequest {
|
|
1683
1683
|
/**
|
|
1684
|
-
* @public
|
|
1685
1684
|
* <p>The ARN of the CloudWatch RUM resource that you're adding tags to.</p>
|
|
1685
|
+
* @public
|
|
1686
1686
|
*/
|
|
1687
1687
|
ResourceArn: string | undefined;
|
|
1688
1688
|
/**
|
|
1689
|
-
* @public
|
|
1690
1689
|
* <p>The list of key-value pairs to associate with the resource.</p>
|
|
1690
|
+
* @public
|
|
1691
1691
|
*/
|
|
1692
1692
|
Tags: Record<string, string> | undefined;
|
|
1693
1693
|
}
|
|
@@ -1701,13 +1701,13 @@ export interface TagResourceResponse {
|
|
|
1701
1701
|
*/
|
|
1702
1702
|
export interface UntagResourceRequest {
|
|
1703
1703
|
/**
|
|
1704
|
-
* @public
|
|
1705
1704
|
* <p>The ARN of the CloudWatch RUM resource that you're removing tags from.</p>
|
|
1705
|
+
* @public
|
|
1706
1706
|
*/
|
|
1707
1707
|
ResourceArn: string | undefined;
|
|
1708
1708
|
/**
|
|
1709
|
-
* @public
|
|
1710
1709
|
* <p>The list of tag keys to remove from the resource.</p>
|
|
1710
|
+
* @public
|
|
1711
1711
|
*/
|
|
1712
1712
|
TagKeys: string[] | undefined;
|
|
1713
1713
|
}
|