Awso_docdb_eioSourceval add_source_identifier_to_subscription :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.AddSourceIdentifierToSubscriptionMessage.t ->
(Awso_docdb.Values.AddSourceIdentifierToSubscriptionResult.t,
Awso_docdb.Values.AddSourceIdentifierToSubscriptionResult.error)
Result.tval add_tags_to_resource :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.AddTagsToResourceMessage.t ->
(unit, unit) Result.tval apply_pending_maintenance_action :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.ApplyPendingMaintenanceActionMessage.t ->
(Awso_docdb.Values.ApplyPendingMaintenanceActionResult.t,
Awso_docdb.Values.ApplyPendingMaintenanceActionResult.error)
Result.tval copy_d_b_cluster_parameter_group :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.CopyDBClusterParameterGroupMessage.t ->
(Awso_docdb.Values.CopyDBClusterParameterGroupResult.t,
Awso_docdb.Values.CopyDBClusterParameterGroupResult.error)
Result.tval copy_d_b_cluster_snapshot :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.CopyDBClusterSnapshotMessage.t ->
(Awso_docdb.Values.CopyDBClusterSnapshotResult.t,
Awso_docdb.Values.CopyDBClusterSnapshotResult.error)
Result.tval create_d_b_cluster :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.CreateDBClusterMessage.t ->
(Awso_docdb.Values.CreateDBClusterResult.t,
Awso_docdb.Values.CreateDBClusterResult.error)
Result.tval create_d_b_cluster_parameter_group :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.CreateDBClusterParameterGroupMessage.t ->
(Awso_docdb.Values.CreateDBClusterParameterGroupResult.t,
Awso_docdb.Values.CreateDBClusterParameterGroupResult.error)
Result.tval create_d_b_cluster_snapshot :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.CreateDBClusterSnapshotMessage.t ->
(Awso_docdb.Values.CreateDBClusterSnapshotResult.t,
Awso_docdb.Values.CreateDBClusterSnapshotResult.error)
Result.tval create_d_b_instance :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.CreateDBInstanceMessage.t ->
(Awso_docdb.Values.CreateDBInstanceResult.t,
Awso_docdb.Values.CreateDBInstanceResult.error)
Result.tval create_d_b_subnet_group :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.CreateDBSubnetGroupMessage.t ->
(Awso_docdb.Values.CreateDBSubnetGroupResult.t,
Awso_docdb.Values.CreateDBSubnetGroupResult.error)
Result.tval create_event_subscription :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.CreateEventSubscriptionMessage.t ->
(Awso_docdb.Values.CreateEventSubscriptionResult.t,
Awso_docdb.Values.CreateEventSubscriptionResult.error)
Result.tval create_global_cluster :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.CreateGlobalClusterMessage.t ->
(Awso_docdb.Values.CreateGlobalClusterResult.t,
Awso_docdb.Values.CreateGlobalClusterResult.error)
Result.tval delete_d_b_cluster :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.DeleteDBClusterMessage.t ->
(Awso_docdb.Values.DeleteDBClusterResult.t,
Awso_docdb.Values.DeleteDBClusterResult.error)
Result.tval delete_d_b_cluster_parameter_group :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.DeleteDBClusterParameterGroupMessage.t ->
(unit, unit) Result.tval delete_d_b_cluster_snapshot :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.DeleteDBClusterSnapshotMessage.t ->
(Awso_docdb.Values.DeleteDBClusterSnapshotResult.t,
Awso_docdb.Values.DeleteDBClusterSnapshotResult.error)
Result.tval delete_d_b_instance :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.DeleteDBInstanceMessage.t ->
(Awso_docdb.Values.DeleteDBInstanceResult.t,
Awso_docdb.Values.DeleteDBInstanceResult.error)
Result.tval delete_d_b_subnet_group :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.DeleteDBSubnetGroupMessage.t ->
(unit, unit) Result.tval delete_event_subscription :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.DeleteEventSubscriptionMessage.t ->
(Awso_docdb.Values.DeleteEventSubscriptionResult.t,
Awso_docdb.Values.DeleteEventSubscriptionResult.error)
Result.tval delete_global_cluster :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.DeleteGlobalClusterMessage.t ->
(Awso_docdb.Values.DeleteGlobalClusterResult.t,
Awso_docdb.Values.DeleteGlobalClusterResult.error)
Result.tval describe_certificates :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.DescribeCertificatesMessage.t ->
(Awso_docdb.Values.CertificateMessage.t,
Awso_docdb.Values.CertificateMessage.error)
Result.tval describe_d_b_cluster_parameter_groups :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.DescribeDBClusterParameterGroupsMessage.t ->
(Awso_docdb.Values.DBClusterParameterGroupsMessage.t,
Awso_docdb.Values.DBClusterParameterGroupsMessage.error)
Result.tval describe_d_b_cluster_parameters :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.DescribeDBClusterParametersMessage.t ->
(Awso_docdb.Values.DBClusterParameterGroupDetails.t,
Awso_docdb.Values.DBClusterParameterGroupDetails.error)
Result.tval describe_d_b_cluster_snapshot_attributes :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.DescribeDBClusterSnapshotAttributesMessage.t ->
(Awso_docdb.Values.DescribeDBClusterSnapshotAttributesResult.t,
Awso_docdb.Values.DescribeDBClusterSnapshotAttributesResult.error)
Result.tval describe_d_b_cluster_snapshots :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.DescribeDBClusterSnapshotsMessage.t ->
(Awso_docdb.Values.DBClusterSnapshotMessage.t,
Awso_docdb.Values.DBClusterSnapshotMessage.error)
Result.tval describe_d_b_clusters :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.DescribeDBClustersMessage.t ->
(Awso_docdb.Values.DBClusterMessage.t,
Awso_docdb.Values.DBClusterMessage.error)
Result.tval describe_d_b_engine_versions :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.DescribeDBEngineVersionsMessage.t ->
(Awso_docdb.Values.DBEngineVersionMessage.t,
Awso_docdb.Values.DBEngineVersionMessage.error)
Result.tval describe_d_b_instances :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.DescribeDBInstancesMessage.t ->
(Awso_docdb.Values.DBInstanceMessage.t,
Awso_docdb.Values.DBInstanceMessage.error)
Result.tval describe_d_b_subnet_groups :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.DescribeDBSubnetGroupsMessage.t ->
(Awso_docdb.Values.DBSubnetGroupMessage.t,
Awso_docdb.Values.DBSubnetGroupMessage.error)
Result.tval describe_engine_default_cluster_parameters :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.DescribeEngineDefaultClusterParametersMessage.t ->
(Awso_docdb.Values.DescribeEngineDefaultClusterParametersResult.t,
Awso_docdb.Values.DescribeEngineDefaultClusterParametersResult.error)
Result.tval describe_event_categories :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.DescribeEventCategoriesMessage.t ->
(Awso_docdb.Values.EventCategoriesMessage.t,
Awso_docdb.Values.EventCategoriesMessage.error)
Result.tval describe_event_subscriptions :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.DescribeEventSubscriptionsMessage.t ->
(Awso_docdb.Values.EventSubscriptionsMessage.t,
Awso_docdb.Values.EventSubscriptionsMessage.error)
Result.tval describe_events :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.DescribeEventsMessage.t ->
(Awso_docdb.Values.EventsMessage.t, Awso_docdb.Values.EventsMessage.error)
Result.tval describe_global_clusters :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.DescribeGlobalClustersMessage.t ->
(Awso_docdb.Values.GlobalClustersMessage.t,
Awso_docdb.Values.GlobalClustersMessage.error)
Result.tval describe_orderable_d_b_instance_options :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.DescribeOrderableDBInstanceOptionsMessage.t ->
(Awso_docdb.Values.OrderableDBInstanceOptionsMessage.t,
Awso_docdb.Values.OrderableDBInstanceOptionsMessage.error)
Result.tval describe_pending_maintenance_actions :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.DescribePendingMaintenanceActionsMessage.t ->
(Awso_docdb.Values.PendingMaintenanceActionsMessage.t,
Awso_docdb.Values.PendingMaintenanceActionsMessage.error)
Result.tval failover_d_b_cluster :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.FailoverDBClusterMessage.t ->
(Awso_docdb.Values.FailoverDBClusterResult.t,
Awso_docdb.Values.FailoverDBClusterResult.error)
Result.tval failover_global_cluster :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.FailoverGlobalClusterMessage.t ->
(Awso_docdb.Values.FailoverGlobalClusterResult.t,
Awso_docdb.Values.FailoverGlobalClusterResult.error)
Result.tval list_tags_for_resource :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.ListTagsForResourceMessage.t ->
(Awso_docdb.Values.TagListMessage.t, Awso_docdb.Values.TagListMessage.error)
Result.tval modify_d_b_cluster :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.ModifyDBClusterMessage.t ->
(Awso_docdb.Values.ModifyDBClusterResult.t,
Awso_docdb.Values.ModifyDBClusterResult.error)
Result.tval modify_d_b_cluster_parameter_group :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.ModifyDBClusterParameterGroupMessage.t ->
(Awso_docdb.Values.DBClusterParameterGroupNameMessage.t,
Awso_docdb.Values.DBClusterParameterGroupNameMessage.error)
Result.tval modify_d_b_cluster_snapshot_attribute :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.ModifyDBClusterSnapshotAttributeMessage.t ->
(Awso_docdb.Values.ModifyDBClusterSnapshotAttributeResult.t,
Awso_docdb.Values.ModifyDBClusterSnapshotAttributeResult.error)
Result.tval modify_d_b_instance :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.ModifyDBInstanceMessage.t ->
(Awso_docdb.Values.ModifyDBInstanceResult.t,
Awso_docdb.Values.ModifyDBInstanceResult.error)
Result.tval modify_d_b_subnet_group :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.ModifyDBSubnetGroupMessage.t ->
(Awso_docdb.Values.ModifyDBSubnetGroupResult.t,
Awso_docdb.Values.ModifyDBSubnetGroupResult.error)
Result.tval modify_event_subscription :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.ModifyEventSubscriptionMessage.t ->
(Awso_docdb.Values.ModifyEventSubscriptionResult.t,
Awso_docdb.Values.ModifyEventSubscriptionResult.error)
Result.tval modify_global_cluster :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.ModifyGlobalClusterMessage.t ->
(Awso_docdb.Values.ModifyGlobalClusterResult.t,
Awso_docdb.Values.ModifyGlobalClusterResult.error)
Result.tval reboot_d_b_instance :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.RebootDBInstanceMessage.t ->
(Awso_docdb.Values.RebootDBInstanceResult.t,
Awso_docdb.Values.RebootDBInstanceResult.error)
Result.tval remove_from_global_cluster :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.RemoveFromGlobalClusterMessage.t ->
(Awso_docdb.Values.RemoveFromGlobalClusterResult.t,
Awso_docdb.Values.RemoveFromGlobalClusterResult.error)
Result.tval remove_source_identifier_from_subscription :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.RemoveSourceIdentifierFromSubscriptionMessage.t ->
(Awso_docdb.Values.RemoveSourceIdentifierFromSubscriptionResult.t,
Awso_docdb.Values.RemoveSourceIdentifierFromSubscriptionResult.error)
Result.tval remove_tags_from_resource :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.RemoveTagsFromResourceMessage.t ->
(unit, unit) Result.tval reset_d_b_cluster_parameter_group :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.ResetDBClusterParameterGroupMessage.t ->
(Awso_docdb.Values.DBClusterParameterGroupNameMessage.t,
Awso_docdb.Values.DBClusterParameterGroupNameMessage.error)
Result.tval restore_d_b_cluster_from_snapshot :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.RestoreDBClusterFromSnapshotMessage.t ->
(Awso_docdb.Values.RestoreDBClusterFromSnapshotResult.t,
Awso_docdb.Values.RestoreDBClusterFromSnapshotResult.error)
Result.tval restore_d_b_cluster_to_point_in_time :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.RestoreDBClusterToPointInTimeMessage.t ->
(Awso_docdb.Values.RestoreDBClusterToPointInTimeResult.t,
Awso_docdb.Values.RestoreDBClusterToPointInTimeResult.error)
Result.tval start_d_b_cluster :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.StartDBClusterMessage.t ->
(Awso_docdb.Values.StartDBClusterResult.t,
Awso_docdb.Values.StartDBClusterResult.error)
Result.tval stop_d_b_cluster :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.StopDBClusterMessage.t ->
(Awso_docdb.Values.StopDBClusterResult.t,
Awso_docdb.Values.StopDBClusterResult.error)
Result.tval switchover_global_cluster :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_docdb.Values.SwitchoverGlobalClusterMessage.t ->
(Awso_docdb.Values.SwitchoverGlobalClusterResult.t,
Awso_docdb.Values.SwitchoverGlobalClusterResult.error)
Result.tinclude module type of struct include Awso_docdb.Values endval structure_to_value_aux :
('a * 'b option) list ->
f:(('a * 'b) list -> 'c) ->
[> `Structure of 'c ]val structure_to_wrapped_value :
wrapper:'a ->
response:'a ->
('b * 'c option) list ->
[> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]Information about an Availability Zone.
module GlobalClusterMemberSynchronizationStatus =
Awso_docdb.Values.GlobalClusterMemberSynchronizationStatusDetailed information about a subnet.
Provides information about a pending maintenance action for a resource.
A data structure with information about any primary and secondary clusters associated with an Amazon DocumentDB global clusters.
Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.
Provides a list of status information for an instance.
A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.
Used as a response element for queries on virtual private cloud (VPC) security group membership.
The version of the database engine that an instance can be upgraded to.
Contains information about an instance that is part of a cluster.
Describes an Identity and Access Management (IAM) role that is associated with a cluster.
Contains the name and values of a manual cluster snapshot attribute. Manual cluster snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual cluster snapshot.
Contains the state of scheduled or in-process operations on an Amazon DocumentDB global cluster. This data type is empty unless a switchover or failover operation is scheduled or is in progress on the global cluster.
Detailed information about an individual parameter.
Returns the details of the DB instance’s server certificate. For more information, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide.
Detailed information about a subnet group.
Network information for accessing a cluster or instance. Client programs must specify a valid endpoint to access these Amazon DocumentDB resources.
One or more modified settings for an instance. These modified settings have been requested, but haven't been applied yet.
Specifies any Amazon DocumentDB Serverless properties or limits that differ between Amazon DocumentDB engine versions. You can test the values of this attribute when deciding which Amazon DocumentDB version to use in a new or upgraded cluster. You can also retrieve the version of an existing cluster and check whether that version supports certain Amazon DocumentDB Serverless features before you attempt to use those features.
Contains the secret managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the master user password.
module ServerlessV2ScalingConfigurationInfo =
Awso_docdb.Values.ServerlessV2ScalingConfigurationInfoRetrieves the scaling configuration for an Amazon DocumentDB Serverless cluster.
module ResourcePendingMaintenanceActions =
Awso_docdb.Values.ResourcePendingMaintenanceActionsRepresents the output of ApplyPendingMaintenanceAction.
The options that are available for an instance.
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.
A data type representing an Amazon DocumentDB global cluster.
Detailed information about an event.
Detailed information about an event to which you have subscribed.
An event source type, accompanied by one or more event category names.
Detailed information about an instance.
Detailed information about an engine version.
Detailed information about a cluster snapshot.
Detailed information about a cluster parameter group.
Detailed information about a cluster.
A certificate authority (CA) certificate for an Amazon Web Services account.
DBClusterIdentifier doesn't refer to an existing cluster.
DBInstanceIdentifier doesn't refer to an existing instance.
DBSnapshotIdentifier doesn't refer to an existing snapshot.
The GlobalClusterIdentifier doesn't refer to an existing global cluster.
The cluster isn't in a valid state.
The requested operation can't be performed while the cluster is in this state.
The specified instance isn't in the available state.
You already have a cluster with the given identifier.
The cluster can't be created because you have reached the maximum allowed quota of clusters.
DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.
DBSubnetGroupName doesn't refer to an existing subnet group.
module InsufficientDBClusterCapacityFault =
Awso_docdb.Values.InsufficientDBClusterCapacityFaultThe cluster doesn't have enough capacity for the current operation.
module InsufficientStorageClusterCapacityFault =
Awso_docdb.Values.InsufficientStorageClusterCapacityFaultThere is not enough storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.
module InvalidDBClusterSnapshotStateFault =
Awso_docdb.Values.InvalidDBClusterSnapshotStateFaultThe provided value isn't a valid cluster snapshot state.
The state of the snapshot doesn't allow deletion.
You cannot restore from a virtual private cloud (VPC) backup to a non-VPC DB instance.
The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).
The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.
An error occurred when accessing an KMS key.
The network type is not supported by either DBSubnetGroup or the DB engine version.
The request would cause you to exceed the allowed amount of storage available across all instances.
Sets the scaling configuration of an Amazon DocumentDB Serverless cluster.
The requested source could not be found.
The subscription name does not exist.
The specified resource ID was not found.
module EventSubscriptionQuotaExceededFault =
Awso_docdb.Values.EventSubscriptionQuotaExceededFaultYou have reached the maximum number of event subscriptions.
Amazon SNS has responded that there is a problem with the specified topic.
You do not have permission to publish to the SNS topic Amazon Resource Name (ARN).
The SNS topic Amazon Resource Name (ARN) does not exist.
module SubscriptionCategoryNotFoundFault =
Awso_docdb.Values.SubscriptionCategoryNotFoundFaultThe provided category does not exist.
module DBSubnetGroupDoesNotCoverEnoughAZs =
Awso_docdb.Values.DBSubnetGroupDoesNotCoverEnoughAZsSubnets in the subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
The request would cause you to exceed the allowed number of subnets in a subnet group.
The subnet is already in use in the Availability Zone.
The specified CIDR IP or Amazon EC2 security group isn't authorized for the specified security group. Amazon DocumentDB also might not be authorized to perform necessary actions on your behalf using IAM.
CertificateIdentifier doesn't refer to an existing certificate.
You already have a instance with the given identifier.
DBParameterGroupName doesn't refer to an existing parameter group.
DBSecurityGroupName doesn't refer to an existing security group.
The upgrade failed because a resource that the depends on can't be modified.
module InsufficientDBInstanceCapacityFault =
Awso_docdb.Values.InsufficientDBInstanceCapacityFaultThe specified instance class isn't available in the specified Availability Zone.
The state of the security group doesn't allow deletion.
Storage of the specified StorageType can't be associated with the DB instance.
module DBClusterSnapshotAttributesResult =
Awso_docdb.Values.DBClusterSnapshotAttributesResultDetailed information about the attributes that are associated with a cluster snapshot.
You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.
module DBClusterParameterGroupNotFoundFault =
Awso_docdb.Values.DBClusterParameterGroupNotFoundFaultDBClusterParameterGroupName doesn't refer to an existing cluster parameter group.
The subnet group can't be deleted because it's in use.
module CloudwatchLogsExportConfiguration =
Awso_docdb.Values.CloudwatchLogsExportConfigurationThe configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster. The EnableLogTypes and DisableLogTypes arrays determine which logs are exported (or not exported) to CloudWatch Logs. The values within these arrays depend on the engine that is being used.
Contains the result of a successful invocation of the DescribeEngineDefaultClusterParameters operation.
module InvalidEventSubscriptionStateFault =
Awso_docdb.Values.InvalidEventSubscriptionStateFaultSomeone else might be modifying a subscription. Wait a few seconds, and try again.
DBSnapshotIdentifier is already being used by an existing snapshot.
The request would cause you to exceed the allowed number of snapshots.
module DBClusterSnapshotAlreadyExistsFault =
Awso_docdb.Values.DBClusterSnapshotAlreadyExistsFaultYou already have a cluster snapshot with the given identifier.
module InvalidDBParameterGroupStateFault =
Awso_docdb.Values.InvalidDBParameterGroupStateFaultThe parameter group is in use, or it is in a state that is not valid. If you are trying to delete the parameter group, you can't delete it when the parameter group is in this state.
The GlobalClusterIdentifier already exists. Choose a new global cluster identifier (unique name) to create a new global cluster.
The number of global clusters for this account is already at the maximum allowed.
The provided subscription name already exists.
DBSubnetGroupName is already being used by an existing subnet group.
The request would cause you to exceed the allowed number of subnet groups.
The request would cause you to exceed the allowed number of instances.
module DBParameterGroupAlreadyExistsFault =
Awso_docdb.Values.DBParameterGroupAlreadyExistsFaultA parameter group with the same name already exists.
module DBParameterGroupQuotaExceededFault =
Awso_docdb.Values.DBParameterGroupQuotaExceededFaultThis request would cause you to exceed the allowed number of parameter groups.
Represents the output of ListTagsForResource.
Switches over the specified secondary Amazon DocumentDB cluster to be the new primary Amazon DocumentDB cluster in the global database cluster.
Switches over the specified secondary Amazon DocumentDB cluster to be the new primary Amazon DocumentDB cluster in the global database cluster.
Stops the running cluster that is specified by DBClusterIdentifier. The cluster must be in the available state. For more information, see Stopping and Starting an Amazon DocumentDB Cluster.
Stops the running cluster that is specified by DBClusterIdentifier. The cluster must be in the available state. For more information, see Stopping and Starting an Amazon DocumentDB Cluster.
Restarts the stopped cluster that is specified by DBClusterIdentifier. For more information, see Stopping and Starting an Amazon DocumentDB Cluster.
Restarts the stopped cluster that is specified by DBClusterIdentifier. For more information, see Stopping and Starting an Amazon DocumentDB Cluster.
module RestoreDBClusterToPointInTimeResult =
Awso_docdb.Values.RestoreDBClusterToPointInTimeResultRestores a cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target cluster is created from the source cluster with the same configuration as the original cluster, except that the new cluster is created with the default security group.
module RestoreDBClusterToPointInTimeMessage =
Awso_docdb.Values.RestoreDBClusterToPointInTimeMessageRepresents the input to RestoreDBClusterToPointInTime.
module RestoreDBClusterFromSnapshotResult =
Awso_docdb.Values.RestoreDBClusterFromSnapshotResultCreates 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 default configuration and default security group. If a cluster snapshot is specified, the target cluster is created from the source cluster restore point with the same configuration as the original source DB cluster, except that the new cluster is created with the default security group.
module RestoreDBClusterFromSnapshotMessage =
Awso_docdb.Values.RestoreDBClusterFromSnapshotMessageRepresents the input to RestoreDBClusterFromSnapshot.
module ResetDBClusterParameterGroupMessage =
Awso_docdb.Values.ResetDBClusterParameterGroupMessageRepresents the input to ResetDBClusterParameterGroup.
Represents the input to RemoveTagsFromResource.
module RemoveSourceIdentifierFromSubscriptionResult =
Awso_docdb.Values.RemoveSourceIdentifierFromSubscriptionResultRemoves a source identifier from an existing Amazon DocumentDB event notification subscription.
module RemoveSourceIdentifierFromSubscriptionMessage =
Awso_docdb.Values.RemoveSourceIdentifierFromSubscriptionMessageRepresents the input to RemoveSourceIdentifierFromSubscription.
Detaches an Amazon DocumentDB secondary cluster from a global cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary in a different region. This action only applies to Amazon DocumentDB clusters.
Represents the input to RemoveFromGlobalCluster.
You might need to reboot your instance, usually for maintenance reasons. For example, if you make certain changes, or if you change the cluster parameter group that is associated with the instance, you must reboot the instance for the changes to take effect. Rebooting an instance restarts the database engine service. Rebooting an instance results in a momentary outage, during which the instance status is set to rebooting.
Represents the input to RebootDBInstance.
Represents the output of DescribePendingMaintenanceActions.
module OrderableDBInstanceOptionsMessage =
Awso_docdb.Values.OrderableDBInstanceOptionsMessageRepresents the output of DescribeOrderableDBInstanceOptions.
Modify a setting for an Amazon DocumentDB global cluster. You can change one or more configuration parameters (for example: deletion protection), or the global cluster identifier by specifying these parameters and the new values in the request. This action only applies to Amazon DocumentDB clusters.
Represents the input to ModifyGlobalCluster.
Modifies an existing Amazon DocumentDB event notification subscription.
Represents the input to ModifyEventSubscription.
Modifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.
Represents the input to ModifyDBSubnetGroup.
Modifies settings for an instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
Represents the input to ModifyDBInstance.
module ModifyDBClusterSnapshotAttributeResult =
Awso_docdb.Values.ModifyDBClusterSnapshotAttributeResultAdds 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 Services accounts, specify restore as the AttributeName, and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual cluster snapshot. Use the value all to make the manual cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services accounts. Do not add the all value for any manual cluster snapshots that contain private information that you don't want available to all Amazon Web Services accounts. If a manual cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.
module ModifyDBClusterSnapshotAttributeMessage =
Awso_docdb.Values.ModifyDBClusterSnapshotAttributeMessageRepresents the input to ModifyDBClusterSnapshotAttribute.
Modifies a setting for an Amazon DocumentDB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
module ModifyDBClusterParameterGroupMessage =
Awso_docdb.Values.ModifyDBClusterParameterGroupMessageRepresents the input to ModifyDBClusterParameterGroup.
Represents the input to ModifyDBCluster.
Represents the input to ListTagsForResource.
The subnet isn't in the available state.
Returns information about Amazon DocumentDB global clusters. This API supports pagination. This action only applies to Amazon DocumentDB clusters.
Promotes 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 to respond to an unplanned event, such as a regional disaster in the primary region. Failing over can result in a loss of write transaction data that wasn't replicated to the chosen secondary before the failover event occurred. However, the recovery process that promotes a DB instance on the chosen seconday DB cluster to be the primary writer DB instance guarantees that the data is in a transactionally consistent state.
Promotes 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 to respond to an unplanned event, such as a regional disaster in the primary region. Failing over can result in a loss of write transaction data that wasn't replicated to the chosen secondary before the failover event occurred. However, the recovery process that promotes a DB instance on the chosen seconday DB cluster to be the primary writer DB instance guarantees that the data is in a transactionally consistent state.
Forces 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 primary instance (the cluster writer). If the primary instance fails, Amazon DocumentDB automatically fails over to an Amazon DocumentDB replica, if one exists. You can force a failover when you want to simulate a failure of a primary instance for testing.
Represents the input to FailoverDBCluster.
Represents the output of DescribeEvents.
Represents the output of DescribeEventSubscriptions.
Represents the output of DescribeEventCategories.
module DescribePendingMaintenanceActionsMessage =
Awso_docdb.Values.DescribePendingMaintenanceActionsMessageRepresents the input to DescribePendingMaintenanceActions.
module DescribeOrderableDBInstanceOptionsMessage =
Awso_docdb.Values.DescribeOrderableDBInstanceOptionsMessageRepresents the input to DescribeOrderableDBInstanceOptions.
Returns information about Amazon DocumentDB global clusters. This API supports pagination. This action only applies to Amazon DocumentDB clusters.
Represents the input to DescribeEvents.
module DescribeEventSubscriptionsMessage =
Awso_docdb.Values.DescribeEventSubscriptionsMessageRepresents the input to DescribeEventSubscriptions.
Represents the input to DescribeEventCategories.
module DescribeEngineDefaultClusterParametersResult =
Awso_docdb.Values.DescribeEngineDefaultClusterParametersResultReturns the default engine and system parameter information for the cluster database engine.
module DescribeEngineDefaultClusterParametersMessage =
Awso_docdb.Values.DescribeEngineDefaultClusterParametersMessageRepresents the input to DescribeEngineDefaultClusterParameters.
Represents the input to DescribeDBSubnetGroups.
Represents the input to DescribeDBInstances.
Represents the input to DescribeDBEngineVersions.
Represents the input to DescribeDBClusters.
module DescribeDBClusterSnapshotsMessage =
Awso_docdb.Values.DescribeDBClusterSnapshotsMessageRepresents the input to DescribeDBClusterSnapshots.
module DescribeDBClusterSnapshotAttributesResult =
Awso_docdb.Values.DescribeDBClusterSnapshotAttributesResultReturns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot. When you share snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual cluster snapshot. If all is included in the list of values for the restore attribute, then the manual cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts.
module DescribeDBClusterSnapshotAttributesMessage =
Awso_docdb.Values.DescribeDBClusterSnapshotAttributesMessageRepresents the input to DescribeDBClusterSnapshotAttributes.
module DescribeDBClusterParametersMessage =
Awso_docdb.Values.DescribeDBClusterParametersMessageRepresents the input to DescribeDBClusterParameters.
module DescribeDBClusterParameterGroupsMessage =
Awso_docdb.Values.DescribeDBClusterParameterGroupsMessageRepresents the input to DescribeDBClusterParameterGroups.
Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web Services account.
Deletes a global cluster. The primary and secondary clusters must already be detached or deleted before attempting to delete a global cluster. This action only applies to Amazon DocumentDB clusters.
Represents the input to DeleteGlobalCluster.
Deletes an Amazon DocumentDB event notification subscription.
Represents the input to DeleteEventSubscription.
Represents the input to DeleteDBSubnetGroup.
Deletes a previously provisioned instance.
Represents the input to DeleteDBInstance.
Deletes 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 deleted.
Represents the input to DeleteDBClusterSnapshot.
Deletes a previously provisioned cluster. When you delete a cluster, all automated backups for that cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified cluster are not deleted.
module DeleteDBClusterParameterGroupMessage =
Awso_docdb.Values.DeleteDBClusterParameterGroupMessageRepresents the input to DeleteDBClusterParameterGroup.
Represents the input to DeleteDBCluster.
Represents the output of DescribeDBSubnetGroups.
Represents the output of DescribeDBInstances.
Represents the output of DescribeDBEngineVersions.
Represents the output of DescribeDBClusterSnapshots.
Represents the output of DBClusterParameterGroups.
module DBClusterParameterGroupNameMessage =
Awso_docdb.Values.DBClusterParameterGroupNameMessageContains the name of a cluster parameter group.
Represents the output of DBClusterParameterGroup.
Represents the output of DescribeDBClusters.
Creates an Amazon DocumentDB global cluster that can span multiple multiple Amazon Web Services Regions. The global cluster contains one primary cluster with read-write capability, and up-to 10 read-only secondary clusters. Global clusters uses storage-based fast replication across regions with latencies less than one second, using dedicated infrastructure with no impact to your workload’s performance. You can create a global cluster that is initially empty, and then add a primary and a secondary to it. Or you can specify an existing cluster during the create operation, and this cluster becomes the primary of the global cluster. This action only applies to Amazon DocumentDB clusters.
Represents the input to CreateGlobalCluster.
Creates an Amazon DocumentDB event notification subscription. This action requires a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the Amazon SNS console. You can specify the type of source (SourceType) that you want to be notified of. You can also provide a list of Amazon DocumentDB sources (SourceIds) that trigger the events, and you can provide a list of event categories (EventCategories) for events that you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup. If you specify both the SourceType and SourceIds (such as SourceType = db-instance and SourceIdentifier = myDBInstance1), you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your Amazon DocumentDB sources. If you do not specify either the SourceType or the SourceIdentifier, you are notified of events generated from all Amazon DocumentDB sources belonging to your customer account.
Represents the input to CreateEventSubscription.
Creates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.
Represents the input to CreateDBSubnetGroup.
Creates a new instance.
Represents the input to CreateDBInstance.
Creates a snapshot of a cluster.
Represents the input of CreateDBClusterSnapshot.
Creates a new Amazon DocumentDB cluster.
module CreateDBClusterParameterGroupResult =
Awso_docdb.Values.CreateDBClusterParameterGroupResultCreates 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 initially created with the default parameters for the database engine used by instances in the cluster. In Amazon DocumentDB, you cannot make modifications directly to the default.docdb3.6 cluster parameter group. If your Amazon DocumentDB cluster is using the default cluster parameter group and you want to modify a value in it, you must first create a new parameter group or copy an existing parameter group, modify it, and then apply the modified parameter group to your cluster. For the new cluster parameter group and associated settings to take effect, you must then reboot the instances in the cluster without failover. For more information, see Modifying Amazon DocumentDB Cluster Parameter Groups.
module CreateDBClusterParameterGroupMessage =
Awso_docdb.Values.CreateDBClusterParameterGroupMessageRepresents the input of CreateDBClusterParameterGroup.
Represents the input to CreateDBCluster.
Copies a snapshot of a cluster. To copy a cluster snapshot from a shared manual cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared cluster snapshot. You can only copy a shared DB cluster snapshot, whether encrypted or not, in the same Amazon Web Services Region. To cancel the copy operation after it is in progress, delete the target cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that cluster snapshot is in the copying status.
Represents the input to CopyDBClusterSnapshot.
module CopyDBClusterParameterGroupResult =
Awso_docdb.Values.CopyDBClusterParameterGroupResultCopies the specified cluster parameter group.
module CopyDBClusterParameterGroupMessage =
Awso_docdb.Values.CopyDBClusterParameterGroupMessageRepresents the input to CopyDBClusterParameterGroup.
Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web Services account.
module ApplyPendingMaintenanceActionResult =
Awso_docdb.Values.ApplyPendingMaintenanceActionResultApplies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).
module ApplyPendingMaintenanceActionMessage =
Awso_docdb.Values.ApplyPendingMaintenanceActionMessageRepresents the input to ApplyPendingMaintenanceAction.
Represents the input to AddTagsToResource.
module AddSourceIdentifierToSubscriptionResult =
Awso_docdb.Values.AddSourceIdentifierToSubscriptionResultAdds a source identifier to an existing event notification subscription.
module AddSourceIdentifierToSubscriptionMessage =
Awso_docdb.Values.AddSourceIdentifierToSubscriptionMessageRepresents the input to AddSourceIdentifierToSubscription.