JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
com.amazonaws.services.cloudwatchrum

Interface AWSCloudWatchRUM

  • All Known Subinterfaces:
    AWSCloudWatchRUMAsync
    All Known Implementing Classes:
    AbstractAWSCloudWatchRUM, AbstractAWSCloudWatchRUMAsync, AWSCloudWatchRUMAsyncClient, AWSCloudWatchRUMClient 

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

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

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

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

    • Method Detail

      • batchCreateRumMetricDefinitions

        BatchCreateRumMetricDefinitionsResult batchCreateRumMetricDefinitions(BatchCreateRumMetricDefinitionsRequest batchCreateRumMetricDefinitionsRequest)

        Specifies the extended metrics and custom metrics that you want a CloudWatch RUM app monitor to send to a destination. Valid destinations include CloudWatch and Evidently.

        By default, RUM app monitors send some metrics to CloudWatch. These default metrics are listed in CloudWatch metrics that you can collect with CloudWatch RUM.

        In addition to these default metrics, you can choose to send extended metrics, 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:
        Result of the BatchCreateRumMetricDefinitions operation returned by the service.
        Throws:
        ConflictException - This operation attempted to create a resource that already exists.
        ServiceQuotaExceededException - This request exceeds a service quota.
        ResourceNotFoundException - Resource not found.
        InternalServerException - Internal service exception.
        ValidationException - One of the arguments for the request is not valid.
        ThrottlingException - The request was throttled because of quota limits.
        AccessDeniedException - You don't have sufficient permissions to perform this action.
        See Also:
        AWS API Documentation

      • batchDeleteRumMetricDefinitions

        BatchDeleteRumMetricDefinitionsResult batchDeleteRumMetricDefinitions(BatchDeleteRumMetricDefinitionsRequest batchDeleteRumMetricDefinitionsRequest)

        Removes the specified metrics from being sent to an extended metrics destination.

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

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

        Parameters:
        batchDeleteRumMetricDefinitionsRequest -
        Returns:
        Result of the BatchDeleteRumMetricDefinitions operation returned by the service.
        Throws:
        ConflictException - This operation attempted to create a resource that already exists.
        ResourceNotFoundException - Resource not found.
        InternalServerException - Internal service exception.
        ValidationException - One of the arguments for the request is not valid.
        ThrottlingException - The request was throttled because of quota limits.
        AccessDeniedException - You don't have sufficient permissions to perform this action.
        See Also:
        AWS API Documentation

      • putRumEvents

        PutRumEventsResult putRumEvents(PutRumEventsRequest putRumEventsRequest)

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

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

        Parameters:
        putRumEventsRequest -
        Returns:
        Result of the PutRumEvents operation returned by the service.
        Throws:
        ResourceNotFoundException - Resource not found.
        InternalServerException - Internal service exception.
        ValidationException - One of the arguments for the request is not valid.
        ThrottlingException - The request was throttled because of quota limits.
        AccessDeniedException - You don't have sufficient permissions to perform this action.
        See Also:
        AWS API Documentation

      • tagResource

        TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

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

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

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

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

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

        For more information, see Tagging Amazon Web Services resources.

        Parameters:
        tagResourceRequest -
        Returns:
        Result of the TagResource operation returned by the service.
        Throws:
        ResourceNotFoundException - Resource not found.
        InternalServerException - Internal service exception.
        ValidationException - One of the arguments for the request is not valid.
        See Also:
        AWS API Documentation

      • shutdown

        void shutdown()
        Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

      • getCachedResponseMetadata

        ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
        Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

        Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

        Parameters:
        request - The originally executed request.
        Returns:
        The response metadata for the specified request, or null if none is available.
Skip navigation links

AltStyle によって変換されたページ (->オリジナル) /