CloudWatchRUM / Paginator / GetAppMonitorData

GetAppMonitorData

class CloudWatchRUM.Paginator.GetAppMonitorData

paginator = client.get_paginator('get_app_monitor_data')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CloudWatchRUM.Client.get_app_monitor_data().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    Name='string',
    TimeRange={
        'After': 123,
        'Before': 123
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

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) –

• Name (string) –

  [REQUIRED]

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

• 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.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

}

Response Structure

• (dict) –

  • Events (list) –

    The events that RUM collected that match your request.

    • (string) –