AppMonitorConfiguration appMonitorConfiguration
A structure that contains much of the configuration data for the app monitor.
String created
The date and time that this app monitor was created.
CustomEvents customEvents
Specifies whether this app monitor allows the web client to define and send custom events.
For more information about custom events, see Send custom events.
DataStorage dataStorage
A structure that contains information about whether this app monitor stores a copy of the telemetry data that RUM collects using CloudWatch Logs.
String domain
The top-level internet domain name for which your application has administrative authority.
String id
The unique ID of this app monitor.
String lastModified
The date and time of the most recent changes to this app monitor's configuration.
String name
The name of the app monitor.
String state
The current state of the app monitor.
Map<K,V> tags
The list of tag keys and values associated with this app monitor.
Boolean allowCookies
If you set this to true, the RUM web client sets two cookies, a session cookie and a user cookie.
The cookies allow the RUM web client to collect data relating to the number of users an application has and the
behavior of the application across a sequence of events. Cookies are stored in the top-level domain of the
current page.
Boolean enableXRay
If you set this to true, RUM enables X-Ray tracing for the user sessions that RUM samples. RUM adds
an X-Ray trace header to allowed HTTP requests. It also records an X-Ray segment for allowed HTTP requests. You
can see traces and segments from these user sessions in the X-Ray console and the CloudWatch ServiceLens console.
For more information, see What is
X-Ray?
List<E> excludedPages
A list of URLs in your website or application to exclude from RUM data collection.
You can't include both ExcludedPages and IncludedPages in the same operation.
List<E> favoritePages
A list of pages in your application that are to be displayed with a "favorite" icon in the CloudWatch RUM console.
String guestRoleArn
The ARN of the guest IAM role that is attached to the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.
It is possible that an app monitor does not have a value for GuestRoleArn. For example, this can
happen when you use the console to create an app monitor and you allow CloudWatch RUM to create a new identity
pool for Authorization. In this case, GuestRoleArn is not present in the GetAppMonitor
response because it is not stored by the service.
If this issue affects you, you can take one of the following steps:
Use the Cloud Development Kit (CDK) to create an identity pool and the associated IAM role, and use that for your app monitor.
Make a separate GetIdentityPoolRoles call to Amazon Cognito to retrieve the GuestRoleArn.
String identityPoolId
The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.
List<E> includedPages
If this app monitor is to collect data from only certain pages in your application, this structure lists those pages.
You can't include both ExcludedPages and IncludedPages in the same operation.
Double sessionSampleRate
Specifies the portion of user sessions to use for RUM data collection. Choosing a higher portion gives you more data but also incurs more costs.
The range for this value is 0 to 1 inclusive. Setting this to 1 means that 100% of user sessions are sampled, and setting it to 0.1 means that 10% of user sessions are sampled.
If you omit this parameter, the default of 0.1 is used, and 10% of sessions will be sampled.
List<E> telemetries
An array that lists the types of telemetry data that this app monitor is to collect.
errors indicates that RUM collects data about unhandled JavaScript errors raised by your
application.
performance indicates that RUM collects performance data about how your application and its
resources are loaded and rendered. This includes Core Web Vitals.
http indicates that RUM collects data about HTTP errors thrown by your application.
String created
The date and time that the app monitor was created.
String id
The unique ID of this app monitor.
String lastModified
The date and time of the most recent changes to this app monitor's configuration.
String name
The name of this app monitor.
String state
The current state of this app monitor.
String errorCode
The error code.
String errorMessage
The error message for this metric definition.
MetricDefinitionRequest metricDefinition
The metric definition that caused this error.
String appMonitorName
The name of the CloudWatch RUM app monitor that is to send the metrics.
String destination
The destination to send the metrics to. Valid values are CloudWatch and Evidently. If
you specify Evidently, you must also specify the Amazon Resource Name (ARN) of the
CloudWatchEvidently experiment that will receive the metrics and an IAM role that has permission to write to the
experiment.
String destinationArn
This parameter is required if Destination is Evidently. If Destination is
CloudWatch, do not use this parameter.
This parameter specifies the ARN of the Evidently experiment that is to receive the metrics. You must have already defined this experiment as a valid destination. For more information, see PutRumMetricsDestination.
List<E> metricDefinitions
An array of structures which define the metrics that you want to send.
String appMonitorName
The name of the CloudWatch RUM app monitor that is sending these metrics.
String destination
Defines the destination where you want to stop sending the specified metrics. Valid values are
CloudWatch and Evidently. If you specify Evidently, you must also specify
the ARN of the CloudWatchEvidently experiment that is to be the destination and an IAM role that has permission
to write to the experiment.
String destinationArn
This parameter is required if Destination is Evidently. If Destination is
CloudWatch, do not use this parameter.
This parameter specifies the ARN of the Evidently experiment that was receiving the metrics that are being deleted.
List<E> metricDefinitionIds
An array of structures which define the metrics that you want to stop sending.
String appMonitorName
The name of the CloudWatch RUM app monitor that is sending the metrics.
String destination
The type of destination that you want to view metrics for. Valid values are CloudWatch and
Evidently.
String destinationArn
This parameter is required if Destination is Evidently. If Destination is
CloudWatch, do not use this parameter.
This parameter specifies the ARN of the Evidently experiment that corresponds to the destination.
Integer maxResults
The maximum number of results to return in one operation. The default is 50. The maximum that you can specify is 100.
To retrieve the remaining results, make another call with the returned NextToken value.
String nextToken
Use the token returned by the previous operation to request the next page of results.
AppMonitorConfiguration appMonitorConfiguration
A structure that contains much of the configuration data for the app monitor. If you are using Amazon Cognito for
authorization, you must include this structure in your request, and it must include the ID of the Amazon Cognito
identity pool to use for authorization. If you don't include AppMonitorConfiguration, you must set
up your own authorization method. For more information, see Authorize your application to send data to Amazon Web Services.
If you omit this argument, the sample rate used for RUM is set to 10% of the user sessions.
CustomEvents customEvents
Specifies whether this app monitor allows the web client to define and send custom events. If you omit this
parameter, custom events are DISABLED.
For more information about custom events, see Send custom events.
Boolean cwLogEnabled
Data collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM sends a copy of this telemetry data to Amazon CloudWatch Logs in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur Amazon CloudWatch Logs charges.
If you omit this parameter, the default is false.
String domain
The top-level internet domain name for which your application has administrative authority.
String name
A name for the app monitor.
Map<K,V> tags
Assigns one or more tags (key-value pairs) to the app monitor.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can associate as many as 50 tags with an app monitor.
For more information, see Tagging Amazon Web Services resources.
String id
The unique ID of the new app monitor.
String status
Specifies whether this app monitor allows the web client to define and send custom events. The default is for
custom events to be DISABLED.
CwLog cwLog
A structure that contains the information about whether the app monitor stores copies of the data that RUM collects in CloudWatch Logs. If it does, this structure also contains the name of the log group.
String name
The name of the app monitor to delete.
String appMonitorName
The name of the app monitor that is sending metrics to the destination that you want to delete.
String destination
The type of destination to delete. Valid values are CloudWatch and Evidently.
String destinationArn
This parameter is required if Destination is Evidently. If Destination is
CloudWatch, do not use this parameter. This parameter specifies the ARN of the Evidently experiment
that corresponds to the destination to delete.
List<E> filters
An array of structures that you can use to filter the results to those that match one or more sets of key-value pairs that you specify.
Integer maxResults
The maximum number of results to return in one operation.
String name
The name of the app monitor that collected the data that you want to retrieve.
String nextToken
Use the token returned by the previous operation to request the next page of results.
TimeRange timeRange
A structure that defines the time range that you want to retrieve results from.
String name
The app monitor to retrieve information for.
AppMonitor appMonitor
A structure containing all the configuration information for the app monitor.
Integer retryAfterSeconds
The value of a parameter in the request caused an error.
String appMonitorName
The name of the app monitor associated with the destinations that you want to retrieve.
Integer maxResults
The maximum number of results to return in one operation. The default is 50. The maximum that you can specify is 100.
To retrieve the remaining results, make another call with the returned NextToken value.
String nextToken
Use the token returned by the previous operation to request the next page of results.
String resourceArn
The ARN of the resource that you want to see the tags of.
Map<K,V> dimensionKeys
This field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in
CloudWatch The value of this field is used only if the metric destination is CloudWatch. If the
metric destination is Evidently, the value of DimensionKeys is ignored.
String eventPattern
The pattern that defines the metric. RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination.
If the metrics destination is CloudWatch and the event also matches a value in
DimensionKeys, then the metric is published with the specified dimensions.
String metricDefinitionId
The ID of this metric definition.
String name
The name of the metric that is defined in this structure.
String namespace
If this metric definition is for a custom metric instead of an extended metric, this field displays the metric namespace that the custom metric is published to.
String unitLabel
Use this field only if you are sending this metric to CloudWatch. It defines the CloudWatch metric unit that this metric is measured in.
String valueKey
The field within the event object that the metric value is sourced from.
Map<K,V> dimensionKeys
Use this field only if you are sending the metric to CloudWatch.
This field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch. For extended metrics, valid values for the entries in this field are the following:
"metadata.pageId": "PageId"
"metadata.browserName": "BrowserName"
"metadata.deviceType": "DeviceType"
"metadata.osName": "OSName"
"metadata.countryCode": "CountryCode"
"event_details.fileType": "FileType"
For both extended metrics and custom metrics, all dimensions listed in this field must also be included in
EventPattern.
String eventPattern
The pattern that defines the metric, specified as a JSON object. RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination.
When you define extended metrics, the metric definition is not valid if EventPattern is omitted.
Example event patterns:
'{ "event_type": ["com.amazon.rum.js_error_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], } }'
'{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Firefox" ] }, "event_details": { "duration": [{ "numeric": [ "<", 2000 ] }] } }'
'{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], "countryCode": [ "US" ] }, "event_details": { "duration": [{ "numeric": [ ">=", 2000, "<", 8000 ] }] } }'
If the metrics destination is CloudWatch and the event also matches a value in
DimensionKeys, then the metric is published with the specified dimensions.
String name
The name for the metric that is defined in this structure. For custom metrics, you can specify any name that you like. For extended metrics, valid values are the following:
PerformanceNavigationDuration
PerformanceResourceDuration
NavigationSatisfiedTransaction
NavigationToleratedTransaction
NavigationFrustratedTransaction
WebVitalsCumulativeLayoutShift
WebVitalsFirstInputDelay
WebVitalsLargestContentfulPaint
JsErrorCount
HttpErrorCount
SessionCount
String namespace
If this structure is for a custom metric instead of an extended metrics, use this parameter to define the metric namespace for that custom metric. Do not specify this parameter if this structure is for an extended metric.
You cannot use any string that starts with AWS/ for your namespace.
String unitLabel
The CloudWatch metric unit to use for this metric. If you omit this field, the metric is recorded with no unit.
String valueKey
The field within the event object that the metric value is sourced from.
If you omit this field, a hardcoded value of 1 is pushed as the metric value. This is useful if you want to count the number of events that the filter catches.
If this metric is sent to CloudWatch Evidently, this field will be passed to Evidently raw. Evidently will handle data extraction from the event.
String destination
Specifies whether the destination is CloudWatch or Evidently.
String destinationArn
If the destination is Evidently, this specifies the ARN of the Evidently experiment that receives
the metrics.
String iamRoleArn
This field appears only when the destination is Evidently. It specifies the ARN of the IAM role that
is used to write to the Evidently experiment that receives the metrics.
AppMonitorDetails appMonitorDetails
A structure that contains information about the app monitor that collected this telemetry information.
String batchId
A unique identifier for this batch of RUM event data.
String id
The ID of the app monitor that is sending this data.
List<E> rumEvents
An array of structures that contain the telemetry event data.
UserDetails userDetails
A structure that contains information about the user session that this batch of events was collected from.
String appMonitorName
The name of the CloudWatch RUM app monitor that will send the metrics.
String destination
Defines the destination to send the metrics to. Valid values are CloudWatch and
Evidently. If you specify Evidently, you must also specify the ARN of the
CloudWatchEvidently experiment that is to be the destination and an IAM role that has permission to write to the
experiment.
String destinationArn
Use this parameter only if Destination is Evidently. This parameter specifies the ARN
of the Evidently experiment that will receive the extended metrics.
String iamRoleArn
This parameter is required if Destination is Evidently. If Destination is
CloudWatch, don't use this parameter.
This parameter specifies the ARN of an IAM role that RUM will assume to write to the Evidently experiment that you are sending metrics to. This role must have permission to write to that experiment.
If you specify this parameter, you must be signed on to a role that has PassRole permissions
attached to it, to allow the role to be passed. The CloudWatchAmazonCloudWatchRUMFullAccess policy doesn't include PassRole permissions.
String name
The name of a key to search for. The filter returns only the events that match the Name and
Values that you specify.
Valid values for Name are Browser | Device | Country |
Page | OS | EventType | Invert
List<E> values
The values of the Name that are to be be included in the returned results.
String details
A string containing details about the event.
String id
A unique ID for this event.
String metadata
Metadata about this event, which contains a JSON serialization of the identity of the user for this session. The user information comes from information such as the HTTP user-agent request header and document interface.
Date timestamp
The exact time that this event occurred.
String type
The JSON schema that denotes the type of event this is, such as a page load or a new session.
AppMonitorConfiguration appMonitorConfiguration
A structure that contains much of the configuration data for the app monitor. If you are using Amazon Cognito for
authorization, you must include this structure in your request, and it must include the ID of the Amazon Cognito
identity pool to use for authorization. If you don't include AppMonitorConfiguration, you must set
up your own authorization method. For more information, see Authorize your application to send data to Amazon Web Services.
CustomEvents customEvents
Specifies whether this app monitor allows the web client to define and send custom events. The default is for
custom events to be DISABLED.
For more information about custom events, see Send custom events.
Boolean cwLogEnabled
Data collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM sends a copy of this telemetry data to Amazon CloudWatch Logs in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur Amazon CloudWatch Logs charges.
String domain
The top-level internet domain name for which your application has administrative authority.
String name
The name of the app monitor to update.
String appMonitorName
The name of the CloudWatch RUM app monitor that sends these metrics.
String destination
The destination to send the metrics to. Valid values are CloudWatch and Evidently. If
you specify Evidently, you must also specify the ARN of the CloudWatchEvidently experiment that will
receive the metrics and an IAM role that has permission to write to the experiment.
String destinationArn
This parameter is required if Destination is Evidently. If Destination is
CloudWatch, do not use this parameter.
This parameter specifies the ARN of the Evidently experiment that is to receive the metrics. You must have already defined this experiment as a valid destination. For more information, see PutRumMetricsDestination.
MetricDefinitionRequest metricDefinition
A structure that contains the new definition that you want to use for this metric.
String metricDefinitionId
The ID of the metric definition to update.
Copyright © 2024. All rights reserved.