aws-sdk-cloudwatchrum 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20bb52ab04849ccff2aa8e3b4693d60fe788a58e95d6fdcb3f5189049692ac54
-  data.tar.gz: 503e19e7f22fa108214cae2aaa9a5ae4afb8a508c8a3e9daa03633bd04ae3f02
+  metadata.gz: 9b0a930f1aeddabdd05066e8aed44696135857a631d28b77dd755c17f9700a17
+  data.tar.gz: b019010acf76af8382445a3e396cfda0b808705f06059efba15a11c8b4eabeb3
 SHA512:
-  metadata.gz: 255be46858c8501eec0d0a4e5a120a45601fcf487b36366fce45a251138e4a75950aa9ce368455408e83f3115dbd673897a26d907edf795823c43429b1680562
-  data.tar.gz: 5c6923940bbd6d077a80316e8fb3eb8061b4d8f6890ef5913edcc570b5d175dd20e3dea2af0a0f270f4330a751eb47b50dbfae49123a23f9ea0f90b21854c875
+  metadata.gz: c68cc9c88c896706e1946e39e2bbbfeae47df4be0ebd9e5ce696c0609d6541251fa00b18512e1978d68644c72b500f39b0320b3e81856ba2f12a30263e981452
+  data.tar.gz: f061dd498ab3929eca0c1e54eeff59cc964a97848d57282275c1b97310a9eb24c3848baab18691c215f09e39a2ba99179f3e4ca8b9f1d3ee1e3da5006a267c15

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.9.0 (2023-02-22)
+------------------
+
+* Feature - CloudWatch RUM now supports CloudWatch Custom Metrics
+
 1.8.0 (2023-01-18)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.8.0
+1.9.0

data/lib/aws-sdk-cloudwatchrum/client.rb

@@ -368,21 +368,37 @@ module Aws::CloudWatchRUM
 
     # @!group API Operations
 
-    # Specifies the extended metrics that you want a CloudWatch RUM app
-    # monitor to send to a destination. Valid destinations include
-    # CloudWatch and Evidently.
+    # Specifies the extended metrics and custom metrics that you want a
+    # CloudWatch RUM app monitor to send to a destination. Valid
+    # destinations include CloudWatch and Evidently.
     #
     # 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][1].
     #
-    # If you also send extended metrics, you can send metrics to Evidently
-    # as well as CloudWatch, and you can also optionally send the metrics
-    # with additional dimensions. The valid dimension names for the
-    # additional dimensions are `BrowserName`, `CountryCode`, `DeviceType`,
-    # `FileType`, `OSName`, and `PageId`. For more information, see [
-    # Extended metrics that you can send to CloudWatch and CloudWatch
-    # Evidently][2].
+    # In addition to these default metrics, you can choose to send extended
+    # metrics or 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][2].
+    #
+    # * 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.
+    #
+    #   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, so the final namespace for your metrics in CloudWatch is
+    #   `RUM/CustomMetrics/your-custom-namespace `.
     #
     # The maximum number of metric definitions that you can specify in one
     # `BatchCreateRumMetricDefinitions` operation is 200.
@@ -390,10 +406,10 @@ module Aws::CloudWatchRUM
     # The maximum number of metric definitions that one destination can
     # contain is 2000.
     #
-    # Extended metrics sent are charged as CloudWatch custom metrics. Each
-    # combination of additional dimension name and dimension value counts as
-    # a custom metric. For more information, see [Amazon CloudWatch
-    # Pricing][3].
+    # Extended metrics sent to CloudWatch and RUM custom metrics are charged
+    # as CloudWatch custom metrics. Each combination of additional dimension
+    # name and dimension value counts as a custom metric. For more
+    # information, see [Amazon CloudWatch Pricing][3].
     #
     # You must have already created a destination for the metrics before you
     # send them. For more information, see [PutRumMetricsDestination][4].
@@ -455,6 +471,7 @@ module Aws::CloudWatchRUM
     #         },
     #         event_pattern: "EventPattern",
     #         name: "MetricName", # required
+    #         namespace: "Namespace",
     #         unit_label: "UnitLabel",
     #         value_key: "ValueKey",
     #       },
@@ -470,6 +487,7 @@ module Aws::CloudWatchRUM
     #   resp.errors[0].metric_definition.dimension_keys["DimensionKey"] #=> String
     #   resp.errors[0].metric_definition.event_pattern #=> String
     #   resp.errors[0].metric_definition.name #=> String
+    #   resp.errors[0].metric_definition.namespace #=> String
     #   resp.errors[0].metric_definition.unit_label #=> String
     #   resp.errors[0].metric_definition.value_key #=> String
     #   resp.metric_definitions #=> Array
@@ -478,6 +496,7 @@ module Aws::CloudWatchRUM
     #   resp.metric_definitions[0].event_pattern #=> String
     #   resp.metric_definitions[0].metric_definition_id #=> String
     #   resp.metric_definitions[0].name #=> String
+    #   resp.metric_definitions[0].namespace #=> String
     #   resp.metric_definitions[0].unit_label #=> String
     #   resp.metric_definitions[0].value_key #=> String
     #
@@ -609,6 +628,7 @@ module Aws::CloudWatchRUM
     #   resp.metric_definitions[0].event_pattern #=> String
     #   resp.metric_definitions[0].metric_definition_id #=> String
     #   resp.metric_definitions[0].name #=> String
+    #   resp.metric_definitions[0].namespace #=> String
     #   resp.metric_definitions[0].unit_label #=> String
     #   resp.metric_definitions[0].value_key #=> String
     #   resp.next_token #=> String
@@ -1083,20 +1103,20 @@ module Aws::CloudWatchRUM
     #       name: "String",
     #       version: "String",
     #     },
-    #     batch_id: "String", # required
-    #     id: "AppMonitorId", # required
+    #     batch_id: "PutRumEventsRequestBatchIdString", # required
+    #     id: "PutRumEventsRequestIdString", # required
     #     rum_events: [ # required
     #       {
     #         details: "JsonValue", # required
-    #         id: "String", # required
+    #         id: "RumEventIdString", # required
     #         metadata: "JsonValue",
     #         timestamp: Time.now, # required
     #         type: "String", # required
     #       },
     #     ],
     #     user_details: { # required
-    #       session_id: "String",
-    #       user_id: "String",
+    #       session_id: "UserDetailsSessionIdString",
+    #       user_id: "UserDetailsUserIdString",
     #     },
     #   })
     #
@@ -1113,11 +1133,12 @@ module Aws::CloudWatchRUM
     # CloudWatch RUM. You can send extended metrics to CloudWatch or to a
     # CloudWatch Evidently experiment.
     #
-    # For more information about extended metrics, see [AddRumMetrics][1].
+    # For more information about extended metrics, see
+    # [BatchCreateRumMetricDefinitions][1].
     #
     #
     #
-    # [1]: https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_AddRumMetrics.html
+    # [1]: https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_BatchCreateRumMetricDefinitions.html
     #
     # @option params [required, String] :app_monitor_name
     #   The name of the CloudWatch RUM app monitor that will send the metrics.
@@ -1384,6 +1405,7 @@ module Aws::CloudWatchRUM
     #       },
     #       event_pattern: "EventPattern",
     #       name: "MetricName", # required
+    #       namespace: "Namespace",
     #       unit_label: "UnitLabel",
     #       value_key: "ValueKey",
     #     },
@@ -1412,7 +1434,7 @@ module Aws::CloudWatchRUM
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-cloudwatchrum'
-      context[:gem_version] = '1.8.0'
+      context[:gem_version] = '1.9.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-cloudwatchrum/client_api.rb

@@ -81,8 +81,11 @@ module Aws::CloudWatchRUM
     MetricDestinationSummary = Shapes::StructureShape.new(name: 'MetricDestinationSummary')
     MetricDestinationSummaryList = Shapes::ListShape.new(name: 'MetricDestinationSummaryList')
     MetricName = Shapes::StringShape.new(name: 'MetricName')
+    Namespace = Shapes::StringShape.new(name: 'Namespace')
     Pages = Shapes::ListShape.new(name: 'Pages')
     PutRumEventsRequest = Shapes::StructureShape.new(name: 'PutRumEventsRequest')
+    PutRumEventsRequestBatchIdString = Shapes::StringShape.new(name: 'PutRumEventsRequestBatchIdString')
+    PutRumEventsRequestIdString = Shapes::StringShape.new(name: 'PutRumEventsRequestIdString')
     PutRumEventsResponse = Shapes::StructureShape.new(name: 'PutRumEventsResponse')
     PutRumMetricsDestinationRequest = Shapes::StructureShape.new(name: 'PutRumMetricsDestinationRequest')
     PutRumMetricsDestinationResponse = Shapes::StructureShape.new(name: 'PutRumMetricsDestinationResponse')
@@ -94,6 +97,7 @@ module Aws::CloudWatchRUM
     QueryTimestamp = Shapes::IntegerShape.new(name: 'QueryTimestamp')
     ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
     RumEvent = Shapes::StructureShape.new(name: 'RumEvent')
+    RumEventIdString = Shapes::StringShape.new(name: 'RumEventIdString')
     RumEventList = Shapes::ListShape.new(name: 'RumEventList')
     ServiceQuotaExceededException = Shapes::StructureShape.new(name: 'ServiceQuotaExceededException')
     SessionSampleRate = Shapes::FloatShape.new(name: 'SessionSampleRate')
@@ -120,6 +124,8 @@ module Aws::CloudWatchRUM
     UpdateRumMetricDefinitionResponse = Shapes::StructureShape.new(name: 'UpdateRumMetricDefinitionResponse')
     Url = Shapes::StringShape.new(name: 'Url')
     UserDetails = Shapes::StructureShape.new(name: 'UserDetails')
+    UserDetailsSessionIdString = Shapes::StringShape.new(name: 'UserDetailsSessionIdString')
+    UserDetailsUserIdString = Shapes::StringShape.new(name: 'UserDetailsUserIdString')
     ValidationException = Shapes::StructureShape.new(name: 'ValidationException')
     ValueKey = Shapes::StringShape.new(name: 'ValueKey')
 
@@ -302,6 +308,7 @@ module Aws::CloudWatchRUM
     MetricDefinition.add_member(:event_pattern, Shapes::ShapeRef.new(shape: EventPattern, location_name: "EventPattern"))
     MetricDefinition.add_member(:metric_definition_id, Shapes::ShapeRef.new(shape: MetricDefinitionId, required: true, location_name: "MetricDefinitionId"))
     MetricDefinition.add_member(:name, Shapes::ShapeRef.new(shape: MetricName, required: true, location_name: "Name"))
+    MetricDefinition.add_member(:namespace, Shapes::ShapeRef.new(shape: Namespace, location_name: "Namespace"))
     MetricDefinition.add_member(:unit_label, Shapes::ShapeRef.new(shape: UnitLabel, location_name: "UnitLabel"))
     MetricDefinition.add_member(:value_key, Shapes::ShapeRef.new(shape: ValueKey, location_name: "ValueKey"))
     MetricDefinition.struct_class = Types::MetricDefinition
@@ -311,6 +318,7 @@ module Aws::CloudWatchRUM
     MetricDefinitionRequest.add_member(:dimension_keys, Shapes::ShapeRef.new(shape: DimensionKeysMap, location_name: "DimensionKeys"))
     MetricDefinitionRequest.add_member(:event_pattern, Shapes::ShapeRef.new(shape: EventPattern, location_name: "EventPattern"))
     MetricDefinitionRequest.add_member(:name, Shapes::ShapeRef.new(shape: MetricName, required: true, location_name: "Name"))
+    MetricDefinitionRequest.add_member(:namespace, Shapes::ShapeRef.new(shape: Namespace, location_name: "Namespace"))
     MetricDefinitionRequest.add_member(:unit_label, Shapes::ShapeRef.new(shape: UnitLabel, location_name: "UnitLabel"))
     MetricDefinitionRequest.add_member(:value_key, Shapes::ShapeRef.new(shape: ValueKey, location_name: "ValueKey"))
     MetricDefinitionRequest.struct_class = Types::MetricDefinitionRequest
@@ -329,8 +337,8 @@ module Aws::CloudWatchRUM
     Pages.member = Shapes::ShapeRef.new(shape: Url)
 
     PutRumEventsRequest.add_member(:app_monitor_details, Shapes::ShapeRef.new(shape: AppMonitorDetails, required: true, location_name: "AppMonitorDetails"))
-    PutRumEventsRequest.add_member(:batch_id, Shapes::ShapeRef.new(shape: String, required: true, location_name: "BatchId"))
-    PutRumEventsRequest.add_member(:id, Shapes::ShapeRef.new(shape: AppMonitorId, required: true, location: "uri", location_name: "Id"))
+    PutRumEventsRequest.add_member(:batch_id, Shapes::ShapeRef.new(shape: PutRumEventsRequestBatchIdString, required: true, location_name: "BatchId"))
+    PutRumEventsRequest.add_member(:id, Shapes::ShapeRef.new(shape: PutRumEventsRequestIdString, required: true, location: "uri", location_name: "Id"))
     PutRumEventsRequest.add_member(:rum_events, Shapes::ShapeRef.new(shape: RumEventList, required: true, location_name: "RumEvents"))
     PutRumEventsRequest.add_member(:user_details, Shapes::ShapeRef.new(shape: UserDetails, required: true, location_name: "UserDetails"))
     PutRumEventsRequest.struct_class = Types::PutRumEventsRequest
@@ -359,7 +367,7 @@ module Aws::CloudWatchRUM
     ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
 
     RumEvent.add_member(:details, Shapes::ShapeRef.new(shape: JsonValue, required: true, location_name: "details", metadata: {"jsonvalue"=>true}))
-    RumEvent.add_member(:id, Shapes::ShapeRef.new(shape: String, required: true, location_name: "id"))
+    RumEvent.add_member(:id, Shapes::ShapeRef.new(shape: RumEventIdString, required: true, location_name: "id"))
     RumEvent.add_member(:metadata, Shapes::ShapeRef.new(shape: JsonValue, location_name: "metadata", metadata: {"jsonvalue"=>true}))
     RumEvent.add_member(:timestamp, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "timestamp"))
     RumEvent.add_member(:type, Shapes::ShapeRef.new(shape: String, required: true, location_name: "type"))
@@ -417,8 +425,8 @@ module Aws::CloudWatchRUM
 
     UpdateRumMetricDefinitionResponse.struct_class = Types::UpdateRumMetricDefinitionResponse
 
-    UserDetails.add_member(:session_id, Shapes::ShapeRef.new(shape: String, location_name: "sessionId"))
-    UserDetails.add_member(:user_id, Shapes::ShapeRef.new(shape: String, location_name: "userId"))
+    UserDetails.add_member(:session_id, Shapes::ShapeRef.new(shape: UserDetailsSessionIdString, location_name: "sessionId"))
+    UserDetails.add_member(:user_id, Shapes::ShapeRef.new(shape: UserDetailsUserIdString, location_name: "userId"))
     UserDetails.struct_class = Types::UserDetails
 
     ValidationException.add_member(:message, Shapes::ShapeRef.new(shape: String, required: true, location_name: "message"))

data/lib/aws-sdk-cloudwatchrum/endpoint_provider.rb

@@ -14,36 +14,39 @@ module Aws::CloudWatchRUM
       use_dual_stack = parameters.use_dual_stack
       use_fips = parameters.use_fips
       endpoint = parameters.endpoint
-      if (partition_result = Aws::Endpoints::Matchers.aws_partition(region))
-        if Aws::Endpoints::Matchers.set?(endpoint) && (url = Aws::Endpoints::Matchers.parse_url(endpoint))
-          if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
-            raise ArgumentError, "Invalid Configuration: FIPS and custom endpoint are not supported"
-          end
-          if Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
-            raise ArgumentError, "Invalid Configuration: Dualstack and custom endpoint are not supported"
-          end
-          return Aws::Endpoints::Endpoint.new(url: endpoint, headers: {}, properties: {})
-        end
-        if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true) && Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
-          if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS")) && Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsDualStack"))
-            return Aws::Endpoints::Endpoint.new(url: "https://rum-fips.#{region}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {})
-          end
-          raise ArgumentError, "FIPS and DualStack are enabled, but this partition does not support one or both"
-        end
+      if Aws::Endpoints::Matchers.set?(endpoint)
         if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
-          if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"))
-            return Aws::Endpoints::Endpoint.new(url: "https://rum-fips.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
-          end
-          raise ArgumentError, "FIPS is enabled but this partition does not support FIPS"
+          raise ArgumentError, "Invalid Configuration: FIPS and custom endpoint are not supported"
         end
         if Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
-          if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsDualStack"))
-            return Aws::Endpoints::Endpoint.new(url: "https://rum.#{region}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {})
+          raise ArgumentError, "Invalid Configuration: Dualstack and custom endpoint are not supported"
+        end
+        return Aws::Endpoints::Endpoint.new(url: endpoint, headers: {}, properties: {})
+      end
+      if Aws::Endpoints::Matchers.set?(region)
+        if (partition_result = Aws::Endpoints::Matchers.aws_partition(region))
+          if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true) && Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
+            if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS")) && Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsDualStack"))
+              return Aws::Endpoints::Endpoint.new(url: "https://rum-fips.#{region}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {})
+            end
+            raise ArgumentError, "FIPS and DualStack are enabled, but this partition does not support one or both"
+          end
+          if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
+            if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"))
+              return Aws::Endpoints::Endpoint.new(url: "https://rum-fips.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
+            end
+            raise ArgumentError, "FIPS is enabled but this partition does not support FIPS"
+          end
+          if Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
+            if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsDualStack"))
+              return Aws::Endpoints::Endpoint.new(url: "https://rum.#{region}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {})
+            end
+            raise ArgumentError, "DualStack is enabled but this partition does not support DualStack"
           end
-          raise ArgumentError, "DualStack is enabled but this partition does not support DualStack"
+          return Aws::Endpoints::Endpoint.new(url: "https://rum.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
         end
-        return Aws::Endpoints::Endpoint.new(url: "https://rum.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
       end
+      raise ArgumentError, "Invalid Configuration: Missing Region"
       raise ArgumentError, 'No endpoint could be resolved'
 
     end

data/lib/aws-sdk-cloudwatchrum/types.rb

@@ -965,6 +965,12 @@ module Aws::CloudWatchRUM
     #   The name of the metric that is defined in this structure.
     #   @return [String]
     #
+    # @!attribute [rw] 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.
+    #   @return [String]
+    #
     # @!attribute [rw] unit_label
     #   Use this field only if you are sending this metric to CloudWatch. It
     #   defines the CloudWatch metric unit that this metric is measured in.
@@ -982,79 +988,151 @@ module Aws::CloudWatchRUM
       :event_pattern,
       :metric_definition_id,
       :name,
+      :namespace,
       :unit_label,
       :value_key)
       SENSITIVE = []
       include Aws::Structure
     end
 
-    # Use this structure to define one extended 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][1].
+    # 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][1].
+    #
+    # 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.
+    #
+    #   * If `Name` is `PerformanceNavigationDuration`, then `ValueKey`must
+    #     be `event_details.duration` and the `EventPattern` must include
+    #     `\{"event_type":["com.amazon.rum.performance_navigation_event"]\}`
+    #
+    #   * If `Name` is `PerformanceResourceDuration`, then `ValueKey`must be
+    #     `event_details.duration` and the `EventPattern` must include
+    #     `\{"event_type":["com.amazon.rum.performance_resource_event"]\}`
+    #
+    #   * If `Name` is `NavigationSatisfiedTransaction`, then `ValueKey`must
+    #     be null and the `EventPattern` must include `\{ "event_type":
+    #     ["com.amazon.rum.performance_navigation_event"], "event_details":
+    #     \{ "duration": [\{ "numeric": [">",2000] \}] \} \}`
+    #
+    #   * If `Name` is `NavigationToleratedTransaction`, then `ValueKey`must
+    #     be null and the `EventPattern` must include `\{ "event_type":
+    #     ["com.amazon.rum.performance_navigation_event"], "event_details":
+    #     \{ "duration": [\{ "numeric": [">=",2000,"<"8000] \}] \} \}`
+    #
+    #   * If `Name` is `NavigationFrustratedTransaction`, then
+    #     `ValueKey`must be null and the `EventPattern` must include `\{
+    #     "event_type": ["com.amazon.rum.performance_navigation_event"],
+    #     "event_details": \{ "duration": [\{ "numeric": [">=",8000] \}] \}
+    #     \}`
+    #
+    #   * If `Name` is `WebVitalsCumulativeLayoutShift`, then `ValueKey`must
+    #     be `event_details.value` and the `EventPattern` must include
+    #     `\{"event_type":["com.amazon.rum.cumulative_layout_shift_event"]\}`
+    #
+    #   * If `Name` is `WebVitalsFirstInputDelay`, then `ValueKey`must be
+    #     `event_details.value` and the `EventPattern` must include
+    #     `\{"event_type":["com.amazon.rum.first_input_delay_event"]\}`
+    #
+    #   * If `Name` is `WebVitalsLargestContentfulPaint`, then
+    #     `ValueKey`must be `event_details.value` and the `EventPattern`
+    #     must include
+    #     `\{"event_type":["com.amazon.rum.largest_contentful_paint_event"]\}`
+    #
+    #   * If `Name` is `JsErrorCount`, then `ValueKey`must be null and the
+    #     `EventPattern` must include
+    #     `\{"event_type":["com.amazon.rum.js_error_event"]\}`
+    #
+    #   * If `Name` is `HttpErrorCount`, then `ValueKey`must be null and the
+    #     `EventPattern` must include
+    #     `\{"event_type":["com.amazon.rum.http_event"]\}`
+    #
+    #   * If `Name` is `SessionCount`, then `ValueKey`must be null and the
+    #     `EventPattern` must include
+    #     `\{"event_type":["com.amazon.rum.session_start_event"]\}`
     #
-    # 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.
+    # For custom metrics, the following validation rules apply:
     #
-    # * If `Name` is `PerformanceNavigationDuration`, then `ValueKey`must be
-    #   `event_details.duration` and the `EventPattern` must include
-    #   `\{"event_type":["com.amazon.rum.performance_navigation_event"]\}`
+    # * The namespace can't be omitted and can't be `AWS/RUM`. You can use
+    #   the `AWS/RUM` namespace only for extended metrics.
     #
-    # * If `Name` is `PerformanceResourceDuration`, then `ValueKey`must be
-    #   `event_details.duration` and the `EventPattern` must include
-    #   `\{"event_type":["com.amazon.rum.performance_resource_event"]\}`
+    # * All dimensions listed in the `DimensionKeys` field must be present
+    #   in the value of `EventPattern`.
     #
-    # * If `Name` is `NavigationSatisfiedTransaction`, then `ValueKey`must
-    #   be null and the `EventPattern` must include `\{ "event_type":
-    #   ["com.amazon.rum.performance_navigation_event"], "event_details": \{
-    #   "duration": [\{ "numeric": [">",2000] \}] \} \}`
+    # * The values that you specify for `ValueKey`, `EventPattern`, and
+    #   `DimensionKeys` must be fields in RUM events, so all first-level
+    #   keys in these fields must be one of the keys in the list later in
+    #   this section.
     #
-    # * If `Name` is `NavigationToleratedTransaction`, then `ValueKey`must
-    #   be null and the `EventPattern` must include `\{ "event_type":
-    #   ["com.amazon.rum.performance_navigation_event"], "event_details": \{
-    #   "duration": [\{ "numeric": [">=",2000,"<"8000] \}] \} \}`
+    # * If you set a value for `EventPattern`, it must be a JSON object.
     #
-    # * If `Name` is `NavigationFrustratedTransaction`, then `ValueKey`must
-    #   be null and the `EventPattern` must include `\{ "event_type":
-    #   ["com.amazon.rum.performance_navigation_event"], "event_details": \{
-    #   "duration": [\{ "numeric": [">=",8000] \}] \} \}`
+    # * For every non-empty `event_details`, there must be a non-empty
+    #   `event_type`.
     #
-    # * If `Name` is `WebVitalsCumulativeLayoutShift`, then `ValueKey`must
-    #   be `event_details.value` and the `EventPattern` must include
-    #   `\{"event_type":["com.amazon.rum.cumulative_layout_shift_event"]\}`
+    # * If `EventPattern` contains an `event_details` field, it must also
+    #   contain an `event_type`. For every built-in `event_type` that you
+    #   use, you must use a value for `event_details` that corresponds to
+    #   that `event_type`. For information about event details that
+    #   correspond to event types, see [ RUM event details][2].
     #
-    # * If `Name` is `WebVitalsFirstInputDelay`, then `ValueKey`must be
-    #   `event_details.value` and the `EventPattern` must include
-    #   `\{"event_type":["com.amazon.rum.first_input_delay_event"]\}`
+    # * In `EventPattern`, any JSON array must contain only one value.
     #
-    # * If `Name` is `WebVitalsLargestContentfulPaint`, then `ValueKey`must
-    #   be `event_details.value` and the `EventPattern` must include
-    #   `\{"event_type":["com.amazon.rum.largest_contentful_paint_event"]\}`
+    # Valid key values for first-level keys in the `ValueKey`,
+    # `EventPattern`, and `DimensionKeys` fields:
     #
-    # * If `Name` is `JsErrorCount`, then `ValueKey`must be null and the
-    #   `EventPattern` must include
-    #   `\{"event_type":["com.amazon.rum.js_error_event"]\}`
+    # * `account_id`
     #
-    # * If `Name` is `HttpErrorCount`, then `ValueKey`must be null and the
-    #   `EventPattern` must include
-    #   `\{"event_type":["com.amazon.rum.http_event"]\}`
+    # * `application_Id`
     #
-    # * If `Name` is `SessionCount`, then `ValueKey`must be null and the
-    #   `EventPattern` must include
-    #   `\{"event_type":["com.amazon.rum.session_start_event"]\}`
+    # * `application_version`
+    #
+    # * `application_name`
+    #
+    # * `batch_id`
+    #
+    # * `event_details`
+    #
+    # * `event_id`
+    #
+    # * `event_interaction`
+    #
+    # * `event_timestamp`
+    #
+    # * `event_type`
+    #
+    # * `event_version`
+    #
+    # * `log_stream`
+    #
+    # * `metadata`
+    #
+    # * `sessionId`
+    #
+    # * `user_details`
+    #
+    # * `userId`
     #
     #
     #
     # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-vended-metrics.html
+    # [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-datacollected.html#CloudWatch-RUM-datacollected-eventDetails
     #
     # @!attribute [rw] dimension_keys
     #   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. Valid
-    #   values for the entries in this field are the following:
+    #   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"`
     #
@@ -1068,8 +1146,8 @@ module Aws::CloudWatchRUM
     #
     #   * `"event_details.fileType": "FileType"`
     #
-    #   All dimensions listed in this field must also be included in
-    #   `EventPattern`.
+    #   For both extended metrics and custom metrics, all dimensions listed
+    #   in this field must also be included in `EventPattern`.
     #   @return [Hash<String,String>]
     #
     # @!attribute [rw] event_pattern
@@ -1103,8 +1181,9 @@ module Aws::CloudWatchRUM
     #   @return [String]
     #
     # @!attribute [rw] name
-    #   The name for the metric that is defined in this structure. Valid
-    #   values are the following:
+    #   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`
     #
@@ -1129,6 +1208,16 @@ module Aws::CloudWatchRUM
     #   * `SessionCount`
     #   @return [String]
     #
+    # @!attribute [rw] 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.
+    #   @return [String]
+    #
     # @!attribute [rw] unit_label
     #   The CloudWatch metric unit to use for this metric. If you omit this
     #   field, the metric is recorded with no unit.
@@ -1153,6 +1242,7 @@ module Aws::CloudWatchRUM
       :dimension_keys,
       :event_pattern,
       :name,
+      :namespace,
       :unit_label,
       :value_key)
       SENSITIVE = []

data/lib/aws-sdk-cloudwatchrum.rb

@@ -52,6 +52,6 @@ require_relative 'aws-sdk-cloudwatchrum/customizations'
 # @!group service
 module Aws::CloudWatchRUM
 
-  GEM_VERSION = '1.8.0'
+  GEM_VERSION = '1.9.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-cloudwatchrum
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-18 00:00:00.000000000 Z
+date: 2023-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core