CloudWatchRUM / Client / batch_get_rum_metric_definitions

batch_get_rum_metric_definitions#

CloudWatchRUM.Client.batch_get_rum_metric_definitions(**kwargs)#

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

Request Syntax

response = client.batch_get_rum_metric_definitions(
    AppMonitorName='string',
    Destination='CloudWatch'|'Evidently',
    DestinationArn='string',
    MaxResults=123,
    NextToken='string'
)

Parameters:

AppMonitorName (string) –
[REQUIRED]

The name of the CloudWatch RUM app monitor that is sending the metrics.
Destination (string) –
[REQUIRED]

The type of destination that you want to view metrics for. Valid values are CloudWatch and Evidently.
DestinationArn (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.
MaxResults (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.
NextToken (string) – Use the token returned by the previous operation to request the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'MetricDefinitions': [
        {
            'DimensionKeys': {
                'string': 'string'
            },
            'EventPattern': 'string',
            'MetricDefinitionId': 'string',
            'Name': 'string',
            'Namespace': 'string',
            'UnitLabel': 'string',
            'ValueKey': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- MetricDefinitions (list) –
  
  An array of structures that display information about the metrics that are sent by the specified app monitor to the specified destination.
  - (dict) –
    
    A structure that displays the definition of one extended metric that RUM sends to CloudWatch or CloudWatch Evidently. For more information, see Additional metrics that you can send to CloudWatch and CloudWatch Evidently.
    - DimensionKeys (dict) –
      
      This field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch The value of this field is used only if the metric destination is CloudWatch. If the metric destination is Evidently, the value of DimensionKeys is ignored.
      - (string) –
        
        (string) –
    - EventPattern (string) –
      
      The pattern that defines the metric. RUM checks events that happen in a user’s session against the pattern, and events that match the pattern are sent to the metric destination.
      
      If the metrics destination is CloudWatch and the event also matches a value in DimensionKeys, then the metric is published with the specified dimensions.
    - MetricDefinitionId (string) –
      
      The ID of this metric definition.
    - Name (string) –
      
      The name of the metric that is defined in this structure.
    - Namespace (string) –
      
      If this metric definition is for a custom metric instead of an extended metric, this field displays the metric namespace that the custom metric is published to.
    - UnitLabel (string) –
      
      Use this field only if you are sending this metric to CloudWatch. It defines the CloudWatch metric unit that this metric is measured in.
    - ValueKey (string) –
      
      The field within the event object that the metric value is sourced from.
- NextToken (string) –
  
  A token that you can use in a subsequent operation to retrieve the next set of results.

Exceptions

CloudWatchRUM.Client.exceptions.ResourceNotFoundException
CloudWatchRUM.Client.exceptions.InternalServerException
CloudWatchRUM.Client.exceptions.ValidationException
CloudWatchRUM.Client.exceptions.AccessDeniedException