Class: AWS.RUM

var params = {
  Name: 'STRING_VALUE' /* required */
};
rum.deleteAppMonitor(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    The name of the app monitor to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Name: 'STRING_VALUE' /* required */
};
rum.getAppMonitor(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    The app monitor to retrieve information for.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AppMonitor — (map)

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

      • AppMonitorConfiguration — (map)

        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 — (Array<String>)

          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.

        • FavoritePages — (Array<String>)

          A list of pages in the CloudWatch RUM console that are to be displayed with a "favorite" icon.

        • 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 — (Array<String>)

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

           <p>You can't include both <code>ExcludedPages</code> and <code>IncludedPages</code> in the same operation.</p> 

        • SessionSampleRate — (Float)

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

          The number you specify is the percentage of user sessions that will be used.

          If you omit this parameter, the default of 10 is used.

        • Telemetries — (Array<String>)

          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.

      • Created — (String)

        The date and time that this app monitor was created.

      • DataStorage — (map)

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

        • CwLog — (map)

          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.

        Possible values include:
        • "CREATED"
        • "DELETING"
        • "ACTIVE"
      • Tags — (map<String>)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Name: 'STRING_VALUE', /* required */
  TimeRange: { /* required */
    After: 'NUMBER_VALUE', /* required */
    Before: 'NUMBER_VALUE'
  },
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
rum.getAppMonitorData(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Filters — (Array<map>)

    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.

    • 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 — (Array<String>)

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

  • MaxResults — (Integer)

    The maximum number of results to return in one operation.

  • Name — (String)

    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 — (map)

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

    • After — required — (Integer)

      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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Events — (Array<String>)

      The events that RUM collected that match your request.

    • NextToken — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
rum.listAppMonitors(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • MaxResults — (Integer)

    The maximum number of results to return in one operation.

  • NextToken — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AppMonitorSummaries — (Array<map>)

      An array of structures that contain information about the returned app monitors.

      • Created — (String)

        The date and time that the app monitor was created.

      • 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 this app monitor.

      • State — (String)

        The current state of this app monitor.

        Possible values include:
        • "CREATED"
        • "DELETING"
        • "ACTIVE"
    • NextToken — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
rum.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceArn — (String)

    The ARN of the resource that you want to see the tags of.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ResourceArn — (String)

      The ARN of the resource that you are viewing.

    • Tags — (map<String>)

      The list of tag keys and values associated with the resource you specified.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AppMonitorDetails: { /* required */
    id: 'STRING_VALUE',
    name: 'STRING_VALUE',
    version: 'STRING_VALUE'
  },
  BatchId: 'STRING_VALUE', /* required */
  Id: 'STRING_VALUE', /* required */
  RumEvents: [ /* required */
    {
      details: any /* This value will be JSON encoded on your behalf with JSON.stringify() */, /* required */
      id: 'STRING_VALUE', /* required */
      timestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
      type: 'STRING_VALUE', /* required */
      metadata: any /* This value will be JSON encoded on your behalf with JSON.stringify() */
    },
    /* more items */
  ],
  UserDetails: { /* required */
    sessionId: 'STRING_VALUE',
    userId: 'STRING_VALUE'
  }
};
rum.putRumEvents(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AppMonitorDetails — (map)

    A structure that contains information about the app monitor that collected this telemetry information.

    • id — (String)

      The unique ID of the app monitor.

    • name — (String)

      The name of the app monitor.

    • version — (String)

      The version of the app monitor.

  • BatchId — (String)

    A unique identifier for this batch of RUM event data.

  • Id — (String)

    The ID of the app monitor that is sending this data.

  • RumEvents — (Array<map>)

    An array of structures that contain the telemetry event data.

    • details — required — (String)

      A string containing details about the event.

    • id — required — (String)

      A unique ID for this event.

    • metadata — (String)

      Metadata about this event, which contains a JSON serialization of the identity of the user for this session. The user information comes from information such as the HTTP user-agent request header and document interface.

    • timestamp — required — (Date)

      The exact time that this event occurred.

    • type — required — (String)

      The JSON schema that denotes the type of event this is, such as a page load or a new session.

  • UserDetails — (map)

    A structure that contains information about the user session that this batch of events was collected from.

    • sessionId — (String)

      The session ID that the performance events are from.

    • userId — (String)

      The ID of the user for this user session. This ID is generated by RUM and does not include any personally identifiable information about the user.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
rum.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceArn — (String)

    The ARN of the CloudWatch RUM resource that you're adding tags to.

  • Tags — (map<String>)

    The list of key-value pairs to associate with the resource.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
rum.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceArn — (String)

    The ARN of the CloudWatch RUM resource that you're removing tags from.

  • TagKeys — (Array<String>)

    The list of tag keys to remove from the resource.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Name: 'STRING_VALUE', /* required */
  AppMonitorConfiguration: {
    AllowCookies: true || false,
    EnableXRay: true || false,
    ExcludedPages: [
      'STRING_VALUE',
      /* more items */
    ],
    FavoritePages: [
      'STRING_VALUE',
      /* more items */
    ],
    GuestRoleArn: 'STRING_VALUE',
    IdentityPoolId: 'STRING_VALUE',
    IncludedPages: [
      'STRING_VALUE',
      /* more items */
    ],
    SessionSampleRate: 'NUMBER_VALUE',
    Telemetries: [
      errors | performance | http,
      /* more items */
    ]
  },
  CwLogEnabled: true || false,
  Domain: 'STRING_VALUE'
};
rum.updateAppMonitor(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AppMonitorConfiguration — (map)

    A structure that contains much of the configuration data for the app monitor. If you are using Amazon Cognito for authorization, you must include this structure in your request, and it must include the ID of the Amazon Cognito identity pool to use for authorization. If you don't include AppMonitorConfiguration, you must set up your own authorization method. For more information, see Authorize your application to send data to Amazon Web Services.

    • 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 — (Array<String>)

      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.

    • FavoritePages — (Array<String>)

      A list of pages in the CloudWatch RUM console that are to be displayed with a "favorite" icon.

    • 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 — (Array<String>)

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

       <p>You can't include both <code>ExcludedPages</code> and <code>IncludedPages</code> in the same operation.</p> 

    • SessionSampleRate — (Float)

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

      The number you specify is the percentage of user sessions that will be used.

      If you omit this parameter, the default of 10 is used.

    • Telemetries — (Array<String>)

      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.

  • CwLogEnabled — (Boolean)

    Data collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM sends a copy of this telemetry data to Amazon CloudWatch Logs in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur Amazon CloudWatch Logs charges.

  • Domain — (String)

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

  • Name — (String)

    The name of the app monitor to update.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.