Amazon Web Services, Inc.

Amazon DocumentDB with MongoDB compatibility

Amazon DocumentDB is a fast, reliable, and fully managed database service. Amazon DocumentDB makes it easy to set up, operate, and scale MongoDB-compatible…

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Amazon DocumentDB is a fast, reliable, and fully managed database service.
Amazon DocumentDB makes it easy to set up, operate, and scale MongoDB-compatible databases in the cloud.
With Amazon DocumentDB, you can run the same application code and use the same drivers and tools that you use with MongoDB.

Endpoints 56

  • POSTAdd source identifier to subscription/#Action=AddSourceIdentifierToSubscription?Action=AddSourceIdentifierToSubscription&Version=2014-10-31Adds a source identifier to an existing event notification subscription.
  • POSTAdd tags to resource/#Action=AddTagsToResource?Action=AddTagsToResource&Version=2014-10-31Adds metadata tags to an Amazon DocumentDB resource. You can use these tags with cost allocation reporting to track costs that are associated with Amazon…
  • POSTApply pending maintenance action/#Action=ApplyPendingMaintenanceAction?Action=ApplyPendingMaintenanceAction&Version=2014-10-31Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).
  • POSTCopy dB cluster parameter group/#Action=CopyDBClusterParameterGroup?Action=CopyDBClusterParameterGroup&Version=2014-10-31Copies the specified cluster parameter group.
  • POSTCopy dB cluster snapshot/#Action=CopyDBClusterSnapshot?Action=CopyDBClusterSnapshot&Version=2014-10-31Copies a snapshot of a cluster. To copy a cluster snapshot from a shared manual cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon…
  • POSTCreate dB cluster/#Action=CreateDBCluster?Action=CreateDBCluster&Version=2014-10-31Creates a new Amazon DocumentDB cluster.
  • POSTCreate dB cluster parameter group/#Action=CreateDBClusterParameterGroup?Action=CreateDBClusterParameterGroup&Version=2014-10-31Creates a new cluster parameter group. Parameters in a cluster parameter group apply to all of the instances in a cluster. A cluster parameter group is…
  • POSTCreate dB cluster snapshot/#Action=CreateDBClusterSnapshot?Action=CreateDBClusterSnapshot&Version=2014-10-31Creates a snapshot of a cluster.
  • POSTCreate dB instance/#Action=CreateDBInstance?Action=CreateDBInstance&Version=2014-10-31Creates a new instance.
  • POSTCreate dB subnet group/#Action=CreateDBSubnetGroup?Action=CreateDBSubnetGroup&Version=2014-10-31Creates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.
  • POSTCreate event subscription/#Action=CreateEventSubscription?Action=CreateEventSubscription&Version=2014-10-31Creates an Amazon DocumentDB event notification subscription. This action requires a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB…
  • POSTCreate global cluster/#Action=CreateGlobalCluster?Action=CreateGlobalCluster&Version=2014-10-31Creates an Amazon DocumentDB global cluster that can span multiple multiple Amazon Web Services Regions. The global cluster contains one primary cluster with…
  • POSTDelete dB cluster/#Action=DeleteDBCluster?Action=DeleteDBCluster&Version=2014-10-31Deletes a previously provisioned cluster. When you delete a cluster, all automated backups for that cluster are deleted and can't be recovered. Manual DB…
  • POSTDelete dB cluster parameter group/#Action=DeleteDBClusterParameterGroup?Action=DeleteDBClusterParameterGroup&Version=2014-10-31Deletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with any clusters.
  • POSTDelete dB cluster snapshot/#Action=DeleteDBClusterSnapshot?Action=DeleteDBClusterSnapshot&Version=2014-10-31Deletes a cluster snapshot. If the snapshot is being copied, the copy operation is terminated. The cluster snapshot must be in the available state to be…
  • POSTDelete dB instance/#Action=DeleteDBInstance?Action=DeleteDBInstance&Version=2014-10-31Deletes a previously provisioned instance.
  • POSTDelete dB subnet group/#Action=DeleteDBSubnetGroup?Action=DeleteDBSubnetGroup&Version=2014-10-31Deletes a subnet group. The specified database subnet group must not be associated with any DB instances.
  • POSTDelete event subscription/#Action=DeleteEventSubscription?Action=DeleteEventSubscription&Version=2014-10-31Deletes an Amazon DocumentDB event notification subscription.
  • POSTDelete global cluster/#Action=DeleteGlobalCluster?Action=DeleteGlobalCluster&Version=2014-10-31Deletes a global cluster. The primary and secondary clusters must already be detached or deleted before attempting to delete a global cluster. This action…
  • POSTDescribe certificates/#Action=DescribeCertificates?Action=DescribeCertificates&Version=2014-10-31Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web Services account.
  • POSTDescribe dB cluster parameter groups/#Action=DescribeDBClusterParameterGroups?Action=DescribeDBClusterParameterGroups&Version=2014-10-31Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list contains only the description of the…
  • POSTDescribe dB cluster parameters/#Action=DescribeDBClusterParameters?Action=DescribeDBClusterParameters&Version=2014-10-31Returns the detailed parameter list for a particular cluster parameter group.
  • POSTDescribe dB cluster snapshot attributes/#Action=DescribeDBClusterSnapshotAttributes?Action=DescribeDBClusterSnapshotAttributes&Version=2014-10-31Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot. When you share snapshots with other Amazon Web Services…
  • POSTDescribe dB cluster snapshots/#Action=DescribeDBClusterSnapshots?Action=DescribeDBClusterSnapshots&Version=2014-10-31Returns information about cluster snapshots. This API operation supports pagination.
  • POSTDescribe dB clusters/#Action=DescribeDBClusters?Action=DescribeDBClusters&Version=2014-10-31Returns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination. For certain management features such as cluster and…
  • POSTDescribe dB engine versions/#Action=DescribeDBEngineVersions?Action=DescribeDBEngineVersions&Version=2014-10-31Returns a list of the available engines.
  • POSTDescribe dB instances/#Action=DescribeDBInstances?Action=DescribeDBInstances&Version=2014-10-31Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.
  • POSTDescribe dB subnet groups/#Action=DescribeDBSubnetGroups?Action=DescribeDBSubnetGroups&Version=2014-10-31Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup .
  • POSTDescribe engine default cluster parameters/#Action=DescribeEngineDefaultClusterParameters?Action=DescribeEngineDefaultClusterParameters&Version=2014-10-31Returns the default engine and system parameter information for the cluster database engine.
  • POSTDescribe event categories/#Action=DescribeEventCategories?Action=DescribeEventCategories&Version=2014-10-31Displays a list of categories for all event source types, or, if specified, for a specified source type.
  • POSTDescribe event subscriptions/#Action=DescribeEventSubscriptions?Action=DescribeEventSubscriptions&Version=2014-10-31Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName , SNSTopicARN , CustomerID ,…
  • POSTDescribe events/#Action=DescribeEvents?Action=DescribeEvents&Version=2014-10-31Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular…
  • POSTDescribe global clusters/#Action=DescribeGlobalClusters?Action=DescribeGlobalClusters&Version=2014-10-31Returns information about Amazon DocumentDB global clusters. This API supports pagination. This action only applies to Amazon DocumentDB clusters.
  • POSTDescribe orderable dB instance options/#Action=DescribeOrderableDBInstanceOptions?Action=DescribeOrderableDBInstanceOptions&Version=2014-10-31Returns a list of orderable instance options for the specified engine.
  • POSTDescribe pending maintenance actions/#Action=DescribePendingMaintenanceActions?Action=DescribePendingMaintenanceActions&Version=2014-10-31Returns a list of resources (for example, instances) that have at least one pending maintenance action.
  • POSTDescribe serverless v2 platform versions/#Action=DescribeServerlessV2PlatformVersions?Action=DescribeServerlessV2PlatformVersions&Version=2014-10-31Describes the properties of specific platform versions for Amazon DocumentDB Serverless v2.
  • POSTFailover dB cluster/#Action=FailoverDBCluster?Action=FailoverDBCluster&Version=2014-10-31Forces a failover for a cluster. A failover for a cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the cluster to be the…
  • POSTFailover global cluster/#Action=FailoverGlobalCluster?Action=FailoverGlobalCluster&Version=2014-10-31Promotes the specified secondary DB cluster to be the primary DB cluster in the global cluster when failing over a global cluster occurs. Use this operation…
  • POSTList tags for resource/#Action=ListTagsForResource?Action=ListTagsForResource&Version=2014-10-31Lists all tags on an Amazon DocumentDB resource.
  • POSTModify dB cluster/#Action=ModifyDBCluster?Action=ModifyDBCluster&Version=2014-10-31Modifies a setting for an Amazon DocumentDB cluster. You can change one or more database configuration parameters by specifying these parameters and the new…
  • POSTModify dB cluster parameter group/#Action=ModifyDBClusterParameterGroup?Action=ModifyDBClusterParameterGroup&Version=2014-10-31Modifies the parameters of a cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName , ParameterValue , and…
  • POSTModify dB cluster snapshot attribute/#Action=ModifyDBClusterSnapshotAttribute?Action=ModifyDBClusterSnapshotAttribute&Version=2014-10-31Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot. To share a manual cluster snapshot with other Amazon Web…
  • POSTModify dB instance/#Action=ModifyDBInstance?Action=ModifyDBInstance&Version=2014-10-31Modifies settings for an instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the…
  • POSTModify dB subnet group/#Action=ModifyDBSubnetGroup?Action=ModifyDBSubnetGroup&Version=2014-10-31Modifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.
  • POSTModify event subscription/#Action=ModifyEventSubscription?Action=ModifyEventSubscription&Version=2014-10-31Modifies an existing Amazon DocumentDB event notification subscription.
  • POSTModify global cluster/#Action=ModifyGlobalCluster?Action=ModifyGlobalCluster&Version=2014-10-31Modify a setting for an Amazon DocumentDB global cluster. You can change one or more configuration parameters (for example: deletion protection), or the…
  • POSTReboot dB instance/#Action=RebootDBInstance?Action=RebootDBInstance&Version=2014-10-31You might need to reboot your instance, usually for maintenance reasons. For example, if you make certain changes, or if you change the cluster parameter…
  • POSTRemove from global cluster/#Action=RemoveFromGlobalCluster?Action=RemoveFromGlobalCluster&Version=2014-10-31Detaches an Amazon DocumentDB secondary cluster from a global cluster. The cluster becomes a standalone cluster with read-write capability instead of being…
  • POSTRemove source identifier from subscription/#Action=RemoveSourceIdentifierFromSubscription?Action=RemoveSourceIdentifierFromSubscription&Version=2014-10-31Removes a source identifier from an existing Amazon DocumentDB event notification subscription.
  • POSTRemove tags from resource/#Action=RemoveTagsFromResource?Action=RemoveTagsFromResource&Version=2014-10-31Removes metadata tags from an Amazon DocumentDB resource.
  • POSTReset dB cluster parameter group/#Action=ResetDBClusterParameterGroup?Action=ResetDBClusterParameterGroup&Version=2014-10-31Modifies the parameters of a cluster parameter group to the default value. To reset specific parameters, submit a list of the following: ParameterName and…
  • POSTRestore dB cluster from snapshot/#Action=RestoreDBClusterFromSnapshot?Action=RestoreDBClusterFromSnapshot&Version=2014-10-31Creates a new cluster from a snapshot or cluster snapshot. If a snapshot is specified, the target cluster is created from the source DB snapshot with a…
  • POSTRestore dB cluster to point in time/#Action=RestoreDBClusterToPointInTime?Action=RestoreDBClusterToPointInTime&Version=2014-10-31Restores a cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The…
  • POSTStart dB cluster/#Action=StartDBCluster?Action=StartDBCluster&Version=2014-10-31Restarts the stopped cluster that is specified by DBClusterIdentifier . For more information, see Stopping and Starting an Amazon DocumentDB Cluster .
  • POSTStop dB cluster/#Action=StopDBCluster?Action=StopDBCluster&Version=2014-10-31Stops the running cluster that is specified by DBClusterIdentifier . The cluster must be in the available state. For more information, see Stopping and…
  • POSTSwitchover global cluster/#Action=SwitchoverGlobalCluster?Action=SwitchoverGlobalCluster&Version=2014-10-31Switches over the specified secondary Amazon DocumentDB cluster to be the new primary Amazon DocumentDB cluster in the global database cluster.

API details

Base URL
https://rds.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
56 operations on 56 pathsPOST 56
Description format
AWS Smithy model, API version 2014-10-31

How to test the Amazon DocumentDB with MongoDB compatibility in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon DocumentDB with MongoDB compatibility collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Add source identifier to subscription” (POST /#Action=AddSourceIdentifierToSubscription?Action=AddSourceIdentifierToSubscription&Version=2014-10-31), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon DocumentDB with MongoDB compatibility?

Amazon DocumentDB is a fast, reliable, and fully managed database service. Amazon DocumentDB makes it easy to set up, operate, and scale MongoDB-compatible… It is listed under Developer tools and has 56 endpoints.

Who publishes the Amazon DocumentDB with MongoDB compatibility?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon DocumentDB with MongoDB compatibility?

Requests go to https://rds.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon DocumentDB with MongoDB compatibility?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon DocumentDB with MongoDB compatibility have?

56 operations on 56 paths (56 POST).

Is forking the Amazon DocumentDB with MongoDB compatibility free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.