Tutorial: Listening for Amazon OpenSearch Service EventBridge events - Amazon OpenSearch Service (successor to Amazon Elasticsearch Service)

Tutorial: Listening for Amazon OpenSearch Service EventBridge events

In this tutorial, you set up a simple AWS Lambda function that listens for Amazon OpenSearch Service events and writes them to a CloudWatch Logs log stream.


This tutorial assumes that you have an existing OpenSearch Service domain. If you haven't created a domain, follow the steps in Creating and managing Amazon OpenSearch Service domains to create one.

Step 1: Create the Lambda function

In this procedure, you create a simple Lambda function to serve as a target for OpenSearch Service event messages.

To create a target Lambda function

  1. Open the AWS Lambda console at https://console.aws.amazon.com/lambda/.

  2. Choose Create function and Author from scratch.

  3. For Function name, enter event-handler.

  4. For Runtime, choose Python 3.8.

  5. Choose Create function.

  6. In the Function code section, edit the sample code to match the following example:

    import json def lambda_handler(event, context): if event["source"] != "aws.es": raise ValueError("Function only supports input from events with a source type of: aws.es") print(json.dumps(event))

    This is a simple Python 3.8 function that prints the events sent by OpenSearch Service. If everything is configured correctly, at the end of this tutorial, the event details appear in the CloudWatch Logs log stream that's associated with this Lambda function.

  7. Choose Deploy.

Step 2: Register an event rule

In this step, you create an EventBridge rule that captures events from your OpenSearch Service domains. This rule captures all events within the account where it's defined. The event messages themselves contain information about the event source, including the domain from which it originated. You can use this information to filter and sort events programmatically.

To create an EventBridge rule

  1. Open the EventBridge console at https://console.aws.amazon.com/events/.

  2. Choose Create rule.

  3. Name the rule event-rule.

  4. For Define pattern, choose Event pattern, then choose Custom pattern.

  5. Paste the following event pattern into the text area:

    { "source": ["aws.es"] }

    Press Save after adding the pattern. This pattern applies across all of your OpenSearch Service domains and to every OpenSearch Service event. Alternatively, you can create a more specific pattern to filter out some results.

  6. Leave the target as Lambda function and choose event-handler from the dropdown.

  7. Choose Create.

Step 3: Test your configuration

The next time you receive a notification in the Notifications section of the OpenSearch Service console, if everything is configured properly, your Lambda function is triggered and it writes the event data to a CloudWatch Logs log stream for the function.

To test your configuration

  1. Open the CloudWatch console at https://console.aws.amazon.com/cloudwatch/.

  2. On the navigation pane, choose Logs and select the log group for your Lambda function (for example, /aws/lambda/event-handler).

  3. Select a log stream to view the event data.