Interface RumAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface RumAsyncClient extends AwsClient
Service client for accessing CloudWatch RUM asynchronously. This can be created using the static 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 Details

  • 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, and PageId. For more information, see Extended metrics that you can send to CloudWatch and CloudWatch Evidently.

      • Custom metrics are metrics that you define. You can send custom metrics to CloudWatch. CloudWatch Evidently, or both. With custom metrics, you can use any metric name and namespace. To derive the metrics, you can use any custom events, built-in events, custom attributes, or default attributes.

        You can't send custom metrics to the AWS/RUM namespace. You must send custom metrics to a custom namespace that you define. The namespace that you use can't start with AWS/. CloudWatch RUM prepends RUM/CustomMetrics/ to the custom namespace that you define, so the final namespace for your metrics in CloudWatch is RUM/CustomMetrics/your-custom-namespace .

      The maximum number of metric definitions that you can specify in one BatchCreateRumMetricDefinitions operation is 200.

      The maximum number of metric definitions that one destination can contain is 2000.

      Extended metrics sent to CloudWatch and RUM custom metrics are charged as CloudWatch custom metrics. Each combination of additional dimension name and dimension value counts as a custom metric. For more information, see Amazon CloudWatch Pricing.

      You must have already created a destination for the metrics before you send them. For more information, see PutRumMetricsDestination.

      If some metric definitions specified in a BatchCreateRumMetricDefinitions operations are not valid, those metric definitions fail and return errors, but all valid metric definitions in the same operation still succeed.

      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 invoke Throwable.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, and PageId. For more information, see Extended metrics that you can send to CloudWatch and CloudWatch Evidently.

      • Custom metrics are metrics that you define. You can send custom metrics to CloudWatch. CloudWatch Evidently, or both. With custom metrics, you can use any metric name and namespace. To derive the metrics, you can use any custom events, built-in events, custom attributes, or default attributes.

        You can't send custom metrics to the AWS/RUM namespace. You must send custom metrics to a custom namespace that you define. The namespace that you use can't start with AWS/. CloudWatch RUM prepends RUM/CustomMetrics/ to the custom namespace that you define, so the final namespace for your metrics in CloudWatch is RUM/CustomMetrics/your-custom-namespace .

      The maximum number of metric definitions that you can specify in one BatchCreateRumMetricDefinitions operation is 200.

      The maximum number of metric definitions that one destination can contain is 2000.

      Extended metrics sent to CloudWatch and RUM custom metrics are charged as CloudWatch custom metrics. Each combination of additional dimension name and dimension value counts as a custom metric. For more information, see Amazon CloudWatch Pricing.

      You must have already created a destination for the metrics before you send them. For more information, see PutRumMetricsDestination.

      If some metric definitions specified in a BatchCreateRumMetricDefinitions operations are not valid, those metric definitions fail and return errors, but all valid metric definitions in the same operation still succeed.


      This is a convenience which creates an instance of the BatchCreateRumMetricDefinitionsRequest.Builder avoiding the need to create one manually via BatchCreateRumMetricDefinitionsRequest.builder()

      Parameters:
      batchCreateRumMetricDefinitionsRequest - A Consumer that will call methods on BatchCreateRumMetricDefinitionsRequest.Builder to 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 invoke Throwable.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 BatchDeleteRumMetricDefinitions operations are not valid, those metric definitions fail and return errors, but all valid metric definition IDs in the same operation are still deleted.

      The maximum number of metric definitions that you can specify in one BatchDeleteRumMetricDefinitions operation is 200.

      Parameters:
      batchDeleteRumMetricDefinitionsRequest -
      Returns:
      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 invoke Throwable.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 BatchDeleteRumMetricDefinitions operations are not valid, those metric definitions fail and return errors, but all valid metric definition IDs in the same operation are still deleted.

      The maximum number of metric definitions that you can specify in one BatchDeleteRumMetricDefinitions operation is 200.


      This is a convenience which creates an instance of the BatchDeleteRumMetricDefinitionsRequest.Builder avoiding the need to create one manually via BatchDeleteRumMetricDefinitionsRequest.builder()

      Parameters:
      batchDeleteRumMetricDefinitionsRequest - A Consumer that will call methods on BatchDeleteRumMetricDefinitionsRequest.Builder to 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 invoke Throwable.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 invoke Throwable.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.Builder avoiding the need to create one manually via BatchGetRumMetricDefinitionsRequest.builder()

      Parameters:
      batchGetRumMetricDefinitionsRequest - A Consumer that will call methods on BatchGetRumMetricDefinitionsRequest.Builder to 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 invoke Throwable.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 new Subscription i.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 
       
 software.amazon.awssdk.services.rum.paginators.BatchGetRumMetricDefinitionsPublisher publisher = client.batchGetRumMetricDefinitionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 invoke Throwable.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 new Subscription i.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 
       
 software.amazon.awssdk.services.rum.paginators.BatchGetRumMetricDefinitionsPublisher publisher = client.batchGetRumMetricDefinitionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the batchGetRumMetricDefinitions(software.amazon.awssdk.services.rum.model.BatchGetRumMetricDefinitionsRequest) operation.


      This is a convenience which creates an instance of the BatchGetRumMetricDefinitionsRequest.Builder avoiding the need to create one manually via BatchGetRumMetricDefinitionsRequest.builder()

      Parameters:
      batchGetRumMetricDefinitionsRequest - A Consumer that will call methods on BatchGetRumMetricDefinitionsRequest.Builder to 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 invoke Throwable.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 invoke Throwable.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.Builder avoiding the need to create one manually via CreateAppMonitorRequest.builder()

      Parameters:
      createAppMonitorRequest - A Consumer that will call methods on CreateAppMonitorRequest.Builder to 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 invoke Throwable.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 invoke Throwable.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.Builder avoiding the need to create one manually via DeleteAppMonitorRequest.builder()

      Parameters:
      deleteAppMonitorRequest - A Consumer that will call methods on DeleteAppMonitorRequest.Builder to 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 invoke Throwable.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:

    • deleteResourcePolicy

      default CompletableFuture<DeleteResourcePolicyResponse> deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)

      Removes the association of a resource-based policy from an app monitor.

      Parameters:
      deleteResourcePolicyRequest -
      Returns:
      A Java Future containing the result of the DeleteResourcePolicy 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidPolicyRevisionIdException The policy revision ID that you provided doeesn't match the latest policy revision ID.
      • ConflictException This operation attempted to create a resource that already exists.
      • ResourceNotFoundException Resource not found.
      • InternalServerException Internal service exception.
      • PolicyNotFoundException The resource-based policy doesn't exist on this app monitor.
      • 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:

    • deleteResourcePolicy

      default CompletableFuture<DeleteResourcePolicyResponse> deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest)

      Removes the association of a resource-based policy from an app monitor.


      This is a convenience which creates an instance of the DeleteResourcePolicyRequest.Builder avoiding the need to create one manually via DeleteResourcePolicyRequest.builder()

      Parameters:
      deleteResourcePolicyRequest - A Consumer that will call methods on DeleteResourcePolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteResourcePolicy 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidPolicyRevisionIdException The policy revision ID that you provided doeesn't match the latest policy revision ID.
      • ConflictException This operation attempted to create a resource that already exists.
      • ResourceNotFoundException Resource not found.
      • InternalServerException Internal service exception.
      • PolicyNotFoundException The resource-based policy doesn't exist on this app monitor.
      • 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 invoke Throwable.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.Builder avoiding the need to create one manually via DeleteRumMetricsDestinationRequest.builder()

      Parameters:
      deleteRumMetricsDestinationRequest - A Consumer that will call methods on DeleteRumMetricsDestinationRequest.Builder to 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 invoke Throwable.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 invoke Throwable.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.Builder avoiding the need to create one manually via GetAppMonitorRequest.builder()

      Parameters:
      getAppMonitorRequest - A Consumer that will call methods on GetAppMonitorRequest.Builder to 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 invoke Throwable.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 invoke Throwable.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.Builder avoiding the need to create one manually via GetAppMonitorDataRequest.builder()

      Parameters:
      getAppMonitorDataRequest - A Consumer that will call methods on GetAppMonitorDataRequest.Builder to 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 invoke Throwable.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 new Subscription i.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 
       
 software.amazon.awssdk.services.rum.paginators.GetAppMonitorDataPublisher publisher = client.getAppMonitorDataPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 invoke Throwable.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 new Subscription i.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 
       
 software.amazon.awssdk.services.rum.paginators.GetAppMonitorDataPublisher publisher = client.getAppMonitorDataPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getAppMonitorData(software.amazon.awssdk.services.rum.model.GetAppMonitorDataRequest) operation.


      This is a convenience which creates an instance of the GetAppMonitorDataRequest.Builder avoiding the need to create one manually via GetAppMonitorDataRequest.builder()

      Parameters:
      getAppMonitorDataRequest - A Consumer that will call methods on GetAppMonitorDataRequest.Builder to 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 invoke Throwable.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:

    • getResourcePolicy

      default CompletableFuture<GetResourcePolicyResponse> getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest)

      Use this operation to retrieve information about a resource-based policy that is attached to an app monitor.

      Parameters:
      getResourcePolicyRequest -
      Returns:
      A Java Future containing the result of the GetResourcePolicy 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 invoke Throwable.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.
      • PolicyNotFoundException The resource-based policy doesn't exist on this app monitor.
      • 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:

    • getResourcePolicy

      default CompletableFuture<GetResourcePolicyResponse> getResourcePolicy(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest)

      Use this operation to retrieve information about a resource-based policy that is attached to an app monitor.


      This is a convenience which creates an instance of the GetResourcePolicyRequest.Builder avoiding the need to create one manually via GetResourcePolicyRequest.builder()

      Parameters:
      getResourcePolicyRequest - A Consumer that will call methods on GetResourcePolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetResourcePolicy 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 invoke Throwable.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.
      • PolicyNotFoundException The resource-based policy doesn't exist on this app monitor.
      • 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 invoke Throwable.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.Builder avoiding the need to create one manually via ListAppMonitorsRequest.builder()

      Parameters:
      listAppMonitorsRequest - A Consumer that will call methods on ListAppMonitorsRequest.Builder to 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 invoke Throwable.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 new Subscription i.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 
       
 software.amazon.awssdk.services.rum.paginators.ListAppMonitorsPublisher publisher = client.listAppMonitorsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 invoke Throwable.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 new Subscription i.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 
       
 software.amazon.awssdk.services.rum.paginators.ListAppMonitorsPublisher publisher = client.listAppMonitorsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listAppMonitors(software.amazon.awssdk.services.rum.model.ListAppMonitorsRequest) operation.


      This is a convenience which creates an instance of the ListAppMonitorsRequest.Builder avoiding the need to create one manually via ListAppMonitorsRequest.builder()

      Parameters:
      listAppMonitorsRequest - A Consumer that will call methods on ListAppMonitorsRequest.Builder to 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 invoke Throwable.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 invoke Throwable.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.Builder avoiding the need to create one manually via ListRumMetricsDestinationsRequest.builder()

      Parameters:
      listRumMetricsDestinationsRequest - A Consumer that will call methods on ListRumMetricsDestinationsRequest.Builder to 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 invoke Throwable.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 new Subscription i.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 
       
 software.amazon.awssdk.services.rum.paginators.ListRumMetricsDestinationsPublisher publisher = client.listRumMetricsDestinationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 invoke Throwable.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 new Subscription i.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 
       
 software.amazon.awssdk.services.rum.paginators.ListRumMetricsDestinationsPublisher publisher = client.listRumMetricsDestinationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 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) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listRumMetricsDestinations(software.amazon.awssdk.services.rum.model.ListRumMetricsDestinationsRequest) operation.


      This is a convenience which creates an instance of the ListRumMetricsDestinationsRequest.Builder avoiding the need to create one manually via ListRumMetricsDestinationsRequest.builder()

      Parameters:
      listRumMetricsDestinationsRequest - A Consumer that will call methods on ListRumMetricsDestinationsRequest.Builder to 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 invoke Throwable.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 invoke Throwable.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.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to 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 invoke Throwable.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:

    • putResourcePolicy

      default CompletableFuture<PutResourcePolicyResponse> putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)

      Use this operation to assign a resource-based policy to a CloudWatch RUM app monitor to control access to it. Each app monitor can have one resource-based policy. The maximum size of the policy is 4 KB. To learn more about using resource policies with RUM, see Using resource-based policies with CloudWatch RUM.

      Parameters:
      putResourcePolicyRequest -
      Returns:
      A Java Future containing the result of the PutResourcePolicy 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • PolicySizeLimitExceededException The policy document is too large. The limit is 4 KB.
      • InvalidPolicyRevisionIdException The policy revision ID that you provided doeesn't match the latest policy revision ID.
      • 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.
      • MalformedPolicyDocumentException The policy document that you specified is not formatted correctly.
      • 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:

    • putResourcePolicy

      default CompletableFuture<PutResourcePolicyResponse> putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest)

      Use this operation to assign a resource-based policy to a CloudWatch RUM app monitor to control access to it. Each app monitor can have one resource-based policy. The maximum size of the policy is 4 KB. To learn more about using resource policies with RUM, see Using resource-based policies with CloudWatch RUM.


      This is a convenience which creates an instance of the PutResourcePolicyRequest.Builder avoiding the need to create one manually via PutResourcePolicyRequest.builder()

      Parameters:
      putResourcePolicyRequest - A Consumer that will call methods on PutResourcePolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutResourcePolicy 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • PolicySizeLimitExceededException The policy document is too large. The limit is 4 KB.
      • InvalidPolicyRevisionIdException The policy revision ID that you provided doeesn't match the latest policy revision ID.
      • 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.
      • MalformedPolicyDocumentException The policy document that you specified is not formatted correctly.
      • 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(PutRumEventsRequest putRumEventsRequest)

      Sends telemetry events about your application performance and user behavior to CloudWatch RUM. The code snippet that RUM generates for you to add to your application includes PutRumEvents operations to send this data to RUM.

      Each PutRumEvents operation can send a batch of events from one user session.

      Parameters:
      putRumEventsRequest -
      Returns:
      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 invoke Throwable.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 PutRumEvents operations to send this data to RUM.

      Each PutRumEvents operation can send a batch of events from one user session.


      This is a convenience which creates an instance of the PutRumEventsRequest.Builder avoiding the need to create one manually via PutRumEventsRequest.builder()

      Parameters:
      putRumEventsRequest - A Consumer that will call methods on PutRumEventsRequest.Builder to 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 invoke Throwable.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 invoke Throwable.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.Builder avoiding the need to create one manually via PutRumMetricsDestinationRequest.builder()

      Parameters:
      putRumMetricsDestinationRequest - A Consumer that will call methods on PutRumMetricsDestinationRequest.Builder to 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 invoke Throwable.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

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      Assigns one or more tags (key-value pairs) to the specified CloudWatch RUM resource. Currently, the only resources that can be tagged app monitors.

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

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

      You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

      You can associate as many as 50 tags with a resource.

      For more information, see Tagging Amazon Web Services resources.

      Parameters:
      tagResourceRequest -
      Returns:
      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 invoke Throwable.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 TagResource action with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

      You can associate as many as 50 tags with a resource.

      For more information, see Tagging Amazon Web Services resources.


      This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to 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 invoke Throwable.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 invoke Throwable.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.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to 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 invoke Throwable.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 invoke Throwable.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.Builder avoiding the need to create one manually via UpdateAppMonitorRequest.builder()

      Parameters:
      updateAppMonitorRequest - A Consumer that will call methods on UpdateAppMonitorRequest.Builder to 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 invoke Throwable.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 invoke Throwable.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.Builder avoiding the need to create one manually via UpdateRumMetricDefinitionRequest.builder()

      Parameters:
      updateRumMetricDefinitionRequest - A Consumer that will call methods on UpdateRumMetricDefinitionRequest.Builder to 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 invoke Throwable.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

      default RumServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static RumAsyncClient create()
      Create a RumAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static RumAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a RumAsyncClient.