Class: AWS.RUM

var params = {
  AppMonitorName: 'STRING_VALUE', /* required */
  Destination: CloudWatch | Evidently, /* required */
  MetricDefinitionIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  DestinationArn: 'STRING_VALUE'
};
rum.batchDeleteRumMetricDefinitions(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: {}) —
  • AppMonitorName — (String)

    The name of the CloudWatch RUM app monitor that is sending these metrics.

  • Destination — (String)

    Defines the destination where you want to stop sending the specified metrics. Valid values are CloudWatch and Evidently. If you specify Evidently, you must also specify the ARN of the CloudWatchEvidently experiment that is to be the destination and an IAM role that has permission to write to the experiment.

    Possible values include:
    • "CloudWatch"
    • "Evidently"
  • DestinationArn — (String)

    This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter.

    This parameter specifies the ARN of the Evidently experiment that was receiving the metrics that are being deleted.

  • MetricDefinitionIds — (Array<String>)

    An array of structures which define the metrics that you want to stop sending.

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:

    • Errors — (Array<map>)

      An array of error objects, if the operation caused any errors.

      • ErrorCode — required — (String)

        The error code.

      • ErrorMessage — required — (String)

        The error message for this metric definition.

      • MetricDefinitionId — required — (String)

        The ID of the metric definition that caused this error.

    • MetricDefinitionIds — (Array<String>)

      The IDs of the metric definitions that were deleted.

Returns:

• (AWS.Request) —

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

var params = {
  AppMonitorName: 'STRING_VALUE', /* required */
  Destination: CloudWatch | Evidently, /* required */
  DestinationArn: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
rum.batchGetRumMetricDefinitions(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: {}) —
  • AppMonitorName — (String)

    The name of the CloudWatch RUM app monitor that is sending the metrics.

  • Destination — (String)

    The type of destination that you want to view metrics for. Valid values are CloudWatch and Evidently.

    Possible values include:
    • "CloudWatch"
    • "Evidently"
  • DestinationArn — (String)

    This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter.

    This parameter specifies the ARN of the Evidently experiment that corresponds to the destination.

  • MaxResults — (Integer)

    The maximum number of results to return in one operation. The default is 50. The maximum that you can specify is 100.

    To retrieve the remaining results, make another call with the returned NextToken value.

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

    • MetricDefinitions — (Array<map>)

      An array of structures that display information about the metrics that are sent by the specified app monitor to the specified destination.

      • DimensionKeys — (map<String>)

        This field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch The value of this field is used only if the metric destination is CloudWatch. If the metric destination is Evidently, the value of DimensionKeys is ignored.

      • EventPattern — (String)

        The pattern that defines the metric. RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination.

        If the metrics destination is CloudWatch and the event also matches a value in DimensionKeys, then the metric is published with the specified dimensions.

      • MetricDefinitionId — required — (String)

        The ID of this metric definition.

      • Name — required — (String)

        The name of the metric that is defined in this structure.

      • Namespace — (String)

        If this metric definition is for a custom metric instead of an extended metric, this field displays the metric namespace that the custom metric is published to.

      • UnitLabel — (String)

        Use this field only if you are sending this metric to CloudWatch. It defines the CloudWatch metric unit that this metric is measured in.

      • ValueKey — (String)

        The field within the event object that the metric value is sourced from.

    • 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 = {
  Domain: 'STRING_VALUE', /* required */
  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 */
    ]
  },
  CustomEvents: {
    Status: ENABLED | DISABLED
  },
  CwLogEnabled: true || false,
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
rum.createAppMonitor(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.

    If you omit this argument, the sample rate used for RUM is set to 10% of the user sessions.

    • 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 your application that are to be displayed with a "favorite" icon in the CloudWatch RUM console.

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

      Note: It is possible that an app monitor does not have a value for GuestRoleArn. For example, this can happen when you use the console to create an app monitor and you allow CloudWatch RUM to create a new identity pool for Authorization. In this case, GuestRoleArn is not present in the GetAppMonitor response because it is not stored by the service. If this issue affects you, you can take one of the following steps:

      • Use the Cloud Development Kit (CDK) to create an identity pool and the associated IAM role, and use that for your app monitor.
      • Make a separate GetIdentityPoolRoles call to Amazon Cognito to retrieve the GuestRoleArn.
    • 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.

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

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

  • CustomEvents — (map)

    Specifies whether this app monitor allows the web client to define and send custom events. If you omit this parameter, custom events are DISABLED.

    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.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
  • 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.

    If you omit this parameter, the default is false.

  • Domain — (String)

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

  • Name — (String)

    A name for the app monitor.

  • Tags — (map<String>)

    Assigns one or more tags (key-value pairs) to the app monitor.

    Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

    Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

    You can associate as many as 50 tags with an app monitor.

    For more information, see Tagging Amazon Web Services resources.

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:

    • Id — (String)

      The unique ID of the new app monitor.

Returns:

• (AWS.Request) —

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

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 = {
  AppMonitorName: 'STRING_VALUE', /* required */
  Destination: CloudWatch | Evidently, /* required */
  DestinationArn: 'STRING_VALUE'
};
rum.deleteRumMetricsDestination(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: {}) —
  • AppMonitorName — (String)

    The name of the app monitor that is sending metrics to the destination that you want to delete.

  • Destination — (String)

    The type of destination to delete. Valid values are CloudWatch and Evidently.

    Possible values include:
    • "CloudWatch"
    • "Evidently"
  • DestinationArn — (String)

    This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter. This parameter specifies the ARN of the Evidently experiment that corresponds to the destination 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 your application that are to be displayed with a "favorite" icon in the CloudWatch RUM console.

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

          Note: It is possible that an app monitor does not have a value for GuestRoleArn. For example, this can happen when you use the console to create an app monitor and you allow CloudWatch RUM to create a new identity pool for Authorization. In this case, GuestRoleArn is not present in the GetAppMonitor response because it is not stored by the service. If this issue affects you, you can take one of the following steps:

          • Use the Cloud Development Kit (CDK) to create an identity pool and the associated IAM role, and use that for your app monitor.
          • Make a separate GetIdentityPoolRoles call to Amazon Cognito to retrieve the GuestRoleArn.
        • 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.

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

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

      • CustomEvents — (map)

        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.

          Possible values include:
          • "ENABLED"
          • "DISABLED"
      • 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. The default is 50. The maximum that you can specify is 100.

  • 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 = {
  AppMonitorName: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
rum.listRumMetricsDestinations(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: {}) —
  • AppMonitorName — (String)

    The name of the app monitor associated with the destinations that you want to retrieve.

  • MaxResults — (Integer)

    The maximum number of results to return in one operation. The default is 50. The maximum that you can specify is 100.

    To retrieve the remaining results, make another call with the returned NextToken value.

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

    • Destinations — (Array<map>)

      The list of CloudWatch RUM extended metrics destinations associated with the app monitor that you specified.

      • Destination — (String)

        Specifies whether the destination is CloudWatch or Evidently.

        Possible values include:
        • "CloudWatch"
        • "Evidently"
      • DestinationArn — (String)

        If the destination is Evidently, this specifies the ARN of the Evidently experiment that receives the metrics.

      • IamRoleArn — (String)

        This field appears only when the destination is Evidently. It specifies the ARN of the IAM role that is used to write to the Evidently experiment that receives the metrics.

    • 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 = {
  AppMonitorName: 'STRING_VALUE', /* required */
  Destination: CloudWatch | Evidently, /* required */
  DestinationArn: 'STRING_VALUE',
  IamRoleArn: 'STRING_VALUE'
};
rum.putRumMetricsDestination(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: {}) —
  • AppMonitorName — (String)

    The name of the CloudWatch RUM app monitor that will send the metrics.

  • Destination — (String)

    Defines the destination to send the metrics to. Valid values are CloudWatch and Evidently. If you specify Evidently, you must also specify the ARN of the CloudWatchEvidently experiment that is to be the destination and an IAM role that has permission to write to the experiment.

    Possible values include:
    • "CloudWatch"
    • "Evidently"
  • DestinationArn — (String)

    Use this parameter only if Destination is Evidently. This parameter specifies the ARN of the Evidently experiment that will receive the extended metrics.

  • IamRoleArn — (String)

    This parameter is required if Destination is Evidently. If Destination is CloudWatch, don't use this parameter.

    This parameter specifies the ARN of an IAM role that RUM will assume to write to the Evidently experiment that you are sending metrics to. This role must have permission to write to that experiment.

    If you specify this parameter, you must be signed on to a role that has PassRole permissions attached to it, to allow the role to be passed. The CloudWatchAmazonCloudWatchRUMFullAccess policy doesn't include PassRole permissions.

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 */
    ]
  },
  CustomEvents: {
    Status: ENABLED | DISABLED
  },
  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 your application that are to be displayed with a "favorite" icon in the CloudWatch RUM console.

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

      Note: It is possible that an app monitor does not have a value for GuestRoleArn. For example, this can happen when you use the console to create an app monitor and you allow CloudWatch RUM to create a new identity pool for Authorization. In this case, GuestRoleArn is not present in the GetAppMonitor response because it is not stored by the service. If this issue affects you, you can take one of the following steps:

      • Use the Cloud Development Kit (CDK) to create an identity pool and the associated IAM role, and use that for your app monitor.
      • Make a separate GetIdentityPoolRoles call to Amazon Cognito to retrieve the GuestRoleArn.
    • 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.

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

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

  • CustomEvents — (map)

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

    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.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
  • 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.

var params = {
  AppMonitorName: 'STRING_VALUE', /* required */
  Destination: CloudWatch | Evidently, /* required */
  MetricDefinition: { /* required */
    Name: 'STRING_VALUE', /* required */
    DimensionKeys: {
      '<DimensionKey>': 'STRING_VALUE',
      /* '<DimensionKey>': ... */
    },
    EventPattern: 'STRING_VALUE',
    Namespace: 'STRING_VALUE',
    UnitLabel: 'STRING_VALUE',
    ValueKey: 'STRING_VALUE'
  },
  MetricDefinitionId: 'STRING_VALUE', /* required */
  DestinationArn: 'STRING_VALUE'
};
rum.updateRumMetricDefinition(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: {}) —
  • AppMonitorName — (String)

    The name of the CloudWatch RUM app monitor that sends these metrics.

  • Destination — (String)

    The destination to send the metrics to. Valid values are CloudWatch and Evidently. If you specify Evidently, you must also specify the ARN of the CloudWatchEvidently experiment that will receive the metrics and an IAM role that has permission to write to the experiment.

    Possible values include:
    • "CloudWatch"
    • "Evidently"
  • DestinationArn — (String)

    This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter.

    This parameter specifies the ARN of the Evidently experiment that is to receive the metrics. You must have already defined this experiment as a valid destination. For more information, see PutRumMetricsDestination.

  • MetricDefinition — (map)

    A structure that contains the new definition that you want to use for this metric.

    • DimensionKeys — (map<String>)

      Use this field only if you are sending the metric to CloudWatch.

      This field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch. For extended metrics, valid values for the entries in this field are the following:

      • "metadata.pageId": "PageId"

      • "metadata.browserName": "BrowserName"

      • "metadata.deviceType": "DeviceType"

      • "metadata.osName": "OSName"

      • "metadata.countryCode": "CountryCode"

      • "event_details.fileType": "FileType"

      For both extended metrics and custom metrics, all dimensions listed in this field must also be included in EventPattern.

    • EventPattern — (String)

      The pattern that defines the metric, specified as a JSON object. RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination.

      When you define extended metrics, the metric definition is not valid if EventPattern is omitted.

      Example event patterns:

      • '{ "event_type": ["com.amazon.rum.js_error_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], } }'

      • '{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Firefox" ] }, "event_details": { "duration": [{ "numeric": [ "<", 2000 ] }] } }'

      • '{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], "countryCode": [ "US" ] }, "event_details": { "duration": [{ "numeric": [ ">=", 2000, "<", 8000 ] }] } }'

      If the metrics destination is CloudWatch and the event also matches a value in DimensionKeys, then the metric is published with the specified dimensions.

    • Name — required — (String)

      The name for the metric that is defined in this structure. For custom metrics, you can specify any name that you like. For extended metrics, valid values are the following:

      • PerformanceNavigationDuration

      • PerformanceResourceDuration

      • NavigationSatisfiedTransaction

      • NavigationToleratedTransaction

      • NavigationFrustratedTransaction

      • WebVitalsCumulativeLayoutShift

      • WebVitalsFirstInputDelay

      • WebVitalsLargestContentfulPaint

      • JsErrorCount

      • HttpErrorCount

      • SessionCount

    • Namespace — (String)

      If this structure is for a custom metric instead of an extended metrics, use this parameter to define the metric namespace for that custom metric. Do not specify this parameter if this structure is for an extended metric.

      You cannot use any string that starts with AWS/ for your namespace.

    • UnitLabel — (String)

      The CloudWatch metric unit to use for this metric. If you omit this field, the metric is recorded with no unit.

    • ValueKey — (String)

      The field within the event object that the metric value is sourced from.

      If you omit this field, a hardcoded value of 1 is pushed as the metric value. This is useful if you want to count the number of events that the filter catches.

      If this metric is sent to CloudWatch Evidently, this field will be passed to Evidently raw. Evidently will handle data extraction from the event.

  • MetricDefinitionId — (String)

    The ID of the metric definition 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.