aws-sdk-cloudwatchrum 1.19.0 → 1.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f57c12b93f2d224ba6feba5c9491e8d1704dd5adb77ec5d0ab9e10fe9f7ca967
-  data.tar.gz: 26acac08d5047c5b7446288429c9bec7ac2a8b94ff471845502cb61cb90e861d
+  metadata.gz: e877212df6f7d184132c5a3b0223e55ef3fd14da5123162409aeec7ab6c12cc7
+  data.tar.gz: 88ac93d18d001255f29e34d05575edeace3d5e1a709347ad65e813dc71a8fcd4
 SHA512:
-  metadata.gz: 8158e6d2757f8895bb2c81325367bdec2ef379cbb02551fa87c67133851cc02dd99ab574b1b575eedd5557255d3e75941b8548cc479a8f8b7b7f41e89c703a8b
-  data.tar.gz: 0d87e4b7962075cf5e8d90748693addde127cd0e00ff0cedc0aa1103298e3d40f600ff2e8704a90b42ecd977de735d4f62641346797d0433d4696a08ff165343
+  metadata.gz: 1df607880f09dd92075ce4543bc5b197d6465b135544939030d4d7fe27f9f6e65c09fd69da2ac9cff1dab723635a2499485c4ae9a25d9a6f7b35a73beb87729f
+  data.tar.gz: 57ba21456766bca57b3dc45b3aae6653502ff97b06218b3565264a63aadd5c26dae96b849ecb9068bc410acc7155023aee8a6eedd8961e69798242093e318f16

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.20.0 (2024-02-23)
+------------------
+
+* Feature - Doc-only update for new RUM metrics that were added
+
 1.19.0 (2024-01-26)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.19.0
+1.20.0

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

@@ -397,21 +397,21 @@ module Aws::CloudWatchRUM
     # with CloudWatch RUM][1].
     #
     # In addition to these default metrics, you can choose to send extended
-    # metrics or custom metrics or both.
+    # 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
+    # * 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][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.
+    #   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
@@ -453,9 +453,9 @@ module Aws::CloudWatchRUM
     # @option params [required, 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.
+    #   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.
     #
     # @option params [String] :destination_arn
     #   This parameter is required if `Destination` is `Evidently`. If
@@ -694,7 +694,7 @@ module Aws::CloudWatchRUM
     #
     #
     #
-    #   [1]: https://docs.aws.amazon.com/monitoring/CloudWatch-RUM-get-started-authorization.html
+    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-get-started-authorization.html
     #
     # @option params [Types::CustomEvents] :custom_events
     #   Specifies whether this app monitor allows the web client to define and
@@ -1177,12 +1177,22 @@ module Aws::CloudWatchRUM
     #
     # @option params [String] :iam_role_arn
     #   This parameter is required if `Destination` is `Evidently`. If
-    #   `Destination` is `CloudWatch`, do not use this parameter.
+    #   `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][1] permissions attached to it, to allow the role to be
+    #   passed. The [ CloudWatchAmazonCloudWatchRUMFullAccess][2] policy
+    #   doesn't include `PassRole` permissions.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html
+    #   [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/auth-and-access-control-cw.html#managed-policies-cloudwatch-RUM
+    #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
     # @example Request syntax with placeholder values
@@ -1314,7 +1324,7 @@ module Aws::CloudWatchRUM
     #
     #
     #
-    #   [1]: https://docs.aws.amazon.com/monitoring/CloudWatch-RUM-get-started-authorization.html
+    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-get-started-authorization.html
     #
     # @option params [Types::CustomEvents] :custom_events
     #   Specifies whether this app monitor allows the web client to define and
@@ -1454,7 +1464,7 @@ module Aws::CloudWatchRUM
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-cloudwatchrum'
-      context[:gem_version] = '1.19.0'
+      context[:gem_version] = '1.20.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -32,7 +32,7 @@ module Aws::CloudWatchRUM
             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"))
+            if Aws::Endpoints::Matchers.boolean_equals?(Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"), true)
               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"

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

@@ -139,6 +139,28 @@ module Aws::CloudWatchRUM
     # @!attribute [rw] guest_role_arn
     #   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.
+    #
+    #   <note markdown="1"> 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][1] 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][2] call to Amazon Cognito
+    #     to retrieve the `GuestRoleArn`.
+    #
+    #    </note>
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_GetAppMonitor.html
+    #   [2]: https://docs.aws.amazon.com/cognitoidentity/latest/APIReference/API_GetIdentityPoolRoles.html
     #   @return [String]
     #
     # @!attribute [rw] identity_pool_id
@@ -295,9 +317,9 @@ module Aws::CloudWatchRUM
     # @!attribute [rw] 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.
+    #   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.
     #   @return [String]
     #
     # @!attribute [rw] destination_arn
@@ -530,7 +552,7 @@ module Aws::CloudWatchRUM
     #
     #
     #
-    #   [1]: https://docs.aws.amazon.com/monitoring/CloudWatch-RUM-get-started-authorization.html
+    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-get-started-authorization.html
     #   @return [Types::AppMonitorConfiguration]
     #
     # @!attribute [rw] custom_events
@@ -997,8 +1019,8 @@ module Aws::CloudWatchRUM
 
     # 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].
+    # information, see [ Custom metrics and extended 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`
@@ -1008,8 +1030,8 @@ module Aws::CloudWatchRUM
     #
     # * 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.
+    #   following list, 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
@@ -1060,6 +1082,20 @@ module Aws::CloudWatchRUM
     #     `EventPattern` must include
     #     `\{"event_type":["com.amazon.rum.session_start_event"]\}`
     #
+    #   * If `Name` is `PageViewCount`, then `ValueKey`must be null and the
+    #     `EventPattern` must include
+    #     `\{"event_type":["com.amazon.rum.page_view_event"]\}`
+    #
+    #   * If `Name` is `Http4xxCount`, then `ValueKey`must 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 `ValueKey`must be null and the
+    #     `EventPattern` must include `\{"event_type":
+    #     ["com.amazon.rum.http_event"],"event_details":\{"response":\{"status":[\{"numeric":[">=",500,"<=",599]\}]\}\}\}
+    #     \}`
+    #
     # For custom metrics, the following validation rules apply:
     #
     # * The namespace can't be omitted and can't be `AWS/RUM`. You can use
@@ -1123,7 +1159,7 @@ module Aws::CloudWatchRUM
     #
     #
     #
-    # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-vended-metrics.html
+    # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-custom-and-extended-metrics.html
     # [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-datacollected.html#CloudWatch-RUM-datacollected-eventDetails
     #
     # @!attribute [rw] dimension_keys
@@ -1175,7 +1211,7 @@ module Aws::CloudWatchRUM
     #     "event_details": \{ "duration": [\{ "numeric": [ ">=", 2000, "<",
     #     8000 ] \}] \} \}'`
     #
-    #   If the metrics destination' is `CloudWatch` and the event also
+    #   If the metrics destination is `CloudWatch` and the event also
     #   matches a value in `DimensionKeys`, then the metric is published
     #   with the specified dimensions.
     #   @return [String]
@@ -1228,12 +1264,12 @@ module Aws::CloudWatchRUM
     #   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
+    #   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 and Evidently will handle data extraction
-    #   from the event.
+    #   passed to Evidently raw. Evidently will handle data extraction from
+    #   the event.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/MetricDefinitionRequest AWS API Documentation
@@ -1336,11 +1372,21 @@ module Aws::CloudWatchRUM
     #
     # @!attribute [rw] iam_role_arn
     #   This parameter is required if `Destination` is `Evidently`. If
-    #   `Destination` is `CloudWatch`, do not use this parameter.
+    #   `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][1] permissions attached to it, to allow the role to
+    #   be passed. The [ CloudWatchAmazonCloudWatchRUMFullAccess][2] policy
+    #   doesn't include `PassRole` permissions.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html
+    #   [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/auth-and-access-control-cw.html#managed-policies-cloudwatch-RUM
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/PutRumMetricsDestinationRequest AWS API Documentation
@@ -1573,7 +1619,7 @@ module Aws::CloudWatchRUM
     #
     #
     #
-    #   [1]: https://docs.aws.amazon.com/monitoring/CloudWatch-RUM-get-started-authorization.html
+    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-get-started-authorization.html
     #   @return [Types::AppMonitorConfiguration]
     #
     # @!attribute [rw] custom_events

data/lib/aws-sdk-cloudwatchrum.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-cloudwatchrum
 version: !ruby/object:Gem::Version
-  version: 1.19.0
+  version: 1.20.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-26 00:00:00.000000000 Z
+date: 2024-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core