You are here:
Event Relay Execution Statuses
You can run, pause, or stop the execution of an event relay. After you change the execution state, it can take several minutes for the new state to take effect. During this time, the event relay displays a transitional status in the UI. After the state change completes, the final status appears.
Transitional Status and Final Status
Because a state change happens asynchronously, changing the event relay state isn’t immediate and can take a short while. When the state change is in progress, the event relays list view and the event relay detail page show a transitional status. The transitional status is a visual indication that the state change is underway. Transitional statuses are available only in the UI and not in the API.
For example, when you change the state of a stopped relay to Run, the status first changes to Starting… before it changes to Running. And when you change the state of a paused relay to Run, the status first changes to Resuming… before it changes to Running. This image shows a transitional status of Starting for one event relay and a final status of Paused, Running, and Stopped for the other event relays.
These are the possible transitional states.
- Starting...
- Resuming...
- Pausing...
- Stopping...
The final statuses are listed in the next section.
Running Status
To start a stopped or paused event relay, set the event relay state to Run.
Paused Status
To pause the event relay and temporarily hold off sending events to Amazon EventBridge, set the event relay state to Pause. When you resume a paused event relay, the relay of events continues from where it left off. Stored events are relayed from the Salesforce event bus starting after the last relayed event, and new events.
When the event relay is paused, its current state information is saved in the EventRelayFeedback Salesforce object. There can be a delay between when you set the state to Pause and when the event relay is paused. In this case, the saved state information corresponds to the state when the event relay was actually paused.
Stopped Status
To stop relaying events from Salesforce to Amazon EventBridge, change the event relay state to Stop. When you start a stopped event relay, new events published to the Salesforce event bus are delivered to Amazon EventBridge. Any events stored in the Salesforce event bus that were received after the relay was stopped and before it was started aren’t sent.
When you stop an event relay, its current state information in EventRelayFeedback is deleted.
Error Status
The system sets the event relay status to Error if it encounters an error when attempting to run the event relay. Errors can be caused by configuration problems or connectivity issues to Amazon EventBridge. You can view the error in Setup or by querying EventRelayFeedback. For a list of error codes, see EventRelayFeedback in the Object Reference for the Salesforce Platform.
The system attempts to recover from the error periodically. When the system recovers from the error, the event relay resumes from where it left off and the status changes to Running or a status you select. In rare occasions, if the system can’t resume from where it left off, it uses the error recovery option to determine from where to relay events. For more information, see Error Recovery Options.
