/* * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ /* * Do not modify this file. This file is generated from the docdb-2014-10-31.normal.json service model. */ using System; using System.Threading; using System.Threading.Tasks; using System.Collections.Generic; using Amazon.Runtime; using Amazon.DocDB.Model; namespace Amazon.DocDB { /// /// Interface for accessing DocDB /// /// Amazon DocumentDB is a fast, reliable, and fully managed database service. Amazon /// DocumentDB makes it easy to set up, operate, and scale MongoDB-compatible databases /// in the cloud. With Amazon DocumentDB, you can run the same application code and use /// the same drivers and tools that you use with MongoDB. /// public partial interface IAmazonDocDB : IAmazonService, IDisposable { /// /// Paginators for the service /// IDocDBPaginatorFactory Paginators { get; } #region AddSourceIdentifierToSubscription /// /// Adds a source identifier to an existing event notification subscription. /// /// Container for the necessary parameters to execute the AddSourceIdentifierToSubscription service method. /// /// The response from the AddSourceIdentifierToSubscription service method, as returned by DocDB. /// /// The requested source could not be found. /// /// /// The subscription name does not exist. /// /// REST API Reference for AddSourceIdentifierToSubscription Operation AddSourceIdentifierToSubscriptionResponse AddSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest request); /// /// Adds a source identifier to an existing event notification subscription. /// /// Container for the necessary parameters to execute the AddSourceIdentifierToSubscription service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the AddSourceIdentifierToSubscription service method, as returned by DocDB. /// /// The requested source could not be found. /// /// /// The subscription name does not exist. /// /// REST API Reference for AddSourceIdentifierToSubscription Operation Task AddSourceIdentifierToSubscriptionAsync(AddSourceIdentifierToSubscriptionRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region AddTagsToResource /// /// Adds metadata tags to an Amazon DocumentDB resource. You can use these tags with cost /// allocation reporting to track costs that are associated with Amazon DocumentDB resources /// or in a Condition statement in an Identity and Access Management (IAM) /// policy for Amazon DocumentDB. /// /// Container for the necessary parameters to execute the AddTagsToResource service method. /// /// The response from the AddTagsToResource service method, as returned by DocDB. /// /// DBClusterIdentifier doesn't refer to an existing cluster. /// /// /// DBInstanceIdentifier doesn't refer to an existing instance. /// /// /// DBSnapshotIdentifier doesn't refer to an existing snapshot. /// /// REST API Reference for AddTagsToResource Operation AddTagsToResourceResponse AddTagsToResource(AddTagsToResourceRequest request); /// /// Adds metadata tags to an Amazon DocumentDB resource. You can use these tags with cost /// allocation reporting to track costs that are associated with Amazon DocumentDB resources /// or in a Condition statement in an Identity and Access Management (IAM) /// policy for Amazon DocumentDB. /// /// Container for the necessary parameters to execute the AddTagsToResource service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the AddTagsToResource service method, as returned by DocDB. /// /// DBClusterIdentifier doesn't refer to an existing cluster. /// /// /// DBInstanceIdentifier doesn't refer to an existing instance. /// /// /// DBSnapshotIdentifier doesn't refer to an existing snapshot. /// /// REST API Reference for AddTagsToResource Operation Task AddTagsToResourceAsync(AddTagsToResourceRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ApplyPendingMaintenanceAction /// /// Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB /// instance). /// /// Container for the necessary parameters to execute the ApplyPendingMaintenanceAction service method. /// /// The response from the ApplyPendingMaintenanceAction service method, as returned by DocDB. /// /// The cluster isn't in a valid state. /// /// /// The specified instance isn't in the available state. /// /// /// The specified resource ID was not found. /// /// REST API Reference for ApplyPendingMaintenanceAction Operation ApplyPendingMaintenanceActionResponse ApplyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest request); /// /// Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB /// instance). /// /// Container for the necessary parameters to execute the ApplyPendingMaintenanceAction service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ApplyPendingMaintenanceAction service method, as returned by DocDB. /// /// The cluster isn't in a valid state. /// /// /// The specified instance isn't in the available state. /// /// /// The specified resource ID was not found. /// /// REST API Reference for ApplyPendingMaintenanceAction Operation Task ApplyPendingMaintenanceActionAsync(ApplyPendingMaintenanceActionRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CopyDBClusterParameterGroup /// /// Copies the specified cluster parameter group. /// /// Container for the necessary parameters to execute the CopyDBClusterParameterGroup service method. /// /// The response from the CopyDBClusterParameterGroup service method, as returned by DocDB. /// /// A parameter group with the same name already exists. /// /// /// DBParameterGroupName doesn't refer to an existing parameter group. /// /// /// This request would cause you to exceed the allowed number of parameter groups. /// /// REST API Reference for CopyDBClusterParameterGroup Operation CopyDBClusterParameterGroupResponse CopyDBClusterParameterGroup(CopyDBClusterParameterGroupRequest request); /// /// Copies the specified cluster parameter group. /// /// Container for the necessary parameters to execute the CopyDBClusterParameterGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CopyDBClusterParameterGroup service method, as returned by DocDB. /// /// A parameter group with the same name already exists. /// /// /// DBParameterGroupName doesn't refer to an existing parameter group. /// /// /// This request would cause you to exceed the allowed number of parameter groups. /// /// REST API Reference for CopyDBClusterParameterGroup Operation Task CopyDBClusterParameterGroupAsync(CopyDBClusterParameterGroupRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CopyDBClusterSnapshot /// /// 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. /// /// /// Container for the necessary parameters to execute the CopyDBClusterSnapshot service method. /// /// The response from the CopyDBClusterSnapshot service method, as returned by DocDB. /// /// You already have a cluster snapshot with the given identifier. /// /// /// DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot. /// /// /// The provided value isn't a valid cluster snapshot state. /// /// /// The cluster isn't in a valid state. /// /// /// An error occurred when accessing an KMS key. /// /// /// The request would cause you to exceed the allowed number of snapshots. /// /// REST API Reference for CopyDBClusterSnapshot Operation CopyDBClusterSnapshotResponse CopyDBClusterSnapshot(CopyDBClusterSnapshotRequest request); /// /// 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. /// /// /// Container for the necessary parameters to execute the CopyDBClusterSnapshot service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CopyDBClusterSnapshot service method, as returned by DocDB. /// /// You already have a cluster snapshot with the given identifier. /// /// /// DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot. /// /// /// The provided value isn't a valid cluster snapshot state. /// /// /// The cluster isn't in a valid state. /// /// /// An error occurred when accessing an KMS key. /// /// /// The request would cause you to exceed the allowed number of snapshots. /// /// REST API Reference for CopyDBClusterSnapshot Operation Task CopyDBClusterSnapshotAsync(CopyDBClusterSnapshotRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateDBCluster /// /// Creates a new Amazon DocumentDB cluster. /// /// Container for the necessary parameters to execute the CreateDBCluster service method. /// /// The response from the CreateDBCluster service method, as returned by DocDB. /// /// You already have a cluster with the given identifier. /// /// /// DBClusterIdentifier doesn't refer to an existing cluster. /// /// /// DBClusterParameterGroupName doesn't refer to an existing cluster parameter /// group. /// /// /// The cluster can't be created because you have reached the maximum allowed quota of /// clusters. /// /// /// DBInstanceIdentifier doesn't refer to an existing instance. /// /// /// Subnets in the subnet group should cover at least two Availability Zones unless there /// is only one Availability Zone. /// /// /// DBSubnetGroupName doesn't refer to an existing subnet group. /// /// /// The GlobalClusterIdentifier doesn't refer to an existing global cluster. /// /// /// There 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. /// /// /// The cluster isn't in a valid state. /// /// /// The specified instance isn't in the available state. /// /// /// The subnet group can't be deleted because it's in use. /// /// /// The requested operation can't be performed while the cluster is in this state. /// /// /// 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 request would cause you to exceed the allowed amount of storage available across /// all instances. /// /// REST API Reference for CreateDBCluster Operation CreateDBClusterResponse CreateDBCluster(CreateDBClusterRequest request); /// /// Creates a new Amazon DocumentDB cluster. /// /// Container for the necessary parameters to execute the CreateDBCluster service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateDBCluster service method, as returned by DocDB. /// /// You already have a cluster with the given identifier. /// /// /// DBClusterIdentifier doesn't refer to an existing cluster. /// /// /// DBClusterParameterGroupName doesn't refer to an existing cluster parameter /// group. /// /// /// The cluster can't be created because you have reached the maximum allowed quota of /// clusters. /// /// /// DBInstanceIdentifier doesn't refer to an existing instance. /// /// /// Subnets in the subnet group should cover at least two Availability Zones unless there /// is only one Availability Zone. /// /// /// DBSubnetGroupName doesn't refer to an existing subnet group. /// /// /// The GlobalClusterIdentifier doesn't refer to an existing global cluster. /// /// /// There 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. /// /// /// The cluster isn't in a valid state. /// /// /// The specified instance isn't in the available state. /// /// /// The subnet group can't be deleted because it's in use. /// /// /// The requested operation can't be performed while the cluster is in this state. /// /// /// 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 request would cause you to exceed the allowed amount of storage available across /// all instances. /// /// REST API Reference for CreateDBCluster Operation Task CreateDBClusterAsync(CreateDBClusterRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateDBClusterParameterGroup /// /// Creates 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. /// /// /// Container for the necessary parameters to execute the CreateDBClusterParameterGroup service method. /// /// The response from the CreateDBClusterParameterGroup service method, as returned by DocDB. /// /// A parameter group with the same name already exists. /// /// /// This request would cause you to exceed the allowed number of parameter groups. /// /// REST API Reference for CreateDBClusterParameterGroup Operation CreateDBClusterParameterGroupResponse CreateDBClusterParameterGroup(CreateDBClusterParameterGroupRequest request); /// /// Creates 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. /// /// /// Container for the necessary parameters to execute the CreateDBClusterParameterGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateDBClusterParameterGroup service method, as returned by DocDB. /// /// A parameter group with the same name already exists. /// /// /// This request would cause you to exceed the allowed number of parameter groups. /// /// REST API Reference for CreateDBClusterParameterGroup Operation Task CreateDBClusterParameterGroupAsync(CreateDBClusterParameterGroupRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateDBClusterSnapshot /// /// Creates a snapshot of a cluster. /// /// Container for the necessary parameters to execute the CreateDBClusterSnapshot service method. /// /// The response from the CreateDBClusterSnapshot service method, as returned by DocDB. /// /// DBClusterIdentifier doesn't refer to an existing cluster. /// /// /// You already have a cluster snapshot with the given identifier. /// /// /// The provided value isn't a valid cluster snapshot state. /// /// /// The cluster isn't in a valid state. /// /// /// The request would cause you to exceed the allowed number of snapshots. /// /// REST API Reference for CreateDBClusterSnapshot Operation CreateDBClusterSnapshotResponse CreateDBClusterSnapshot(CreateDBClusterSnapshotRequest request); /// /// Creates a snapshot of a cluster. /// /// Container for the necessary parameters to execute the CreateDBClusterSnapshot service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateDBClusterSnapshot service method, as returned by DocDB. /// /// DBClusterIdentifier doesn't refer to an existing cluster. /// /// /// You already have a cluster snapshot with the given identifier. /// /// /// The provided value isn't a valid cluster snapshot state. /// /// /// The cluster isn't in a valid state. /// /// /// The request would cause you to exceed the allowed number of snapshots. /// /// REST API Reference for CreateDBClusterSnapshot Operation Task CreateDBClusterSnapshotAsync(CreateDBClusterSnapshotRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateDBInstance /// /// Creates a new instance. /// /// Container for the necessary parameters to execute the CreateDBInstance service method. /// /// The response from the CreateDBInstance service method, as returned by DocDB. /// /// 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. /// /// /// /// DBClusterIdentifier doesn't refer to an existing cluster. /// /// /// 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. /// /// /// Subnets in the subnet group should cover at least two Availability Zones unless there /// is only one Availability Zone. /// /// /// DBSubnetGroupName doesn't refer to an existing subnet group. /// /// /// The request would cause you to exceed the allowed number of instances. /// /// /// The specified instance class isn't available in the specified Availability Zone. /// /// /// The cluster isn't in a valid state. /// /// /// 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 request would cause you to exceed the allowed amount of storage available across /// all instances. /// /// /// Storage of the specified StorageType can't be associated with the DB /// instance. /// /// REST API Reference for CreateDBInstance Operation CreateDBInstanceResponse CreateDBInstance(CreateDBInstanceRequest request); /// /// Creates a new instance. /// /// Container for the necessary parameters to execute the CreateDBInstance service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateDBInstance service method, as returned by DocDB. /// /// 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. /// /// /// /// DBClusterIdentifier doesn't refer to an existing cluster. /// /// /// 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. /// /// /// Subnets in the subnet group should cover at least two Availability Zones unless there /// is only one Availability Zone. /// /// /// DBSubnetGroupName doesn't refer to an existing subnet group. /// /// /// The request would cause you to exceed the allowed number of instances. /// /// /// The specified instance class isn't available in the specified Availability Zone. /// /// /// The cluster isn't in a valid state. /// /// /// 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 request would cause you to exceed the allowed amount of storage available across /// all instances. /// /// /// Storage of the specified StorageType can't be associated with the DB /// instance. /// /// REST API Reference for CreateDBInstance Operation Task CreateDBInstanceAsync(CreateDBInstanceRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateDBSubnetGroup /// /// 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. /// /// Container for the necessary parameters to execute the CreateDBSubnetGroup service method. /// /// The response from the CreateDBSubnetGroup service method, as returned by DocDB. /// /// DBSubnetGroupName is already being used by an existing subnet group. /// /// /// Subnets 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 subnet groups. /// /// /// The request would cause you to exceed the allowed number of subnets in a subnet group. /// /// /// The requested subnet is not valid, or multiple subnets were requested that are not /// all in a common virtual private cloud (VPC). /// /// REST API Reference for CreateDBSubnetGroup Operation CreateDBSubnetGroupResponse CreateDBSubnetGroup(CreateDBSubnetGroupRequest request); /// /// 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. /// /// Container for the necessary parameters to execute the CreateDBSubnetGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateDBSubnetGroup service method, as returned by DocDB. /// /// DBSubnetGroupName is already being used by an existing subnet group. /// /// /// Subnets 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 subnet groups. /// /// /// The request would cause you to exceed the allowed number of subnets in a subnet group. /// /// /// The requested subnet is not valid, or multiple subnets were requested that are not /// all in a common virtual private cloud (VPC). /// /// REST API Reference for CreateDBSubnetGroup Operation Task CreateDBSubnetGroupAsync(CreateDBSubnetGroupRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateEventSubscription /// /// 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. /// /// /// Container for the necessary parameters to execute the CreateEventSubscription service method. /// /// The response from the CreateEventSubscription service method, as returned by DocDB. /// /// You 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. /// /// /// The requested source could not be found. /// /// /// The provided subscription name already exists. /// /// /// The provided category does not exist. /// /// REST API Reference for CreateEventSubscription Operation CreateEventSubscriptionResponse CreateEventSubscription(CreateEventSubscriptionRequest request); /// /// 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. /// /// /// Container for the necessary parameters to execute the CreateEventSubscription service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateEventSubscription service method, as returned by DocDB. /// /// You 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. /// /// /// The requested source could not be found. /// /// /// The provided subscription name already exists. /// /// /// The provided category does not exist. /// /// REST API Reference for CreateEventSubscription Operation Task CreateEventSubscriptionAsync(CreateEventSubscriptionRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateGlobalCluster /// /// 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 give 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. /// /// /// /// Container for the necessary parameters to execute the CreateGlobalCluster service method. /// /// The response from the CreateGlobalCluster service method, as returned by DocDB. /// /// DBClusterIdentifier doesn't refer to an existing cluster. /// /// /// 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 cluster isn't in a valid state. /// /// REST API Reference for CreateGlobalCluster Operation CreateGlobalClusterResponse CreateGlobalCluster(CreateGlobalClusterRequest request); /// /// 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 give 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. /// /// /// /// Container for the necessary parameters to execute the CreateGlobalCluster service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateGlobalCluster service method, as returned by DocDB. /// /// DBClusterIdentifier doesn't refer to an existing cluster. /// /// /// 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 cluster isn't in a valid state. /// /// REST API Reference for CreateGlobalCluster Operation Task CreateGlobalClusterAsync(CreateGlobalClusterRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteDBCluster /// /// 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. /// /// Container for the necessary parameters to execute the DeleteDBCluster service method. /// /// The response from the DeleteDBCluster service method, as returned by DocDB. /// /// DBClusterIdentifier doesn't refer to an existing cluster. /// /// /// You already have a cluster snapshot with the given identifier. /// /// /// The provided value isn't a valid cluster snapshot state. /// /// /// The cluster isn't in a valid state. /// /// /// The request would cause you to exceed the allowed number of snapshots. /// /// REST API Reference for DeleteDBCluster Operation DeleteDBClusterResponse DeleteDBCluster(DeleteDBClusterRequest request); /// /// 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. /// /// Container for the necessary parameters to execute the DeleteDBCluster service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteDBCluster service method, as returned by DocDB. /// /// DBClusterIdentifier doesn't refer to an existing cluster. /// /// /// You already have a cluster snapshot with the given identifier. /// /// /// The provided value isn't a valid cluster snapshot state. /// /// /// The cluster isn't in a valid state. /// /// /// The request would cause you to exceed the allowed number of snapshots. /// /// REST API Reference for DeleteDBCluster Operation Task DeleteDBClusterAsync(DeleteDBClusterRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteDBClusterParameterGroup /// /// Deletes a specified cluster parameter group. The cluster parameter group to be deleted /// can't be associated with any clusters. /// /// Container for the necessary parameters to execute the DeleteDBClusterParameterGroup service method. /// /// The response from the DeleteDBClusterParameterGroup service method, as returned by DocDB. /// /// DBParameterGroupName doesn't refer to an existing parameter group. /// /// /// The 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. /// /// REST API Reference for DeleteDBClusterParameterGroup Operation DeleteDBClusterParameterGroupResponse DeleteDBClusterParameterGroup(DeleteDBClusterParameterGroupRequest request); /// /// Deletes a specified cluster parameter group. The cluster parameter group to be deleted /// can't be associated with any clusters. /// /// Container for the necessary parameters to execute the DeleteDBClusterParameterGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteDBClusterParameterGroup service method, as returned by DocDB. /// /// DBParameterGroupName doesn't refer to an existing parameter group. /// /// /// The 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. /// /// REST API Reference for DeleteDBClusterParameterGroup Operation Task DeleteDBClusterParameterGroupAsync(DeleteDBClusterParameterGroupRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteDBClusterSnapshot /// /// 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. /// /// /// /// Container for the necessary parameters to execute the DeleteDBClusterSnapshot service method. /// /// The response from the DeleteDBClusterSnapshot service method, as returned by DocDB. /// /// DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot. /// /// /// The provided value isn't a valid cluster snapshot state. /// /// REST API Reference for DeleteDBClusterSnapshot Operation DeleteDBClusterSnapshotResponse DeleteDBClusterSnapshot(DeleteDBClusterSnapshotRequest request); /// /// 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. /// /// /// /// Container for the necessary parameters to execute the DeleteDBClusterSnapshot service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteDBClusterSnapshot service method, as returned by DocDB. /// /// DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot. /// /// /// The provided value isn't a valid cluster snapshot state. /// /// REST API Reference for DeleteDBClusterSnapshot Operation Task DeleteDBClusterSnapshotAsync(DeleteDBClusterSnapshotRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteDBInstance /// /// Deletes a previously provisioned instance. /// /// Container for the necessary parameters to execute the DeleteDBInstance service method. /// /// The response from the DeleteDBInstance service method, as returned by DocDB. /// /// DBInstanceIdentifier doesn't refer to an existing instance. /// /// /// DBSnapshotIdentifier is already being used by an existing snapshot. /// /// /// The cluster isn't in a valid state. /// /// /// The specified instance isn't in the available state. /// /// /// The request would cause you to exceed the allowed number of snapshots. /// /// REST API Reference for DeleteDBInstance Operation DeleteDBInstanceResponse DeleteDBInstance(DeleteDBInstanceRequest request); /// /// Deletes a previously provisioned instance. /// /// Container for the necessary parameters to execute the DeleteDBInstance service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteDBInstance service method, as returned by DocDB. /// /// DBInstanceIdentifier doesn't refer to an existing instance. /// /// /// DBSnapshotIdentifier is already being used by an existing snapshot. /// /// /// The cluster isn't in a valid state. /// /// /// The specified instance isn't in the available state. /// /// /// The request would cause you to exceed the allowed number of snapshots. /// /// REST API Reference for DeleteDBInstance Operation Task DeleteDBInstanceAsync(DeleteDBInstanceRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteDBSubnetGroup /// /// Deletes a subnet group. /// /// /// /// The specified database subnet group must not be associated with any DB instances. /// /// /// /// Container for the necessary parameters to execute the DeleteDBSubnetGroup service method. /// /// The response from the DeleteDBSubnetGroup service method, as returned by DocDB. /// /// DBSubnetGroupName doesn't refer to an existing subnet group. /// /// /// The subnet group can't be deleted because it's in use. /// /// /// The subnet isn't in the available state. /// /// REST API Reference for DeleteDBSubnetGroup Operation DeleteDBSubnetGroupResponse DeleteDBSubnetGroup(DeleteDBSubnetGroupRequest request); /// /// Deletes a subnet group. /// /// /// /// The specified database subnet group must not be associated with any DB instances. /// /// /// /// Container for the necessary parameters to execute the DeleteDBSubnetGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteDBSubnetGroup service method, as returned by DocDB. /// /// DBSubnetGroupName doesn't refer to an existing subnet group. /// /// /// The subnet group can't be deleted because it's in use. /// /// /// The subnet isn't in the available state. /// /// REST API Reference for DeleteDBSubnetGroup Operation Task DeleteDBSubnetGroupAsync(DeleteDBSubnetGroupRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteEventSubscription /// /// Deletes an Amazon DocumentDB event notification subscription. /// /// Container for the necessary parameters to execute the DeleteEventSubscription service method. /// /// The response from the DeleteEventSubscription service method, as returned by DocDB. /// /// Someone else might be modifying a subscription. Wait a few seconds, and try again. /// /// /// The subscription name does not exist. /// /// REST API Reference for DeleteEventSubscription Operation DeleteEventSubscriptionResponse DeleteEventSubscription(DeleteEventSubscriptionRequest request); /// /// Deletes an Amazon DocumentDB event notification subscription. /// /// Container for the necessary parameters to execute the DeleteEventSubscription service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteEventSubscription service method, as returned by DocDB. /// /// Someone else might be modifying a subscription. Wait a few seconds, and try again. /// /// /// The subscription name does not exist. /// /// REST API Reference for DeleteEventSubscription Operation Task DeleteEventSubscriptionAsync(DeleteEventSubscriptionRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteGlobalCluster /// /// 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. /// /// /// /// Container for the necessary parameters to execute the DeleteGlobalCluster service method. /// /// The response from the DeleteGlobalCluster service method, as returned by DocDB. /// /// The GlobalClusterIdentifier doesn't refer to an existing global cluster. /// /// /// The requested operation can't be performed while the cluster is in this state. /// /// REST API Reference for DeleteGlobalCluster Operation DeleteGlobalClusterResponse DeleteGlobalCluster(DeleteGlobalClusterRequest request); /// /// 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. /// /// /// /// Container for the necessary parameters to execute the DeleteGlobalCluster service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteGlobalCluster service method, as returned by DocDB. /// /// The GlobalClusterIdentifier doesn't refer to an existing global cluster. /// /// /// The requested operation can't be performed while the cluster is in this state. /// /// REST API Reference for DeleteGlobalCluster Operation Task DeleteGlobalClusterAsync(DeleteGlobalClusterRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeCertificates /// /// Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB /// for this Amazon Web Services account. /// /// Container for the necessary parameters to execute the DescribeCertificates service method. /// /// The response from the DescribeCertificates service method, as returned by DocDB. /// /// CertificateIdentifier doesn't refer to an existing certificate. /// /// REST API Reference for DescribeCertificates Operation DescribeCertificatesResponse DescribeCertificates(DescribeCertificatesRequest request); /// /// Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB /// for this Amazon Web Services account. /// /// Container for the necessary parameters to execute the DescribeCertificates service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeCertificates service method, as returned by DocDB. /// /// CertificateIdentifier doesn't refer to an existing certificate. /// /// REST API Reference for DescribeCertificates Operation Task DescribeCertificatesAsync(DescribeCertificatesRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeDBClusterParameterGroups /// /// Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName /// parameter is specified, the list contains only the description of the specified cluster /// parameter group. /// /// Container for the necessary parameters to execute the DescribeDBClusterParameterGroups service method. /// /// The response from the DescribeDBClusterParameterGroups service method, as returned by DocDB. /// /// DBParameterGroupName doesn't refer to an existing parameter group. /// /// REST API Reference for DescribeDBClusterParameterGroups Operation DescribeDBClusterParameterGroupsResponse DescribeDBClusterParameterGroups(DescribeDBClusterParameterGroupsRequest request); /// /// Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName /// parameter is specified, the list contains only the description of the specified cluster /// parameter group. /// /// Container for the necessary parameters to execute the DescribeDBClusterParameterGroups service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeDBClusterParameterGroups service method, as returned by DocDB. /// /// DBParameterGroupName doesn't refer to an existing parameter group. /// /// REST API Reference for DescribeDBClusterParameterGroups Operation Task DescribeDBClusterParameterGroupsAsync(DescribeDBClusterParameterGroupsRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeDBClusterParameters /// /// Returns the detailed parameter list for a particular cluster parameter group. /// /// Container for the necessary parameters to execute the DescribeDBClusterParameters service method. /// /// The response from the DescribeDBClusterParameters service method, as returned by DocDB. /// /// DBParameterGroupName doesn't refer to an existing parameter group. /// /// REST API Reference for DescribeDBClusterParameters Operation DescribeDBClusterParametersResponse DescribeDBClusterParameters(DescribeDBClusterParametersRequest request); /// /// Returns the detailed parameter list for a particular cluster parameter group. /// /// Container for the necessary parameters to execute the DescribeDBClusterParameters service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeDBClusterParameters service method, as returned by DocDB. /// /// DBParameterGroupName doesn't refer to an existing parameter group. /// /// REST API Reference for DescribeDBClusterParameters Operation Task DescribeDBClusterParametersAsync(DescribeDBClusterParametersRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeDBClusters /// /// Returns information about provisioned Amazon DocumentDB clusters. This API operation /// supports pagination. For certain management features such as cluster and instance /// lifecycle management, Amazon DocumentDB leverages operational technology that is shared /// with Amazon RDS and Amazon Neptune. Use the filterName=engine,Values=docdb /// filter parameter to return only Amazon DocumentDB clusters. /// /// Container for the necessary parameters to execute the DescribeDBClusters service method. /// /// The response from the DescribeDBClusters service method, as returned by DocDB. /// /// DBClusterIdentifier doesn't refer to an existing cluster. /// /// REST API Reference for DescribeDBClusters Operation DescribeDBClustersResponse DescribeDBClusters(DescribeDBClustersRequest request); /// /// Returns information about provisioned Amazon DocumentDB clusters. This API operation /// supports pagination. For certain management features such as cluster and instance /// lifecycle management, Amazon DocumentDB leverages operational technology that is shared /// with Amazon RDS and Amazon Neptune. Use the filterName=engine,Values=docdb /// filter parameter to return only Amazon DocumentDB clusters. /// /// Container for the necessary parameters to execute the DescribeDBClusters service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeDBClusters service method, as returned by DocDB. /// /// DBClusterIdentifier doesn't refer to an existing cluster. /// /// REST API Reference for DescribeDBClusters Operation Task DescribeDBClustersAsync(DescribeDBClustersRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeDBClusterSnapshotAttributes /// /// Returns 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. /// /// /// Container for the necessary parameters to execute the DescribeDBClusterSnapshotAttributes service method. /// /// The response from the DescribeDBClusterSnapshotAttributes service method, as returned by DocDB. /// /// DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot. /// /// REST API Reference for DescribeDBClusterSnapshotAttributes Operation DescribeDBClusterSnapshotAttributesResponse DescribeDBClusterSnapshotAttributes(DescribeDBClusterSnapshotAttributesRequest request); /// /// Returns 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. /// /// /// Container for the necessary parameters to execute the DescribeDBClusterSnapshotAttributes service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeDBClusterSnapshotAttributes service method, as returned by DocDB. /// /// DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot. /// /// REST API Reference for DescribeDBClusterSnapshotAttributes Operation Task DescribeDBClusterSnapshotAttributesAsync(DescribeDBClusterSnapshotAttributesRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeDBClusterSnapshots /// /// Returns information about cluster snapshots. This API operation supports pagination. /// /// Container for the necessary parameters to execute the DescribeDBClusterSnapshots service method. /// /// The response from the DescribeDBClusterSnapshots service method, as returned by DocDB. /// /// DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot. /// /// REST API Reference for DescribeDBClusterSnapshots Operation DescribeDBClusterSnapshotsResponse DescribeDBClusterSnapshots(DescribeDBClusterSnapshotsRequest request); /// /// Returns information about cluster snapshots. This API operation supports pagination. /// /// Container for the necessary parameters to execute the DescribeDBClusterSnapshots service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeDBClusterSnapshots service method, as returned by DocDB. /// /// DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot. /// /// REST API Reference for DescribeDBClusterSnapshots Operation Task DescribeDBClusterSnapshotsAsync(DescribeDBClusterSnapshotsRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeDBEngineVersions /// /// Returns a list of the available engines. /// /// Container for the necessary parameters to execute the DescribeDBEngineVersions service method. /// /// The response from the DescribeDBEngineVersions service method, as returned by DocDB. /// REST API Reference for DescribeDBEngineVersions Operation DescribeDBEngineVersionsResponse DescribeDBEngineVersions(DescribeDBEngineVersionsRequest request); /// /// Returns a list of the available engines. /// /// Container for the necessary parameters to execute the DescribeDBEngineVersions service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeDBEngineVersions service method, as returned by DocDB. /// REST API Reference for DescribeDBEngineVersions Operation Task DescribeDBEngineVersionsAsync(DescribeDBEngineVersionsRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeDBInstances /// /// Returns information about provisioned Amazon DocumentDB instances. This API supports /// pagination. /// /// Container for the necessary parameters to execute the DescribeDBInstances service method. /// /// The response from the DescribeDBInstances service method, as returned by DocDB. /// /// DBInstanceIdentifier doesn't refer to an existing instance. /// /// REST API Reference for DescribeDBInstances Operation DescribeDBInstancesResponse DescribeDBInstances(DescribeDBInstancesRequest request); /// /// Returns information about provisioned Amazon DocumentDB instances. This API supports /// pagination. /// /// Container for the necessary parameters to execute the DescribeDBInstances service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeDBInstances service method, as returned by DocDB. /// /// DBInstanceIdentifier doesn't refer to an existing instance. /// /// REST API Reference for DescribeDBInstances Operation Task DescribeDBInstancesAsync(DescribeDBInstancesRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeDBSubnetGroups /// /// Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName /// is specified, the list will contain only the descriptions of the specified DBSubnetGroup. /// /// Container for the necessary parameters to execute the DescribeDBSubnetGroups service method. /// /// The response from the DescribeDBSubnetGroups service method, as returned by DocDB. /// /// DBSubnetGroupName doesn't refer to an existing subnet group. /// /// REST API Reference for DescribeDBSubnetGroups Operation DescribeDBSubnetGroupsResponse DescribeDBSubnetGroups(DescribeDBSubnetGroupsRequest request); /// /// Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName /// is specified, the list will contain only the descriptions of the specified DBSubnetGroup. /// /// Container for the necessary parameters to execute the DescribeDBSubnetGroups service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeDBSubnetGroups service method, as returned by DocDB. /// /// DBSubnetGroupName doesn't refer to an existing subnet group. /// /// REST API Reference for DescribeDBSubnetGroups Operation Task DescribeDBSubnetGroupsAsync(DescribeDBSubnetGroupsRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeEngineDefaultClusterParameters /// /// Returns the default engine and system parameter information for the cluster database /// engine. /// /// Container for the necessary parameters to execute the DescribeEngineDefaultClusterParameters service method. /// /// The response from the DescribeEngineDefaultClusterParameters service method, as returned by DocDB. /// REST API Reference for DescribeEngineDefaultClusterParameters Operation DescribeEngineDefaultClusterParametersResponse DescribeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest request); /// /// Returns the default engine and system parameter information for the cluster database /// engine. /// /// Container for the necessary parameters to execute the DescribeEngineDefaultClusterParameters service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeEngineDefaultClusterParameters service method, as returned by DocDB. /// REST API Reference for DescribeEngineDefaultClusterParameters Operation Task DescribeEngineDefaultClusterParametersAsync(DescribeEngineDefaultClusterParametersRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeEventCategories /// /// Displays a list of categories for all event source types, or, if specified, for a /// specified source type. /// /// Container for the necessary parameters to execute the DescribeEventCategories service method. /// /// The response from the DescribeEventCategories service method, as returned by DocDB. /// REST API Reference for DescribeEventCategories Operation DescribeEventCategoriesResponse DescribeEventCategories(DescribeEventCategoriesRequest request); /// /// Displays a list of categories for all event source types, or, if specified, for a /// specified source type. /// /// Container for the necessary parameters to execute the DescribeEventCategories service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeEventCategories service method, as returned by DocDB. /// REST API Reference for DescribeEventCategories Operation Task DescribeEventCategoriesAsync(DescribeEventCategoriesRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeEvents /// /// Returns events related to instances, security groups, snapshots, and DB parameter /// groups for the past 14 days. You can obtain events specific to a particular DB instance, /// security group, snapshot, or parameter group by providing the name as a parameter. /// By default, the events of the past hour are returned. /// /// Container for the necessary parameters to execute the DescribeEvents service method. /// /// The response from the DescribeEvents service method, as returned by DocDB. /// REST API Reference for DescribeEvents Operation DescribeEventsResponse DescribeEvents(DescribeEventsRequest request); /// /// Returns events related to instances, security groups, snapshots, and DB parameter /// groups for the past 14 days. You can obtain events specific to a particular DB instance, /// security group, snapshot, or parameter group by providing the name as a parameter. /// By default, the events of the past hour are returned. /// /// Container for the necessary parameters to execute the DescribeEvents service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeEvents service method, as returned by DocDB. /// REST API Reference for DescribeEvents Operation Task DescribeEventsAsync(DescribeEventsRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeEventSubscriptions /// /// Lists all the subscription descriptions for a customer account. The description for /// a subscription includes SubscriptionName, SNSTopicARN, CustomerID, /// SourceType, SourceID, CreationTime, and Status. /// /// /// /// If you specify a SubscriptionName, lists the description for that subscription. /// /// /// Container for the necessary parameters to execute the DescribeEventSubscriptions service method. /// /// The response from the DescribeEventSubscriptions service method, as returned by DocDB. /// /// The subscription name does not exist. /// /// REST API Reference for DescribeEventSubscriptions Operation DescribeEventSubscriptionsResponse DescribeEventSubscriptions(DescribeEventSubscriptionsRequest request); /// /// Lists all the subscription descriptions for a customer account. The description for /// a subscription includes SubscriptionName, SNSTopicARN, CustomerID, /// SourceType, SourceID, CreationTime, and Status. /// /// /// /// If you specify a SubscriptionName, lists the description for that subscription. /// /// /// Container for the necessary parameters to execute the DescribeEventSubscriptions service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeEventSubscriptions service method, as returned by DocDB. /// /// The subscription name does not exist. /// /// REST API Reference for DescribeEventSubscriptions Operation Task DescribeEventSubscriptionsAsync(DescribeEventSubscriptionsRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeGlobalClusters /// /// Returns information about Amazon DocumentDB global clusters. This API supports pagination. /// /// /// /// This action only applies to Amazon DocumentDB clusters. /// /// /// /// Container for the necessary parameters to execute the DescribeGlobalClusters service method. /// /// The response from the DescribeGlobalClusters service method, as returned by DocDB. /// /// The GlobalClusterIdentifier doesn't refer to an existing global cluster. /// /// REST API Reference for DescribeGlobalClusters Operation DescribeGlobalClustersResponse DescribeGlobalClusters(DescribeGlobalClustersRequest request); /// /// Returns information about Amazon DocumentDB global clusters. This API supports pagination. /// /// /// /// This action only applies to Amazon DocumentDB clusters. /// /// /// /// Container for the necessary parameters to execute the DescribeGlobalClusters service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeGlobalClusters service method, as returned by DocDB. /// /// The GlobalClusterIdentifier doesn't refer to an existing global cluster. /// /// REST API Reference for DescribeGlobalClusters Operation Task DescribeGlobalClustersAsync(DescribeGlobalClustersRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeOrderableDBInstanceOptions /// /// Returns a list of orderable instance options for the specified engine. /// /// Container for the necessary parameters to execute the DescribeOrderableDBInstanceOptions service method. /// /// The response from the DescribeOrderableDBInstanceOptions service method, as returned by DocDB. /// REST API Reference for DescribeOrderableDBInstanceOptions Operation DescribeOrderableDBInstanceOptionsResponse DescribeOrderableDBInstanceOptions(DescribeOrderableDBInstanceOptionsRequest request); /// /// Returns a list of orderable instance options for the specified engine. /// /// Container for the necessary parameters to execute the DescribeOrderableDBInstanceOptions service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeOrderableDBInstanceOptions service method, as returned by DocDB. /// REST API Reference for DescribeOrderableDBInstanceOptions Operation Task DescribeOrderableDBInstanceOptionsAsync(DescribeOrderableDBInstanceOptionsRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribePendingMaintenanceActions /// /// Returns a list of resources (for example, instances) that have at least one pending /// maintenance action. /// /// Container for the necessary parameters to execute the DescribePendingMaintenanceActions service method. /// /// The response from the DescribePendingMaintenanceActions service method, as returned by DocDB. /// /// The specified resource ID was not found. /// /// REST API Reference for DescribePendingMaintenanceActions Operation DescribePendingMaintenanceActionsResponse DescribePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest request); /// /// Returns a list of resources (for example, instances) that have at least one pending /// maintenance action. /// /// Container for the necessary parameters to execute the DescribePendingMaintenanceActions service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribePendingMaintenanceActions service method, as returned by DocDB. /// /// The specified resource ID was not found. /// /// REST API Reference for DescribePendingMaintenanceActions Operation Task DescribePendingMaintenanceActionsAsync(DescribePendingMaintenanceActionsRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region FailoverDBCluster /// /// 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. /// /// /// Container for the necessary parameters to execute the FailoverDBCluster service method. /// /// The response from the FailoverDBCluster service method, as returned by DocDB. /// /// DBClusterIdentifier doesn't refer to an existing cluster. /// /// /// The cluster isn't in a valid state. /// /// /// The specified instance isn't in the available state. /// /// REST API Reference for FailoverDBCluster Operation FailoverDBClusterResponse FailoverDBCluster(FailoverDBClusterRequest request); /// /// 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. /// /// /// Container for the necessary parameters to execute the FailoverDBCluster service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the FailoverDBCluster service method, as returned by DocDB. /// /// DBClusterIdentifier doesn't refer to an existing cluster. /// /// /// The cluster isn't in a valid state. /// /// /// The specified instance isn't in the available state. /// /// REST API Reference for FailoverDBCluster Operation Task FailoverDBClusterAsync(FailoverDBClusterRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListTagsForResource /// /// Lists all tags on an Amazon DocumentDB resource. /// /// Container for the necessary parameters to execute the ListTagsForResource service method. /// /// The response from the ListTagsForResource service method, as returned by DocDB. /// /// DBClusterIdentifier doesn't refer to an existing cluster. /// /// /// DBInstanceIdentifier doesn't refer to an existing instance. /// /// /// DBSnapshotIdentifier doesn't refer to an existing snapshot. /// /// REST API Reference for ListTagsForResource Operation ListTagsForResourceResponse ListTagsForResource(ListTagsForResourceRequest request); /// /// Lists all tags on an Amazon DocumentDB resource. /// /// Container for the necessary parameters to execute the ListTagsForResource service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListTagsForResource service method, as returned by DocDB. /// /// DBClusterIdentifier doesn't refer to an existing cluster. /// /// /// DBInstanceIdentifier doesn't refer to an existing instance. /// /// /// DBSnapshotIdentifier doesn't refer to an existing snapshot. /// /// REST API Reference for ListTagsForResource Operation Task ListTagsForResourceAsync(ListTagsForResourceRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ModifyDBCluster /// /// 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. /// /// Container for the necessary parameters to execute the ModifyDBCluster service method. /// /// The response from the ModifyDBCluster service method, as returned by DocDB. /// /// You already have a cluster with the given identifier. /// /// /// DBClusterIdentifier doesn't refer to an existing cluster. /// /// /// DBClusterParameterGroupName doesn't refer to an existing cluster parameter /// group. /// /// /// DBSubnetGroupName doesn't refer to an existing subnet group. /// /// /// The cluster isn't in a valid state. /// /// /// The specified instance isn't in the available state. /// /// /// The state of the security group doesn't allow deletion. /// /// /// The subnet group can't be deleted because it's in use. /// /// /// 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. /// /// /// The request would cause you to exceed the allowed amount of storage available across /// all instances. /// /// REST API Reference for ModifyDBCluster Operation ModifyDBClusterResponse ModifyDBCluster(ModifyDBClusterRequest request); /// /// 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. /// /// Container for the necessary parameters to execute the ModifyDBCluster service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ModifyDBCluster service method, as returned by DocDB. /// /// You already have a cluster with the given identifier. /// /// /// DBClusterIdentifier doesn't refer to an existing cluster. /// /// /// DBClusterParameterGroupName doesn't refer to an existing cluster parameter /// group. /// /// /// DBSubnetGroupName doesn't refer to an existing subnet group. /// /// /// The cluster isn't in a valid state. /// /// /// The specified instance isn't in the available state. /// /// /// The state of the security group doesn't allow deletion. /// /// /// The subnet group can't be deleted because it's in use. /// /// /// 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. /// /// /// The request would cause you to exceed the allowed amount of storage available across /// all instances. /// /// REST API Reference for ModifyDBCluster Operation Task ModifyDBClusterAsync(ModifyDBClusterRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ModifyDBClusterParameterGroup /// /// Modifies the parameters of a cluster parameter group. To modify more than one parameter, /// submit a list of the following: ParameterName, ParameterValue, /// and ApplyMethod. A maximum of 20 parameters can be modified in a single /// request. /// /// /// /// Changes to dynamic parameters are applied immediately. Changes to static parameters /// require a reboot or maintenance window before the change can take effect. /// /// /// /// After you create a cluster parameter group, you should wait at least 5 minutes before /// creating your first cluster that uses that cluster parameter group as the default /// parameter group. This allows Amazon DocumentDB to fully complete the create action /// before the parameter group is used as the default for a new cluster. This step is /// especially important for parameters that are critical when creating the default database /// for a cluster, such as the character set for the default database defined by the character_set_database /// parameter. /// /// /// /// Container for the necessary parameters to execute the ModifyDBClusterParameterGroup service method. /// /// The response from the ModifyDBClusterParameterGroup service method, as returned by DocDB. /// /// DBParameterGroupName doesn't refer to an existing parameter group. /// /// /// The 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. /// /// REST API Reference for ModifyDBClusterParameterGroup Operation ModifyDBClusterParameterGroupResponse ModifyDBClusterParameterGroup(ModifyDBClusterParameterGroupRequest request); /// /// Modifies the parameters of a cluster parameter group. To modify more than one parameter, /// submit a list of the following: ParameterName, ParameterValue, /// and ApplyMethod. A maximum of 20 parameters can be modified in a single /// request. /// /// /// /// Changes to dynamic parameters are applied immediately. Changes to static parameters /// require a reboot or maintenance window before the change can take effect. /// /// /// /// After you create a cluster parameter group, you should wait at least 5 minutes before /// creating your first cluster that uses that cluster parameter group as the default /// parameter group. This allows Amazon DocumentDB to fully complete the create action /// before the parameter group is used as the default for a new cluster. This step is /// especially important for parameters that are critical when creating the default database /// for a cluster, such as the character set for the default database defined by the character_set_database /// parameter. /// /// /// /// Container for the necessary parameters to execute the ModifyDBClusterParameterGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ModifyDBClusterParameterGroup service method, as returned by DocDB. /// /// DBParameterGroupName doesn't refer to an existing parameter group. /// /// /// The 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. /// /// REST API Reference for ModifyDBClusterParameterGroup Operation Task ModifyDBClusterParameterGroupAsync(ModifyDBClusterParameterGroupRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ModifyDBClusterSnapshotAttribute /// /// Adds 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. /// /// /// Container for the necessary parameters to execute the ModifyDBClusterSnapshotAttribute service method. /// /// The response from the ModifyDBClusterSnapshotAttribute service method, as returned by DocDB. /// /// DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot. /// /// /// The provided value isn't a valid cluster snapshot state. /// /// /// You have exceeded the maximum number of accounts that you can share a manual DB snapshot /// with. /// /// REST API Reference for ModifyDBClusterSnapshotAttribute Operation ModifyDBClusterSnapshotAttributeResponse ModifyDBClusterSnapshotAttribute(ModifyDBClusterSnapshotAttributeRequest request); /// /// Adds 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. /// /// /// Container for the necessary parameters to execute the ModifyDBClusterSnapshotAttribute service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ModifyDBClusterSnapshotAttribute service method, as returned by DocDB. /// /// DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot. /// /// /// The provided value isn't a valid cluster snapshot state. /// /// /// You have exceeded the maximum number of accounts that you can share a manual DB snapshot /// with. /// /// REST API Reference for ModifyDBClusterSnapshotAttribute Operation Task ModifyDBClusterSnapshotAttributeAsync(ModifyDBClusterSnapshotAttributeRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ModifyDBInstance /// /// 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. /// /// Container for the necessary parameters to execute the ModifyDBInstance service method. /// /// The response from the ModifyDBInstance service method, as returned by DocDB. /// /// 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. /// /// /// DBInstanceIdentifier doesn't refer to an existing instance. /// /// /// 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. /// /// /// The specified instance class isn't available in the specified Availability Zone. /// /// /// The specified instance isn't in the available state. /// /// /// The state of the security group doesn't allow deletion. /// /// /// The subnet group doesn't cover all Availability Zones after it is created because /// of changes that were made. /// /// /// The request would cause you to exceed the allowed amount of storage available across /// all instances. /// /// /// Storage of the specified StorageType can't be associated with the DB /// instance. /// /// REST API Reference for ModifyDBInstance Operation ModifyDBInstanceResponse ModifyDBInstance(ModifyDBInstanceRequest request); /// /// 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. /// /// Container for the necessary parameters to execute the ModifyDBInstance service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ModifyDBInstance service method, as returned by DocDB. /// /// 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. /// /// /// DBInstanceIdentifier doesn't refer to an existing instance. /// /// /// 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. /// /// /// The specified instance class isn't available in the specified Availability Zone. /// /// /// The specified instance isn't in the available state. /// /// /// The state of the security group doesn't allow deletion. /// /// /// The subnet group doesn't cover all Availability Zones after it is created because /// of changes that were made. /// /// /// The request would cause you to exceed the allowed amount of storage available across /// all instances. /// /// /// Storage of the specified StorageType can't be associated with the DB /// instance. /// /// REST API Reference for ModifyDBInstance Operation Task ModifyDBInstanceAsync(ModifyDBInstanceRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ModifyDBSubnetGroup /// /// 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. /// /// Container for the necessary parameters to execute the ModifyDBSubnetGroup service method. /// /// The response from the ModifyDBSubnetGroup service method, as returned by DocDB. /// /// Subnets in the subnet group should cover at least two Availability Zones unless there /// is only one Availability Zone. /// /// /// DBSubnetGroupName doesn't refer to an existing subnet group. /// /// /// The request would cause you to exceed the allowed number of subnets in a subnet group. /// /// /// The requested subnet is not valid, or multiple subnets were requested that are not /// all in a common virtual private cloud (VPC). /// /// /// The subnet is already in use in the Availability Zone. /// /// REST API Reference for ModifyDBSubnetGroup Operation ModifyDBSubnetGroupResponse ModifyDBSubnetGroup(ModifyDBSubnetGroupRequest request); /// /// 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. /// /// Container for the necessary parameters to execute the ModifyDBSubnetGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ModifyDBSubnetGroup service method, as returned by DocDB. /// /// Subnets in the subnet group should cover at least two Availability Zones unless there /// is only one Availability Zone. /// /// /// DBSubnetGroupName doesn't refer to an existing subnet group. /// /// /// The request would cause you to exceed the allowed number of subnets in a subnet group. /// /// /// The requested subnet is not valid, or multiple subnets were requested that are not /// all in a common virtual private cloud (VPC). /// /// /// The subnet is already in use in the Availability Zone. /// /// REST API Reference for ModifyDBSubnetGroup Operation Task ModifyDBSubnetGroupAsync(ModifyDBSubnetGroupRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ModifyEventSubscription /// /// Modifies an existing Amazon DocumentDB event notification subscription. /// /// Container for the necessary parameters to execute the ModifyEventSubscription service method. /// /// The response from the ModifyEventSubscription service method, as returned by DocDB. /// /// You 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. /// /// /// The provided category does not exist. /// /// /// The subscription name does not exist. /// /// REST API Reference for ModifyEventSubscription Operation ModifyEventSubscriptionResponse ModifyEventSubscription(ModifyEventSubscriptionRequest request); /// /// Modifies an existing Amazon DocumentDB event notification subscription. /// /// Container for the necessary parameters to execute the ModifyEventSubscription service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ModifyEventSubscription service method, as returned by DocDB. /// /// You 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. /// /// /// The provided category does not exist. /// /// /// The subscription name does not exist. /// /// REST API Reference for ModifyEventSubscription Operation Task ModifyEventSubscriptionAsync(ModifyEventSubscriptionRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ModifyGlobalCluster /// /// 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. /// /// /// /// Container for the necessary parameters to execute the ModifyGlobalCluster service method. /// /// The response from the ModifyGlobalCluster service method, as returned by DocDB. /// /// The GlobalClusterIdentifier doesn't refer to an existing global cluster. /// /// /// The requested operation can't be performed while the cluster is in this state. /// /// REST API Reference for ModifyGlobalCluster Operation ModifyGlobalClusterResponse ModifyGlobalCluster(ModifyGlobalClusterRequest request); /// /// 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. /// /// /// /// Container for the necessary parameters to execute the ModifyGlobalCluster service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ModifyGlobalCluster service method, as returned by DocDB. /// /// The GlobalClusterIdentifier doesn't refer to an existing global cluster. /// /// /// The requested operation can't be performed while the cluster is in this state. /// /// REST API Reference for ModifyGlobalCluster Operation Task ModifyGlobalClusterAsync(ModifyGlobalClusterRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region RebootDBInstance /// /// 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. /// /// /// /// Container for the necessary parameters to execute the RebootDBInstance service method. /// /// The response from the RebootDBInstance service method, as returned by DocDB. /// /// DBInstanceIdentifier doesn't refer to an existing instance. /// /// /// The specified instance isn't in the available state. /// /// REST API Reference for RebootDBInstance Operation RebootDBInstanceResponse RebootDBInstance(RebootDBInstanceRequest request); /// /// 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. /// /// /// /// Container for the necessary parameters to execute the RebootDBInstance service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the RebootDBInstance service method, as returned by DocDB. /// /// DBInstanceIdentifier doesn't refer to an existing instance. /// /// /// The specified instance isn't in the available state. /// /// REST API Reference for RebootDBInstance Operation Task RebootDBInstanceAsync(RebootDBInstanceRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region RemoveFromGlobalCluster /// /// 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. /// /// /// /// Container for the necessary parameters to execute the RemoveFromGlobalCluster service method. /// /// The response from the RemoveFromGlobalCluster service method, as returned by DocDB. /// /// DBClusterIdentifier doesn't refer to an existing cluster. /// /// /// The GlobalClusterIdentifier doesn't refer to an existing global cluster. /// /// /// The requested operation can't be performed while the cluster is in this state. /// /// REST API Reference for RemoveFromGlobalCluster Operation RemoveFromGlobalClusterResponse RemoveFromGlobalCluster(RemoveFromGlobalClusterRequest request); /// /// 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. /// /// /// /// Container for the necessary parameters to execute the RemoveFromGlobalCluster service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the RemoveFromGlobalCluster service method, as returned by DocDB. /// /// DBClusterIdentifier doesn't refer to an existing cluster. /// /// /// The GlobalClusterIdentifier doesn't refer to an existing global cluster. /// /// /// The requested operation can't be performed while the cluster is in this state. /// /// REST API Reference for RemoveFromGlobalCluster Operation Task RemoveFromGlobalClusterAsync(RemoveFromGlobalClusterRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region RemoveSourceIdentifierFromSubscription /// /// Removes a source identifier from an existing Amazon DocumentDB event notification /// subscription. /// /// Container for the necessary parameters to execute the RemoveSourceIdentifierFromSubscription service method. /// /// The response from the RemoveSourceIdentifierFromSubscription service method, as returned by DocDB. /// /// The requested source could not be found. /// /// /// The subscription name does not exist. /// /// REST API Reference for RemoveSourceIdentifierFromSubscription Operation RemoveSourceIdentifierFromSubscriptionResponse RemoveSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest request); /// /// Removes a source identifier from an existing Amazon DocumentDB event notification /// subscription. /// /// Container for the necessary parameters to execute the RemoveSourceIdentifierFromSubscription service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the RemoveSourceIdentifierFromSubscription service method, as returned by DocDB. /// /// The requested source could not be found. /// /// /// The subscription name does not exist. /// /// REST API Reference for RemoveSourceIdentifierFromSubscription Operation Task RemoveSourceIdentifierFromSubscriptionAsync(RemoveSourceIdentifierFromSubscriptionRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region RemoveTagsFromResource /// /// Removes metadata tags from an Amazon DocumentDB resource. /// /// Container for the necessary parameters to execute the RemoveTagsFromResource service method. /// /// The response from the RemoveTagsFromResource service method, as returned by DocDB. /// /// DBClusterIdentifier doesn't refer to an existing cluster. /// /// /// DBInstanceIdentifier doesn't refer to an existing instance. /// /// /// DBSnapshotIdentifier doesn't refer to an existing snapshot. /// /// REST API Reference for RemoveTagsFromResource Operation RemoveTagsFromResourceResponse RemoveTagsFromResource(RemoveTagsFromResourceRequest request); /// /// Removes metadata tags from an Amazon DocumentDB resource. /// /// Container for the necessary parameters to execute the RemoveTagsFromResource service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the RemoveTagsFromResource service method, as returned by DocDB. /// /// DBClusterIdentifier doesn't refer to an existing cluster. /// /// /// DBInstanceIdentifier doesn't refer to an existing instance. /// /// /// DBSnapshotIdentifier doesn't refer to an existing snapshot. /// /// REST API Reference for RemoveTagsFromResource Operation Task RemoveTagsFromResourceAsync(RemoveTagsFromResourceRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ResetDBClusterParameterGroup /// /// Modifies the parameters of a cluster parameter group to the default value. To reset /// specific parameters, submit a list of the following: ParameterName and /// ApplyMethod. To reset the entire cluster parameter group, specify the /// DBClusterParameterGroupName and ResetAllParameters parameters. /// /// /// /// /// When you reset the entire group, dynamic parameters are updated immediately and static /// parameters are set to pending-reboot to take effect on the next DB instance /// reboot. /// /// /// Container for the necessary parameters to execute the ResetDBClusterParameterGroup service method. /// /// The response from the ResetDBClusterParameterGroup service method, as returned by DocDB. /// /// DBParameterGroupName doesn't refer to an existing parameter group. /// /// /// The 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. /// /// REST API Reference for ResetDBClusterParameterGroup Operation ResetDBClusterParameterGroupResponse ResetDBClusterParameterGroup(ResetDBClusterParameterGroupRequest request); /// /// Modifies the parameters of a cluster parameter group to the default value. To reset /// specific parameters, submit a list of the following: ParameterName and /// ApplyMethod. To reset the entire cluster parameter group, specify the /// DBClusterParameterGroupName and ResetAllParameters parameters. /// /// /// /// /// When you reset the entire group, dynamic parameters are updated immediately and static /// parameters are set to pending-reboot to take effect on the next DB instance /// reboot. /// /// /// Container for the necessary parameters to execute the ResetDBClusterParameterGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ResetDBClusterParameterGroup service method, as returned by DocDB. /// /// DBParameterGroupName doesn't refer to an existing parameter group. /// /// /// The 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. /// /// REST API Reference for ResetDBClusterParameterGroup Operation Task ResetDBClusterParameterGroupAsync(ResetDBClusterParameterGroupRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region RestoreDBClusterFromSnapshot /// /// Creates 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. /// /// /// Container for the necessary parameters to execute the RestoreDBClusterFromSnapshot service method. /// /// The response from the RestoreDBClusterFromSnapshot service method, as returned by DocDB. /// /// 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. /// /// /// DBSnapshotIdentifier doesn't refer to an existing snapshot. /// /// /// DBSubnetGroupName doesn't refer to an existing subnet group. /// /// /// The cluster doesn't have enough capacity for the current operation. /// /// /// There 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. /// /// /// The 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 request would cause you to exceed the allowed amount of storage available across /// all instances. /// /// REST API Reference for RestoreDBClusterFromSnapshot Operation RestoreDBClusterFromSnapshotResponse RestoreDBClusterFromSnapshot(RestoreDBClusterFromSnapshotRequest request); /// /// Creates 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. /// /// /// Container for the necessary parameters to execute the RestoreDBClusterFromSnapshot service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the RestoreDBClusterFromSnapshot service method, as returned by DocDB. /// /// 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. /// /// /// DBSnapshotIdentifier doesn't refer to an existing snapshot. /// /// /// DBSubnetGroupName doesn't refer to an existing subnet group. /// /// /// The cluster doesn't have enough capacity for the current operation. /// /// /// There 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. /// /// /// The 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 request would cause you to exceed the allowed amount of storage available across /// all instances. /// /// REST API Reference for RestoreDBClusterFromSnapshot Operation Task RestoreDBClusterFromSnapshotAsync(RestoreDBClusterFromSnapshotRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region RestoreDBClusterToPointInTime /// /// Restores 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. /// /// Container for the necessary parameters to execute the RestoreDBClusterToPointInTime service method. /// /// The response from the RestoreDBClusterToPointInTime service method, as returned by DocDB. /// /// You already have a cluster with the given identifier. /// /// /// DBClusterIdentifier doesn't refer to an existing cluster. /// /// /// 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. /// /// /// The cluster doesn't have enough capacity for the current operation. /// /// /// There 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. /// /// /// The provided value isn't a valid cluster snapshot state. /// /// /// The cluster isn't in a valid 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 request would cause you to exceed the allowed amount of storage available across /// all instances. /// /// REST API Reference for RestoreDBClusterToPointInTime Operation RestoreDBClusterToPointInTimeResponse RestoreDBClusterToPointInTime(RestoreDBClusterToPointInTimeRequest request); /// /// Restores 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. /// /// Container for the necessary parameters to execute the RestoreDBClusterToPointInTime service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the RestoreDBClusterToPointInTime service method, as returned by DocDB. /// /// You already have a cluster with the given identifier. /// /// /// DBClusterIdentifier doesn't refer to an existing cluster. /// /// /// 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. /// /// /// The cluster doesn't have enough capacity for the current operation. /// /// /// There 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. /// /// /// The provided value isn't a valid cluster snapshot state. /// /// /// The cluster isn't in a valid 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 request would cause you to exceed the allowed amount of storage available across /// all instances. /// /// REST API Reference for RestoreDBClusterToPointInTime Operation Task RestoreDBClusterToPointInTimeAsync(RestoreDBClusterToPointInTimeRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region StartDBCluster /// /// Restarts the stopped cluster that is specified by DBClusterIdentifier. /// For more information, see Stopping /// and Starting an Amazon DocumentDB Cluster. /// /// Container for the necessary parameters to execute the StartDBCluster service method. /// /// The response from the StartDBCluster service method, as returned by DocDB. /// /// DBClusterIdentifier doesn't refer to an existing cluster. /// /// /// The cluster isn't in a valid state. /// /// /// The specified instance isn't in the available state. /// /// REST API Reference for StartDBCluster Operation StartDBClusterResponse StartDBCluster(StartDBClusterRequest request); /// /// Restarts the stopped cluster that is specified by DBClusterIdentifier. /// For more information, see Stopping /// and Starting an Amazon DocumentDB Cluster. /// /// Container for the necessary parameters to execute the StartDBCluster service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the StartDBCluster service method, as returned by DocDB. /// /// DBClusterIdentifier doesn't refer to an existing cluster. /// /// /// The cluster isn't in a valid state. /// /// /// The specified instance isn't in the available state. /// /// REST API Reference for StartDBCluster Operation Task StartDBClusterAsync(StartDBClusterRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region StopDBCluster /// /// 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. /// /// Container for the necessary parameters to execute the StopDBCluster service method. /// /// The response from the StopDBCluster service method, as returned by DocDB. /// /// DBClusterIdentifier doesn't refer to an existing cluster. /// /// /// The cluster isn't in a valid state. /// /// /// The specified instance isn't in the available state. /// /// REST API Reference for StopDBCluster Operation StopDBClusterResponse StopDBCluster(StopDBClusterRequest request); /// /// 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. /// /// Container for the necessary parameters to execute the StopDBCluster service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the StopDBCluster service method, as returned by DocDB. /// /// DBClusterIdentifier doesn't refer to an existing cluster. /// /// /// The cluster isn't in a valid state. /// /// /// The specified instance isn't in the available state. /// /// REST API Reference for StopDBCluster Operation Task StopDBClusterAsync(StopDBClusterRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion } }