Skip to content

PutRumEventsRequest

Source code in docs_src/capo_rum/types/put_rum_events_request.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
class PutRumEventsRequest(TypedDict, closed=True):
    id: "capo_rum.types.app_monitor_id.AppMonitorId"
    """<p>The ID of the app monitor that is sending this data.</p>"""
    batch_id: "str"
    """<p>A unique identifier for this batch of RUM event data.</p>"""
    app_monitor_details: "capo_rum.types.app_monitor_details.AppMonitorDetails"
    """<p>A structure that contains information about the app monitor that collected this telemetry information.</p>"""
    user_details: "capo_rum.types.user_details.UserDetails"
    """<p>A structure that contains information about the user session that this batch of events was collected from.</p>"""
    rum_events: "capo_rum.types.rum_event_list.RumEventList"
    """<p>An array of structures that contain the telemetry event data.</p>"""
    alias: NotRequired["capo_rum.types.alias.Alias"]
    """<p>If the app monitor uses a resource-based policy that requires <code>PutRumEvents</code> requests to specify a certain alias, specify that alias here. This alias will be compared to the <code>rum:alias</code> context key in the resource-based policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-resource-policies.html">Using resource-based policies with CloudWatch RUM</a>.</p>"""

alias instance-attribute 

alias: NotRequired[Alias]

If the app monitor uses a resource-based policy that requires PutRumEvents requests to specify a certain alias, specify that alias here. This alias will be compared to the rum:alias context key in the resource-based policy. For more information, see Using resource-based policies with CloudWatch RUM.

app_monitor_details instance-attribute 

app_monitor_details: AppMonitorDetails

A structure that contains information about the app monitor that collected this telemetry information.

batch_id instance-attribute 

batch_id: str

A unique identifier for this batch of RUM event data.

id instance-attribute 

id: AppMonitorId

The ID of the app monitor that is sending this data.

rum_events instance-attribute 

rum_events: RumEventList

An array of structures that contain the telemetry event data.

user_details instance-attribute 

user_details: UserDetails

A structure that contains information about the user session that this batch of events was collected from.