Expand description
Amazon DocumentDB API documentation
If you’re using the service, you’re probably looking for DocdbClient and Docdb.
Structs§
- AddSource
Identifier ToSubscription Message Represents the input to AddSourceIdentifierToSubscription.
- AddSource
Identifier ToSubscription Result - AddTags
ToResource Message Represents the input to AddTagsToResource.
- Apply
Pending Maintenance Action Message Represents the input to ApplyPendingMaintenanceAction.
- Apply
Pending Maintenance Action Result - Availability
Zone Information about an Availability Zone.
- Certificate
A certificate authority (CA) certificate for an account.
- Certificate
Message - Cloudwatch
Logs Export Configuration The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster.
The
EnableLogTypesandDisableLogTypesarrays determine which logs are exported (or not exported) to CloudWatch Logs. The values within these arrays depend on the engine that is being used.- CopyDB
Cluster Parameter Group Message Represents the input to CopyDBClusterParameterGroup.
- CopyDB
Cluster Parameter Group Result - CopyDB
Cluster Snapshot Message Represents the input to CopyDBClusterSnapshot.
- CopyDB
Cluster Snapshot Result - CreateDB
Cluster Message Represents the input to CreateDBCluster.
- CreateDB
Cluster Parameter Group Message Represents the input of CreateDBClusterParameterGroup.
- CreateDB
Cluster Parameter Group Result - CreateDB
Cluster Result - CreateDB
Cluster Snapshot Message Represents the input of CreateDBClusterSnapshot.
- CreateDB
Cluster Snapshot Result - CreateDB
Instance Message Represents the input to CreateDBInstance.
- CreateDB
Instance Result - CreateDB
Subnet Group Message Represents the input to CreateDBSubnetGroup.
- CreateDB
Subnet Group Result - Create
Event Subscription Message Represents the input to CreateEventSubscription.
- Create
Event Subscription Result - Create
Global Cluster Message Represents the input to CreateGlobalCluster.
- Create
Global Cluster Result - DBCluster
Detailed information about a cluster.
- DBCluster
Member Contains information about an instance that is part of a cluster.
- DBCluster
Message Represents the output of DescribeDBClusters.
- DBCluster
Parameter Group Detailed information about a cluster parameter group.
- DBCluster
Parameter Group Details Represents the output of DBClusterParameterGroup.
- DBCluster
Parameter Group Name Message Contains the name of a cluster parameter group.
- DBCluster
Parameter Groups Message Represents the output of DBClusterParameterGroups.
- DBCluster
Role Describes an Identity and Access Management (IAM) role that is associated with a cluster.
- DBCluster
Snapshot Detailed information about a cluster snapshot.
- DBCluster
Snapshot Attribute Contains the name and values of a manual cluster snapshot attribute.
Manual cluster snapshot attributes are used to authorize other accounts to restore a manual cluster snapshot.
- DBCluster
Snapshot Attributes Result Detailed information about the attributes that are associated with a cluster snapshot.
- DBCluster
Snapshot Message Represents the output of DescribeDBClusterSnapshots.
- DBEngine
Version Detailed information about an engine version.
- DBEngine
Version Message Represents the output of DescribeDBEngineVersions.
- DBInstance
Detailed information about an instance.
- DBInstance
Message Represents the output of DescribeDBInstances.
- DBInstance
Status Info Provides a list of status information for an instance.
- DBSubnet
Group Detailed information about a subnet group.
- DBSubnet
Group Message Represents the output of DescribeDBSubnetGroups.
- DeleteDB
Cluster Message Represents the input to DeleteDBCluster.
- DeleteDB
Cluster Parameter Group Message Represents the input to DeleteDBClusterParameterGroup.
- DeleteDB
Cluster Result - DeleteDB
Cluster Snapshot Message Represents the input to DeleteDBClusterSnapshot.
- DeleteDB
Cluster Snapshot Result - DeleteDB
Instance Message Represents the input to DeleteDBInstance.
- DeleteDB
Instance Result - DeleteDB
Subnet Group Message Represents the input to DeleteDBSubnetGroup.
- Delete
Event Subscription Message Represents the input to DeleteEventSubscription.
- Delete
Event Subscription Result - Delete
Global Cluster Message Represents the input to DeleteGlobalCluster.
- Delete
Global Cluster Result - Describe
Certificates Message - DescribeDB
Cluster Parameter Groups Message Represents the input to DescribeDBClusterParameterGroups.
- DescribeDB
Cluster Parameters Message Represents the input to DescribeDBClusterParameters.
- DescribeDB
Cluster Snapshot Attributes Message Represents the input to DescribeDBClusterSnapshotAttributes.
- DescribeDB
Cluster Snapshot Attributes Result - DescribeDB
Cluster Snapshots Message Represents the input to DescribeDBClusterSnapshots.
- DescribeDB
Clusters Message Represents the input to DescribeDBClusters.
- DescribeDB
Engine Versions Message Represents the input to DescribeDBEngineVersions.
- DescribeDB
Instances Message Represents the input to DescribeDBInstances.
- DescribeDB
Subnet Groups Message Represents the input to DescribeDBSubnetGroups.
- Describe
Engine Default Cluster Parameters Message Represents the input to DescribeEngineDefaultClusterParameters.
- Describe
Engine Default Cluster Parameters Result - Describe
Event Categories Message Represents the input to DescribeEventCategories.
- Describe
Event Subscriptions Message Represents the input to DescribeEventSubscriptions.
- Describe
Events Message Represents the input to DescribeEvents.
- Describe
Global Clusters Message - Describe
OrderableDB Instance Options Message Represents the input to DescribeOrderableDBInstanceOptions.
- Describe
Pending Maintenance Actions Message Represents the input to DescribePendingMaintenanceActions.
- Docdb
Client - A client for the Amazon DocDB API.
- Endpoint
Network information for accessing a cluster or instance. Client programs must specify a valid endpoint to access these Amazon DocumentDB resources.
- Engine
Defaults Contains the result of a successful invocation of the
DescribeEngineDefaultClusterParametersoperation.- Event
Detailed information about an event.
- Event
Categories Map An event source type, accompanied by one or more event category names.
- Event
Categories Message Represents the output of DescribeEventCategories.
- Event
Subscription Detailed information about an event to which you have subscribed.
- Event
Subscriptions Message Represents the output of DescribeEventSubscriptions.
- Events
Message Represents the output of DescribeEvents.
- FailoverDB
Cluster Message Represents the input to FailoverDBCluster.
- FailoverDB
Cluster Result - Filter
A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
- Global
Cluster A data type representing an Amazon DocumentDB global cluster.
- Global
Cluster Member A data structure with information about any primary and secondary clusters associated with an Amazon DocumentDB global clusters.
- Global
Clusters Message - List
Tags ForResource Message Represents the input to ListTagsForResource.
- ModifyDB
Cluster Message Represents the input to ModifyDBCluster.
- ModifyDB
Cluster Parameter Group Message Represents the input to ModifyDBClusterParameterGroup.
- ModifyDB
Cluster Result - ModifyDB
Cluster Snapshot Attribute Message Represents the input to ModifyDBClusterSnapshotAttribute.
- ModifyDB
Cluster Snapshot Attribute Result - ModifyDB
Instance Message Represents the input to ModifyDBInstance.
- ModifyDB
Instance Result - ModifyDB
Subnet Group Message Represents the input to ModifyDBSubnetGroup.
- ModifyDB
Subnet Group Result - Modify
Event Subscription Message Represents the input to ModifyEventSubscription.
- Modify
Event Subscription Result - Modify
Global Cluster Message Represents the input to ModifyGlobalCluster.
- Modify
Global Cluster Result - OrderableDB
Instance Option The options that are available for an instance.
- OrderableDB
Instance Options Message Represents the output of DescribeOrderableDBInstanceOptions.
- Parameter
Detailed information about an individual parameter.
- Pending
Cloudwatch Logs Exports A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.
- Pending
Maintenance Action Provides information about a pending maintenance action for a resource.
- Pending
Maintenance Actions Message Represents the output of DescribePendingMaintenanceActions.
- Pending
Modified Values One or more modified settings for an instance. These modified settings have been requested, but haven't been applied yet.
- RebootDB
Instance Message Represents the input to RebootDBInstance.
- RebootDB
Instance Result - Remove
From Global Cluster Message Represents the input to RemoveFromGlobalCluster.
- Remove
From Global Cluster Result - Remove
Source Identifier From Subscription Message Represents the input to RemoveSourceIdentifierFromSubscription.
- Remove
Source Identifier From Subscription Result - Remove
Tags From Resource Message Represents the input to RemoveTagsFromResource.
- ResetDB
Cluster Parameter Group Message Represents the input to ResetDBClusterParameterGroup.
- Resource
Pending Maintenance Actions Represents the output of ApplyPendingMaintenanceAction.
- RestoreDB
Cluster From Snapshot Message Represents the input to RestoreDBClusterFromSnapshot.
- RestoreDB
Cluster From Snapshot Result - RestoreDB
Cluster ToPoint InTime Message Represents the input to RestoreDBClusterToPointInTime.
- RestoreDB
Cluster ToPoint InTime Result - StartDB
Cluster Message - StartDB
Cluster Result - StopDB
Cluster Message - StopDB
Cluster Result - Subnet
Detailed information about a subnet.
- Tag
Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.
- TagList
Message Represents the output of ListTagsForResource.
- Upgrade
Target The version of the database engine that an instance can be upgraded to.
- VpcSecurity
Group Membership Used as a response element for queries on virtual private cloud (VPC) security group membership.
Enums§
- AddSource
Identifier ToSubscription Error - Errors returned by AddSourceIdentifierToSubscription
- AddTags
ToResource Error - Errors returned by AddTagsToResource
- Apply
Pending Maintenance Action Error - Errors returned by ApplyPendingMaintenanceAction
- CopyDB
Cluster Parameter Group Error - Errors returned by CopyDBClusterParameterGroup
- CopyDB
Cluster Snapshot Error - Errors returned by CopyDBClusterSnapshot
- CreateDB
Cluster Error - Errors returned by CreateDBCluster
- CreateDB
Cluster Parameter Group Error - Errors returned by CreateDBClusterParameterGroup
- CreateDB
Cluster Snapshot Error - Errors returned by CreateDBClusterSnapshot
- CreateDB
Instance Error - Errors returned by CreateDBInstance
- CreateDB
Subnet Group Error - Errors returned by CreateDBSubnetGroup
- Create
Event Subscription Error - Errors returned by CreateEventSubscription
- Create
Global Cluster Error - Errors returned by CreateGlobalCluster
- DeleteDB
Cluster Error - Errors returned by DeleteDBCluster
- DeleteDB
Cluster Parameter Group Error - Errors returned by DeleteDBClusterParameterGroup
- DeleteDB
Cluster Snapshot Error - Errors returned by DeleteDBClusterSnapshot
- DeleteDB
Instance Error - Errors returned by DeleteDBInstance
- DeleteDB
Subnet Group Error - Errors returned by DeleteDBSubnetGroup
- Delete
Event Subscription Error - Errors returned by DeleteEventSubscription
- Delete
Global Cluster Error - Errors returned by DeleteGlobalCluster
- Describe
Certificates Error - Errors returned by DescribeCertificates
- DescribeDB
Cluster Parameter Groups Error - Errors returned by DescribeDBClusterParameterGroups
- DescribeDB
Cluster Parameters Error - Errors returned by DescribeDBClusterParameters
- DescribeDB
Cluster Snapshot Attributes Error - Errors returned by DescribeDBClusterSnapshotAttributes
- DescribeDB
Cluster Snapshots Error - Errors returned by DescribeDBClusterSnapshots
- DescribeDB
Clusters Error - Errors returned by DescribeDBClusters
- DescribeDB
Engine Versions Error - Errors returned by DescribeDBEngineVersions
- DescribeDB
Instances Error - Errors returned by DescribeDBInstances
- DescribeDB
Subnet Groups Error - Errors returned by DescribeDBSubnetGroups
- Describe
Engine Default Cluster Parameters Error - Errors returned by DescribeEngineDefaultClusterParameters
- Describe
Event Categories Error - Errors returned by DescribeEventCategories
- Describe
Event Subscriptions Error - Errors returned by DescribeEventSubscriptions
- Describe
Events Error - Errors returned by DescribeEvents
- Describe
Global Clusters Error - Errors returned by DescribeGlobalClusters
- Describe
OrderableDB Instance Options Error - Errors returned by DescribeOrderableDBInstanceOptions
- Describe
Pending Maintenance Actions Error - Errors returned by DescribePendingMaintenanceActions
- FailoverDB
Cluster Error - Errors returned by FailoverDBCluster
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- ModifyDB
Cluster Error - Errors returned by ModifyDBCluster
- ModifyDB
Cluster Parameter Group Error - Errors returned by ModifyDBClusterParameterGroup
- ModifyDB
Cluster Snapshot Attribute Error - Errors returned by ModifyDBClusterSnapshotAttribute
- ModifyDB
Instance Error - Errors returned by ModifyDBInstance
- ModifyDB
Subnet Group Error - Errors returned by ModifyDBSubnetGroup
- Modify
Event Subscription Error - Errors returned by ModifyEventSubscription
- Modify
Global Cluster Error - Errors returned by ModifyGlobalCluster
- RebootDB
Instance Error - Errors returned by RebootDBInstance
- Remove
From Global Cluster Error - Errors returned by RemoveFromGlobalCluster
- Remove
Source Identifier From Subscription Error - Errors returned by RemoveSourceIdentifierFromSubscription
- Remove
Tags From Resource Error - Errors returned by RemoveTagsFromResource
- ResetDB
Cluster Parameter Group Error - Errors returned by ResetDBClusterParameterGroup
- RestoreDB
Cluster From Snapshot Error - Errors returned by RestoreDBClusterFromSnapshot
- RestoreDB
Cluster ToPoint InTime Error - Errors returned by RestoreDBClusterToPointInTime
- StartDB
Cluster Error - Errors returned by StartDBCluster
- StopDB
Cluster Error - Errors returned by StopDBCluster
Traits§
- Docdb
- Trait representing the capabilities of the Amazon DocDB API. Amazon DocDB clients implement this trait.