ILiveEventProvider
The data provider object used for replacing the list of live events.
This provider is used to set/replace all the live events to a whole new set of live events.
The new set of live events can be created by calling the add() function multiple times with different lists of live events,
and then when the commit() function is finally called, all previous live events will be replaced with the entire
set of new live events. If the provider object is destroyed before calling commit(), all changes that are queued up will be lost.
Methods
add()
add(liveEvents: ILiveEvent
[]):Promise<IAddLiveEventFailure[]>
Add a list of live events to the commit queue.
This function can be called one or more times to add live event data.
Will skip any live events that fail to be inserted and will continue to try to insert the rest of the
live events provided, the list of failed live events will be returned.
Inserted data will only be committed when the commit() function is called.
Parameters
liveEvents
An array of live event instances to be inserted.
Throws
- IllegalStateError If this function is called after the same
LiveEventProviderhas already returned an error previously in one of its methods. - InternalError If this function encounters an unrecoverable error such as data store connection issues, etc. Provider should be aborted upon receiving this error.
- StorageLimitError if this function encounters an error due to ingested data exceeding the storage limit. Consult with your Amazon contact if you encounter this error.
Returns
Promise<IAddLiveEventFailure[]>
IAddLiveEventFailure[] A list of live events that failed to be added to the commit queue and the error causing the failure.
commit()
commit(version:
string):Promise<void>
Commits any pending operations from this provider object to the data store.
This function should be called once after performing operations on the provider using the other methods in the provider interface.
Parameters
version
string
A string representing the version of the live event lineup that will be in the data store as a result of this commit.
Throws
IllegalStateErrorif this function is called after the Provider has already returned anInternalErrorpreviously.InternalErrorif the data cannot be committed to the data store.
Returns
Promise<void>
Last updated: Jul 22, 2026
