RUM

import { RUM } from "https://aws-api.deno.dev/v0.3/services/rum.ts?docs=full";

class RUM {

constructor(apiFactory: client.ApiFactory);

async createAppMonitor(params: CreateAppMonitorRequest, opts?: client.RequestOptions): Promise<CreateAppMonitorResponse>;

async deleteAppMonitor(params: DeleteAppMonitorRequest, opts?: client.RequestOptions): Promise<void>;

async getAppMonitor(params: GetAppMonitorRequest, opts?: client.RequestOptions): Promise<GetAppMonitorResponse>;

async getAppMonitorData(params: GetAppMonitorDataRequest, opts?: client.RequestOptions): Promise<GetAppMonitorDataResponse>;

async listAppMonitors(params?: ListAppMonitorsRequest, opts?: client.RequestOptions): Promise<ListAppMonitorsResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async putRumEvents(params: PutRumEventsRequest, opts?: client.RequestOptions): Promise<void>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateAppMonitor(params: UpdateAppMonitorRequest, opts?: client.RequestOptions): Promise<void>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new RUM(apiFactory: client.ApiFactory)

[src]

§Methods

createAppMonitor(params: CreateAppMonitorRequest, opts?: client.RequestOptions): Promise<CreateAppMonitorResponse>

[src]

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?

deleteAppMonitor(params: DeleteAppMonitorRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

getAppMonitor(params: GetAppMonitorRequest, opts?: client.RequestOptions): Promise<GetAppMonitorResponse>

[src]

Retrieves the complete configuration information for one app monitor.

getAppMonitorData(params: GetAppMonitorDataRequest, opts?: client.RequestOptions): Promise<GetAppMonitorDataResponse>

[src]

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.

listAppMonitors(params?: ListAppMonitorsRequest, opts?: client.RequestOptions): Promise<ListAppMonitorsResponse>

[src]

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

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

Displays the tags associated with a CloudWatch RUM resource.

putRumEvents(params: PutRumEventsRequest, opts?: client.RequestOptions): Promise<void>

[src]

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.

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

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.

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Removes one or more tags from the specified resource.

updateAppMonitor(params: UpdateAppMonitorRequest, opts?: client.RequestOptions): Promise<void>

[src]

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?

§Static Properties

ApiMetadata: client.ApiMetadata

[src]