Class: Aws::CloudWatchRUM::Client

Inherits:
Seahorse::Client::Base show all
Includes:
Aws::ClientStubs
Defined in:
gems/aws-sdk-cloudwatchrum/lib/aws-sdk-cloudwatchrum/client.rb

Overview

An API client for CloudWatchRUM. To construct a client, you need to configure a :region and :credentials.

client = Aws::CloudWatchRUM::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from Aws::ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks. Takes effect only when disable_clock_skew_correction is not set.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_clock_skew_correction (Boolean) —

    Used only in standard and adaptive retry modes. When true, the SDK does not apply a clock skew correction, does not update its stored skew from responses, and does not retry clock skew errors. Clock skew correction is enabled by default.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is the default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling Aws::ClientStubs#stub_responses. See Aws::ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::CloudWatchRUM::EndpointProvider) —

    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.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



478
479
480
 
# File 'gems/aws-sdk-cloudwatchrum/lib/aws-sdk-cloudwatchrum/client.rb', line 478

def initialize(*args)
  super
end

Instance Method Details

#batch_create_rum_metric_definitions(params = {}) ⇒ Types::BatchCreateRumMetricDefinitionsResponse

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.

In addition to these default metrics, you can choose to send extended metrics, custom metrics, or both.

  • Extended metrics let you send metrics with additional dimensions that aren't included in the default metrics. You can also send extended metrics to both Evidently and CloudWatch. The valid dimension names for the additional dimensions for extended metrics are BrowserName, CountryCode, DeviceType, FileType, OSName, and PageId. For more information, see Extended metrics that you can send to CloudWatch and CloudWatch Evidently.

  • Custom metrics are metrics that you define. You can send custom metrics to CloudWatch. CloudWatch Evidently, or both. With custom metrics, you can use any metric name and namespace. To derive the metrics, you can use any custom events, built-in events, custom attributes, or default attributes.

    You can't send custom metrics to the AWS/RUM namespace. You must send custom metrics to a custom namespace that you define. The namespace that you use can't start with AWS/. CloudWatch RUM prepends RUM/CustomMetrics/ to the custom namespace that you define, 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.

The maximum number of metric definitions that one destination can contain is 2000.

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.

You must have already created a destination for the metrics before you send them. For more information, see PutRumMetricsDestination.

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.

Examples:

Request syntax with placeholder values


resp = client.batch_create_rum_metric_definitions({
  app_monitor_name: "AppMonitorName", # required
  destination: "CloudWatch", # required, accepts CloudWatch, Evidently
  destination_arn: "DestinationArn",
  metric_definitions: [ # required
    {
      name: "MetricName", # required
      value_key: "ValueKey",
      unit_label: "UnitLabel",
      dimension_keys: {
        "DimensionKey" => "DimensionName",
      },
      event_pattern: "EventPattern",
      namespace: "Namespace",
    },
  ],
})

Response structure


resp.errors #=> Array
resp.errors[0].metric_definition.name #=> String
resp.errors[0].metric_definition.value_key #=> String
resp.errors[0].metric_definition.unit_label #=> String
resp.errors[0].metric_definition.dimension_keys #=> Hash
resp.errors[0].metric_definition.dimension_keys["DimensionKey"] #=> String
resp.errors[0].metric_definition.event_pattern #=> String
resp.errors[0].metric_definition.namespace #=> String
resp.errors[0].error_code #=> String
resp.errors[0].error_message #=> String
resp.metric_definitions #=> Array
resp.metric_definitions[0].metric_definition_id #=> String
resp.metric_definitions[0].name #=> String
resp.metric_definitions[0].value_key #=> String
resp.metric_definitions[0].unit_label #=> String
resp.metric_definitions[0].dimension_keys #=> Hash
resp.metric_definitions[0].dimension_keys["DimensionKey"] #=> String
resp.metric_definitions[0].event_pattern #=> String
resp.metric_definitions[0].namespace #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :app_monitor_name (required, String) —

    The name of the CloudWatch RUM app monitor that is to send the metrics.

  • :destination (required, String) —

    The destination to send the metrics to. Valid values are CloudWatch and Evidently. If you specify Evidently, you must also specify the Amazon Resource Name (ARN) of the CloudWatchEvidently experiment that will receive the metrics and an IAM role that has permission to write to the experiment.

  • :destination_arn (String) —

    This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter.

    This parameter specifies the ARN of the Evidently experiment that is to receive the metrics. You must have already defined this experiment as a valid destination. For more information, see PutRumMetricsDestination.

  • :metric_definitions (required, Array<Types::MetricDefinitionRequest>) —

    An array of structures which define the metrics that you want to send.

Returns:

See Also:



620
621
622
623
 
# File 'gems/aws-sdk-cloudwatchrum/lib/aws-sdk-cloudwatchrum/client.rb', line 620

def batch_create_rum_metric_definitions(params = {}, options = {})
  req = build_request(:batch_create_rum_metric_definitions, params)
  req.send_request(options)
end

#batch_delete_rum_metric_definitions(params = {}) ⇒ Types::BatchDeleteRumMetricDefinitionsResponse

Removes the specified metrics from being sent to an extended metrics destination.

If some metric definition IDs specified in a BatchDeleteRumMetricDefinitions operations are not valid, those metric definitions fail and return errors, but all valid metric definition IDs in the same operation are still deleted.

The maximum number of metric definitions that you can specify in one BatchDeleteRumMetricDefinitions operation is 200.

Examples:

Request syntax with placeholder values


resp = client.batch_delete_rum_metric_definitions({
  app_monitor_name: "AppMonitorName", # required
  destination: "CloudWatch", # required, accepts CloudWatch, Evidently
  destination_arn: "DestinationArn",
  metric_definition_ids: ["MetricDefinitionId"], # required
})

Response structure


resp.errors #=> Array
resp.errors[0].metric_definition_id #=> String
resp.errors[0].error_code #=> String
resp.errors[0].error_message #=> String
resp.metric_definition_ids #=> Array
resp.metric_definition_ids[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :app_monitor_name (required, String) —

    The name of the CloudWatch RUM app monitor that is sending these metrics.

  • :destination (required, String) —

    Defines the destination where you want to stop sending the specified metrics. Valid values are CloudWatch and Evidently. If you specify Evidently, you must also specify the ARN of the CloudWatchEvidently experiment that is to be the destination and an IAM role that has permission to write to the experiment.

  • :destination_arn (String) —

    This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter.

    This parameter specifies the ARN of the Evidently experiment that was receiving the metrics that are being deleted.

  • :metric_definition_ids (required, Array<String>) —

    An array of structures which define the metrics that you want to stop sending.

Returns:

See Also:



685
686
687
688
 
# File 'gems/aws-sdk-cloudwatchrum/lib/aws-sdk-cloudwatchrum/client.rb', line 685

def batch_delete_rum_metric_definitions(params = {}, options = {})
  req = build_request(:batch_delete_rum_metric_definitions, params)
  req.send_request(options)
end

#batch_get_rum_metric_definitions(params = {}) ⇒ Types::BatchGetRumMetricDefinitionsResponse

Retrieves the list of metrics and dimensions that a RUM app monitor is sending to a single destination.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.batch_get_rum_metric_definitions({
  app_monitor_name: "AppMonitorName", # required
  destination: "CloudWatch", # required, accepts CloudWatch, Evidently
  destination_arn: "DestinationArn",
  max_results: 1,
  next_token: "String",
})

Response structure


resp.metric_definitions #=> Array
resp.metric_definitions[0].metric_definition_id #=> String
resp.metric_definitions[0].name #=> String
resp.metric_definitions[0].value_key #=> String
resp.metric_definitions[0].unit_label #=> String
resp.metric_definitions[0].dimension_keys #=> Hash
resp.metric_definitions[0].dimension_keys["DimensionKey"] #=> String
resp.metric_definitions[0].event_pattern #=> String
resp.metric_definitions[0].namespace #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :app_monitor_name (required, String) —

    The name of the CloudWatch RUM app monitor that is sending the metrics.

  • :destination (required, String) —

    The type of destination that you want to view metrics for. Valid values are CloudWatch and Evidently.

  • :destination_arn (String) —

    This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter.

    This parameter specifies the ARN of the Evidently experiment that corresponds to the destination.

  • :max_results (Integer) —

    The maximum number of results to return in one operation. The default is 50. The maximum that you can specify is 100.

    To retrieve the remaining results, make another call with the returned NextToken value.

  • :next_token (String) —

    Use the token returned by the previous operation to request the next page of results.

Returns:

See Also:



753
754
755
756
 
# File 'gems/aws-sdk-cloudwatchrum/lib/aws-sdk-cloudwatchrum/client.rb', line 753

def batch_get_rum_metric_definitions(params = {}, options = {})
  req = build_request(:batch_get_rum_metric_definitions, params)
  req.send_request(options)
end

#create_app_monitor(params = {}) ⇒ Types::CreateAppMonitorResponse

Creates a Amazon CloudWatch RUM app monitor, which collects telemetry data from your application and sends that data to RUM. The data includes performance and reliability information such as page load time, client-side errors, and user behavior.

You use this operation only to create a new app monitor. To update an existing app monitor, use UpdateAppMonitor instead.

After you create an app monitor, sign in to the CloudWatch RUM console to get the JavaScript code snippet to add to your web application. For more information, see How do I find a code snippet that I've already generated?

Examples:

Request syntax with placeholder values


resp = client.create_app_monitor({
  name: "AppMonitorName", # required
  domain: "AppMonitorDomain",
  domain_list: ["AppMonitorDomain"],
  tags: {
    "TagKey" => "TagValue",
  },
  app_monitor_configuration: {
    identity_pool_id: "IdentityPoolId",
    excluded_pages: ["Url"],
    included_pages: ["Url"],
    favorite_pages: ["String"],
    session_sample_rate: 1.0,
    guest_role_arn: "Arn",
    allow_cookies: false,
    telemetries: ["errors"], # accepts errors, performance, http
    enable_x_ray: false,
  },
  cw_log_enabled: false,
  custom_events: {
    status: "ENABLED", # accepts ENABLED, DISABLED
  },
  deobfuscation_configuration: {
    java_script_source_maps: {
      status: "ENABLED", # required, accepts ENABLED, DISABLED
      s3_uri: "DeobfuscationS3Uri",
    },
  },
  platform: "Web", # accepts Web, Android, iOS
})

Response structure


resp.id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    A name for the app monitor.

  • :domain (String) —

    The top-level internet domain name for which your application has administrative authority.

  • :domain_list (Array<String>) —

    List the domain names for which your application has administrative authority. The CreateAppMonitor requires either the domain or the domain list.

  • :tags (Hash<String,String>) —

    Assigns one or more tags (key-value pairs) to the app monitor.

    Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

    Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

    You can associate as many as 50 tags with an app monitor.

    For more information, see Tagging Amazon Web Services resources.

  • :app_monitor_configuration (Types::AppMonitorConfiguration) —

    A structure that contains much of the configuration data for the app monitor. If you are using Amazon Cognito for authorization, you must include this structure in your request, and it must include the ID of the Amazon Cognito identity pool to use for authorization. If you don't include AppMonitorConfiguration, you must set up your own authorization method. For more information, see Authorize your application to send data to Amazon Web Services.

    If you omit this argument, the sample rate used for RUM is set to 10% of the user sessions.

  • :cw_log_enabled (Boolean) —

    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 data to Amazon CloudWatch Logs in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur Amazon CloudWatch Logs charges.

    If you omit this parameter, the default is false.

  • :custom_events (Types::CustomEvents) —

    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.

  • :deobfuscation_configuration (Types::DeobfuscationConfiguration) —

    A structure that contains the configuration for how an app monitor can deobfuscate stack traces.

  • :platform (String) —

    The platform type for the app monitor. Valid values are Web for web applications, Android for Android applications, and iOS for IOS applications. If you omit this parameter, the default is Web.

Returns:

See Also:



896
897
898
899
 
# File 'gems/aws-sdk-cloudwatchrum/lib/aws-sdk-cloudwatchrum/client.rb', line 896

def create_app_monitor(params = {}, options = {})
  req = build_request(:create_app_monitor, params)
  req.send_request(options)
end

#delete_app_monitor(params = {}) ⇒ Struct

Deletes an existing app monitor. This immediately stops the collection of data.

Examples:

Request syntax with placeholder values


resp = client.delete_app_monitor({
  name: "AppMonitorName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the app monitor to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



919
920
921
922
 
# File 'gems/aws-sdk-cloudwatchrum/lib/aws-sdk-cloudwatchrum/client.rb', line 919

def delete_app_monitor(params = {}, options = {})
  req = build_request(:delete_app_monitor, params)
  req.send_request(options)
end

#delete_resource_policy(params = {}) ⇒ Types::DeleteResourcePolicyResponse

Removes the association of a resource-based policy from an app monitor.

Examples:

Request syntax with placeholder values


resp = client.delete_resource_policy({
  name: "AppMonitorName", # required
  policy_revision_id: "PolicyRevisionId",
})

Response structure


resp.policy_revision_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The app monitor that you want to remove the resource policy from.

  • :policy_revision_id (String) —

    Specifies a specific policy revision to delete. Provide a PolicyRevisionId to ensure an atomic delete operation. If the revision ID that you provide doesn't match the latest policy revision ID, the request will be rejected with an InvalidPolicyRevisionIdException error.

Returns:

See Also:



956
957
958
959
 
# File 'gems/aws-sdk-cloudwatchrum/lib/aws-sdk-cloudwatchrum/client.rb', line 956

def delete_resource_policy(params = {}, options = {})
  req = build_request(:delete_resource_policy, params)
  req.send_request(options)
end

#delete_rum_metrics_destination(params = {}) ⇒ Struct

Deletes a destination for CloudWatch RUM extended metrics, so that the specified app monitor stops sending extended metrics to that destination.

Examples:

Request syntax with placeholder values


resp = client.delete_rum_metrics_destination({
  app_monitor_name: "AppMonitorName", # required
  destination: "CloudWatch", # required, accepts CloudWatch, Evidently
  destination_arn: "DestinationArn",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :app_monitor_name (required, String) —

    The name of the app monitor that is sending metrics to the destination that you want to delete.

  • :destination (required, String) —

    The type of destination to delete. Valid values are CloudWatch and Evidently.

  • :destination_arn (String) —

    This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter. This parameter specifies the ARN of the Evidently experiment that corresponds to the destination to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



993
994
995
996
 
# File 'gems/aws-sdk-cloudwatchrum/lib/aws-sdk-cloudwatchrum/client.rb', line 993

def delete_rum_metrics_destination(params = {}, options = {})
  req = build_request(:delete_rum_metrics_destination, params)
  req.send_request(options)
end

#get_app_monitor(params = {}) ⇒ Types::GetAppMonitorResponse

Retrieves the complete configuration information for one app monitor.

Examples:

Request syntax with placeholder values


resp = client.get_app_monitor({
  name: "AppMonitorName", # required
})

Response structure


resp.app_monitor.name #=> String
resp.app_monitor.domain #=> String
resp.app_monitor.domain_list #=> Array
resp.app_monitor.domain_list[0] #=> String
resp.app_monitor.id #=> String
resp.app_monitor.created #=> String
resp.app_monitor.last_modified #=> String
resp.app_monitor.tags #=> Hash
resp.app_monitor.tags["TagKey"] #=> String
resp.app_monitor.state #=> String, one of "CREATED", "DELETING", "ACTIVE"
resp.app_monitor.app_monitor_configuration.identity_pool_id #=> String
resp.app_monitor.app_monitor_configuration.excluded_pages #=> Array
resp.app_monitor.app_monitor_configuration.excluded_pages[0] #=> String
resp.app_monitor.app_monitor_configuration.included_pages #=> Array
resp.app_monitor.app_monitor_configuration.included_pages[0] #=> String
resp.app_monitor.app_monitor_configuration.favorite_pages #=> Array
resp.app_monitor.app_monitor_configuration.favorite_pages[0] #=> String
resp.app_monitor.app_monitor_configuration.session_sample_rate #=> Float
resp.app_monitor.app_monitor_configuration.guest_role_arn #=> String
resp.app_monitor.app_monitor_configuration.allow_cookies #=> Boolean
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.app_monitor_configuration.enable_x_ray #=> Boolean
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.custom_events.status #=> String, one of "ENABLED", "DISABLED"
resp.app_monitor.deobfuscation_configuration.java_script_source_maps.status #=> String, one of "ENABLED", "DISABLED"
resp.app_monitor.deobfuscation_configuration.java_script_source_maps.s3_uri #=> String
resp.app_monitor.platform #=> String, one of "Web", "Android", "iOS"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The app monitor to retrieve information for.

Returns:

See Also:



1049
1050
1051
1052
 
# File 'gems/aws-sdk-cloudwatchrum/lib/aws-sdk-cloudwatchrum/client.rb', line 1049

def get_app_monitor(params = {}, options = {})
  req = build_request(:get_app_monitor, params)
  req.send_request(options)
end

#get_app_monitor_data(params = {}) ⇒ Types::GetAppMonitorDataResponse

Retrieves the raw performance events that RUM has collected from your web application, so that you can do your own processing or analysis of this data.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_app_monitor_data({
  name: "AppMonitorName", # required
  time_range: { # required
    after: 1, # required
    before: 1,
  },
  filters: [
    {
      name: "QueryFilterKey",
      values: ["QueryFilterValue"],
    },
  ],
  max_results: 1,
  next_token: "Token",
})

Response structure


resp.events #=> Array
resp.events[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the app monitor that collected the data that you want to retrieve.

  • :time_range (required, Types::TimeRange) —

    A structure that defines the time range that you want to retrieve results from.

  • :filters (Array<Types::QueryFilter>) —

    An array of structures that you can use to filter the results to those that match one or more sets of key-value pairs that you specify.

  • :max_results (Integer) —

    The maximum number of results to return in one operation.

  • :next_token (String) —

    Use the token returned by the previous operation to request the next page of results.

Returns:

See Also:



1112
1113
1114
1115
 
# File 'gems/aws-sdk-cloudwatchrum/lib/aws-sdk-cloudwatchrum/client.rb', line 1112

def get_app_monitor_data(params = {}, options = {})
  req = build_request(:get_app_monitor_data, params)
  req.send_request(options)
end

#get_resource_policy(params = {}) ⇒ Types::GetResourcePolicyResponse

Use this operation to retrieve information about a resource-based policy that is attached to an app monitor.

Examples:

Request syntax with placeholder values


resp = client.get_resource_policy({
  name: "AppMonitorName", # required
})

Response structure


resp.policy_document #=> String
resp.policy_revision_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the app monitor that is associated with the resource-based policy that you want to view.

Returns:

See Also:



1144
1145
1146
1147
 
# File 'gems/aws-sdk-cloudwatchrum/lib/aws-sdk-cloudwatchrum/client.rb', line 1144

def get_resource_policy(params = {}, options = {})
  req = build_request(:get_resource_policy, params)
  req.send_request(options)
end

#list_app_monitors(params = {}) ⇒ Types::ListAppMonitorsResponse

Returns a list of the Amazon CloudWatch RUM app monitors in the account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_app_monitors({
  max_results: 1,
  next_token: "String",
})

Response structure


resp.next_token #=> String
resp.app_monitor_summaries #=> Array
resp.app_monitor_summaries[0].name #=> String
resp.app_monitor_summaries[0].id #=> String
resp.app_monitor_summaries[0].created #=> String
resp.app_monitor_summaries[0].last_modified #=> String
resp.app_monitor_summaries[0].state #=> String, one of "CREATED", "DELETING", "ACTIVE"
resp.app_monitor_summaries[0].platform #=> String, one of "Web", "Android", "iOS"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to return in one operation. The default is 50. The maximum that you can specify is 100.

  • :next_token (String) —

    Use the token returned by the previous operation to request the next page of results.

Returns:

See Also:



1189
1190
1191
1192
 
# File 'gems/aws-sdk-cloudwatchrum/lib/aws-sdk-cloudwatchrum/client.rb', line 1189

def list_app_monitors(params = {}, options = {})
  req = build_request(:list_app_monitors, params)
  req.send_request(options)
end

#list_rum_metrics_destinations(params = {}) ⇒ Types::ListRumMetricsDestinationsResponse

Returns a list of destinations that you have created to receive RUM extended metrics, for the specified app monitor.

For more information about extended metrics, see AddRumMetrics.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_rum_metrics_destinations({
  app_monitor_name: "AppMonitorName", # required
  max_results: 1,
  next_token: "String",
})

Response structure


resp.destinations #=> Array
resp.destinations[0].destination #=> String, one of "CloudWatch", "Evidently"
resp.destinations[0].destination_arn #=> String
resp.destinations[0].iam_role_arn #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :app_monitor_name (required, String) —

    The name of the app monitor associated with the destinations that you want to retrieve.

  • :max_results (Integer) —

    The maximum number of results to return in one operation. The default is 50. The maximum that you can specify is 100.

    To retrieve the remaining results, make another call with the returned NextToken value.

  • :next_token (String) —

    Use the token returned by the previous operation to request the next page of results.

Returns:

See Also:



1245
1246
1247
1248
 
# File 'gems/aws-sdk-cloudwatchrum/lib/aws-sdk-cloudwatchrum/client.rb', line 1245

def list_rum_metrics_destinations(params = {}, options = {})
  req = build_request(:list_rum_metrics_destinations, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Displays the tags associated with a CloudWatch RUM resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "Arn", # required
})

Response structure


resp.resource_arn #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource that you want to see the tags of.

Returns:

See Also:



1276
1277
1278
1279
 
# File 'gems/aws-sdk-cloudwatchrum/lib/aws-sdk-cloudwatchrum/client.rb', line 1276

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#put_resource_policy(params = {}) ⇒ Types::PutResourcePolicyResponse

Use this operation to assign a resource-based policy to a CloudWatch RUM app monitor to control access to it. Each app monitor can have one resource-based policy. The maximum size of the policy is 4 KB. To learn more about using resource policies with RUM, see Using resource-based policies with CloudWatch RUM.

Examples:

Request syntax with placeholder values


resp = client.put_resource_policy({
  name: "AppMonitorName", # required
  policy_document: "String", # required
  policy_revision_id: "PolicyRevisionId",
})

Response structure


resp.policy_document #=> String
resp.policy_revision_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the app monitor that you want to apply this resource-based policy to. To find the names of your app monitors, you can use the ListAppMonitors operation.

  • :policy_document (required, String) —

    The JSON to use as the resource policy. The document can be up to 4 KB in size. For more information about the contents and syntax for this policy, see Using resource-based policies with CloudWatch RUM.

  • :policy_revision_id (String) —

    A string value that you can use to conditionally update your policy. You can provide the revision ID of your existing policy to make mutating requests against that policy.

    When you assign a policy revision ID, then later requests about that policy will be rejected with an InvalidPolicyRevisionIdException error if they don't provide the correct current revision ID.

Returns:

See Also:



1340
1341
1342
1343
 
# File 'gems/aws-sdk-cloudwatchrum/lib/aws-sdk-cloudwatchrum/client.rb', line 1340

def put_resource_policy(params = {}, options = {})
  req = build_request(:put_resource_policy, params)
  req.send_request(options)
end

#put_rum_events(params = {}) ⇒ Struct

Sends telemetry events about your application performance and user behavior to CloudWatch RUM. The code snippet that RUM generates for you to add to your application includes PutRumEvents operations to send this data to RUM.

Each PutRumEvents operation can send a batch of events from one user session.

Examples:

Request syntax with placeholder values


resp = client.put_rum_events({
  id: "PutRumEventsRequestIdString", # required
  batch_id: "PutRumEventsRequestBatchIdString", # required
  app_monitor_details: { # required
    name: "String",
    id: "String",
    version: "String",
  },
  user_details: { # required
    user_id: "UserDetailsUserIdString",
    session_id: "UserDetailsSessionIdString",
  },
  rum_events: [ # required
    {
      id: "RumEventIdString", # required
      timestamp: Time.now, # required
      type: "String", # required
      metadata: "JsonValue",
      details: "JsonValue", # required
    },
  ],
  alias: "Alias",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the app monitor that is sending this data.

  • :batch_id (required, String) —

    A unique identifier for this batch of RUM event data.

  • :app_monitor_details (required, Types::AppMonitorDetails) —

    A structure that contains information about the app monitor that collected this telemetry information.

  • :user_details (required, Types::UserDetails) —

    A structure that contains information about the user session that this batch of events was collected from.

  • :rum_events (required, Array<Types::RumEvent>) —

    An array of structures that contain the telemetry event data.

  • :alias (String) —

    If the app monitor uses a resource-based policy that requires PutRumEvents requests to specify a certain alias, specify that alias here. This alias will be compared to the rum:alias context key in the resource-based policy. For more information, see Using resource-based policies with CloudWatch RUM.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1413
1414
1415
1416
 
# File 'gems/aws-sdk-cloudwatchrum/lib/aws-sdk-cloudwatchrum/client.rb', line 1413

def put_rum_events(params = {}, options = {})
  req = build_request(:put_rum_events, params)
  req.send_request(options)
end

#put_rum_metrics_destination(params = {}) ⇒ Struct

Creates or updates a destination to receive extended metrics from CloudWatch RUM. You can send extended metrics to CloudWatch or to a CloudWatch Evidently experiment.

For more information about extended metrics, see BatchCreateRumMetricDefinitions.

Examples:

Request syntax with placeholder values


resp = client.put_rum_metrics_destination({
  app_monitor_name: "AppMonitorName", # required
  destination: "CloudWatch", # required, accepts CloudWatch, Evidently
  destination_arn: "DestinationArn",
  iam_role_arn: "IamRoleArn",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :app_monitor_name (required, String) —

    The name of the CloudWatch RUM app monitor that will send the metrics.

  • :destination (required, String) —

    Defines 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 is to be the destination and an IAM role that has permission to write to the experiment.

  • :destination_arn (String) —

    Use this parameter only if Destination is Evidently. This parameter specifies the ARN of the Evidently experiment that will receive the extended metrics.

  • :iam_role_arn (String) —

    This parameter is required if Destination is Evidently. If 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 permissions attached to it, to allow the role to be passed. The CloudWatchAmazonCloudWatchRUMFullAccess policy doesn't include PassRole permissions.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1477
1478
1479
1480
 
# File 'gems/aws-sdk-cloudwatchrum/lib/aws-sdk-cloudwatchrum/client.rb', line 1477

def put_rum_metrics_destination(params = {}, options = {})
  req = build_request(:put_rum_metrics_destination, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Assigns one or more tags (key-value pairs) to the specified CloudWatch RUM resource. Currently, the only resources that can be tagged app monitors.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a resource.

For more information, see Tagging Amazon Web Services resources.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "Arn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the CloudWatch RUM resource that you're adding tags to.

  • :tags (required, Hash<String,String>) —

    The list of key-value pairs to associate with the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1528
1529
1530
1531
 
# File 'gems/aws-sdk-cloudwatchrum/lib/aws-sdk-cloudwatchrum/client.rb', line 1528

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes one or more tags from the specified resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "Arn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the CloudWatch RUM resource that you're removing tags from.

  • :tag_keys (required, Array<String>) —

    The list of tag keys to remove from the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1555
1556
1557
1558
 
# File 'gems/aws-sdk-cloudwatchrum/lib/aws-sdk-cloudwatchrum/client.rb', line 1555

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_app_monitor(params = {}) ⇒ Struct

Updates the configuration of an existing app monitor. When you use this operation, only the parts of the app monitor configuration that you specify in this operation are changed. For any parameters that you omit, the existing values are kept.

You can't use this operation to change the tags of an existing app monitor. To change the tags of an existing app monitor, use TagResource.

To create a new app monitor, use CreateAppMonitor.

After you update an app monitor, sign in to the CloudWatch RUM console to get the updated JavaScript code snippet to add to your web application. For more information, see How do I find a code snippet that I've already generated?

Examples:

Request syntax with placeholder values


resp = client.update_app_monitor({
  name: "AppMonitorName", # required
  domain: "AppMonitorDomain",
  domain_list: ["AppMonitorDomain"],
  app_monitor_configuration: {
    identity_pool_id: "IdentityPoolId",
    excluded_pages: ["Url"],
    included_pages: ["Url"],
    favorite_pages: ["String"],
    session_sample_rate: 1.0,
    guest_role_arn: "Arn",
    allow_cookies: false,
    telemetries: ["errors"], # accepts errors, performance, http
    enable_x_ray: false,
  },
  cw_log_enabled: false,
  custom_events: {
    status: "ENABLED", # accepts ENABLED, DISABLED
  },
  deobfuscation_configuration: {
    java_script_source_maps: {
      status: "ENABLED", # required, accepts ENABLED, DISABLED
      s3_uri: "DeobfuscationS3Uri",
    },
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the app monitor to update.

  • :domain (String) —

    The top-level internet domain name for which your application has administrative authority.

  • :domain_list (Array<String>) —

    List the domain names for which your application has administrative authority. The UpdateAppMonitor allows either the domain or the domain list.

  • :app_monitor_configuration (Types::AppMonitorConfiguration) —

    A structure that contains much of the configuration data for the app monitor. If you are using Amazon Cognito for authorization, you must include this structure in your request, and it must include the ID of the Amazon Cognito identity pool to use for authorization. If you don't include AppMonitorConfiguration, you must set up your own authorization method. For more information, see Authorize your application to send data to Amazon Web Services.

  • :cw_log_enabled (Boolean) —

    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 data to Amazon CloudWatch Logs in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur Amazon CloudWatch Logs charges.

  • :custom_events (Types::CustomEvents) —

    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.

  • :deobfuscation_configuration (Types::DeobfuscationConfiguration) —

    A structure that contains the configuration for how an app monitor can deobfuscate stack traces.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1663
1664
1665
1666
 
# File 'gems/aws-sdk-cloudwatchrum/lib/aws-sdk-cloudwatchrum/client.rb', line 1663

def update_app_monitor(params = {}, options = {})
  req = build_request(:update_app_monitor, params)
  req.send_request(options)
end

#update_rum_metric_definition(params = {}) ⇒ Struct

Modifies one existing metric definition for CloudWatch RUM extended metrics. For more information about extended metrics, see BatchCreateRumMetricsDefinitions.

Examples:

Request syntax with placeholder values


resp = client.update_rum_metric_definition({
  app_monitor_name: "AppMonitorName", # required
  destination: "CloudWatch", # required, accepts CloudWatch, Evidently
  destination_arn: "DestinationArn",
  metric_definition: { # required
    name: "MetricName", # required
    value_key: "ValueKey",
    unit_label: "UnitLabel",
    dimension_keys: {
      "DimensionKey" => "DimensionName",
    },
    event_pattern: "EventPattern",
    namespace: "Namespace",
  },
  metric_definition_id: "MetricDefinitionId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :app_monitor_name (required, String) —

    The name of the CloudWatch RUM app monitor that sends these metrics.

  • :destination (required, String) —

    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.

  • :destination_arn (String) —

    This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter.

    This parameter specifies the ARN of the Evidently experiment that is to receive the metrics. You must have already defined this experiment as a valid destination. For more information, see PutRumMetricsDestination.

  • :metric_definition (required, Types::MetricDefinitionRequest) —

    A structure that contains the new definition that you want to use for this metric.

  • :metric_definition_id (required, String) —

    The ID of the metric definition to update.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1731
1732
1733
1734
 
# File 'gems/aws-sdk-cloudwatchrum/lib/aws-sdk-cloudwatchrum/client.rb', line 1731

def update_rum_metric_definition(params = {}, options = {})
  req = build_request(:update_rum_metric_definition, params)
  req.send_request(options)
end