CloudWatchRUM / Client / get_app_monitor

get_app_monitor

CloudWatchRUM.Client.get_app_monitor(**kwargs)

Retrieves the complete configuration information for one app monitor.

See also: AWS API Documentation

Request Syntax

response = client.get_app_monitor(
    Name='string'
)

Parameters:

Name (string) –

[REQUIRED]

The app monitor to retrieve information for.

Return type:

dict

Returns:

Response Syntax

{
    'AppMonitor': {
        'AppMonitorConfiguration': {
            'AllowCookies': True|False,
            'EnableXRay': True|False,
            'ExcludedPages': [
                'string',
            ],
            'FavoritePages': [
                'string',
            ],
            'GuestRoleArn': 'string',
            'IdentityPoolId': 'string',
            'IncludedPages': [
                'string',
            ],
            'SessionSampleRate': 123.0,
            'Telemetries': [
                'errors'|'performance'|'http',
            ]
        },
        'Created': 'string',
        'CustomEvents': {
            'Status': 'ENABLED'|'DISABLED'
        },
        'DataStorage': {
            'CwLog': {
                'CwLogEnabled': True|False,
                'CwLogGroup': 'string'
            }
        },
        'Domain': 'string',
        'Id': 'string',
        'LastModified': 'string',
        'Name': 'string',
        'State': 'CREATED'|'DELETING'|'ACTIVE',
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

• (dict) –

  • AppMonitor (dict) –

    A structure containing all the configuration information for the app monitor.

    • AppMonitorConfiguration (dict) –

      A structure that contains much of the configuration data for the app monitor.

      • AllowCookies (boolean) –

        If you set this to true, the RUM web client sets two cookies, a session cookie and a user cookie. The cookies allow the RUM web client to collect data relating to the number of users an application has and the behavior of the application across a sequence of events. Cookies are stored in the top-level domain of the current page.

      • EnableXRay (boolean) –

        If you set this to true, RUM enables X-Ray tracing for the user sessions that RUM samples. RUM adds an X-Ray trace header to allowed HTTP requests. It also records an X-Ray segment for allowed HTTP requests. You can see traces and segments from these user sessions in the X-Ray console and the CloudWatch ServiceLens console. For more information, see What is X-Ray?

      • ExcludedPages (list) –

        A list of URLs in your website or application to exclude from RUM data collection.

        You can’t include both ExcludedPages and IncludedPages in the same operation.

        • (string) –

      • FavoritePages (list) –

        A list of pages in your application that are to be displayed with a “favorite” icon in the CloudWatch RUM console.

        • (string) –

      • GuestRoleArn (string) –

        The ARN of the guest IAM role that is attached to the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.

      • IdentityPoolId (string) –

        The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.

      • IncludedPages (list) –

        If this app monitor is to collect data from only certain pages in your application, this structure lists those pages.

        You can’t include both ExcludedPages and IncludedPages in the same operation.

        • (string) –

      • SessionSampleRate (float) –

        Specifies the portion of user sessions to use for RUM data collection. Choosing a higher portion gives you more data but also incurs more costs.

        The range for this value is 0 to 1 inclusive. Setting this to 1 means that 100% of user sessions are sampled, and setting it to 0.1 means that 10% of user sessions are sampled.

        If you omit this parameter, the default of 0.1 is used, and 10% of sessions will be sampled.

      • Telemetries (list) –

        An array that lists the types of telemetry data that this app monitor is to collect.

        • errors indicates that RUM collects data about unhandled JavaScript errors raised by your application.

        • performance indicates that RUM collects performance data about how your application and its resources are loaded and rendered. This includes Core Web Vitals.

        • http indicates that RUM collects data about HTTP errors thrown by your application.

        • (string) –

    • Created (string) –

      The date and time that this app monitor was created.

    • CustomEvents (dict) –

      Specifies whether this app monitor allows the web client to define and send custom events.

      For more information about custom events, see Send custom events.

      • Status (string) –

        Specifies whether this app monitor allows the web client to define and send custom events. The default is for custom events to be DISABLED.

    • DataStorage (dict) –

      A structure that contains information about whether this app monitor stores a copy of the telemetry data that RUM collects using CloudWatch Logs.

      • CwLog (dict) –

        A structure that contains the information about whether the app monitor stores copies of the data that RUM collects in CloudWatch Logs. If it does, this structure also contains the name of the log group.

        • CwLogEnabled (boolean) –

          Indicated whether the app monitor stores copies of the data that RUM collects in CloudWatch Logs.

        • CwLogGroup (string) –

          The name of the log group where the copies are stored.

    • Domain (string) –

      The top-level internet domain name for which your application has administrative authority.

    • Id (string) –

      The unique ID of this app monitor.

    • LastModified (string) –

      The date and time of the most recent changes to this app monitor’s configuration.

    • Name (string) –

      The name of the app monitor.

    • State (string) –

      The current state of the app monitor.

    • Tags (dict) –

      The list of tag keys and values associated with this app monitor.

      • (string) –

        • (string) –

Exceptions

• CloudWatchRUM.Client.exceptions.ResourceNotFoundException

• CloudWatchRUM.Client.exceptions.InternalServerException

• CloudWatchRUM.Client.exceptions.ValidationException

• CloudWatchRUM.Client.exceptions.ThrottlingException

• CloudWatchRUM.Client.exceptions.AccessDeniedException