BatchGetRumMetricDefinitions
Retrieves the list of metrics and dimensions that a RUM app monitor is sending to a single destination.
Request Syntax
GET /rummetrics/AppMonitorName/metrics?destination=Destination&destinationArn=DestinationArn&maxResults=MaxResults&nextToken=NextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- AppMonitorName
-
The name of the CloudWatch RUM app monitor that is sending the metrics.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^(?!\.)[\.\-_#A-Za-z0-9]+$Required: Yes
- Destination
-
The type of destination that you want to view metrics for. Valid values are
CloudWatchandEvidently.Valid Values:
CloudWatch | EvidentlyRequired: Yes
- DestinationArn
-
This parameter is required if
DestinationisEvidently. IfDestinationisCloudWatch, do not use this parameter.This parameter specifies the ARN of the Evidently experiment that corresponds to the destination.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
arn:[^:]*:[^:]*:[^:]*:[^:]*:.* - MaxResults
-
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
NextTokenvalue.Valid Range: Minimum value of 1. Maximum value of 100.
- NextToken
-
Use the token returned by the previous operation to request the next page of results.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"MetricDefinitions": [
{
"DimensionKeys": {
"string" : "string"
},
"EventPattern": "string",
"MetricDefinitionId": "string",
"Name": "string",
"Namespace": "string",
"UnitLabel": "string",
"ValueKey": "string"
}
],
"NextToken": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- MetricDefinitions
-
An array of structures that display information about the metrics that are sent by the specified app monitor to the specified destination.
Type: Array of MetricDefinition objects
- NextToken
-
A token that you can use in a subsequent operation to retrieve the next set of results.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have sufficient permissions to perform this action.
HTTP Status Code: 403
- InternalServerException
-
Internal service exception.
HTTP Status Code: 500
- ResourceNotFoundException
-
Resource not found.
HTTP Status Code: 404
- ValidationException
-
One of the arguments for the request is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
