AWS Amazon DocumentDB with MongoDB compatibility

Name: Amazon DocumentDB with MongoDB compatibility API
Brand: Amazon DocumentDB with MongoDB compatibility
Availability: InStock

Browse all Amazonaws APIs

★ Only Publicly Available OpenAPI DocumentStorageDatabasehmac106 EndpointsREST

For Agents

Provision and operate Amazon DocumentDB clusters and instances, manage snapshots and parameter groups, and control global clusters for MongoDB-compatible workloads.

Use for: Provision a new DocumentDB cluster with three instances, Take a snapshot of an existing DocumentDB cluster, Restore a cluster from a recent snapshot, Modify the parameter group attached to a DocumentDB cluster

Not supported: Does not handle MongoDB query execution, index management, or document-level CRUD - use for DocumentDB cluster and instance lifecycle only.

Jentic publishes the only available OpenAPI specification for Amazon DocumentDB, keeping it validated and agent-ready. Amazon DocumentDB is a managed document database with MongoDB compatibility, designed to run document workloads at scale on AWS. The API covers the full control plane: clusters, instances, parameter groups, snapshots, subnet groups, global clusters, event subscriptions, and pending-maintenance actions. Use it when an agent needs to provision DocumentDB clusters, restore from a snapshot, scale instances, or manage cross-region global clusters without going through the AWS console.

Install Jentic One Beta

Connect the Amazon DocumentDB with MongoDB compatibility to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Amazon DocumentDB with MongoDB compatibility, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Famazonaws.com%2Faws-documentdb" | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Famazonaws.com%2Faws-documentdb" | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Amazon DocumentDB with MongoDB compatibility API.

Provision clusters and primary or replica instances with CreateDBCluster and CreateDBInstance sized for the workload

Snapshot and restore clusters with CreateDBClusterSnapshot, RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime

Manage tunable engine parameters via DBClusterParameterGroup operations and ModifyDBClusterParameterGroup

Operate cross-region global clusters using CreateGlobalCluster, ModifyGlobalCluster, and RemoveFromGlobalCluster

GET STARTED

Start building with Amazon DocumentDB with MongoDB compatibility API

Explore with Jentic One

View OpenAPI Document

Use Cases

Patterns agents use Amazon DocumentDB with MongoDB compatibility API for, with concrete tasks.

★ Provision a Production DocumentDB Cluster

Spin up a multi-AZ DocumentDB cluster with one writer and two reader instances by calling CreateDBCluster, then CreateDBInstance for each member. Attach a DBClusterParameterGroup tuned for the workload and a DBSubnetGroup that spans at least two Availability Zones for fault tolerance.

Call CreateDBCluster with Engine docdb and a DBSubnetGroupName, then CreateDBInstance three times bound to that cluster identifier and verify with DescribeDBClusters.

Disaster Recovery via Point-in-Time Restore

Recover a DocumentDB cluster to any second within the backup retention window using RestoreDBClusterToPointInTime. The new cluster is provisioned from continuous backups without manual snapshot juggling, giving a clean recovery path after accidental data loss.

Call RestoreDBClusterToPointInTime with SourceDBClusterIdentifier, DBClusterIdentifier of the new cluster, and RestoreToTime set to the desired timestamp.

Run a Cross-Region Global Cluster

Create a DocumentDB global cluster spanning two AWS regions for low-latency reads in a secondary region and faster regional failover. CreateGlobalCluster anchors the topology, ModifyGlobalCluster adds secondary clusters, and RemoveFromGlobalCluster detaches a region during decommissioning.

Call CreateGlobalCluster with the primary cluster identifier, then ModifyGlobalCluster to add a secondary cluster ARN in another region.

Agent-Driven DocumentDB Lifecycle Management

An AI agent connected via Jentic can react to a runbook event - provision a new cluster for a stage environment, snapshot a production cluster before a deploy, or scale instance class during a load test. Jentic returns the matching DocumentDB operation and schema so the agent can sequence calls and check status without bespoke SDK code.

Search Jentic for 'create a DocumentDB cluster', load CreateDBCluster, execute it with the requested DBClusterIdentifier, Engine docdb, and DBSubnetGroupName, then poll DescribeDBClusters.

Key Endpoints

106 endpoints — jentic publishes the only available openapi specification for amazon documentdb, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/#Action=CreateDBCluster

Create a DocumentDB cluster

POST

/#Action=CreateDBInstance

Add an instance to a cluster

POST

/#Action=CreateDBClusterSnapshot

Snapshot a cluster

POST

/#Action=DeleteDBCluster

Delete a cluster

POST

/#Action=CopyDBClusterSnapshot

Copy a cluster snapshot

POST

/#Action=CreateGlobalCluster

Create a cross-region global cluster

POST

/#Action=ApplyPendingMaintenanceAction

Apply a pending maintenance action

POST

/#Action=CreateDBCluster

Create a DocumentDB cluster

POST

/#Action=CreateDBInstance

Add an instance to a cluster

POST

/#Action=CreateDBClusterSnapshot

Snapshot a cluster

POST

/#Action=DeleteDBCluster

Delete a cluster

POST

/#Action=CopyDBClusterSnapshot

Copy a cluster snapshot

POST

/#Action=CreateGlobalCluster

Create a cross-region global cluster

POST

/#Action=ApplyPendingMaintenanceAction

Apply a pending maintenance action

Why Jentic?

What agents get from Jentic-routed access to this vendor.

Setup

Wiring Amazon DocumentDB by hand means building SigV4 request signing, resolving the shared rds.{region}.amazonaws.com host, and handling the query-style Action dispatch plus AWS retries yourself. Through Jentic you install once, import DocumentDB from the API Directory, store the AWS access keys once, and your agent calls it.

Permission scoping

DocumentDB dispatches every action through a single endpoint with the operation named in the request, so scope the agent to the operations it needs, such as creating a cluster or a cluster snapshot. Destructive operations like deleting a DB cluster stay out of that set unless you add them.

Credential isolation

Your AWS access keys for DocumentDB are stored once, encrypted, by your own Jentic One instance and injected at execution time when the request is signed. They never enter the agent's prompt, logs, or context.

Intent-based discovery

Agents search Jentic by intent such as 'create a DocumentDB cluster' or 'restore from a snapshot', and Jentic returns the matching DocumentDB operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

FAQs

Specific to using Amazon DocumentDB with MongoDB compatibility API through Jentic.

Why is there no official OpenAPI spec for Amazon DocumentDB?

AWS does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Amazon DocumentDB via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

What authentication does the Amazon DocumentDB API use?

DocumentDB uses AWS Signature Version 4 (HMAC) signing with an AWS access key ID and secret access key. Through Jentic, those credentials live encrypted in your Jentic One instance and are injected into signed requests at execution time, so the agent never sees the raw secret access key.

Can I run a global cluster across regions through this API?

Yes. Use CreateGlobalCluster to define the topology, then ModifyGlobalCluster to attach secondary clusters in other regions. Reads and writes follow standard global cluster semantics, and RemoveFromGlobalCluster detaches a region for maintenance.

What are the rate limits for the Amazon DocumentDB API?

DocumentDB shares standard AWS service quotas, which are managed per account and region rather than published as fixed per-second limits in the spec. Cluster and instance counts are also gated by RDS-style account quotas; ThrottlingException responses should trigger backoff.

How do I provision a DocumentDB cluster through Jentic?

Search Jentic for 'create a DocumentDB cluster', load CreateDBCluster, then execute it with DBClusterIdentifier, Engine docdb, MasterUsername, MasterUserPassword, and DBSubnetGroupName. Run pip install jentic and use the async search and execute pattern.

Does this API run database queries, or only manage clusters?

Only manages clusters and instances. Application queries connect via the MongoDB wire protocol to the cluster endpoint returned by DescribeDBClusters and use a MongoDB driver - DocumentDB's data plane is not exposed through this REST API.

Can I limit what my agent is allowed to do with the Amazon DocumentDB API?

Yes. Amazon DocumentDB dispatches every action through a single endpoint with the operation named in the request, and because you run Jentic One yourself, your own rules decide which of those operations the agent may call. You can allow only the operations it needs, such as CreateDBCluster to provision a cluster or CreateDBClusterSnapshot to back one up, while keeping destructive operations like DeleteDBCluster out of that set unless you add them. The stored AWS access keys are injected only when a permitted request is signed, so the agent can invoke only the operations you have granted.

AWS Amazon DocumentDB with MongoDB compatibility

Connect the Amazon DocumentDB with MongoDB compatibility to your agent

Capabilities

Start building with Amazon DocumentDB with MongoDB compatibility API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs