AbstractAWSCloudWatchRUM (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cloudwatchrum.AbstractAWSCloudWatchRUM

All Implemented Interfaces:

AWSCloudWatchRUM

Direct Known Subclasses:

AbstractAWSCloudWatchRUMAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSCloudWatchRUM
extends Object
implements AWSCloudWatchRUM
```
Abstract implementation of AWSCloudWatchRUM. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.cloudwatchrum.AWSCloudWatchRUM
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BatchCreateRumMetricDefinitionsResult`	`batchCreateRumMetricDefinitions(BatchCreateRumMetricDefinitionsRequest request)` Specifies the extended metrics and custom metrics that you want a CloudWatch RUM app monitor to send to a destination.
`BatchDeleteRumMetricDefinitionsResult`	`batchDeleteRumMetricDefinitions(BatchDeleteRumMetricDefinitionsRequest request)` Removes the specified metrics from being sent to an extended metrics destination.
`BatchGetRumMetricDefinitionsResult`	`batchGetRumMetricDefinitions(BatchGetRumMetricDefinitionsRequest request)` Retrieves the list of metrics and dimensions that a RUM app monitor is sending to a single destination.
`CreateAppMonitorResult`	`createAppMonitor(CreateAppMonitorRequest request)` Creates a Amazon CloudWatch RUM app monitor, which collects telemetry data from your application and sends that data to RUM.
`DeleteAppMonitorResult`	`deleteAppMonitor(DeleteAppMonitorRequest request)` Deletes an existing app monitor.
`DeleteRumMetricsDestinationResult`	`deleteRumMetricsDestination(DeleteRumMetricsDestinationRequest request)` Deletes a destination for CloudWatch RUM extended metrics, so that the specified app monitor stops sending extended metrics to that destination.
`GetAppMonitorResult`	`getAppMonitor(GetAppMonitorRequest request)` Retrieves the complete configuration information for one app monitor.
`GetAppMonitorDataResult`	`getAppMonitorData(GetAppMonitorDataRequest request)` 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.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`ListAppMonitorsResult`	`listAppMonitors(ListAppMonitorsRequest request)` Returns a list of the Amazon CloudWatch RUM app monitors in the account.
`ListRumMetricsDestinationsResult`	`listRumMetricsDestinations(ListRumMetricsDestinationsRequest request)` Returns a list of destinations that you have created to receive RUM extended metrics, for the specified app monitor.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Displays the tags associated with a CloudWatch RUM resource.
`PutRumEventsResult`	`putRumEvents(PutRumEventsRequest request)` Sends telemetry events about your application performance and user behavior to CloudWatch RUM.
`PutRumMetricsDestinationResult`	`putRumMetricsDestination(PutRumMetricsDestinationRequest request)` Creates or updates a destination to receive extended metrics from CloudWatch RUM.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Assigns one or more tags (key-value pairs) to the specified CloudWatch RUM resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes one or more tags from the specified resource.
`UpdateAppMonitorResult`	`updateAppMonitor(UpdateAppMonitorRequest request)` Updates the configuration of an existing app monitor.
`UpdateRumMetricDefinitionResult`	`updateRumMetricDefinition(UpdateRumMetricDefinitionRequest request)` Modifies one existing metric definition for CloudWatch RUM extended metrics.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - batchCreateRumMetricDefinitions
```
public BatchCreateRumMetricDefinitionsResult batchCreateRumMetricDefinitions(BatchCreateRumMetricDefinitionsRequest request)
```
    Description copied from interface: AWSCloudWatchRUM
    Specifies the extended metrics and custom metrics that you want a CloudWatch RUM app monitor to send to a destination. Valid destinations include CloudWatch and Evidently.
    
    By default, RUM app monitors send some metrics to CloudWatch. These default metrics are listed in CloudWatch metrics that you can collect with CloudWatch RUM.
    
    In addition to these default metrics, you can choose to send extended metrics, custom metrics, or both.
    - Extended metrics let you send metrics with additional dimensions that aren't included in the default metrics. You can also send extended metrics to both Evidently and CloudWatch. The valid dimension names for the additional dimensions for extended metrics are BrowserName, CountryCode, DeviceType, FileType, OSName, and PageId. For more information, see Extended metrics that you can send to CloudWatch and CloudWatch Evidently.
    - Custom metrics are metrics that you define. You can send custom metrics to CloudWatch. CloudWatch Evidently, or both. With custom metrics, you can use any metric name and namespace. To derive the metrics, you can use any custom events, built-in events, custom attributes, or default attributes.
      
      You can't send custom metrics to the AWS/RUM namespace. You must send custom metrics to a custom namespace that you define. The namespace that you use can't start with AWS/. CloudWatch RUM prepends RUM/CustomMetrics/ to the custom namespace that you define, so the final namespace for your metrics in CloudWatch is RUM/CustomMetrics/your-custom-namespace .
    The maximum number of metric definitions that you can specify in one BatchCreateRumMetricDefinitions operation is 200.
    
    The maximum number of metric definitions that one destination can contain is 2000.
    
    Extended metrics sent to CloudWatch and RUM custom metrics are charged as CloudWatch custom metrics. Each combination of additional dimension name and dimension value counts as a custom metric. For more information, see Amazon CloudWatch Pricing.
    
    You must have already created a destination for the metrics before you send them. For more information, see PutRumMetricsDestination.
    
    If some metric definitions specified in a BatchCreateRumMetricDefinitions operations are not valid, those metric definitions fail and return errors, but all valid metric definitions in the same operation still succeed.
    Specified by:
    
    batchCreateRumMetricDefinitions in interface AWSCloudWatchRUM
    
    Returns:
    
    Result of the BatchCreateRumMetricDefinitions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchDeleteRumMetricDefinitions
```
public BatchDeleteRumMetricDefinitionsResult batchDeleteRumMetricDefinitions(BatchDeleteRumMetricDefinitionsRequest request)
```
    Description copied from interface: AWSCloudWatchRUM
    
    Removes the specified metrics from being sent to an extended metrics destination.
    
    If some metric definition IDs specified in a BatchDeleteRumMetricDefinitions operations are not valid, those metric definitions fail and return errors, but all valid metric definition IDs in the same operation are still deleted.
    
    The maximum number of metric definitions that you can specify in one BatchDeleteRumMetricDefinitions operation is 200.
    
    Specified by:
    
    batchDeleteRumMetricDefinitions in interface AWSCloudWatchRUM
    
    Returns:
    
    Result of the BatchDeleteRumMetricDefinitions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchGetRumMetricDefinitions
```
public BatchGetRumMetricDefinitionsResult batchGetRumMetricDefinitions(BatchGetRumMetricDefinitionsRequest request)
```
    Description copied from interface: AWSCloudWatchRUM
    
    Retrieves the list of metrics and dimensions that a RUM app monitor is sending to a single destination.
    
    Specified by:
    
    batchGetRumMetricDefinitions in interface AWSCloudWatchRUM
    
    Returns:
    
    Result of the BatchGetRumMetricDefinitions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createAppMonitor
```
public CreateAppMonitorResult createAppMonitor(CreateAppMonitorRequest request)
```
    Description copied from interface: AWSCloudWatchRUM
    
    Creates a Amazon CloudWatch RUM app monitor, which collects telemetry data from your application and sends that data to RUM. The data includes performance and reliability information such as page load time, client-side errors, and user behavior.
    
    You use this operation only to create a new app monitor. To update an existing app monitor, use UpdateAppMonitor instead.
    
    After you create an app monitor, sign in to the CloudWatch RUM console to get the JavaScript code snippet to add to your web application. For more information, see How do I find a code snippet that I've already generated?
    
    Specified by:
    
    createAppMonitor in interface AWSCloudWatchRUM
    
    Returns:
    
    Result of the CreateAppMonitor operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteAppMonitor
```
public DeleteAppMonitorResult deleteAppMonitor(DeleteAppMonitorRequest request)
```
    Description copied from interface: AWSCloudWatchRUM
    
    Deletes an existing app monitor. This immediately stops the collection of data.
    
    Specified by:
    
    deleteAppMonitor in interface AWSCloudWatchRUM
    
    Returns:
    
    Result of the DeleteAppMonitor operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteRumMetricsDestination
```
public DeleteRumMetricsDestinationResult deleteRumMetricsDestination(DeleteRumMetricsDestinationRequest request)
```
    Description copied from interface: AWSCloudWatchRUM
    
    Deletes a destination for CloudWatch RUM extended metrics, so that the specified app monitor stops sending extended metrics to that destination.
    
    Specified by:
    
    deleteRumMetricsDestination in interface AWSCloudWatchRUM
    
    Returns:
    
    Result of the DeleteRumMetricsDestination operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getAppMonitor
```
public GetAppMonitorResult getAppMonitor(GetAppMonitorRequest request)
```
    Description copied from interface: AWSCloudWatchRUM
    
    Retrieves the complete configuration information for one app monitor.
    
    Specified by:
    
    getAppMonitor in interface AWSCloudWatchRUM
    
    Returns:
    
    Result of the GetAppMonitor operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getAppMonitorData
```
public GetAppMonitorDataResult getAppMonitorData(GetAppMonitorDataRequest request)
```
    Description copied from interface: AWSCloudWatchRUM
    
    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.
    
    Specified by:
    
    getAppMonitorData in interface AWSCloudWatchRUM
    
    Returns:
    
    Result of the GetAppMonitorData operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAppMonitors
```
public ListAppMonitorsResult listAppMonitors(ListAppMonitorsRequest request)
```
    Description copied from interface: AWSCloudWatchRUM
    
    Returns a list of the Amazon CloudWatch RUM app monitors in the account.
    
    Specified by:
    
    listAppMonitors in interface AWSCloudWatchRUM
    
    Returns:
    
    Result of the ListAppMonitors operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listRumMetricsDestinations
```
public ListRumMetricsDestinationsResult listRumMetricsDestinations(ListRumMetricsDestinationsRequest request)
```
    Description copied from interface: AWSCloudWatchRUM
    
    Returns a list of destinations that you have created to receive RUM extended metrics, for the specified app monitor.
    
    For more information about extended metrics, see AddRumMetrics.
    
    Specified by:
    
    listRumMetricsDestinations in interface AWSCloudWatchRUM
    
    Returns:
    
    Result of the ListRumMetricsDestinations operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AWSCloudWatchRUM
    
    Displays the tags associated with a CloudWatch RUM resource.
    
    Specified by:
    
    listTagsForResource in interface AWSCloudWatchRUM
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putRumEvents
```
public PutRumEventsResult putRumEvents(PutRumEventsRequest request)
```
    Description copied from interface: AWSCloudWatchRUM
    
    Sends telemetry events about your application performance and user behavior to CloudWatch RUM. The code snippet that RUM generates for you to add to your application includes PutRumEvents operations to send this data to RUM.
    
    Each PutRumEvents operation can send a batch of events from one user session.
    
    Specified by:
    
    putRumEvents in interface AWSCloudWatchRUM
    
    Returns:
    
    Result of the PutRumEvents operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putRumMetricsDestination
```
public PutRumMetricsDestinationResult putRumMetricsDestination(PutRumMetricsDestinationRequest request)
```
    Description copied from interface: AWSCloudWatchRUM
    
    Creates or updates a destination to receive extended metrics from CloudWatch RUM. You can send extended metrics to CloudWatch or to a CloudWatch Evidently experiment.
    
    For more information about extended metrics, see BatchCreateRumMetricDefinitions.
    
    Specified by:
    
    putRumMetricsDestination in interface AWSCloudWatchRUM
    
    Returns:
    
    Result of the PutRumMetricsDestination operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AWSCloudWatchRUM
    
    Assigns one or more tags (key-value pairs) to the specified CloudWatch RUM resource. Currently, the only resources that can be tagged app monitors.
    
    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 use the TagResource action with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
    
    You can associate as many as 50 tags with a resource.
    
    For more information, see Tagging Amazon Web Services resources.
    
    Specified by:
    
    tagResource in interface AWSCloudWatchRUM
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AWSCloudWatchRUM
    
    Removes one or more tags from the specified resource.
    
    Specified by:
    
    untagResource in interface AWSCloudWatchRUM
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateAppMonitor
```
public UpdateAppMonitorResult updateAppMonitor(UpdateAppMonitorRequest request)
```
    Description copied from interface: AWSCloudWatchRUM
    
    Updates the configuration of an existing app monitor. When you use this operation, only the parts of the app monitor configuration that you specify in this operation are changed. For any parameters that you omit, the existing values are kept.
    
    You can't use this operation to change the tags of an existing app monitor. To change the tags of an existing app monitor, use TagResource.
    
    To create a new app monitor, use CreateAppMonitor.
    
    After you update an app monitor, sign in to the CloudWatch RUM console to get the updated JavaScript code snippet to add to your web application. For more information, see How do I find a code snippet that I've already generated?
    
    Specified by:
    
    updateAppMonitor in interface AWSCloudWatchRUM
    
    Returns:
    
    Result of the UpdateAppMonitor operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateRumMetricDefinition
```
public UpdateRumMetricDefinitionResult updateRumMetricDefinition(UpdateRumMetricDefinitionRequest request)
```
    Description copied from interface: AWSCloudWatchRUM
    
    Modifies one existing metric definition for CloudWatch RUM extended metrics. For more information about extended metrics, see BatchCreateRumMetricsDefinitions.
    
    Specified by:
    
    updateRumMetricDefinition in interface AWSCloudWatchRUM
    
    Returns:
    
    Result of the UpdateRumMetricDefinition operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSCloudWatchRUM
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSCloudWatchRUM
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSCloudWatchRUM
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSCloudWatchRUM
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

AWS SDK for Java 1.x API Reference - 1.12.779

Class AbstractAWSCloudWatchRUM

Field Summary

Fields inherited from interface com.amazonaws.services.cloudwatchrum.AWSCloudWatchRUM

Method Summary

Methods inherited from class java.lang.Object

Method Detail

batchCreateRumMetricDefinitions

batchDeleteRumMetricDefinitions

batchGetRumMetricDefinitions

createAppMonitor

deleteAppMonitor

deleteRumMetricsDestination

getAppMonitor

getAppMonitorData

listAppMonitors

listRumMetricsDestinations

listTagsForResource

putRumEvents

putRumMetricsDestination

tagResource

untagResource

updateAppMonitor

updateRumMetricDefinition

shutdown

getCachedResponseMetadata