AWS documentdb documentation change

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

File: documentdb/latest/developerguide/week.md

Summary

Added documentation for the $week operator in Amazon DocumentDB, including description, MongoDB Shell example, and code examples in Node.js and Python

Security assessment

This change adds documentation for a date/time operator ($week) with standard usage examples. The code examples include TLS connection parameters (tls=true, tlsCAFile=global-bundle.pem) which are standard security practices for DocumentDB connections, but this is not new security documentation - it's just showing standard connection strings. No evidence of addressing a specific security vulnerability or incident.

Diff

diff --git a/documentdb/latest/developerguide/week.md b/documentdb/latest/developerguide/week.md
index 8b1378917..80521f8ab 100644
--- a//documentdb/latest/developerguide/week.md
+++ b//documentdb/latest/developerguide/week.md
@@ -0,0 +1 @@
+[](/pdfs/documentdb/latest/developerguide/developerguide.pdf#week "Open PDF")
@@ -1,0 +3,117 @@
+[Documentation](/index.html)[Amazon DocumentDB](/documentdb/index.html)[Developer Guide](what-is.html)
+
+Example (MongoDB Shell)Code examples
+
+# $week
+
+The `$week` operator in Amazon DocumentDB returns the week number of a date (0-53) based on the ISO 8601 standard. The week number is calculated based on the year and the day of the week, with Monday as the first day of the week.
+
+**Parameters**
+
+None
+
+## Example (MongoDB Shell)
+
+The following example demonstrates how to use the `$week` operator to retrieve the week number of a given date.
+
+**Create sample documents**
+    
+    
+    db.events.insertMany([
+      { _id: 1, date: new Date("2023-01-01") },
+      { _id: 2, date: new Date("2023-01-08") },
+      { _id: 3, date: new Date("2023-12-31") }
+    ]);
+
+**Query example**
+    
+    
+    db.events.aggregate([
+      { $project: {
+        _id: 1,
+        week: { $week: "$date" }
+      }}
+    ]);
+
+**Output**
+    
+    
+    [
+      { "_id": 1, "week": 1 },
+      { "_id": 2, "week": 2 },
+      { "_id": 3, "week": 53 }
+    ]
+
+## Code examples
+
+To view a code example for using the `$week` command, choose the tab for the language that you want to use:
+
+Node.js
+    
+    
+    
+    const { MongoClient } = require('mongodb');
+    
+    async function example() {
+      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 events = db.collection('events');
+    
+      const result = await events.aggregate([
+        { $project: {
+          _id: 1,
+          week: { $week: "$date" }
+        }}
+      ]).toArray();
+    
+      console.log(result);
+      await client.close();
+    }
+    
+    example();
+
+Python
+    
+    
+    
+    from pymongo import MongoClient
+    
+    def example():
+      client = MongoClient('mongodb://<username>:<password>@<cluster-endpoint>:27017/?tls=true&tlsCAFile=global-bundle.pem&replicaSet=rs0&readPreference=secondaryPreferred&retryWrites=false')
+      db = client['test']
+      events = db['events']
+    
+      result = list(events.aggregate([
+          {'$project': {
+              '_id': 1,
+              'week': {'$week': '$date'}
+          }}
+      ]))
+    
+      print(result)
+    
+      client.close()
+    
+    example()
+
+![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)
+
+$vectorSearch
+
+$year
+
+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.