Interface RumAsyncClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
some cases such as credentials retrieval and endpoint discovery as part of the async API call.
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
FieldsModifier and TypeFieldDescriptionstatic final StringValue 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 RumAsyncClientBuilderbuilder()Create a builder that can be used to configure and create aRumAsyncClient.static RumAsyncClientcreate()Create aRumAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.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.createAppMonitor(CreateAppMonitorRequest createAppMonitorRequest) Creates a Amazon CloudWatch RUM app monitor, which collects telemetry data from your application and sends that data to RUM.deleteAppMonitor(Consumer<DeleteAppMonitorRequest.Builder> deleteAppMonitorRequest) Deletes an existing app monitor.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 CompletableFuture<GetAppMonitorResponse> getAppMonitor(Consumer<GetAppMonitorRequest.Builder> getAppMonitorRequest) Retrieves the complete configuration information for one app monitor.default CompletableFuture<GetAppMonitorResponse> getAppMonitor(GetAppMonitorRequest getAppMonitorRequest) Retrieves the complete configuration information for one app monitor.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.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 GetAppMonitorDataPublishergetAppMonitorDataPaginator(Consumer<GetAppMonitorDataRequest.Builder> getAppMonitorDataRequest) This is a variant ofgetAppMonitorData(software.amazon.awssdk.services.rum.model.GetAppMonitorDataRequest)operation.default GetAppMonitorDataPublishergetAppMonitorDataPaginator(GetAppMonitorDataRequest getAppMonitorDataRequest) This is a variant ofgetAppMonitorData(software.amazon.awssdk.services.rum.model.GetAppMonitorDataRequest)operation.default CompletableFuture<ListAppMonitorsResponse> listAppMonitors(Consumer<ListAppMonitorsRequest.Builder> listAppMonitorsRequest) Returns a list of the Amazon CloudWatch RUM app monitors in the account.default CompletableFuture<ListAppMonitorsResponse> listAppMonitors(ListAppMonitorsRequest listAppMonitorsRequest) Returns a list of the Amazon CloudWatch RUM app monitors in the account.default ListAppMonitorsPublisherlistAppMonitorsPaginator(Consumer<ListAppMonitorsRequest.Builder> listAppMonitorsRequest) This is a variant oflistAppMonitors(software.amazon.awssdk.services.rum.model.ListAppMonitorsRequest)operation.default ListAppMonitorsPublisherlistAppMonitorsPaginator(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.listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Displays the tags associated with a CloudWatch RUM resource.listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Displays the tags associated with a CloudWatch RUM resource.default CompletableFuture<PutRumEventsResponse> putRumEvents(Consumer<PutRumEventsRequest.Builder> putRumEventsRequest) Sends telemetry events about your application performance and user behavior to CloudWatch RUM.default CompletableFuture<PutRumEventsResponse> putRumEvents(PutRumEventsRequest putRumEventsRequest) Sends telemetry events about your application performance and user behavior to CloudWatch RUM.putRumMetricsDestination(Consumer<PutRumMetricsDestinationRequest.Builder> putRumMetricsDestinationRequest) Creates or updates a destination to receive extended metrics from CloudWatch RUM.putRumMetricsDestination(PutRumMetricsDestinationRequest putRumMetricsDestinationRequest) Creates or updates a destination to receive extended metrics from CloudWatch RUM.default RumServiceClientConfigurationThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Assigns one or more tags (key-value pairs) to the specified CloudWatch RUM resource.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest) Assigns one or more tags (key-value pairs) to the specified CloudWatch RUM resource.default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes one or more tags from the specified resource.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes one or more tags from the specified resource.updateAppMonitor(Consumer<UpdateAppMonitorRequest.Builder> updateAppMonitorRequest) Updates the configuration of an existing app monitor.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
closeMethods 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 CompletableFuture<BatchCreateRumMetricDefinitionsResponse> 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, 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/RUMnamespace. 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
BatchCreateRumMetricDefinitionsoperation 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
BatchCreateRumMetricDefinitionsoperations are not valid, those metric definitions fail and return errors, but all valid metric definitions in the same operation still succeed.- Parameters:
batchCreateRumMetricDefinitionsRequest-- Returns:
- A Java Future containing the result of the BatchCreateRumMetricDefinitions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
batchCreateRumMetricDefinitions
default CompletableFuture<BatchCreateRumMetricDefinitionsResponse> batchCreateRumMetricDefinitions(Consumer<BatchCreateRumMetricDefinitionsRequest.Builder> 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, 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/RUMnamespace. 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
BatchCreateRumMetricDefinitionsoperation 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
BatchCreateRumMetricDefinitionsoperations 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.Builderavoiding the need to create one manually viaBatchCreateRumMetricDefinitionsRequest.builder()- Parameters:
batchCreateRumMetricDefinitionsRequest- AConsumerthat will call methods onBatchCreateRumMetricDefinitionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the BatchCreateRumMetricDefinitions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
batchDeleteRumMetricDefinitions
default CompletableFuture<BatchDeleteRumMetricDefinitionsResponse> batchDeleteRumMetricDefinitions(BatchDeleteRumMetricDefinitionsRequest batchDeleteRumMetricDefinitionsRequest) Removes the specified metrics from being sent to an extended metrics destination.
If some metric definition IDs specified in a
BatchDeleteRumMetricDefinitionsoperations 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
BatchDeleteRumMetricDefinitionsoperation is 200.- Parameters:
batchDeleteRumMetricDefinitionsRequest-- Returns:
- A Java Future containing the result of the BatchDeleteRumMetricDefinitions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchDeleteRumMetricDefinitions
default CompletableFuture<BatchDeleteRumMetricDefinitionsResponse> batchDeleteRumMetricDefinitions(Consumer<BatchDeleteRumMetricDefinitionsRequest.Builder> batchDeleteRumMetricDefinitionsRequest) Removes the specified metrics from being sent to an extended metrics destination.
If some metric definition IDs specified in a
BatchDeleteRumMetricDefinitionsoperations 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
BatchDeleteRumMetricDefinitionsoperation is 200.
This is a convenience which creates an instance of the
BatchDeleteRumMetricDefinitionsRequest.Builderavoiding the need to create one manually viaBatchDeleteRumMetricDefinitionsRequest.builder()- Parameters:
batchDeleteRumMetricDefinitionsRequest- AConsumerthat will call methods onBatchDeleteRumMetricDefinitionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the BatchDeleteRumMetricDefinitions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchGetRumMetricDefinitions
default CompletableFuture<BatchGetRumMetricDefinitionsResponse> batchGetRumMetricDefinitions(BatchGetRumMetricDefinitionsRequest batchGetRumMetricDefinitionsRequest) Retrieves the list of metrics and dimensions that a RUM app monitor is sending to a single destination.
- Parameters:
batchGetRumMetricDefinitionsRequest-- Returns:
- A Java Future containing the result of the BatchGetRumMetricDefinitions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchGetRumMetricDefinitions
default CompletableFuture<BatchGetRumMetricDefinitionsResponse> batchGetRumMetricDefinitions(Consumer<BatchGetRumMetricDefinitionsRequest.Builder> batchGetRumMetricDefinitionsRequest) 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.Builderavoiding the need to create one manually viaBatchGetRumMetricDefinitionsRequest.builder()- Parameters:
batchGetRumMetricDefinitionsRequest- AConsumerthat will call methods onBatchGetRumMetricDefinitionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the BatchGetRumMetricDefinitions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchGetRumMetricDefinitionsPaginator
default BatchGetRumMetricDefinitionsPublisher batchGetRumMetricDefinitionsPaginator(BatchGetRumMetricDefinitionsRequest batchGetRumMetricDefinitionsRequest) This is a variant of
batchGetRumMetricDefinitions(software.amazon.awssdk.services.rum.model.BatchGetRumMetricDefinitionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.rum.paginators.BatchGetRumMetricDefinitionsPublisher publisher = client.batchGetRumMetricDefinitionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.rum.paginators.BatchGetRumMetricDefinitionsPublisher publisher = client.batchGetRumMetricDefinitionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rum.model.BatchGetRumMetricDefinitionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rum.model.BatchGetRumMetricDefinitionsResponse response) { //... }; });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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchGetRumMetricDefinitionsPaginator
default BatchGetRumMetricDefinitionsPublisher batchGetRumMetricDefinitionsPaginator(Consumer<BatchGetRumMetricDefinitionsRequest.Builder> batchGetRumMetricDefinitionsRequest) This is a variant of
batchGetRumMetricDefinitions(software.amazon.awssdk.services.rum.model.BatchGetRumMetricDefinitionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.rum.paginators.BatchGetRumMetricDefinitionsPublisher publisher = client.batchGetRumMetricDefinitionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.rum.paginators.BatchGetRumMetricDefinitionsPublisher publisher = client.batchGetRumMetricDefinitionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rum.model.BatchGetRumMetricDefinitionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rum.model.BatchGetRumMetricDefinitionsResponse response) { //... }; });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.Builderavoiding the need to create one manually viaBatchGetRumMetricDefinitionsRequest.builder()- Parameters:
batchGetRumMetricDefinitionsRequest- AConsumerthat will call methods onBatchGetRumMetricDefinitionsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAppMonitor
default CompletableFuture<CreateAppMonitorResponse> 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:
- A Java Future containing the result of the CreateAppMonitor operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAppMonitor
default CompletableFuture<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. 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.Builderavoiding the need to create one manually viaCreateAppMonitorRequest.builder()- Parameters:
createAppMonitorRequest- AConsumerthat will call methods onCreateAppMonitorRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateAppMonitor operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAppMonitor
default CompletableFuture<DeleteAppMonitorResponse> deleteAppMonitor(DeleteAppMonitorRequest deleteAppMonitorRequest) Deletes an existing app monitor. This immediately stops the collection of data.
- Parameters:
deleteAppMonitorRequest-- Returns:
- A Java Future containing the result of the DeleteAppMonitor operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAppMonitor
default CompletableFuture<DeleteAppMonitorResponse> deleteAppMonitor(Consumer<DeleteAppMonitorRequest.Builder> deleteAppMonitorRequest) Deletes an existing app monitor. This immediately stops the collection of data.
This is a convenience which creates an instance of the
DeleteAppMonitorRequest.Builderavoiding the need to create one manually viaDeleteAppMonitorRequest.builder()- Parameters:
deleteAppMonitorRequest- AConsumerthat will call methods onDeleteAppMonitorRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteAppMonitor operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRumMetricsDestination
default CompletableFuture<DeleteRumMetricsDestinationResponse> 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:
- A Java Future containing the result of the DeleteRumMetricsDestination operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRumMetricsDestination
default CompletableFuture<DeleteRumMetricsDestinationResponse> 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.
This is a convenience which creates an instance of the
DeleteRumMetricsDestinationRequest.Builderavoiding the need to create one manually viaDeleteRumMetricsDestinationRequest.builder()- Parameters:
deleteRumMetricsDestinationRequest- AConsumerthat will call methods onDeleteRumMetricsDestinationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteRumMetricsDestination operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAppMonitor
default CompletableFuture<GetAppMonitorResponse> getAppMonitor(GetAppMonitorRequest getAppMonitorRequest) Retrieves the complete configuration information for one app monitor.
- Parameters:
getAppMonitorRequest-- Returns:
- A Java Future containing the result of the GetAppMonitor operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAppMonitor
default CompletableFuture<GetAppMonitorResponse> getAppMonitor(Consumer<GetAppMonitorRequest.Builder> getAppMonitorRequest) Retrieves the complete configuration information for one app monitor.
This is a convenience which creates an instance of the
GetAppMonitorRequest.Builderavoiding the need to create one manually viaGetAppMonitorRequest.builder()- Parameters:
getAppMonitorRequest- AConsumerthat will call methods onGetAppMonitorRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetAppMonitor operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAppMonitorData
default CompletableFuture<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.
- Parameters:
getAppMonitorDataRequest-- Returns:
- A Java Future containing the result of the GetAppMonitorData operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAppMonitorData
default CompletableFuture<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.
This is a convenience which creates an instance of the
GetAppMonitorDataRequest.Builderavoiding the need to create one manually viaGetAppMonitorDataRequest.builder()- Parameters:
getAppMonitorDataRequest- AConsumerthat will call methods onGetAppMonitorDataRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetAppMonitorData operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAppMonitorDataPaginator
default GetAppMonitorDataPublisher getAppMonitorDataPaginator(GetAppMonitorDataRequest getAppMonitorDataRequest) This is a variant of
getAppMonitorData(software.amazon.awssdk.services.rum.model.GetAppMonitorDataRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.rum.paginators.GetAppMonitorDataPublisher publisher = client.getAppMonitorDataPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.rum.paginators.GetAppMonitorDataPublisher publisher = client.getAppMonitorDataPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rum.model.GetAppMonitorDataResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rum.model.GetAppMonitorDataResponse response) { //... }; });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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAppMonitorDataPaginator
default GetAppMonitorDataPublisher getAppMonitorDataPaginator(Consumer<GetAppMonitorDataRequest.Builder> getAppMonitorDataRequest) This is a variant of
getAppMonitorData(software.amazon.awssdk.services.rum.model.GetAppMonitorDataRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.rum.paginators.GetAppMonitorDataPublisher publisher = client.getAppMonitorDataPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.rum.paginators.GetAppMonitorDataPublisher publisher = client.getAppMonitorDataPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rum.model.GetAppMonitorDataResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rum.model.GetAppMonitorDataResponse response) { //... }; });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.Builderavoiding the need to create one manually viaGetAppMonitorDataRequest.builder()- Parameters:
getAppMonitorDataRequest- AConsumerthat will call methods onGetAppMonitorDataRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAppMonitors
default CompletableFuture<ListAppMonitorsResponse> listAppMonitors(ListAppMonitorsRequest listAppMonitorsRequest) Returns a list of the Amazon CloudWatch RUM app monitors in the account.
- Parameters:
listAppMonitorsRequest-- Returns:
- A Java Future containing the result of the ListAppMonitors operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAppMonitors
default CompletableFuture<ListAppMonitorsResponse> listAppMonitors(Consumer<ListAppMonitorsRequest.Builder> listAppMonitorsRequest) Returns a list of the Amazon CloudWatch RUM app monitors in the account.
This is a convenience which creates an instance of the
ListAppMonitorsRequest.Builderavoiding the need to create one manually viaListAppMonitorsRequest.builder()- Parameters:
listAppMonitorsRequest- AConsumerthat will call methods onListAppMonitorsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListAppMonitors operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAppMonitorsPaginator
default ListAppMonitorsPublisher listAppMonitorsPaginator(ListAppMonitorsRequest listAppMonitorsRequest) This is a variant of
listAppMonitors(software.amazon.awssdk.services.rum.model.ListAppMonitorsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.rum.paginators.ListAppMonitorsPublisher publisher = client.listAppMonitorsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.rum.paginators.ListAppMonitorsPublisher publisher = client.listAppMonitorsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rum.model.ListAppMonitorsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rum.model.ListAppMonitorsResponse response) { //... }; });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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAppMonitorsPaginator
default ListAppMonitorsPublisher listAppMonitorsPaginator(Consumer<ListAppMonitorsRequest.Builder> listAppMonitorsRequest) This is a variant of
listAppMonitors(software.amazon.awssdk.services.rum.model.ListAppMonitorsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.rum.paginators.ListAppMonitorsPublisher publisher = client.listAppMonitorsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.rum.paginators.ListAppMonitorsPublisher publisher = client.listAppMonitorsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rum.model.ListAppMonitorsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rum.model.ListAppMonitorsResponse response) { //... }; });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.Builderavoiding the need to create one manually viaListAppMonitorsRequest.builder()- Parameters:
listAppMonitorsRequest- AConsumerthat will call methods onListAppMonitorsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRumMetricsDestinations
default CompletableFuture<ListRumMetricsDestinationsResponse> 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:
- A Java Future containing the result of the ListRumMetricsDestinations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRumMetricsDestinations
default CompletableFuture<ListRumMetricsDestinationsResponse> listRumMetricsDestinations(Consumer<ListRumMetricsDestinationsRequest.Builder> 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.
This is a convenience which creates an instance of the
ListRumMetricsDestinationsRequest.Builderavoiding the need to create one manually viaListRumMetricsDestinationsRequest.builder()- Parameters:
listRumMetricsDestinationsRequest- AConsumerthat will call methods onListRumMetricsDestinationsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListRumMetricsDestinations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRumMetricsDestinationsPaginator
default ListRumMetricsDestinationsPublisher listRumMetricsDestinationsPaginator(ListRumMetricsDestinationsRequest listRumMetricsDestinationsRequest) This is a variant of
listRumMetricsDestinations(software.amazon.awssdk.services.rum.model.ListRumMetricsDestinationsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.rum.paginators.ListRumMetricsDestinationsPublisher publisher = client.listRumMetricsDestinationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.rum.paginators.ListRumMetricsDestinationsPublisher publisher = client.listRumMetricsDestinationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rum.model.ListRumMetricsDestinationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rum.model.ListRumMetricsDestinationsResponse response) { //... }; });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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRumMetricsDestinationsPaginator
default ListRumMetricsDestinationsPublisher listRumMetricsDestinationsPaginator(Consumer<ListRumMetricsDestinationsRequest.Builder> listRumMetricsDestinationsRequest) This is a variant of
listRumMetricsDestinations(software.amazon.awssdk.services.rum.model.ListRumMetricsDestinationsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.rum.paginators.ListRumMetricsDestinationsPublisher publisher = client.listRumMetricsDestinationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.rum.paginators.ListRumMetricsDestinationsPublisher publisher = client.listRumMetricsDestinationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rum.model.ListRumMetricsDestinationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rum.model.ListRumMetricsDestinationsResponse response) { //... }; });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.Builderavoiding the need to create one manually viaListRumMetricsDestinationsRequest.builder()- Parameters:
listRumMetricsDestinationsRequest- AConsumerthat will call methods onListRumMetricsDestinationsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Displays the tags associated with a CloudWatch RUM resource.
- Parameters:
listTagsForResourceRequest-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException Resource not found.
- InternalServerException Internal service exception.
- ValidationException One of the arguments for the request is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Displays the tags associated with a CloudWatch RUM resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException Resource not found.
- InternalServerException Internal service exception.
- ValidationException One of the arguments for the request is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putRumEvents
default CompletableFuture<PutRumEventsResponse> 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
PutRumEventsoperations to send this data to RUM.Each
PutRumEventsoperation can send a batch of events from one user session.- Parameters:
putRumEventsRequest-- Returns:
- A Java Future containing the result of the PutRumEvents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putRumEvents
default CompletableFuture<PutRumEventsResponse> putRumEvents(Consumer<PutRumEventsRequest.Builder> 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
PutRumEventsoperations to send this data to RUM.Each
PutRumEventsoperation can send a batch of events from one user session.
This is a convenience which creates an instance of the
PutRumEventsRequest.Builderavoiding the need to create one manually viaPutRumEventsRequest.builder()- Parameters:
putRumEventsRequest- AConsumerthat will call methods onPutRumEventsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the PutRumEvents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putRumMetricsDestination
default CompletableFuture<PutRumMetricsDestinationResponse> 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:
- A Java Future containing the result of the PutRumMetricsDestination operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putRumMetricsDestination
default CompletableFuture<PutRumMetricsDestinationResponse> putRumMetricsDestination(Consumer<PutRumMetricsDestinationRequest.Builder> 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.
This is a convenience which creates an instance of the
PutRumMetricsDestinationRequest.Builderavoiding the need to create one manually viaPutRumMetricsDestinationRequest.builder()- Parameters:
putRumMetricsDestinationRequest- AConsumerthat will call methods onPutRumMetricsDestinationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the PutRumMetricsDestination operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
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
TagResourceaction 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:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException Resource not found.
- InternalServerException Internal service exception.
- ValidationException One of the arguments for the request is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> 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
TagResourceaction 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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException Resource not found.
- InternalServerException Internal service exception.
- ValidationException One of the arguments for the request is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes one or more tags from the specified resource.
- Parameters:
untagResourceRequest-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException Resource not found.
- InternalServerException Internal service exception.
- ValidationException One of the arguments for the request is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes one or more tags from the specified resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException Resource not found.
- InternalServerException Internal service exception.
- ValidationException One of the arguments for the request is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAppMonitor
default CompletableFuture<UpdateAppMonitorResponse> 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:
- A Java Future containing the result of the UpdateAppMonitor operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAppMonitor
default CompletableFuture<UpdateAppMonitorResponse> updateAppMonitor(Consumer<UpdateAppMonitorRequest.Builder> 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?
This is a convenience which creates an instance of the
UpdateAppMonitorRequest.Builderavoiding the need to create one manually viaUpdateAppMonitorRequest.builder()- Parameters:
updateAppMonitorRequest- AConsumerthat will call methods onUpdateAppMonitorRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateAppMonitor operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateRumMetricDefinition
default CompletableFuture<UpdateRumMetricDefinitionResponse> updateRumMetricDefinition(UpdateRumMetricDefinitionRequest updateRumMetricDefinitionRequest) Modifies one existing metric definition for CloudWatch RUM extended metrics. For more information about extended metrics, see BatchCreateRumMetricsDefinitions.
- Parameters:
updateRumMetricDefinitionRequest-- Returns:
- A Java Future containing the result of the UpdateRumMetricDefinition operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateRumMetricDefinition
default CompletableFuture<UpdateRumMetricDefinitionResponse> updateRumMetricDefinition(Consumer<UpdateRumMetricDefinitionRequest.Builder> updateRumMetricDefinitionRequest) 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.Builderavoiding the need to create one manually viaUpdateRumMetricDefinitionRequest.builder()- Parameters:
updateRumMetricDefinitionRequest- AConsumerthat will call methods onUpdateRumMetricDefinitionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateRumMetricDefinition operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RumException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-
create
Create aRumAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aRumAsyncClient.
-