aws-sdk-cloudwatchrum 1.4.0 → 1.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cloudwatchrum/client.rb +473 -4
- data/lib/aws-sdk-cloudwatchrum/client_api.rb +256 -1
- data/lib/aws-sdk-cloudwatchrum/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-cloudwatchrum/endpoint_provider.rb +111 -0
- data/lib/aws-sdk-cloudwatchrum/endpoints.rb +253 -0
- data/lib/aws-sdk-cloudwatchrum/plugins/endpoints.rb +102 -0
- data/lib/aws-sdk-cloudwatchrum/types.rb +777 -9
- data/lib/aws-sdk-cloudwatchrum.rb +6 -2
- metadata +8 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d10d0ad2d26801ade4a75cd019519a35155108706603fbb3fc19cabf96ca1be5
|
4
|
+
data.tar.gz: 5f641ed525f185f87396f0d6027fb0e558dd0cfdbb57f09c2eaffd146bf7f3a4
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b59a451a8e30fdcdf337a33d1f6f37aceaa9fcda40fda63cbef8713572645a499578708551872c2a206eaa32f0e10bb25742db9ae5c031c0e757e32d486c1cfb
|
7
|
+
data.tar.gz: a14a249facfaeeb3df7160166409975fb8daf02a02a77119b29796189f9f05d281eb6c8eae2e953f19070571d4cde14af1a84cfbb4a481eb7f717d211fede55c
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.6.0 (2022-10-25)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.5.0 (2022-10-20)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - CloudWatch RUM now supports Extended CloudWatch Metrics with Additional Dimensions
|
13
|
+
|
4
14
|
1.4.0 (2022-02-24)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.6.0
|
@@ -30,7 +30,7 @@ require 'aws-sdk-core/plugins/http_checksum.rb'
|
|
30
30
|
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
31
31
|
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
32
32
|
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
33
|
-
require 'aws-sdk-core/plugins/
|
33
|
+
require 'aws-sdk-core/plugins/sign.rb'
|
34
34
|
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
35
35
|
|
36
36
|
Aws::Plugins::GlobalConfiguration.add_identifier(:cloudwatchrum)
|
@@ -79,8 +79,9 @@ module Aws::CloudWatchRUM
|
|
79
79
|
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
80
80
|
add_plugin(Aws::Plugins::DefaultsMode)
|
81
81
|
add_plugin(Aws::Plugins::RecursionDetection)
|
82
|
-
add_plugin(Aws::Plugins::
|
82
|
+
add_plugin(Aws::Plugins::Sign)
|
83
83
|
add_plugin(Aws::Plugins::Protocols::RestJson)
|
84
|
+
add_plugin(Aws::CloudWatchRUM::Plugins::Endpoints)
|
84
85
|
|
85
86
|
# @overload initialize(options)
|
86
87
|
# @param [Hash] options
|
@@ -287,6 +288,19 @@ module Aws::CloudWatchRUM
|
|
287
288
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
288
289
|
# requests are made, and retries are disabled.
|
289
290
|
#
|
291
|
+
# @option options [Aws::TokenProvider] :token_provider
|
292
|
+
# A Bearer Token Provider. This can be an instance of any one of the
|
293
|
+
# following classes:
|
294
|
+
#
|
295
|
+
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
296
|
+
# tokens.
|
297
|
+
#
|
298
|
+
# * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
|
299
|
+
# access token generated from `aws login`.
|
300
|
+
#
|
301
|
+
# When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
|
302
|
+
# will be used to search for tokens configured for your profile in shared configuration files.
|
303
|
+
#
|
290
304
|
# @option options [Boolean] :use_dualstack_endpoint
|
291
305
|
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
292
306
|
# will be used if available.
|
@@ -300,6 +314,9 @@ module Aws::CloudWatchRUM
|
|
300
314
|
# When `true`, request parameters are validated before
|
301
315
|
# sending the request.
|
302
316
|
#
|
317
|
+
# @option options [Aws::CloudWatchRUM::EndpointProvider] :endpoint_provider
|
318
|
+
# The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::CloudWatchRUM::EndpointParameters`
|
319
|
+
#
|
303
320
|
# @option options [URI::HTTP,String] :http_proxy A proxy to send
|
304
321
|
# requests through. Formatted like 'http://proxy.com:123'.
|
305
322
|
#
|
@@ -351,6 +368,244 @@ module Aws::CloudWatchRUM
|
|
351
368
|
|
352
369
|
# @!group API Operations
|
353
370
|
|
371
|
+
# Specifies the extended metrics that you want a CloudWatch RUM app
|
372
|
+
# monitor to send to a destination. Valid destinations include
|
373
|
+
# CloudWatch and Evidently.
|
374
|
+
#
|
375
|
+
# By default, RUM app monitors send some metrics to CloudWatch. These
|
376
|
+
# default metrics are listed in [CloudWatch metrics that you can collect
|
377
|
+
# with CloudWatch RUM][1].
|
378
|
+
#
|
379
|
+
# If you also send extended metrics, you can send metrics to Evidently
|
380
|
+
# as well as CloudWatch, and you can also optionally send the metrics
|
381
|
+
# with additional dimensions. The valid dimension names for the
|
382
|
+
# additional dimensions are `BrowserName`, `CountryCode`, `DeviceType`,
|
383
|
+
# `FileType`, `OSName`, and `PageId`. For more information, see [
|
384
|
+
# Extended metrics that you can send to CloudWatch and CloudWatch
|
385
|
+
# Evidently][2].
|
386
|
+
#
|
387
|
+
# The maximum number of metric definitions that you can specify in one
|
388
|
+
# `BatchCreateRumMetricDefinitions` operation is 200.
|
389
|
+
#
|
390
|
+
# <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>
|
391
|
+
#
|
392
|
+
#
|
393
|
+
#
|
394
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-metrics.html
|
395
|
+
# [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-vended-metrics.html
|
396
|
+
#
|
397
|
+
# @option params [required, String] :app_monitor_name
|
398
|
+
# The name of the CloudWatch RUM app monitor that is to send the
|
399
|
+
# metrics.
|
400
|
+
#
|
401
|
+
# @option params [required, String] :destination
|
402
|
+
# The destination to send the metrics to. Valid values are `CloudWatch`
|
403
|
+
# and `Evidently`. If you specify `Evidently`, you must also specify the
|
404
|
+
# ARN of the CloudWatchEvidently experiment that will receive the
|
405
|
+
# metrics and an IAM role that has permission to write to the
|
406
|
+
# experiment.
|
407
|
+
#
|
408
|
+
# @option params [String] :destination_arn
|
409
|
+
# This parameter is required if `Destination` is `Evidently`. If
|
410
|
+
# `Destination` is `CloudWatch`, do not use this parameter.
|
411
|
+
#
|
412
|
+
# This parameter specifies the ARN of the Evidently experiment that is
|
413
|
+
# to receive the metrics. You must have already defined this experiment
|
414
|
+
# as a valid destination. For more information, see
|
415
|
+
# [PutRumMetricsDestination][1].
|
416
|
+
#
|
417
|
+
#
|
418
|
+
#
|
419
|
+
# [1]: https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_PutRumMetricsDestination.html
|
420
|
+
#
|
421
|
+
# @option params [required, Array<Types::MetricDefinitionRequest>] :metric_definitions
|
422
|
+
# An array of structures which define the metrics that you want to send.
|
423
|
+
#
|
424
|
+
# @return [Types::BatchCreateRumMetricDefinitionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
425
|
+
#
|
426
|
+
# * {Types::BatchCreateRumMetricDefinitionsResponse#errors #errors} => Array<Types::BatchCreateRumMetricDefinitionsError>
|
427
|
+
# * {Types::BatchCreateRumMetricDefinitionsResponse#metric_definitions #metric_definitions} => Array<Types::MetricDefinition>
|
428
|
+
#
|
429
|
+
# @example Request syntax with placeholder values
|
430
|
+
#
|
431
|
+
# resp = client.batch_create_rum_metric_definitions({
|
432
|
+
# app_monitor_name: "AppMonitorName", # required
|
433
|
+
# destination: "CloudWatch", # required, accepts CloudWatch, Evidently
|
434
|
+
# destination_arn: "DestinationArn",
|
435
|
+
# metric_definitions: [ # required
|
436
|
+
# {
|
437
|
+
# dimension_keys: {
|
438
|
+
# "DimensionKey" => "DimensionName",
|
439
|
+
# },
|
440
|
+
# event_pattern: "EventPattern",
|
441
|
+
# name: "MetricName", # required
|
442
|
+
# unit_label: "UnitLabel",
|
443
|
+
# value_key: "ValueKey",
|
444
|
+
# },
|
445
|
+
# ],
|
446
|
+
# })
|
447
|
+
#
|
448
|
+
# @example Response structure
|
449
|
+
#
|
450
|
+
# resp.errors #=> Array
|
451
|
+
# resp.errors[0].error_code #=> String
|
452
|
+
# resp.errors[0].error_message #=> String
|
453
|
+
# resp.errors[0].metric_definition.dimension_keys #=> Hash
|
454
|
+
# resp.errors[0].metric_definition.dimension_keys["DimensionKey"] #=> String
|
455
|
+
# resp.errors[0].metric_definition.event_pattern #=> String
|
456
|
+
# resp.errors[0].metric_definition.name #=> String
|
457
|
+
# resp.errors[0].metric_definition.unit_label #=> String
|
458
|
+
# resp.errors[0].metric_definition.value_key #=> String
|
459
|
+
# resp.metric_definitions #=> Array
|
460
|
+
# resp.metric_definitions[0].dimension_keys #=> Hash
|
461
|
+
# resp.metric_definitions[0].dimension_keys["DimensionKey"] #=> String
|
462
|
+
# resp.metric_definitions[0].event_pattern #=> String
|
463
|
+
# resp.metric_definitions[0].metric_definition_id #=> String
|
464
|
+
# resp.metric_definitions[0].name #=> String
|
465
|
+
# resp.metric_definitions[0].unit_label #=> String
|
466
|
+
# resp.metric_definitions[0].value_key #=> String
|
467
|
+
#
|
468
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/BatchCreateRumMetricDefinitions AWS API Documentation
|
469
|
+
#
|
470
|
+
# @overload batch_create_rum_metric_definitions(params = {})
|
471
|
+
# @param [Hash] params ({})
|
472
|
+
def batch_create_rum_metric_definitions(params = {}, options = {})
|
473
|
+
req = build_request(:batch_create_rum_metric_definitions, params)
|
474
|
+
req.send_request(options)
|
475
|
+
end
|
476
|
+
|
477
|
+
# Removes the specified metrics from being sent to an extended metrics
|
478
|
+
# destination.
|
479
|
+
#
|
480
|
+
# If some metric definition IDs specified in a
|
481
|
+
# `BatchDeleteRumMetricDefinitions` operations are not valid, those
|
482
|
+
# metric definitions fail and return errors, but all valid metric
|
483
|
+
# definition IDs in the same operation are still deleted.
|
484
|
+
#
|
485
|
+
# The maximum number of metric definitions that you can specify in one
|
486
|
+
# `BatchDeleteRumMetricDefinitions` operation is 200.
|
487
|
+
#
|
488
|
+
# @option params [required, String] :app_monitor_name
|
489
|
+
# The name of the CloudWatch RUM app monitor that is sending these
|
490
|
+
# metrics.
|
491
|
+
#
|
492
|
+
# @option params [required, String] :destination
|
493
|
+
# Defines the destination where you want to stop sending the specified
|
494
|
+
# metrics. Valid values are `CloudWatch` and `Evidently`. If you specify
|
495
|
+
# `Evidently`, you must also specify the ARN of the CloudWatchEvidently
|
496
|
+
# experiment that is to be the destination and an IAM role that has
|
497
|
+
# permission to write to the experiment.
|
498
|
+
#
|
499
|
+
# @option params [String] :destination_arn
|
500
|
+
# This parameter is required if `Destination` is `Evidently`. If
|
501
|
+
# `Destination` is `CloudWatch`, do not use this parameter.
|
502
|
+
#
|
503
|
+
# This parameter specifies the ARN of the Evidently experiment that was
|
504
|
+
# receiving the metrics that are being deleted.
|
505
|
+
#
|
506
|
+
# @option params [required, Array<String>] :metric_definition_ids
|
507
|
+
# An array of structures which define the metrics that you want to stop
|
508
|
+
# sending.
|
509
|
+
#
|
510
|
+
# @return [Types::BatchDeleteRumMetricDefinitionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
511
|
+
#
|
512
|
+
# * {Types::BatchDeleteRumMetricDefinitionsResponse#errors #errors} => Array<Types::BatchDeleteRumMetricDefinitionsError>
|
513
|
+
# * {Types::BatchDeleteRumMetricDefinitionsResponse#metric_definition_ids #metric_definition_ids} => Array<String>
|
514
|
+
#
|
515
|
+
# @example Request syntax with placeholder values
|
516
|
+
#
|
517
|
+
# resp = client.batch_delete_rum_metric_definitions({
|
518
|
+
# app_monitor_name: "AppMonitorName", # required
|
519
|
+
# destination: "CloudWatch", # required, accepts CloudWatch, Evidently
|
520
|
+
# destination_arn: "DestinationArn",
|
521
|
+
# metric_definition_ids: ["MetricDefinitionId"], # required
|
522
|
+
# })
|
523
|
+
#
|
524
|
+
# @example Response structure
|
525
|
+
#
|
526
|
+
# resp.errors #=> Array
|
527
|
+
# resp.errors[0].error_code #=> String
|
528
|
+
# resp.errors[0].error_message #=> String
|
529
|
+
# resp.errors[0].metric_definition_id #=> String
|
530
|
+
# resp.metric_definition_ids #=> Array
|
531
|
+
# resp.metric_definition_ids[0] #=> String
|
532
|
+
#
|
533
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/BatchDeleteRumMetricDefinitions AWS API Documentation
|
534
|
+
#
|
535
|
+
# @overload batch_delete_rum_metric_definitions(params = {})
|
536
|
+
# @param [Hash] params ({})
|
537
|
+
def batch_delete_rum_metric_definitions(params = {}, options = {})
|
538
|
+
req = build_request(:batch_delete_rum_metric_definitions, params)
|
539
|
+
req.send_request(options)
|
540
|
+
end
|
541
|
+
|
542
|
+
# Retrieves the list of metrics and dimensions that a RUM app monitor is
|
543
|
+
# sending to a single destination.
|
544
|
+
#
|
545
|
+
# @option params [required, String] :app_monitor_name
|
546
|
+
# The name of the CloudWatch RUM app monitor that is sending the
|
547
|
+
# metrics.
|
548
|
+
#
|
549
|
+
# @option params [required, String] :destination
|
550
|
+
# The type of destination that you want to view metrics for. Valid
|
551
|
+
# values are `CloudWatch` and `Evidently`.
|
552
|
+
#
|
553
|
+
# @option params [String] :destination_arn
|
554
|
+
# This parameter is required if `Destination` is `Evidently`. If
|
555
|
+
# `Destination` is `CloudWatch`, do not use this parameter.
|
556
|
+
#
|
557
|
+
# This parameter specifies the ARN of the Evidently experiment that
|
558
|
+
# corresponds to the destination.
|
559
|
+
#
|
560
|
+
# @option params [Integer] :max_results
|
561
|
+
# The maximum number of results to return in one operation. The default
|
562
|
+
# is 50. The maximum that you can specify is 100.
|
563
|
+
#
|
564
|
+
# To retrieve the remaining results, make another call with the returned
|
565
|
+
# `NextToken` value.
|
566
|
+
#
|
567
|
+
# @option params [String] :next_token
|
568
|
+
# Use the token returned by the previous operation to request the next
|
569
|
+
# page of results.
|
570
|
+
#
|
571
|
+
# @return [Types::BatchGetRumMetricDefinitionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
572
|
+
#
|
573
|
+
# * {Types::BatchGetRumMetricDefinitionsResponse#metric_definitions #metric_definitions} => Array<Types::MetricDefinition>
|
574
|
+
# * {Types::BatchGetRumMetricDefinitionsResponse#next_token #next_token} => String
|
575
|
+
#
|
576
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
577
|
+
#
|
578
|
+
# @example Request syntax with placeholder values
|
579
|
+
#
|
580
|
+
# resp = client.batch_get_rum_metric_definitions({
|
581
|
+
# app_monitor_name: "AppMonitorName", # required
|
582
|
+
# destination: "CloudWatch", # required, accepts CloudWatch, Evidently
|
583
|
+
# destination_arn: "DestinationArn",
|
584
|
+
# max_results: 1,
|
585
|
+
# next_token: "String",
|
586
|
+
# })
|
587
|
+
#
|
588
|
+
# @example Response structure
|
589
|
+
#
|
590
|
+
# resp.metric_definitions #=> Array
|
591
|
+
# resp.metric_definitions[0].dimension_keys #=> Hash
|
592
|
+
# resp.metric_definitions[0].dimension_keys["DimensionKey"] #=> String
|
593
|
+
# resp.metric_definitions[0].event_pattern #=> String
|
594
|
+
# resp.metric_definitions[0].metric_definition_id #=> String
|
595
|
+
# resp.metric_definitions[0].name #=> String
|
596
|
+
# resp.metric_definitions[0].unit_label #=> String
|
597
|
+
# resp.metric_definitions[0].value_key #=> String
|
598
|
+
# resp.next_token #=> String
|
599
|
+
#
|
600
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/BatchGetRumMetricDefinitions AWS API Documentation
|
601
|
+
#
|
602
|
+
# @overload batch_get_rum_metric_definitions(params = {})
|
603
|
+
# @param [Hash] params ({})
|
604
|
+
def batch_get_rum_metric_definitions(params = {}, options = {})
|
605
|
+
req = build_request(:batch_get_rum_metric_definitions, params)
|
606
|
+
req.send_request(options)
|
607
|
+
end
|
608
|
+
|
354
609
|
# Creates a Amazon CloudWatch RUM app monitor, which collects telemetry
|
355
610
|
# data from your application and sends that data to RUM. The data
|
356
611
|
# includes performance and reliability information such as page load
|
@@ -475,6 +730,43 @@ module Aws::CloudWatchRUM
|
|
475
730
|
req.send_request(options)
|
476
731
|
end
|
477
732
|
|
733
|
+
# Deletes a destination for CloudWatch RUM extended metrics, so that the
|
734
|
+
# specified app monitor stops sending extended metrics to that
|
735
|
+
# destination.
|
736
|
+
#
|
737
|
+
# @option params [required, String] :app_monitor_name
|
738
|
+
# The name of the app monitor that is sending metrics to the destination
|
739
|
+
# that you want to delete.
|
740
|
+
#
|
741
|
+
# @option params [required, String] :destination
|
742
|
+
# The type of destination to delete. Valid values are `CloudWatch` and
|
743
|
+
# `Evidently`.
|
744
|
+
#
|
745
|
+
# @option params [String] :destination_arn
|
746
|
+
# This parameter is required if `Destination` is `Evidently`. If
|
747
|
+
# `Destination` is `CloudWatch`, do not use this parameter. This
|
748
|
+
# parameter specifies the ARN of the Evidently experiment that
|
749
|
+
# corresponds to the destination to delete.
|
750
|
+
#
|
751
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
752
|
+
#
|
753
|
+
# @example Request syntax with placeholder values
|
754
|
+
#
|
755
|
+
# resp = client.delete_rum_metrics_destination({
|
756
|
+
# app_monitor_name: "AppMonitorName", # required
|
757
|
+
# destination: "CloudWatch", # required, accepts CloudWatch, Evidently
|
758
|
+
# destination_arn: "DestinationArn",
|
759
|
+
# })
|
760
|
+
#
|
761
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/DeleteRumMetricsDestination AWS API Documentation
|
762
|
+
#
|
763
|
+
# @overload delete_rum_metrics_destination(params = {})
|
764
|
+
# @param [Hash] params ({})
|
765
|
+
def delete_rum_metrics_destination(params = {}, options = {})
|
766
|
+
req = build_request(:delete_rum_metrics_destination, params)
|
767
|
+
req.send_request(options)
|
768
|
+
end
|
769
|
+
|
478
770
|
# Retrieves the complete configuration information for one app monitor.
|
479
771
|
#
|
480
772
|
# @option params [required, String] :name
|
@@ -592,7 +884,8 @@ module Aws::CloudWatchRUM
|
|
592
884
|
# account.
|
593
885
|
#
|
594
886
|
# @option params [Integer] :max_results
|
595
|
-
# The maximum number of results to return in one operation.
|
887
|
+
# The maximum number of results to return in one operation. The default
|
888
|
+
# is 50. The maximum that you can specify is 100.
|
596
889
|
#
|
597
890
|
# @option params [String] :next_token
|
598
891
|
# Use the token returned by the previous operation to request the next
|
@@ -631,6 +924,62 @@ module Aws::CloudWatchRUM
|
|
631
924
|
req.send_request(options)
|
632
925
|
end
|
633
926
|
|
927
|
+
# Returns a list of destinations that you have created to receive RUM
|
928
|
+
# extended metrics, for the specified app monitor.
|
929
|
+
#
|
930
|
+
# For more information about extended metrics, see [AddRumMetrics][1].
|
931
|
+
#
|
932
|
+
#
|
933
|
+
#
|
934
|
+
# [1]: https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_AddRumMetrcs.html
|
935
|
+
#
|
936
|
+
# @option params [required, String] :app_monitor_name
|
937
|
+
# The name of the app monitor associated with the destinations that you
|
938
|
+
# want to retrieve.
|
939
|
+
#
|
940
|
+
# @option params [Integer] :max_results
|
941
|
+
# The maximum number of results to return in one operation. The default
|
942
|
+
# is 50. The maximum that you can specify is 100.
|
943
|
+
#
|
944
|
+
# To retrieve the remaining results, make another call with the returned
|
945
|
+
# `NextToken` value.
|
946
|
+
#
|
947
|
+
# @option params [String] :next_token
|
948
|
+
# Use the token returned by the previous operation to request the next
|
949
|
+
# page of results.
|
950
|
+
#
|
951
|
+
# @return [Types::ListRumMetricsDestinationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
952
|
+
#
|
953
|
+
# * {Types::ListRumMetricsDestinationsResponse#destinations #destinations} => Array<Types::MetricDestinationSummary>
|
954
|
+
# * {Types::ListRumMetricsDestinationsResponse#next_token #next_token} => String
|
955
|
+
#
|
956
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
957
|
+
#
|
958
|
+
# @example Request syntax with placeholder values
|
959
|
+
#
|
960
|
+
# resp = client.list_rum_metrics_destinations({
|
961
|
+
# app_monitor_name: "AppMonitorName", # required
|
962
|
+
# max_results: 1,
|
963
|
+
# next_token: "String",
|
964
|
+
# })
|
965
|
+
#
|
966
|
+
# @example Response structure
|
967
|
+
#
|
968
|
+
# resp.destinations #=> Array
|
969
|
+
# resp.destinations[0].destination #=> String, one of "CloudWatch", "Evidently"
|
970
|
+
# resp.destinations[0].destination_arn #=> String
|
971
|
+
# resp.destinations[0].iam_role_arn #=> String
|
972
|
+
# resp.next_token #=> String
|
973
|
+
#
|
974
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/ListRumMetricsDestinations AWS API Documentation
|
975
|
+
#
|
976
|
+
# @overload list_rum_metrics_destinations(params = {})
|
977
|
+
# @param [Hash] params ({})
|
978
|
+
def list_rum_metrics_destinations(params = {}, options = {})
|
979
|
+
req = build_request(:list_rum_metrics_destinations, params)
|
980
|
+
req.send_request(options)
|
981
|
+
end
|
982
|
+
|
634
983
|
# Displays the tags associated with a CloudWatch RUM resource.
|
635
984
|
#
|
636
985
|
# @option params [required, String] :resource_arn
|
@@ -723,6 +1072,59 @@ module Aws::CloudWatchRUM
|
|
723
1072
|
req.send_request(options)
|
724
1073
|
end
|
725
1074
|
|
1075
|
+
# Creates or updates a destination to receive extended metrics from
|
1076
|
+
# CloudWatch RUM. You can send extended metrics to CloudWatch or to a
|
1077
|
+
# CloudWatch Evidently experiment.
|
1078
|
+
#
|
1079
|
+
# For more information about extended metrics, see [AddRumMetrics][1].
|
1080
|
+
#
|
1081
|
+
#
|
1082
|
+
#
|
1083
|
+
# [1]: https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_AddRumMetrics.html
|
1084
|
+
#
|
1085
|
+
# @option params [required, String] :app_monitor_name
|
1086
|
+
# The name of the CloudWatch RUM app monitor that will send the metrics.
|
1087
|
+
#
|
1088
|
+
# @option params [required, String] :destination
|
1089
|
+
# Defines the destination to send the metrics to. Valid values are
|
1090
|
+
# `CloudWatch` and `Evidently`. If you specify `Evidently`, you must
|
1091
|
+
# also specify the ARN of the CloudWatchEvidently experiment that is to
|
1092
|
+
# be the destination and an IAM role that has permission to write to the
|
1093
|
+
# experiment.
|
1094
|
+
#
|
1095
|
+
# @option params [String] :destination_arn
|
1096
|
+
# Use this parameter only if `Destination` is `Evidently`. This
|
1097
|
+
# parameter specifies the ARN of the Evidently experiment that will
|
1098
|
+
# receive the extended metrics.
|
1099
|
+
#
|
1100
|
+
# @option params [String] :iam_role_arn
|
1101
|
+
# This parameter is required if `Destination` is `Evidently`. If
|
1102
|
+
# `Destination` is `CloudWatch`, do not use this parameter.
|
1103
|
+
#
|
1104
|
+
# This parameter specifies the ARN of an IAM role that RUM will assume
|
1105
|
+
# to write to the Evidently experiment that you are sending metrics to.
|
1106
|
+
# This role must have permission to write to that experiment.
|
1107
|
+
#
|
1108
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1109
|
+
#
|
1110
|
+
# @example Request syntax with placeholder values
|
1111
|
+
#
|
1112
|
+
# resp = client.put_rum_metrics_destination({
|
1113
|
+
# app_monitor_name: "AppMonitorName", # required
|
1114
|
+
# destination: "CloudWatch", # required, accepts CloudWatch, Evidently
|
1115
|
+
# destination_arn: "DestinationArn",
|
1116
|
+
# iam_role_arn: "IamRoleArn",
|
1117
|
+
# })
|
1118
|
+
#
|
1119
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/PutRumMetricsDestination AWS API Documentation
|
1120
|
+
#
|
1121
|
+
# @overload put_rum_metrics_destination(params = {})
|
1122
|
+
# @param [Hash] params ({})
|
1123
|
+
def put_rum_metrics_destination(params = {}, options = {})
|
1124
|
+
req = build_request(:put_rum_metrics_destination, params)
|
1125
|
+
req.send_request(options)
|
1126
|
+
end
|
1127
|
+
|
726
1128
|
# Assigns one or more tags (key-value pairs) to the specified CloudWatch
|
727
1129
|
# RUM resource. Currently, the only resources that can be tagged app
|
728
1130
|
# monitors.
|
@@ -880,6 +1282,73 @@ module Aws::CloudWatchRUM
|
|
880
1282
|
req.send_request(options)
|
881
1283
|
end
|
882
1284
|
|
1285
|
+
# Modifies one existing metric definition for CloudWatch RUM extended
|
1286
|
+
# metrics. For more information about extended metrics, see
|
1287
|
+
# [BatchCreateRumMetricsDefinitions][1].
|
1288
|
+
#
|
1289
|
+
#
|
1290
|
+
#
|
1291
|
+
# [1]: https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_BatchCreateRumMetricsDefinitions.html
|
1292
|
+
#
|
1293
|
+
# @option params [required, String] :app_monitor_name
|
1294
|
+
# The name of the CloudWatch RUM app monitor that sends these metrics.
|
1295
|
+
#
|
1296
|
+
# @option params [required, String] :destination
|
1297
|
+
# The destination to send the metrics to. Valid values are `CloudWatch`
|
1298
|
+
# and `Evidently`. If you specify `Evidently`, you must also specify the
|
1299
|
+
# ARN of the CloudWatchEvidently experiment that will receive the
|
1300
|
+
# metrics and an IAM role that has permission to write to the
|
1301
|
+
# experiment.
|
1302
|
+
#
|
1303
|
+
# @option params [String] :destination_arn
|
1304
|
+
# This parameter is required if `Destination` is `Evidently`. If
|
1305
|
+
# `Destination` is `CloudWatch`, do not use this parameter.
|
1306
|
+
#
|
1307
|
+
# This parameter specifies the ARN of the Evidently experiment that is
|
1308
|
+
# to receive the metrics. You must have already defined this experiment
|
1309
|
+
# as a valid destination. For more information, see
|
1310
|
+
# [PutRumMetricsDestination][1].
|
1311
|
+
#
|
1312
|
+
#
|
1313
|
+
#
|
1314
|
+
# [1]: https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_PutRumMetricsDestination.html
|
1315
|
+
#
|
1316
|
+
# @option params [required, Types::MetricDefinitionRequest] :metric_definition
|
1317
|
+
# A structure that contains the new definition that you want to use for
|
1318
|
+
# this metric.
|
1319
|
+
#
|
1320
|
+
# @option params [required, String] :metric_definition_id
|
1321
|
+
# The ID of the metric definition to update.
|
1322
|
+
#
|
1323
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1324
|
+
#
|
1325
|
+
# @example Request syntax with placeholder values
|
1326
|
+
#
|
1327
|
+
# resp = client.update_rum_metric_definition({
|
1328
|
+
# app_monitor_name: "AppMonitorName", # required
|
1329
|
+
# destination: "CloudWatch", # required, accepts CloudWatch, Evidently
|
1330
|
+
# destination_arn: "DestinationArn",
|
1331
|
+
# metric_definition: { # required
|
1332
|
+
# dimension_keys: {
|
1333
|
+
# "DimensionKey" => "DimensionName",
|
1334
|
+
# },
|
1335
|
+
# event_pattern: "EventPattern",
|
1336
|
+
# name: "MetricName", # required
|
1337
|
+
# unit_label: "UnitLabel",
|
1338
|
+
# value_key: "ValueKey",
|
1339
|
+
# },
|
1340
|
+
# metric_definition_id: "MetricDefinitionId", # required
|
1341
|
+
# })
|
1342
|
+
#
|
1343
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/UpdateRumMetricDefinition AWS API Documentation
|
1344
|
+
#
|
1345
|
+
# @overload update_rum_metric_definition(params = {})
|
1346
|
+
# @param [Hash] params ({})
|
1347
|
+
def update_rum_metric_definition(params = {}, options = {})
|
1348
|
+
req = build_request(:update_rum_metric_definition, params)
|
1349
|
+
req.send_request(options)
|
1350
|
+
end
|
1351
|
+
|
883
1352
|
# @!endgroup
|
884
1353
|
|
885
1354
|
# @param params ({})
|
@@ -893,7 +1362,7 @@ module Aws::CloudWatchRUM
|
|
893
1362
|
params: params,
|
894
1363
|
config: config)
|
895
1364
|
context[:gem_name] = 'aws-sdk-cloudwatchrum'
|
896
|
-
context[:gem_version] = '1.
|
1365
|
+
context[:gem_version] = '1.6.0'
|
897
1366
|
Seahorse::Client::Request.new(handlers, context)
|
898
1367
|
end
|
899
1368
|
|