Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ClientEvent_Ingestion

We send the Amazon Chime SDK meeting events to the Amazon Chime backend to analyze meeting health trends or identify common failures. This helps to improve your meeting experience.

Sensitive attributes

The Amazon Chime SDK for JavaScript will not send below sensitive attributes to the Amazon Chime backend.

Attribute Description
externalMeetingId The Amazon Chime SDK external meeting ID.
externalUserId The Amazon Chime SDK external user ID that can indicate an identity managed by your application.

Opt out of Event Ingestion

Event ingestion is enabled for clients using AWS SDK v2.934.0 and above. To opt out of event ingestion, provide NoOpEventReporter to DefaultMeetingSession while creating the meeting session.

import {
  ConsoleLogger,
  DefaultDeviceController,
  DefaultMeetingSession,
  LogLevel,
  MeetingSessionConfiguration,
  NoOpEventReporter,
  EventReporter,
  DefaultEventController
} from 'amazon-chime-sdk-js';

const logger = new ConsoleLogger('MyLogger', LogLevel.INFO);
const deviceController = new DefaultDeviceController(logger);

// You need responses from server-side Chime API. See below for details.
const meetingResponse = // The response from the CreateMeeting API action.
const attendeeResponse = // The response from the CreateAttendee or BatchCreateAttendee API action.
const configuration = new MeetingSessionConfiguration(meetingResponse, attendeeResponse);

// Use NoOpEventReporter to opt-out of event ingestion.
const eventReporter = new NoOpEventReporter();

const meetingSession = new DefaultMeetingSession(
  configuration,
  logger,
  deviceController,
  new DefaultEventController(configuration, logger, eventReporter)
);

Give feedback on this guide

Generated using TypeDoc