CloudWatchRUM / Client / put_rum_events

put_rum_events

CloudWatchRUM.Client.put_rum_events(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.put_rum_events(
    AppMonitorDetails={
        'id': 'string',
        'name': 'string',
        'version': 'string'
    },
    BatchId='string',
    Id='string',
    RumEvents=[
        {
            'details': 'string',
            'id': 'string',
            'metadata': 'string',
            'timestamp': datetime(2015, 1, 1),
            'type': 'string'
        },
    ],
    UserDetails={
        'sessionId': 'string',
        'userId': 'string'
    }
)

Parameters:

• AppMonitorDetails (dict) –

  [REQUIRED]

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

  • id (string) –

    The unique ID of the app monitor.

  • name (string) –

    The name of the app monitor.

  • version (string) –

    The version of the app monitor.

• BatchId (string) –

  [REQUIRED]

  A unique identifier for this batch of RUM event data.

• Id (string) –

  [REQUIRED]

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

• RumEvents (list) –

  [REQUIRED]

  An array of structures that contain the telemetry event data.

  • (dict) –

    A structure that contains the information for one performance event that RUM collects from a user session with your application.

    • details (string) – [REQUIRED]

      A string containing details about the event.

    • id (string) – [REQUIRED]

      A unique ID for this event.

    • metadata (string) –

      Metadata about this event, which contains a JSON serialization of the identity of the user for this session. The user information comes from information such as the HTTP user-agent request header and document interface.

    • timestamp (datetime) – [REQUIRED]

      The exact time that this event occurred.

    • type (string) – [REQUIRED]

      The JSON schema that denotes the type of event this is, such as a page load or a new session.

• UserDetails (dict) –

  [REQUIRED]

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

  • sessionId (string) –

    The session ID that the performance events are from.

  • userId (string) –

    The ID of the user for this user session. This ID is generated by RUM and does not include any personally identifiable information about the user.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

• (dict) –

Exceptions

• CloudWatchRUM.Client.exceptions.ResourceNotFoundException

• CloudWatchRUM.Client.exceptions.InternalServerException

• CloudWatchRUM.Client.exceptions.ValidationException

• CloudWatchRUM.Client.exceptions.ThrottlingException

• CloudWatchRUM.Client.exceptions.AccessDeniedException