# Amazon DocumentDB with MongoDB compatibility API

> Amazon DocumentDB with MongoDB compatibility API on Apizie: 53 endpoints (Adds a source identifier to an existing event notification subscription., Adds metadata tags to an Amazon DocumentDB resource. You can use these tags with cost allocation reporting…, Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance)., Copies the specified cluster parameter group., …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:amazonaws-docdb`
- Category: Cloud
- Status: byok
- Source: https://github.com/mermade/aws2openapi
- Page: https://zieapi.vercel.app/api/cloud/amazonaws-docdb
- OpenAPI: https://zieapi.vercel.app/api/cloud/amazonaws-docdb/openapi.json

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…

## Endpoints

### Adds a source identifier to an existing event notification subscription.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-add-source-identifier-to-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| SubscriptionName | string | yes | The name of the Amazon DocumentDB event notification subscription that you want to add a source identifier to. |
| SourceIdentifier | string | yes | The identifier of the event source to be added: If the source type is an instance, a DBInstanceIdentifier must be provided. If the source… |

### Adds metadata tags to an Amazon DocumentDB resource. You can use these tags with cost allocation reporting…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-add-tags-to-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ResourceName | string | yes | The Amazon DocumentDB resource that the tags are added to. This value is an Amazon Resource Name . |
| Tags | array | yes | The tags to be assigned to the Amazon DocumentDB resource. |

### Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-apply-pending-maintenance-action` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ResourceIdentifier | string | yes | The Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. |
| ApplyAction | string | yes | The pending maintenance action to apply to this resource. Valid values: system-update , db-upgrade |
| OptInType | string | yes | A value that specifies the type of opt-in request or undoes an opt-in request. An opt-in request of type immediate can't be undone. Valid… |

### Copies the specified cluster parameter group.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-copy-dbcluster-parameter-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| SourceDBClusterParameterGroupIdentifier | string | yes | The identifier or Amazon Resource Name (ARN) for the source cluster parameter group. Constraints: Must specify a valid cluster parameter… |
| TargetDBClusterParameterGroupIdentifier | string | yes | The identifier for the copied cluster parameter group. Constraints: Cannot be null, empty, or blank. Must contain from 1 to 255 letters,… |
| TargetDBClusterParameterGroupDescription | string | yes | A description for the copied cluster parameter group. |
| Tags | array | no | The tags that are to be assigned to the parameter group. |

### Copies a snapshot of a cluster. To copy a cluster snapshot from a shared manual cluster snapshot,…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-copy-dbcluster-snapshot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| SourceDBClusterSnapshotIdentifier | string | yes | The identifier of the cluster snapshot to copy. This parameter is not case sensitive. Constraints: Must specify a valid system snapshot in… |
| TargetDBClusterSnapshotIdentifier | string | yes | The identifier of the new cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive. Constraints:… |
| KmsKeyId | string | no | The KMS key ID for an encrypted cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key… |
| PreSignedUrl | string | no | The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the Amazon Web Services Region that… |
| CopyTags | boolean | no | Set to true to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwise false . The default is false . |
| Tags | array | no | The tags to be assigned to the cluster snapshot. |

### Creates a new Amazon DocumentDB cluster.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-create-dbcluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| AvailabilityZones | array | no | A list of Amazon EC2 Availability Zones that instances in the cluster can be created in. |
| BackupRetentionPeriod | integer | no | The number of days for which automated backups are retained. You must specify a minimum value of 1. Default: 1 Constraints: Must be a… |
| DBClusterIdentifier | string | yes | The cluster identifier. This parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or… |
| DBClusterParameterGroupName | string | no | The name of the cluster parameter group to associate with this cluster. |
| VpcSecurityGroupIds | array | no | A list of EC2 VPC security groups to associate with this cluster. |
| DBSubnetGroupName | string | no | A subnet group to associate with this cluster. Constraints: Must match the name of an existing DBSubnetGroup . Must not be default.… |
| Engine | string | yes | The name of the database engine to be used for this cluster. Valid values: docdb |
| EngineVersion | string | no | The version number of the database engine to use. The --engine-version will default to the latest major engine version. For production… |
| Port | integer | no | The port number on which the instances in the cluster accept connections. |
| MasterUsername | string | no | The name of the master user for the cluster. Constraints: Must be from 1 to 63 letters or numbers. The first character must be a letter.… |
| MasterUserPassword | string | no | The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote… |
| PreferredBackupWindow | string | no | The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod… |
| PreferredMaintenanceWindow | string | no | The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The… |
| Tags | array | no | The tags to be assigned to the cluster. |
| StorageEncrypted | boolean | no | Specifies whether the cluster is encrypted. |
| KmsKeyId | string | no | The KMS key identifier for an encrypted cluster. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If… |
| PreSignedUrl | string | no | Not currently supported. |
| EnableCloudwatchLogsExports | array | no | A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs. You can enable audit logs or profiler logs. For more… |
| DeletionProtection | boolean | no | Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and… |
| GlobalClusterIdentifier | string | no | The cluster identifier of the new global cluster. |

### Creates a new cluster parameter group. Parameters in a cluster parameter group apply to all of the instances…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-create-dbcluster-parameter-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DBClusterParameterGroupName | string | yes | The name of the cluster parameter group. Constraints: Must not match the name of an existing DBClusterParameterGroup . This value is… |
| DBParameterGroupFamily | string | yes | The cluster parameter group family name. |
| Description | string | yes | The description for the cluster parameter group. |
| Tags | array | no | The tags to be assigned to the cluster parameter group. |

### Creates a snapshot of a cluster.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-create-dbcluster-snapshot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DBClusterSnapshotIdentifier | string | yes | The identifier of the cluster snapshot. This parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters,… |
| DBClusterIdentifier | string | yes | The identifier of the cluster to create a snapshot for. This parameter is not case sensitive. Constraints: Must match the identifier of an… |
| Tags | array | no | The tags to be assigned to the cluster snapshot. |

### Creates a new instance.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-create-dbinstance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DBInstanceIdentifier | string | yes | The instance identifier. This parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or… |
| DBInstanceClass | string | yes | The compute and memory capacity of the instance; for example, db.r5.large . |
| Engine | string | yes | The name of the database engine to be used for this instance. Valid value: docdb |
| AvailabilityZone | string | no | The Amazon EC2 Availability Zone that the instance is created in. Default: A random, system-chosen Availability Zone in the endpoint's… |
| PreferredMaintenanceWindow | string | no | The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi… |
| AutoMinorVersionUpgrade | boolean | no | This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.… |
| Tags | array | no | The tags to be assigned to the instance. You can assign up to 10 tags to an instance. |
| DBClusterIdentifier | string | yes | The identifier of the cluster that the instance will belong to. |
| CopyTagsToSnapshot | boolean | no | A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. |
| PromotionTier | integer | no | A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing… |
| EnablePerformanceInsights | boolean | no | A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance… |
| PerformanceInsightsKMSKeyId | string | no | The KMS key identifier for encryption of Performance Insights data. The KMS key identifier is the key ARN, key ID, alias ARN, or alias… |

### Creates a new subnet group. subnet groups must contain at least one subnet in at least two Availability…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-create-dbsubnet-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DBSubnetGroupName | string | yes | The name for the subnet group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 letters, numbers,… |
| DBSubnetGroupDescription | string | yes | The description for the subnet group. |
| SubnetIds | array | yes | The Amazon EC2 subnet IDs for the subnet group. |
| Tags | array | no | The tags to be assigned to the subnet group. |

### Creates an Amazon DocumentDB event notification subscription. This action requires a topic Amazon Resource…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-create-event-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| SubscriptionName | string | yes | The name of the subscription. Constraints: The name must be fewer than 255 characters. |
| SnsTopicArn | string | yes | The Amazon Resource Name (ARN) of the SNS topic created for event notification. Amazon SNS creates the ARN when you create a topic and… |
| SourceType | string | no | The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, you would… |
| EventCategories | array | no | A list of event categories for a SourceType that you want to subscribe to. |
| SourceIds | array | no | The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the… |
| Enabled | boolean | no | A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it. |
| Tags | array | no | The tags to be assigned to the event subscription. |

### Creates an Amazon DocumentDB global cluster that can span multiple multiple Amazon Web Services Regions. The…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-create-global-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| GlobalClusterIdentifier | string | yes | The cluster identifier of the new global cluster. |
| SourceDBClusterIdentifier | string | no | The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster. This parameter is optional. |
| Engine | string | no | The name of the database engine to be used for this cluster. |
| EngineVersion | string | no | The engine version of the global cluster. |
| DeletionProtection | boolean | no | The deletion protection setting for the new global cluster. The global cluster can't be deleted when deletion protection is enabled. |
| DatabaseName | string | no | The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon DocumentDB will not create a… |
| StorageEncrypted | boolean | no | The storage encryption setting for the new global cluster. |

### Deletes a previously provisioned cluster. When you delete a cluster, all automated backups for that cluster…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-delete-dbcluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DBClusterIdentifier | string | yes | The cluster identifier for the cluster to be deleted. This parameter isn't case sensitive. Constraints: Must match an existing… |
| SkipFinalSnapshot | boolean | no | Determines whether a final cluster snapshot is created before the cluster is deleted. If true is specified, no cluster snapshot is… |
| FinalDBSnapshotIdentifier | string | no | The cluster snapshot identifier of the new cluster snapshot created when SkipFinalSnapshot is set to false . Specifying this parameter and… |

### Deletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-delete-dbcluster-parameter-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DBClusterParameterGroupName | string | yes | The name of the cluster parameter group. Constraints: Must be the name of an existing cluster parameter group. You can't delete a default… |

### Deletes a cluster snapshot. If the snapshot is being copied, the copy operation is terminated. The cluster…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-delete-dbcluster-snapshot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DBClusterSnapshotIdentifier | string | yes | The identifier of the cluster snapshot to delete. Constraints: Must be the name of an existing cluster snapshot in the available state. |

### Deletes a previously provisioned instance.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-delete-dbinstance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DBInstanceIdentifier | string | yes | The instance identifier for the instance to be deleted. This parameter isn't case sensitive. Constraints: Must match the name of an… |

### Deletes a subnet group. The specified database subnet group must not be associated with any DB instances.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-delete-dbsubnet-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DBSubnetGroupName | string | yes | The name of the database subnet group to delete. You can't delete the default subnet group. Constraints: Must match the name of an… |

### Deletes an Amazon DocumentDB event notification subscription.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-delete-event-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| SubscriptionName | string | yes | The name of the Amazon DocumentDB event notification subscription that you want to delete. |

### Deletes a global cluster. The primary and secondary clusters must already be detached or deleted before…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-delete-global-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| GlobalClusterIdentifier | string | yes | The cluster identifier of the global cluster being deleted. |

### Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-describe-certificates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| CertificateIdentifier | string | no | The user-supplied certificate identifier. If this parameter is specified, information for only the specified certificate is returned. If… |
| Filters | array | no | This parameter is not currently supported. |
| MaxRecords | integer | no | The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token… |
| Marker | string | no | An optional pagination token provided by a previous DescribeCertificates request. If this parameter is specified, the response includes… |

### Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-describe-dbcluster-parameter-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DBClusterParameterGroupName | string | no | The name of a specific cluster parameter group to return details for. Constraints: If provided, must match the name of an existing… |
| Filters | array | no | This parameter is not currently supported. |
| MaxRecords | integer | no | The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token… |
| Marker | string | no | An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the… |

### Returns the detailed parameter list for a particular cluster parameter group.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-describe-dbcluster-parameters` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DBClusterParameterGroupName | string | yes | The name of a specific cluster parameter group to return parameter details for. Constraints: If provided, must match the name of an… |
| Source | string | no | A value that indicates to return only parameters for a specific source. Parameter sources can be engine , service , or customer . |
| Filters | array | no | This parameter is not currently supported. |
| MaxRecords | integer | no | The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token… |
| Marker | string | no | An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the… |

### Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot. When you…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-describe-dbcluster-snapshot-attributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DBClusterSnapshotIdentifier | string | yes | The identifier for the cluster snapshot to describe the attributes for. |

### Returns information about cluster snapshots. This API operation supports pagination.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-describe-dbcluster-snapshots` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DBClusterIdentifier | string | no | The ID of the cluster to retrieve the list of cluster snapshots for. This parameter can't be used with the DBClusterSnapshotIdentifier… |
| DBClusterSnapshotIdentifier | string | no | A specific cluster snapshot identifier to describe. This parameter can't be used with the DBClusterIdentifier parameter. This value is… |
| SnapshotType | string | no | The type of cluster snapshots to be returned. You can specify one of the following values: automated - Return all cluster snapshots that… |
| Filters | array | no | This parameter is not currently supported. |
| MaxRecords | integer | no | The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token… |
| Marker | string | no | An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the… |
| IncludeShared | boolean | no | Set to true to include shared manual cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has… |
| IncludePublic | boolean | no | Set to true to include manual cluster snapshots that are public and can be copied or restored by any Amazon Web Services account, and… |

### Returns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination.…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-describe-dbclusters` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DBClusterIdentifier | string | no | The user-provided cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This… |
| Filters | array | no | A filter that specifies one or more clusters to describe. Supported filters: db-cluster-id - Accepts cluster identifiers and cluster… |
| MaxRecords | integer | no | The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token… |
| Marker | string | no | An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the… |

### Returns a list of the available engines.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-describe-dbengine-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Engine | string | no | The database engine to return. |
| EngineVersion | string | no | The database engine version to return. Example: 3.6.0 |
| DBParameterGroupFamily | string | no | The name of a specific parameter group family to return details for. Constraints: If provided, must match an existing… |
| Filters | array | no | This parameter is not currently supported. |
| MaxRecords | integer | no | The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token… |
| Marker | string | no | An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the… |
| DefaultOnly | boolean | no | Indicates that only the default version of the specified engine or engine and major version combination is returned. |
| ListSupportedCharacterSets | boolean | no | If this parameter is specified and the requested engine supports the CharacterSetName parameter for CreateDBInstance , the response… |
| ListSupportedTimezones | boolean | no | If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance , the response includes a… |

### Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-describe-dbinstances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DBInstanceIdentifier | string | no | The user-provided instance identifier. If this parameter is specified, information from only the specific instance is returned. This… |
| Filters | array | no | A filter that specifies one or more instances to describe. Supported filters: db-cluster-id - Accepts cluster identifiers and cluster… |
| MaxRecords | integer | no | The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token… |
| Marker | string | no | An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the… |

### Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-describe-dbsubnet-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DBSubnetGroupName | string | no | The name of the subnet group to return details for. |
| Filters | array | no | This parameter is not currently supported. |
| MaxRecords | integer | no | The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token… |
| Marker | string | no | An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the… |

### Returns the default engine and system parameter information for the cluster database engine.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-describe-engine-default-cluster-parameters` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DBParameterGroupFamily | string | yes | The name of the cluster parameter group family to return the engine parameter information for. |
| Filters | array | no | This parameter is not currently supported. |
| MaxRecords | integer | no | The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token… |
| Marker | string | no | An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the… |

### Displays a list of categories for all event source types, or, if specified, for a specified source type.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-describe-event-categories` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| SourceType | string | no | The type of source that is generating the events. Valid values: db-instance , db-parameter-group , db-security-group |
| Filters | array | no | This parameter is not currently supported. |

### Lists all the subscription descriptions for a customer account. The description for a subscription includes…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-describe-event-subscriptions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| SubscriptionName | string | no | The name of the Amazon DocumentDB event notification subscription that you want to describe. |
| Filters | array | no | This parameter is not currently supported. |
| MaxRecords | integer | no | The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token… |
| Marker | string | no | An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the… |

### Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-describe-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| SourceIdentifier | string | no | The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.… |
| SourceType | string | no | The event source to retrieve events for. If no value is specified, all events are returned. |
| StartTime | string | no | The beginning of the time interval to retrieve events for, specified in ISO 8601 format. Example: 2009-07-08T18:00Z |
| EndTime | string | no | The end of the time interval for which to retrieve events, specified in ISO 8601 format. Example: 2009-07-08T18:00Z |
| Duration | integer | no | The number of minutes to retrieve events for. Default: 60 |
| EventCategories | array | no | A list of event categories that trigger notifications for an event notification subscription. |
| Filters | array | no | This parameter is not currently supported. |
| MaxRecords | integer | no | The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token… |
| Marker | string | no | An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the… |

### Returns information about Amazon DocumentDB global clusters. This API supports pagination. This action only…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-describe-global-clusters` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| GlobalClusterIdentifier | string | no | The user-supplied cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This… |
| Filters | array | no | A filter that specifies one or more global DB clusters to describe. Supported filters: db-cluster-id accepts cluster identifiers and… |
| MaxRecords | integer | no | The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token… |
| Marker | string | no | An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes… |

### Returns a list of orderable instance options for the specified engine.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-describe-orderable-dbinstance-options` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Engine | string | yes | The name of the engine to retrieve instance options for. |
| EngineVersion | string | no | The engine version filter value. Specify this parameter to show only the available offerings that match the specified engine version. |
| DBInstanceClass | string | no | The instance class filter value. Specify this parameter to show only the available offerings that match the specified instance class. |
| LicenseModel | string | no | The license model filter value. Specify this parameter to show only the available offerings that match the specified license model. |
| Vpc | boolean | no | The virtual private cloud (VPC) filter value. Specify this parameter to show only the available VPC or non-VPC offerings. |
| Filters | array | no | This parameter is not currently supported. |
| MaxRecords | integer | no | The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token… |
| Marker | string | no | An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the… |

### Returns a list of resources (for example, instances) that have at least one pending maintenance action.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-describe-pending-maintenance-actions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ResourceIdentifier | string | no | The ARN of a resource to return pending maintenance actions for. |
| Filters | array | no | A filter that specifies one or more resources to return pending maintenance actions for. Supported filters: db-cluster-id - Accepts… |
| Marker | string | no | An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the… |
| MaxRecords | integer | no | The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token… |

### Forces a failover for a cluster. A failover for a cluster promotes one of the Amazon DocumentDB replicas…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-failover-dbcluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DBClusterIdentifier | string | no | A cluster identifier to force a failover for. This parameter is not case sensitive. Constraints: Must match the identifier of an existing… |
| TargetDBInstanceIdentifier | string | no | The name of the instance to promote to the primary instance. You must specify the instance identifier for an Amazon DocumentDB replica in… |

### Lists all tags on an Amazon DocumentDB resource.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-list-tags-for-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ResourceName | string | yes | The Amazon DocumentDB resource with tags to be listed. This value is an Amazon Resource Name (ARN). |
| Filters | array | no | This parameter is not currently supported. |

### Modifies a setting for an Amazon DocumentDB cluster. You can change one or more database configuration…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-modify-dbcluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DBClusterIdentifier | string | yes | The cluster identifier for the cluster that is being modified. This parameter is not case sensitive. Constraints: Must match the… |
| NewDBClusterIdentifier | string | no | The new cluster identifier for the cluster when renaming a cluster. This value is stored as a lowercase string. Constraints: Must contain… |
| ApplyImmediately | boolean | no | A value that specifies whether the changes in this request and any pending changes are asynchronously applied as soon as possible,… |
| BackupRetentionPeriod | integer | no | The number of days for which automated backups are retained. You must specify a minimum value of 1. Default: 1 Constraints: Must be a… |
| DBClusterParameterGroupName | string | no | The name of the cluster parameter group to use for the cluster. |
| VpcSecurityGroupIds | array | no | A list of virtual private cloud (VPC) security groups that the cluster will belong to. |
| Port | integer | no | The port number on which the cluster accepts connections. Constraints: Must be a value from 1150 to 65535 . Default: The same port as the… |
| MasterUserPassword | string | no | The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote… |
| PreferredBackupWindow | string | no | The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod… |
| PreferredMaintenanceWindow | string | no | The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The… |
| CloudwatchLogsExportConfiguration | object | no | The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster. The… |
| EngineVersion | string | no | The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is… |
| AllowMajorVersionUpgrade | boolean | no | A value that indicates whether major version upgrades are allowed. Constraints: You must allow major version upgrades when specifying a… |
| DeletionProtection | boolean | no | Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and… |

### Modifies the parameters of a cluster parameter group. To modify more than one parameter, submit a list of…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-modify-dbcluster-parameter-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DBClusterParameterGroupName | string | yes | The name of the cluster parameter group to modify. |
| Parameters | array | yes | A list of parameters in the cluster parameter group to modify. |

### Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot. To…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-modify-dbcluster-snapshot-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DBClusterSnapshotIdentifier | string | yes | The identifier for the cluster snapshot to modify the attributes for. |
| AttributeName | string | yes | The name of the cluster snapshot attribute to modify. To manage authorization for other Amazon Web Services accounts to copy or restore a… |
| ValuesToAdd | array | no | A list of cluster snapshot attributes to add to the attribute specified by AttributeName . To authorize other Amazon Web Services accounts… |
| ValuesToRemove | array | no | A list of cluster snapshot attributes to remove from the attribute specified by AttributeName . To remove authorization for other Amazon… |

### Modifies settings for an instance. You can change one or more database configuration parameters by…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-modify-dbinstance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DBInstanceIdentifier | string | yes | The instance identifier. This value is stored as a lowercase string. Constraints: Must match the identifier of an existing DBInstance . |
| DBInstanceClass | string | no | The new compute and memory capacity of the instance; for example, db.r5.large . Not all instance classes are available in all Amazon Web… |
| ApplyImmediately | boolean | no | Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible,… |
| PreferredMaintenanceWindow | string | no | The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't… |
| AutoMinorVersionUpgrade | boolean | no | This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set. |
| NewDBInstanceIdentifier | string | no | The new instance identifier for the instance when renaming an instance. When you change the instance identifier, an instance reboot occurs… |
| CACertificateIdentifier | string | no | Indicates the certificate that needs to be associated with the instance. |
| CopyTagsToSnapshot | boolean | no | A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. |
| PromotionTier | integer | no | A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing… |
| EnablePerformanceInsights | boolean | no | A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance… |
| PerformanceInsightsKMSKeyId | string | no | The KMS key identifier for encryption of Performance Insights data. The KMS key identifier is the key ARN, key ID, alias ARN, or alias… |

### Modifies an existing subnet group. subnet groups must contain at least one subnet in at least two…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-modify-dbsubnet-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DBSubnetGroupName | string | yes | The name for the subnet group. This value is stored as a lowercase string. You can't modify the default subnet group. Constraints: Must… |
| DBSubnetGroupDescription | string | no | The description for the subnet group. |
| SubnetIds | array | yes | The Amazon EC2 subnet IDs for the subnet group. |

### Modifies an existing Amazon DocumentDB event notification subscription.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-modify-event-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| SubscriptionName | string | yes | The name of the Amazon DocumentDB event notification subscription. |
| SnsTopicArn | string | no | The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic… |
| SourceType | string | no | The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, set this… |
| EventCategories | array | no | A list of event categories for a SourceType that you want to subscribe to. |
| Enabled | boolean | no | A Boolean value; set to true to activate the subscription. |

### Modify a setting for an Amazon DocumentDB global cluster. You can change one or more configuration…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-modify-global-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| GlobalClusterIdentifier | string | yes | The identifier for the global cluster being modified. This parameter isn't case-sensitive. Constraints: Must match the identifier of an… |
| NewGlobalClusterIdentifier | string | no | The new identifier for a global cluster when you modify a global cluster. This value is stored as a lowercase string. Must contain from 1… |
| DeletionProtection | boolean | no | Indicates if the global cluster has deletion protection enabled. The global cluster can't be deleted when deletion protection is enabled. |

### You might need to reboot your instance, usually for maintenance reasons. For example, if you make certain…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-reboot-dbinstance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DBInstanceIdentifier | string | yes | The instance identifier. This parameter is stored as a lowercase string. Constraints: Must match the identifier of an existing DBInstance . |
| ForceFailover | boolean | no | When true , the reboot is conducted through a Multi-AZ failover. Constraint: You can't specify true if the instance is not configured for… |

### Detaches an Amazon DocumentDB secondary cluster from a global cluster. The cluster becomes a standalone…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-remove-from-global-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| GlobalClusterIdentifier | string | yes | The cluster identifier to detach from the Amazon DocumentDB global cluster. |
| DbClusterIdentifier | string | yes | The Amazon Resource Name (ARN) identifying the cluster that was detached from the Amazon DocumentDB global cluster. |

### Removes a source identifier from an existing Amazon DocumentDB event notification subscription.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-remove-source-identifier-from-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| SubscriptionName | string | yes | The name of the Amazon DocumentDB event notification subscription that you want to remove a source identifier from. |
| SourceIdentifier | string | yes | The source identifier to be removed from the subscription, such as the instance identifier for an instance, or the name of a security group. |

### Removes metadata tags from an Amazon DocumentDB resource.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-remove-tags-from-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ResourceName | string | yes | The Amazon DocumentDB resource that the tags are removed from. This value is an Amazon Resource Name (ARN). |
| TagKeys | array | yes | The tag key (name) of the tag to be removed. |

### Modifies the parameters of a cluster parameter group to the default value. To reset specific parameters,…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-reset-dbcluster-parameter-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DBClusterParameterGroupName | string | yes | The name of the cluster parameter group to reset. |
| ResetAllParameters | boolean | no | A value that is set to true to reset all parameters in the cluster parameter group to their default values, and false otherwise. You can't… |
| Parameters | array | no | A list of parameter names in the cluster parameter group to reset to the default values. You can't use this parameter if the… |

### Creates a new cluster from a snapshot or cluster snapshot. If a snapshot is specified, the target cluster is…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-restore-dbcluster-from-snapshot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| AvailabilityZones | array | no | Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in. |
| DBClusterIdentifier | string | yes | The name of the cluster to create from the snapshot or cluster snapshot. This parameter isn't case sensitive. Constraints: Must contain… |
| SnapshotIdentifier | string | yes | The identifier for the snapshot or cluster snapshot to restore from. You can use either the name or the Amazon Resource Name (ARN) to… |
| Engine | string | yes | The database engine to use for the new cluster. Default: The same as source. Constraint: Must be compatible with the engine of the source. |
| EngineVersion | string | no | The version of the database engine to use for the new cluster. |
| Port | integer | no | The port number on which the new cluster accepts connections. Constraints: Must be a value from 1150 to 65535 . Default: The same port as… |
| DBSubnetGroupName | string | no | The name of the subnet group to use for the new cluster. Constraints: If provided, must match the name of an existing DBSubnetGroup .… |
| VpcSecurityGroupIds | array | no | A list of virtual private cloud (VPC) security groups that the new cluster will belong to. |
| Tags | array | no | The tags to be assigned to the restored cluster. |
| KmsKeyId | string | no | The KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot. The KMS key identifier is the… |
| EnableCloudwatchLogsExports | array | no | A list of log types that must be enabled for exporting to Amazon CloudWatch Logs. |
| DeletionProtection | boolean | no | Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and… |
| DBClusterParameterGroupName | string | no | The name of the DB cluster parameter group to associate with this DB cluster. Type: String. Required: No. If this argument is omitted, the… |

### Restores a cluster to an arbitrary point in time. Users can restore to any point in time before…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-restore-dbcluster-to-point-in-time` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DBClusterIdentifier | string | yes | The name of the new cluster to be created. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. The first character must… |
| RestoreType | string | no | The type of restore to be performed. You can specify one of the following values: full-copy - The new DB cluster is restored as a full… |
| SourceDBClusterIdentifier | string | yes | The identifier of the source cluster from which to restore. Constraints: Must match the identifier of an existing DBCluster . |
| RestoreToTime | string | no | The date and time to restore the cluster to. Valid values: A time in Universal Coordinated Time (UTC) format. Constraints: Must be before… |
| UseLatestRestorableTime | boolean | no | A value that is set to true to restore the cluster to the latest restorable backup time, and false otherwise. Default: false Constraints:… |
| Port | integer | no | The port number on which the new cluster accepts connections. Constraints: Must be a value from 1150 to 65535 . Default: The default port… |
| DBSubnetGroupName | string | no | The subnet group name to use for the new cluster. Constraints: If provided, must match the name of an existing DBSubnetGroup . Example:… |
| VpcSecurityGroupIds | array | no | A list of VPC security groups that the new cluster belongs to. |
| Tags | array | no | The tags to be assigned to the restored cluster. |
| KmsKeyId | string | no | The KMS key identifier to use when restoring an encrypted cluster from an encrypted cluster. The KMS key identifier is the Amazon Resource… |
| EnableCloudwatchLogsExports | array | no | A list of log types that must be enabled for exporting to Amazon CloudWatch Logs. |
| DeletionProtection | boolean | no | Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and… |

### Restarts the stopped cluster that is specified by DBClusterIdentifier . For more information, see Stopping…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-start-dbcluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DBClusterIdentifier | string | yes | The identifier of the cluster to restart. Example: docdb-2019-05-28-15-24-52 |

### Stops the running cluster that is specified by DBClusterIdentifier . The cluster must be in the available…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-stop-dbcluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DBClusterIdentifier | string | yes | The identifier of the cluster to stop. Example: docdb-2019-05-28-15-24-52 |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-add-source-identifier-to-subscription" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Amazon DocumentDB with MongoDB compatibility API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/cloud:amazonaws-docdb/get-add-source-identifier-to-subscription with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Amazon DocumentDB with MongoDB compatibility API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Amazon DocumentDB with MongoDB compatibility itself also needs your own key from amazonaws.com.

### Can AI agents use the Amazon DocumentDB with MongoDB compatibility API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:amazonaws-docdb.

### What is the status of the Amazon DocumentDB with MongoDB compatibility API?
Needs your own provider key (bring your own key)