AWS documentdb documentation change

Service: documentdb · 2026-03-31 · Documentation low

File: documentdb/latest/developerguide/jsonSchema.md

Summary

Added new documentation page for the $jsonSchema operator in Amazon DocumentDB, including overview, parameters, MongoDB Shell example, and code examples in Node.js and Python

Security assessment

This change adds documentation for the $jsonSchema operator which enables JSON schema validation for documents. While not directly addressing a specific security vulnerability, schema validation is a security best practice that helps enforce data structure and type constraints, preventing malformed or unexpected data from being inserted. The code examples include TLS connections with CA certificates (tls=true&tlsCAFile=global-bundle.pem), demonstrating secure connection practices. However, there is no evidence this addresses a specific security incident or vulnerability.

Diff

diff --git a/documentdb/latest/developerguide/jsonSchema.md b/documentdb/latest/developerguide/jsonSchema.md
index 8b1378917..4b0c17bdc 100644
--- a//documentdb/latest/developerguide/jsonSchema.md
+++ b//documentdb/latest/developerguide/jsonSchema.md
@@ -0,0 +1 @@
+[](/pdfs/documentdb/latest/developerguide/developerguide.pdf#jsonSchema "Open PDF")
@@ -1,0 +3,134 @@
+[Documentation](/index.html)[Amazon DocumentDB](/documentdb/index.html)[Developer Guide](what-is.html)
+
+Example (MongoDB Shell)Code examples
+
+# $jsonSchema
+
+New from version 4.0.
+
+Not supported by Elastic cluster.
+
+The `$jsonSchema` operator in Amazon DocumentDB is used to filter documents based on a specified JSON schema. This operator allows you to query documents that match a particular JSON schema, ensuring that the retrieved documents adhere to specific structural and data type requirements.
+
+Using the `$jsonSchema` evaluation query operator as part of a collection creation, you can validate the schema of the documents being inserted into the collection. See [Using JSON schema validation](./json-schema-validation.html) for additional information.
+
+**Parameters**
+
+  * `required` (array): Specifies the required fields in the document.
+
+  * `properties` (object): Defines the data type and other constraints for each field in the document.
+
+
+
+
+## Example (MongoDB Shell)
+
+The following example demonstrates the use of the `$jsonSchema` operator to filter the `employees` collection to only retrieve documents that have the `name`, `employeeId` and `age` fields, and the `employeeId` field is of type `string`.
+
+**Create sample documents**
+    
+    
+    db.employees.insertMany([
+      { "name": { "firstName": "Carol", "lastName": "Smith" }, "employeeId": "1" },
+      { "name": { "firstName": "Emily", "lastName": "Brown" }, "employeeId": "2", "age": 25 },
+      { "name": { "firstName": "William", "lastName": "Taylor" }, "employeeId": 3, "age": 24 },
+      { "name": { "firstName": "Jane", "lastName": "Doe" }, "employeeId": "4" }
+    ]);
+
+**Query example**
+    
+    
+    db.employees.aggregate([
+      { $match: {
+        $jsonSchema: {
+          required: ["name", "employeeId", "age"],
+          properties: { "employeeId": { "bsonType": "string" } }
+        }
+      }}
+    ]);
+
+**Output**
+    
+    
+    { "_id" : ObjectId("6908e8b61f77fc26b2ecd26f"), "name" : { "firstName" : "Emily", "lastName" : "Brown" }, "employeeId" : "2", "age" : 25 }
+
+## Code examples
+
+To view a code example for using the `$jsonSchema` command, choose the tab for the language that you want to use:
+
+Node.js
+    
+    
+    
+    const { MongoClient } = require('mongodb');
+    
+    async function filterByJsonSchema() {
+      const client = await MongoClient.connect('mongodb://<username>:<password>@<cluster-endpoint>:27017/?tls=true&tlsCAFile=global-bundle.pem&replicaSet=rs0&readPreference=secondaryPreferred&retryWrites=false');
+      const db = client.db('test');
+      const collection = db.collection('employees');
+    
+      const result = await collection.aggregate([
+        {
+          $match: {
+            $jsonSchema: {
+              required: ['name', 'employeeId', 'age'],
+              properties: { 'employeeId': { 'bsonType': 'string' } }
+            }
+          }
+        }
+      ]).toArray();
+    
+      console.log(result);
+      await client.close();
+    }
+    
+    filterByJsonSchema();
+
+Python
+    
+    
+    
+    from pymongo import MongoClient
+    
+    def filter_by_json_schema():
+      client = MongoClient('mongodb://<username>:<password>@<cluster-endpoint>:27017/?tls=true&tlsCAFile=global-bundle.pem&replicaSet=rs0&readPreference=secondaryPreferred&retryWrites=false')
+      db = client['test']
+      collection = db['employees']
+    
+      result = list(collection.aggregate([
+        {
+          '$match': {
+            '$jsonSchema': {
+              'required': ['name', 'employeeId', 'age'],
+              'properties': {'employeeId': {'bsonType': 'string'}}
+            }
+          }
+        }
+      ]))
+    
+      print(result)
+      client.close()
+    
+    filter_by_json_schema()
+
+![Warning](https://d1ge0kk1l5kms0.cloudfront.net/images/G/01/webservices/console/warning.png) **Javascript is disabled or is unavailable in your browser.**
+
+To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.
+
+[Document Conventions](/general/latest/gr/docconventions.html)
+
+$in
+
+$lt
+
+Did this page help you? - Yes
+
+Thanks for letting us know we're doing a good job!
+
+If you've got a moment, please tell us what we did right so we can do more of it.
+
+Did this page help you? - No
+
+Thanks for letting us know this page needs work. We're sorry we let you down.
+
+If you've got a moment, please tell us how we can make the documentation better.