com.amazonaws.services.cloudwatchrum

Interface AWSCloudWatchRUM

All Known Subinterfaces:

AWSCloudWatchRUMAsync

All Known Implementing Classes:

AbstractAWSCloudWatchRUM, AbstractAWSCloudWatchRUMAsync, AWSCloudWatchRUMAsyncClient, AWSCloudWatchRUMClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSCloudWatchRUM

Interface for accessing CloudWatch RUM.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSCloudWatchRUM instead.

With Amazon CloudWatch RUM, you can perform real-user monitoring to collect client-side data about your web application performance from actual user sessions in real time. The data collected includes page load times, client-side errors, and user behavior. When you view this data, you can see it all aggregated together and also see breakdowns by the browsers and devices that your customers use.

You can use the collected data to quickly identify and debug client-side performance issues. CloudWatch RUM helps you visualize anomalies in your application performance and find relevant debugging data such as error messages, stack traces, and user sessions. You can also use RUM to understand the range of end-user impact including the number of users, geolocations, and browsers used.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
BatchCreateRumMetricDefinitionsResult	batchCreateRumMetricDefinitions(BatchCreateRumMetricDefinitionsRequest batchCreateRumMetricDefinitionsRequest) Specifies the extended metrics and custom metrics that you want a CloudWatch RUM app monitor to send to a destination.
BatchDeleteRumMetricDefinitionsResult	batchDeleteRumMetricDefinitions(BatchDeleteRumMetricDefinitionsRequest batchDeleteRumMetricDefinitionsRequest) Removes the specified metrics from being sent to an extended metrics destination.
BatchGetRumMetricDefinitionsResult	batchGetRumMetricDefinitions(BatchGetRumMetricDefinitionsRequest batchGetRumMetricDefinitionsRequest) Retrieves the list of metrics and dimensions that a RUM app monitor is sending to a single destination.
CreateAppMonitorResult	createAppMonitor(CreateAppMonitorRequest createAppMonitorRequest) Creates a Amazon CloudWatch RUM app monitor, which collects telemetry data from your application and sends that data to RUM.
DeleteAppMonitorResult	deleteAppMonitor(DeleteAppMonitorRequest deleteAppMonitorRequest) Deletes an existing app monitor.
DeleteRumMetricsDestinationResult	deleteRumMetricsDestination(DeleteRumMetricsDestinationRequest deleteRumMetricsDestinationRequest) Deletes a destination for CloudWatch RUM extended metrics, so that the specified app monitor stops sending extended metrics to that destination.
GetAppMonitorResult	getAppMonitor(GetAppMonitorRequest getAppMonitorRequest) Retrieves the complete configuration information for one app monitor.
GetAppMonitorDataResult	getAppMonitorData(GetAppMonitorDataRequest getAppMonitorDataRequest) 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 listAppMonitorsRequest) Returns a list of the Amazon CloudWatch RUM app monitors in the account.
ListRumMetricsDestinationsResult	listRumMetricsDestinations(ListRumMetricsDestinationsRequest listRumMetricsDestinationsRequest) Returns a list of destinations that you have created to receive RUM extended metrics, for the specified app monitor.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Displays the tags associated with a CloudWatch RUM resource.
PutRumEventsResult	putRumEvents(PutRumEventsRequest putRumEventsRequest) Sends telemetry events about your application performance and user behavior to CloudWatch RUM.
PutRumMetricsDestinationResult	putRumMetricsDestination(PutRumMetricsDestinationRequest putRumMetricsDestinationRequest) 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 tagResourceRequest) Assigns one or more tags (key-value pairs) to the specified CloudWatch RUM resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes one or more tags from the specified resource.
UpdateAppMonitorResult	updateAppMonitor(UpdateAppMonitorRequest updateAppMonitorRequest) Updates the configuration of an existing app monitor.
UpdateRumMetricDefinitionResult	updateRumMetricDefinition(UpdateRumMetricDefinitionRequest updateRumMetricDefinitionRequest) Modifies one existing metric definition for CloudWatch RUM extended metrics.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

batchCreateRumMetricDefinitions

BatchCreateRumMetricDefinitionsResult batchCreateRumMetricDefinitions(BatchCreateRumMetricDefinitionsRequest batchCreateRumMetricDefinitionsRequest)

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 or custom metrics or both.

• Extended metrics enable you to send metrics with additional dimensions not included in the default metrics. You can also send extended metrics to Evidently as well as 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 or to CloudWatch Evidently or to both. With custom metrics, you can use any metric name and namespace, and 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.

Parameters:

batchCreateRumMetricDefinitionsRequest -

Returns:

Result of the BatchCreateRumMetricDefinitions operation returned by the service.

Throws:

ConflictException - This operation attempted to create a resource that already exists.

ServiceQuotaExceededException - This request exceeds a service quota.

ResourceNotFoundException - Resource not found.

InternalServerException - Internal service exception.

ValidationException - One of the arguments for the request is not valid.

ThrottlingException - The request was throttled because of quota limits.

AccessDeniedException - You don't have sufficient permissions to perform this action.

See Also:

AWS API Documentation

batchDeleteRumMetricDefinitions

BatchDeleteRumMetricDefinitionsResult batchDeleteRumMetricDefinitions(BatchDeleteRumMetricDefinitionsRequest batchDeleteRumMetricDefinitionsRequest)

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.

Parameters:

batchDeleteRumMetricDefinitionsRequest -

Returns:

Result of the BatchDeleteRumMetricDefinitions operation returned by the service.

Throws:

ConflictException - This operation attempted to create a resource that already exists.

ResourceNotFoundException - Resource not found.

InternalServerException - Internal service exception.

ValidationException - One of the arguments for the request is not valid.

ThrottlingException - The request was throttled because of quota limits.

AccessDeniedException - You don't have sufficient permissions to perform this action.

See Also:

AWS API Documentation

batchGetRumMetricDefinitions

BatchGetRumMetricDefinitionsResult batchGetRumMetricDefinitions(BatchGetRumMetricDefinitionsRequest batchGetRumMetricDefinitionsRequest)

Retrieves the list of metrics and dimensions that a RUM app monitor is sending to a single destination.

Parameters:

batchGetRumMetricDefinitionsRequest -

Returns:

Result of the BatchGetRumMetricDefinitions operation returned by the service.

Throws:

ResourceNotFoundException - Resource not found.

InternalServerException - Internal service exception.

ValidationException - One of the arguments for the request is not valid.

AccessDeniedException - You don't have sufficient permissions to perform this action.

See Also:

AWS API Documentation

createAppMonitor

CreateAppMonitorResult createAppMonitor(CreateAppMonitorRequest createAppMonitorRequest)

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?

Parameters:

createAppMonitorRequest -

Returns:

Result of the CreateAppMonitor operation returned by the service.

Throws:

ConflictException - This operation attempted to create a resource that already exists.

ServiceQuotaExceededException - This request exceeds a service quota.

ResourceNotFoundException - Resource not found.

InternalServerException - Internal service exception.

ValidationException - One of the arguments for the request is not valid.

ThrottlingException - The request was throttled because of quota limits.

AccessDeniedException - You don't have sufficient permissions to perform this action.

See Also:

AWS API Documentation

deleteAppMonitor

DeleteAppMonitorResult deleteAppMonitor(DeleteAppMonitorRequest deleteAppMonitorRequest)

Deletes an existing app monitor. This immediately stops the collection of data.

Parameters:

deleteAppMonitorRequest -

Returns:

Result of the DeleteAppMonitor operation returned by the service.

Throws:

ConflictException - This operation attempted to create a resource that already exists.

ResourceNotFoundException - Resource not found.

InternalServerException - Internal service exception.

ValidationException - One of the arguments for the request is not valid.

ThrottlingException - The request was throttled because of quota limits.

AccessDeniedException - You don't have sufficient permissions to perform this action.

See Also:

AWS API Documentation

deleteRumMetricsDestination

DeleteRumMetricsDestinationResult deleteRumMetricsDestination(DeleteRumMetricsDestinationRequest deleteRumMetricsDestinationRequest)

Deletes a destination for CloudWatch RUM extended metrics, so that the specified app monitor stops sending extended metrics to that destination.

Parameters:

deleteRumMetricsDestinationRequest -

Returns:

Result of the DeleteRumMetricsDestination operation returned by the service.

Throws:

ConflictException - This operation attempted to create a resource that already exists.

ResourceNotFoundException - Resource not found.

InternalServerException - Internal service exception.

ValidationException - One of the arguments for the request is not valid.

ThrottlingException - The request was throttled because of quota limits.

AccessDeniedException - You don't have sufficient permissions to perform this action.

See Also:

AWS API Documentation

getAppMonitor

GetAppMonitorResult getAppMonitor(GetAppMonitorRequest getAppMonitorRequest)

Retrieves the complete configuration information for one app monitor.

Parameters:

getAppMonitorRequest -

Returns:

Result of the GetAppMonitor operation returned by the service.

Throws:

ResourceNotFoundException - Resource not found.

InternalServerException - Internal service exception.

ValidationException - One of the arguments for the request is not valid.

ThrottlingException - The request was throttled because of quota limits.

AccessDeniedException - You don't have sufficient permissions to perform this action.

See Also:

AWS API Documentation

getAppMonitorData

GetAppMonitorDataResult getAppMonitorData(GetAppMonitorDataRequest getAppMonitorDataRequest)

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.

Parameters:

getAppMonitorDataRequest -

Returns:

Result of the GetAppMonitorData operation returned by the service.

Throws:

ResourceNotFoundException - Resource not found.

InternalServerException - Internal service exception.

ValidationException - One of the arguments for the request is not valid.

ThrottlingException - The request was throttled because of quota limits.

AccessDeniedException - You don't have sufficient permissions to perform this action.

See Also:

AWS API Documentation

listAppMonitors

ListAppMonitorsResult listAppMonitors(ListAppMonitorsRequest listAppMonitorsRequest)

Returns a list of the Amazon CloudWatch RUM app monitors in the account.

Parameters:

listAppMonitorsRequest -

Returns:

Result of the ListAppMonitors operation returned by the service.

Throws:

InternalServerException - Internal service exception.

ValidationException - One of the arguments for the request is not valid.

ThrottlingException - The request was throttled because of quota limits.

AccessDeniedException - You don't have sufficient permissions to perform this action.

See Also:

AWS API Documentation

listRumMetricsDestinations

ListRumMetricsDestinationsResult listRumMetricsDestinations(ListRumMetricsDestinationsRequest listRumMetricsDestinationsRequest)

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.

Parameters:

listRumMetricsDestinationsRequest -

Returns:

Result of the ListRumMetricsDestinations operation returned by the service.

Throws:

ResourceNotFoundException - Resource not found.

InternalServerException - Internal service exception.

ValidationException - One of the arguments for the request is not valid.

AccessDeniedException - You don't have sufficient permissions to perform this action.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Displays the tags associated with a CloudWatch RUM resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ResourceNotFoundException - Resource not found.

InternalServerException - Internal service exception.

ValidationException - One of the arguments for the request is not valid.

See Also:

AWS API Documentation

putRumEvents

PutRumEventsResult putRumEvents(PutRumEventsRequest putRumEventsRequest)

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.

Parameters:

putRumEventsRequest -

Returns:

Result of the PutRumEvents operation returned by the service.

Throws:

ResourceNotFoundException - Resource not found.

InternalServerException - Internal service exception.

ValidationException - One of the arguments for the request is not valid.

ThrottlingException - The request was throttled because of quota limits.

AccessDeniedException - You don't have sufficient permissions to perform this action.

See Also:

AWS API Documentation

putRumMetricsDestination

PutRumMetricsDestinationResult putRumMetricsDestination(PutRumMetricsDestinationRequest putRumMetricsDestinationRequest)

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.

Parameters:

putRumMetricsDestinationRequest -

Returns:

Result of the PutRumMetricsDestination operation returned by the service.

Throws:

ConflictException - This operation attempted to create a resource that already exists.

ResourceNotFoundException - Resource not found.

InternalServerException - Internal service exception.

ValidationException - One of the arguments for the request is not valid.

ThrottlingException - The request was throttled because of quota limits.

AccessDeniedException - You don't have sufficient permissions to perform this action.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

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.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

ResourceNotFoundException - Resource not found.

InternalServerException - Internal service exception.

ValidationException - One of the arguments for the request is not valid.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes one or more tags from the specified resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

ResourceNotFoundException - Resource not found.

InternalServerException - Internal service exception.

ValidationException - One of the arguments for the request is not valid.

See Also:

AWS API Documentation

updateAppMonitor

UpdateAppMonitorResult updateAppMonitor(UpdateAppMonitorRequest updateAppMonitorRequest)

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?

Parameters:

updateAppMonitorRequest -

Returns:

Result of the UpdateAppMonitor operation returned by the service.

Throws:

ConflictException - This operation attempted to create a resource that already exists.

ResourceNotFoundException - Resource not found.

InternalServerException - Internal service exception.

ValidationException - One of the arguments for the request is not valid.

ThrottlingException - The request was throttled because of quota limits.

AccessDeniedException - You don't have sufficient permissions to perform this action.

See Also:

AWS API Documentation

updateRumMetricDefinition

UpdateRumMetricDefinitionResult updateRumMetricDefinition(UpdateRumMetricDefinitionRequest updateRumMetricDefinitionRequest)

Modifies one existing metric definition for CloudWatch RUM extended metrics. For more information about extended metrics, see BatchCreateRumMetricsDefinitions.

Parameters:

updateRumMetricDefinitionRequest -

Returns:

Result of the UpdateRumMetricDefinition operation returned by the service.

Throws:

ConflictException - This operation attempted to create a resource that already exists.

ServiceQuotaExceededException - This request exceeds a service quota.

ResourceNotFoundException - Resource not found.

InternalServerException - Internal service exception.

ValidationException - One of the arguments for the request is not valid.

ThrottlingException - The request was throttled because of quota limits.

AccessDeniedException - You don't have sufficient permissions to perform this action.

See Also:

AWS API Documentation

shutdown

void shutdown()

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.

getCachedResponseMetadata

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

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.