CloudWatchRUM / Client / get_app_monitor_data

get_app_monitor_data#

CloudWatchRUM.Client.get_app_monitor_data(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.get_app_monitor_data(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    Name='string',
    NextToken='string',
    TimeRange={
        'After': 123,
        'Before': 123
    }
)
Parameters:

  • Filters (list) –

    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.

    • (dict) –

      A structure that defines a key and values that you can use to filter the results. The only performance events that are returned are those that have values matching the ones that you specify in one of your QueryFilter structures.

      For example, you could specify Browser as the Name and specify Chrome,Firefox as the Values to return events generated only from those browsers.

      Specifying Invert as the Name works as a “not equal to” filter. For example, specify Invert as the Name and specify Chrome as the value to return all events except events from user sessions with the Chrome browser.

      • Name (string) –

        The name of a key to search for. The filter returns only the events that match the Name and Values that you specify.

        Valid values for Name are Browser | Device | Country | Page | OS | EventType | Invert

      • Values (list) –

        The values of the Name that are to be be included in the returned results.

        • (string) –

  • MaxResults (integer) – The maximum number of results to return in one operation.

  • Name (string) –

    [REQUIRED]

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

  • NextToken (string) – Use the token returned by the previous operation to request the next page of results.

  • TimeRange (dict) –

    [REQUIRED]

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

    • After (integer) – [REQUIRED]

      The beginning of the time range to retrieve performance events from.

    • Before (integer) –

      The end of the time range to retrieve performance events from. If you omit this, the time range extends to the time that this operation is performed.

Return type:

dict

Returns:

Response Syntax

{
    'Events': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Events (list) –

      The events that RUM collected that match your request.

      • (string) –

    • NextToken (string) –

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

Exceptions