Batch Get Rum Metric Definitions

rum.batch_get_rum_metric_definitions
ActionAmazon Web Servicesconnection required

Calls the AWS rum API (SigV4).

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

Connection

Required
Yes — the node will not save without one
Auth type
API key
Providers
AWS CloudWatch RUM
Secret shape
{"access_key_id", "secret_access_key"}
Config it needs
region
Resolved by
config.connection_id, else node.connection_id

Configuration

4 fields, 2 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.

FieldTypeRequiredDefaultConstraintsExample
region
AWS region (overrides the connection).
stringNo———
app_monitor_name
The name of the CloudWatch RUM app monitor that is sending the metrics.
stringYes———
destination
The type of destination that you want to view metrics for. Valid values are CloudWatch and
stringYes———
max_results
Maximum items to return.
numberNo50≥ 1—

Example configuration

Every value below is the contract’s own example or default — nothing invented.

{
  "max_results": 50
}

Output

One shape.

result

FieldTypeExample
MetricDefinitions
array—
NextToken
string—
{
  "MetricDefinitions": [],
  "NextToken": ""
}

See Batch Get Rum Metric Definitions run in a workflow.

In a technical demo we add the AWS CloudWatch RUM connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.