aws-sdk-cloudwatchrum 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d10d0ad2d26801ade4a75cd019519a35155108706603fbb3fc19cabf96ca1be5
-  data.tar.gz: 5f641ed525f185f87396f0d6027fb0e558dd0cfdbb57f09c2eaffd146bf7f3a4
+  metadata.gz: 5c4ffa715c6ef074119e4f51f2289ad49a93231de51a2359e0ea1ed13f338de7
+  data.tar.gz: bc1c8f95291a15fc19905917cba8cd8bb81c37d3d94d45fa2bceac3c467f254e
 SHA512:
-  metadata.gz: b59a451a8e30fdcdf337a33d1f6f37aceaa9fcda40fda63cbef8713572645a499578708551872c2a206eaa32f0e10bb25742db9ae5c031c0e757e32d486c1cfb
-  data.tar.gz: a14a249facfaeeb3df7160166409975fb8daf02a02a77119b29796189f9f05d281eb6c8eae2e953f19070571d4cde14af1a84cfbb4a481eb7f717d211fede55c
+  metadata.gz: 63cf009014891534d489afd7196187759d92f1bf08bf7c47bb5edf110f0b749527f219725263fc84409a348c25d1d9cebe379553b5a9215d730cca1b1d57bf4c
+  data.tar.gz: 2ed9bfe8e31b06f402416befa77988a07e50a3f6c8972f5a28d8d975870683faccaa8b5c7d777a20a2bb2946545347955450c5b6045805880619a07cca038795

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.7.0 (2022-11-17)
+------------------
+
+* Feature - CloudWatch RUM now supports custom events. To use custom events, create an app monitor or update an app monitor with CustomEvent Status as ENABLED.
+
 1.6.0 (2022-10-25)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.6.0
+1.7.0

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

@@ -387,12 +387,28 @@ module Aws::CloudWatchRUM
     # The maximum number of metric definitions that you can specify in one
     # `BatchCreateRumMetricDefinitions` operation is 200.
     #
-    #      <p>The maximum number of metric definitions that one destination can contain is 2000.</p> <p>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 <a href="https://aws.amazon.com/cloudwatch/pricing/">Amazon CloudWatch Pricing</a>.</p> <p>You must have already created a destination for the metrics before you send them. For more information, see <a href="https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_PutRumMetricsDestination.html">PutRumMetricsDestination</a>.</p> <p>If some metric definitions specified in a <code>BatchCreateRumMetricDefinitions</code> operations are not valid, those metric definitions fail and return errors, but all valid metric definitions in the same operation still succeed.</p>
+    # 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].
+    #
+    # You must have already created a destination for the metrics before you
+    # send them. For more information, see [PutRumMetricsDestination][4].
+    #
+    # If some metric definitions specified in a
+    # `BatchCreateRumMetricDefinitions` operations are not valid, those
+    # metric definitions fail and return errors, but all valid metric
+    # definitions in the same operation still succeed.
     #
     #
     #
     # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-metrics.html
     # [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-vended-metrics.html
+    # [3]: https://aws.amazon.com/cloudwatch/pricing/
+    # [4]: https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_PutRumMetricsDestination.html
     #
     # @option params [required, String] :app_monitor_name
     #   The name of the CloudWatch RUM app monitor that is to send the
@@ -640,6 +656,17 @@ module Aws::CloudWatchRUM
     #
     #   [1]: https://docs.aws.amazon.com/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
+    #   send custom events. If you omit this parameter, custom events are
+    #   `DISABLED`.
+    #
+    #   For more information about custom events, see [Send custom events][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-custom-events.html
+    #
     # @option params [Boolean] :cw_log_enabled
     #   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
@@ -666,7 +693,13 @@ module Aws::CloudWatchRUM
     #   Tags don't have any semantic meaning to Amazon Web Services and are
     #   interpreted strictly as strings of characters.
     #
-    #        <p>You can associate as many as 50 tags with an app monitor.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
+    #   You can associate as many as 50 tags with an app monitor.
+    #
+    #   For more information, see [Tagging Amazon Web Services resources][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
     #
     # @return [Types::CreateAppMonitorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -686,6 +719,9 @@ module Aws::CloudWatchRUM
     #       session_sample_rate: 1.0,
     #       telemetries: ["errors"], # accepts errors, performance, http
     #     },
+    #     custom_events: {
+    #       status: "ENABLED", # accepts ENABLED, DISABLED
+    #     },
     #     cw_log_enabled: false,
     #     domain: "AppMonitorDomain", # required
     #     name: "AppMonitorName", # required
@@ -798,6 +834,7 @@ module Aws::CloudWatchRUM
     #   resp.app_monitor.app_monitor_configuration.telemetries #=> Array
     #   resp.app_monitor.app_monitor_configuration.telemetries[0] #=> String, one of "errors", "performance", "http"
     #   resp.app_monitor.created #=> String
+    #   resp.app_monitor.custom_events.status #=> String, one of "ENABLED", "DISABLED"
     #   resp.app_monitor.data_storage.cw_log.cw_log_enabled #=> Boolean
     #   resp.app_monitor.data_storage.cw_log.cw_log_group #=> String
     #   resp.app_monitor.domain #=> String
@@ -1238,6 +1275,16 @@ module Aws::CloudWatchRUM
     #
     #   [1]: https://docs.aws.amazon.com/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
+    #   send custom events. The default is for custom events to be `DISABLED`.
+    #
+    #   For more information about custom events, see [Send custom events][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-custom-events.html
+    #
     # @option params [Boolean] :cw_log_enabled
     #   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
@@ -1268,6 +1315,9 @@ module Aws::CloudWatchRUM
     #       session_sample_rate: 1.0,
     #       telemetries: ["errors"], # accepts errors, performance, http
     #     },
+    #     custom_events: {
+    #       status: "ENABLED", # accepts ENABLED, DISABLED
+    #     },
     #     cw_log_enabled: false,
     #     domain: "AppMonitorDomain",
     #     name: "AppMonitorName", # required
@@ -1362,7 +1412,7 @@ module Aws::CloudWatchRUM
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-cloudwatchrum'
-      context[:gem_version] = '1.6.0'
+      context[:gem_version] = '1.7.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -37,6 +37,8 @@ module Aws::CloudWatchRUM
     ConflictException = Shapes::StructureShape.new(name: 'ConflictException')
     CreateAppMonitorRequest = Shapes::StructureShape.new(name: 'CreateAppMonitorRequest')
     CreateAppMonitorResponse = Shapes::StructureShape.new(name: 'CreateAppMonitorResponse')
+    CustomEvents = Shapes::StructureShape.new(name: 'CustomEvents')
+    CustomEventsStatus = Shapes::StringShape.new(name: 'CustomEventsStatus')
     CwLog = Shapes::StructureShape.new(name: 'CwLog')
     DataStorage = Shapes::StructureShape.new(name: 'DataStorage')
     DeleteAppMonitorRequest = Shapes::StructureShape.new(name: 'DeleteAppMonitorRequest')
@@ -126,6 +128,7 @@ module Aws::CloudWatchRUM
 
     AppMonitor.add_member(:app_monitor_configuration, Shapes::ShapeRef.new(shape: AppMonitorConfiguration, location_name: "AppMonitorConfiguration"))
     AppMonitor.add_member(:created, Shapes::ShapeRef.new(shape: ISOTimestampString, location_name: "Created"))
+    AppMonitor.add_member(:custom_events, Shapes::ShapeRef.new(shape: CustomEvents, location_name: "CustomEvents"))
     AppMonitor.add_member(:data_storage, Shapes::ShapeRef.new(shape: DataStorage, location_name: "DataStorage"))
     AppMonitor.add_member(:domain, Shapes::ShapeRef.new(shape: AppMonitorDomain, location_name: "Domain"))
     AppMonitor.add_member(:id, Shapes::ShapeRef.new(shape: AppMonitorId, location_name: "Id"))
@@ -211,6 +214,7 @@ module Aws::CloudWatchRUM
     ConflictException.struct_class = Types::ConflictException
 
     CreateAppMonitorRequest.add_member(:app_monitor_configuration, Shapes::ShapeRef.new(shape: AppMonitorConfiguration, location_name: "AppMonitorConfiguration"))
+    CreateAppMonitorRequest.add_member(:custom_events, Shapes::ShapeRef.new(shape: CustomEvents, location_name: "CustomEvents"))
     CreateAppMonitorRequest.add_member(:cw_log_enabled, Shapes::ShapeRef.new(shape: Boolean, location_name: "CwLogEnabled"))
     CreateAppMonitorRequest.add_member(:domain, Shapes::ShapeRef.new(shape: AppMonitorDomain, required: true, location_name: "Domain"))
     CreateAppMonitorRequest.add_member(:name, Shapes::ShapeRef.new(shape: AppMonitorName, required: true, location_name: "Name"))
@@ -220,6 +224,9 @@ module Aws::CloudWatchRUM
     CreateAppMonitorResponse.add_member(:id, Shapes::ShapeRef.new(shape: AppMonitorId, location_name: "Id"))
     CreateAppMonitorResponse.struct_class = Types::CreateAppMonitorResponse
 
+    CustomEvents.add_member(:status, Shapes::ShapeRef.new(shape: CustomEventsStatus, location_name: "Status"))
+    CustomEvents.struct_class = Types::CustomEvents
+
     CwLog.add_member(:cw_log_enabled, Shapes::ShapeRef.new(shape: Boolean, location_name: "CwLogEnabled"))
     CwLog.add_member(:cw_log_group, Shapes::ShapeRef.new(shape: String, location_name: "CwLogGroup"))
     CwLog.struct_class = Types::CwLog
@@ -393,6 +400,7 @@ module Aws::CloudWatchRUM
     UntagResourceResponse.struct_class = Types::UntagResourceResponse
 
     UpdateAppMonitorRequest.add_member(:app_monitor_configuration, Shapes::ShapeRef.new(shape: AppMonitorConfiguration, location_name: "AppMonitorConfiguration"))
+    UpdateAppMonitorRequest.add_member(:custom_events, Shapes::ShapeRef.new(shape: CustomEvents, location_name: "CustomEvents"))
     UpdateAppMonitorRequest.add_member(:cw_log_enabled, Shapes::ShapeRef.new(shape: Boolean, location_name: "CwLogEnabled"))
     UpdateAppMonitorRequest.add_member(:domain, Shapes::ShapeRef.new(shape: AppMonitorDomain, location_name: "Domain"))
     UpdateAppMonitorRequest.add_member(:name, Shapes::ShapeRef.new(shape: AppMonitorName, required: true, location: "uri", location_name: "Name"))

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

@@ -37,6 +37,18 @@ module Aws::CloudWatchRUM
     #   The date and time that this app monitor was created.
     #   @return [String]
     #
+    # @!attribute [rw] custom_events
+    #   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][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-custom-events.html
+    #   @return [Types::CustomEvents]
+    #
     # @!attribute [rw] data_storage
     #   A structure that contains information about whether this app monitor
     #   stores a copy of the telemetry data that RUM collects using
@@ -74,6 +86,7 @@ module Aws::CloudWatchRUM
     class AppMonitor < Struct.new(
       :app_monitor_configuration,
       :created,
+      :custom_events,
       :data_storage,
       :domain,
       :id,
@@ -152,7 +165,8 @@ module Aws::CloudWatchRUM
     #   If this app monitor is to collect data from only certain pages in
     #   your application, this structure lists those pages.
     #
-    #        <p>You can't include both <code>ExcludedPages</code> and <code>IncludedPages</code> in the same operation.</p>
+    #   You can't include both `ExcludedPages` and `IncludedPages` in the
+    #   same operation.
     #   @return [Array<String>]
     #
     # @!attribute [rw] session_sample_rate
@@ -582,6 +596,9 @@ module Aws::CloudWatchRUM
     #           session_sample_rate: 1.0,
     #           telemetries: ["errors"], # accepts errors, performance, http
     #         },
+    #         custom_events: {
+    #           status: "ENABLED", # accepts ENABLED, DISABLED
+    #         },
     #         cw_log_enabled: false,
     #         domain: "AppMonitorDomain", # required
     #         name: "AppMonitorName", # required
@@ -607,6 +624,19 @@ module Aws::CloudWatchRUM
     #   [1]: https://docs.aws.amazon.com/monitoring/CloudWatch-RUM-get-started-authorization.html
     #   @return [Types::AppMonitorConfiguration]
     #
+    # @!attribute [rw] custom_events
+    #   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][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-custom-events.html
+    #   @return [Types::CustomEvents]
+    #
     # @!attribute [rw] cw_log_enabled
     #   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
@@ -637,13 +667,21 @@ module Aws::CloudWatchRUM
     #   Tags don't have any semantic meaning to Amazon Web Services and are
     #   interpreted strictly as strings of characters.
     #
-    #        <p>You can associate as many as 50 tags with an app monitor.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
+    #   You can associate as many as 50 tags with an app monitor.
+    #
+    #   For more information, see [Tagging Amazon Web Services
+    #   resources][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
     #   @return [Hash<String,String>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/CreateAppMonitorRequest AWS API Documentation
     #
     class CreateAppMonitorRequest < Struct.new(
       :app_monitor_configuration,
+      :custom_events,
       :cw_log_enabled,
       :domain,
       :name,
@@ -664,6 +702,30 @@ module Aws::CloudWatchRUM
       include Aws::Structure
     end
 
+    # A structure that contains information about custom events for this app
+    # monitor.
+    #
+    # @note When making an API call, you may pass CustomEvents
+    #   data as a hash:
+    #
+    #       {
+    #         status: "ENABLED", # accepts ENABLED, DISABLED
+    #       }
+    #
+    # @!attribute [rw] 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`.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/CustomEvents AWS API Documentation
+    #
+    class CustomEvents < Struct.new(
+      :status)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # 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
@@ -1182,9 +1244,9 @@ module Aws::CloudWatchRUM
     #   * `"metadata.countryCode": "CountryCode"`
     #
     #   * `"event_details.fileType": "FileType"`
-    #   ^
     #
-    #        <p> All dimensions listed in this field must also be included in <code>EventPattern</code>.</p>
+    #   All dimensions listed in this field must also be included in
+    #   `EventPattern`.
     #   @return [Hash<String,String>]
     #
     # @!attribute [rw] event_pattern
@@ -1683,6 +1745,9 @@ module Aws::CloudWatchRUM
     #           session_sample_rate: 1.0,
     #           telemetries: ["errors"], # accepts errors, performance, http
     #         },
+    #         custom_events: {
+    #           status: "ENABLED", # accepts ENABLED, DISABLED
+    #         },
     #         cw_log_enabled: false,
     #         domain: "AppMonitorDomain",
     #         name: "AppMonitorName", # required
@@ -1702,6 +1767,19 @@ module Aws::CloudWatchRUM
     #   [1]: https://docs.aws.amazon.com/monitoring/CloudWatch-RUM-get-started-authorization.html
     #   @return [Types::AppMonitorConfiguration]
     #
+    # @!attribute [rw] custom_events
+    #   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][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-custom-events.html
+    #   @return [Types::CustomEvents]
+    #
     # @!attribute [rw] cw_log_enabled
     #   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
@@ -1723,6 +1801,7 @@ module Aws::CloudWatchRUM
     #
     class UpdateAppMonitorRequest < Struct.new(
       :app_monitor_configuration,
+      :custom_events,
       :cw_log_enabled,
       :domain,
       :name)

data/lib/aws-sdk-cloudwatchrum.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-cloudwatchrum
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-25 00:00:00.000000000 Z
+date: 2022-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core