GetAppMonitorDataCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { RUMClient, GetAppMonitorDataCommand } from "@aws-sdk/client-rum"; // ES Modules import
// const { RUMClient, GetAppMonitorDataCommand } = require("@aws-sdk/client-rum"); // CommonJS import
const client = new RUMClient(config);
const input = { // GetAppMonitorDataRequest
  Name: "STRING_VALUE", // required
  TimeRange: { // TimeRange
    After: Number("long"), // required
    Before: Number("long"),
  },
  Filters: [ // QueryFilters
    { // QueryFilter
      Name: "STRING_VALUE",
      Values: [ // QueryFilterValueList
        "STRING_VALUE",
      ],
    },
  ],
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
};
const command = new GetAppMonitorDataCommand(input);
const response = await client.send(command);
// { // GetAppMonitorDataResponse
//   Events: [ // EventDataList
//     "STRING_VALUE",
//   ],
//   NextToken: "STRING_VALUE",
// };

GetAppMonitorDataCommand Input

See GetAppMonitorDataCommandInput for more details

Parameter
Type
Description
Name
Required
string | undefined

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

TimeRange
Required
TimeRange | undefined

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

Filters
QueryFilter[] | undefined

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.

MaxResults
number | undefined

The maximum number of results to return in one operation.

NextToken
string | undefined

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

GetAppMonitorDataCommand Output

See GetAppMonitorDataCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Events
string[] | undefined

The events that RUM collected that match your request.

NextToken
string | undefined

A token that you can use in a subsequent operation to retrieve the next set of results.

Throws

Name
Fault
Details
AccessDeniedException
client

You don't have sufficient permissions to perform this action.

InternalServerException
server

Internal service exception.

ResourceNotFoundException
client

Resource not found.

ThrottlingException
client

The request was throttled because of quota limits.

ValidationException
client

One of the arguments for the request is not valid.

RUMServiceException
Base exception class for all service exceptions from RUM service.