Interface RumClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
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
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbatchCreateRumMetricDefinitions
(Consumer<BatchCreateRumMetricDefinitionsRequest.Builder> batchCreateRumMetricDefinitionsRequest) Specifies the extended metrics and custom metrics that you want a CloudWatch RUM app monitor to send to a destination.batchCreateRumMetricDefinitions
(BatchCreateRumMetricDefinitionsRequest batchCreateRumMetricDefinitionsRequest) Specifies the extended metrics and custom metrics that you want a CloudWatch RUM app monitor to send to a destination.batchDeleteRumMetricDefinitions
(Consumer<BatchDeleteRumMetricDefinitionsRequest.Builder> batchDeleteRumMetricDefinitionsRequest) Removes the specified metrics from being sent to an extended metrics destination.batchDeleteRumMetricDefinitions
(BatchDeleteRumMetricDefinitionsRequest batchDeleteRumMetricDefinitionsRequest) Removes the specified metrics from being sent to an extended metrics destination.batchGetRumMetricDefinitions
(Consumer<BatchGetRumMetricDefinitionsRequest.Builder> batchGetRumMetricDefinitionsRequest) Retrieves the list of metrics and dimensions that a RUM app monitor is sending to a single destination.batchGetRumMetricDefinitions
(BatchGetRumMetricDefinitionsRequest batchGetRumMetricDefinitionsRequest) Retrieves the list of metrics and dimensions that a RUM app monitor is sending to a single destination.batchGetRumMetricDefinitionsPaginator
(Consumer<BatchGetRumMetricDefinitionsRequest.Builder> batchGetRumMetricDefinitionsRequest) This is a variant ofbatchGetRumMetricDefinitions(software.amazon.awssdk.services.rum.model.BatchGetRumMetricDefinitionsRequest)
operation.batchGetRumMetricDefinitionsPaginator
(BatchGetRumMetricDefinitionsRequest batchGetRumMetricDefinitionsRequest) This is a variant ofbatchGetRumMetricDefinitions(software.amazon.awssdk.services.rum.model.BatchGetRumMetricDefinitionsRequest)
operation.static RumClientBuilder
builder()
Create a builder that can be used to configure and create aRumClient
.static RumClient
create()
Create aRumClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateAppMonitorResponse
createAppMonitor
(Consumer<CreateAppMonitorRequest.Builder> createAppMonitorRequest) Creates a Amazon CloudWatch RUM app monitor, which collects telemetry data from your application and sends that data to RUM.default CreateAppMonitorResponse
createAppMonitor
(CreateAppMonitorRequest createAppMonitorRequest) Creates a Amazon CloudWatch RUM app monitor, which collects telemetry data from your application and sends that data to RUM.default DeleteAppMonitorResponse
deleteAppMonitor
(Consumer<DeleteAppMonitorRequest.Builder> deleteAppMonitorRequest) Deletes an existing app monitor.default DeleteAppMonitorResponse
deleteAppMonitor
(DeleteAppMonitorRequest deleteAppMonitorRequest) Deletes an existing app monitor.deleteRumMetricsDestination
(Consumer<DeleteRumMetricsDestinationRequest.Builder> deleteRumMetricsDestinationRequest) Deletes a destination for CloudWatch RUM extended metrics, so that the specified app monitor stops sending extended metrics to that destination.deleteRumMetricsDestination
(DeleteRumMetricsDestinationRequest deleteRumMetricsDestinationRequest) Deletes a destination for CloudWatch RUM extended metrics, so that the specified app monitor stops sending extended metrics to that destination.default GetAppMonitorResponse
getAppMonitor
(Consumer<GetAppMonitorRequest.Builder> getAppMonitorRequest) Retrieves the complete configuration information for one app monitor.default GetAppMonitorResponse
getAppMonitor
(GetAppMonitorRequest getAppMonitorRequest) Retrieves the complete configuration information for one app monitor.default GetAppMonitorDataResponse
getAppMonitorData
(Consumer<GetAppMonitorDataRequest.Builder> 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.default GetAppMonitorDataResponse
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.default GetAppMonitorDataIterable
getAppMonitorDataPaginator
(Consumer<GetAppMonitorDataRequest.Builder> getAppMonitorDataRequest) This is a variant ofgetAppMonitorData(software.amazon.awssdk.services.rum.model.GetAppMonitorDataRequest)
operation.default GetAppMonitorDataIterable
getAppMonitorDataPaginator
(GetAppMonitorDataRequest getAppMonitorDataRequest) This is a variant ofgetAppMonitorData(software.amazon.awssdk.services.rum.model.GetAppMonitorDataRequest)
operation.default ListAppMonitorsResponse
listAppMonitors
(Consumer<ListAppMonitorsRequest.Builder> listAppMonitorsRequest) Returns a list of the Amazon CloudWatch RUM app monitors in the account.default ListAppMonitorsResponse
listAppMonitors
(ListAppMonitorsRequest listAppMonitorsRequest) Returns a list of the Amazon CloudWatch RUM app monitors in the account.default ListAppMonitorsIterable
listAppMonitorsPaginator
(Consumer<ListAppMonitorsRequest.Builder> listAppMonitorsRequest) This is a variant oflistAppMonitors(software.amazon.awssdk.services.rum.model.ListAppMonitorsRequest)
operation.default ListAppMonitorsIterable
listAppMonitorsPaginator
(ListAppMonitorsRequest listAppMonitorsRequest) This is a variant oflistAppMonitors(software.amazon.awssdk.services.rum.model.ListAppMonitorsRequest)
operation.listRumMetricsDestinations
(Consumer<ListRumMetricsDestinationsRequest.Builder> listRumMetricsDestinationsRequest) Returns a list of destinations that you have created to receive RUM extended metrics, for the specified app monitor.listRumMetricsDestinations
(ListRumMetricsDestinationsRequest listRumMetricsDestinationsRequest) Returns a list of destinations that you have created to receive RUM extended metrics, for the specified app monitor.listRumMetricsDestinationsPaginator
(Consumer<ListRumMetricsDestinationsRequest.Builder> listRumMetricsDestinationsRequest) This is a variant oflistRumMetricsDestinations(software.amazon.awssdk.services.rum.model.ListRumMetricsDestinationsRequest)
operation.listRumMetricsDestinationsPaginator
(ListRumMetricsDestinationsRequest listRumMetricsDestinationsRequest) This is a variant oflistRumMetricsDestinations(software.amazon.awssdk.services.rum.model.ListRumMetricsDestinationsRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Displays the tags associated with a CloudWatch RUM resource.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Displays the tags associated with a CloudWatch RUM resource.default PutRumEventsResponse
putRumEvents
(Consumer<PutRumEventsRequest.Builder> putRumEventsRequest) Sends telemetry events about your application performance and user behavior to CloudWatch RUM.default PutRumEventsResponse
putRumEvents
(PutRumEventsRequest putRumEventsRequest) Sends telemetry events about your application performance and user behavior to CloudWatch RUM.default PutRumMetricsDestinationResponse
putRumMetricsDestination
(Consumer<PutRumMetricsDestinationRequest.Builder> putRumMetricsDestinationRequest) Creates or updates a destination to receive extended metrics from CloudWatch RUM.default PutRumMetricsDestinationResponse
putRumMetricsDestination
(PutRumMetricsDestinationRequest putRumMetricsDestinationRequest) Creates or updates a destination to receive extended metrics from CloudWatch RUM.default RumServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Assigns one or more tags (key-value pairs) to the specified CloudWatch RUM resource.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Assigns one or more tags (key-value pairs) to the specified CloudWatch RUM resource.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes one or more tags from the specified resource.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Removes one or more tags from the specified resource.default UpdateAppMonitorResponse
updateAppMonitor
(Consumer<UpdateAppMonitorRequest.Builder> updateAppMonitorRequest) Updates the configuration of an existing app monitor.default UpdateAppMonitorResponse
updateAppMonitor
(UpdateAppMonitorRequest updateAppMonitorRequest) Updates the configuration of an existing app monitor.updateRumMetricDefinition
(Consumer<UpdateRumMetricDefinitionRequest.Builder> updateRumMetricDefinitionRequest) Modifies one existing metric definition for CloudWatch RUM extended metrics.updateRumMetricDefinition
(UpdateRumMetricDefinitionRequest updateRumMetricDefinitionRequest) Modifies one existing metric definition for CloudWatch RUM extended metrics.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
batchCreateRumMetricDefinitions
default BatchCreateRumMetricDefinitionsResponse batchCreateRumMetricDefinitions(BatchCreateRumMetricDefinitionsRequest batchCreateRumMetricDefinitionsRequest) throws ConflictException, ServiceQuotaExceededException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, RumException 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
, andPageId
. 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 withAWS/
. CloudWatch RUM prependsRUM/CustomMetrics/
to the custom namespace that you define, so the final namespace for your metrics in CloudWatch isRUM/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.
- See Also:
-
-
batchCreateRumMetricDefinitions
default BatchCreateRumMetricDefinitionsResponse batchCreateRumMetricDefinitions(Consumer<BatchCreateRumMetricDefinitionsRequest.Builder> batchCreateRumMetricDefinitionsRequest) throws ConflictException, ServiceQuotaExceededException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, RumException 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
, andPageId
. 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 withAWS/
. CloudWatch RUM prependsRUM/CustomMetrics/
to the custom namespace that you define, so the final namespace for your metrics in CloudWatch isRUM/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.
This is a convenience which creates an instance of the
BatchCreateRumMetricDefinitionsRequest.Builder
avoiding the need to create one manually viaBatchCreateRumMetricDefinitionsRequest.builder()
- Parameters:
batchCreateRumMetricDefinitionsRequest
- AConsumer
that will call methods onBatchCreateRumMetricDefinitionsRequest.Builder
to create a request.- Returns:
- Result of the BatchCreateRumMetricDefinitions operation returned by the service.
- See Also:
-
-
batchDeleteRumMetricDefinitions
default BatchDeleteRumMetricDefinitionsResponse batchDeleteRumMetricDefinitions(BatchDeleteRumMetricDefinitionsRequest batchDeleteRumMetricDefinitionsRequest) throws ConflictException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, RumException 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.
- See Also:
-
batchDeleteRumMetricDefinitions
default BatchDeleteRumMetricDefinitionsResponse batchDeleteRumMetricDefinitions(Consumer<BatchDeleteRumMetricDefinitionsRequest.Builder> batchDeleteRumMetricDefinitionsRequest) throws ConflictException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, RumException 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.
This is a convenience which creates an instance of the
BatchDeleteRumMetricDefinitionsRequest.Builder
avoiding the need to create one manually viaBatchDeleteRumMetricDefinitionsRequest.builder()
- Parameters:
batchDeleteRumMetricDefinitionsRequest
- AConsumer
that will call methods onBatchDeleteRumMetricDefinitionsRequest.Builder
to create a request.- Returns:
- Result of the BatchDeleteRumMetricDefinitions operation returned by the service.
- See Also:
-
batchGetRumMetricDefinitions
default BatchGetRumMetricDefinitionsResponse batchGetRumMetricDefinitions(BatchGetRumMetricDefinitionsRequest batchGetRumMetricDefinitionsRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, RumException 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.
- See Also:
-
batchGetRumMetricDefinitions
default BatchGetRumMetricDefinitionsResponse batchGetRumMetricDefinitions(Consumer<BatchGetRumMetricDefinitionsRequest.Builder> batchGetRumMetricDefinitionsRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, RumException Retrieves the list of metrics and dimensions that a RUM app monitor is sending to a single destination.
This is a convenience which creates an instance of the
BatchGetRumMetricDefinitionsRequest.Builder
avoiding the need to create one manually viaBatchGetRumMetricDefinitionsRequest.builder()
- Parameters:
batchGetRumMetricDefinitionsRequest
- AConsumer
that will call methods onBatchGetRumMetricDefinitionsRequest.Builder
to create a request.- Returns:
- Result of the BatchGetRumMetricDefinitions operation returned by the service.
- See Also:
-
batchGetRumMetricDefinitionsPaginator
default BatchGetRumMetricDefinitionsIterable batchGetRumMetricDefinitionsPaginator(BatchGetRumMetricDefinitionsRequest batchGetRumMetricDefinitionsRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, RumException This is a variant of
batchGetRumMetricDefinitions(software.amazon.awssdk.services.rum.model.BatchGetRumMetricDefinitionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rum.paginators.BatchGetRumMetricDefinitionsIterable responses = client.batchGetRumMetricDefinitionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rum.paginators.BatchGetRumMetricDefinitionsIterable responses = client .batchGetRumMetricDefinitionsPaginator(request); for (software.amazon.awssdk.services.rum.model.BatchGetRumMetricDefinitionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rum.paginators.BatchGetRumMetricDefinitionsIterable responses = client.batchGetRumMetricDefinitionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
batchGetRumMetricDefinitions(software.amazon.awssdk.services.rum.model.BatchGetRumMetricDefinitionsRequest)
operation.- Parameters:
batchGetRumMetricDefinitionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
batchGetRumMetricDefinitionsPaginator
default BatchGetRumMetricDefinitionsIterable batchGetRumMetricDefinitionsPaginator(Consumer<BatchGetRumMetricDefinitionsRequest.Builder> batchGetRumMetricDefinitionsRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, RumException This is a variant of
batchGetRumMetricDefinitions(software.amazon.awssdk.services.rum.model.BatchGetRumMetricDefinitionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rum.paginators.BatchGetRumMetricDefinitionsIterable responses = client.batchGetRumMetricDefinitionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rum.paginators.BatchGetRumMetricDefinitionsIterable responses = client .batchGetRumMetricDefinitionsPaginator(request); for (software.amazon.awssdk.services.rum.model.BatchGetRumMetricDefinitionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rum.paginators.BatchGetRumMetricDefinitionsIterable responses = client.batchGetRumMetricDefinitionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
batchGetRumMetricDefinitions(software.amazon.awssdk.services.rum.model.BatchGetRumMetricDefinitionsRequest)
operation.
This is a convenience which creates an instance of the
BatchGetRumMetricDefinitionsRequest.Builder
avoiding the need to create one manually viaBatchGetRumMetricDefinitionsRequest.builder()
- Parameters:
batchGetRumMetricDefinitionsRequest
- AConsumer
that will call methods onBatchGetRumMetricDefinitionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
createAppMonitor
default CreateAppMonitorResponse createAppMonitor(CreateAppMonitorRequest createAppMonitorRequest) throws ConflictException, ServiceQuotaExceededException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, RumException 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.
- See Also:
-
createAppMonitor
default CreateAppMonitorResponse createAppMonitor(Consumer<CreateAppMonitorRequest.Builder> createAppMonitorRequest) throws ConflictException, ServiceQuotaExceededException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, RumException 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?
This is a convenience which creates an instance of the
CreateAppMonitorRequest.Builder
avoiding the need to create one manually viaCreateAppMonitorRequest.builder()
- Parameters:
createAppMonitorRequest
- AConsumer
that will call methods onCreateAppMonitorRequest.Builder
to create a request.- Returns:
- Result of the CreateAppMonitor operation returned by the service.
- See Also:
-
deleteAppMonitor
default DeleteAppMonitorResponse deleteAppMonitor(DeleteAppMonitorRequest deleteAppMonitorRequest) throws ConflictException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, RumException Deletes an existing app monitor. This immediately stops the collection of data.
- Parameters:
deleteAppMonitorRequest
-- Returns:
- Result of the DeleteAppMonitor operation returned by the service.
- See Also:
-
deleteAppMonitor
default DeleteAppMonitorResponse deleteAppMonitor(Consumer<DeleteAppMonitorRequest.Builder> deleteAppMonitorRequest) throws ConflictException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, RumException Deletes an existing app monitor. This immediately stops the collection of data.
This is a convenience which creates an instance of the
DeleteAppMonitorRequest.Builder
avoiding the need to create one manually viaDeleteAppMonitorRequest.builder()
- Parameters:
deleteAppMonitorRequest
- AConsumer
that will call methods onDeleteAppMonitorRequest.Builder
to create a request.- Returns:
- Result of the DeleteAppMonitor operation returned by the service.
- See Also:
-
deleteRumMetricsDestination
default DeleteRumMetricsDestinationResponse deleteRumMetricsDestination(DeleteRumMetricsDestinationRequest deleteRumMetricsDestinationRequest) throws ConflictException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, RumException 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.
- See Also:
-
deleteRumMetricsDestination
default DeleteRumMetricsDestinationResponse deleteRumMetricsDestination(Consumer<DeleteRumMetricsDestinationRequest.Builder> deleteRumMetricsDestinationRequest) throws ConflictException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, RumException Deletes a destination for CloudWatch RUM extended metrics, so that the specified app monitor stops sending extended metrics to that destination.
This is a convenience which creates an instance of the
DeleteRumMetricsDestinationRequest.Builder
avoiding the need to create one manually viaDeleteRumMetricsDestinationRequest.builder()
- Parameters:
deleteRumMetricsDestinationRequest
- AConsumer
that will call methods onDeleteRumMetricsDestinationRequest.Builder
to create a request.- Returns:
- Result of the DeleteRumMetricsDestination operation returned by the service.
- See Also:
-
getAppMonitor
default GetAppMonitorResponse getAppMonitor(GetAppMonitorRequest getAppMonitorRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, RumException Retrieves the complete configuration information for one app monitor.
- Parameters:
getAppMonitorRequest
-- Returns:
- Result of the GetAppMonitor operation returned by the service.
- See Also:
-
getAppMonitor
default GetAppMonitorResponse getAppMonitor(Consumer<GetAppMonitorRequest.Builder> getAppMonitorRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, RumException Retrieves the complete configuration information for one app monitor.
This is a convenience which creates an instance of the
GetAppMonitorRequest.Builder
avoiding the need to create one manually viaGetAppMonitorRequest.builder()
- Parameters:
getAppMonitorRequest
- AConsumer
that will call methods onGetAppMonitorRequest.Builder
to create a request.- Returns:
- Result of the GetAppMonitor operation returned by the service.
- See Also:
-
getAppMonitorData
default GetAppMonitorDataResponse getAppMonitorData(GetAppMonitorDataRequest getAppMonitorDataRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, RumException 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.
- See Also:
-
getAppMonitorData
default GetAppMonitorDataResponse getAppMonitorData(Consumer<GetAppMonitorDataRequest.Builder> getAppMonitorDataRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, RumException 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.
This is a convenience which creates an instance of the
GetAppMonitorDataRequest.Builder
avoiding the need to create one manually viaGetAppMonitorDataRequest.builder()
- Parameters:
getAppMonitorDataRequest
- AConsumer
that will call methods onGetAppMonitorDataRequest.Builder
to create a request.- Returns:
- Result of the GetAppMonitorData operation returned by the service.
- See Also:
-
getAppMonitorDataPaginator
default GetAppMonitorDataIterable getAppMonitorDataPaginator(GetAppMonitorDataRequest getAppMonitorDataRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, RumException This is a variant of
getAppMonitorData(software.amazon.awssdk.services.rum.model.GetAppMonitorDataRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rum.paginators.GetAppMonitorDataIterable responses = client.getAppMonitorDataPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rum.paginators.GetAppMonitorDataIterable responses = client .getAppMonitorDataPaginator(request); for (software.amazon.awssdk.services.rum.model.GetAppMonitorDataResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rum.paginators.GetAppMonitorDataIterable responses = client.getAppMonitorDataPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getAppMonitorData(software.amazon.awssdk.services.rum.model.GetAppMonitorDataRequest)
operation.- Parameters:
getAppMonitorDataRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getAppMonitorDataPaginator
default GetAppMonitorDataIterable getAppMonitorDataPaginator(Consumer<GetAppMonitorDataRequest.Builder> getAppMonitorDataRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, RumException This is a variant of
getAppMonitorData(software.amazon.awssdk.services.rum.model.GetAppMonitorDataRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rum.paginators.GetAppMonitorDataIterable responses = client.getAppMonitorDataPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rum.paginators.GetAppMonitorDataIterable responses = client .getAppMonitorDataPaginator(request); for (software.amazon.awssdk.services.rum.model.GetAppMonitorDataResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rum.paginators.GetAppMonitorDataIterable responses = client.getAppMonitorDataPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getAppMonitorData(software.amazon.awssdk.services.rum.model.GetAppMonitorDataRequest)
operation.
This is a convenience which creates an instance of the
GetAppMonitorDataRequest.Builder
avoiding the need to create one manually viaGetAppMonitorDataRequest.builder()
- Parameters:
getAppMonitorDataRequest
- AConsumer
that will call methods onGetAppMonitorDataRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAppMonitors
default ListAppMonitorsResponse listAppMonitors(ListAppMonitorsRequest listAppMonitorsRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, RumException 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.
- See Also:
-
listAppMonitors
default ListAppMonitorsResponse listAppMonitors(Consumer<ListAppMonitorsRequest.Builder> listAppMonitorsRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, RumException Returns a list of the Amazon CloudWatch RUM app monitors in the account.
This is a convenience which creates an instance of the
ListAppMonitorsRequest.Builder
avoiding the need to create one manually viaListAppMonitorsRequest.builder()
- Parameters:
listAppMonitorsRequest
- AConsumer
that will call methods onListAppMonitorsRequest.Builder
to create a request.- Returns:
- Result of the ListAppMonitors operation returned by the service.
- See Also:
-
listAppMonitorsPaginator
default ListAppMonitorsIterable listAppMonitorsPaginator(ListAppMonitorsRequest listAppMonitorsRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, RumException This is a variant of
listAppMonitors(software.amazon.awssdk.services.rum.model.ListAppMonitorsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rum.paginators.ListAppMonitorsIterable responses = client.listAppMonitorsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rum.paginators.ListAppMonitorsIterable responses = client.listAppMonitorsPaginator(request); for (software.amazon.awssdk.services.rum.model.ListAppMonitorsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rum.paginators.ListAppMonitorsIterable responses = client.listAppMonitorsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAppMonitors(software.amazon.awssdk.services.rum.model.ListAppMonitorsRequest)
operation.- Parameters:
listAppMonitorsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAppMonitorsPaginator
default ListAppMonitorsIterable listAppMonitorsPaginator(Consumer<ListAppMonitorsRequest.Builder> listAppMonitorsRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, RumException This is a variant of
listAppMonitors(software.amazon.awssdk.services.rum.model.ListAppMonitorsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rum.paginators.ListAppMonitorsIterable responses = client.listAppMonitorsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rum.paginators.ListAppMonitorsIterable responses = client.listAppMonitorsPaginator(request); for (software.amazon.awssdk.services.rum.model.ListAppMonitorsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rum.paginators.ListAppMonitorsIterable responses = client.listAppMonitorsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAppMonitors(software.amazon.awssdk.services.rum.model.ListAppMonitorsRequest)
operation.
This is a convenience which creates an instance of the
ListAppMonitorsRequest.Builder
avoiding the need to create one manually viaListAppMonitorsRequest.builder()
- Parameters:
listAppMonitorsRequest
- AConsumer
that will call methods onListAppMonitorsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listRumMetricsDestinations
default ListRumMetricsDestinationsResponse listRumMetricsDestinations(ListRumMetricsDestinationsRequest listRumMetricsDestinationsRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, RumException 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.
- See Also:
-
listRumMetricsDestinations
default ListRumMetricsDestinationsResponse listRumMetricsDestinations(Consumer<ListRumMetricsDestinationsRequest.Builder> listRumMetricsDestinationsRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, RumException 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.
This is a convenience which creates an instance of the
ListRumMetricsDestinationsRequest.Builder
avoiding the need to create one manually viaListRumMetricsDestinationsRequest.builder()
- Parameters:
listRumMetricsDestinationsRequest
- AConsumer
that will call methods onListRumMetricsDestinationsRequest.Builder
to create a request.- Returns:
- Result of the ListRumMetricsDestinations operation returned by the service.
- See Also:
-
listRumMetricsDestinationsPaginator
default ListRumMetricsDestinationsIterable listRumMetricsDestinationsPaginator(ListRumMetricsDestinationsRequest listRumMetricsDestinationsRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, RumException This is a variant of
listRumMetricsDestinations(software.amazon.awssdk.services.rum.model.ListRumMetricsDestinationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rum.paginators.ListRumMetricsDestinationsIterable responses = client.listRumMetricsDestinationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rum.paginators.ListRumMetricsDestinationsIterable responses = client .listRumMetricsDestinationsPaginator(request); for (software.amazon.awssdk.services.rum.model.ListRumMetricsDestinationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rum.paginators.ListRumMetricsDestinationsIterable responses = client.listRumMetricsDestinationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRumMetricsDestinations(software.amazon.awssdk.services.rum.model.ListRumMetricsDestinationsRequest)
operation.- Parameters:
listRumMetricsDestinationsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listRumMetricsDestinationsPaginator
default ListRumMetricsDestinationsIterable listRumMetricsDestinationsPaginator(Consumer<ListRumMetricsDestinationsRequest.Builder> listRumMetricsDestinationsRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, RumException This is a variant of
listRumMetricsDestinations(software.amazon.awssdk.services.rum.model.ListRumMetricsDestinationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.rum.paginators.ListRumMetricsDestinationsIterable responses = client.listRumMetricsDestinationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.rum.paginators.ListRumMetricsDestinationsIterable responses = client .listRumMetricsDestinationsPaginator(request); for (software.amazon.awssdk.services.rum.model.ListRumMetricsDestinationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.rum.paginators.ListRumMetricsDestinationsIterable responses = client.listRumMetricsDestinationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRumMetricsDestinations(software.amazon.awssdk.services.rum.model.ListRumMetricsDestinationsRequest)
operation.
This is a convenience which creates an instance of the
ListRumMetricsDestinationsRequest.Builder
avoiding the need to create one manually viaListRumMetricsDestinationsRequest.builder()
- Parameters:
listRumMetricsDestinationsRequest
- AConsumer
that will call methods onListRumMetricsDestinationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, RumException Displays the tags associated with a CloudWatch RUM resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, RumException Displays the tags associated with a CloudWatch RUM resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
putRumEvents
default PutRumEventsResponse putRumEvents(PutRumEventsRequest putRumEventsRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, RumException 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.
- See Also:
-
putRumEvents
default PutRumEventsResponse putRumEvents(Consumer<PutRumEventsRequest.Builder> putRumEventsRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, RumException 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.
This is a convenience which creates an instance of the
PutRumEventsRequest.Builder
avoiding the need to create one manually viaPutRumEventsRequest.builder()
- Parameters:
putRumEventsRequest
- AConsumer
that will call methods onPutRumEventsRequest.Builder
to create a request.- Returns:
- Result of the PutRumEvents operation returned by the service.
- See Also:
-
putRumMetricsDestination
default PutRumMetricsDestinationResponse putRumMetricsDestination(PutRumMetricsDestinationRequest putRumMetricsDestinationRequest) throws ConflictException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, RumException 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.
- See Also:
-
putRumMetricsDestination
default PutRumMetricsDestinationResponse putRumMetricsDestination(Consumer<PutRumMetricsDestinationRequest.Builder> putRumMetricsDestinationRequest) throws ConflictException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, RumException 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.
This is a convenience which creates an instance of the
PutRumMetricsDestinationRequest.Builder
avoiding the need to create one manually viaPutRumMetricsDestinationRequest.builder()
- Parameters:
putRumMetricsDestinationRequest
- AConsumer
that will call methods onPutRumMetricsDestinationRequest.Builder
to create a request.- Returns:
- Result of the PutRumMetricsDestination operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, RumException 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.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, RumException 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.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, RumException Removes one or more tags from the specified resource.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, RumException Removes one or more tags from the specified resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateAppMonitor
default UpdateAppMonitorResponse updateAppMonitor(UpdateAppMonitorRequest updateAppMonitorRequest) throws ConflictException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, RumException 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.
- See Also:
-
updateAppMonitor
default UpdateAppMonitorResponse updateAppMonitor(Consumer<UpdateAppMonitorRequest.Builder> updateAppMonitorRequest) throws ConflictException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, RumException 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?
This is a convenience which creates an instance of the
UpdateAppMonitorRequest.Builder
avoiding the need to create one manually viaUpdateAppMonitorRequest.builder()
- Parameters:
updateAppMonitorRequest
- AConsumer
that will call methods onUpdateAppMonitorRequest.Builder
to create a request.- Returns:
- Result of the UpdateAppMonitor operation returned by the service.
- See Also:
-
updateRumMetricDefinition
default UpdateRumMetricDefinitionResponse updateRumMetricDefinition(UpdateRumMetricDefinitionRequest updateRumMetricDefinitionRequest) throws ConflictException, ServiceQuotaExceededException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, RumException 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.
- See Also:
-
updateRumMetricDefinition
default UpdateRumMetricDefinitionResponse updateRumMetricDefinition(Consumer<UpdateRumMetricDefinitionRequest.Builder> updateRumMetricDefinitionRequest) throws ConflictException, ServiceQuotaExceededException, ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, RumException Modifies one existing metric definition for CloudWatch RUM extended metrics. For more information about extended metrics, see BatchCreateRumMetricsDefinitions.
This is a convenience which creates an instance of the
UpdateRumMetricDefinitionRequest.Builder
avoiding the need to create one manually viaUpdateRumMetricDefinitionRequest.builder()
- Parameters:
updateRumMetricDefinitionRequest
- AConsumer
that will call methods onUpdateRumMetricDefinitionRequest.Builder
to create a request.- Returns:
- Result of the UpdateRumMetricDefinition operation returned by the service.
- See Also:
-
create
Create aRumClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aRumClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-