rum/aws.sdk.kotlin.services.rum

Package-level declarations

Types

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

batchCreateRumMetricDefinitions

inline suspend fun RumClient.batchCreateRumMetricDefinitions(crossinline block: BatchCreateRumMetricDefinitionsRequest.Builder.() -> Unit): BatchCreateRumMetricDefinitionsResponse

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.

batchDeleteRumMetricDefinitions

inline suspend fun RumClient.batchDeleteRumMetricDefinitions(crossinline block: BatchDeleteRumMetricDefinitionsRequest.Builder.() -> Unit): BatchDeleteRumMetricDefinitionsResponse

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

batchGetRumMetricDefinitions

inline suspend fun RumClient.batchGetRumMetricDefinitions(crossinline block: BatchGetRumMetricDefinitionsRequest.Builder.() -> Unit): BatchGetRumMetricDefinitionsResponse

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

createAppMonitor

inline suspend fun RumClient.createAppMonitor(crossinline block: CreateAppMonitorRequest.Builder.() -> Unit): CreateAppMonitorResponse

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.

deleteAppMonitor

inline suspend fun RumClient.deleteAppMonitor(crossinline block: DeleteAppMonitorRequest.Builder.() -> Unit): DeleteAppMonitorResponse

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

deleteResourcePolicy

inline suspend fun RumClient.deleteResourcePolicy(crossinline block: DeleteResourcePolicyRequest.Builder.() -> Unit): DeleteResourcePolicyResponse

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

deleteRumMetricsDestination

inline suspend fun RumClient.deleteRumMetricsDestination(crossinline block: DeleteRumMetricsDestinationRequest.Builder.() -> Unit): DeleteRumMetricsDestinationResponse

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

getAppMonitor

inline suspend fun RumClient.getAppMonitor(crossinline block: GetAppMonitorRequest.Builder.() -> Unit): GetAppMonitorResponse

Retrieves the complete configuration information for one app monitor.

getAppMonitorData

inline suspend fun RumClient.getAppMonitorData(crossinline block: GetAppMonitorDataRequest.Builder.() -> Unit): GetAppMonitorDataResponse

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.

getResourcePolicy

inline suspend fun RumClient.getResourcePolicy(crossinline block: GetResourcePolicyRequest.Builder.() -> Unit): GetResourcePolicyResponse

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

listAppMonitors

inline suspend fun RumClient.listAppMonitors(crossinline block: ListAppMonitorsRequest.Builder.() -> Unit): ListAppMonitorsResponse

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

listRumMetricsDestinations

inline suspend fun RumClient.listRumMetricsDestinations(crossinline block: ListRumMetricsDestinationsRequest.Builder.() -> Unit): ListRumMetricsDestinationsResponse

Returns a list of destinations that you have created to receive RUM extended metrics, for the specified app monitor.

listTagsForResource

inline suspend fun RumClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Displays the tags associated with a CloudWatch RUM resource.

putResourcePolicy

inline suspend fun RumClient.putResourcePolicy(crossinline block: PutResourcePolicyRequest.Builder.() -> Unit): PutResourcePolicyResponse

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.

putRumEvents

inline suspend fun RumClient.putRumEvents(crossinline block: PutRumEventsRequest.Builder.() -> Unit): PutRumEventsResponse

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.

putRumMetricsDestination

inline suspend fun RumClient.putRumMetricsDestination(crossinline block: PutRumMetricsDestinationRequest.Builder.() -> Unit): PutRumMetricsDestinationResponse

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.

tagResource

inline suspend fun RumClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

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

untagResource

inline suspend fun RumClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes one or more tags from the specified resource.

updateAppMonitor

inline suspend fun RumClient.updateAppMonitor(crossinline block: UpdateAppMonitorRequest.Builder.() -> Unit): UpdateAppMonitorResponse

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.

updateRumMetricDefinition

inline suspend fun RumClient.updateRumMetricDefinition(crossinline block: UpdateRumMetricDefinitionRequest.Builder.() -> Unit): UpdateRumMetricDefinitionResponse

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

withConfig

fun RumClient.withConfig(block: RumClient.Config.Builder.() -> Unit): RumClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.