aws-sdk-cloudwatchrum 1.49.0 → 1.50.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cloudwatchrum/client.rb +171 -163
- data/lib/aws-sdk-cloudwatchrum/client_api.rb +50 -47
- data/lib/aws-sdk-cloudwatchrum/errors.rb +5 -5
- data/lib/aws-sdk-cloudwatchrum/types.rb +372 -351
- data/lib/aws-sdk-cloudwatchrum/waiters.rb +15 -0
- data/lib/aws-sdk-cloudwatchrum.rb +2 -1
- data/sig/client.rbs +53 -52
- data/sig/errors.rbs +1 -1
- data/sig/types.rbs +48 -45
- metadata +2 -1
|
@@ -28,38 +28,10 @@ module Aws::CloudWatchRUM
|
|
|
28
28
|
# information such as page load time, client-side errors, and user
|
|
29
29
|
# behavior.
|
|
30
30
|
#
|
|
31
|
-
# @!attribute [rw]
|
|
32
|
-
#
|
|
33
|
-
# monitor.
|
|
34
|
-
# @return [Types::AppMonitorConfiguration]
|
|
35
|
-
#
|
|
36
|
-
# @!attribute [rw] created
|
|
37
|
-
# The date and time that this app monitor was created.
|
|
31
|
+
# @!attribute [rw] name
|
|
32
|
+
# The name of the app monitor.
|
|
38
33
|
# @return [String]
|
|
39
34
|
#
|
|
40
|
-
# @!attribute [rw] custom_events
|
|
41
|
-
# Specifies whether this app monitor allows the web client to define
|
|
42
|
-
# and send custom events.
|
|
43
|
-
#
|
|
44
|
-
# For more information about custom events, see [Send custom
|
|
45
|
-
# events][1].
|
|
46
|
-
#
|
|
47
|
-
#
|
|
48
|
-
#
|
|
49
|
-
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-custom-events.html
|
|
50
|
-
# @return [Types::CustomEvents]
|
|
51
|
-
#
|
|
52
|
-
# @!attribute [rw] data_storage
|
|
53
|
-
# A structure that contains information about whether this app monitor
|
|
54
|
-
# stores a copy of the telemetry data that RUM collects using
|
|
55
|
-
# CloudWatch Logs.
|
|
56
|
-
# @return [Types::DataStorage]
|
|
57
|
-
#
|
|
58
|
-
# @!attribute [rw] deobfuscation_configuration
|
|
59
|
-
# A structure that contains the configuration for how an app monitor
|
|
60
|
-
# can deobfuscate stack traces.
|
|
61
|
-
# @return [Types::DeobfuscationConfiguration]
|
|
62
|
-
#
|
|
63
35
|
# @!attribute [rw] domain
|
|
64
36
|
# The top-level internet domain name for which your application has
|
|
65
37
|
# administrative authority.
|
|
@@ -74,38 +46,73 @@ module Aws::CloudWatchRUM
|
|
|
74
46
|
# The unique ID of this app monitor.
|
|
75
47
|
# @return [String]
|
|
76
48
|
#
|
|
49
|
+
# @!attribute [rw] created
|
|
50
|
+
# The date and time that this app monitor was created.
|
|
51
|
+
# @return [String]
|
|
52
|
+
#
|
|
77
53
|
# @!attribute [rw] last_modified
|
|
78
54
|
# The date and time of the most recent changes to this app monitor's
|
|
79
55
|
# configuration.
|
|
80
56
|
# @return [String]
|
|
81
57
|
#
|
|
82
|
-
# @!attribute [rw]
|
|
83
|
-
# The
|
|
84
|
-
# @return [String]
|
|
58
|
+
# @!attribute [rw] tags
|
|
59
|
+
# The list of tag keys and values associated with this app monitor.
|
|
60
|
+
# @return [Hash<String,String>]
|
|
85
61
|
#
|
|
86
62
|
# @!attribute [rw] state
|
|
87
63
|
# The current state of the app monitor.
|
|
88
64
|
# @return [String]
|
|
89
65
|
#
|
|
90
|
-
# @!attribute [rw]
|
|
91
|
-
#
|
|
92
|
-
#
|
|
66
|
+
# @!attribute [rw] app_monitor_configuration
|
|
67
|
+
# A structure that contains much of the configuration data for the app
|
|
68
|
+
# monitor.
|
|
69
|
+
# @return [Types::AppMonitorConfiguration]
|
|
70
|
+
#
|
|
71
|
+
# @!attribute [rw] data_storage
|
|
72
|
+
# A structure that contains information about whether this app monitor
|
|
73
|
+
# stores a copy of the telemetry data that RUM collects using
|
|
74
|
+
# CloudWatch Logs.
|
|
75
|
+
# @return [Types::DataStorage]
|
|
76
|
+
#
|
|
77
|
+
# @!attribute [rw] custom_events
|
|
78
|
+
# Specifies whether this app monitor allows the web client to define
|
|
79
|
+
# and send custom events.
|
|
80
|
+
#
|
|
81
|
+
# For more information about custom events, see [Send custom
|
|
82
|
+
# events][1].
|
|
83
|
+
#
|
|
84
|
+
#
|
|
85
|
+
#
|
|
86
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-custom-events.html
|
|
87
|
+
# @return [Types::CustomEvents]
|
|
88
|
+
#
|
|
89
|
+
# @!attribute [rw] deobfuscation_configuration
|
|
90
|
+
# A structure that contains the configuration for how an app monitor
|
|
91
|
+
# can deobfuscate stack traces.
|
|
92
|
+
# @return [Types::DeobfuscationConfiguration]
|
|
93
|
+
#
|
|
94
|
+
# @!attribute [rw] platform
|
|
95
|
+
# The platform type for this app monitor. Valid values are `Web` for
|
|
96
|
+
# web applications , `Android` for Android applications, and `iOS` for
|
|
97
|
+
# IOS applications.
|
|
98
|
+
# @return [String]
|
|
93
99
|
#
|
|
94
100
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/AppMonitor AWS API Documentation
|
|
95
101
|
#
|
|
96
102
|
class AppMonitor < Struct.new(
|
|
97
|
-
:
|
|
98
|
-
:created,
|
|
99
|
-
:custom_events,
|
|
100
|
-
:data_storage,
|
|
101
|
-
:deobfuscation_configuration,
|
|
103
|
+
:name,
|
|
102
104
|
:domain,
|
|
103
105
|
:domain_list,
|
|
104
106
|
:id,
|
|
107
|
+
:created,
|
|
105
108
|
:last_modified,
|
|
106
|
-
:
|
|
109
|
+
:tags,
|
|
107
110
|
:state,
|
|
108
|
-
:
|
|
111
|
+
:app_monitor_configuration,
|
|
112
|
+
:data_storage,
|
|
113
|
+
:custom_events,
|
|
114
|
+
:deobfuscation_configuration,
|
|
115
|
+
:platform)
|
|
109
116
|
SENSITIVE = []
|
|
110
117
|
include Aws::Structure
|
|
111
118
|
end
|
|
@@ -113,27 +120,10 @@ module Aws::CloudWatchRUM
|
|
|
113
120
|
# This structure contains much of the configuration data for the app
|
|
114
121
|
# monitor.
|
|
115
122
|
#
|
|
116
|
-
# @!attribute [rw]
|
|
117
|
-
#
|
|
118
|
-
#
|
|
119
|
-
#
|
|
120
|
-
# application has and the behavior of the application across a
|
|
121
|
-
# sequence of events. Cookies are stored in the top-level domain of
|
|
122
|
-
# the current page.
|
|
123
|
-
# @return [Boolean]
|
|
124
|
-
#
|
|
125
|
-
# @!attribute [rw] enable_x_ray
|
|
126
|
-
# If you set this to `true`, RUM enables X-Ray tracing for the user
|
|
127
|
-
# sessions that RUM samples. RUM adds an X-Ray trace header to allowed
|
|
128
|
-
# HTTP requests. It also records an X-Ray segment for allowed HTTP
|
|
129
|
-
# requests. You can see traces and segments from these user sessions
|
|
130
|
-
# in the X-Ray console and the CloudWatch ServiceLens console. For
|
|
131
|
-
# more information, see [What is X-Ray?][1]
|
|
132
|
-
#
|
|
133
|
-
#
|
|
134
|
-
#
|
|
135
|
-
# [1]: https://docs.aws.amazon.com/xray/latest/devguide/aws-xray.html
|
|
136
|
-
# @return [Boolean]
|
|
123
|
+
# @!attribute [rw] identity_pool_id
|
|
124
|
+
# The ID of the Amazon Cognito identity pool that is used to authorize
|
|
125
|
+
# the sending of data to RUM.
|
|
126
|
+
# @return [String]
|
|
137
127
|
#
|
|
138
128
|
# @!attribute [rw] excluded_pages
|
|
139
129
|
# A list of URLs in your website or application to exclude from RUM
|
|
@@ -143,11 +133,32 @@ module Aws::CloudWatchRUM
|
|
|
143
133
|
# same operation.
|
|
144
134
|
# @return [Array<String>]
|
|
145
135
|
#
|
|
136
|
+
# @!attribute [rw] included_pages
|
|
137
|
+
# If this app monitor is to collect data from only certain pages in
|
|
138
|
+
# your application, this structure lists those pages.
|
|
139
|
+
#
|
|
140
|
+
# You can't include both `ExcludedPages` and `IncludedPages` in the
|
|
141
|
+
# same operation.
|
|
142
|
+
# @return [Array<String>]
|
|
143
|
+
#
|
|
146
144
|
# @!attribute [rw] favorite_pages
|
|
147
145
|
# A list of pages in your application that are to be displayed with a
|
|
148
146
|
# "favorite" icon in the CloudWatch RUM console.
|
|
149
147
|
# @return [Array<String>]
|
|
150
148
|
#
|
|
149
|
+
# @!attribute [rw] session_sample_rate
|
|
150
|
+
# Specifies the portion of user sessions to use for RUM data
|
|
151
|
+
# collection. Choosing a higher portion gives you more data but also
|
|
152
|
+
# incurs more costs.
|
|
153
|
+
#
|
|
154
|
+
# The range for this value is 0 to 1 inclusive. Setting this to 1
|
|
155
|
+
# means that 100% of user sessions are sampled, and setting it to 0.1
|
|
156
|
+
# means that 10% of user sessions are sampled.
|
|
157
|
+
#
|
|
158
|
+
# If you omit this parameter, the default of 0.1 is used, and 10% of
|
|
159
|
+
# sessions will be sampled.
|
|
160
|
+
# @return [Float]
|
|
161
|
+
#
|
|
151
162
|
# @!attribute [rw] guest_role_arn
|
|
152
163
|
# The ARN of the guest IAM role that is attached to the Amazon Cognito
|
|
153
164
|
# identity pool that is used to authorize the sending of data to RUM.
|
|
@@ -175,31 +186,14 @@ module Aws::CloudWatchRUM
|
|
|
175
186
|
# [2]: https://docs.aws.amazon.com/cognitoidentity/latest/APIReference/API_GetIdentityPoolRoles.html
|
|
176
187
|
# @return [String]
|
|
177
188
|
#
|
|
178
|
-
# @!attribute [rw]
|
|
179
|
-
#
|
|
180
|
-
#
|
|
181
|
-
#
|
|
182
|
-
#
|
|
183
|
-
#
|
|
184
|
-
#
|
|
185
|
-
#
|
|
186
|
-
#
|
|
187
|
-
# You can't include both `ExcludedPages` and `IncludedPages` in the
|
|
188
|
-
# same operation.
|
|
189
|
-
# @return [Array<String>]
|
|
190
|
-
#
|
|
191
|
-
# @!attribute [rw] session_sample_rate
|
|
192
|
-
# Specifies the portion of user sessions to use for RUM data
|
|
193
|
-
# collection. Choosing a higher portion gives you more data but also
|
|
194
|
-
# incurs more costs.
|
|
195
|
-
#
|
|
196
|
-
# The range for this value is 0 to 1 inclusive. Setting this to 1
|
|
197
|
-
# means that 100% of user sessions are sampled, and setting it to 0.1
|
|
198
|
-
# means that 10% of user sessions are sampled.
|
|
199
|
-
#
|
|
200
|
-
# If you omit this parameter, the default of 0.1 is used, and 10% of
|
|
201
|
-
# sessions will be sampled.
|
|
202
|
-
# @return [Float]
|
|
189
|
+
# @!attribute [rw] allow_cookies
|
|
190
|
+
# If you set this to `true`, the RUM web client sets two cookies, a
|
|
191
|
+
# session cookie and a user cookie. The cookies allow the RUM web
|
|
192
|
+
# client to collect data relating to the number of users an
|
|
193
|
+
# application has and the behavior of the application across a
|
|
194
|
+
# sequence of events. Cookies are stored in the top-level domain of
|
|
195
|
+
# the current page.
|
|
196
|
+
# @return [Boolean]
|
|
203
197
|
#
|
|
204
198
|
# @!attribute [rw] telemetries
|
|
205
199
|
# An array that lists the types of telemetry data that this app
|
|
@@ -216,32 +210,45 @@ module Aws::CloudWatchRUM
|
|
|
216
210
|
# by your application.
|
|
217
211
|
# @return [Array<String>]
|
|
218
212
|
#
|
|
213
|
+
# @!attribute [rw] enable_x_ray
|
|
214
|
+
# If you set this to `true`, RUM enables X-Ray tracing for the user
|
|
215
|
+
# sessions that RUM samples. RUM adds an X-Ray trace header to allowed
|
|
216
|
+
# HTTP requests. It also records an X-Ray segment for allowed HTTP
|
|
217
|
+
# requests. You can see traces and segments from these user sessions
|
|
218
|
+
# in the X-Ray console and the CloudWatch ServiceLens console. For
|
|
219
|
+
# more information, see [What is X-Ray?][1]
|
|
220
|
+
#
|
|
221
|
+
#
|
|
222
|
+
#
|
|
223
|
+
# [1]: https://docs.aws.amazon.com/xray/latest/devguide/aws-xray.html
|
|
224
|
+
# @return [Boolean]
|
|
225
|
+
#
|
|
219
226
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/AppMonitorConfiguration AWS API Documentation
|
|
220
227
|
#
|
|
221
228
|
class AppMonitorConfiguration < Struct.new(
|
|
222
|
-
:allow_cookies,
|
|
223
|
-
:enable_x_ray,
|
|
224
|
-
:excluded_pages,
|
|
225
|
-
:favorite_pages,
|
|
226
|
-
:guest_role_arn,
|
|
227
229
|
:identity_pool_id,
|
|
230
|
+
:excluded_pages,
|
|
228
231
|
:included_pages,
|
|
232
|
+
:favorite_pages,
|
|
229
233
|
:session_sample_rate,
|
|
230
|
-
:
|
|
234
|
+
:guest_role_arn,
|
|
235
|
+
:allow_cookies,
|
|
236
|
+
:telemetries,
|
|
237
|
+
:enable_x_ray)
|
|
231
238
|
SENSITIVE = []
|
|
232
239
|
include Aws::Structure
|
|
233
240
|
end
|
|
234
241
|
|
|
235
242
|
# A structure that contains information about the RUM app monitor.
|
|
236
243
|
#
|
|
237
|
-
# @!attribute [rw] id
|
|
238
|
-
# The unique ID of the app monitor.
|
|
239
|
-
# @return [String]
|
|
240
|
-
#
|
|
241
244
|
# @!attribute [rw] name
|
|
242
245
|
# The name of the app monitor.
|
|
243
246
|
# @return [String]
|
|
244
247
|
#
|
|
248
|
+
# @!attribute [rw] id
|
|
249
|
+
# The unique ID of the app monitor.
|
|
250
|
+
# @return [String]
|
|
251
|
+
#
|
|
245
252
|
# @!attribute [rw] version
|
|
246
253
|
# The version of the app monitor.
|
|
247
254
|
# @return [String]
|
|
@@ -249,8 +256,8 @@ module Aws::CloudWatchRUM
|
|
|
249
256
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/AppMonitorDetails AWS API Documentation
|
|
250
257
|
#
|
|
251
258
|
class AppMonitorDetails < Struct.new(
|
|
252
|
-
:id,
|
|
253
259
|
:name,
|
|
260
|
+
:id,
|
|
254
261
|
:version)
|
|
255
262
|
SENSITIVE = []
|
|
256
263
|
include Aws::Structure
|
|
@@ -259,35 +266,42 @@ module Aws::CloudWatchRUM
|
|
|
259
266
|
# A structure that includes some data about app monitors and their
|
|
260
267
|
# settings.
|
|
261
268
|
#
|
|
262
|
-
# @!attribute [rw]
|
|
263
|
-
# The
|
|
269
|
+
# @!attribute [rw] name
|
|
270
|
+
# The name of this app monitor.
|
|
264
271
|
# @return [String]
|
|
265
272
|
#
|
|
266
273
|
# @!attribute [rw] id
|
|
267
274
|
# The unique ID of this app monitor.
|
|
268
275
|
# @return [String]
|
|
269
276
|
#
|
|
277
|
+
# @!attribute [rw] created
|
|
278
|
+
# The date and time that the app monitor was created.
|
|
279
|
+
# @return [String]
|
|
280
|
+
#
|
|
270
281
|
# @!attribute [rw] last_modified
|
|
271
282
|
# The date and time of the most recent changes to this app monitor's
|
|
272
283
|
# configuration.
|
|
273
284
|
# @return [String]
|
|
274
285
|
#
|
|
275
|
-
# @!attribute [rw] name
|
|
276
|
-
# The name of this app monitor.
|
|
277
|
-
# @return [String]
|
|
278
|
-
#
|
|
279
286
|
# @!attribute [rw] state
|
|
280
287
|
# The current state of this app monitor.
|
|
281
288
|
# @return [String]
|
|
282
289
|
#
|
|
290
|
+
# @!attribute [rw] platform
|
|
291
|
+
# The platform type for this app monitor. Valid values are `Web` for
|
|
292
|
+
# web applications, `Android` for Android applications, and `iOS` for
|
|
293
|
+
# IOS applications.
|
|
294
|
+
# @return [String]
|
|
295
|
+
#
|
|
283
296
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/AppMonitorSummary AWS API Documentation
|
|
284
297
|
#
|
|
285
298
|
class AppMonitorSummary < Struct.new(
|
|
286
|
-
:
|
|
299
|
+
:name,
|
|
287
300
|
:id,
|
|
301
|
+
:created,
|
|
288
302
|
:last_modified,
|
|
289
|
-
:
|
|
290
|
-
:
|
|
303
|
+
:state,
|
|
304
|
+
:platform)
|
|
291
305
|
SENSITIVE = []
|
|
292
306
|
include Aws::Structure
|
|
293
307
|
end
|
|
@@ -299,6 +313,10 @@ module Aws::CloudWatchRUM
|
|
|
299
313
|
#
|
|
300
314
|
# [1]: https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_BatchCreateRumMetricsDefinitions.html
|
|
301
315
|
#
|
|
316
|
+
# @!attribute [rw] metric_definition
|
|
317
|
+
# The metric definition that caused this error.
|
|
318
|
+
# @return [Types::MetricDefinitionRequest]
|
|
319
|
+
#
|
|
302
320
|
# @!attribute [rw] error_code
|
|
303
321
|
# The error code.
|
|
304
322
|
# @return [String]
|
|
@@ -307,16 +325,12 @@ module Aws::CloudWatchRUM
|
|
|
307
325
|
# The error message for this metric definition.
|
|
308
326
|
# @return [String]
|
|
309
327
|
#
|
|
310
|
-
# @!attribute [rw] metric_definition
|
|
311
|
-
# The metric definition that caused this error.
|
|
312
|
-
# @return [Types::MetricDefinitionRequest]
|
|
313
|
-
#
|
|
314
328
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/BatchCreateRumMetricDefinitionsError AWS API Documentation
|
|
315
329
|
#
|
|
316
330
|
class BatchCreateRumMetricDefinitionsError < Struct.new(
|
|
331
|
+
:metric_definition,
|
|
317
332
|
:error_code,
|
|
318
|
-
:error_message
|
|
319
|
-
:metric_definition)
|
|
333
|
+
:error_message)
|
|
320
334
|
SENSITIVE = []
|
|
321
335
|
include Aws::Structure
|
|
322
336
|
end
|
|
@@ -388,6 +402,10 @@ module Aws::CloudWatchRUM
|
|
|
388
402
|
#
|
|
389
403
|
# [1]: https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_BatchDeleteRumMetricsDefinitions.html
|
|
390
404
|
#
|
|
405
|
+
# @!attribute [rw] metric_definition_id
|
|
406
|
+
# The ID of the metric definition that caused this error.
|
|
407
|
+
# @return [String]
|
|
408
|
+
#
|
|
391
409
|
# @!attribute [rw] error_code
|
|
392
410
|
# The error code.
|
|
393
411
|
# @return [String]
|
|
@@ -396,16 +414,12 @@ module Aws::CloudWatchRUM
|
|
|
396
414
|
# The error message for this metric definition.
|
|
397
415
|
# @return [String]
|
|
398
416
|
#
|
|
399
|
-
# @!attribute [rw] metric_definition_id
|
|
400
|
-
# The ID of the metric definition that caused this error.
|
|
401
|
-
# @return [String]
|
|
402
|
-
#
|
|
403
417
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/BatchDeleteRumMetricDefinitionsError AWS API Documentation
|
|
404
418
|
#
|
|
405
419
|
class BatchDeleteRumMetricDefinitionsError < Struct.new(
|
|
420
|
+
:metric_definition_id,
|
|
406
421
|
:error_code,
|
|
407
|
-
:error_message
|
|
408
|
-
:metric_definition_id)
|
|
422
|
+
:error_message)
|
|
409
423
|
SENSITIVE = []
|
|
410
424
|
include Aws::Structure
|
|
411
425
|
end
|
|
@@ -550,6 +564,42 @@ module Aws::CloudWatchRUM
|
|
|
550
564
|
include Aws::Structure
|
|
551
565
|
end
|
|
552
566
|
|
|
567
|
+
# @!attribute [rw] name
|
|
568
|
+
# A name for the app monitor.
|
|
569
|
+
# @return [String]
|
|
570
|
+
#
|
|
571
|
+
# @!attribute [rw] domain
|
|
572
|
+
# The top-level internet domain name for which your application has
|
|
573
|
+
# administrative authority.
|
|
574
|
+
# @return [String]
|
|
575
|
+
#
|
|
576
|
+
# @!attribute [rw] domain_list
|
|
577
|
+
# List the domain names for which your application has administrative
|
|
578
|
+
# authority. The `CreateAppMonitor` requires either the domain or the
|
|
579
|
+
# domain list.
|
|
580
|
+
# @return [Array<String>]
|
|
581
|
+
#
|
|
582
|
+
# @!attribute [rw] tags
|
|
583
|
+
# Assigns one or more tags (key-value pairs) to the app monitor.
|
|
584
|
+
#
|
|
585
|
+
# Tags can help you organize and categorize your resources. You can
|
|
586
|
+
# also use them to scope user permissions by granting a user
|
|
587
|
+
# permission to access or change only resources with certain tag
|
|
588
|
+
# values.
|
|
589
|
+
#
|
|
590
|
+
# Tags don't have any semantic meaning to Amazon Web Services and are
|
|
591
|
+
# interpreted strictly as strings of characters.
|
|
592
|
+
#
|
|
593
|
+
# You can associate as many as 50 tags with an app monitor.
|
|
594
|
+
#
|
|
595
|
+
# For more information, see [Tagging Amazon Web Services
|
|
596
|
+
# resources][1].
|
|
597
|
+
#
|
|
598
|
+
#
|
|
599
|
+
#
|
|
600
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
|
601
|
+
# @return [Hash<String,String>]
|
|
602
|
+
#
|
|
553
603
|
# @!attribute [rw] app_monitor_configuration
|
|
554
604
|
# A structure that contains much of the configuration data for the app
|
|
555
605
|
# monitor. If you are using Amazon Cognito for authorization, you must
|
|
@@ -567,6 +617,16 @@ module Aws::CloudWatchRUM
|
|
|
567
617
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-get-started-authorization.html
|
|
568
618
|
# @return [Types::AppMonitorConfiguration]
|
|
569
619
|
#
|
|
620
|
+
# @!attribute [rw] cw_log_enabled
|
|
621
|
+
# Data collected by RUM is kept by RUM for 30 days and then deleted.
|
|
622
|
+
# This parameter specifies whether RUM sends a copy of this telemetry
|
|
623
|
+
# data to Amazon CloudWatch Logs in your account. This enables you to
|
|
624
|
+
# keep the telemetry data for more than 30 days, but it does incur
|
|
625
|
+
# Amazon CloudWatch Logs charges.
|
|
626
|
+
#
|
|
627
|
+
# If you omit this parameter, the default is `false`.
|
|
628
|
+
# @return [Boolean]
|
|
629
|
+
#
|
|
570
630
|
# @!attribute [rw] custom_events
|
|
571
631
|
# Specifies whether this app monitor allows the web client to define
|
|
572
632
|
# and send custom events. If you omit this parameter, custom events
|
|
@@ -580,68 +640,29 @@ module Aws::CloudWatchRUM
|
|
|
580
640
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-custom-events.html
|
|
581
641
|
# @return [Types::CustomEvents]
|
|
582
642
|
#
|
|
583
|
-
# @!attribute [rw] cw_log_enabled
|
|
584
|
-
# Data collected by RUM is kept by RUM for 30 days and then deleted.
|
|
585
|
-
# This parameter specifies whether RUM sends a copy of this telemetry
|
|
586
|
-
# data to Amazon CloudWatch Logs in your account. This enables you to
|
|
587
|
-
# keep the telemetry data for more than 30 days, but it does incur
|
|
588
|
-
# Amazon CloudWatch Logs charges.
|
|
589
|
-
#
|
|
590
|
-
# If you omit this parameter, the default is `false`.
|
|
591
|
-
# @return [Boolean]
|
|
592
|
-
#
|
|
593
643
|
# @!attribute [rw] deobfuscation_configuration
|
|
594
644
|
# A structure that contains the configuration for how an app monitor
|
|
595
645
|
# can deobfuscate stack traces.
|
|
596
646
|
# @return [Types::DeobfuscationConfiguration]
|
|
597
647
|
#
|
|
598
|
-
# @!attribute [rw]
|
|
599
|
-
# The
|
|
600
|
-
#
|
|
648
|
+
# @!attribute [rw] platform
|
|
649
|
+
# The platform type for the app monitor. Valid values are `Web` for
|
|
650
|
+
# web applications, `Android` for Android applications, and `iOS` for
|
|
651
|
+
# IOS applications. If you omit this parameter, the default is `Web`.
|
|
601
652
|
# @return [String]
|
|
602
653
|
#
|
|
603
|
-
# @!attribute [rw] domain_list
|
|
604
|
-
# List the domain names for which your application has administrative
|
|
605
|
-
# authority. The `CreateAppMonitor` requires either the domain or the
|
|
606
|
-
# domain list.
|
|
607
|
-
# @return [Array<String>]
|
|
608
|
-
#
|
|
609
|
-
# @!attribute [rw] name
|
|
610
|
-
# A name for the app monitor.
|
|
611
|
-
# @return [String]
|
|
612
|
-
#
|
|
613
|
-
# @!attribute [rw] tags
|
|
614
|
-
# Assigns one or more tags (key-value pairs) to the app monitor.
|
|
615
|
-
#
|
|
616
|
-
# Tags can help you organize and categorize your resources. You can
|
|
617
|
-
# also use them to scope user permissions by granting a user
|
|
618
|
-
# permission to access or change only resources with certain tag
|
|
619
|
-
# values.
|
|
620
|
-
#
|
|
621
|
-
# Tags don't have any semantic meaning to Amazon Web Services and are
|
|
622
|
-
# interpreted strictly as strings of characters.
|
|
623
|
-
#
|
|
624
|
-
# You can associate as many as 50 tags with an app monitor.
|
|
625
|
-
#
|
|
626
|
-
# For more information, see [Tagging Amazon Web Services
|
|
627
|
-
# resources][1].
|
|
628
|
-
#
|
|
629
|
-
#
|
|
630
|
-
#
|
|
631
|
-
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
|
632
|
-
# @return [Hash<String,String>]
|
|
633
|
-
#
|
|
634
654
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/CreateAppMonitorRequest AWS API Documentation
|
|
635
655
|
#
|
|
636
656
|
class CreateAppMonitorRequest < Struct.new(
|
|
657
|
+
:name,
|
|
658
|
+
:domain,
|
|
659
|
+
:domain_list,
|
|
660
|
+
:tags,
|
|
637
661
|
:app_monitor_configuration,
|
|
638
|
-
:custom_events,
|
|
639
662
|
:cw_log_enabled,
|
|
663
|
+
:custom_events,
|
|
640
664
|
:deobfuscation_configuration,
|
|
641
|
-
:
|
|
642
|
-
:domain_list,
|
|
643
|
-
:name,
|
|
644
|
-
:tags)
|
|
665
|
+
:platform)
|
|
645
666
|
SENSITIVE = []
|
|
646
667
|
include Aws::Structure
|
|
647
668
|
end
|
|
@@ -813,6 +834,16 @@ module Aws::CloudWatchRUM
|
|
|
813
834
|
include Aws::Structure
|
|
814
835
|
end
|
|
815
836
|
|
|
837
|
+
# @!attribute [rw] name
|
|
838
|
+
# The name of the app monitor that collected the data that you want to
|
|
839
|
+
# retrieve.
|
|
840
|
+
# @return [String]
|
|
841
|
+
#
|
|
842
|
+
# @!attribute [rw] time_range
|
|
843
|
+
# A structure that defines the time range that you want to retrieve
|
|
844
|
+
# results from.
|
|
845
|
+
# @return [Types::TimeRange]
|
|
846
|
+
#
|
|
816
847
|
# @!attribute [rw] filters
|
|
817
848
|
# An array of structures that you can use to filter the results to
|
|
818
849
|
# those that match one or more sets of key-value pairs that you
|
|
@@ -823,29 +854,19 @@ module Aws::CloudWatchRUM
|
|
|
823
854
|
# The maximum number of results to return in one operation.
|
|
824
855
|
# @return [Integer]
|
|
825
856
|
#
|
|
826
|
-
# @!attribute [rw] name
|
|
827
|
-
# The name of the app monitor that collected the data that you want to
|
|
828
|
-
# retrieve.
|
|
829
|
-
# @return [String]
|
|
830
|
-
#
|
|
831
857
|
# @!attribute [rw] next_token
|
|
832
858
|
# Use the token returned by the previous operation to request the next
|
|
833
859
|
# page of results.
|
|
834
860
|
# @return [String]
|
|
835
861
|
#
|
|
836
|
-
# @!attribute [rw] time_range
|
|
837
|
-
# A structure that defines the time range that you want to retrieve
|
|
838
|
-
# results from.
|
|
839
|
-
# @return [Types::TimeRange]
|
|
840
|
-
#
|
|
841
862
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/GetAppMonitorDataRequest AWS API Documentation
|
|
842
863
|
#
|
|
843
864
|
class GetAppMonitorDataRequest < Struct.new(
|
|
865
|
+
:name,
|
|
866
|
+
:time_range,
|
|
844
867
|
:filters,
|
|
845
868
|
:max_results,
|
|
846
|
-
:
|
|
847
|
-
:next_token,
|
|
848
|
-
:time_range)
|
|
869
|
+
:next_token)
|
|
849
870
|
SENSITIVE = []
|
|
850
871
|
include Aws::Structure
|
|
851
872
|
end
|
|
@@ -959,22 +980,22 @@ module Aws::CloudWatchRUM
|
|
|
959
980
|
# A structure that contains the configuration for how an app monitor can
|
|
960
981
|
# unminify JavaScript error stack traces using source maps.
|
|
961
982
|
#
|
|
962
|
-
# @!attribute [rw] s3_uri
|
|
963
|
-
# The S3Uri of the bucket or folder that stores the source map files.
|
|
964
|
-
# It is required if status is ENABLED.
|
|
965
|
-
# @return [String]
|
|
966
|
-
#
|
|
967
983
|
# @!attribute [rw] status
|
|
968
984
|
# Specifies whether JavaScript error stack traces should be unminified
|
|
969
985
|
# for this app monitor. The default is for JavaScript error stack
|
|
970
986
|
# trace unminification to be `DISABLED`.
|
|
971
987
|
# @return [String]
|
|
972
988
|
#
|
|
989
|
+
# @!attribute [rw] s3_uri
|
|
990
|
+
# The S3Uri of the bucket or folder that stores the source map files.
|
|
991
|
+
# It is required if status is ENABLED.
|
|
992
|
+
# @return [String]
|
|
993
|
+
#
|
|
973
994
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/JavaScriptSourceMaps AWS API Documentation
|
|
974
995
|
#
|
|
975
996
|
class JavaScriptSourceMaps < Struct.new(
|
|
976
|
-
:
|
|
977
|
-
:
|
|
997
|
+
:status,
|
|
998
|
+
:s3_uri)
|
|
978
999
|
SENSITIVE = []
|
|
979
1000
|
include Aws::Structure
|
|
980
1001
|
end
|
|
@@ -998,21 +1019,21 @@ module Aws::CloudWatchRUM
|
|
|
998
1019
|
include Aws::Structure
|
|
999
1020
|
end
|
|
1000
1021
|
|
|
1001
|
-
# @!attribute [rw] app_monitor_summaries
|
|
1002
|
-
# An array of structures that contain information about the returned
|
|
1003
|
-
# app monitors.
|
|
1004
|
-
# @return [Array<Types::AppMonitorSummary>]
|
|
1005
|
-
#
|
|
1006
1022
|
# @!attribute [rw] next_token
|
|
1007
1023
|
# A token that you can use in a subsequent operation to retrieve the
|
|
1008
1024
|
# next set of results.
|
|
1009
1025
|
# @return [String]
|
|
1010
1026
|
#
|
|
1027
|
+
# @!attribute [rw] app_monitor_summaries
|
|
1028
|
+
# An array of structures that contain information about the returned
|
|
1029
|
+
# app monitors.
|
|
1030
|
+
# @return [Array<Types::AppMonitorSummary>]
|
|
1031
|
+
#
|
|
1011
1032
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/ListAppMonitorsResponse AWS API Documentation
|
|
1012
1033
|
#
|
|
1013
1034
|
class ListAppMonitorsResponse < Struct.new(
|
|
1014
|
-
:
|
|
1015
|
-
:
|
|
1035
|
+
:next_token,
|
|
1036
|
+
:app_monitor_summaries)
|
|
1016
1037
|
SENSITIVE = []
|
|
1017
1038
|
include Aws::Structure
|
|
1018
1039
|
end
|
|
@@ -1116,6 +1137,24 @@ module Aws::CloudWatchRUM
|
|
|
1116
1137
|
#
|
|
1117
1138
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-vended-metrics.html
|
|
1118
1139
|
#
|
|
1140
|
+
# @!attribute [rw] metric_definition_id
|
|
1141
|
+
# The ID of this metric definition.
|
|
1142
|
+
# @return [String]
|
|
1143
|
+
#
|
|
1144
|
+
# @!attribute [rw] name
|
|
1145
|
+
# The name of the metric that is defined in this structure.
|
|
1146
|
+
# @return [String]
|
|
1147
|
+
#
|
|
1148
|
+
# @!attribute [rw] value_key
|
|
1149
|
+
# The field within the event object that the metric value is sourced
|
|
1150
|
+
# from.
|
|
1151
|
+
# @return [String]
|
|
1152
|
+
#
|
|
1153
|
+
# @!attribute [rw] unit_label
|
|
1154
|
+
# Use this field only if you are sending this metric to CloudWatch. It
|
|
1155
|
+
# defines the CloudWatch metric unit that this metric is measured in.
|
|
1156
|
+
# @return [String]
|
|
1157
|
+
#
|
|
1119
1158
|
# @!attribute [rw] dimension_keys
|
|
1120
1159
|
# This field is a map of field paths to dimension names. It defines
|
|
1121
1160
|
# the dimensions to associate with this metric in CloudWatch The value
|
|
@@ -1127,19 +1166,11 @@ module Aws::CloudWatchRUM
|
|
|
1127
1166
|
# @!attribute [rw] event_pattern
|
|
1128
1167
|
# The pattern that defines the metric. RUM checks events that happen
|
|
1129
1168
|
# in a user's session against the pattern, and events that match the
|
|
1130
|
-
# pattern are sent to the metric destination.
|
|
1131
|
-
#
|
|
1132
|
-
# If the metrics destination is `CloudWatch` and the event also
|
|
1133
|
-
# matches a value in `DimensionKeys`, then the metric is published
|
|
1134
|
-
# with the specified dimensions.
|
|
1135
|
-
# @return [String]
|
|
1136
|
-
#
|
|
1137
|
-
# @!attribute [rw] metric_definition_id
|
|
1138
|
-
# The ID of this metric definition.
|
|
1139
|
-
# @return [String]
|
|
1169
|
+
# pattern are sent to the metric destination.
|
|
1140
1170
|
#
|
|
1141
|
-
#
|
|
1142
|
-
#
|
|
1171
|
+
# If the metrics destination is `CloudWatch` and the event also
|
|
1172
|
+
# matches a value in `DimensionKeys`, then the metric is published
|
|
1173
|
+
# with the specified dimensions.
|
|
1143
1174
|
# @return [String]
|
|
1144
1175
|
#
|
|
1145
1176
|
# @!attribute [rw] namespace
|
|
@@ -1148,26 +1179,16 @@ module Aws::CloudWatchRUM
|
|
|
1148
1179
|
# custom metric is published to.
|
|
1149
1180
|
# @return [String]
|
|
1150
1181
|
#
|
|
1151
|
-
# @!attribute [rw] unit_label
|
|
1152
|
-
# Use this field only if you are sending this metric to CloudWatch. It
|
|
1153
|
-
# defines the CloudWatch metric unit that this metric is measured in.
|
|
1154
|
-
# @return [String]
|
|
1155
|
-
#
|
|
1156
|
-
# @!attribute [rw] value_key
|
|
1157
|
-
# The field within the event object that the metric value is sourced
|
|
1158
|
-
# from.
|
|
1159
|
-
# @return [String]
|
|
1160
|
-
#
|
|
1161
1182
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/MetricDefinition AWS API Documentation
|
|
1162
1183
|
#
|
|
1163
1184
|
class MetricDefinition < Struct.new(
|
|
1164
|
-
:dimension_keys,
|
|
1165
|
-
:event_pattern,
|
|
1166
1185
|
:metric_definition_id,
|
|
1167
1186
|
:name,
|
|
1168
|
-
:
|
|
1187
|
+
:value_key,
|
|
1169
1188
|
:unit_label,
|
|
1170
|
-
:
|
|
1189
|
+
:dimension_keys,
|
|
1190
|
+
:event_pattern,
|
|
1191
|
+
:namespace)
|
|
1171
1192
|
SENSITIVE = []
|
|
1172
1193
|
include Aws::Structure
|
|
1173
1194
|
end
|
|
@@ -1316,6 +1337,52 @@ module Aws::CloudWatchRUM
|
|
|
1316
1337
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-custom-and-extended-metrics.html
|
|
1317
1338
|
# [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-datacollected.html#CloudWatch-RUM-datacollected-eventDetails
|
|
1318
1339
|
#
|
|
1340
|
+
# @!attribute [rw] name
|
|
1341
|
+
# The name for the metric that is defined in this structure. For
|
|
1342
|
+
# custom metrics, you can specify any name that you like. For extended
|
|
1343
|
+
# metrics, valid values are the following:
|
|
1344
|
+
#
|
|
1345
|
+
# * `PerformanceNavigationDuration`
|
|
1346
|
+
#
|
|
1347
|
+
# * `PerformanceResourceDuration `
|
|
1348
|
+
#
|
|
1349
|
+
# * `NavigationSatisfiedTransaction`
|
|
1350
|
+
#
|
|
1351
|
+
# * `NavigationToleratedTransaction`
|
|
1352
|
+
#
|
|
1353
|
+
# * `NavigationFrustratedTransaction`
|
|
1354
|
+
#
|
|
1355
|
+
# * `WebVitalsCumulativeLayoutShift`
|
|
1356
|
+
#
|
|
1357
|
+
# * `WebVitalsFirstInputDelay`
|
|
1358
|
+
#
|
|
1359
|
+
# * `WebVitalsLargestContentfulPaint`
|
|
1360
|
+
#
|
|
1361
|
+
# * `JsErrorCount`
|
|
1362
|
+
#
|
|
1363
|
+
# * `HttpErrorCount`
|
|
1364
|
+
#
|
|
1365
|
+
# * `SessionCount`
|
|
1366
|
+
# @return [String]
|
|
1367
|
+
#
|
|
1368
|
+
# @!attribute [rw] value_key
|
|
1369
|
+
# The field within the event object that the metric value is sourced
|
|
1370
|
+
# from.
|
|
1371
|
+
#
|
|
1372
|
+
# If you omit this field, a hardcoded value of 1 is pushed as the
|
|
1373
|
+
# metric value. This is useful if you want to count the number of
|
|
1374
|
+
# events that the filter catches.
|
|
1375
|
+
#
|
|
1376
|
+
# If this metric is sent to CloudWatch Evidently, this field will be
|
|
1377
|
+
# passed to Evidently raw. Evidently will handle data extraction from
|
|
1378
|
+
# the event.
|
|
1379
|
+
# @return [String]
|
|
1380
|
+
#
|
|
1381
|
+
# @!attribute [rw] unit_label
|
|
1382
|
+
# The CloudWatch metric unit to use for this metric. If you omit this
|
|
1383
|
+
# field, the metric is recorded with no unit.
|
|
1384
|
+
# @return [String]
|
|
1385
|
+
#
|
|
1319
1386
|
# @!attribute [rw] dimension_keys
|
|
1320
1387
|
# Use this field only if you are sending the metric to CloudWatch.
|
|
1321
1388
|
#
|
|
@@ -1369,34 +1436,6 @@ module Aws::CloudWatchRUM
|
|
|
1369
1436
|
# with the specified dimensions.
|
|
1370
1437
|
# @return [String]
|
|
1371
1438
|
#
|
|
1372
|
-
# @!attribute [rw] name
|
|
1373
|
-
# The name for the metric that is defined in this structure. For
|
|
1374
|
-
# custom metrics, you can specify any name that you like. For extended
|
|
1375
|
-
# metrics, valid values are the following:
|
|
1376
|
-
#
|
|
1377
|
-
# * `PerformanceNavigationDuration`
|
|
1378
|
-
#
|
|
1379
|
-
# * `PerformanceResourceDuration `
|
|
1380
|
-
#
|
|
1381
|
-
# * `NavigationSatisfiedTransaction`
|
|
1382
|
-
#
|
|
1383
|
-
# * `NavigationToleratedTransaction`
|
|
1384
|
-
#
|
|
1385
|
-
# * `NavigationFrustratedTransaction`
|
|
1386
|
-
#
|
|
1387
|
-
# * `WebVitalsCumulativeLayoutShift`
|
|
1388
|
-
#
|
|
1389
|
-
# * `WebVitalsFirstInputDelay`
|
|
1390
|
-
#
|
|
1391
|
-
# * `WebVitalsLargestContentfulPaint`
|
|
1392
|
-
#
|
|
1393
|
-
# * `JsErrorCount`
|
|
1394
|
-
#
|
|
1395
|
-
# * `HttpErrorCount`
|
|
1396
|
-
#
|
|
1397
|
-
# * `SessionCount`
|
|
1398
|
-
# @return [String]
|
|
1399
|
-
#
|
|
1400
1439
|
# @!attribute [rw] namespace
|
|
1401
1440
|
# If this structure is for a custom metric instead of an extended
|
|
1402
1441
|
# metrics, use this parameter to define the metric namespace for that
|
|
@@ -1407,33 +1446,15 @@ module Aws::CloudWatchRUM
|
|
|
1407
1446
|
# namespace.
|
|
1408
1447
|
# @return [String]
|
|
1409
1448
|
#
|
|
1410
|
-
# @!attribute [rw] unit_label
|
|
1411
|
-
# The CloudWatch metric unit to use for this metric. If you omit this
|
|
1412
|
-
# field, the metric is recorded with no unit.
|
|
1413
|
-
# @return [String]
|
|
1414
|
-
#
|
|
1415
|
-
# @!attribute [rw] value_key
|
|
1416
|
-
# The field within the event object that the metric value is sourced
|
|
1417
|
-
# from.
|
|
1418
|
-
#
|
|
1419
|
-
# If you omit this field, a hardcoded value of 1 is pushed as the
|
|
1420
|
-
# metric value. This is useful if you want to count the number of
|
|
1421
|
-
# events that the filter catches.
|
|
1422
|
-
#
|
|
1423
|
-
# If this metric is sent to CloudWatch Evidently, this field will be
|
|
1424
|
-
# passed to Evidently raw. Evidently will handle data extraction from
|
|
1425
|
-
# the event.
|
|
1426
|
-
# @return [String]
|
|
1427
|
-
#
|
|
1428
1449
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/MetricDefinitionRequest AWS API Documentation
|
|
1429
1450
|
#
|
|
1430
1451
|
class MetricDefinitionRequest < Struct.new(
|
|
1431
|
-
:dimension_keys,
|
|
1432
|
-
:event_pattern,
|
|
1433
1452
|
:name,
|
|
1434
|
-
:
|
|
1453
|
+
:value_key,
|
|
1435
1454
|
:unit_label,
|
|
1436
|
-
:
|
|
1455
|
+
:dimension_keys,
|
|
1456
|
+
:event_pattern,
|
|
1457
|
+
:namespace)
|
|
1437
1458
|
SENSITIVE = []
|
|
1438
1459
|
include Aws::Structure
|
|
1439
1460
|
end
|
|
@@ -1550,16 +1571,12 @@ module Aws::CloudWatchRUM
|
|
|
1550
1571
|
include Aws::Structure
|
|
1551
1572
|
end
|
|
1552
1573
|
|
|
1553
|
-
# @!attribute [rw]
|
|
1554
|
-
#
|
|
1555
|
-
#
|
|
1556
|
-
# alias here. This alias will be compared to the `rum:alias` context
|
|
1557
|
-
# key in the resource-based policy. For more information, see [Using
|
|
1558
|
-
# resource-based policies with CloudWatch RUM][1].
|
|
1559
|
-
#
|
|
1560
|
-
#
|
|
1574
|
+
# @!attribute [rw] id
|
|
1575
|
+
# The ID of the app monitor that is sending this data.
|
|
1576
|
+
# @return [String]
|
|
1561
1577
|
#
|
|
1562
|
-
#
|
|
1578
|
+
# @!attribute [rw] batch_id
|
|
1579
|
+
# A unique identifier for this batch of RUM event data.
|
|
1563
1580
|
# @return [String]
|
|
1564
1581
|
#
|
|
1565
1582
|
# @!attribute [rw] app_monitor_details
|
|
@@ -1567,32 +1584,36 @@ module Aws::CloudWatchRUM
|
|
|
1567
1584
|
# collected this telemetry information.
|
|
1568
1585
|
# @return [Types::AppMonitorDetails]
|
|
1569
1586
|
#
|
|
1570
|
-
# @!attribute [rw]
|
|
1571
|
-
# A
|
|
1572
|
-
#
|
|
1573
|
-
#
|
|
1574
|
-
# @!attribute [rw] id
|
|
1575
|
-
# The ID of the app monitor that is sending this data.
|
|
1576
|
-
# @return [String]
|
|
1587
|
+
# @!attribute [rw] user_details
|
|
1588
|
+
# A structure that contains information about the user session that
|
|
1589
|
+
# this batch of events was collected from.
|
|
1590
|
+
# @return [Types::UserDetails]
|
|
1577
1591
|
#
|
|
1578
1592
|
# @!attribute [rw] rum_events
|
|
1579
1593
|
# An array of structures that contain the telemetry event data.
|
|
1580
1594
|
# @return [Array<Types::RumEvent>]
|
|
1581
1595
|
#
|
|
1582
|
-
# @!attribute [rw]
|
|
1583
|
-
#
|
|
1584
|
-
#
|
|
1585
|
-
#
|
|
1596
|
+
# @!attribute [rw] alias
|
|
1597
|
+
# If the app monitor uses a resource-based policy that requires
|
|
1598
|
+
# `PutRumEvents` requests to specify a certain alias, specify that
|
|
1599
|
+
# alias here. This alias will be compared to the `rum:alias` context
|
|
1600
|
+
# key in the resource-based policy. For more information, see [Using
|
|
1601
|
+
# resource-based policies with CloudWatch RUM][1].
|
|
1602
|
+
#
|
|
1603
|
+
#
|
|
1604
|
+
#
|
|
1605
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-resource-policies.html
|
|
1606
|
+
# @return [String]
|
|
1586
1607
|
#
|
|
1587
1608
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/PutRumEventsRequest AWS API Documentation
|
|
1588
1609
|
#
|
|
1589
1610
|
class PutRumEventsRequest < Struct.new(
|
|
1590
|
-
:alias,
|
|
1591
|
-
:app_monitor_details,
|
|
1592
|
-
:batch_id,
|
|
1593
1611
|
:id,
|
|
1612
|
+
:batch_id,
|
|
1613
|
+
:app_monitor_details,
|
|
1614
|
+
:user_details,
|
|
1594
1615
|
:rum_events,
|
|
1595
|
-
:
|
|
1616
|
+
:alias)
|
|
1596
1617
|
SENSITIVE = []
|
|
1597
1618
|
include Aws::Structure
|
|
1598
1619
|
end
|
|
@@ -1716,21 +1737,10 @@ module Aws::CloudWatchRUM
|
|
|
1716
1737
|
# A structure that contains the information for one performance event
|
|
1717
1738
|
# that RUM collects from a user session with your application.
|
|
1718
1739
|
#
|
|
1719
|
-
# @!attribute [rw] details
|
|
1720
|
-
# A string containing details about the event.
|
|
1721
|
-
# @return [String]
|
|
1722
|
-
#
|
|
1723
1740
|
# @!attribute [rw] id
|
|
1724
1741
|
# A unique ID for this event.
|
|
1725
1742
|
# @return [String]
|
|
1726
1743
|
#
|
|
1727
|
-
# @!attribute [rw] metadata
|
|
1728
|
-
# Metadata about this event, which contains a JSON serialization of
|
|
1729
|
-
# the identity of the user for this session. The user information
|
|
1730
|
-
# comes from information such as the HTTP user-agent request header
|
|
1731
|
-
# and document interface.
|
|
1732
|
-
# @return [String]
|
|
1733
|
-
#
|
|
1734
1744
|
# @!attribute [rw] timestamp
|
|
1735
1745
|
# The exact time that this event occurred.
|
|
1736
1746
|
# @return [Time]
|
|
@@ -1740,14 +1750,25 @@ module Aws::CloudWatchRUM
|
|
|
1740
1750
|
# page load or a new session.
|
|
1741
1751
|
# @return [String]
|
|
1742
1752
|
#
|
|
1753
|
+
# @!attribute [rw] metadata
|
|
1754
|
+
# Metadata about this event, which contains a JSON serialization of
|
|
1755
|
+
# the identity of the user for this session. The user information
|
|
1756
|
+
# comes from information such as the HTTP user-agent request header
|
|
1757
|
+
# and document interface.
|
|
1758
|
+
# @return [String]
|
|
1759
|
+
#
|
|
1760
|
+
# @!attribute [rw] details
|
|
1761
|
+
# A string containing details about the event.
|
|
1762
|
+
# @return [String]
|
|
1763
|
+
#
|
|
1743
1764
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/RumEvent AWS API Documentation
|
|
1744
1765
|
#
|
|
1745
1766
|
class RumEvent < Struct.new(
|
|
1746
|
-
:details,
|
|
1747
1767
|
:id,
|
|
1748
|
-
:metadata,
|
|
1749
1768
|
:timestamp,
|
|
1750
|
-
:type
|
|
1769
|
+
:type,
|
|
1770
|
+
:metadata,
|
|
1771
|
+
:details)
|
|
1751
1772
|
SENSITIVE = []
|
|
1752
1773
|
include Aws::Structure
|
|
1753
1774
|
end
|
|
@@ -1791,6 +1812,10 @@ module Aws::CloudWatchRUM
|
|
|
1791
1812
|
# @!attribute [rw] message
|
|
1792
1813
|
# @return [String]
|
|
1793
1814
|
#
|
|
1815
|
+
# @!attribute [rw] service_code
|
|
1816
|
+
# The ID of the service that is associated with the error.
|
|
1817
|
+
# @return [String]
|
|
1818
|
+
#
|
|
1794
1819
|
# @!attribute [rw] quota_code
|
|
1795
1820
|
# The ID of the service quota that was exceeded.
|
|
1796
1821
|
# @return [String]
|
|
@@ -1799,17 +1824,13 @@ module Aws::CloudWatchRUM
|
|
|
1799
1824
|
# The value of a parameter in the request caused an error.
|
|
1800
1825
|
# @return [Integer]
|
|
1801
1826
|
#
|
|
1802
|
-
# @!attribute [rw] service_code
|
|
1803
|
-
# The ID of the service that is associated with the error.
|
|
1804
|
-
# @return [String]
|
|
1805
|
-
#
|
|
1806
1827
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/ThrottlingException AWS API Documentation
|
|
1807
1828
|
#
|
|
1808
1829
|
class ThrottlingException < Struct.new(
|
|
1809
1830
|
:message,
|
|
1831
|
+
:service_code,
|
|
1810
1832
|
:quota_code,
|
|
1811
|
-
:retry_after_seconds
|
|
1812
|
-
:service_code)
|
|
1833
|
+
:retry_after_seconds)
|
|
1813
1834
|
SENSITIVE = []
|
|
1814
1835
|
include Aws::Structure
|
|
1815
1836
|
end
|
|
@@ -1858,6 +1879,21 @@ module Aws::CloudWatchRUM
|
|
|
1858
1879
|
#
|
|
1859
1880
|
class UntagResourceResponse < Aws::EmptyStructure; end
|
|
1860
1881
|
|
|
1882
|
+
# @!attribute [rw] name
|
|
1883
|
+
# The name of the app monitor to update.
|
|
1884
|
+
# @return [String]
|
|
1885
|
+
#
|
|
1886
|
+
# @!attribute [rw] domain
|
|
1887
|
+
# The top-level internet domain name for which your application has
|
|
1888
|
+
# administrative authority.
|
|
1889
|
+
# @return [String]
|
|
1890
|
+
#
|
|
1891
|
+
# @!attribute [rw] domain_list
|
|
1892
|
+
# List the domain names for which your application has administrative
|
|
1893
|
+
# authority. The `UpdateAppMonitor` allows either the domain or the
|
|
1894
|
+
# domain list.
|
|
1895
|
+
# @return [Array<String>]
|
|
1896
|
+
#
|
|
1861
1897
|
# @!attribute [rw] app_monitor_configuration
|
|
1862
1898
|
# A structure that contains much of the configuration data for the app
|
|
1863
1899
|
# monitor. If you are using Amazon Cognito for authorization, you must
|
|
@@ -1872,6 +1908,14 @@ module Aws::CloudWatchRUM
|
|
|
1872
1908
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-get-started-authorization.html
|
|
1873
1909
|
# @return [Types::AppMonitorConfiguration]
|
|
1874
1910
|
#
|
|
1911
|
+
# @!attribute [rw] cw_log_enabled
|
|
1912
|
+
# Data collected by RUM is kept by RUM for 30 days and then deleted.
|
|
1913
|
+
# This parameter specifies whether RUM sends a copy of this telemetry
|
|
1914
|
+
# data to Amazon CloudWatch Logs in your account. This enables you to
|
|
1915
|
+
# keep the telemetry data for more than 30 days, but it does incur
|
|
1916
|
+
# Amazon CloudWatch Logs charges.
|
|
1917
|
+
# @return [Boolean]
|
|
1918
|
+
#
|
|
1875
1919
|
# @!attribute [rw] custom_events
|
|
1876
1920
|
# Specifies whether this app monitor allows the web client to define
|
|
1877
1921
|
# and send custom events. The default is for custom events to be
|
|
@@ -1885,44 +1929,21 @@ module Aws::CloudWatchRUM
|
|
|
1885
1929
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-custom-events.html
|
|
1886
1930
|
# @return [Types::CustomEvents]
|
|
1887
1931
|
#
|
|
1888
|
-
# @!attribute [rw] cw_log_enabled
|
|
1889
|
-
# Data collected by RUM is kept by RUM for 30 days and then deleted.
|
|
1890
|
-
# This parameter specifies whether RUM sends a copy of this telemetry
|
|
1891
|
-
# data to Amazon CloudWatch Logs in your account. This enables you to
|
|
1892
|
-
# keep the telemetry data for more than 30 days, but it does incur
|
|
1893
|
-
# Amazon CloudWatch Logs charges.
|
|
1894
|
-
# @return [Boolean]
|
|
1895
|
-
#
|
|
1896
1932
|
# @!attribute [rw] deobfuscation_configuration
|
|
1897
1933
|
# A structure that contains the configuration for how an app monitor
|
|
1898
1934
|
# can deobfuscate stack traces.
|
|
1899
1935
|
# @return [Types::DeobfuscationConfiguration]
|
|
1900
1936
|
#
|
|
1901
|
-
# @!attribute [rw] domain
|
|
1902
|
-
# The top-level internet domain name for which your application has
|
|
1903
|
-
# administrative authority.
|
|
1904
|
-
# @return [String]
|
|
1905
|
-
#
|
|
1906
|
-
# @!attribute [rw] domain_list
|
|
1907
|
-
# List the domain names for which your application has administrative
|
|
1908
|
-
# authority. The `UpdateAppMonitor` allows either the domain or the
|
|
1909
|
-
# domain list.
|
|
1910
|
-
# @return [Array<String>]
|
|
1911
|
-
#
|
|
1912
|
-
# @!attribute [rw] name
|
|
1913
|
-
# The name of the app monitor to update.
|
|
1914
|
-
# @return [String]
|
|
1915
|
-
#
|
|
1916
1937
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/UpdateAppMonitorRequest AWS API Documentation
|
|
1917
1938
|
#
|
|
1918
1939
|
class UpdateAppMonitorRequest < Struct.new(
|
|
1919
|
-
:
|
|
1920
|
-
:custom_events,
|
|
1921
|
-
:cw_log_enabled,
|
|
1922
|
-
:deobfuscation_configuration,
|
|
1940
|
+
:name,
|
|
1923
1941
|
:domain,
|
|
1924
1942
|
:domain_list,
|
|
1925
|
-
:
|
|
1943
|
+
:app_monitor_configuration,
|
|
1944
|
+
:cw_log_enabled,
|
|
1945
|
+
:custom_events,
|
|
1946
|
+
:deobfuscation_configuration)
|
|
1926
1947
|
SENSITIVE = []
|
|
1927
1948
|
include Aws::Structure
|
|
1928
1949
|
end
|
|
@@ -1985,21 +2006,21 @@ module Aws::CloudWatchRUM
|
|
|
1985
2006
|
# A structure that contains information about the user session that this
|
|
1986
2007
|
# batch of events was collected from.
|
|
1987
2008
|
#
|
|
1988
|
-
# @!attribute [rw] session_id
|
|
1989
|
-
# The session ID that the performance events are from.
|
|
1990
|
-
# @return [String]
|
|
1991
|
-
#
|
|
1992
2009
|
# @!attribute [rw] user_id
|
|
1993
2010
|
# The ID of the user for this user session. This ID is generated by
|
|
1994
2011
|
# RUM and does not include any personally identifiable information
|
|
1995
2012
|
# about the user.
|
|
1996
2013
|
# @return [String]
|
|
1997
2014
|
#
|
|
2015
|
+
# @!attribute [rw] session_id
|
|
2016
|
+
# The session ID that the performance events are from.
|
|
2017
|
+
# @return [String]
|
|
2018
|
+
#
|
|
1998
2019
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/UserDetails AWS API Documentation
|
|
1999
2020
|
#
|
|
2000
2021
|
class UserDetails < Struct.new(
|
|
2001
|
-
:
|
|
2002
|
-
:
|
|
2022
|
+
:user_id,
|
|
2023
|
+
:session_id)
|
|
2003
2024
|
SENSITIVE = []
|
|
2004
2025
|
include Aws::Structure
|
|
2005
2026
|
end
|