By default, RUM app monitors send some metrics to CloudWatch. These default metrics * are listed in CloudWatch metrics that you can collect * with CloudWatch RUM.
- *In addition to these default metrics, you can choose to send extended metrics or custom metrics or both.
+ *In addition to these default metrics, you can choose to send extended metrics, custom + * metrics, or both.
*Extended metrics enable you to send metrics with additional dimensions not included
- * in the default metrics. You can also send extended metrics to Evidently as well as CloudWatch.
- * The valid dimension names for the additional dimensions for extended metrics are
- * BrowserName, CountryCode, DeviceType,
- * FileType, OSName, and PageId. For more information, see
- *
- * Extended metrics that you can send to CloudWatch and CloudWatch Evidently.
Extended metrics let you send metrics with additional dimensions that aren't included in the
+ * default metrics. You can also send extended metrics to both Evidently and CloudWatch. The valid dimension names for the additional dimensions for extended
+ * metrics are BrowserName, CountryCode,
+ * DeviceType, FileType, OSName, and
+ * PageId. For more information, see
+ * Extended metrics that you can send to CloudWatch and CloudWatch
+ * Evidently.
Custom metrics are metrics that you define. You can send custom metrics to CloudWatch or - * to CloudWatch Evidently or to both. With custom metrics, - * you can use any metric name and namespace, and to derive the metrics you can use any custom events, built-in events, - * custom attributes, or default attributes.
+ *Custom metrics are metrics that you define. You can send custom metrics to CloudWatch. + * CloudWatch Evidently, or both. With custom metrics, you can use any metric + * name and namespace. To derive the metrics, you can use any custom events, built-in + * events, custom attributes, or default attributes.
*You can't send custom metrics to the AWS/RUM namespace. You must send custom metrics to a
* custom namespace that you define. The namespace that you use can't start with AWS/.
* CloudWatch RUM prepends RUM/CustomMetrics/ to the custom namespace that you define,
diff --git a/clients/client-rum/src/models/models_0.ts b/clients/client-rum/src/models/models_0.ts
index a39982dda04c0..1d4bf9700b0bc 100644
--- a/clients/client-rum/src/models/models_0.ts
+++ b/clients/client-rum/src/models/models_0.ts
@@ -97,6 +97,25 @@ export interface AppMonitorConfiguration {
* @public
*
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.
Use this structure to define one extended metric or custom metric that RUM will send * to CloudWatch or CloudWatch Evidently. For more information, see - * - * Additional metrics that you can send to CloudWatch and CloudWatch Evidently.
+ * + * Custom metrics and extended metrics that you can send to CloudWatch and CloudWatch Evidently. *This structure is validated differently for extended metrics and custom metrics. For extended metrics
* that are sent to the AWS/RUM namespace, the following validations apply:
The Namespace parameter must be omitted or set to AWS/RUM.
Only certain combinations of values for Name, ValueKey, and EventPattern
- * are valid. In addition to what is displayed in the list below, the EventPattern can also include information
- * used by the DimensionKeys field.
Only certain combinations of values for Name, ValueKey, and
+ * EventPattern are valid. In addition to what is displayed in the
+ * following list, the EventPattern can also include information used by
+ * the DimensionKeys field.
If Name is PerformanceNavigationDuration, then
@@ -433,6 +453,24 @@ export type MetricDestination = (typeof MetricDestination)[keyof typeof MetricDe
* must include \{"event_type":["com.amazon.rum.session_start_event"]\}
*
If Name is PageViewCount, then
+ * ValueKeymust be null and the EventPattern
+ * must include \{"event_type":["com.amazon.rum.page_view_event"]\}
+ *
If Name is Http4xxCount, then
+ * ValueKeymust be null and the EventPattern
+ * must include \{"event_type": ["com.amazon.rum.http_event"],"event_details":\{"response":\{"status":[\{"numeric":[">=",400,"<",500]\}]\}\}\} \}
+ *
If Name is Http5xxCount, then
+ * ValueKeymust be null and the EventPattern
+ * must include \{"event_type": ["com.amazon.rum.http_event"],"event_details":\{"response":\{"status":[\{"numeric":[">=",500,"<=",599]\}]\}\}\} \}
+ *
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 - * just 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 and Evidently - * will handle data extraction from the event.
+ *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.
*/ ValueKey?: string; @@ -728,9 +766,8 @@ export interface MetricDefinitionRequest { * * * - *If the metrics destination'
- * is CloudWatch and the event
- * also matches a value in DimensionKeys, then the metric is published with the specified dimensions.
If the metrics destination is CloudWatch and the event also matches a value
+ * in DimensionKeys, then the metric is published with the specified dimensions.
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.
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.
AppMonitorConfiguration, you must set up your own
* authorization method. For more information, see
- * Authorize your application
+ * 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.
*/ @@ -1617,10 +1655,15 @@ export interface PutRumMetricsDestinationRequest { /** * @public *This parameter is required if Destination is Evidently. If Destination is
- * CloudWatch, do not use this parameter.
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.
AppMonitorConfiguration, you must set up your own
* authorization method. For more information, see
- * Authorize your application
+ * Authorize your application
* to send data to Amazon Web Services.
*/
AppMonitorConfiguration?: AppMonitorConfiguration;
diff --git a/codegen/sdk-codegen/aws-models/rum.json b/codegen/sdk-codegen/aws-models/rum.json
index 4727d278e73f7..6f5c3c765633b 100644
--- a/codegen/sdk-codegen/aws-models/rum.json
+++ b/codegen/sdk-codegen/aws-models/rum.json
@@ -122,7 +122,7 @@
"GuestRoleArn": {
"target": "com.amazonaws.rum#Arn",
"traits": {
- "smithy.api#documentation": "The ARN of the guest IAM role that is attached to the Amazon Cognito identity pool \n that is used to authorize the sending of data to RUM.
" + "smithy.api#documentation": "The ARN of the guest IAM role that is attached to the Amazon Cognito identity pool \n that is used to authorize the sending of data to RUM.
\nIt is possible that an app monitor does not have a value for GuestRoleArn. For example, \n this can happen when you use the console to create an app monitor and you allow CloudWatch RUM to \n create a new identity pool for Authorization. In this case, GuestRoleArn is not present in the \n GetAppMonitor\n response because it is not stored by the service.
If this issue affects you, you can take one of the following steps:
\nUse the Cloud Development Kit (CDK) to create an identity pool and the associated IAM\n role, and use that for your app monitor.
\nMake a separate GetIdentityPoolRoles\n call to Amazon Cognito to retrieve \n the GuestRoleArn.
Specifies the extended metrics and custom metrics that you want a CloudWatch RUM app monitor to send to a destination. Valid\n destinations include CloudWatch and Evidently.
\nBy default, RUM app monitors send some metrics to CloudWatch. These default metrics\n are listed in CloudWatch metrics that you can collect \n with CloudWatch RUM.
\nIn addition to these default metrics, you can choose to send extended metrics or custom metrics or both.
\nExtended metrics enable you to send metrics with additional dimensions not included \n in the default metrics. You can also send extended metrics to Evidently as well as CloudWatch. \n The valid dimension names for the additional dimensions for extended metrics are\n BrowserName, CountryCode, DeviceType,\n FileType, OSName, and PageId. For more information, see \n \n Extended metrics that you can send to CloudWatch and CloudWatch Evidently.
Custom metrics are metrics that you define. You can send custom metrics to CloudWatch or\n to CloudWatch Evidently or to both. With custom metrics, \n you can use any metric name and namespace, and to derive the metrics you can use any custom events, built-in events, \n custom attributes, or default attributes.
\nYou can't send custom metrics to the AWS/RUM namespace. You must send custom metrics to a \n custom namespace that you define. The namespace that you use can't start with AWS/. \n CloudWatch RUM prepends RUM/CustomMetrics/ to the custom namespace that you define, \n so the final namespace for your metrics in CloudWatch is \n RUM/CustomMetrics/your-custom-namespace\n .
The maximum number of metric definitions that you can specify in one \n BatchCreateRumMetricDefinitions operation is 200.
The maximum number of metric definitions that one destination can contain is 2000.
\nExtended metrics sent to CloudWatch and RUM custom metrics are charged as CloudWatch custom metrics. Each combination of additional dimension name and dimension\n value counts as a custom metric. For more information, see \n Amazon CloudWatch Pricing.
\nYou must have\n already created a destination for the metrics before you send them. For more information, see \n PutRumMetricsDestination.
\nIf some metric definitions specified in a BatchCreateRumMetricDefinitions operations are not valid,\n those metric definitions fail and return errors, but all valid metric definitions in the same operation still succeed.
Specifies the extended metrics and custom metrics that you want a CloudWatch RUM app monitor to send to a destination. Valid\n destinations include CloudWatch and Evidently.
\nBy default, RUM app monitors send some metrics to CloudWatch. These default metrics\n are listed in CloudWatch metrics that you can collect \n with CloudWatch RUM.
\nIn addition to these default metrics, you can choose to send extended metrics, custom\n metrics, or both.
\nExtended metrics let you send metrics with additional dimensions that aren't included in the\n default metrics. You can also send extended metrics to both Evidently and CloudWatch. The valid dimension names for the additional dimensions for extended\n metrics are BrowserName, CountryCode,\n DeviceType, FileType, OSName, and\n PageId. For more information, see \n Extended metrics that you can send to CloudWatch and CloudWatch\n Evidently.
Custom metrics are metrics that you define. You can send custom metrics to CloudWatch.\n CloudWatch Evidently, or both. With custom metrics, you can use any metric\n name and namespace. To derive the metrics, you can use any custom events, built-in\n events, custom attributes, or default attributes.
\nYou can't send custom metrics to the AWS/RUM namespace. You must send custom metrics to a \n custom namespace that you define. The namespace that you use can't start with AWS/. \n CloudWatch RUM prepends RUM/CustomMetrics/ to the custom namespace that you define, \n so the final namespace for your metrics in CloudWatch is \n RUM/CustomMetrics/your-custom-namespace\n .
The maximum number of metric definitions that you can specify in one \n BatchCreateRumMetricDefinitions operation is 200.
The maximum number of metric definitions that one destination can contain is 2000.
\nExtended metrics sent to CloudWatch and RUM custom metrics are charged as CloudWatch custom metrics. Each combination of additional dimension name and dimension\n value counts as a custom metric. For more information, see \n Amazon CloudWatch Pricing.
\nYou must have\n already created a destination for the metrics before you send them. For more information, see \n PutRumMetricsDestination.
\nIf some metric definitions specified in a BatchCreateRumMetricDefinitions operations are not valid,\n those metric definitions fail and return errors, but all valid metric definitions in the same operation still succeed.
The destination to send the metrics to. Valid values are CloudWatch and Evidently. If\n you specify Evidently, you must also specify the ARN of the CloudWatchEvidently experiment \n that will receive\n the metrics and an IAM role that has permission to write to the experiment.
The destination to send the metrics to. Valid values are CloudWatch and\n Evidently. If you specify Evidently, you must also specify the\n Amazon Resource Name (ARN) of the CloudWatchEvidently experiment that will receive\n the metrics and an IAM role that has permission to write to the\n experiment.
A structure that contains much of the configuration data for the app monitor. If you are using \n Amazon Cognito for authorization, you must include this structure in your request, and it must include the ID of the \n Amazon Cognito identity pool to use for authorization. If you don't include AppMonitorConfiguration, you must set up your own \n authorization method. For more information, see \n Authorize your application\n 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.
" + "smithy.api#documentation": "A structure that contains much of the configuration data for the app monitor. If you are using \n Amazon Cognito for authorization, you must include this structure in your request, and it must include the ID of the \n Amazon Cognito identity pool to use for authorization. If you don't include AppMonitorConfiguration, you must set up your own \n authorization method. For more information, see \n Authorize your application\n 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.
" } }, "CwLogEnabled": { @@ -1588,7 +1588,7 @@ "ValueKey": { "target": "com.amazonaws.rum#ValueKey", "traits": { - "smithy.api#documentation": "The field within the event object that the metric value is sourced from.
\nIf you omit this field, a hardcoded value of 1 is pushed as the metric value. This is useful if you\n just want to count the number of events that the filter catches.
\nIf this metric is sent to CloudWatch Evidently, this field will be passed to Evidently raw and Evidently \n will handle data extraction from the event.
" + "smithy.api#documentation": "The field within the event object that the metric value is sourced from.
\nIf you omit this field, a hardcoded value of 1 is pushed as the metric value. This is\n useful if you want to count the number of events that the filter catches.
\nIf this metric is sent to CloudWatch Evidently, this field will be passed to\n Evidently raw. Evidently will handle data extraction from the event.
" } }, "UnitLabel": { @@ -1606,7 +1606,7 @@ "EventPattern": { "target": "com.amazonaws.rum#EventPattern", "traits": { - "smithy.api#documentation": "The pattern that defines the metric, specified as a JSON object. RUM checks events that happen in a user's session\n against the pattern, and events that match the pattern are sent to the metric destination.
\nWhen you define extended metrics, the metric definition is not valid if EventPattern\n is omitted.
Example event patterns:
\n\n '{\n \"event_type\": [\"com.amazon.rum.js_error_event\"],\n \"metadata\": {\n \"browserName\": [ \"Chrome\", \"Safari\" ], } }'\n
\n '{\n \"event_type\": [\"com.amazon.rum.performance_navigation_event\"],\n \"metadata\": {\n \"browserName\": [ \"Chrome\", \"Firefox\" ]\n },\n \"event_details\": {\n \"duration\": [{\n \"numeric\": [ \"<\", 2000 ]\n }]\n }\n }'\n
\n '{\n \"event_type\": [\"com.amazon.rum.performance_navigation_event\"],\n \"metadata\": {\n \"browserName\": [ \"Chrome\", \"Safari\" ],\n \"countryCode\": [ \"US\" ]\n },\n \"event_details\": {\n \"duration\": [{\n \"numeric\": [ \">=\", 2000, \"<\", 8000 ]\n }]\n }\n }'\n
If the metrics destination'\n is CloudWatch and the event\n also matches a value in DimensionKeys, then the metric is published with the specified dimensions.
The pattern that defines the metric, specified as a JSON object. RUM checks events that happen in a user's session\n against the pattern, and events that match the pattern are sent to the metric destination.
\nWhen you define extended metrics, the metric definition is not valid if EventPattern\n is omitted.
Example event patterns:
\n\n '{\n \"event_type\": [\"com.amazon.rum.js_error_event\"],\n \"metadata\": {\n \"browserName\": [ \"Chrome\", \"Safari\" ], } }'\n
\n '{\n \"event_type\": [\"com.amazon.rum.performance_navigation_event\"],\n \"metadata\": {\n \"browserName\": [ \"Chrome\", \"Firefox\" ]\n },\n \"event_details\": {\n \"duration\": [{\n \"numeric\": [ \"<\", 2000 ]\n }]\n }\n }'\n
\n '{\n \"event_type\": [\"com.amazon.rum.performance_navigation_event\"],\n \"metadata\": {\n \"browserName\": [ \"Chrome\", \"Safari\" ],\n \"countryCode\": [ \"US\" ]\n },\n \"event_details\": {\n \"duration\": [{\n \"numeric\": [ \">=\", 2000, \"<\", 8000 ]\n }]\n }\n }'\n
If the metrics destination is CloudWatch and the event also matches a value\n in DimensionKeys, then the metric is published with the specified dimensions.
Use this structure to define one extended metric or custom metric that RUM will send\n to CloudWatch or CloudWatch Evidently. For more information, see \n \n Additional metrics that you can send to CloudWatch and CloudWatch Evidently.
\nThis structure is validated differently for extended metrics and custom metrics. For extended metrics\n that are sent to the AWS/RUM namespace, the following validations apply:
The Namespace parameter must be omitted or set to AWS/RUM.
Only certain combinations of values for Name, ValueKey, and EventPattern\n are valid. In addition to what is displayed in the list below, the EventPattern can also include information\n used by the DimensionKeys field.
If Name is PerformanceNavigationDuration, then\n ValueKeymust be event_details.duration and the EventPattern\n must include {\"event_type\":[\"com.amazon.rum.performance_navigation_event\"]}\n
If Name is PerformanceResourceDuration, then\n ValueKeymust be event_details.duration and the EventPattern\n must include {\"event_type\":[\"com.amazon.rum.performance_resource_event\"]}\n
If Name is NavigationSatisfiedTransaction, then\n ValueKeymust be null and the EventPattern\n must include {\n \"event_type\": [\"com.amazon.rum.performance_navigation_event\"],\n \"event_details\": {\n \"duration\": [{\n \"numeric\": [\">\",2000]\n }]\n }\n }\n
If Name is NavigationToleratedTransaction, then\n ValueKeymust be null and the EventPattern\n must include {\n \"event_type\": [\"com.amazon.rum.performance_navigation_event\"],\n \"event_details\": {\n \"duration\": [{\n \"numeric\": [\">=\",2000,\"<\"8000]\n }]\n }\n }\n
If Name is NavigationFrustratedTransaction, then\n ValueKeymust be null and the EventPattern\n must include {\n \"event_type\": [\"com.amazon.rum.performance_navigation_event\"],\n \"event_details\": {\n \"duration\": [{\n \"numeric\": [\">=\",8000]\n }]\n }\n }\n
If Name is WebVitalsCumulativeLayoutShift, then\n ValueKeymust be event_details.value and the EventPattern\n must include {\"event_type\":[\"com.amazon.rum.cumulative_layout_shift_event\"]}\n
If Name is WebVitalsFirstInputDelay, then\n ValueKeymust be event_details.value and the EventPattern\n must include {\"event_type\":[\"com.amazon.rum.first_input_delay_event\"]}\n
If Name is WebVitalsLargestContentfulPaint, then\n ValueKeymust be event_details.value and the EventPattern\n must include {\"event_type\":[\"com.amazon.rum.largest_contentful_paint_event\"]}\n
If Name is JsErrorCount, then\n ValueKeymust be null and the EventPattern\n must include {\"event_type\":[\"com.amazon.rum.js_error_event\"]}\n
If Name is HttpErrorCount, then\n ValueKeymust be null and the EventPattern\n must include {\"event_type\":[\"com.amazon.rum.http_event\"]}\n
If Name is SessionCount, then\n ValueKeymust be null and the EventPattern\n must include {\"event_type\":[\"com.amazon.rum.session_start_event\"]}\n
For custom metrics, the following validation rules apply:
\nThe namespace can't be omitted and can't be AWS/RUM. You can use the AWS/RUM\n namespace only for extended metrics.
All dimensions listed in the DimensionKeys field must be present in the value\n of EventPattern.
The values that you specify for ValueKey, EventPattern, and \n DimensionKeys must be fields in RUM events, so all first-level keys in these fields must \n be one of the keys in the list later in this section.
If you set a value for EventPattern, it must be a JSON object.
For every non-empty event_details, there must be a non-empty event_type.
If EventPattern contains an event_details field, \n it must also contain an event_type. For every built-in event_type that you use, you must use \n a value for event_details that corresponds to that\n event_type. For information about event details that correspond to event types, see \n \n RUM event details.
In EventPattern, any JSON array must contain only one value.
Valid key values for first-level keys in the ValueKey, EventPattern, and \n DimensionKeys fields:
\n account_id\n
\n application_Id\n
\n application_version\n
\n application_name\n
\n batch_id\n
\n event_details\n
\n event_id\n
\n event_interaction\n
\n event_timestamp\n
\n event_type\n
\n event_version\n
\n log_stream\n
\n metadata\n
\n sessionId\n
\n user_details\n
\n userId\n
Use this structure to define one extended metric or custom metric that RUM will send\n to CloudWatch or CloudWatch Evidently. For more information, see \n \n Custom metrics and extended metrics that you can send to CloudWatch and CloudWatch Evidently.
\nThis structure is validated differently for extended metrics and custom metrics. For extended metrics\n that are sent to the AWS/RUM namespace, the following validations apply:
The Namespace parameter must be omitted or set to AWS/RUM.
Only certain combinations of values for Name, ValueKey, and\n EventPattern are valid. In addition to what is displayed in the\n following list, the EventPattern can also include information used by\n the DimensionKeys field.
If Name is PerformanceNavigationDuration, then\n ValueKeymust be event_details.duration and the EventPattern\n must include {\"event_type\":[\"com.amazon.rum.performance_navigation_event\"]}\n
If Name is PerformanceResourceDuration, then\n ValueKeymust be event_details.duration and the EventPattern\n must include {\"event_type\":[\"com.amazon.rum.performance_resource_event\"]}\n
If Name is NavigationSatisfiedTransaction, then\n ValueKeymust be null and the EventPattern\n must include {\n \"event_type\": [\"com.amazon.rum.performance_navigation_event\"],\n \"event_details\": {\n \"duration\": [{\n \"numeric\": [\">\",2000]\n }]\n }\n }\n
If Name is NavigationToleratedTransaction, then\n ValueKeymust be null and the EventPattern\n must include {\n \"event_type\": [\"com.amazon.rum.performance_navigation_event\"],\n \"event_details\": {\n \"duration\": [{\n \"numeric\": [\">=\",2000,\"<\"8000]\n }]\n }\n }\n
If Name is NavigationFrustratedTransaction, then\n ValueKeymust be null and the EventPattern\n must include {\n \"event_type\": [\"com.amazon.rum.performance_navigation_event\"],\n \"event_details\": {\n \"duration\": [{\n \"numeric\": [\">=\",8000]\n }]\n }\n }\n
If Name is WebVitalsCumulativeLayoutShift, then\n ValueKeymust be event_details.value and the EventPattern\n must include {\"event_type\":[\"com.amazon.rum.cumulative_layout_shift_event\"]}\n
If Name is WebVitalsFirstInputDelay, then\n ValueKeymust be event_details.value and the EventPattern\n must include {\"event_type\":[\"com.amazon.rum.first_input_delay_event\"]}\n
If Name is WebVitalsLargestContentfulPaint, then\n ValueKeymust be event_details.value and the EventPattern\n must include {\"event_type\":[\"com.amazon.rum.largest_contentful_paint_event\"]}\n
If Name is JsErrorCount, then\n ValueKeymust be null and the EventPattern\n must include {\"event_type\":[\"com.amazon.rum.js_error_event\"]}\n
If Name is HttpErrorCount, then\n ValueKeymust be null and the EventPattern\n must include {\"event_type\":[\"com.amazon.rum.http_event\"]}\n
If Name is SessionCount, then\n ValueKeymust be null and the EventPattern\n must include {\"event_type\":[\"com.amazon.rum.session_start_event\"]}\n
If Name is PageViewCount, then\n ValueKeymust be null and the EventPattern\n must include {\"event_type\":[\"com.amazon.rum.page_view_event\"]}\n
If Name is Http4xxCount, then\n ValueKeymust be null and the EventPattern\n must include {\"event_type\": [\"com.amazon.rum.http_event\"],\"event_details\":{\"response\":{\"status\":[{\"numeric\":[\">=\",400,\"<\",500]}]}}} }\n
If Name is Http5xxCount, then\n ValueKeymust be null and the EventPattern\n must include {\"event_type\": [\"com.amazon.rum.http_event\"],\"event_details\":{\"response\":{\"status\":[{\"numeric\":[\">=\",500,\"<=\",599]}]}}} }\n
For custom metrics, the following validation rules apply:
\nThe namespace can't be omitted and can't be AWS/RUM. You can use the AWS/RUM\n namespace only for extended metrics.
All dimensions listed in the DimensionKeys field must be present in the value\n of EventPattern.
The values that you specify for ValueKey, EventPattern, and \n DimensionKeys must be fields in RUM events, so all first-level keys in these fields must \n be one of the keys in the list later in this section.
If you set a value for EventPattern, it must be a JSON object.
For every non-empty event_details, there must be a non-empty event_type.
If EventPattern contains an event_details field, \n it must also contain an event_type. For every built-in event_type that you use, you must use \n a value for event_details that corresponds to that\n event_type. For information about event details that correspond to event types, see \n \n RUM event details.
In EventPattern, any JSON array must contain only one value.
Valid key values for first-level keys in the ValueKey, EventPattern, and \n DimensionKeys fields:
\n account_id\n
\n application_Id\n
\n application_version\n
\n application_name\n
\n batch_id\n
\n event_details\n
\n event_id\n
\n event_interaction\n
\n event_timestamp\n
\n event_type\n
\n event_version\n
\n log_stream\n
\n metadata\n
\n sessionId\n
\n user_details\n
\n userId\n
This parameter is required if Destination is Evidently. If Destination is \n CloudWatch, do not use this parameter.
This parameter specifies\n the ARN of an IAM role that RUM will assume to write to the Evidently \n experiment that you are sending metrics to. This role must have permission to write to that experiment.
" + "smithy.api#documentation": "This parameter is required if Destination is Evidently. If Destination is \n CloudWatch, don't use this parameter.
This parameter specifies\n the ARN of an IAM role that RUM will assume to write to the Evidently \n experiment that you are sending metrics to. This role must have permission to write to that experiment.
\nIf you specify this parameter, you must be signed on to a role that has PassRole permissions attached to it, to allow\n the role to be passed. The \n CloudWatchAmazonCloudWatchRUMFullAccess\n policy doesn't include PassRole\n permissions.
A structure that contains much of the configuration data for the app monitor. If you are using \n Amazon Cognito for authorization, you must include this structure in your request, and it must include the ID of the \n Amazon Cognito identity pool to use for authorization. If you don't include AppMonitorConfiguration, you must set up your own \n authorization method. For more information, see \n Authorize your application\n to send data to Amazon Web Services.
A structure that contains much of the configuration data for the app monitor. If you are using \n Amazon Cognito for authorization, you must include this structure in your request, and it must include the ID of the \n Amazon Cognito identity pool to use for authorization. If you don't include AppMonitorConfiguration, you must set up your own \n authorization method. For more information, see \n Authorize your application\n to send data to Amazon Web Services.