本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# 動作
<a name="API_Operations"></a>

支援下列動作 Amazon DocumentDB (with MongoDB compatibility)：
+  [AddSourceIdentifierToSubscription](API_AddSourceIdentifierToSubscription.md) 
+  [AddTagsToResource](API_AddTagsToResource.md) 
+  [ApplyPendingMaintenanceAction](API_ApplyPendingMaintenanceAction.md) 
+  [CopyDBClusterParameterGroup](API_CopyDBClusterParameterGroup.md) 
+  [CopyDBClusterSnapshot](API_CopyDBClusterSnapshot.md) 
+  [CreateDBCluster](API_CreateDBCluster.md) 
+  [CreateDBClusterParameterGroup](API_CreateDBClusterParameterGroup.md) 
+  [CreateDBClusterSnapshot](API_CreateDBClusterSnapshot.md) 
+  [CreateDBInstance](API_CreateDBInstance.md) 
+  [CreateDBSubnetGroup](API_CreateDBSubnetGroup.md) 
+  [CreateEventSubscription](API_CreateEventSubscription.md) 
+  [CreateGlobalCluster](API_CreateGlobalCluster.md) 
+  [DeleteDBCluster](API_DeleteDBCluster.md) 
+  [DeleteDBClusterParameterGroup](API_DeleteDBClusterParameterGroup.md) 
+  [DeleteDBClusterSnapshot](API_DeleteDBClusterSnapshot.md) 
+  [DeleteDBInstance](API_DeleteDBInstance.md) 
+  [DeleteDBSubnetGroup](API_DeleteDBSubnetGroup.md) 
+  [DeleteEventSubscription](API_DeleteEventSubscription.md) 
+  [DeleteGlobalCluster](API_DeleteGlobalCluster.md) 
+  [DescribeCertificates](API_DescribeCertificates.md) 
+  [DescribeDBClusterParameterGroups](API_DescribeDBClusterParameterGroups.md) 
+  [DescribeDBClusterParameters](API_DescribeDBClusterParameters.md) 
+  [DescribeDBClusters](API_DescribeDBClusters.md) 
+  [DescribeDBClusterSnapshotAttributes](API_DescribeDBClusterSnapshotAttributes.md) 
+  [DescribeDBClusterSnapshots](API_DescribeDBClusterSnapshots.md) 
+  [DescribeDBEngineVersions](API_DescribeDBEngineVersions.md) 
+  [DescribeDBInstances](API_DescribeDBInstances.md) 
+  [DescribeDBSubnetGroups](API_DescribeDBSubnetGroups.md) 
+  [DescribeEngineDefaultClusterParameters](API_DescribeEngineDefaultClusterParameters.md) 
+  [DescribeEventCategories](API_DescribeEventCategories.md) 
+  [DescribeEvents](API_DescribeEvents.md) 
+  [DescribeEventSubscriptions](API_DescribeEventSubscriptions.md) 
+  [DescribeGlobalClusters](API_DescribeGlobalClusters.md) 
+  [DescribeOrderableDBInstanceOptions](API_DescribeOrderableDBInstanceOptions.md) 
+  [DescribePendingMaintenanceActions](API_DescribePendingMaintenanceActions.md) 
+  [FailoverDBCluster](API_FailoverDBCluster.md) 
+  [FailoverGlobalCluster](API_FailoverGlobalCluster.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ModifyDBCluster](API_ModifyDBCluster.md) 
+  [ModifyDBClusterParameterGroup](API_ModifyDBClusterParameterGroup.md) 
+  [ModifyDBClusterSnapshotAttribute](API_ModifyDBClusterSnapshotAttribute.md) 
+  [ModifyDBInstance](API_ModifyDBInstance.md) 
+  [ModifyDBSubnetGroup](API_ModifyDBSubnetGroup.md) 
+  [ModifyEventSubscription](API_ModifyEventSubscription.md) 
+  [ModifyGlobalCluster](API_ModifyGlobalCluster.md) 
+  [RebootDBInstance](API_RebootDBInstance.md) 
+  [RemoveFromGlobalCluster](API_RemoveFromGlobalCluster.md) 
+  [RemoveSourceIdentifierFromSubscription](API_RemoveSourceIdentifierFromSubscription.md) 
+  [RemoveTagsFromResource](API_RemoveTagsFromResource.md) 
+  [ResetDBClusterParameterGroup](API_ResetDBClusterParameterGroup.md) 
+  [RestoreDBClusterFromSnapshot](API_RestoreDBClusterFromSnapshot.md) 
+  [RestoreDBClusterToPointInTime](API_RestoreDBClusterToPointInTime.md) 
+  [StartDBCluster](API_StartDBCluster.md) 
+  [StopDBCluster](API_StopDBCluster.md) 
+  [SwitchoverGlobalCluster](API_SwitchoverGlobalCluster.md) 

Amazon DocumentDB Elastic Clusters 支援下列動作：
+  [ApplyPendingMaintenanceAction](API_elastic_ApplyPendingMaintenanceAction.md) 
+  [CopyClusterSnapshot](API_elastic_CopyClusterSnapshot.md) 
+  [CreateCluster](API_elastic_CreateCluster.md) 
+  [CreateClusterSnapshot](API_elastic_CreateClusterSnapshot.md) 
+  [DeleteCluster](API_elastic_DeleteCluster.md) 
+  [DeleteClusterSnapshot](API_elastic_DeleteClusterSnapshot.md) 
+  [GetCluster](API_elastic_GetCluster.md) 
+  [GetClusterSnapshot](API_elastic_GetClusterSnapshot.md) 
+  [GetPendingMaintenanceAction](API_elastic_GetPendingMaintenanceAction.md) 
+  [ListClusters](API_elastic_ListClusters.md) 
+  [ListClusterSnapshots](API_elastic_ListClusterSnapshots.md) 
+  [ListPendingMaintenanceActions](API_elastic_ListPendingMaintenanceActions.md) 
+  [ListTagsForResource](API_elastic_ListTagsForResource.md) 
+  [RestoreClusterFromSnapshot](API_elastic_RestoreClusterFromSnapshot.md) 
+  [StartCluster](API_elastic_StartCluster.md) 
+  [StopCluster](API_elastic_StopCluster.md) 
+  [TagResource](API_elastic_TagResource.md) 
+  [UntagResource](API_elastic_UntagResource.md) 
+  [UpdateCluster](API_elastic_UpdateCluster.md) 

# Amazon DocumentDB (with MongoDB compatibility)
<a name="API_Operations_Amazon_DocumentDB_with_MongoDB_compatibility"></a>

支援下列動作 Amazon DocumentDB (with MongoDB compatibility)：
+  [AddSourceIdentifierToSubscription](API_AddSourceIdentifierToSubscription.md) 
+  [AddTagsToResource](API_AddTagsToResource.md) 
+  [ApplyPendingMaintenanceAction](API_ApplyPendingMaintenanceAction.md) 
+  [CopyDBClusterParameterGroup](API_CopyDBClusterParameterGroup.md) 
+  [CopyDBClusterSnapshot](API_CopyDBClusterSnapshot.md) 
+  [CreateDBCluster](API_CreateDBCluster.md) 
+  [CreateDBClusterParameterGroup](API_CreateDBClusterParameterGroup.md) 
+  [CreateDBClusterSnapshot](API_CreateDBClusterSnapshot.md) 
+  [CreateDBInstance](API_CreateDBInstance.md) 
+  [CreateDBSubnetGroup](API_CreateDBSubnetGroup.md) 
+  [CreateEventSubscription](API_CreateEventSubscription.md) 
+  [CreateGlobalCluster](API_CreateGlobalCluster.md) 
+  [DeleteDBCluster](API_DeleteDBCluster.md) 
+  [DeleteDBClusterParameterGroup](API_DeleteDBClusterParameterGroup.md) 
+  [DeleteDBClusterSnapshot](API_DeleteDBClusterSnapshot.md) 
+  [DeleteDBInstance](API_DeleteDBInstance.md) 
+  [DeleteDBSubnetGroup](API_DeleteDBSubnetGroup.md) 
+  [DeleteEventSubscription](API_DeleteEventSubscription.md) 
+  [DeleteGlobalCluster](API_DeleteGlobalCluster.md) 
+  [DescribeCertificates](API_DescribeCertificates.md) 
+  [DescribeDBClusterParameterGroups](API_DescribeDBClusterParameterGroups.md) 
+  [DescribeDBClusterParameters](API_DescribeDBClusterParameters.md) 
+  [DescribeDBClusters](API_DescribeDBClusters.md) 
+  [DescribeDBClusterSnapshotAttributes](API_DescribeDBClusterSnapshotAttributes.md) 
+  [DescribeDBClusterSnapshots](API_DescribeDBClusterSnapshots.md) 
+  [DescribeDBEngineVersions](API_DescribeDBEngineVersions.md) 
+  [DescribeDBInstances](API_DescribeDBInstances.md) 
+  [DescribeDBSubnetGroups](API_DescribeDBSubnetGroups.md) 
+  [DescribeEngineDefaultClusterParameters](API_DescribeEngineDefaultClusterParameters.md) 
+  [DescribeEventCategories](API_DescribeEventCategories.md) 
+  [DescribeEvents](API_DescribeEvents.md) 
+  [DescribeEventSubscriptions](API_DescribeEventSubscriptions.md) 
+  [DescribeGlobalClusters](API_DescribeGlobalClusters.md) 
+  [DescribeOrderableDBInstanceOptions](API_DescribeOrderableDBInstanceOptions.md) 
+  [DescribePendingMaintenanceActions](API_DescribePendingMaintenanceActions.md) 
+  [FailoverDBCluster](API_FailoverDBCluster.md) 
+  [FailoverGlobalCluster](API_FailoverGlobalCluster.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ModifyDBCluster](API_ModifyDBCluster.md) 
+  [ModifyDBClusterParameterGroup](API_ModifyDBClusterParameterGroup.md) 
+  [ModifyDBClusterSnapshotAttribute](API_ModifyDBClusterSnapshotAttribute.md) 
+  [ModifyDBInstance](API_ModifyDBInstance.md) 
+  [ModifyDBSubnetGroup](API_ModifyDBSubnetGroup.md) 
+  [ModifyEventSubscription](API_ModifyEventSubscription.md) 
+  [ModifyGlobalCluster](API_ModifyGlobalCluster.md) 
+  [RebootDBInstance](API_RebootDBInstance.md) 
+  [RemoveFromGlobalCluster](API_RemoveFromGlobalCluster.md) 
+  [RemoveSourceIdentifierFromSubscription](API_RemoveSourceIdentifierFromSubscription.md) 
+  [RemoveTagsFromResource](API_RemoveTagsFromResource.md) 
+  [ResetDBClusterParameterGroup](API_ResetDBClusterParameterGroup.md) 
+  [RestoreDBClusterFromSnapshot](API_RestoreDBClusterFromSnapshot.md) 
+  [RestoreDBClusterToPointInTime](API_RestoreDBClusterToPointInTime.md) 
+  [StartDBCluster](API_StartDBCluster.md) 
+  [StopDBCluster](API_StopDBCluster.md) 
+  [SwitchoverGlobalCluster](API_SwitchoverGlobalCluster.md) 

# AddSourceIdentifierToSubscription
<a name="API_AddSourceIdentifierToSubscription"></a>

將來源識別符新增至現有的事件通知訂閱。

## 請求參數
<a name="API_AddSourceIdentifierToSubscription_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** SourceIdentifier **   
要新增的事件來源識別符：  
+ 如果來源類型是執行個體，`DBInstanceIdentifier`則必須提供 。
+ 如果來源類型是安全群組，`DBSecurityGroupName`則必須提供 。
+ 如果來源類型是參數群組，`DBParameterGroupName`則必須提供 。
+ 如果來源類型是快照，`DBSnapshotIdentifier`則必須提供 。
類型：字串  
必要：是

 ** SubscriptionName **   
您要新增來源識別符的 Amazon DocumentDB 事件通知訂閱名稱。  
類型：字串  
必要：是

## 回應元素
<a name="API_AddSourceIdentifierToSubscription_ResponseElements"></a>

服務會傳回下列元素。

 ** EventSubscription **   
您已訂閱之事件的詳細資訊。  
類型：[EventSubscription](API_EventSubscription.md) 物件

## 錯誤
<a name="API_AddSourceIdentifierToSubscription_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** SourceNotFound **   
找不到請求的來源。  
HTTP 狀態碼：404

 ** SubscriptionNotFound **   
訂閱名稱不存在。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_AddSourceIdentifierToSubscription_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/AddSourceIdentifierToSubscription) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/AddSourceIdentifierToSubscription) 

# AddTagsToResource
<a name="API_AddTagsToResource"></a>

將中繼資料標籤新增至 Amazon DocumentDB 資源。您可以將這些標籤與成本分配報告搭配使用，以追蹤與 Amazon DocumentDB 資源相關聯的成本，或在 Amazon DocumentDB 的 AWS Identity and Access Management (IAM) 政策中的`Condition`陳述式中追蹤成本。

## 請求參數
<a name="API_AddTagsToResource_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** ResourceName **   
標籤新增至其中的 Amazon DocumentDB 資源。此值是 Amazon Resource Name 。  
類型：字串  
必要：是

 **Tags.Tag.N**   
要指派給 Amazon DocumentDB 資源的標籤。  
類型：[Tag](API_Tag.md) 物件陣列  
必要：是

## 錯誤
<a name="API_AddTagsToResource_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` 不會參考現有的叢集。  
HTTP 狀態碼：404

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` 不會參考現有的執行個體。  
HTTP 狀態碼：404

 ** DBSnapshotNotFound **   
 `DBSnapshotIdentifier` 不會參考現有的快照。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_AddTagsToResource_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/AddTagsToResource) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/AddTagsToResource) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/AddTagsToResource) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/AddTagsToResource) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/AddTagsToResource) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/AddTagsToResource) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/AddTagsToResource) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/AddTagsToResource) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/AddTagsToResource) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/AddTagsToResource) 

# ApplyPendingMaintenanceAction
<a name="API_ApplyPendingMaintenanceAction"></a>

將待定維護動作套用至資源 （例如，套用至 Amazon DocumentDB 執行個體）。

## 請求參數
<a name="API_ApplyPendingMaintenanceAction_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** ApplyAction **   
要套用至此資源的待處理維護動作。  
有效值：`system-update`、`db-upgrade`  
類型：字串  
必要：是

 ** OptInType **   
指定選擇加入請求類型或復原選擇加入請求的值。無法復原 `immediate` 類型的選擇使用請求。  
有效值：  
+  `immediate` - 立即套用維護動作。
+  `next-maintenance` - 在下次資源維護時段期間套用維護動作。
+  `undo-opt-in` - 取消任何現有的 `next-maintenance` 選擇使用請求。
類型：字串  
必要：是

 ** ResourceIdentifier **   
要套用待處理維護動作之資源的 Amazon Resource Name (ARN)。  
類型：字串  
必要：是

## 回應元素
<a name="API_ApplyPendingMaintenanceAction_ResponseElements"></a>

服務會傳回下列元素。

 ** ResourcePendingMaintenanceActions **   
代表 的輸出[ApplyPendingMaintenanceAction](#API_ApplyPendingMaintenanceAction)。  
類型：[ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md) 物件

## 錯誤
<a name="API_ApplyPendingMaintenanceAction_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** InvalidDBClusterStateFault **   
叢集未處於有效狀態。  
HTTP 狀態碼：400

 ** InvalidDBInstanceState **   
 指定的執行個體未處於*可用*狀態。  
HTTP 狀態碼：400

 ** ResourceNotFoundFault **   
找不到指定的資源 ID。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_ApplyPendingMaintenanceAction_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ApplyPendingMaintenanceAction) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ApplyPendingMaintenanceAction) 

# CopyDBClusterParameterGroup
<a name="API_CopyDBClusterParameterGroup"></a>

複製指定的叢集參數群組。

## 請求參數
<a name="API_CopyDBClusterParameterGroup_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** SourceDBClusterParameterGroupIdentifier **   
來源叢集參數群組的識別符或 Amazon Resource Name (ARN)。  
限制條件：  
+ 必須指定有效的叢集參數群組。
+ 如果來源叢集參數群組與複本位於相同的 AWS 區域 中，請指定有效的參數群組識別符，例如 `my-db-cluster-param-group`或有效的 ARN。
+ 如果來源參數群組位於 AWS 區域 與複本不同的 中，請指定有效的叢集參數群組 ARN；例如 `arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group`。
類型：字串  
必要：是

 ** TargetDBClusterParameterGroupDescription **   
複製叢集參數群組的描述。  
類型：字串  
必要：是

 ** TargetDBClusterParameterGroupIdentifier **   
複製叢集參數群組的識別符。  
限制條件：  
+ 不得為無效、空白或留空。
+ 必須包含 1 到 255 個字母、數字或連字號。
+ 第一個字元必須是字母。
+ 不能以連字號結尾，或包含兩個連續連字號。
範例：`my-cluster-param-group1`  
類型：字串  
必要：是

 **Tags.Tag.N**   
要指派給參數群組的標籤。  
類型：[Tag](API_Tag.md) 物件陣列  
必要：否

## 回應元素
<a name="API_CopyDBClusterParameterGroup_ResponseElements"></a>

服務會傳回下列元素。

 ** DBClusterParameterGroup **   
叢集參數群組的詳細資訊。  
類型：[DBClusterParameterGroup](API_DBClusterParameterGroup.md) 物件

## 錯誤
<a name="API_CopyDBClusterParameterGroup_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** DBParameterGroupAlreadyExists **   
具有相同名稱的參數群組已存在。  
HTTP 狀態碼：400

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` 不參考現有的參數群組。  
HTTP 狀態碼：404

 ** DBParameterGroupQuotaExceeded **   
此請求將導致您超過允許的參數群組數量。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_CopyDBClusterParameterGroup_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CopyDBClusterParameterGroup) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CopyDBClusterParameterGroup) 

# CopyDBClusterSnapshot
<a name="API_CopyDBClusterSnapshot"></a>

複製叢集的快照。

若要從共用手動叢集快照複製叢集快照， `SourceDBClusterSnapshotIdentifier` 必須是共用叢集快照的 Amazon Resource Name (ARN)。您只能在相同的 AWS 區域中複製共用資料庫叢集快照，無論是否加密。

若要在複製操作進行後取消複製操作，請在叢集快照處於*複製*狀態`TargetDBClusterSnapshotIdentifier`時刪除 識別的目標叢集快照。

## 請求參數
<a name="API_CopyDBClusterSnapshot_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** SourceDBClusterSnapshotIdentifier **   
要複製之叢集快照的識別碼。此參數不區分大小寫。  
限制條件：  
+ 必須指定處於*可用*狀態的有效叢集快照。
+ 如果來源叢集快照與 AWS 區域 複本位於相同位置，請指定有效的快照識別符。
+ 如果來源叢集快照位於不同 AWS 區域 或由另一個 AWS 帳戶擁有，請指定快照 ARN。
範例：`my-cluster-snapshot1`  
類型：字串  
必要：是

 ** TargetDBClusterSnapshotIdentifier **   
要從來源叢集快照建立之新叢集快照的識別碼。此參數不區分大小寫。  
限制條件：  
+ 必須包含 1 到 63 個字母、數字或連字號。
+ 第一個字元必須是字母。
+ 不能以連字號結尾，或包含兩個連續連字號。
範例：`my-cluster-snapshot2`  
類型：字串  
必要：是

 ** CopyTags **   
設定為 `true`，將所有標籤從來源叢集快照複製到目標叢集快照，否則為 `false`。預設值為 `false`。  
類型：布林值  
必要：否

 ** KmsKeyId **   
加密叢集快照的 AWS KMS 金鑰 ID。金鑰 ID AWS KMS 是 AWS KMS 加密金鑰的 Amazon Resource Name (ARN)、 AWS KMS 金鑰識別符或 AWS KMS 金鑰別名。  
如果您從 複製加密的叢集快照 AWS 帳戶，您可以指定 的值`KmsKeyId`，以使用新的加密金鑰 AWS KMS 來加密複本。如果您未指定 的值`KmsKeyId`，則會使用與來源叢集快照相同的 AWS KMS 金鑰來加密叢集快照的複本。  
如果您複製從另一個 共用的加密叢集快照 AWS 帳戶，則必須指定 的值`KmsKeyId`。  
若要將加密的叢集快照複製到另一個叢集快照 AWS 區域，請將 `KmsKeyId`設定為您要用來加密目的地區域中叢集快照複本的 AWS KMS 金鑰 ID。 AWS KMS 加密金鑰專屬於在其中建立 AWS 區域 的 ，您無法在另一個 AWS 區域 區域中使用加密金鑰 AWS 區域。  
如果您複製未加密的叢集快照並指定 `KmsKeyId` 參數的值，則會傳回錯誤。  
類型：字串  
必要：否

 ** PreSignedUrl **   
在 中包含簽章第 4 版簽署的 API 動作請求 AWS 區域 的 URL，`CopyDBClusterSnapshot`其中包含要複製的來源叢集快照。從另一個叢集快照複製時，您必須使用 `PreSignedUrl` 參數 AWS 區域。  
如果您使用的是 AWS SDK 工具或 AWS CLI，您可以指定 `SourceRegion`（或`--source-region`用於 AWS CLI)，而不是`PreSignedUrl`手動指定。指定 `SourceRegion` 會自動產生預先簽章的 URL，這是可在來源中執行之操作的有效請求 AWS 區域。  
預先簽章的 URL 必須是 `CopyDBClusterSnapshot` API 動作的有效請求，可在包含要複製之叢集快照 AWS 區域 的來源中執行。預先簽章的 URL 請求必須包含下列參數值：  
+  `SourceRegion` - 包含要複製之快照的區域 ID。
+  `SourceDBClusterSnapshotIdentifier` - 要複製之加密叢集快照的識別符。此識別碼必須是來源 AWS 區域的 Amazon Resource Name (ARN) 格式。例如，如果您要從 us-east-1 複製加密叢集快照 AWS 區域，則您的 `SourceDBClusterSnapshotIdentifier`看起來會如下所示：`arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot`。
+  `TargetDBClusterSnapshotIdentifier` - 要建立新叢集快照的識別符。此參數不區分大小寫。
類型：字串  
必要：否

 **Tags.Tag.N**   
要指派給叢集快照的標籤。  
類型：[Tag](API_Tag.md) 物件陣列  
必要：否

## 回應元素
<a name="API_CopyDBClusterSnapshot_ResponseElements"></a>

服務會傳回下列元素。

 ** DBClusterSnapshot **   
叢集快照的詳細資訊。  
類型：[DBClusterSnapshot](API_DBClusterSnapshot.md) 物件

## 錯誤
<a name="API_CopyDBClusterSnapshot_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** DBClusterSnapshotAlreadyExistsFault **   
您已擁有具有指定識別符的叢集快照。  
HTTP 狀態碼：400

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier` 不會參考現有的叢集快照。  
HTTP 狀態碼：404

 ** InvalidDBClusterSnapshotStateFault **   
提供的值不是有效的叢集快照狀態。  
HTTP 狀態碼：400

 ** InvalidDBClusterStateFault **   
叢集未處於有效狀態。  
HTTP 狀態碼：400

 ** KMSKeyNotAccessibleFault **   
存取 AWS KMS 金鑰時發生錯誤。  
HTTP 狀態碼：400

 ** SnapshotQuotaExceeded **   
請求會導致您超過允許的快照數量。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_CopyDBClusterSnapshot_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CopyDBClusterSnapshot) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CopyDBClusterSnapshot) 

# CreateDBCluster
<a name="API_CreateDBCluster"></a>

建立新的 Amazon DocumentDB 叢集。

## 請求參數
<a name="API_CreateDBCluster_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** DBClusterIdentifier **   
叢集的識別碼，此參數是以小寫字母字串的形式儲存。  
限制條件：  
+ 必須包含 1 到 63 個字母、數字或連字號。
+ 第一個字元必須是字母。
+ 不能以連字號結尾，或包含兩個連續連字號。
範例：`my-cluster`  
類型：字串  
必要：是

 ** Engine **   
要用於此叢集的資料庫引擎名稱。  
有效值：`docdb`  
類型：字串  
必要：是

 **AvailabilityZones.AvailabilityZone.N**   
Amazon EC2 可用區域的清單，在這些可用區域中可以建立叢集中的執行個體。  
類型：字串陣列  
必要：否

 ** BackupRetentionPeriod **   
自動備份保留的天數。您必須指定一個值 (最小值為 1)。  
預設：1  
限制條件：  
+ 該值必須介於 1 到 35 之間。
類型：整數  
必要：否

 ** DBClusterParameterGroupName **   
要與此叢集建立關聯的叢集參數群組名稱。  
類型：字串  
必要：否

 ** DBSubnetGroupName **   
要與此叢集建立關聯的子網路群組。  
限制條件：必須符合現有 `DBSubnetGroup` 的名稱。絕不能為預設值。  
範例：`mySubnetgroup`  
類型：字串  
必要：否

 ** DeletionProtection **   
指定是否可以刪除此叢集。如果 `DeletionProtection` 已啟用，除非修改並`DeletionProtection`停用，否則無法刪除叢集。 會`DeletionProtection`保護叢集免於意外刪除。  
類型：布林值  
必要：否

 **EnableCloudwatchLogsExports.member.N**   
需要啟用以匯出至 Amazon CloudWatch Logs 的日誌類型清單。您可以啟用稽核日誌或分析工具日誌。如需詳細資訊，請參閱[稽核 Amazon DocumentDB 事件](https://docs.aws.amazon.com/documentdb/latest/developerguide/event-auditing.html)和分析 [ Amazon DocumentDB 操作](https://docs.aws.amazon.com/documentdb/latest/developerguide/profiling.html)。  
類型：字串陣列  
必要：否

 ** EngineVersion **   
要使用的資料庫引擎版本號碼。`--engine-version` 預設為最新的主要引擎版本。對於生產工作負載，我們建議使用預定的主要引擎版本明確宣告此參數。  
類型：字串  
必要：否

 ** GlobalClusterIdentifier **   
新全域叢集的叢集識別符。  
類型：字串  
長度限制：長度下限為 1。長度上限為 255。  
模式：`[A-Za-z][0-9A-Za-z-:._]*`  
必要：否

 ** KmsKeyId **   
加密叢集的 AWS KMS 金鑰識別符。  
 AWS KMS 金鑰識別符是 AWS KMS 加密金鑰的 Amazon Resource Name (ARN)。如果您要使用擁有用來加密新叢集之 AWS KMS 加密金鑰 AWS 帳戶 的相同 來建立叢集，您可以使用 AWS KMS 金鑰別名，而不是 AWS KMS 加密金鑰的 ARN。  
若加密金鑰並未在 `KmsKeyId` 中指定：  
+ 如果 `StorageEncrypted` 參數是 `true`，則 Amazon DocumentDB 會使用您的預設加密金鑰。
 AWS KMS 會為您的 建立預設加密金鑰 AWS 帳戶。每個 AWS 帳戶 都有不同的預設加密金鑰 AWS 區域。  
類型：字串  
必要：否

 ** ManageMasterUserPassword **   
指定是否使用 Amazon Web Services Secrets Manager 管理主要使用者密碼。  
限制條件：如果`MasterUserPassword`指定 ，則無法使用 Amazon Web Services Secrets Manager 管理主要使用者密碼。  
類型：布林值  
必要：否

 ** MasterUsername **   
叢集主要使用者的名稱。  
限制條件：  
+ 必須為 1 到 63 個字母或數字。
+ 第一個字元必須是字母。
+ 不能是所選擇資料庫引擎的保留字。
類型：字串  
必要：否

 ** MasterUserPassword **   
主要資料庫使用者的密碼。此密碼可包含任何可印出的 ASCII 字元，但斜線 (/)、雙引號 (") 或 "at" 符號 (@) 則除外。  
限制條件：必須包含 8 到 100 個字元。  
類型：字串  
必要：否

 ** MasterUserSecretKmsKeyId **   
Amazon Web Services KMS 金鑰識別符，用於加密在 Amazon Web Services Secrets Manager 中自動產生和管理的秘密。只有在主要使用者密碼由資料庫叢集的 Amazon Web Services Secrets Manager 中的 Amazon DocumentDB 管理時，此設定才有效。  
Amazon Web Services KMS 金鑰識別符是 KMS 金鑰的金鑰 ARN、金鑰 ID、別名 ARN 或別名名稱。若要在不同的 Amazon Web Services 帳戶中使用 KMS 金鑰，請指定金鑰 ARN 或別名 ARN。  
如果您未指定 `MasterUserSecretKmsKeyId`，則會使用 `aws/secretsmanager` KMS 金鑰來加密秘密。如果秘密位於不同的 Amazon Web Services 帳戶中，則無法使用 `aws/secretsmanager` KMS 金鑰來加密秘密，而且您必須使用客戶受管的 KMS 金鑰。  
您的 Amazon Web Services 帳戶有預設 KMS 金鑰。您的 Amazon Web Services 帳戶在每個 Amazon Web Services 區域都有不同的預設 KMS 金鑰。  
類型：字串  
必要：否

 ** NetworkType **   
叢集的網路類型。  
網路類型由為叢集`DBSubnetGroup`指定的 決定。只能`DBSubnetGroup`支援 IPv4 通訊協定或 IPv4 和 IPv6 通訊協定 (`DUAL`)。  
如需詳細資訊，請參閱《Amazon [DocumentDB 開發人員指南》中的 VPC 中的 DocumentDB 叢集](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html)。 Amazon DocumentDB   
有效值: `IPV4` \$1 `DUAL`   
類型：字串  
必要：否

 ** Port **   
叢集中執行個體接受連線的連接埠號碼。  
類型：整數  
必要：否

 ** PreferredBackupWindow **   
每日的時間範圍，若使用 `BackupRetentionPeriod` 參數啟用自動化備份，則會在此期間建立自動化備份。  
預設值是從 8 小時時段中隨機選取的 30 分鐘時段 AWS 區域。  
限制條件：  
+ 格式必須為 `hh24:mi-hh24:mi`。
+ 必須以國際標準時間 (UTC) 表示。
+ 不得和慣用的維護時段衝突。
+ 必須至少 30 分鐘。
類型：字串  
必要：否

 ** PreferredMaintenanceWindow **   
每週可能進行系統維護的時段，以國際標準時間 (UTC) 表示。  
格式：`ddd:hh24:mi-ddd:hh24:mi`  
預設值是從每個 8 小時時段中隨機選取的 30 分鐘時段 AWS 區域，隨機發生在一週中的某一天。  
有效日：星期一、星期二、星期三、星期四、星期五、星期六、星期日  
限制條件：必須至少是 30 分鐘的時段。  
類型：字串  
必要：否

 ** PreSignedUrl **   
目前不支援。  
類型：字串  
必要：否

 ** ServerlessV2ScalingConfiguration **   
包含 Amazon DocumentDB Serverless 叢集的擴展組態。  
類型：[ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) 物件  
必要：否

 ** StorageEncrypted **   
指定是否要加密叢集。  
類型：布林值  
必要：否

 ** StorageType **   
和資料庫叢集相關聯的儲存類型。  
如需 Amazon DocumentDB 叢集儲存類型的資訊，請參閱《*Amazon DocumentDB 開發人員指南*》中的叢集儲存組態。  
儲存類型 - 的有效值 `standard | iopt1`   
預設值為 `standard `   
當您建立儲存類型設為 的 Amazon DocumentDB 叢集時`iopt1`，會在回應中傳回儲存類型。當您將其設定為 時，不會傳回儲存類型`standard`。
類型：字串  
必要：否

 **Tags.Tag.N**   
要指派給叢集的標籤。  
類型：[Tag](API_Tag.md) 物件陣列  
必要：否

 **VpcSecurityGroupIds.VpcSecurityGroupId.N**   
與此叢集關聯的 EC2 VPC 安全群組清單。  
類型：字串陣列  
必要：否

## 回應元素
<a name="API_CreateDBCluster_ResponseElements"></a>

服務會傳回下列元素。

 ** DBCluster **   
叢集的詳細資訊。  
類型：[DBCluster](API_DBCluster.md) 物件

## 錯誤
<a name="API_CreateDBCluster_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** DBClusterAlreadyExistsFault **   
您已擁有具有指定識別符的叢集。  
HTTP 狀態碼：400

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` 不會參考現有的叢集。  
HTTP 狀態碼：404

 ** DBClusterParameterGroupNotFound **   
 `DBClusterParameterGroupName` 不參考現有的叢集參數群組。  
HTTP 狀態碼：404

 ** DBClusterQuotaExceededFault **   
無法建立叢集，因為您已達到叢集允許的配額上限。  
HTTP 狀態碼：403

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` 不會參考現有的執行個體。  
HTTP 狀態碼：404

 ** DBSubnetGroupDoesNotCoverEnoughAZs **   
除非只有一個可用區域，否則子網路群組中的子網路應涵蓋至少兩個可用區域。  
HTTP 狀態碼：400

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` 不會參考現有的子網路群組。  
HTTP 狀態碼：404

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier` 不是指現有的全域叢集。  
HTTP 狀態碼：404

 ** InsufficientStorageClusterCapacity **   
目前動作的可用儲存空間不足。您可以透過更新子網路群組以使用具有更多可用儲存空間的不同可用區域來解決此錯誤。  
HTTP 狀態碼：400

 ** InvalidDBClusterStateFault **   
叢集未處於有效狀態。  
HTTP 狀態碼：400

 ** InvalidDBInstanceState **   
 指定的執行個體未處於*可用*狀態。  
HTTP 狀態碼：400

 ** InvalidDBSubnetGroupStateFault **   
無法刪除子網路群組，因為它正在使用中。  
HTTP 狀態碼：400

 ** InvalidGlobalClusterStateFault **   
當叢集處於此狀態時，無法執行請求的操作。  
HTTP 狀態碼：400

 ** InvalidSubnet **   
請求的子網路無效，或請求的多個子網路並非全部位於通用虛擬私有雲端 (VPC) 中。  
HTTP 狀態碼：400

 ** InvalidVPCNetworkStateFault **   
由於進行了變更，子網路群組在建立之後不會涵蓋所有可用區域。  
HTTP 狀態碼：400

 ** KMSKeyNotAccessibleFault **   
存取 AWS KMS 金鑰時發生錯誤。  
HTTP 狀態碼：400

 ** NetworkTypeNotSupported **   
`DBSubnetGroup` 或 資料庫引擎版本不支援 網路類型。  
HTTP 狀態碼：400

 ** StorageQuotaExceeded **   
請求將導致您超過所有執行個體允許的可用儲存量。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_CreateDBCluster_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateDBCluster) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBCluster) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBCluster) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBCluster) 
+  [AWS 適用於 Java V2 的開發套件](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBCluster) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBCluster) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBCluster) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBCluster) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBCluster) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBCluster) 

# CreateDBClusterParameterGroup
<a name="API_CreateDBClusterParameterGroup"></a>

建立新的叢集參數群組。

叢集參數群組中的參數會套用到叢集中的所有執行個體。

最初會為叢集中執行個體所使用的資料庫引擎，使用預設參數建立叢集參數群組。在 Amazon DocumentDB 中，您無法直接修改`default.docdb3.6`叢集參數群組。如果您的 Amazon DocumentDB 叢集使用預設叢集參數群組，而且您想要修改其中的值，您必須先[建立新的參數群組](https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-create.html)或[複製現有的參數群組](https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-copy.html)、修改它，然後將修改後的參數群組套用至您的叢集。若要讓新的叢集參數群組和相關聯的設定生效，您必須重新啟動叢集中的執行個體，而不進行容錯移轉。如需詳細資訊，請參閱[修改 Amazon DocumentDB 叢集參數群組](https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-modify.html)。

## 請求參數
<a name="API_CreateDBClusterParameterGroup_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** DBClusterParameterGroupName **   
叢集參數群組的名稱。  
限制條件：  
+ 不得與現有 `DBClusterParameterGroup` 的名稱相符。
此值會以小寫字母字串的形式儲存。
類型：字串  
必要：是

 ** DBParameterGroupFamily **   
叢集參數群組系列的名稱。  
類型：字串  
必要：是

 ** Description **   
叢集參數群組的描述。  
類型：字串  
必要：是

 **Tags.Tag.N**   
要指派給叢集參數群組的標籤。  
類型：[Tag](API_Tag.md) 物件陣列  
必要：否

## 回應元素
<a name="API_CreateDBClusterParameterGroup_ResponseElements"></a>

服務會傳回下列元素。

 ** DBClusterParameterGroup **   
叢集參數群組的詳細資訊。  
類型：[DBClusterParameterGroup](API_DBClusterParameterGroup.md) 物件

## 錯誤
<a name="API_CreateDBClusterParameterGroup_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** DBParameterGroupAlreadyExists **   
具有相同名稱的參數群組已存在。  
HTTP 狀態碼：400

 ** DBParameterGroupQuotaExceeded **   
此請求將導致您超過允許的參數群組數量。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_CreateDBClusterParameterGroup_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBClusterParameterGroup) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBClusterParameterGroup) 

# CreateDBClusterSnapshot
<a name="API_CreateDBClusterSnapshot"></a>

建立叢集的快照。

## 請求參數
<a name="API_CreateDBClusterSnapshot_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** DBClusterIdentifier **   
要為其建立快照的叢集識別符。此參數不區分大小寫。  
限制條件：  
+ 必須符合現有 `DBCluster` 的識別碼。
範例：`my-cluster`  
類型：字串  
必要：是

 ** DBClusterSnapshotIdentifier **   
叢集快照的識別符。此參數是以小寫字母字串的形式儲存。  
限制條件：  
+ 必須包含 1 到 63 個字母、數字或連字號。
+ 第一個字元必須是字母。
+ 不能以連字號結尾，或包含兩個連續連字號。
範例：`my-cluster-snapshot1`  
類型：字串  
必要：是

 **Tags.Tag.N**   
要指派給叢集快照的標籤。  
類型：[Tag](API_Tag.md) 物件陣列  
必要：否

## 回應元素
<a name="API_CreateDBClusterSnapshot_ResponseElements"></a>

服務會傳回下列元素。

 ** DBClusterSnapshot **   
叢集快照的詳細資訊。  
類型：[DBClusterSnapshot](API_DBClusterSnapshot.md) 物件

## 錯誤
<a name="API_CreateDBClusterSnapshot_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` 不會參考現有的叢集。  
HTTP 狀態碼：404

 ** DBClusterSnapshotAlreadyExistsFault **   
您已擁有具有指定識別符的叢集快照。  
HTTP 狀態碼：400

 ** InvalidDBClusterSnapshotStateFault **   
提供的值不是有效的叢集快照狀態。  
HTTP 狀態碼：400

 ** InvalidDBClusterStateFault **   
叢集未處於有效狀態。  
HTTP 狀態碼：400

 ** SnapshotQuotaExceeded **   
請求會導致您超過允許的快照數量。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_CreateDBClusterSnapshot_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBClusterSnapshot) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBClusterSnapshot) 

# CreateDBInstance
<a name="API_CreateDBInstance"></a>

建立新的執行個體。

## 請求參數
<a name="API_CreateDBInstance_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** DBClusterIdentifier **   
執行個體所屬叢集的識別碼。  
類型：字串  
必要：是

 ** DBInstanceClass **   
執行個體的運算與記憶體容量，例如 `db.r5.large`。  
類型：字串  
必要：是

 ** DBInstanceIdentifier **   
執行個體識別碼。此參數是以小寫字母字串的形式儲存。  
限制條件：  
+ 必須包含 1 到 63 個字母、數字或連字號。
+ 第一個字元必須是字母。
+ 不能以連字號結尾，或包含兩個連續連字號。
範例：`mydbinstance`  
類型：字串  
必要：是

 ** Engine **   
要為此執行個體使用的資料庫引擎名稱。  
有效值：`docdb`  
類型：字串  
必要：是

 ** AutoMinorVersionUpgrade **   
此參數不適用於 Amazon DocumentDB。無論設定的值為何，Amazon DocumentDB 都不會執行次要版本升級。  
預設：`false`  
類型：布林值  
必要：否

 ** AvailabilityZone **   
在其中建立執行個體的 Amazon EC2 可用區域。  
預設：端點 中的隨機、系統選擇的可用區域 AWS 區域。  
範例：`us-east-1d`  
類型：字串  
必要：否

 ** CACertificateIdentifier **   
用於資料庫執行個體伺服器憑證的 CA 憑證識別符。  
如需詳細資訊，請參閱《[Amazon DocumentDB 開發人員指南》中的更新您的 Amazon DocumentDB TLS 憑證](https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html)和[加密傳輸中的資料](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html)。 *Amazon DocumentDB *  
類型：字串  
必要：否

 ** CopyTagsToSnapshot **   
值，指示是否將標籤從資料庫執行個體複製到資料庫執行個體快照。根據預設，不會複製標籤。  
類型：布林值  
必要：否

 ** EnablePerformanceInsights **   
指示是否啟用資料庫執行個體績效詳情的值。如需詳細資訊，請參閱[使用 Amazon 績效詳情](https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html)。  
類型：布林值  
必要：否

 ** PerformanceInsightsKMSKeyId **   
Performance Insights 資料加密的 AWS KMS 金鑰識別符。  
 AWS KMS 金鑰識別符是 KMS 金鑰的金鑰 ARN、金鑰 ID、別名 ARN 或別名名稱。  
如果您未指定 PerformanceInsightsKMSKeyId 的值，則 Amazon DocumentDB 會使用預設 KMS 金鑰。您的 Amazon Web Services 帳戶有預設 KMS 金鑰。您的 Amazon Web Services 帳戶在每個 Amazon Web Services 區域都有不同的預設 KMS 金鑰。  
類型：字串  
必要：否

 ** PreferredMaintenanceWindow **   
每週可能進行系統維護的時間範圍，以國際標準時間 (UTC) 表示。  
 格式：`ddd:hh24:mi-ddd:hh24:mi`  
預設值是從每個 8 小時時段中隨機選取的 30 分鐘時段 AWS 區域，隨機發生在一週中的某一天。  
有效日：星期一、星期二、星期三、星期四、星期五、星期六、星期日  
限制條件：必須至少是 30 分鐘的時段。  
類型：字串  
必要：否

 ** PromotionTier **   
指定現有主要執行個體故障後，Amazon DocumentDB 複本提升為主要執行個體的順序的值。  
預設：1  
有效值：0-15  
類型：整數  
必要：否

 **Tags.Tag.N**   
要指派給執行個體的標籤。一個執行個體最多可以指派 10 個標籤。  
類型：[Tag](API_Tag.md) 物件陣列  
必要：否

## 回應元素
<a name="API_CreateDBInstance_ResponseElements"></a>

服務會傳回下列元素。

 ** DBInstance **   
執行個體的詳細資訊。  
類型：[DBInstance](API_DBInstance.md) 物件

## 錯誤
<a name="API_CreateDBInstance_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** AuthorizationNotFound **   
指定的 CIDR IP 或 Amazon EC2 安全群組未獲得指定安全群組的授權。  
Amazon DocumentDB 也可能無權使用 IAM 代表您執行必要的動作。  
HTTP 狀態碼：404

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` 不會參考現有的叢集。  
HTTP 狀態碼：404

 ** DBInstanceAlreadyExists **   
您已有一個具有指定識別符的執行個體。  
HTTP 狀態碼：400

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` 不會參考現有的參數群組。  
HTTP 狀態碼：404

 ** DBSecurityGroupNotFound **   
 `DBSecurityGroupName` 不會參考現有的安全群組。  
HTTP 狀態碼：404

 ** DBSubnetGroupDoesNotCoverEnoughAZs **   
除非只有一個可用區域，否則子網路群組中的子網路應涵蓋至少兩個可用區域。  
HTTP 狀態碼：400

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` 不會參考現有的子網路群組。  
HTTP 狀態碼：404

 ** InstanceQuotaExceeded **   
請求會導致您超過允許的執行個體數量。  
HTTP 狀態碼：400

 ** InsufficientDBInstanceCapacity **   
指定的執行個體類別無法在指定的可用區域中使用。  
HTTP 狀態碼：400

 ** InvalidDBClusterStateFault **   
叢集未處於有效狀態。  
HTTP 狀態碼：400

 ** InvalidSubnet **   
請求的子網路無效，或請求的多個子網路並非全部位於通用虛擬私有雲端 (VPC) 中。  
HTTP 狀態碼：400

 ** InvalidVPCNetworkStateFault **   
由於進行了變更，子網路群組在建立之後不會涵蓋所有可用區域。  
HTTP 狀態碼：400

 ** KMSKeyNotAccessibleFault **   
存取 AWS KMS 金鑰時發生錯誤。  
HTTP 狀態碼：400

 ** StorageQuotaExceeded **   
請求將導致您超過所有執行個體允許的可用儲存量。  
HTTP 狀態碼：400

 ** StorageTypeNotSupported **   
指定的 儲存體`StorageType`無法與資料庫執行個體建立關聯。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_CreateDBInstance_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateDBInstance) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBInstance) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBInstance) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBInstance) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBInstance) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBInstance) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBInstance) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBInstance) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBInstance) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBInstance) 

# CreateDBSubnetGroup
<a name="API_CreateDBSubnetGroup"></a>

建立新的子網路群組。子網路群組必須在 中至少兩個可用區域中包含至少一個子網路 AWS 區域。

## 請求參數
<a name="API_CreateDBSubnetGroup_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** DBSubnetGroupDescription **   
子網路群組的描述。  
類型：字串  
必要：是

 ** DBSubnetGroupName **   
子網路群組的名稱。此值會以小寫字母字串的形式儲存。  
限制條件：包含的內容絕不能超過 255 個字母、數字、句號、底線、空格或連字號。絕不能為預設值。  
範例：`mySubnetgroup`  
類型：字串  
必要：是

 **SubnetIds.SubnetIdentifier.N**   
子網路群組的 Amazon EC2 子網路 ID。  
類型：字串陣列  
必要：是

 **Tags.Tag.N**   
要指派給子網路群組的標籤。  
類型：[Tag](API_Tag.md) 物件陣列  
必要：否

## 回應元素
<a name="API_CreateDBSubnetGroup_ResponseElements"></a>

服務會傳回下列元素。

 ** DBSubnetGroup **   
子網路群組的詳細資訊。  
類型：[DBSubnetGroup](API_DBSubnetGroup.md) 物件

## 錯誤
<a name="API_CreateDBSubnetGroup_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** DBSubnetGroupAlreadyExists **   
 `DBSubnetGroupName` 現有子網路群組已在使用中。  
HTTP 狀態碼：400

 ** DBSubnetGroupDoesNotCoverEnoughAZs **   
除非只有一個可用區域，否則子網路群組中的子網路應涵蓋至少兩個可用區域。  
HTTP 狀態碼：400

 ** DBSubnetGroupQuotaExceeded **   
請求會導致您超過允許的子網路群組數量。  
HTTP 狀態碼：400

 ** DBSubnetQuotaExceededFault **   
請求會導致您超過子網路群組中允許的子網路數量。  
HTTP 狀態碼：400

 ** InvalidSubnet **   
請求的子網路無效，或請求的多個子網路並非全部位於通用虛擬私有雲端 (VPC) 中。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_CreateDBSubnetGroup_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBSubnetGroup) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBSubnetGroup) 

# CreateEventSubscription
<a name="API_CreateEventSubscription"></a>

建立 Amazon DocumentDB 事件通知訂閱。此動作需要使用 Amazon DocumentDB 主控台、Amazon SNS 主控台或 Amazon SNS API 建立的 Amazon Resource Name (ARN) 主題。若要使用 Amazon SNS 取得 ARN，您必須在 Amazon SNS 中建立主題並訂閱主題。ARN 會顯示在 Amazon SNS 主控台中。

您可以指定要收到通知的來源類型 (`SourceType`)。您也可以提供觸發事件的 Amazon DocumentDB 來源 (`SourceIds`) 清單，也可以提供您要收到通知之事件的事件類別 (`EventCategories`) 清單。例如，您可以指定 `SourceType = db-instance`、 `SourceIds = mydbinstance1, mydbinstance2`和 `EventCategories = Availability, Backup`。

如果您同時指定 `SourceType`和 `SourceIds`（例如 `SourceType = db-instance`和 `SourceIdentifier = myDBInstance1`)，則會通知您指定來源的所有`db-instance`事件。如果您指定 ，`SourceType`但未指定 `SourceIdentifier`，則會收到該來源類型所有 Amazon DocumentDB 來源的事件通知。如果您未指定 `SourceType`或 `SourceIdentifier`，系統會通知您從屬於您客戶帳戶的所有 Amazon DocumentDB 來源所產生的事件。

## 請求參數
<a name="API_CreateEventSubscription_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** SnsTopicArn **   
針對事件通知所建立 SNS 主題的 Amazon Resource Name (ARN)。當您建立主題並訂閱主題時，Amazon SNS 會建立 ARN。  
類型：字串  
必要：是

 ** SubscriptionName **   
訂閱的名稱。  
限制條件：名稱必須少於 255 個字元。  
類型：字串  
必要：是

 ** Enabled **   
 布林值；設定為 `true` 以啟用訂閱，設定為 `false` 以建立訂閱，但不啟用。  
類型：布林值  
必要：否

 **EventCategories.EventCategory.N**   
 `SourceType` 您要訂閱之 的事件類別清單。  
類型：字串陣列  
必要：否

 **SourceIds.SourceId.N**   
傳回事件的事件來源識別碼清單。如未指定，回應中會包含所有來源。識別碼必須以字母開頭，只能包含 ASCII 字母、數字和連字號，而且不得以連字號結尾，或連續包含兩個連字號。  
限制條件：  
+ 如果`SourceIds`提供 ，`SourceType`也必須提供 。
+ 如果來源類型是執行個體，`DBInstanceIdentifier`則必須提供 。
+ 如果來源類型是安全群組，`DBSecurityGroupName`則必須提供 。
+ 如果來源類型是參數群組，`DBParameterGroupName`則必須提供 。
+ 如果來源類型是快照，`DBSnapshotIdentifier`則必須提供 。
類型：字串陣列  
必要：否

 ** SourceType **   
產生事件的來源類型。例如，如果您想要收到執行個體產生事件的通知，請將此參數設定為 `db-instance`。若沒有指定此值，則會傳回所有事件。  
有效值：`db-instance`、`db-cluster`、`db-parameter-group`、`db-security-group`、`db-cluster-snapshot`  
類型：字串  
必要：否

 **Tags.Tag.N**   
要指派給事件訂閱的標籤。  
類型：[Tag](API_Tag.md) 物件陣列  
必要：否

## 回應元素
<a name="API_CreateEventSubscription_ResponseElements"></a>

服務會傳回下列元素。

 ** EventSubscription **   
您已訂閱之事件的詳細資訊。  
類型：[EventSubscription](API_EventSubscription.md) 物件

## 錯誤
<a name="API_CreateEventSubscription_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** EventSubscriptionQuotaExceeded **   
您已達到事件訂閱的數量上限。  
HTTP 狀態碼：400

 ** SNSInvalidTopic **   
Amazon SNS 已回應指定主題發生問題。  
HTTP 狀態碼：400

 ** SNSNoAuthorization **   
您沒有發佈至 SNS 主題 Amazon Resource Name (ARN) 的許可。  
HTTP 狀態碼：400

 ** SNSTopicArnNotFound **   
SNS 主題 Amazon Resource Name (ARN) 不存在。  
HTTP 狀態碼：404

 ** SourceNotFound **   
找不到請求的來源。  
HTTP 狀態碼：404

 ** SubscriptionAlreadyExist **   
提供的訂閱名稱已存在。  
HTTP 狀態碼：400

 ** SubscriptionCategoryNotFound **   
提供的類別不存在。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_CreateEventSubscription_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateEventSubscription) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateEventSubscription) 

# CreateGlobalCluster
<a name="API_CreateGlobalCluster"></a>

建立可跨越多個 的 Amazon DocumentDB 全域叢集 AWS 區域。全域叢集包含一個具有讀寫功能的主要叢集，以及最多 10 個唯讀次要叢集。全域叢集使用儲存型快速複寫跨延遲低於一秒的區域，使用專用基礎設施，不會影響您工作負載的效能。



您可以建立最初為空白的全域叢集，然後將主要叢集和次要叢集新增至該叢集。或者，您可以在建立操作期間指定現有的叢集，而此叢集會成為全域叢集的主要叢集。

**注意**  
此動作僅適用於 Amazon DocumentDB 叢集。

## 請求參數
<a name="API_CreateGlobalCluster_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** GlobalClusterIdentifier **   
新全域叢集的叢集識別符。  
類型：字串  
長度限制：長度下限為 1。長度上限為 255。  
模式：`[A-Za-z][0-9A-Za-z-:._]*`  
必要：是

 ** DatabaseName **   
您資料庫的名稱最長可達 64 個英數字元。如果您未提供名稱，Amazon DocumentDB 將不會在您建立的全域叢集中建立資料庫。  
類型：字串  
必要：否

 ** DeletionProtection **   
新全域叢集的刪除保護設定。啟用刪除保護時，無法刪除全域叢集。  
類型：布林值  
必要：否

 ** Engine **   
要用於此叢集的資料庫引擎名稱。  
類型：字串  
必要：否

 ** EngineVersion **   
全域叢集的引擎版本。  
類型：字串  
必要：否

 ** SourceDBClusterIdentifier **   
要用作全域叢集主要叢集的 Amazon Resource Name (ARN)。此為選用參數。  
類型：字串  
必要：否

 ** StorageEncrypted **   
新全域叢集的儲存加密設定。  
類型：布林值  
必要：否

## 回應元素
<a name="API_CreateGlobalCluster_ResponseElements"></a>

服務會傳回下列元素。

 ** GlobalCluster **   
代表 Amazon DocumentDB 全域叢集的資料類型。  
類型：[GlobalCluster](API_GlobalCluster.md) 物件

## 錯誤
<a name="API_CreateGlobalCluster_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` 不會參考現有的叢集。  
HTTP 狀態碼：404

 ** GlobalClusterAlreadyExistsFault **   
`GlobalClusterIdentifier` 已存在。選擇新的全域叢集識別符 （唯一名稱），以建立新的全域叢集。  
HTTP 狀態碼：400

 ** GlobalClusterQuotaExceededFault **   
此帳戶的全域叢集數目已達允許的上限。  
HTTP 狀態碼：400

 ** InvalidDBClusterStateFault **   
叢集未處於有效狀態。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_CreateGlobalCluster_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateGlobalCluster) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateGlobalCluster) 

# DeleteDBCluster
<a name="API_DeleteDBCluster"></a>

刪除先前佈建的叢集。當您刪除叢集時，該叢集的所有自動備份都會遭到刪除，而且無法復原。不會刪除指定叢集的手動資料庫叢集快照。



## 請求參數
<a name="API_DeleteDBCluster_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** DBClusterIdentifier **   
要刪除之叢集的叢集識別符。此參數不區分大小寫。  
限制條件：  
+ 必須符合現有的 `DBClusterIdentifier`。
類型：字串  
必要：是

 ** FinalDBSnapshotIdentifier **   
 當 `SkipFinalSnapshot`設定為 時所建立新叢集快照的叢集快照識別符`false`。  
 指定此參數，並將 `SkipFinalShapshot` 參數設定為 `true`會導致錯誤。
限制條件：  
+ 必須是 1 到 255 個字母、數字或連字號。
+ 第一個字元必須是字母。
+ 不能以連字號結尾，或包含兩個連續連字號。
類型：字串  
必要：否

 ** SkipFinalSnapshot **   
 決定是否在刪除叢集之前建立最終叢集快照。如果指定 `true` ，則不會建立叢集快照。如果指定 `false` ，則會在刪除資料庫叢集之前建立叢集快照。  
如果 `SkipFinalSnapshot`是 `false`，您必須指定 `FinalDBSnapshotIdentifier` 參數。
預設：`false`  
類型：布林值  
必要：否

## 回應元素
<a name="API_DeleteDBCluster_ResponseElements"></a>

服務會傳回下列元素。

 ** DBCluster **   
叢集的詳細資訊。  
類型：[DBCluster](API_DBCluster.md) 物件

## 錯誤
<a name="API_DeleteDBCluster_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` 不會參考現有的叢集。  
HTTP 狀態碼：404

 ** DBClusterSnapshotAlreadyExistsFault **   
您已擁有具有指定識別符的叢集快照。  
HTTP 狀態碼：400

 ** InvalidDBClusterSnapshotStateFault **   
提供的值不是有效的叢集快照狀態。  
HTTP 狀態碼：400

 ** InvalidDBClusterStateFault **   
叢集未處於有效狀態。  
HTTP 狀態碼：400

 ** SnapshotQuotaExceeded **   
請求會導致您超過允許的快照數量。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DeleteDBCluster_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBCluster) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBCluster) 

# DeleteDBClusterParameterGroup
<a name="API_DeleteDBClusterParameterGroup"></a>

刪除指定的叢集參數群組。要刪除的叢集參數群組無法與任何叢集建立關聯。

## 請求參數
<a name="API_DeleteDBClusterParameterGroup_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** DBClusterParameterGroupName **   
叢集參數群組的名稱。  
限制條件：  
+ 必須是現有叢集參數群組的名稱。
+ 您無法刪除預設叢集參數群組。
+ 無法與任何叢集建立關聯。
類型：字串  
必要：是

## 錯誤
<a name="API_DeleteDBClusterParameterGroup_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` 不會參考現有的參數群組。  
HTTP 狀態碼：404

 ** InvalidDBParameterGroupState **   
參數群組正在使用中，或處於無效狀態。如果您嘗試刪除參數群組，則無法在參數群組處於此狀態時將其刪除。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DeleteDBClusterParameterGroup_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBClusterParameterGroup) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBClusterParameterGroup) 

# DeleteDBClusterSnapshot
<a name="API_DeleteDBClusterSnapshot"></a>

刪除叢集快照。如果正在複製快照，即會終止複製操作。

**注意**  
叢集快照必須處於要刪除`available`的狀態。

## 請求參數
<a name="API_DeleteDBClusterSnapshot_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** DBClusterSnapshotIdentifier **   
要刪除之叢集快照的識別符。  
限制條件：必須是 `available` 狀態中現有叢集快照的名稱。  
類型：字串  
必要：是

## 回應元素
<a name="API_DeleteDBClusterSnapshot_ResponseElements"></a>

服務會傳回下列元素。

 ** DBClusterSnapshot **   
叢集快照的詳細資訊。  
類型：[DBClusterSnapshot](API_DBClusterSnapshot.md) 物件

## 錯誤
<a name="API_DeleteDBClusterSnapshot_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier` 不會參考現有的叢集快照。  
HTTP 狀態碼：404

 ** InvalidDBClusterSnapshotStateFault **   
提供的值不是有效的叢集快照狀態。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DeleteDBClusterSnapshot_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBClusterSnapshot) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBClusterSnapshot) 

# DeleteDBInstance
<a name="API_DeleteDBInstance"></a>

刪除先前佈建的執行個體。

## 請求參數
<a name="API_DeleteDBInstance_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** DBInstanceIdentifier **   
要刪除之執行個體的執行個體識別符。此參數不區分大小寫。  
限制條件：  
+ 必須符合現有執行個體的名稱。
類型：字串  
必要：是

## 回應元素
<a name="API_DeleteDBInstance_ResponseElements"></a>

服務會傳回下列元素。

 ** DBInstance **   
執行個體的詳細資訊。  
類型：[DBInstance](API_DBInstance.md) 物件

## 錯誤
<a name="API_DeleteDBInstance_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` 不會參考現有的執行個體。  
HTTP 狀態碼：404

 ** DBSnapshotAlreadyExists **   
 `DBSnapshotIdentifier` 現有快照已在使用中。  
HTTP 狀態碼：400

 ** InvalidDBClusterStateFault **   
叢集未處於有效狀態。  
HTTP 狀態碼：400

 ** InvalidDBInstanceState **   
 指定的執行個體未處於*可用*狀態。  
HTTP 狀態碼：400

 ** SnapshotQuotaExceeded **   
請求會導致您超過允許的快照數量。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DeleteDBInstance_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBInstance) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBInstance) 

# DeleteDBSubnetGroup
<a name="API_DeleteDBSubnetGroup"></a>

刪除子網路群組。

**注意**  
指定的資料庫子網路群組不能和任何資料庫執行個體建立關聯。

## 請求參數
<a name="API_DeleteDBSubnetGroup_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** DBSubnetGroupName **   
要刪除的資料庫子網路群組名稱。  
您無法刪除預設子網路群組。
限制條件：  
必須符合現有 `DBSubnetGroup` 的名稱。絕不能為預設值。  
範例：`mySubnetgroup`  
類型：字串  
必要：是

## 錯誤
<a name="API_DeleteDBSubnetGroup_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` 不會參考現有的子網路群組。  
HTTP 狀態碼：404

 ** InvalidDBSubnetGroupStateFault **   
無法刪除子網路群組，因為它正在使用中。  
HTTP 狀態碼：400

 ** InvalidDBSubnetStateFault **   
 子網路未處於*可用*狀態。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DeleteDBSubnetGroup_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBSubnetGroup) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBSubnetGroup) 

# DeleteEventSubscription
<a name="API_DeleteEventSubscription"></a>

刪除 Amazon DocumentDB 事件通知訂閱。

## 請求參數
<a name="API_DeleteEventSubscription_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** SubscriptionName **   
您要刪除的 Amazon DocumentDB 事件通知訂閱名稱。  
類型：字串  
必要：是

## 回應元素
<a name="API_DeleteEventSubscription_ResponseElements"></a>

服務會傳回下列元素。

 ** EventSubscription **   
您已訂閱之事件的詳細資訊。  
類型：[EventSubscription](API_EventSubscription.md) 物件

## 錯誤
<a name="API_DeleteEventSubscription_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** InvalidEventSubscriptionState **   
其他人可能正在修改訂閱。請等待幾秒鐘，然後再試一次。  
HTTP 狀態碼：400

 ** SubscriptionNotFound **   
訂閱名稱不存在。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_DeleteEventSubscription_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteEventSubscription) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteEventSubscription) 

# DeleteGlobalCluster
<a name="API_DeleteGlobalCluster"></a>

刪除全域叢集。必須先分離或刪除主要和次要叢集，才能嘗試刪除全域叢集。

**注意**  
此動作僅適用於 Amazon DocumentDB 叢集。

## 請求參數
<a name="API_DeleteGlobalCluster_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** GlobalClusterIdentifier **   
要刪除之全域叢集的叢集識別符。  
類型：字串  
長度限制：長度下限為 1。長度上限為 255。  
模式：`[A-Za-z][0-9A-Za-z-:._]*`  
必要：是

## 回應元素
<a name="API_DeleteGlobalCluster_ResponseElements"></a>

服務會傳回下列元素。

 ** GlobalCluster **   
代表 Amazon DocumentDB 全域叢集的資料類型。  
類型：[GlobalCluster](API_GlobalCluster.md) 物件

## 錯誤
<a name="API_DeleteGlobalCluster_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier` 不是指現有的全域叢集。  
HTTP 狀態碼：404

 ** InvalidGlobalClusterStateFault **   
當叢集處於此狀態時，無法執行請求的操作。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DeleteGlobalCluster_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteGlobalCluster) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteGlobalCluster) 

# DescribeCertificates
<a name="API_DescribeCertificates"></a>

傳回 Amazon DocumentDB 為此提供的憑證授權機構 (CA) 憑證清單 AWS 帳戶。

## 請求參數
<a name="API_DescribeCertificates_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** CertificateIdentifier **   
使用者提供的憑證識別符。如果指定此參數，則只會傳回指定憑證的資訊。如果省略此參數，則會傳回最多 個`MaxRecords`憑證的清單。此參數不區分大小寫。  
Constraints  
+ 必須符合現有的 `CertificateIdentifier`。
類型：字串  
必要：否

 **Filters.Filter.N**   
目前不支援此參數。  
類型：[Filter](API_Filter.md) 物件陣列  
必要：否

 ** Marker **   
前一個 `DescribeCertificates` 請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。  
類型：字串  
必要：否

 ** MaxRecords **   
要在回應中包含的記錄數量上限。若存在的記錄比 `MaxRecords` 值指定的更多，則稱為「標記」的分頁字符會包含在回應中，讓您可以擷取剩餘的結果。  
預設：100  
限制條件：  
+ 下限：20
+ 上限：100
類型：整數  
必要：否

## 回應元素
<a name="API_DescribeCertificates_ResponseElements"></a>

服務會傳回下列元素。

 **Certificates.Certificate.N**   
此 的憑證清單 AWS 帳戶。  
類型：[Certificate](API_Certificate.md) 物件陣列

 ** Marker **   
如果擷取的記錄數目大於 ，則會提供選用的分頁字符`MaxRecords`。如果指定此參數，標記會指定清單中的下一個記錄。在下一次呼叫`Marker`中包含 的值`DescribeCertificates`會導致憑證的下一頁。  
類型：字串

## 錯誤
<a name="API_DescribeCertificates_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** CertificateNotFound **   
 `CertificateIdentifier` 不會參考現有的憑證。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_DescribeCertificates_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeCertificates) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeCertificates) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeCertificates) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeCertificates) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeCertificates) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeCertificates) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeCertificates) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeCertificates) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeCertificates) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeCertificates) 

# DescribeDBClusterParameterGroups
<a name="API_DescribeDBClusterParameterGroups"></a>

傳回 `DBClusterParameterGroup` 描述的清單。如果指定`DBClusterParameterGroupName`參數，則清單只會包含指定叢集參數群組的描述。

## 請求參數
<a name="API_DescribeDBClusterParameterGroups_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** DBClusterParameterGroupName **   
要傳回詳細資訊的特定叢集參數群組名稱。  
限制條件：  
+ 如果提供， 必須符合現有 的名稱`DBClusterParameterGroup`。
類型：字串  
必要：否

 **Filters.Filter.N**   
目前不支援此參數。  
類型：[Filter](API_Filter.md) 物件陣列  
必要：否

 ** Marker **   
前一個請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。  
類型：字串  
必要：否

 ** MaxRecords **   
 要在回應中包含的記錄數量上限。如果存在的記錄超過指定的`MaxRecords`值，回應中會包含分頁字符 （標記），以便擷取剩餘的結果。  
預設：100  
限制條件：最小 20，最大 100。  
類型：整數  
必要：否

## 回應元素
<a name="API_DescribeDBClusterParameterGroups_ResponseElements"></a>

服務會傳回下列元素。

 **DBClusterParameterGroups.DBClusterParameterGroup.N**   
叢集參數群組的清單。  
類型：[DBClusterParameterGroup](API_DBClusterParameterGroup.md) 物件陣列

 ** Marker **   
前一個請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。  
類型：字串

## 錯誤
<a name="API_DescribeDBClusterParameterGroups_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` 不參考現有的參數群組。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_DescribeDBClusterParameterGroups_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusterParameterGroups) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusterParameterGroups) 

# DescribeDBClusterParameters
<a name="API_DescribeDBClusterParameters"></a>

傳回特定叢集參數群組的詳細參數清單。

## 請求參數
<a name="API_DescribeDBClusterParameters_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** DBClusterParameterGroupName **   
要傳回參數詳細資訊的特定叢集參數群組名稱。  
限制條件：  
+ 如果提供， 必須符合現有 的名稱`DBClusterParameterGroup`。
類型：字串  
必要：是

 **Filters.Filter.N**   
目前不支援此參數。  
類型：[Filter](API_Filter.md) 物件陣列  
必要：否

 ** Marker **   
前一個請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。  
類型：字串  
必要：否

 ** MaxRecords **   
 要在回應中包含的記錄數量上限。如果存在的記錄超過指定的`MaxRecords`值，回應中會包含分頁字符 （標記），以便擷取剩餘的結果。  
預設：100  
限制條件：最小 20，最大 100。  
類型：整數  
必要：否

 ** Source **   
 指出只傳回特定來源參數的值。參數來源可以是 `engine`、`service` 或 `customer`。  
類型：字串  
必要：否

## 回應元素
<a name="API_DescribeDBClusterParameters_ResponseElements"></a>

服務會傳回下列元素。

 ** Marker **   
前一個請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。  
類型：字串

 **Parameters.Parameter.N**   
提供叢集參數群組的參數清單。  
類型：[Parameter](API_Parameter.md) 物件陣列

## 錯誤
<a name="API_DescribeDBClusterParameters_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` 不會參考現有的參數群組。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_DescribeDBClusterParameters_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusterParameters) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusterParameters) 

# DescribeDBClusters
<a name="API_DescribeDBClusters"></a>

傳回佈建 Amazon DocumentDB 叢集的相關資訊。此 API 操作支援分頁。對於特定管理功能，例如叢集和執行個體生命週期管理，Amazon DocumentDB 會利用與 Amazon RDS 和 Amazon Neptune 共用的操作技術。使用`filterName=engine,Values=docdb`篩選參數僅傳回 Amazon DocumentDB 叢集。

## 請求參數
<a name="API_DescribeDBClusters_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** DBClusterIdentifier **   
使用者提供的叢集識別符。如果指定此參數，則只會傳回來自特定叢集的資訊。此參數不區分大小寫。  
限制條件：  
+ 如果提供， 必須符合現有的 `DBClusterIdentifier`。
類型：字串  
必要：否

 **Filters.Filter.N**   
篩選條件，指定一或多個要描述的叢集。  
支援的篩選條件：  
+  `db-cluster-id` - 接受叢集識別符和叢集 Amazon Resource Name (ARNs)。結果清單僅包含這些 ARNs 所識別叢集的相關資訊。
類型：[Filter](API_Filter.md) 物件陣列  
必要：否

 ** Marker **   
前一個請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。  
類型：字串  
必要：否

 ** MaxRecords **   
 要在回應中包含的記錄數量上限。如果存在的記錄超過指定的`MaxRecords`值，回應中會包含分頁字符 （標記），以便擷取剩餘的結果。  
預設：100  
限制條件：最小 20，最大 100。  
類型：整數  
必要：否

## 回應元素
<a name="API_DescribeDBClusters_ResponseElements"></a>

服務會傳回下列元素。

 **DBClusters.DBCluster.N**   
叢集清單。  
類型：[DBCluster](API_DBCluster.md) 物件陣列

 ** Marker **   
前一個請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。  
類型：字串

## 錯誤
<a name="API_DescribeDBClusters_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` 不會參考現有的叢集。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_DescribeDBClusters_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusters) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusters) 

# DescribeDBClusterSnapshotAttributes
<a name="API_DescribeDBClusterSnapshotAttributes"></a>

傳回手動資料庫叢集快照的叢集快照屬性名稱和值清單。

當您與其他 共用快照時 AWS 帳戶， 會`DescribeDBClusterSnapshotAttributes`傳回 `restore` 屬性，以及 AWS 帳戶 有權複製或還原手動叢集快照之 IDs 清單。如果 `restore` 屬性的值清單中`all`包含 ，則手動叢集快照是公有的，可由所有 複製或還原 AWS 帳戶。

## 請求參數
<a name="API_DescribeDBClusterSnapshotAttributes_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** DBClusterSnapshotIdentifier **   
描述其屬性之叢集快照的識別符。  
類型：字串  
必要：是

## 回應元素
<a name="API_DescribeDBClusterSnapshotAttributes_ResponseElements"></a>

服務會傳回下列元素。

 ** DBClusterSnapshotAttributesResult **   
與叢集快照相關聯之屬性的詳細資訊。  
類型：[DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md) 物件

## 錯誤
<a name="API_DescribeDBClusterSnapshotAttributes_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier` 不會參考現有的叢集快照。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_DescribeDBClusterSnapshotAttributes_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) 

# DescribeDBClusterSnapshots
<a name="API_DescribeDBClusterSnapshots"></a>

傳回叢集快照的相關資訊。此 API 操作支援分頁。

## 請求參數
<a name="API_DescribeDBClusterSnapshots_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** DBClusterIdentifier **   
要擷取叢集快照清單的叢集 ID。此參數無法與 `DBClusterSnapshotIdentifier` 參數搭配使用。此參數不區分大小寫。  
限制條件：  
+ 如果提供， 必須符合現有 的識別符`DBCluster`。
類型：字串  
必要：否

 ** DBClusterSnapshotIdentifier **   
要描述的特定叢集快照識別符。此參數無法與 `DBClusterIdentifier` 參數搭配使用。此值會以小寫字母字串的形式儲存。  
限制條件：  
+ 如果提供， 必須符合現有 的識別符`DBClusterSnapshot`。
+ 如果這是用於自動快照的識別符，也必須指定 `SnapshotType` 參數。
類型：字串  
必要：否

 **Filters.Filter.N**   
目前不支援此參數。  
類型：[Filter](API_Filter.md) 物件陣列  
必要：否

 ** IncludePublic **   
設定為 `true`以包含公開且可由任何 複製或還原的手動叢集快照 AWS 帳戶，否則為 `false`。預設值為 `false`。  
類型：布林值  
必要：否

 ** IncludeShared **   
設定為 `true` 以包含來自其他 的共用手動叢集快照 AWS 帳戶 ，該快照 AWS 帳戶 已獲得複製或還原的許可，否則為 `false`。預設值為 `false`。  
類型：布林值  
必要：否

 ** Marker **   
前一個請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。  
類型：字串  
必要：否

 ** MaxRecords **   
 要在回應中包含的記錄數量上限。如果存在的記錄超過指定的`MaxRecords`值，回應中會包含分頁字符 （標記），以便擷取剩餘的結果。  
預設：100  
限制條件：最小 20，最大 100。  
類型：整數  
必要：否

 ** SnapshotType **   
要傳回的叢集快照類型。您可以指定下列其中一個值：  
+  `automated` - 傳回 Amazon DocumentDB 為 自動建立的所有叢集快照 AWS 帳戶。
+  `manual` - 傳回您為 手動建立的所有叢集快照 AWS 帳戶。
+  `shared` - 傳回已與 共用的所有手動叢集快照 AWS 帳戶。
+  `public` - 傳回已標示為公有的所有叢集快照。
如果您未指定`SnapshotType`值，則會傳回自動和手動叢集快照。您可以將 `IncludeShared` 參數設定為 ，以包含共用叢集快照與這些結果`true`。您可以將 參數設定為 ，`IncludePublic`將公有叢集快照包含這些結果`true`。  
`IncludeShared` 和 `IncludePublic` 參數不適用於值為 `SnapshotType` 的 `manual` 或 `automated`。當 `SnapshotType` 設為 `shared` 時，不適用 `IncludePublic` 參數。當 `SnapshotType` 設為 `public` 時，不適用 `IncludeShared` 參數。  
類型：字串  
必要：否

## 回應元素
<a name="API_DescribeDBClusterSnapshots_ResponseElements"></a>

服務會傳回下列元素。

 **DBClusterSnapshots.DBClusterSnapshot.N**   
提供叢集快照的清單。  
類型：[DBClusterSnapshot](API_DBClusterSnapshot.md) 物件陣列

 ** Marker **   
前一個請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。  
類型：字串

## 錯誤
<a name="API_DescribeDBClusterSnapshots_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier` 不會參考現有的叢集快照。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_DescribeDBClusterSnapshots_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusterSnapshots) 

# DescribeDBEngineVersions
<a name="API_DescribeDBEngineVersions"></a>

傳回可用引擎的清單。

## 請求參數
<a name="API_DescribeDBEngineVersions_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** DBParameterGroupFamily **   
要傳回詳細資訊的特定參數群組系列名稱。  
限制條件：  
+ 如果提供， 必須符合現有的 `DBParameterGroupFamily`。
類型：字串  
必要：否

 ** DefaultOnly **   
指出只會傳回指定引擎或引擎預設版本和主要版本的組合。  
類型：布林值  
必要：否

 ** Engine **   
要傳回的資料庫引擎。  
類型：字串  
必要：否

 ** EngineVersion **   
要傳回的資料庫引擎版本。  
範例：`3.6.0`  
類型：字串  
必要：否

 **Filters.Filter.N**   
目前不支援此參數。  
類型：[Filter](API_Filter.md) 物件陣列  
必要：否

 ** ListSupportedCharacterSets **   
如已指定此參數，而請求的引擎支援 `CreateDBInstance` 的 `CharacterSetName` 參數，則回應會包含每個引擎版本支援的字元集清單。  
類型：布林值  
必要：否

 ** ListSupportedTimezones **   
如已指定此參數，而請求的引擎支援 `CreateDBInstance` 的 `TimeZone` 參數，則回應會包含每個引擎版本支援的時區清單。  
類型：布林值  
必要：否

 ** Marker **   
前一個請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。  
類型：字串  
必要：否

 ** MaxRecords **   
 要在回應中包含的記錄數量上限。如果存在的記錄超過指定的`MaxRecords`值，回應中會包含分頁字符 （標記），以便擷取剩餘的結果。  
預設：100  
限制條件：最小 20，最大 100。  
類型：整數  
必要：否

## 回應元素
<a name="API_DescribeDBEngineVersions_ResponseElements"></a>

服務會傳回下列元素。

 **DBEngineVersions.DBEngineVersion.N**   
一或多個引擎版本的詳細資訊。  
類型：[DBEngineVersion](API_DBEngineVersion.md) 物件陣列

 ** Marker **   
前一個請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。  
類型：字串

## 錯誤
<a name="API_DescribeDBEngineVersions_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

## 另請參閱
<a name="API_DescribeDBEngineVersions_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBEngineVersions) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBEngineVersions) 

# DescribeDBInstances
<a name="API_DescribeDBInstances"></a>

傳回佈建 Amazon DocumentDB 執行個體的相關資訊。此 API 支援分頁。

## 請求參數
<a name="API_DescribeDBInstances_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** DBInstanceIdentifier **   
使用者提供的執行個體識別符。如果指定此參數，則只會傳回來自特定執行個體的資訊。此參數不區分大小寫。  
限制條件：  
+ 如果提供， 必須符合現有 的識別符`DBInstance`。
類型：字串  
必要：否

 **Filters.Filter.N**   
篩選條件，指定一或多個要描述的執行個體。  
支援的篩選條件：  
+  `db-cluster-id` - 接受叢集識別符和叢集 Amazon Resource Name (ARNs)。結果清單僅包含與由這些 ARNs 識別的叢集相關聯之執行個體的相關資訊。
+  `db-instance-id` - 接受執行個體識別符和執行個體 ARNs。結果清單僅包含這些 ARNs 所識別之執行個體的相關資訊。
類型：[Filter](API_Filter.md) 物件陣列  
必要：否

 ** Marker **   
前一個請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。  
類型：字串  
必要：否

 ** MaxRecords **   
 要在回應中包含的記錄數量上限。如果存在的記錄超過指定的`MaxRecords`值，回應中會包含分頁字符 （標記），以便擷取剩餘的結果。  
預設：100  
限制條件：最小 20，最大 100。  
類型：整數  
必要：否

## 回應元素
<a name="API_DescribeDBInstances_ResponseElements"></a>

服務會傳回下列元素。

 **DBInstances.DBInstance.N**   
一或多個執行個體的詳細資訊。  
類型：[DBInstance](API_DBInstance.md) 物件陣列

 ** Marker **   
前一個請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。  
類型：字串

## 錯誤
<a name="API_DescribeDBInstances_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` 不會參考現有的執行個體。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_DescribeDBInstances_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBInstances) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBInstances) 

# DescribeDBSubnetGroups
<a name="API_DescribeDBSubnetGroups"></a>

傳回 `DBSubnetGroup` 描述的清單。如果指定 `DBSubnetGroupName` ，清單只會包含指定 的描述`DBSubnetGroup`。

## 請求參數
<a name="API_DescribeDBSubnetGroups_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** DBSubnetGroupName **   
要傳回詳細資訊的子網路群組名稱。  
類型：字串  
必要：否

 **Filters.Filter.N**   
目前不支援此參數。  
類型：[Filter](API_Filter.md) 物件陣列  
必要：否

 ** Marker **   
前一個請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。  
類型：字串  
必要：否

 ** MaxRecords **   
 要在回應中包含的記錄數量上限。如果存在的記錄超過指定的`MaxRecords`值，回應中會包含分頁字符 （標記），以便擷取剩餘的結果。  
預設：100  
限制條件：最小 20，最大 100。  
類型：整數  
必要：否

## 回應元素
<a name="API_DescribeDBSubnetGroups_ResponseElements"></a>

服務會傳回下列元素。

 **DBSubnetGroups.DBSubnetGroup.N**   
一或多個子網路群組的詳細資訊。  
類型：[DBSubnetGroup](API_DBSubnetGroup.md) 物件陣列

 ** Marker **   
前一個請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。  
類型：字串

## 錯誤
<a name="API_DescribeDBSubnetGroups_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` 不會參考現有的子網路群組。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_DescribeDBSubnetGroups_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBSubnetGroups) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBSubnetGroups) 

# DescribeEngineDefaultClusterParameters
<a name="API_DescribeEngineDefaultClusterParameters"></a>

傳回叢集資料庫引擎的預設引擎和系統參數資訊。

## 請求參數
<a name="API_DescribeEngineDefaultClusterParameters_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** DBParameterGroupFamily **   
要傳回引擎參數資訊的叢集參數群組系列名稱。  
類型：字串  
必要：是

 **Filters.Filter.N**   
目前不支援此參數。  
類型：[Filter](API_Filter.md) 物件陣列  
必要：否

 ** Marker **   
前一個請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。  
類型：字串  
必要：否

 ** MaxRecords **   
 要在回應中包含的記錄數量上限。如果存在的記錄超過指定的`MaxRecords`值，回應中會包含分頁字符 （標記），以便擷取剩餘的結果。  
預設：100  
限制條件：最小 20，最大 100。  
類型：整數  
必要：否

## 回應元素
<a name="API_DescribeEngineDefaultClusterParameters_ResponseElements"></a>

服務會傳回下列元素。

 ** EngineDefaults **   
包含成功叫用 `DescribeEngineDefaultClusterParameters`操作的結果。  
類型：[EngineDefaults](API_EngineDefaults.md) 物件

## 錯誤
<a name="API_DescribeEngineDefaultClusterParameters_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

## 另請參閱
<a name="API_DescribeEngineDefaultClusterParameters_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) 

# DescribeEventCategories
<a name="API_DescribeEventCategories"></a>

顯示所有事件來源類型或特定來源類型 (如果指定) 的類別清單。

## 請求參數
<a name="API_DescribeEventCategories_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 **Filters.Filter.N**   
目前不支援此參數。  
類型：[Filter](API_Filter.md) 物件陣列  
必要：否

 ** SourceType **   
產生事件的來源類型。  
有效值：`db-instance`、`db-parameter-group`、`db-security-group`  
類型：字串  
必要：否

## 回應元素
<a name="API_DescribeEventCategories_ResponseElements"></a>

服務會傳回下列元素。

 **EventCategoriesMapList.EventCategoriesMap.N**   
事件類別映射的清單。  
類型：[EventCategoriesMap](API_EventCategoriesMap.md) 物件陣列

## 錯誤
<a name="API_DescribeEventCategories_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

## 另請參閱
<a name="API_DescribeEventCategories_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeEventCategories) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeEventCategories) 

# DescribeEvents
<a name="API_DescribeEvents"></a>

傳回過去 14 天內與執行個體、安全群組、快照和資料庫參數群組相關的事件。您可以提供名稱做為參數，以取得特定資料庫執行個體、安全群組、快照或參數群組的特定事件。根據預設，會傳回過去一小時的事件。

## 請求參數
<a name="API_DescribeEvents_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** Duration **   
擷取事件的分鐘數。  
預設：60  
類型：整數  
必要：否

 ** EndTime **   
 擷取事件的時間間隔終點，以 ISO 8601 格式指定。  
範例：2009-07-08T18:00Z  
類型：Timestamp  
必要：否

 **EventCategories.EventCategory.N**   
觸發事件通知訂閱通知的事件類別清單。  
類型：字串陣列  
必要：否

 **Filters.Filter.N**   
目前不支援此參數。  
類型：[Filter](API_Filter.md) 物件陣列  
必要：否

 ** Marker **   
前一個請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。  
類型：字串  
必要：否

 ** MaxRecords **   
 要在回應中包含的記錄數量上限。如果存在的記錄超過指定的`MaxRecords`值，回應中會包含分頁字符 （標記），以便擷取剩餘的結果。  
預設：100  
限制條件：最小 20，最大 100。  
類型：整數  
必要：否

 ** SourceIdentifier **   
要傳回其事件的事件來源識別碼。如未指定，回應中會包含所有來源。  
限制條件：  
+ 如果`SourceIdentifier`提供 ，`SourceType`也必須提供 。
+ 如果來源類型為 `DBInstance`，`DBInstanceIdentifier`則必須提供 。
+ 如果來源類型為 `DBSecurityGroup`，`DBSecurityGroupName`則必須提供 。
+ 如果來源類型為 `DBParameterGroup`，`DBParameterGroupName`則必須提供 。
+ 如果來源類型為 `DBSnapshot`，`DBSnapshotIdentifier`則必須提供 。
+ 不能以連字號結尾，或包含兩個連續連字號。
類型：字串  
必要：否

 ** SourceType **   
事件擷取來源的事件來源。如未指定任何值，則會傳回所有事件。  
類型：字串  
有效值:`db-instance | db-parameter-group | db-security-group | db-snapshot | db-cluster | db-cluster-snapshot`   
必要：否

 ** StartTime **   
 擷取事件的時間間隔起點，以 ISO 8601 格式指定。  
範例：2009-07-08T18:00Z  
類型：Timestamp  
必要：否

## 回應元素
<a name="API_DescribeEvents_ResponseElements"></a>

服務會傳回下列元素。

 **Events.Event.N**   
一或多個事件的詳細資訊。  
類型：[Event](API_Event.md) 物件陣列

 ** Marker **   
前一個請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。  
類型：字串

## 錯誤
<a name="API_DescribeEvents_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

## 另請參閱
<a name="API_DescribeEvents_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeEvents) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeEvents) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeEvents) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeEvents) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeEvents) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeEvents) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeEvents) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeEvents) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeEvents) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeEvents) 

# DescribeEventSubscriptions
<a name="API_DescribeEventSubscriptions"></a>

列出客戶帳戶的所有訂閱描述。訂閱的描述包括 `SubscriptionName`、`SNSTopicARN`、`CustomerID`、`SourceType`、`CreationTime`、 `SourceID`和 `Status`。

如果您指定 `SubscriptionName`， 會列出該訂閱的描述。

## 請求參數
<a name="API_DescribeEventSubscriptions_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 **Filters.Filter.N**   
目前不支援此參數。  
類型：[Filter](API_Filter.md) 物件陣列  
必要：否

 ** Marker **   
前一個請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。  
類型：字串  
必要：否

 ** MaxRecords **   
 要在回應中包含的記錄數量上限。如果存在的記錄超過指定的`MaxRecords`值，回應中會包含分頁字符 （標記），以便擷取剩餘的結果。  
預設：100  
限制條件：最小 20，最大 100。  
類型：整數  
必要：否

 ** SubscriptionName **   
您要描述的 Amazon DocumentDB 事件通知訂閱名稱。  
類型：字串  
必要：否

## 回應元素
<a name="API_DescribeEventSubscriptions_ResponseElements"></a>

服務會傳回下列元素。

 **EventSubscriptionsList.EventSubscription.N**   
事件訂閱的清單。  
類型：[EventSubscription](API_EventSubscription.md) 物件陣列

 ** Marker **   
前一個請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。  
類型：字串

## 錯誤
<a name="API_DescribeEventSubscriptions_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** SubscriptionNotFound **   
訂閱名稱不存在。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_DescribeEventSubscriptions_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeEventSubscriptions) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeEventSubscriptions) 

# DescribeGlobalClusters
<a name="API_DescribeGlobalClusters"></a>

傳回 Amazon DocumentDB 全域叢集的相關資訊。此 API 支援分頁。

**注意**  
此動作僅適用於 Amazon DocumentDB 叢集。

## 請求參數
<a name="API_DescribeGlobalClusters_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 **Filters.Filter.N**   
篩選條件，指定要描述的一或多個全域資料庫叢集。  
支援的篩選條件：`db-cluster-id`接受叢集識別符和叢集 Amazon Resource Name (ARNs)。結果清單只會包含這些 ARNs 所識別叢集的相關資訊。  
類型：[Filter](API_Filter.md) 物件陣列  
必要：否

 ** GlobalClusterIdentifier **   
使用者提供的叢集識別符。如果指定此參數，則只會傳回來自特定叢集的資訊。此參數沒有大小寫之分。  
類型：字串  
長度限制：長度下限為 1。長度上限為 255。  
模式：`[A-Za-z][0-9A-Za-z-:._]*`  
必要：否

 ** Marker **   
前一個 `DescribeGlobalClusters` 請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。  
類型：字串  
必要：否

 ** MaxRecords **   
要在回應中包含的記錄數量上限。如果存在的記錄超過指定的`MaxRecords`值，則稱為標記的分頁字符會包含在回應中，以便您可以擷取剩餘的結果。  
類型：整數  
必要：否

## 回應元素
<a name="API_DescribeGlobalClusters_ResponseElements"></a>

服務會傳回下列元素。

 **GlobalClusters.GlobalClusterMember.N**   
  
類型：[GlobalCluster](API_GlobalCluster.md) 物件陣列

 ** Marker **   
  
類型：字串

## 錯誤
<a name="API_DescribeGlobalClusters_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier` 不是指現有的全域叢集。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_DescribeGlobalClusters_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeGlobalClusters) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeGlobalClusters) 

# DescribeOrderableDBInstanceOptions
<a name="API_DescribeOrderableDBInstanceOptions"></a>

傳回指定引擎的可排序執行個體選項清單。

## 請求參數
<a name="API_DescribeOrderableDBInstanceOptions_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** Engine **   
要擷取執行個體選項的引擎名稱。  
類型：字串  
必要：是

 ** DBInstanceClass **   
執行個體類別篩選條件值。指定此參數，只顯示符合指定執行個體類別的可用方案。  
類型：字串  
必要：否

 ** EngineVersion **   
引擎版本篩選條件值。指定此參數，只顯示符合指定引擎版本的可用方案。  
類型：字串  
必要：否

 **Filters.Filter.N**   
目前不支援此參數。  
類型：[Filter](API_Filter.md) 物件陣列  
必要：否

 ** LicenseModel **   
授權模型篩選條件值。指定此參數，只顯示符合指定授權模型的可用方案。  
類型：字串  
必要：否

 ** Marker **   
前一個請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。  
類型：字串  
必要：否

 ** MaxRecords **   
 要在回應中包含的記錄數量上限。如果存在的記錄超過指定的`MaxRecords`值，回應中會包含分頁字符 （標記），以便擷取剩餘的結果。  
預設：100  
限制條件：最小 20，最大 100。  
類型：整數  
必要：否

 ** Vpc **   
虛擬私有雲端 (VPC) 篩選條件值。指定此參數，以僅顯示可用的 VPC 或非 VPC 供應項目。  
類型：布林值  
必要：否

## 回應元素
<a name="API_DescribeOrderableDBInstanceOptions_ResponseElements"></a>

服務會傳回下列元素。

 ** Marker **   
前一個請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。  
類型：字串

 **OrderableDBInstanceOptions.OrderableDBInstanceOption.N**   
可用於特定可排序執行個體的選項。  
類型：[OrderableDBInstanceOption](API_OrderableDBInstanceOption.md) 物件陣列

## 錯誤
<a name="API_DescribeOrderableDBInstanceOptions_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

## 另請參閱
<a name="API_DescribeOrderableDBInstanceOptions_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS 適用於 Java V2 的開發套件](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) 

# DescribePendingMaintenanceActions
<a name="API_DescribePendingMaintenanceActions"></a>

傳回至少有一個待定維護動作的資源清單 （例如執行個體）。

## 請求參數
<a name="API_DescribePendingMaintenanceActions_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 **Filters.Filter.N**   
篩選條件，指定傳回待處理維護動作的一或多種資源。  
支援的篩選條件：  
+  `db-cluster-id` - 接受叢集識別符和叢集 Amazon Resource Name (ARNs)。結果清單僅包含這些 ARNs 所識別叢集的待定維護動作。
+  `db-instance-id` - 接受執行個體識別符和執行個體 ARNs。結果清單僅包含這些 ARNs 所識別資料庫執行個體的待定維護動作。
類型：[Filter](API_Filter.md) 物件陣列  
必要：否

 ** Marker **   
前一個請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。  
類型：字串  
必要：否

 ** MaxRecords **   
 要在回應中包含的記錄數量上限。如果存在的記錄超過指定的`MaxRecords`值，回應中會包含分頁字符 （標記），以便擷取剩餘的結果。  
預設：100  
限制條件：最小 20，最大 100。  
類型：整數  
必要：否

 ** ResourceIdentifier **   
傳回待處理維護動作的資源 ARN。  
類型：字串  
必要：否

## 回應元素
<a name="API_DescribePendingMaintenanceActions_ResponseElements"></a>

服務會傳回下列元素。

 ** Marker **   
前一個請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。  
類型：字串

 **PendingMaintenanceActions.ResourcePendingMaintenanceActions.N**   
要套用的維護動作。  
類型：[ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md) 物件陣列

## 錯誤
<a name="API_DescribePendingMaintenanceActions_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** ResourceNotFoundFault **   
找不到指定的資源 ID。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_DescribePendingMaintenanceActions_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribePendingMaintenanceActions) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribePendingMaintenanceActions) 

# FailoverDBCluster
<a name="API_FailoverDBCluster"></a>

強制叢集的容錯移轉。

叢集的容錯移轉會將叢集中的其中一個 Amazon DocumentDB 複本 （唯讀執行個體） 提升為主要執行個體 （叢集寫入器）。

如果主要執行個體失敗，Amazon DocumentDB 會自動容錯移轉至 Amazon DocumentDB 複本，如果有的話。當您想要模擬主要執行個體故障以進行測試時，可以強制容錯移轉。

## 請求參數
<a name="API_FailoverDBCluster_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** DBClusterIdentifier **   
強制容錯移轉的叢集識別符。此參數不區分大小寫。  
限制條件：  
+ 必須符合現有 `DBCluster` 的識別碼。
類型：字串  
必要：否

 ** TargetDBInstanceIdentifier **   
要提升為主要執行個體的執行個體名稱。  
您必須為叢集中的 Amazon DocumentDB 複本指定執行個體識別符。例如 `mydbcluster-replica1`。  
類型：字串  
必要：否

## 回應元素
<a name="API_FailoverDBCluster_ResponseElements"></a>

服務會傳回下列元素。

 ** DBCluster **   
叢集的詳細資訊。  
類型：[DBCluster](API_DBCluster.md) 物件

## 錯誤
<a name="API_FailoverDBCluster_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` 不會參考現有的叢集。  
HTTP 狀態碼：404

 ** InvalidDBClusterStateFault **   
叢集未處於有效狀態。  
HTTP 狀態碼：400

 ** InvalidDBInstanceState **   
 指定的執行個體未處於*可用*狀態。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_FailoverDBCluster_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/FailoverDBCluster) 

# FailoverGlobalCluster
<a name="API_FailoverGlobalCluster"></a>

當發生容錯移轉全域叢集時，將指定的次要資料庫叢集提升為全域叢集中的主要資料庫叢集。

使用此操作來回應意外事件，例如主要區域中的區域災難。容錯移轉可能會導致寫入交易資料遺失，這些資料未在容錯移轉事件發生之前複寫到選擇的次要裝置。不過，將所選第二個資料庫叢集上的資料庫執行個體提升為主要寫入器資料庫執行個體的復原程序會保證資料處於交易一致狀態。

## 請求參數
<a name="API_FailoverGlobalCluster_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** GlobalClusterIdentifier **   
套用此操作的 Amazon DocumentDB 全域叢集識別符。識別符是建立叢集時使用者指派的唯一金鑰。換句話說，它是全域叢集的名稱。  
限制條件：  
+ 必須符合現有全域叢集的識別符。
+ 長度下限為 1。長度上限為 255。
模式：`[A-Za-z][0-9A-Za-z-:._]*`  
類型：字串  
長度限制：長度下限為 1。長度上限為 255。  
模式：`[A-Za-z][0-9A-Za-z-:._]*`  
必要：是

 ** TargetDbClusterIdentifier **   
您要提升為全域叢集主要叢集之次要 Amazon DocumentDB 叢集的識別符。使用 Amazon Resource Name (ARN) 做為識別符，讓 Amazon DocumentDB 可以在其 AWS 區域中找到叢集。  
限制條件：  
+ 必須符合現有次要叢集的識別符。
+ 長度下限為 1。長度上限為 255。
模式：`[A-Za-z][0-9A-Za-z-:._]*`  
類型：字串  
長度限制：長度下限為 1。長度上限為 255。  
模式：`[A-Za-z][0-9A-Za-z-:._]*`  
必要：是

 ** AllowDataLoss **   
指定是否允許此全域叢集操作的資料遺失。允許資料遺失會觸發全域容錯移轉操作。  
如果您未指定 `AllowDataLoss`，全域叢集操作會預設為切換。  
限制條件：  
+ 無法與 `Switchover` 參數一起指定。
類型：布林值  
必要：否

 ** Switchover **   
指定是否要切換此全域資料庫叢集。  
限制條件：  
+ 無法與 `AllowDataLoss` 參數一起指定。
類型：布林值  
必要：否

## 回應元素
<a name="API_FailoverGlobalCluster_ResponseElements"></a>

服務會傳回下列元素。

 ** GlobalCluster **   
代表 Amazon DocumentDB 全域叢集的資料類型。  
類型：[GlobalCluster](API_GlobalCluster.md) 物件

## 錯誤
<a name="API_FailoverGlobalCluster_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` 不會參考現有的叢集。  
HTTP 狀態碼：404

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier` 不是指現有的全域叢集。  
HTTP 狀態碼：404

 ** InvalidDBClusterStateFault **   
叢集未處於有效狀態。  
HTTP 狀態碼：400

 ** InvalidGlobalClusterStateFault **   
當叢集處於此狀態時，無法執行請求的操作。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_FailoverGlobalCluster_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/FailoverGlobalCluster) 

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

列出 Amazon DocumentDB 資源上的所有標籤。

## 請求參數
<a name="API_ListTagsForResource_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** ResourceName **   
要列出標籤的 Amazon DocumentDB 資源。這個值是 Amazon Resource Name (ARN)。  
類型：字串  
必要：是

 **Filters.Filter.N**   
目前不支援此參數。  
類型：[Filter](API_Filter.md) 物件陣列  
必要：否

## 回應元素
<a name="API_ListTagsForResource_ResponseElements"></a>

服務會傳回下列元素。

 **TagList.Tag.N**   
一或多個標籤的清單。  
類型：[Tag](API_Tag.md) 物件陣列

## 錯誤
<a name="API_ListTagsForResource_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` 不會參考現有的叢集。  
HTTP 狀態碼：404

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` 不會參考現有的執行個體。  
HTTP 狀態碼：404

 ** DBSnapshotNotFound **   
 `DBSnapshotIdentifier` 不會參考現有的快照。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_ListTagsForResource_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ListTagsForResource) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ListTagsForResource) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ListTagsForResource) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ListTagsForResource) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ListTagsForResource) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ListTagsForResource) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ListTagsForResource) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ListTagsForResource) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ListTagsForResource) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ListTagsForResource) 

# ModifyDBCluster
<a name="API_ModifyDBCluster"></a>

修改 Amazon DocumentDB 叢集的設定。您可以透過在請求中指定這些參數及新的值，來變更一或多個資料庫組態參數。

## 請求參數
<a name="API_ModifyDBCluster_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** DBClusterIdentifier **   
正在修改之叢集的叢集識別符。此參數不區分大小寫。  
限制條件：  
+ 必須符合現有 `DBCluster` 的識別碼。
類型：字串  
必要：是

 ** AllowMajorVersionUpgrade **   
指示是否允許升級主要版本的值。  
限制條件：  
+ 為 `EngineVersion` 參數指定與叢集目前版本不同的主要版本值時，您必須允許主要版本升級。
+ 由於某些參數是版本特定的，因此變更它們需要在就地 MVU 完成後執行新的 `ModifyDBCluster` API 呼叫。
執行 MVU 會直接影響下列參數：  
+  `MasterUserPassword` 
+  `NewDBClusterIdentifier` 
+  `VpcSecurityGroupIds` 
+  `Port` 
類型：布林值  
必要：否

 ** ApplyImmediately **   
指定此請求中的變更和任何待定變更是否以非同步方式盡快套用的值，無論叢集`PreferredMaintenanceWindow`的設定為何。如果此參數設定為 `false`，則會在下一個維護時段套用叢集的變更。  
`ApplyImmediately` 參數只會影響 `NewDBClusterIdentifier`和 `MasterUserPassword`值。如果您將此參數值設定為 `false`，則 `NewDBClusterIdentifier`和 `MasterUserPassword`值的變更會在下一個維護時段套用。所有其他的變更都會立即套用，無論 `ApplyImmediately` 參數的值為何。  
預設：`false`  
類型：布林值  
必要：否

 ** BackupRetentionPeriod **   
自動備份保留的天數。您必須指定一個值 (最小值為 1)。  
預設：1  
限制條件：  
+ 該值必須介於 1 到 35 之間。
類型：整數  
必要：否

 ** CloudwatchLogsExportConfiguration **   
要啟用以匯出至特定執行個體或叢集之 Amazon CloudWatch Logs 的日誌類型的組態設定。`EnableLogTypes` 和 `DisableLogTypes`陣列會決定將哪些日誌匯出 （或未匯出） 至 CloudWatch Logs。  
類型：[CloudwatchLogsExportConfiguration](API_CloudwatchLogsExportConfiguration.md) 物件  
必要：否

 ** DBClusterParameterGroupName **   
要用於叢集的叢集參數群組名稱。  
類型：字串  
必要：否

 ** DeletionProtection **   
指定是否可以刪除此叢集。如果 `DeletionProtection` 已啟用，除非修改並`DeletionProtection`停用，否則無法刪除叢集。 會`DeletionProtection`保護叢集免於意外刪除。  
類型：布林值  
必要：否

 ** EngineVersion **   
您要升級的資料庫引擎版本號碼。變更此參數會造成中斷。變更會在下一次維護時段期間套用，除非已啟用 `ApplyImmediately`。  
若要列出 Amazon DocumentDB 的所有可用引擎版本，請使用下列命令：  
 `aws docdb describe-db-engine-versions --engine docdb --query "DBEngineVersions[].EngineVersion"`   
類型：字串  
必要：否

 ** ManageMasterUserPassword **   
指定是否使用 Amazon Web Services Secrets Manager 管理主要使用者密碼。如果叢集未使用 Amazon Web Services Secrets Manager 管理主要使用者密碼，您可以開啟此管理。在此情況下，您無法指定 `MasterUserPassword`。如果叢集已使用 Amazon Web Services Secrets Manager 管理主要使用者密碼，且您指定主要使用者密碼不是使用 Amazon Web Services Secrets Manager 管理，則您必須指定 `MasterUserPassword`。在此情況下，Amazon DocumentDB 會刪除秘密，並為 指定的主要使用者使用新密碼`MasterUserPassword`。  
類型：布林值  
必要：否

 ** MasterUserPassword **   
主要資料庫使用者的密碼。此密碼可包含任何可印出的 ASCII 字元，但斜線 (/)、雙引號 (") 或 "at" 符號 (@) 則除外。  
限制條件：必須包含 8 到 100 個字元。  
類型：字串  
必要：否

 ** MasterUserSecretKmsKeyId **   
Amazon Web Services KMS 金鑰識別符，用於加密在 Amazon Web Services Secrets Manager 中自動產生和管理的秘密。  
此設定只有在符合下列兩個條件時才有效：  
+ 叢集不會在 Amazon Web Services Secrets Manager 中管理主要使用者密碼。如果叢集已在 Amazon Web Services Secrets Manager 中管理主要使用者密碼，則您無法變更用來加密秘密的 KMS 金鑰。
+ 您能夠`ManageMasterUserPassword`管理 Amazon Web Services Secrets Manager 中的主要使用者密碼。如果您開啟`ManageMasterUserPassword`但未指定 `MasterUserSecretKmsKeyId`，則會使用 `aws/secretsmanager` KMS 金鑰來加密秘密。如果秘密位於不同的 Amazon Web Services 帳戶中，則無法使用 `aws/secretsmanager` KMS 金鑰來加密秘密，而且您必須使用客戶受管的 KMS 金鑰。
Amazon Web Services KMS 金鑰識別符是 KMS 金鑰的金鑰 ARN、金鑰 ID、別名 ARN 或別名名稱。若要在不同的 Amazon Web Services 帳戶中使用 KMS 金鑰，請指定金鑰 ARN 或別名 ARN。  
您的 Amazon Web Services 帳戶有預設 KMS 金鑰。您的 Amazon Web Services 帳戶在每個 Amazon Web Services 區域都有不同的預設 KMS 金鑰。  
類型：字串  
必要：否

 ** NetworkType **   
叢集的網路類型。  
網路類型是由為叢集`DBSubnetGroup`指定的 決定。只能`DBSubnetGroup`支援 IPv4 通訊協定或 IPv4 和 IPv6 通訊協定 (`DUAL`)。  
如需詳細資訊，請參閱《Amazon [DocumentDB 開發人員指南》中的 VPC 中的 DocumentDB 叢集](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html)。 Amazon DocumentDB   
有效值: `IPV4` \$1 `DUAL`   
類型：字串  
必要：否

 ** NewDBClusterIdentifier **   
重新命名叢集時，叢集的新叢集識別碼。此值會以小寫字母字串的形式儲存。  
限制條件：  
+ 必須包含 1 到 63 個字母、數字或連字號。
+ 第一個字元必須是字母。
+ 不能以連字號結尾，或包含兩個連續連字號。
範例：`my-cluster2`  
類型：字串  
必要：否

 ** Port **   
叢集接受連線的連接埠號碼。  
限制條件：必須是從 `1150`到 的值`65535`。  
預設：與原始叢集相同的連接埠。  
類型：整數  
必要：否

 ** PreferredBackupWindow **   
每日的時間範圍，若使用 `BackupRetentionPeriod` 參數啟用自動化備份，則會在此期間建立自動化備份。  
預設值是從每個 8 小時時段隨機選取的 30 分鐘時段 AWS 區域。  
限制條件：  
+ 格式必須為 `hh24:mi-hh24:mi`。
+ 必須以國際標準時間 (UTC) 表示。
+ 不得和慣用的維護時段衝突。
+ 必須至少 30 分鐘。
類型：字串  
必要：否

 ** PreferredMaintenanceWindow **   
每週可能進行系統維護的時段，以國際標準時間 (UTC) 表示。  
格式：`ddd:hh24:mi-ddd:hh24:mi`  
預設值是從每個 8 小時時段中隨機選取的 30 分鐘時段 AWS 區域，隨機發生在一週中的某一天。  
有效日：星期一、星期二、星期三、星期四、星期五、星期六、星期日  
限制條件：必須至少是 30 分鐘的時段。  
類型：字串  
必要：否

 ** RotateMasterUserPassword **   
指定是否要輪換主要使用者密碼的 Amazon Web Services Secrets Manager 管理的秘密。  
只有在叢集的 Amazon Web Services Secrets Manager 中由 Amazon DocumentDB 管理主要使用者密碼時，此設定才有效。秘密值包含更新的密碼。  
限制條件：輪換主要使用者密碼時，您必須立即套用變更。  
類型：布林值  
必要：否

 ** ServerlessV2ScalingConfiguration **   
包含 Amazon DocumentDB Serverless 叢集的擴展組態。  
類型：[ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) 物件  
必要：否

 ** StorageType **   
和資料庫叢集相關聯的儲存類型。  
如需 Amazon DocumentDB 叢集儲存類型的資訊，請參閱《*Amazon DocumentDB 開發人員指南*》中的叢集儲存組態。  
儲存類型 - 的有效值 `standard | iopt1`   
預設值為 `standard `   
類型：字串  
必要：否

 **VpcSecurityGroupIds.VpcSecurityGroupId.N**   
叢集所屬的虛擬私有雲端 (VPC) 安全群組清單。  
類型：字串陣列  
必要：否

## 回應元素
<a name="API_ModifyDBCluster_ResponseElements"></a>

服務會傳回下列元素。

 ** DBCluster **   
叢集的詳細資訊。  
類型：[DBCluster](API_DBCluster.md) 物件

## 錯誤
<a name="API_ModifyDBCluster_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** DBClusterAlreadyExistsFault **   
您已擁有具有指定識別符的叢集。  
HTTP 狀態碼：400

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` 不會參考現有的叢集。  
HTTP 狀態碼：404

 ** DBClusterParameterGroupNotFound **   
 `DBClusterParameterGroupName` 不會參考現有的叢集參數群組。  
HTTP 狀態碼：404

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` 不會參考現有的子網路群組。  
HTTP 狀態碼：404

 ** InvalidDBClusterStateFault **   
叢集未處於有效狀態。  
HTTP 狀態碼：400

 ** InvalidDBInstanceState **   
 指定的執行個體未處於*可用*狀態。  
HTTP 狀態碼：400

 ** InvalidDBSecurityGroupState **   
安全群組的狀態不允許刪除。  
HTTP 狀態碼：400

 ** InvalidDBSubnetGroupStateFault **   
無法刪除子網路群組，因為它正在使用中。  
HTTP 狀態碼：400

 ** InvalidSubnet **   
請求的子網路無效，或請求的多個子網路並非全部位於通用虛擬私有雲端 (VPC) 中。  
HTTP 狀態碼：400

 ** InvalidVPCNetworkStateFault **   
由於進行了變更，子網路群組在建立之後不會涵蓋所有可用區域。  
HTTP 狀態碼：400

 ** NetworkTypeNotSupported **   
`DBSubnetGroup` 或 資料庫引擎版本不支援 網路類型。  
HTTP 狀態碼：400

 ** StorageQuotaExceeded **   
請求將導致您超過所有執行個體允許的可用儲存量。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_ModifyDBCluster_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBCluster) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBCluster) 

# ModifyDBClusterParameterGroup
<a name="API_ModifyDBClusterParameterGroup"></a>

 修改叢集參數群組的參數。若要修改超過一個參數，請提交下列項目的清單：`ParameterName`、`ParameterValue` 和 `ApplyMethod`。單一請求中最多可修改 20 個參數。

**注意**  
動態參數的變更會立即套用。變更靜態參數需要重新啟動或維護時段，變更才能生效。

**重要**  
建立叢集參數群組後，您應等待至少 5 分鐘，然後再建立第一個使用該叢集參數群組做為預設參數群組的叢集。這可讓 Amazon DocumentDB 在參數群組用作新叢集的預設值之前完全完成建立動作。此步驟對建立叢集預設資料庫時的關鍵參數尤其重要，像是 `character_set_database` 參數所定義的預設資料庫字元集。

## 請求參數
<a name="API_ModifyDBClusterParameterGroup_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** DBClusterParameterGroupName **   
要修改之叢集參數群組的名稱。  
類型：字串  
必要：是

 **Parameters.Parameter.N**   
叢集參數群組中要修改的參數清單。  
類型：[Parameter](API_Parameter.md) 物件陣列  
必要：是

## 回應元素
<a name="API_ModifyDBClusterParameterGroup_ResponseElements"></a>

服務會傳回下列元素。

 ** DBClusterParameterGroupName **   
叢集參數群組的名稱。  
限制條件：  
+ 必須是 1 到 255 個字母或數字。
+ 第一個字元必須是字母。
+ 不能以連字號結尾，或包含兩個連續連字號。
此值會以小寫字母字串的形式儲存。
類型：字串

## 錯誤
<a name="API_ModifyDBClusterParameterGroup_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` 不會參考現有的參數群組。  
HTTP 狀態碼：404

 ** InvalidDBParameterGroupState **   
參數群組正在使用中，或處於無效狀態。如果您嘗試刪除參數群組，則無法在參數群組處於此狀態時將其刪除。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_ModifyDBClusterParameterGroup_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBClusterParameterGroup) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBClusterParameterGroup) 

# ModifyDBClusterSnapshotAttribute
<a name="API_ModifyDBClusterSnapshotAttribute"></a>

將屬性和值新增至手動叢集快照，或從中移除屬性和值。

若要與其他 共用手動叢集快照 AWS 帳戶，請將 指定`restore`為 `AttributeName`，並使用 `ValuesToAdd` 參數來新增 AWS 帳戶 授權還原手動叢集快照IDs 清單。使用 值`all`將手動叢集快照設為公有，這表示所有 都可以複製或還原 AWS 帳戶。請勿新增任何手動叢集快照`all`的值，其中包含您不希望所有 都可使用的私有資訊 AWS 帳戶。如果手動叢集快照已加密，則可以共用，但只能指定 `ValuesToAdd` 參數的 AWS 帳戶 IDs清單。本例中無法使用 `all` 做為該參數的值。

## 請求參數
<a name="API_ModifyDBClusterSnapshotAttribute_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** AttributeName **   
要修改的叢集快照屬性名稱。  
若要管理其他 AWS 帳戶 複製或還原手動叢集快照的授權，請將此值設為 `restore`。  
類型：字串  
必要：是

 ** DBClusterSnapshotIdentifier **   
要修改其屬性之叢集快照的識別符。  
類型：字串  
必要：是

 **ValuesToAdd.AttributeValue.N**   
要新增至 指定屬性的叢集快照屬性清單`AttributeName`。  
若要授權其他 AWS 帳戶 複製或還原手動叢集快照，請將此清單設定為包含一或多個 AWS 帳戶 IDs。若要讓手動叢集快照可由任何 還原 AWS 帳戶，請將它設定為 `all`。請勿為包含您不想供所有 使用之私有資訊的任何手動叢集快照新增 `all`值 AWS 帳戶。  
類型：字串陣列  
必要：否

 **ValuesToRemove.AttributeValue.N**   
要從 指定的屬性中移除的叢集快照屬性清單`AttributeName`。  
若要移除其他 AWS 帳戶 複製或還原手動叢集快照的授權，請將此清單設定為包含一或多個 AWS 帳戶 識別符。若要移除任何 AWS 帳戶 複製或還原叢集快照的授權，請將它設定為 `all` 。如果您指定 `all`， AWS 帳戶 其帳戶 ID 明確新增至 `restore` 屬性的 仍然可以複製或還原手動叢集快照。  
類型：字串陣列  
必要：否

## 回應元素
<a name="API_ModifyDBClusterSnapshotAttribute_ResponseElements"></a>

服務會傳回下列元素。

 ** DBClusterSnapshotAttributesResult **   
與叢集快照相關聯的屬性詳細資訊。  
類型：[DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md) 物件

## 錯誤
<a name="API_ModifyDBClusterSnapshotAttribute_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier` 不會參考現有的叢集快照。  
HTTP 狀態碼：404

 ** InvalidDBClusterSnapshotStateFault **   
提供的值不是有效的叢集快照狀態。  
HTTP 狀態碼：400

 ** SharedSnapshotQuotaExceeded **   
您已超過可共享手動資料庫快照的帳戶數量上限。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_ModifyDBClusterSnapshotAttribute_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) 

# ModifyDBInstance
<a name="API_ModifyDBInstance"></a>

修改執行個體的設定。您可以透過在請求中指定這些參數及新的值，來變更一或多個資料庫組態參數。

## 請求參數
<a name="API_ModifyDBInstance_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** DBInstanceIdentifier **   
執行個體識別碼。此值會以小寫字母字串的形式儲存。  
限制條件：  
+ 必須符合現有 `DBInstance` 的識別碼。
類型：字串  
必要：是

 ** ApplyImmediately **   
指定是否盡快非同步套用此請求中的修改和任何待定修改，無論執行個體`PreferredMaintenanceWindow`的設定為何。  
 如果此參數設為 `false`，則會在下一個維護時段套用執行個體的變更。某些參數變更可能會導致中斷，並在下次重新開機時套用。  
預設：`false`  
類型：布林值  
必要：否

 ** AutoMinorVersionUpgrade **   
此參數不適用於 Amazon DocumentDB。無論設定的值為何，Amazon DocumentDB 都不會執行次要版本升級。  
類型：布林值  
必要：否

 ** CACertificateIdentifier **   
指出需要與執行個體建立關聯的憑證。  
類型：字串  
必要：否

 ** CertificateRotationRestart **   
指定是否要在您輪換 SSL/TLS 憑證時重新啟動資料庫執行個體。  
根據預設，當您輪換 SSL/TLS 憑證時，資料庫執行個體會重新啟動。在重新啟動資料庫執行個體之前，不會更新憑證。  
只有在您*未使用* SSL/TLS 連線到資料庫執行個體時，才設定此參數。
如果您使用 SSL/TLS 連線到資料庫執行個體，請參閱《[Amazon DocumentDB 開發人員指南》中的更新您的 Amazon DocumentDB TLS 憑證](https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html)和[加密傳輸中的資料](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html)。 *Amazon DocumentDB *  
類型：布林值  
必要：否

 ** CopyTagsToSnapshot **   
指出是否要將所有標籤從資料庫執行個體複製到資料庫執行個體快照的值。根據預設，不會複製標籤。  
類型：布林值  
必要：否

 ** DBInstanceClass **   
執行個體的新運算和記憶體容量；例如 `db.r5.large`。並非所有執行個體類別皆可在所有 中使用 AWS 區域。  
如果您修改執行個體類別，則會在變更期間發生中斷。變更會在下一個維護時段期間套用，除非針對此請求將 `ApplyImmediately` 指定為 `true`。  
預設：使用現有的設定。  
類型：字串  
必要：否

 ** EnablePerformanceInsights **   
指示是否啟用資料庫執行個體績效詳情的值。如需詳細資訊，請參閱[使用 Amazon 績效詳情](https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html)。  
類型：布林值  
必要：否

 ** NewDBInstanceIdentifier **   
 重新命名執行個體時執行個體的新執行個體識別符。當您變更執行個體識別符時，如果您將 `Apply Immediately`設定為 ，執行個體會立即重新啟動`true`。如果您將 `Apply Immediately`設定為 ，它會在下一個維護時段發生`false`。此值會以小寫字母字串的形式儲存。  
限制條件：  
+ 必須包含 1 到 63 個字母、數字或連字號。
+ 第一個字元必須是字母。
+ 不能以連字號結尾，或包含兩個連續連字號。
範例：`mydbinstance`  
類型：字串  
必要：否

 ** PerformanceInsightsKMSKeyId **   
Performance Insights 資料加密的 AWS KMS 金鑰識別符。  
 AWS KMS 金鑰識別符是 KMS 金鑰的金鑰 ARN、金鑰 ID、別名 ARN 或別名名稱。  
如果您未指定 PerformanceInsightsKMSKeyId 的值，則 Amazon DocumentDB 會使用預設 KMS 金鑰。您的 Amazon Web Services 帳戶有預設 KMS 金鑰。您的 Amazon Web Services 帳戶在每個 Amazon Web Services 區域都有不同的預設 KMS 金鑰。  
類型：字串  
必要：否

 ** PreferredMaintenanceWindow **   
每週可能進行系統維護的時間範圍 (UTC)，在此期間可能會發生中斷。除了下列情況之外，變更此參數不會導致中斷，並且會盡快以非同步方式套用變更。如果存在導致重新啟動的待處理動作，且維護時段已變更為包含目前時間，則變更此參數會導致執行個體重新啟動。如果您要將此時段移至目前時間，則目前時間和時段結束之間必須至少有 30 分鐘，以確保套用待定的變更。  
預設：使用現有的設定。  
格式：`ddd:hh24:mi-ddd:hh24:mi`  
有效日：星期一、星期二、星期三、星期四、星期五、星期六、星期日  
限制條件：必須至少 30 分鐘。  
類型：字串  
必要：否

 ** PromotionTier **   
指定現有主要執行個體故障後，Amazon DocumentDB 複本提升為主要執行個體的順序的值。  
預設：1  
有效值：0-15  
類型：整數  
必要：否

## 回應元素
<a name="API_ModifyDBInstance_ResponseElements"></a>

服務會傳回下列元素。

 ** DBInstance **   
執行個體的詳細資訊。  
類型：[DBInstance](API_DBInstance.md) 物件

## 錯誤
<a name="API_ModifyDBInstance_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** AuthorizationNotFound **   
指定的 CIDR IP 或 Amazon EC2 安全群組未獲得指定安全群組的授權。  
Amazon DocumentDB 也可能無權使用 IAM 代表您執行必要的動作。  
HTTP 狀態碼：404

 ** CertificateNotFound **   
 `CertificateIdentifier` 不會參考現有的憑證。  
HTTP 狀態碼：404

 ** DBInstanceAlreadyExists **   
您已有一個具有指定識別符的執行個體。  
HTTP 狀態碼：400

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` 不會參考現有的執行個體。  
HTTP 狀態碼：404

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` 不參考現有的參數群組。  
HTTP 狀態碼：404

 ** DBSecurityGroupNotFound **   
 `DBSecurityGroupName` 不會參考現有的安全群組。  
HTTP 狀態碼：404

 ** DBUpgradeDependencyFailure **   
升級失敗，因為 所依賴的資源無法修改。  
HTTP 狀態碼：400

 ** InsufficientDBInstanceCapacity **   
指定的執行個體類別無法在指定的可用區域中使用。  
HTTP 狀態碼：400

 ** InvalidDBInstanceState **   
 指定的執行個體未處於*可用*狀態。  
HTTP 狀態碼：400

 ** InvalidDBSecurityGroupState **   
安全群組的狀態不允許刪除。  
HTTP 狀態碼：400

 ** InvalidVPCNetworkStateFault **   
由於進行了變更，子網路群組在建立之後不會涵蓋所有可用區域。  
HTTP 狀態碼：400

 ** StorageQuotaExceeded **   
請求將導致您超過所有執行個體允許的可用儲存量。  
HTTP 狀態碼：400

 ** StorageTypeNotSupported **   
指定的 儲存體`StorageType`無法與資料庫執行個體建立關聯。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_ModifyDBInstance_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBInstance) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBInstance) 

# ModifyDBSubnetGroup
<a name="API_ModifyDBSubnetGroup"></a>

修改現有的子網路群組。子網路群組必須在 中至少兩個可用區域中包含至少一個子網路 AWS 區域。

## 請求參數
<a name="API_ModifyDBSubnetGroup_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** DBSubnetGroupName **   
子網路群組的名稱。此值會以小寫字母字串的形式儲存。您無法修改預設子網路群組。  
限制條件：必須符合現有 `DBSubnetGroup` 的名稱。絕不能為預設值。  
範例：`mySubnetgroup`  
類型：字串  
必要：是

 **SubnetIds.SubnetIdentifier.N**   
子網路群組的 Amazon EC2 子網路 ID。  
類型：字串陣列  
必要：是

 ** DBSubnetGroupDescription **   
子網路群組的描述。  
類型：字串  
必要：否

## 回應元素
<a name="API_ModifyDBSubnetGroup_ResponseElements"></a>

服務會傳回下列元素。

 ** DBSubnetGroup **   
子網路群組的詳細資訊。  
類型：[DBSubnetGroup](API_DBSubnetGroup.md) 物件

## 錯誤
<a name="API_ModifyDBSubnetGroup_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** DBSubnetGroupDoesNotCoverEnoughAZs **   
除非只有一個可用區域，否則子網路群組中的子網路應涵蓋至少兩個可用區域。  
HTTP 狀態碼：400

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` 不會參考現有的子網路群組。  
HTTP 狀態碼：404

 ** DBSubnetQuotaExceededFault **   
請求會導致您超過子網路群組中允許的子網路數量。  
HTTP 狀態碼：400

 ** InvalidSubnet **   
請求的子網路無效，或請求的多個子網路並非全部位於通用虛擬私有雲端 (VPC) 中。  
HTTP 狀態碼：400

 ** SubnetAlreadyInUse **   
子網路已在可用區域中使用。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_ModifyDBSubnetGroup_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBSubnetGroup) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBSubnetGroup) 

# ModifyEventSubscription
<a name="API_ModifyEventSubscription"></a>

修改現有的 Amazon DocumentDB 事件通知訂閱。

## 請求參數
<a name="API_ModifyEventSubscription_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** SubscriptionName **   
Amazon DocumentDB 事件通知訂閱的名稱。  
類型：字串  
必要：是

 ** Enabled **   
 布林值；設定為 `true`以啟用訂閱。  
類型：布林值  
必要：否

 **EventCategories.EventCategory.N**   
 `SourceType` 您要訂閱之 的事件類別清單。  
類型：字串陣列  
必要：否

 ** SnsTopicArn **   
針對事件通知所建立 SNS 主題的 Amazon Resource Name (ARN)。此 ARN 是當您建立並訂閱主題時由 Amazon SNS 所建立。  
類型：字串  
必要：否

 ** SourceType **   
產生事件的來源類型。例如，如果您想要收到執行個體產生事件的通知，請將此參數設定為 `db-instance`。若沒有指定此值，則會傳回所有事件。  
有效值：`db-instance`、`db-parameter-group`、`db-security-group`  
類型：字串  
必要：否

## 回應元素
<a name="API_ModifyEventSubscription_ResponseElements"></a>

服務會傳回下列元素。

 ** EventSubscription **   
您已訂閱之事件的詳細資訊。  
類型：[EventSubscription](API_EventSubscription.md) 物件

## 錯誤
<a name="API_ModifyEventSubscription_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** EventSubscriptionQuotaExceeded **   
您已達到事件訂閱的數量上限。  
HTTP 狀態碼：400

 ** SNSInvalidTopic **   
Amazon SNS 已回應指定主題發生問題。  
HTTP 狀態碼：400

 ** SNSNoAuthorization **   
您沒有發佈至 SNS 主題 Amazon Resource Name (ARN) 的許可。  
HTTP 狀態碼：400

 ** SNSTopicArnNotFound **   
SNS 主題 Amazon Resource Name (ARN) 不存在。  
HTTP 狀態碼：404

 ** SubscriptionCategoryNotFound **   
提供的類別不存在。  
HTTP 狀態碼：404

 ** SubscriptionNotFound **   
訂閱名稱不存在。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_ModifyEventSubscription_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS 適用於 Java V2 的開發套件](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyEventSubscription) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyEventSubscription) 

# ModifyGlobalCluster
<a name="API_ModifyGlobalCluster"></a>

修改 Amazon DocumentDB 全域叢集的設定。您可以在請求中指定這些參數和新值，以變更一或多個組態參數 （例如：刪除保護） 或全域叢集識別符。

**注意**  
此動作僅適用於 Amazon DocumentDB 叢集。

## 請求參數
<a name="API_ModifyGlobalCluster_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** GlobalClusterIdentifier **   
要修改之全域叢集的識別符。此參數沒有大小寫之分。  
限制條件：  
+ 必須符合現有全域叢集的識別符。
類型：字串  
長度限制：長度下限為 1。長度上限為 255。  
模式：`[A-Za-z][0-9A-Za-z-:._]*`  
必要：是

 ** DeletionProtection **   
指出全域叢集是否已啟用刪除保護。啟用刪除保護時，無法刪除全域叢集。  
類型：布林值  
必要：否

 ** NewGlobalClusterIdentifier **   
當您修改全域叢集時，全域叢集的新識別符。此值會以小寫字母字串的形式儲存。  
+ 必須包含 1 到 63 個字母、數字或連字號

  第一個字元必須是字母

  不能以一個連字號結尾或是連續包含兩個連字號
範例：`my-cluster2`  
類型：字串  
長度限制：長度下限為 1。長度上限為 255。  
模式：`[A-Za-z][0-9A-Za-z-:._]*`  
必要：否

## 回應元素
<a name="API_ModifyGlobalCluster_ResponseElements"></a>

服務會傳回下列元素。

 ** GlobalCluster **   
代表 Amazon DocumentDB 全域叢集的資料類型。  
類型：[GlobalCluster](API_GlobalCluster.md) 物件

## 錯誤
<a name="API_ModifyGlobalCluster_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier` 不是指現有的全域叢集。  
HTTP 狀態碼：404

 ** InvalidGlobalClusterStateFault **   
當叢集處於此狀態時，無法執行請求的操作。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_ModifyGlobalCluster_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyGlobalCluster) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyGlobalCluster) 

# RebootDBInstance
<a name="API_RebootDBInstance"></a>

您可能需要重新啟動執行個體，通常是基於維護原因。例如，如果您進行特定變更，或是變更與執行個體相關聯的叢集參數群組，您必須重新啟動執行個體，變更才會生效。

重新啟動執行個體，將重新啟動資料庫引擎服務。重新啟動執行個體會導致暫時性中斷，在此期間，執行個體狀態會設為*重新啟動*。

## 請求參數
<a name="API_RebootDBInstance_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** DBInstanceIdentifier **   
執行個體識別碼。此參數是以小寫字母字串的形式儲存。  
限制條件：  
+ 必須符合現有 `DBInstance` 的識別碼。
類型：字串  
必要：是

 ** ForceFailover **   
 當 時`true`，重新啟動會透過多可用區域容錯移轉執行。  
限制條件：您無法指定執行個體`true`是否未針對異地同步備份設定。  
類型：布林值  
必要：否

## 回應元素
<a name="API_RebootDBInstance_ResponseElements"></a>

服務會傳回下列元素。

 ** DBInstance **   
執行個體的詳細資訊。  
類型：[DBInstance](API_DBInstance.md) 物件

## 錯誤
<a name="API_RebootDBInstance_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` 不會參考現有的執行個體。  
HTTP 狀態碼：404

 ** InvalidDBInstanceState **   
 指定的執行個體未處於*可用*狀態。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_RebootDBInstance_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RebootDBInstance) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RebootDBInstance) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RebootDBInstance) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RebootDBInstance) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RebootDBInstance) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RebootDBInstance) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RebootDBInstance) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RebootDBInstance) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RebootDBInstance) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RebootDBInstance) 

# RemoveFromGlobalCluster
<a name="API_RemoveFromGlobalCluster"></a>

從全域叢集分離 Amazon DocumentDB 次要叢集。叢集會成為具有讀寫功能的獨立叢集，而不是從不同區域中的主要 接收資料。

**注意**  
此動作僅適用於 Amazon DocumentDB 叢集。

## 請求參數
<a name="API_RemoveFromGlobalCluster_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** DbClusterIdentifier **   
識別從 Amazon DocumentDB 全域叢集分離之叢集的 Amazon Resource Name (ARN)。  
類型：字串  
必要：是

 ** GlobalClusterIdentifier **   
要從 Amazon DocumentDB 全域叢集分離的叢集識別符。  
類型：字串  
長度限制：長度下限為 1。長度上限為 255。  
模式：`[A-Za-z][0-9A-Za-z-:._]*`  
必要：是

## 回應元素
<a name="API_RemoveFromGlobalCluster_ResponseElements"></a>

服務會傳回下列元素。

 ** GlobalCluster **   
代表 Amazon DocumentDB 全域叢集的資料類型。  
類型：[GlobalCluster](API_GlobalCluster.md) 物件

## 錯誤
<a name="API_RemoveFromGlobalCluster_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` 不會參考現有的叢集。  
HTTP 狀態碼：404

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier` 不是指現有的全域叢集。  
HTTP 狀態碼：404

 ** InvalidGlobalClusterStateFault **   
當叢集處於此狀態時，無法執行請求的操作。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_RemoveFromGlobalCluster_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RemoveFromGlobalCluster) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RemoveFromGlobalCluster) 

# RemoveSourceIdentifierFromSubscription
<a name="API_RemoveSourceIdentifierFromSubscription"></a>

從現有的 Amazon DocumentDB 事件通知訂閱中移除來源識別符。

## 請求參數
<a name="API_RemoveSourceIdentifierFromSubscription_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** SourceIdentifier **   
 要從訂閱中移除的來源識別符，例如執行個體的執行個體識別符，或安全群組的名稱。  
類型：字串  
必要：是

 ** SubscriptionName **   
您要從中移除來源識別符的 Amazon DocumentDB 事件通知訂閱名稱。  
類型：字串  
必要：是

## 回應元素
<a name="API_RemoveSourceIdentifierFromSubscription_ResponseElements"></a>

服務會傳回下列元素。

 ** EventSubscription **   
您已訂閱之事件的詳細資訊。  
類型：[EventSubscription](API_EventSubscription.md) 物件

## 錯誤
<a name="API_RemoveSourceIdentifierFromSubscription_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** SourceNotFound **   
找不到請求的來源。  
HTTP 狀態碼：404

 ** SubscriptionNotFound **   
訂閱名稱不存在。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_RemoveSourceIdentifierFromSubscription_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) 

# RemoveTagsFromResource
<a name="API_RemoveTagsFromResource"></a>

從 Amazon DocumentDB 資源移除中繼資料標籤。

## 請求參數
<a name="API_RemoveTagsFromResource_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** ResourceName **   
標籤被移除的 Amazon DocumentDB 資源。這個值是 Amazon Resource Name (ARN)。  
類型：字串  
必要：是

 **TagKeys.member.N**   
要移除之標籤的標籤金鑰 (名稱)。  
類型：字串陣列  
必要：是

## 錯誤
<a name="API_RemoveTagsFromResource_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` 不會參考現有的叢集。  
HTTP 狀態碼：404

 ** DBInstanceNotFound **   
 `DBInstanceIdentifier` 不會參考現有的執行個體。  
HTTP 狀態碼：404

 ** DBSnapshotNotFound **   
 `DBSnapshotIdentifier` 不會參考現有的快照。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_RemoveTagsFromResource_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RemoveTagsFromResource) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RemoveTagsFromResource) 

# ResetDBClusterParameterGroup
<a name="API_ResetDBClusterParameterGroup"></a>

 將叢集參數群組的參數修改為預設值。若要重設特定參數，請提交下列項目的清單： `ParameterName`和 `ApplyMethod`。若要重設整個叢集參數群組，請指定 `DBClusterParameterGroupName`和 `ResetAllParameters` 參數。

 當您重設整個群組時，動態參數會立即更新，且靜態參數會設為 `pending-reboot`以在下次重新啟動資料庫執行個體時生效。

## 請求參數
<a name="API_ResetDBClusterParameterGroup_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** DBClusterParameterGroupName **   
要重設之叢集參數群組的名稱。  
類型：字串  
必要：是

 **Parameters.Parameter.N**   
叢集參數群組中要重設為預設值的參數名稱清單。若將 `ResetAllParameters` 參數設為 `true`，您便無法使用此參數。  
類型：[Parameter](API_Parameter.md) 物件陣列  
必要：否

 ** ResetAllParameters **   
設定為 的值`true`，可將叢集參數群組中的所有參數重設為預設值，`false`否則為預設值。若有為 `Parameters` 參數指定參數名稱清單，您便無法使用此參數。  
類型：布林值  
必要：否

## 回應元素
<a name="API_ResetDBClusterParameterGroup_ResponseElements"></a>

服務會傳回下列元素。

 ** DBClusterParameterGroupName **   
叢集參數群組的名稱。  
限制條件：  
+ 必須是 1 到 255 個字母或數字。
+ 第一個字元必須是字母。
+ 不能以連字號結尾，或包含兩個連續連字號。
此值會以小寫字母字串的形式儲存。
類型：字串

## 錯誤
<a name="API_ResetDBClusterParameterGroup_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** DBParameterGroupNotFound **   
 `DBParameterGroupName` 不會參考現有的參數群組。  
HTTP 狀態碼：404

 ** InvalidDBParameterGroupState **   
參數群組正在使用中，或處於無效狀態。如果您嘗試刪除參數群組，則無法在參數群組處於此狀態時將其刪除。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_ResetDBClusterParameterGroup_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ResetDBClusterParameterGroup) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ResetDBClusterParameterGroup) 

# RestoreDBClusterFromSnapshot
<a name="API_RestoreDBClusterFromSnapshot"></a>

從快照或叢集快照建立新的叢集。

如果指定快照，則會使用預設組態和預設安全群組，從來源資料庫快照建立目標叢集。

如果指定叢集快照，則會使用與原始來源資料庫叢集相同的組態，從來源叢集還原點建立目標叢集，但使用預設安全群組建立新叢集。

## 請求參數
<a name="API_RestoreDBClusterFromSnapshot_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** DBClusterIdentifier **   
從快照或叢集快照建立的叢集名稱。此參數不區分大小寫。  
限制條件：  
+ 必須包含 1 到 63 個字母、數字或連字號。
+ 第一個字元必須是字母。
+ 不能以連字號結尾，或包含兩個連續連字號。
範例：`my-snapshot-id`  
類型：字串  
必要：是

 ** Engine **   
用於新叢集的資料庫引擎。  
預設：與來源相同。  
限制條件：必須與來源的引擎相容。  
類型：字串  
必要：是

 ** SnapshotIdentifier **   
還原來源的快照或叢集快照識別碼。  
您可以使用名稱或 Amazon Resource Name (ARN) 來指定叢集快照。不過，您可以只使用 ARN 來指定快照。  
限制條件：  
+ 必須符合現有快照的識別碼。
類型：字串  
必要：是

 **AvailabilityZones.AvailabilityZone.N**   
提供可在還原資料庫叢集中建立執行個體的 Amazon EC2 可用區域清單。  
類型：字串陣列  
必要：否

 ** DBClusterParameterGroupName **   
要與此資料庫叢集建立關聯的資料庫叢集參數群組名稱。  
 *類型*：字串       *必要：*否。  
如果省略此引數，則會使用預設資料庫叢集參數群組。如果提供， 必須符合現有預設資料庫叢集參數群組的名稱。字串必須包含 1 到 255 個字母、數字或連字號。其第一個字元必須是字母，且不能以連字號結尾或包含兩個連續連字號。  
類型：字串  
必要：否

 ** DBSubnetGroupName **   
用於新叢集的子網路群組名稱。  
限制條件：如果提供， 必須符合現有 的名稱`DBSubnetGroup`。  
範例：`mySubnetgroup`  
類型：字串  
必要：否

 ** DeletionProtection **   
指定是否可以刪除此叢集。如果 `DeletionProtection` 已啟用，除非修改並`DeletionProtection`停用，否則無法刪除叢集。 會`DeletionProtection`保護叢集免於意外刪除。  
類型：布林值  
必要：否

 **EnableCloudwatchLogsExports.member.N**   
必須啟用才能匯出至 Amazon CloudWatch Logs 的日誌類型清單。  
類型：字串陣列  
必要：否

 ** EngineVersion **   
用於新叢集的資料庫引擎版本。  
類型：字串  
必要：否

 ** KmsKeyId **   
從資料庫快照或叢集快照還原加密叢集時要使用的 AWS KMS 金鑰識別符。  
 AWS KMS 金鑰識別符是 AWS KMS 加密金鑰的 Amazon Resource Name (ARN)。如果您要使用擁有用來加密新叢集之 AWS KMS 加密金鑰 AWS 帳戶 的相同 來還原叢集，則可以使用 AWS KMS 金鑰別名，而非 AWS KMS 加密金鑰的 ARN。  
如果您未指定 `KmsKeyId` 參數的值，會發生以下情況：  
+ 如果 中的快照或叢集快照`SnapshotIdentifier`已加密，則還原的叢集會使用用來加密快照或叢集快照的 AWS KMS 金鑰進行加密。
+ 如果 `SnapshotIdentifier` 中的快照或叢集快照未加密，則還原的資料庫叢集不會加密。
類型：字串  
必要：否

 ** NetworkType **   
叢集的網路類型。  
網路類型由為叢集`DBSubnetGroup`指定的 決定。只能`DBSubnetGroup`支援 IPv4 通訊協定或 IPv4 和 IPv6 通訊協定 (`DUAL`)。  
如需詳細資訊，請參閱《Amazon [DocumentDB 開發人員指南》中的 VPC 中的 DocumentDB 叢集](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html)。 Amazon DocumentDB   
有效值: `IPV4` \$1 `DUAL`   
類型：字串  
必要：否

 ** Port **   
新叢集接受連線的連接埠號碼。  
限制條件：必須是從 `1150`到 的值`65535`。  
預設：與原始叢集相同的連接埠。  
類型：整數  
必要：否

 ** ServerlessV2ScalingConfiguration **   
包含 Amazon DocumentDB Serverless 叢集的擴展組態。  
類型：[ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) 物件  
必要：否

 ** StorageType **   
和資料庫叢集相關聯的儲存類型。  
如需 Amazon DocumentDB 叢集儲存類型的資訊，請參閱《*Amazon DocumentDB 開發人員指南*》中的叢集儲存組態。  
儲存類型 - 的有效值 `standard | iopt1`   
預設值為 `standard `   
類型：字串  
必要：否

 **Tags.Tag.N**   
要指派給還原叢集的標籤。  
類型：[Tag](API_Tag.md) 物件陣列  
必要：否

 **VpcSecurityGroupIds.VpcSecurityGroupId.N**   
新叢集所屬的虛擬私有雲端 (VPC) 安全群組清單。  
類型：字串陣列  
必要：否

## 回應元素
<a name="API_RestoreDBClusterFromSnapshot_ResponseElements"></a>

服務會傳回下列元素。

 ** DBCluster **   
叢集的詳細資訊。  
類型：[DBCluster](API_DBCluster.md) 物件

## 錯誤
<a name="API_RestoreDBClusterFromSnapshot_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** DBClusterAlreadyExistsFault **   
您已擁有具有指定識別符的叢集。  
HTTP 狀態碼：400

 ** DBClusterQuotaExceededFault **   
無法建立叢集，因為您已達到叢集允許的配額上限。  
HTTP 狀態碼：403

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier` 不會參考現有的叢集快照。  
HTTP 狀態碼：404

 ** DBSnapshotNotFound **   
 `DBSnapshotIdentifier` 不會參考現有的快照。  
HTTP 狀態碼：404

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` 不會參考現有的子網路群組。  
HTTP 狀態碼：404

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` 不會參考現有的子網路群組。  
HTTP 狀態碼：404

 ** InsufficientDBClusterCapacityFault **   
叢集沒有足夠的容量，無法進行目前的操作。  
HTTP 狀態碼：403

 ** InsufficientStorageClusterCapacity **   
目前動作的可用儲存空間不足。您可以透過更新子網路群組以使用具有更多可用儲存空間的不同可用區域來解決此錯誤。  
HTTP 狀態碼：400

 ** InvalidDBClusterSnapshotStateFault **   
提供的值不是有效的叢集快照狀態。  
HTTP 狀態碼：400

 ** InvalidDBSnapshotState **   
快照的狀態不允許刪除。  
HTTP 狀態碼：400

 ** InvalidRestoreFault **   
您無法從虛擬私有雲端 (VPC) 備份還原至非 VPC 資料庫執行個體。  
HTTP 狀態碼：400

 ** InvalidSubnet **   
請求的子網路無效，或請求的多個子網路並非全部位於通用虛擬私有雲端 (VPC) 中。  
HTTP 狀態碼：400

 ** InvalidVPCNetworkStateFault **   
由於進行了變更，子網路群組在建立之後不會涵蓋所有可用區域。  
HTTP 狀態碼：400

 ** KMSKeyNotAccessibleFault **   
存取 AWS KMS 金鑰時發生錯誤。  
HTTP 狀態碼：400

 ** NetworkTypeNotSupported **   
`DBSubnetGroup` 或 資料庫引擎版本不支援 網路類型。  
HTTP 狀態碼：400

 ** StorageQuotaExceeded **   
請求將導致您超過所有執行個體允許的可用儲存量。  
HTTP 狀態碼：400

 ** StorageQuotaExceeded **   
請求將導致您超過所有執行個體允許的可用儲存量。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_RestoreDBClusterFromSnapshot_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RestoreDBClusterFromSnapshot) 

# RestoreDBClusterToPointInTime
<a name="API_RestoreDBClusterToPointInTime"></a>

將叢集還原至任意時間點。使用者可以還原到 `LatestRestorableTime` 之前的任意時間點，最多 `BackupRetentionPeriod` 天。目標叢集是從來源叢集建立，其組態與原始叢集相同，但使用預設安全群組建立新叢集。

## 請求參數
<a name="API_RestoreDBClusterToPointInTime_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** DBClusterIdentifier **   
要建立之新叢集的名稱。  
限制條件：  
+ 必須包含 1 到 63 個字母、數字或連字號。
+ 第一個字元必須是字母。
+ 不能以連字號結尾，或包含兩個連續連字號。
類型：字串  
必要：是

 ** SourceDBClusterIdentifier **   
還原來源之來源叢集的識別符。  
限制條件：  
+ 必須符合現有 `DBCluster` 的識別碼。
類型：字串  
必要：是

 ** DBSubnetGroupName **   
用於新叢集的子網路群組名稱。  
限制條件：如果提供， 必須符合現有 的名稱`DBSubnetGroup`。  
範例：`mySubnetgroup`  
類型：字串  
必要：否

 ** DeletionProtection **   
指定是否可以刪除此叢集。如果 `DeletionProtection` 已啟用，除非修改並`DeletionProtection`停用，否則無法刪除叢集。 會`DeletionProtection`保護叢集免於意外刪除。  
類型：布林值  
必要：否

 **EnableCloudwatchLogsExports.member.N**   
必須啟用才能匯出至 Amazon CloudWatch Logs 的日誌類型清單。  
類型：字串陣列  
必要：否

 ** KmsKeyId **   
從加密叢集還原加密叢集時要使用的 AWS KMS 金鑰識別符。  
 AWS KMS 金鑰識別符是 AWS KMS 加密金鑰的 Amazon Resource Name (ARN)。如果您要使用擁有用來加密新叢集之 AWS KMS 加密金鑰 AWS 帳戶 的相同 來還原叢集，則可以使用 AWS KMS 金鑰別名，而非 AWS KMS 加密金鑰的 ARN。  
您可以還原至新的叢集，並使用與用來加密來源叢集的 AWS KMS 金鑰不同的 AWS KMS 金鑰來加密新的叢集。新的資料庫叢集會使用 `KmsKeyId` 參數識別的 AWS KMS 金鑰加密。  
如果您未指定 `KmsKeyId` 參數的值，會發生以下情況：  
+ 如果叢集已加密，則還原的叢集會使用用來加密來源叢集的 AWS KMS 金鑰進行加密。
+ 如果叢集未加密，則還原的叢集不會加密。
如果 `DBClusterIdentifier`是指未加密的叢集，則還原請求會遭到拒絕。  
類型：字串  
必要：否

 ** NetworkType **   
叢集的網路類型。  
網路類型是由為叢集`DBSubnetGroup`指定的 決定。只能`DBSubnetGroup`支援 IPv4 通訊協定或 IPv4 和 IPv6 通訊協定 (`DUAL`)。  
如需詳細資訊，請參閱《Amazon [DocumentDB 開發人員指南》中的 VPC 中的 DocumentDB 叢集](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html)。 Amazon DocumentDB   
有效值: `IPV4` \$1 `DUAL`   
類型：字串  
必要：否

 ** Port **   
新叢集接受連線的連接埠號碼。  
限制條件：必須是從 `1150`到 的值`65535`。  
預設：引擎的預設連接埠。  
類型：整數  
必要：否

 ** RestoreToTime **   
將叢集還原至此日期和時間。  
有效值：國際標準時間 (UTC) 格式的時間。  
限制條件：  
+ 必須在執行個體最近一次可還原時間之前。
+ 如果未提供 `UseLatestRestorableTime` 參數，則必須指定。
+ 如果 `UseLatestRestorableTime` 參數為 `true`，則無法指定。
+ 如果 `RestoreType` 參數為 `copy-on-write`，則無法指定。
範例：`2015-03-07T23:45:00Z`  
類型：Timestamp  
必要：否

 ** RestoreType **   
要執行的還原類型。您可以指定下列其中一個值：  
+  `full-copy` - 新資料庫叢集將還原為來源資料庫叢集的完整複本。
+  `copy-on-write` - 新資料庫叢集將還原為來源資料庫叢集的複製品。
限制：如果來源資料庫叢集的引擎版本早於 1.11，您無法指定 `copy-on-write`。  
如果您不指定 `RestoreType` 值，則新資料庫叢集會還原為來源資料庫叢集的完整複本。  
類型：字串  
必要：否

 ** ServerlessV2ScalingConfiguration **   
包含 Amazon DocumentDB Serverless 叢集的擴展組態。  
類型：[ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) 物件  
必要：否

 ** StorageType **   
和資料庫叢集相關聯的儲存類型。  
如需 Amazon DocumentDB 叢集儲存類型的資訊，請參閱《*Amazon DocumentDB 開發人員指南*》中的叢集儲存組態。  
儲存類型 - 的有效值 `standard | iopt1`   
預設值為 `standard `   
類型：字串  
必要：否

 **Tags.Tag.N**   
要指派給還原叢集的標籤。  
類型：[Tag](API_Tag.md) 物件陣列  
必要：否

 ** UseLatestRestorableTime **   
值設定為 `true` 可將叢集還原到最近可還原的備份時間，否則為 `false`。  
預設：`false`  
限制條件：如果提供了 `RestoreToTime` 參數，則無法指定。  
類型：布林值  
必要：否

 **VpcSecurityGroupIds.VpcSecurityGroupId.N**   
新叢集所屬的 VPC 安全群組清單。  
類型：字串陣列  
必要：否

## 回應元素
<a name="API_RestoreDBClusterToPointInTime_ResponseElements"></a>

服務會傳回下列元素。

 ** DBCluster **   
叢集的詳細資訊。  
類型：[DBCluster](API_DBCluster.md) 物件

## 錯誤
<a name="API_RestoreDBClusterToPointInTime_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** DBClusterAlreadyExistsFault **   
您已擁有具有指定識別符的叢集。  
HTTP 狀態碼：400

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` 不會參考現有的叢集。  
HTTP 狀態碼：404

 ** DBClusterQuotaExceededFault **   
無法建立叢集，因為您已達到叢集允許的配額上限。  
HTTP 狀態碼：403

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier` 不會參考現有的叢集快照。  
HTTP 狀態碼：404

 ** DBSubnetGroupNotFoundFault **   
 `DBSubnetGroupName` 不會參考現有的子網路群組。  
HTTP 狀態碼：404

 ** InsufficientDBClusterCapacityFault **   
叢集沒有足夠的容量可進行目前的操作。  
HTTP 狀態碼：403

 ** InsufficientStorageClusterCapacity **   
目前動作的可用儲存空間不足。您可以透過更新子網路群組以使用具有更多可用儲存空間的不同可用區域來解決此錯誤。  
HTTP 狀態碼：400

 ** InvalidDBClusterSnapshotStateFault **   
提供的值不是有效的叢集快照狀態。  
HTTP 狀態碼：400

 ** InvalidDBClusterStateFault **   
叢集未處於有效狀態。  
HTTP 狀態碼：400

 ** InvalidDBSnapshotState **   
快照的狀態不允許刪除。  
HTTP 狀態碼：400

 ** InvalidRestoreFault **   
您無法從虛擬私有雲端 (VPC) 備份還原至非 VPC 資料庫執行個體。  
HTTP 狀態碼：400

 ** InvalidSubnet **   
請求的子網路無效，或請求的多個子網路並非全部位於通用虛擬私有雲端 (VPC) 中。  
HTTP 狀態碼：400

 ** InvalidVPCNetworkStateFault **   
由於進行了變更，子網路群組在建立之後不會涵蓋所有可用區域。  
HTTP 狀態碼：400

 ** KMSKeyNotAccessibleFault **   
存取 AWS KMS 金鑰時發生錯誤。  
HTTP 狀態碼：400

 ** NetworkTypeNotSupported **   
`DBSubnetGroup` 或 資料庫引擎版本不支援 網路類型。  
HTTP 狀態碼：400

 ** StorageQuotaExceeded **   
請求將導致您超過所有執行個體允許的可用儲存量。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_RestoreDBClusterToPointInTime_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RestoreDBClusterToPointInTime) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RestoreDBClusterToPointInTime) 

# StartDBCluster
<a name="API_StartDBCluster"></a>

重新啟動由 指定的已停止叢集`DBClusterIdentifier`。如需詳細資訊，請參閱[停止和啟動 Amazon DocumentDB 叢集](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html)。

## 請求參數
<a name="API_StartDBCluster_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** DBClusterIdentifier **   
要重新啟動之叢集的識別符。範例：`docdb-2019-05-28-15-24-52`  
類型：字串  
必要：是

## 回應元素
<a name="API_StartDBCluster_ResponseElements"></a>

服務會傳回下列元素。

 ** DBCluster **   
叢集的詳細資訊。  
類型：[DBCluster](API_DBCluster.md) 物件

## 錯誤
<a name="API_StartDBCluster_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` 不會參考現有的叢集。  
HTTP 狀態碼：404

 ** InvalidDBClusterStateFault **   
叢集未處於有效狀態。  
HTTP 狀態碼：400

 ** InvalidDBInstanceState **   
 指定的執行個體未處於*可用*狀態。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_StartDBCluster_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/StartDBCluster) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/StartDBCluster) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/StartDBCluster) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/StartDBCluster) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/StartDBCluster) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/StartDBCluster) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/StartDBCluster) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/StartDBCluster) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/StartDBCluster) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/StartDBCluster) 

# StopDBCluster
<a name="API_StopDBCluster"></a>

停止 指定的執行中叢集`DBClusterIdentifier`。叢集必須處於*可用*狀態。如需詳細資訊，請參閱[停止和啟動 Amazon DocumentDB 叢集](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html)。

## 請求參數
<a name="API_StopDBCluster_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** DBClusterIdentifier **   
要停止的叢集識別符。範例：`docdb-2019-05-28-15-24-52`  
類型：字串  
必要：是

## 回應元素
<a name="API_StopDBCluster_ResponseElements"></a>

服務會傳回下列元素。

 ** DBCluster **   
叢集的詳細資訊。  
類型：[DBCluster](API_DBCluster.md) 物件

## 錯誤
<a name="API_StopDBCluster_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` 不會參考現有的叢集。  
HTTP 狀態碼：404

 ** InvalidDBClusterStateFault **   
叢集未處於有效狀態。  
HTTP 狀態碼：400

 ** InvalidDBInstanceState **   
 指定的執行個體未處於*可用*狀態。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_StopDBCluster_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/StopDBCluster) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/StopDBCluster) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/StopDBCluster) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/StopDBCluster) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/StopDBCluster) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/StopDBCluster) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/StopDBCluster) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/StopDBCluster) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/StopDBCluster) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/StopDBCluster) 

# SwitchoverGlobalCluster
<a name="API_SwitchoverGlobalCluster"></a>

將指定的次要 Amazon DocumentDB 叢集切換為全域資料庫叢集中的新主要 Amazon DocumentDB 叢集。

## 請求參數
<a name="API_SwitchoverGlobalCluster_RequestParameters"></a>

 如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

 ** GlobalClusterIdentifier **   
要切換之 Amazon DocumentDB 全域資料庫叢集的識別符。識別符是建立叢集時使用者指派的唯一金鑰。換句話說，它是全域叢集的名稱。此參數不區分大小寫。  
限制條件：  
+ 必須符合現有全域叢集的識別符 (Amazon DocumentDB 全域資料庫）。
+ 長度下限為 1。長度上限為 255。
模式：`[A-Za-z][0-9A-Za-z-:._]*`  
類型：字串  
長度限制：長度下限為 1。長度上限為 255。  
模式：`[A-Za-z][0-9A-Za-z-:._]*`  
必要：是

 ** TargetDbClusterIdentifier **   
要提升為全域資料庫叢集新主要叢集的次要 Amazon DocumentDB 叢集識別符。使用 Amazon Resource Name (ARN) 做為識別符，讓 Amazon DocumentDB 可以在其 AWS 區域中找到叢集。  
限制條件：  
+ 必須符合現有次要叢集的識別符。
+ 長度下限為 1。長度上限為 255。
模式：`[A-Za-z][0-9A-Za-z-:._]*`  
類型：字串  
長度限制：長度下限為 1。長度上限為 255。  
模式：`[A-Za-z][0-9A-Za-z-:._]*`  
必要：是

## 回應元素
<a name="API_SwitchoverGlobalCluster_ResponseElements"></a>

服務會傳回下列元素。

 ** GlobalCluster **   
代表 Amazon DocumentDB 全域叢集的資料類型。  
類型：[GlobalCluster](API_GlobalCluster.md) 物件

## 錯誤
<a name="API_SwitchoverGlobalCluster_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` 不會參考現有的叢集。  
HTTP 狀態碼：404

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier` 不是指現有的全域叢集。  
HTTP 狀態碼：404

 ** InvalidDBClusterStateFault **   
叢集未處於有效狀態。  
HTTP 狀態碼：400

 ** InvalidGlobalClusterStateFault **   
當叢集處於此狀態時，無法執行請求的操作。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_SwitchoverGlobalCluster_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS 適用於 Java V2 的開發套件](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/SwitchoverGlobalCluster) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/SwitchoverGlobalCluster) 

# Amazon DocumentDB Elastic Clusters
<a name="API_Operations_Amazon_DocumentDB_Elastic_Clusters"></a>

Amazon DocumentDB Elastic Clusters 支援下列動作：
+  [ApplyPendingMaintenanceAction](API_elastic_ApplyPendingMaintenanceAction.md) 
+  [CopyClusterSnapshot](API_elastic_CopyClusterSnapshot.md) 
+  [CreateCluster](API_elastic_CreateCluster.md) 
+  [CreateClusterSnapshot](API_elastic_CreateClusterSnapshot.md) 
+  [DeleteCluster](API_elastic_DeleteCluster.md) 
+  [DeleteClusterSnapshot](API_elastic_DeleteClusterSnapshot.md) 
+  [GetCluster](API_elastic_GetCluster.md) 
+  [GetClusterSnapshot](API_elastic_GetClusterSnapshot.md) 
+  [GetPendingMaintenanceAction](API_elastic_GetPendingMaintenanceAction.md) 
+  [ListClusters](API_elastic_ListClusters.md) 
+  [ListClusterSnapshots](API_elastic_ListClusterSnapshots.md) 
+  [ListPendingMaintenanceActions](API_elastic_ListPendingMaintenanceActions.md) 
+  [ListTagsForResource](API_elastic_ListTagsForResource.md) 
+  [RestoreClusterFromSnapshot](API_elastic_RestoreClusterFromSnapshot.md) 
+  [StartCluster](API_elastic_StartCluster.md) 
+  [StopCluster](API_elastic_StopCluster.md) 
+  [TagResource](API_elastic_TagResource.md) 
+  [UntagResource](API_elastic_UntagResource.md) 
+  [UpdateCluster](API_elastic_UpdateCluster.md) 

# ApplyPendingMaintenanceAction
<a name="API_elastic_ApplyPendingMaintenanceAction"></a>

要套用至資源的待定維護動作類型。

## 請求語法
<a name="API_elastic_ApplyPendingMaintenanceAction_RequestSyntax"></a>

```
POST /pending-action HTTP/1.1
Content-type: application/json

{
   "applyAction": "string",
   "applyOn": "string",
   "optInType": "string",
   "resourceArn": "string"
}
```

## URI 請求參數
<a name="API_elastic_ApplyPendingMaintenanceAction_RequestParameters"></a>

請求不會使用任何 URI 參數。

## 請求主體
<a name="API_elastic_ApplyPendingMaintenanceAction_RequestBody"></a>

請求接受採用 JSON 格式的下列資料。

 ** [applyAction](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) **   <a name="documentdb-elastic_ApplyPendingMaintenanceAction-request-applyAction"></a>
要套用至資源的待定維護動作。  
有效的動作為：  
+  `ENGINE_UPDATE ` 
+  `ENGINE_UPGRADE` 
+  `SECURITY_UPDATE` 
+  `OS_UPDATE` 
+  `MASTER_USER_PASSWORD_UPDATE` 
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
必要：是

 ** [optInType](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) **   <a name="documentdb-elastic_ApplyPendingMaintenanceAction-request-optInType"></a>
值，指定選擇使用請求的類型，或復原選擇使用請求。無法復原 `IMMEDIATE` 類型的選擇使用請求。  
類型：字串  
有效值:`IMMEDIATE | NEXT_MAINTENANCE | APPLY_ON | UNDO_OPT_IN`   
必要：是

 ** [resourceArn](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) **   <a name="documentdb-elastic_ApplyPendingMaintenanceAction-request-resourceArn"></a>
套用待定維護動作之資源的 Amazon DocumentDB Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
必要：是

 ** [applyOn](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) **   <a name="documentdb-elastic_ApplyPendingMaintenanceAction-request-applyOn"></a>
套用待定維護動作的特定日期。如果opt-in-type為 ，則為必要`APPLY_ON`。格式：`yyyy/MM/dd HH:mm-yyyy/MM/dd HH:mm`  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
必要：否

## 回應語法
<a name="API_elastic_ApplyPendingMaintenanceAction_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "resourcePendingMaintenanceAction": { 
      "pendingMaintenanceActionDetails": [ 
         { 
            "action": "string",
            "autoAppliedAfterDate": "string",
            "currentApplyDate": "string",
            "description": "string",
            "forcedApplyDate": "string",
            "optInStatus": "string"
         }
      ],
      "resourceArn": "string"
   }
}
```

## 回應元素
<a name="API_elastic_ApplyPendingMaintenanceAction_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [resourcePendingMaintenanceAction](#API_elastic_ApplyPendingMaintenanceAction_ResponseSyntax) **   <a name="documentdb-elastic_ApplyPendingMaintenanceAction-response-resourcePendingMaintenanceAction"></a>
正在套用的待定維護動作的輸出。  
類型：[ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md) 物件

## 錯誤
<a name="API_elastic_ApplyPendingMaintenanceAction_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** AccessDeniedException **   
當沒有足夠的許可來執行動作時，就會發生例外狀況。    
 ** message **   
錯誤訊息，說明拒絕存取的原因。
HTTP 狀態碼：403

 ** ConflictException **   
發生存取衝突。    
 ** resourceId **   
發生存取衝突的資源 ID。  
 ** resourceType **   
發生存取衝突的資源類型。
HTTP 狀態碼：409

 ** InternalServerException **   
發生內部伺服器錯誤。  
HTTP 狀態碼：500

 ** ResourceNotFoundException **   
找不到指定的資源。    
 ** message **   
描述失敗的錯誤訊息。  
 ** resourceId **   
找不到的資源 ID。  
 ** resourceType **   
找不到的資源類型。
HTTP 狀態碼：404

 ** ThrottlingException **   
當請求因請求調節而遭拒時，將會擲回 ThrottlingException。    
 ** retryAfterSeconds **   
重試操作之前要等待的秒數。
HTTP 狀態碼：429

 ** ValidationException **   
定義驗證例外狀況的結構。    
 ** fieldList **   
發生驗證例外狀況的欄位清單。  
 ** message **   
描述驗證例外狀況的錯誤訊息。  
 ** reason **   
驗證例外發生的原因 (`unknownOperation`、`fieldValidationFailed`、 `cannotParse`或 之一`other`)。
HTTP 狀態碼：400

## 另請參閱
<a name="API_elastic_ApplyPendingMaintenanceAction_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) 

# CopyClusterSnapshot
<a name="API_elastic_CopyClusterSnapshot"></a>

複製彈性叢集的快照。

## 請求語法
<a name="API_elastic_CopyClusterSnapshot_RequestSyntax"></a>

```
POST /cluster-snapshot/snapshotArn/copy HTTP/1.1
Content-type: application/json

{
   "copyTags": boolean,
   "kmsKeyId": "string",
   "tags": { 
      "string" : "string" 
   },
   "targetSnapshotName": "string"
}
```

## URI 請求參數
<a name="API_elastic_CopyClusterSnapshot_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [snapshotArn](#API_elastic_CopyClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-request-uri-snapshotArn"></a>
彈性叢集快照的 Amazon Resource Name (ARN) 識別符。  
必要：是

## 請求主體
<a name="API_elastic_CopyClusterSnapshot_RequestBody"></a>

請求接受採用 JSON 格式的下列資料。

 ** [targetSnapshotName](#API_elastic_CopyClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-request-targetSnapshotName"></a>
要從來源叢集快照建立之新彈性叢集快照的識別符。此參數不區分大小寫。  
限制條件：  
+ 必須包含 1 到 63 個字母、數字或連字號。
+ 第一個字元必須是字母。
+ 不能以連字號結尾，或包含兩個連續連字號。
範例：`elastic-cluster-snapshot-5`  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
必要：是

 ** [copyTags](#API_elastic_CopyClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-request-copyTags"></a>
設定為 `true`，將所有標籤從來源叢集快照複製到目標彈性叢集快照。預設值為 `false`。  
類型：布林值  
必要：否

 ** [kmsKeyId](#API_elastic_CopyClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-request-kmsKeyId"></a>
加密彈性叢集快照的 AWS KMS 金鑰 ID。 AWS KMS 金鑰 ID 是 Amazon Resource Name (ARN)、 AWS KMS 金鑰識別符或 AWS KMS 加密金鑰的 AWS KMS 金鑰別名。  
如果您從 AWS 帳戶複製加密的彈性叢集快照，您可以指定 的值`KmsKeyId`，以使用新的 AWS S KMS 加密金鑰來加密複本。如果您未指定 的值`KmsKeyId`，則彈性叢集快照的副本會使用與來源彈性叢集快照相同的 `AWS` KMS 金鑰加密。  
如果您複製未加密的彈性叢集快照並指定 `KmsKeyId` 參數的值，則會傳回錯誤。  
類型：字串  
必要：否

 ** [tags](#API_elastic_CopyClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-request-tags"></a>
要指派給彈性叢集快照的標籤。  
類型：字串到字串映射  
索引鍵長度限制：長度下限為 1。長度上限為 128。  
金鑰模式：`(?!aws:)[a-zA-Z+-=._:/]+`  
值長度限制：長度下限為 0。長度上限為 256。  
必要：否

## 回應語法
<a name="API_elastic_CopyClusterSnapshot_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "snapshot": { 
      "adminUserName": "string",
      "clusterArn": "string",
      "clusterCreationTime": "string",
      "kmsKeyId": "string",
      "snapshotArn": "string",
      "snapshotCreationTime": "string",
      "snapshotName": "string",
      "snapshotType": "string",
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## 回應元素
<a name="API_elastic_CopyClusterSnapshot_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [snapshot](#API_elastic_CopyClusterSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_CopyClusterSnapshot-response-snapshot"></a>
傳回特定彈性叢集快照的相關資訊。  
類型：[ClusterSnapshot](API_elastic_ClusterSnapshot.md) 物件

## 錯誤
<a name="API_elastic_CopyClusterSnapshot_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** AccessDeniedException **   
當沒有足夠的許可來執行動作時，就會發生例外狀況。    
 ** message **   
錯誤訊息，說明拒絕存取的原因。
HTTP 狀態碼：403

 ** ConflictException **   
發生存取衝突。    
 ** resourceId **   
發生存取衝突的資源 ID。  
 ** resourceType **   
發生存取衝突的資源類型。
HTTP 狀態碼：409

 ** InternalServerException **   
發生內部伺服器錯誤。  
HTTP 狀態碼：500

 ** ResourceNotFoundException **   
找不到指定的資源。    
 ** message **   
描述失敗的錯誤訊息。  
 ** resourceId **   
找不到的資源 ID。  
 ** resourceType **   
找不到的資源類型。
HTTP 狀態碼：404

 ** ServiceQuotaExceededException **   
已超過 動作的服務配額。  
HTTP 狀態碼：402

 ** ThrottlingException **   
當請求因請求調節而遭拒時，將會擲回 ThrottlingException。    
 ** retryAfterSeconds **   
重試操作之前要等待的秒數。
HTTP 狀態碼：429

 ** ValidationException **   
定義驗證例外狀況的結構。    
 ** fieldList **   
發生驗證例外狀況的欄位清單。  
 ** message **   
描述驗證例外狀況的錯誤訊息。  
 ** reason **   
驗證例外發生的原因 (`unknownOperation`、`fieldValidationFailed`、 `cannotParse`或 之一`other`)。
HTTP 狀態碼：400

## 另請參閱
<a name="API_elastic_CopyClusterSnapshot_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CopyClusterSnapshot) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CopyClusterSnapshot) 

# CreateCluster
<a name="API_elastic_CreateCluster"></a>

建立新的 Amazon DocumentDB 彈性叢集，並傳回其叢集結構。

## 請求語法
<a name="API_elastic_CreateCluster_RequestSyntax"></a>

```
POST /cluster HTTP/1.1
Content-type: application/json

{
   "adminUserName": "string",
   "adminUserPassword": "string",
   "authType": "string",
   "backupRetentionPeriod": number,
   "clientToken": "string",
   "clusterName": "string",
   "kmsKeyId": "string",
   "preferredBackupWindow": "string",
   "preferredMaintenanceWindow": "string",
   "shardCapacity": number,
   "shardCount": number,
   "shardInstanceCount": number,
   "subnetIds": [ "string" ],
   "tags": { 
      "string" : "string" 
   },
   "vpcSecurityGroupIds": [ "string" ]
}
```

## URI 請求參數
<a name="API_elastic_CreateCluster_RequestParameters"></a>

請求不會使用任何 URI 參數。

## 請求主體
<a name="API_elastic_CreateCluster_RequestBody"></a>

請求接受採用 JSON 格式的下列資料。

 ** [adminUserName](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-adminUserName"></a>
Amazon DocumentDB 彈性叢集管理員的名稱。  
 *限制條件*：  
+ 必須為 1 到 63 個字母或數字。
+ 第一個字元必須是字母。
+ 不能是保留字。
類型：字串  
必要：是

 ** [adminUserPassword](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-adminUserPassword"></a>
Amazon DocumentDB 彈性叢集管理員的密碼。密碼可以包含任何可列印的 ASCII 字元。  
 *限制條件*：  
+ 必須包含 8 到 100 個字元。
+ 不能包含正斜線 (/)、雙引號 (") 或 "at" 符號 (@)。
類型：字串  
必要：是

 ** [authType](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-authType"></a>
用來決定在何處擷取用於存取彈性叢集之密碼的身分驗證類型。有效類型為 `PLAIN_TEXT`或 `SECRET_ARN`。  
類型：字串  
有效值:`PLAIN_TEXT | SECRET_ARN`   
必要：是

 ** [clusterName](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-clusterName"></a>
新彈性叢集的名稱。此參數是以小寫字母字串的形式儲存。  
 *限制條件*：  
+ 必須包含 1 到 63 個字母、數字或連字號。
+ 第一個字元必須是字母。
+ 不能以連字號結尾，或包含兩個連續連字號。
 *範例*：`my-cluster`  
類型：字串  
必要：是

 ** [shardCapacity](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-shardCapacity"></a>
指派給每個彈性叢集碎片vCPUs 數目。上限為 64。允許的值為 2、4、8、16、32、64。  
類型：整數  
必要：是

 ** [shardCount](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-shardCount"></a>
指派給彈性叢集的碎片數量。上限為 32。  
類型：整數  
必要：是

 ** [backupRetentionPeriod](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-backupRetentionPeriod"></a>
保留自動快照的天數。  
類型：整數  
必要：否

 ** [clientToken](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-clientToken"></a>
彈性叢集的用戶端字符。  
類型：字串  
必要：否

 ** [kmsKeyId](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-kmsKeyId"></a>
用來加密新彈性叢集的 KMS 金鑰識別符。  
KMS 金鑰識別符是 KMS 加密金鑰的 Amazon Resource Name (ARN)。如果您使用擁有此 KMS 加密金鑰的相同 Amazon 帳戶建立叢集，您可以使用 KMS 金鑰別名，而非 ARN 做為 KMS 加密金鑰。  
如果未指定加密金鑰，Amazon DocumentDB 會使用 KMS 為您的帳戶建立的預設加密金鑰。您的帳戶在每個 Amazon 區域都有不同的預設加密金鑰。  
類型：字串  
必要：否

 ** [preferredBackupWindow](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-preferredBackupWindow"></a>
如果啟用自動備份，則建立自動備份的每日時間範圍，由 決定`backupRetentionPeriod`。  
類型：字串  
必要：否

 ** [preferredMaintenanceWindow](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-preferredMaintenanceWindow"></a>
每週可能進行系統維護的時段，以國際標準時間 (UTC) 表示。  
 *格式*：`ddd:hh24:mi-ddd:hh24:mi`  
 *預設*：從每個 8 小時的時段中隨機選取的 30 分鐘時段 AWS 區域，發生在一週中的隨機一天。  
 *有效天數*：週一、週二、週三、週四、週五、週六、週日  
 *限制條件*：必須至少是 30 分鐘的時段。  
類型：字串  
必要：否

 ** [shardInstanceCount](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-shardInstanceCount"></a>
套用至彈性叢集中所有碎片的複本執行個體數目。`shardInstanceCount` 值 1 表示有一個寫入器執行個體，而任何其他執行個體都是可用於讀取和改善可用性的複本。  
類型：整數  
必要：否

 ** [subnetIds](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-subnetIds"></a>
新彈性叢集的 Amazon EC2 IDs。  
類型：字串陣列  
必要：否

 ** [tags](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-tags"></a>
要指派給新彈性叢集的標籤。  
類型：字串到字串映射  
索引鍵長度限制：長度下限為 1。長度上限為 128。  
金鑰模式：`(?!aws:)[a-zA-Z+-=._:/]+`  
值長度限制：長度下限為 0。長度上限為 256。  
必要：否

 ** [vpcSecurityGroupIds](#API_elastic_CreateCluster_RequestSyntax) **   <a name="documentdb-elastic_CreateCluster-request-vpcSecurityGroupIds"></a>
要與新彈性叢集建立關聯的 EC2 VPC 安全群組清單。  
類型：字串陣列  
必要：否

## 回應語法
<a name="API_elastic_CreateCluster_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cluster": { 
      "adminUserName": "string",
      "authType": "string",
      "backupRetentionPeriod": number,
      "clusterArn": "string",
      "clusterEndpoint": "string",
      "clusterName": "string",
      "createTime": "string",
      "kmsKeyId": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "shardCapacity": number,
      "shardCount": number,
      "shardInstanceCount": number,
      "shards": [ 
         { 
            "createTime": "string",
            "shardId": "string",
            "status": "string"
         }
      ],
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## 回應元素
<a name="API_elastic_CreateCluster_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [cluster](#API_elastic_CreateCluster_ResponseSyntax) **   <a name="documentdb-elastic_CreateCluster-response-cluster"></a>
已建立的新彈性叢集。  
類型：[Cluster](API_elastic_Cluster.md) 物件

## 錯誤
<a name="API_elastic_CreateCluster_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** AccessDeniedException **   
當沒有足夠的許可來執行動作時，就會發生例外狀況。    
 ** message **   
錯誤訊息，說明拒絕存取的原因。
HTTP 狀態碼：403

 ** ConflictException **   
發生存取衝突。    
 ** resourceId **   
發生存取衝突的資源 ID。  
 ** resourceType **   
發生存取衝突的資源類型。
HTTP 狀態碼：409

 ** InternalServerException **   
發生內部伺服器錯誤。  
HTTP 狀態碼：500

 ** ServiceQuotaExceededException **   
已超過 動作的服務配額。  
HTTP 狀態碼：402

 ** ThrottlingException **   
當請求因請求調節而遭拒時，將會擲回 ThrottlingException。    
 ** retryAfterSeconds **   
重試操作之前要等待的秒數。
HTTP 狀態碼：429

 ** ValidationException **   
定義驗證例外狀況的結構。    
 ** fieldList **   
發生驗證例外狀況的欄位清單。  
 ** message **   
描述驗證例外狀況的錯誤訊息。  
 ** reason **   
驗證例外發生的原因 (`unknownOperation`、`fieldValidationFailed`、 `cannotParse`或 之一`other`)。
HTTP 狀態碼：400

## 另請參閱
<a name="API_elastic_CreateCluster_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CreateCluster) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CreateCluster) 

# CreateClusterSnapshot
<a name="API_elastic_CreateClusterSnapshot"></a>

建立彈性叢集的快照。

## 請求語法
<a name="API_elastic_CreateClusterSnapshot_RequestSyntax"></a>

```
POST /cluster-snapshot HTTP/1.1
Content-type: application/json

{
   "clusterArn": "string",
   "snapshotName": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## URI 請求參數
<a name="API_elastic_CreateClusterSnapshot_RequestParameters"></a>

請求不會使用任何 URI 參數。

## 請求主體
<a name="API_elastic_CreateClusterSnapshot_RequestBody"></a>

請求接受採用 JSON 格式的下列資料。

 ** [clusterArn](#API_elastic_CreateClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CreateClusterSnapshot-request-clusterArn"></a>
您要建立快照之彈性叢集的 ARN 識別符。  
類型：字串  
必要：是

 ** [snapshotName](#API_elastic_CreateClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CreateClusterSnapshot-request-snapshotName"></a>
新彈性叢集快照的名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 63。  
必要：是

 ** [tags](#API_elastic_CreateClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_CreateClusterSnapshot-request-tags"></a>
要指派給新彈性叢集快照的標籤。  
類型：字串到字串映射  
索引鍵長度限制：長度下限為 1。長度上限為 128。  
金鑰模式：`(?!aws:)[a-zA-Z+-=._:/]+`  
值長度限制：長度下限為 0。長度上限為 256。  
必要：否

## 回應語法
<a name="API_elastic_CreateClusterSnapshot_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "snapshot": { 
      "adminUserName": "string",
      "clusterArn": "string",
      "clusterCreationTime": "string",
      "kmsKeyId": "string",
      "snapshotArn": "string",
      "snapshotCreationTime": "string",
      "snapshotName": "string",
      "snapshotType": "string",
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## 回應元素
<a name="API_elastic_CreateClusterSnapshot_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [snapshot](#API_elastic_CreateClusterSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_CreateClusterSnapshot-response-snapshot"></a>
傳回新彈性叢集快照的相關資訊。  
類型：[ClusterSnapshot](API_elastic_ClusterSnapshot.md) 物件

## 錯誤
<a name="API_elastic_CreateClusterSnapshot_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** AccessDeniedException **   
當沒有足夠的許可來執行動作時，就會發生例外狀況。    
 ** message **   
錯誤訊息，說明拒絕存取的原因。
HTTP 狀態碼：403

 ** ConflictException **   
發生存取衝突。    
 ** resourceId **   
發生存取衝突的資源 ID。  
 ** resourceType **   
發生存取衝突的資源類型。
HTTP 狀態碼：409

 ** InternalServerException **   
發生內部伺服器錯誤。  
HTTP 狀態碼：500

 ** ResourceNotFoundException **   
找不到指定的資源。    
 ** message **   
描述失敗的錯誤訊息。  
 ** resourceId **   
找不到的資源 ID。  
 ** resourceType **   
找不到的資源類型。
HTTP 狀態碼：404

 ** ServiceQuotaExceededException **   
已超過 動作的服務配額。  
HTTP 狀態碼：402

 ** ThrottlingException **   
當請求因請求調節而遭拒時，將會擲回 ThrottlingException。    
 ** retryAfterSeconds **   
重試操作之前要等待的秒數。
HTTP 狀態碼：429

 ** ValidationException **   
定義驗證例外狀況的結構。    
 ** fieldList **   
發生驗證例外狀況的欄位清單。  
 ** message **   
描述驗證例外狀況的錯誤訊息。  
 ** reason **   
驗證例外發生的原因 (`unknownOperation`、`fieldValidationFailed`、 `cannotParse`或 之一`other`)。
HTTP 狀態碼：400

## 另請參閱
<a name="API_elastic_CreateClusterSnapshot_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CreateClusterSnapshot) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CreateClusterSnapshot) 

# DeleteCluster
<a name="API_elastic_DeleteCluster"></a>

刪除彈性叢集。

## 請求語法
<a name="API_elastic_DeleteCluster_RequestSyntax"></a>

```
DELETE /cluster/clusterArn HTTP/1.1
```

## URI 請求參數
<a name="API_elastic_DeleteCluster_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [clusterArn](#API_elastic_DeleteCluster_RequestSyntax) **   <a name="documentdb-elastic_DeleteCluster-request-uri-clusterArn"></a>
要刪除之彈性叢集的 ARN 識別符。  
必要：是

## 請求主體
<a name="API_elastic_DeleteCluster_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_elastic_DeleteCluster_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cluster": { 
      "adminUserName": "string",
      "authType": "string",
      "backupRetentionPeriod": number,
      "clusterArn": "string",
      "clusterEndpoint": "string",
      "clusterName": "string",
      "createTime": "string",
      "kmsKeyId": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "shardCapacity": number,
      "shardCount": number,
      "shardInstanceCount": number,
      "shards": [ 
         { 
            "createTime": "string",
            "shardId": "string",
            "status": "string"
         }
      ],
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## 回應元素
<a name="API_elastic_DeleteCluster_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [cluster](#API_elastic_DeleteCluster_ResponseSyntax) **   <a name="documentdb-elastic_DeleteCluster-response-cluster"></a>
傳回新刪除彈性叢集的相關資訊。  
類型：[Cluster](API_elastic_Cluster.md) 物件

## 錯誤
<a name="API_elastic_DeleteCluster_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** AccessDeniedException **   
當沒有足夠的許可來執行動作時，就會發生例外狀況。    
 ** message **   
錯誤訊息，說明拒絕存取的原因。
HTTP 狀態碼：403

 ** ConflictException **   
發生存取衝突。    
 ** resourceId **   
發生存取衝突的資源 ID。  
 ** resourceType **   
發生存取衝突的資源類型。
HTTP 狀態碼：409

 ** InternalServerException **   
發生內部伺服器錯誤。  
HTTP 狀態碼：500

 ** ResourceNotFoundException **   
找不到指定的資源。    
 ** message **   
描述失敗的錯誤訊息。  
 ** resourceId **   
找不到的資源 ID。  
 ** resourceType **   
找不到的資源類型。
HTTP 狀態碼：404

 ** ThrottlingException **   
當請求因請求調節而遭拒時，將會擲回 ThrottlingException。    
 ** retryAfterSeconds **   
重試操作之前要等待的秒數。
HTTP 狀態碼：429

 ** ValidationException **   
定義驗證例外狀況的結構。    
 ** fieldList **   
發生驗證例外狀況的欄位清單。  
 ** message **   
描述驗證例外狀況的錯誤訊息。  
 ** reason **   
驗證例外發生的原因 (`unknownOperation`、`fieldValidationFailed`、 `cannotParse`或 之一`other`)。
HTTP 狀態碼：400

## 另請參閱
<a name="API_elastic_DeleteCluster_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/DeleteCluster) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/DeleteCluster) 

# DeleteClusterSnapshot
<a name="API_elastic_DeleteClusterSnapshot"></a>

刪除彈性叢集快照。

## 請求語法
<a name="API_elastic_DeleteClusterSnapshot_RequestSyntax"></a>

```
DELETE /cluster-snapshot/snapshotArn HTTP/1.1
```

## URI 請求參數
<a name="API_elastic_DeleteClusterSnapshot_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [snapshotArn](#API_elastic_DeleteClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_DeleteClusterSnapshot-request-uri-snapshotArn"></a>
要刪除之彈性叢集快照的 ARN 識別符。  
必要：是

## 請求主體
<a name="API_elastic_DeleteClusterSnapshot_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_elastic_DeleteClusterSnapshot_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "snapshot": { 
      "adminUserName": "string",
      "clusterArn": "string",
      "clusterCreationTime": "string",
      "kmsKeyId": "string",
      "snapshotArn": "string",
      "snapshotCreationTime": "string",
      "snapshotName": "string",
      "snapshotType": "string",
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## 回應元素
<a name="API_elastic_DeleteClusterSnapshot_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [snapshot](#API_elastic_DeleteClusterSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_DeleteClusterSnapshot-response-snapshot"></a>
傳回新刪除的彈性叢集快照的相關資訊。  
類型：[ClusterSnapshot](API_elastic_ClusterSnapshot.md) 物件

## 錯誤
<a name="API_elastic_DeleteClusterSnapshot_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** AccessDeniedException **   
當沒有足夠的許可來執行動作時，就會發生例外狀況。    
 ** message **   
錯誤訊息，說明拒絕存取的原因。
HTTP 狀態碼：403

 ** ConflictException **   
發生存取衝突。    
 ** resourceId **   
發生存取衝突的資源 ID。  
 ** resourceType **   
發生存取衝突的資源類型。
HTTP 狀態碼：409

 ** InternalServerException **   
發生內部伺服器錯誤。  
HTTP 狀態碼：500

 ** ResourceNotFoundException **   
找不到指定的資源。    
 ** message **   
描述失敗的錯誤訊息。  
 ** resourceId **   
找不到的資源 ID。  
 ** resourceType **   
找不到的資源類型。
HTTP 狀態碼：404

 ** ThrottlingException **   
當請求因請求調節而遭拒時，將會擲回 ThrottlingException。    
 ** retryAfterSeconds **   
重試操作之前要等待的秒數。
HTTP 狀態碼：429

 ** ValidationException **   
定義驗證例外狀況的結構。    
 ** fieldList **   
發生驗證例外狀況的欄位清單。  
 ** message **   
描述驗證例外狀況的錯誤訊息。  
 ** reason **   
驗證例外發生的原因 (`unknownOperation`、`fieldValidationFailed`、 `cannotParse`或 之一`other`)。
HTTP 狀態碼：400

## 另請參閱
<a name="API_elastic_DeleteClusterSnapshot_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) 

# GetCluster
<a name="API_elastic_GetCluster"></a>

傳回特定彈性叢集的相關資訊。

## 請求語法
<a name="API_elastic_GetCluster_RequestSyntax"></a>

```
GET /cluster/clusterArn HTTP/1.1
```

## URI 請求參數
<a name="API_elastic_GetCluster_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [clusterArn](#API_elastic_GetCluster_RequestSyntax) **   <a name="documentdb-elastic_GetCluster-request-uri-clusterArn"></a>
彈性叢集的 ARN 識別符。  
必要：是

## 請求主體
<a name="API_elastic_GetCluster_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_elastic_GetCluster_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cluster": { 
      "adminUserName": "string",
      "authType": "string",
      "backupRetentionPeriod": number,
      "clusterArn": "string",
      "clusterEndpoint": "string",
      "clusterName": "string",
      "createTime": "string",
      "kmsKeyId": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "shardCapacity": number,
      "shardCount": number,
      "shardInstanceCount": number,
      "shards": [ 
         { 
            "createTime": "string",
            "shardId": "string",
            "status": "string"
         }
      ],
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## 回應元素
<a name="API_elastic_GetCluster_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [cluster](#API_elastic_GetCluster_ResponseSyntax) **   <a name="documentdb-elastic_GetCluster-response-cluster"></a>
傳回特定彈性叢集的相關資訊。  
類型：[Cluster](API_elastic_Cluster.md) 物件

## 錯誤
<a name="API_elastic_GetCluster_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** AccessDeniedException **   
當沒有足夠的許可來執行動作時，就會發生例外狀況。    
 ** message **   
錯誤訊息，說明拒絕存取的原因。
HTTP 狀態碼：403

 ** InternalServerException **   
發生內部伺服器錯誤。  
HTTP 狀態碼：500

 ** ResourceNotFoundException **   
找不到指定的資源。    
 ** message **   
描述失敗的錯誤訊息。  
 ** resourceId **   
找不到的資源 ID。  
 ** resourceType **   
找不到的資源類型。
HTTP 狀態碼：404

 ** ThrottlingException **   
當請求因請求調節而遭拒時，將會擲回 ThrottlingException。    
 ** retryAfterSeconds **   
重試操作之前要等待的秒數。
HTTP 狀態碼：429

 ** ValidationException **   
定義驗證例外狀況的結構。    
 ** fieldList **   
發生驗證例外狀況的欄位清單。  
 ** message **   
描述驗證例外狀況的錯誤訊息。  
 ** reason **   
驗證例外發生的原因 (`unknownOperation`、`fieldValidationFailed`、 `cannotParse`或 之一`other`)。
HTTP 狀態碼：400

## 另請參閱
<a name="API_elastic_GetCluster_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetCluster) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetCluster) 

# GetClusterSnapshot
<a name="API_elastic_GetClusterSnapshot"></a>

傳回特定彈性叢集快照的相關資訊

## 請求語法
<a name="API_elastic_GetClusterSnapshot_RequestSyntax"></a>

```
GET /cluster-snapshot/snapshotArn HTTP/1.1
```

## URI 請求參數
<a name="API_elastic_GetClusterSnapshot_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [snapshotArn](#API_elastic_GetClusterSnapshot_RequestSyntax) **   <a name="documentdb-elastic_GetClusterSnapshot-request-uri-snapshotArn"></a>
彈性叢集快照的 ARN 識別符。  
必要：是

## 請求主體
<a name="API_elastic_GetClusterSnapshot_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_elastic_GetClusterSnapshot_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "snapshot": { 
      "adminUserName": "string",
      "clusterArn": "string",
      "clusterCreationTime": "string",
      "kmsKeyId": "string",
      "snapshotArn": "string",
      "snapshotCreationTime": "string",
      "snapshotName": "string",
      "snapshotType": "string",
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## 回應元素
<a name="API_elastic_GetClusterSnapshot_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [snapshot](#API_elastic_GetClusterSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_GetClusterSnapshot-response-snapshot"></a>
傳回特定彈性叢集快照的相關資訊。  
類型：[ClusterSnapshot](API_elastic_ClusterSnapshot.md) 物件

## 錯誤
<a name="API_elastic_GetClusterSnapshot_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** AccessDeniedException **   
當沒有足夠的許可來執行動作時，就會發生例外狀況。    
 ** message **   
錯誤訊息，說明拒絕存取的原因。
HTTP 狀態碼：403

 ** InternalServerException **   
發生內部伺服器錯誤。  
HTTP 狀態碼：500

 ** ResourceNotFoundException **   
找不到指定的資源。    
 ** message **   
描述失敗的錯誤訊息。  
 ** resourceId **   
找不到的資源 ID。  
 ** resourceType **   
找不到的資源類型。
HTTP 狀態碼：404

 ** ThrottlingException **   
當請求因請求調節而遭拒時，將會擲回 ThrottlingException。    
 ** retryAfterSeconds **   
重試操作之前要等待的秒數。
HTTP 狀態碼：429

 ** ValidationException **   
定義驗證例外狀況的結構。    
 ** fieldList **   
發生驗證例外狀況的欄位清單。  
 ** message **   
描述驗證例外狀況的錯誤訊息。  
 ** reason **   
驗證例外發生的原因 (`unknownOperation`、`fieldValidationFailed`、 `cannotParse`或 之一`other`)。
HTTP 狀態碼：400

## 另請參閱
<a name="API_elastic_GetClusterSnapshot_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetClusterSnapshot) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetClusterSnapshot) 

# GetPendingMaintenanceAction
<a name="API_elastic_GetPendingMaintenanceAction"></a>

擷取所有待定的維護動作。

## 請求語法
<a name="API_elastic_GetPendingMaintenanceAction_RequestSyntax"></a>

```
GET /pending-action/resourceArn HTTP/1.1
```

## URI 請求參數
<a name="API_elastic_GetPendingMaintenanceAction_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [resourceArn](#API_elastic_GetPendingMaintenanceAction_RequestSyntax) **   <a name="documentdb-elastic_GetPendingMaintenanceAction-request-uri-resourceArn"></a>
擷取特定 Amazon Resource Name (ARN) 的待定維護動作。  
長度限制：長度下限為 1。長度上限為 256。  
必要：是

## 請求主體
<a name="API_elastic_GetPendingMaintenanceAction_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_elastic_GetPendingMaintenanceAction_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "resourcePendingMaintenanceAction": { 
      "pendingMaintenanceActionDetails": [ 
         { 
            "action": "string",
            "autoAppliedAfterDate": "string",
            "currentApplyDate": "string",
            "description": "string",
            "forcedApplyDate": "string",
            "optInStatus": "string"
         }
      ],
      "resourceArn": "string"
   }
}
```

## 回應元素
<a name="API_elastic_GetPendingMaintenanceAction_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [resourcePendingMaintenanceAction](#API_elastic_GetPendingMaintenanceAction_ResponseSyntax) **   <a name="documentdb-elastic_GetPendingMaintenanceAction-response-resourcePendingMaintenanceAction"></a>
提供資源待處理維護動作的資訊。  
類型：[ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md) 物件

## 錯誤
<a name="API_elastic_GetPendingMaintenanceAction_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** AccessDeniedException **   
當沒有足夠的許可來執行動作時，就會發生例外狀況。    
 ** message **   
錯誤訊息，說明拒絕存取的原因。
HTTP 狀態碼：403

 ** ConflictException **   
發生存取衝突。    
 ** resourceId **   
發生存取衝突的資源 ID。  
 ** resourceType **   
發生存取衝突的資源類型。
HTTP 狀態碼：409

 ** InternalServerException **   
發生內部伺服器錯誤。  
HTTP 狀態碼：500

 ** ResourceNotFoundException **   
找不到指定的資源。    
 ** message **   
描述失敗的錯誤訊息。  
 ** resourceId **   
找不到的資源 ID。  
 ** resourceType **   
找不到的資源類型。
HTTP 狀態碼：404

 ** ThrottlingException **   
當請求因請求調節而遭拒時，將會擲回 ThrottlingException。    
 ** retryAfterSeconds **   
重試操作之前要等待的秒數。
HTTP 狀態碼：429

 ** ValidationException **   
定義驗證例外狀況的結構。    
 ** fieldList **   
發生驗證例外狀況的欄位清單。  
 ** message **   
描述驗證例外狀況的錯誤訊息。  
 ** reason **   
驗證例外發生的原因 (`unknownOperation`、`fieldValidationFailed`、 `cannotParse`或 之一`other`)。
HTTP 狀態碼：400

## 另請參閱
<a name="API_elastic_GetPendingMaintenanceAction_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) 

# ListClusters
<a name="API_elastic_ListClusters"></a>

傳回佈建 Amazon DocumentDB 彈性叢集的相關資訊。

## 請求語法
<a name="API_elastic_ListClusters_RequestSyntax"></a>

```
GET /clusters?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI 請求參數
<a name="API_elastic_ListClusters_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [maxResults](#API_elastic_ListClusters_RequestSyntax) **   <a name="documentdb-elastic_ListClusters-request-uri-maxResults"></a>
要在回應中接收的彈性叢集快照結果數目上限。  
有效範圍：最小值為 1。最大值為 100。

 ** [nextToken](#API_elastic_ListClusters_RequestSyntax) **   <a name="documentdb-elastic_ListClusters-request-uri-nextToken"></a>
先前請求提供的分頁字符。如果指定此參數，回應只會包含超過此字符的記錄，直到 指定的值為止`max-results`。  
如果回應中沒有更多資料，則`nextToken`不會傳回 。

## 請求主體
<a name="API_elastic_ListClusters_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_elastic_ListClusters_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "clusters": [ 
      { 
         "clusterArn": "string",
         "clusterName": "string",
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

## 回應元素
<a name="API_elastic_ListClusters_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [clusters](#API_elastic_ListClusters_ResponseSyntax) **   <a name="documentdb-elastic_ListClusters-response-clusters"></a>
Amazon DocumentDB 彈性叢集的清單。  
類型：[ClusterInList](API_elastic_ClusterInList.md) 物件陣列

 ** [nextToken](#API_elastic_ListClusters_ResponseSyntax) **   <a name="documentdb-elastic_ListClusters-response-nextToken"></a>
先前請求提供的分頁字符。如果指定此參數，回應只會包含超過此字符的記錄，直到 指定的值為止`max-results`。  
如果回應中沒有更多資料，則`nextToken`不會傳回 。  
類型：字串

## 錯誤
<a name="API_elastic_ListClusters_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** AccessDeniedException **   
當沒有足夠的許可來執行動作時，就會發生例外狀況。    
 ** message **   
錯誤訊息，說明拒絕存取的原因。
HTTP 狀態碼：403

 ** InternalServerException **   
發生內部伺服器錯誤。  
HTTP 狀態碼：500

 ** ThrottlingException **   
當請求因請求調節而遭拒時，將會擲回 ThrottlingException。    
 ** retryAfterSeconds **   
重試操作之前要等待的秒數。
HTTP 狀態碼：429

 ** ValidationException **   
定義驗證例外狀況的結構。    
 ** fieldList **   
發生驗證例外狀況的欄位清單。  
 ** message **   
描述驗證例外狀況的錯誤訊息。  
 ** reason **   
驗證例外發生的原因 (`unknownOperation`、`fieldValidationFailed`、 `cannotParse`或 之一`other`)。
HTTP 狀態碼：400

## 另請參閱
<a name="API_elastic_ListClusters_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListClusters) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListClusters) 

# ListClusterSnapshots
<a name="API_elastic_ListClusterSnapshots"></a>

傳回指定彈性叢集快照的相關資訊。

## 請求語法
<a name="API_elastic_ListClusterSnapshots_RequestSyntax"></a>

```
GET /cluster-snapshots?clusterArn=clusterArn&maxResults=maxResults&nextToken=nextToken&snapshotType=snapshotType HTTP/1.1
```

## URI 請求參數
<a name="API_elastic_ListClusterSnapshots_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [clusterArn](#API_elastic_ListClusterSnapshots_RequestSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-request-uri-clusterArn"></a>
彈性叢集的 ARN 識別符。

 ** [maxResults](#API_elastic_ListClusterSnapshots_RequestSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-request-uri-maxResults"></a>
要在回應中接收的彈性叢集快照結果數目上限。  
有效範圍：最小值為 20。最大值為 100。

 ** [nextToken](#API_elastic_ListClusterSnapshots_RequestSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-request-uri-nextToken"></a>
先前請求提供的分頁字符。如果指定此參數，回應只會包含超過此字符的記錄，直到 指定的值為止`max-results`。  
如果回應中沒有更多資料，則`nextToken`不會傳回 。

 ** [snapshotType](#API_elastic_ListClusterSnapshots_RequestSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-request-uri-snapshotType"></a>
要傳回的叢集快照類型。您可以指定下列其中一個值：  
+  `automated` - 傳回 Amazon DocumentDB 為 AWS 您的帳戶自動建立的所有叢集快照。
+  `manual` - 傳回您為 AWS 帳戶手動建立的所有叢集快照。

## 請求主體
<a name="API_elastic_ListClusterSnapshots_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_elastic_ListClusterSnapshots_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "snapshots": [ 
      { 
         "clusterArn": "string",
         "snapshotArn": "string",
         "snapshotCreationTime": "string",
         "snapshotName": "string",
         "status": "string"
      }
   ]
}
```

## 回應元素
<a name="API_elastic_ListClusterSnapshots_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [nextToken](#API_elastic_ListClusterSnapshots_ResponseSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-response-nextToken"></a>
先前請求提供的分頁字符。如果指定此參數，回應只會包含超過此字符的記錄，直到 指定的值為止`max-results`。  
如果回應中沒有更多資料，則`nextToken`不會傳回 。  
類型：字串

 ** [snapshots](#API_elastic_ListClusterSnapshots_ResponseSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-response-snapshots"></a>
指定彈性叢集的快照清單。  
類型：[ClusterSnapshotInList](API_elastic_ClusterSnapshotInList.md) 物件陣列

## 錯誤
<a name="API_elastic_ListClusterSnapshots_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** AccessDeniedException **   
當沒有足夠的許可來執行動作時，就會發生例外狀況。    
 ** message **   
錯誤訊息，說明拒絕存取的原因。
HTTP 狀態碼：403

 ** InternalServerException **   
發生內部伺服器錯誤。  
HTTP 狀態碼：500

 ** ThrottlingException **   
當請求因請求調節而遭拒時，將會擲回 ThrottlingException。    
 ** retryAfterSeconds **   
重試操作之前要等待的秒數。
HTTP 狀態碼：429

 ** ValidationException **   
定義驗證例外狀況的結構。    
 ** fieldList **   
發生驗證例外狀況的欄位清單。  
 ** message **   
描述驗證例外狀況的錯誤訊息。  
 ** reason **   
驗證例外發生的原因 (`unknownOperation`、`fieldValidationFailed`、 `cannotParse`或 之一`other`)。
HTTP 狀態碼：400

## 另請參閱
<a name="API_elastic_ListClusterSnapshots_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListClusterSnapshots) 

# ListPendingMaintenanceActions
<a name="API_elastic_ListPendingMaintenanceActions"></a>

擷取所有待定維護動作的清單。

## 請求語法
<a name="API_elastic_ListPendingMaintenanceActions_RequestSyntax"></a>

```
GET /pending-actions?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI 請求參數
<a name="API_elastic_ListPendingMaintenanceActions_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [maxResults](#API_elastic_ListPendingMaintenanceActions_RequestSyntax) **   <a name="documentdb-elastic_ListPendingMaintenanceActions-request-uri-maxResults"></a>
要包含在回應中的結果數目上限。如果存在的記錄超過指定的`maxResults`值，回應中會包含分頁字符 （標記），以便擷取剩餘的結果。  
有效範圍：最小值為 1。最大值為 100。

 ** [nextToken](#API_elastic_ListPendingMaintenanceActions_RequestSyntax) **   <a name="documentdb-elastic_ListPendingMaintenanceActions-request-uri-nextToken"></a>
前一個請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `maxResults` 指定的值為止。

## 請求主體
<a name="API_elastic_ListPendingMaintenanceActions_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_elastic_ListPendingMaintenanceActions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "resourcePendingMaintenanceActions": [ 
      { 
         "pendingMaintenanceActionDetails": [ 
            { 
               "action": "string",
               "autoAppliedAfterDate": "string",
               "currentApplyDate": "string",
               "description": "string",
               "forcedApplyDate": "string",
               "optInStatus": "string"
            }
         ],
         "resourceArn": "string"
      }
   ]
}
```

## 回應元素
<a name="API_elastic_ListPendingMaintenanceActions_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [resourcePendingMaintenanceActions](#API_elastic_ListPendingMaintenanceActions_ResponseSyntax) **   <a name="documentdb-elastic_ListPendingMaintenanceActions-response-resourcePendingMaintenanceActions"></a>
提供資源待處理維護動作的資訊。  
類型：[ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md) 物件陣列

 ** [nextToken](#API_elastic_ListPendingMaintenanceActions_ResponseSyntax) **   <a name="documentdb-elastic_ListPendingMaintenanceActions-response-nextToken"></a>
前一個請求提供的選用分頁字符。如果顯示此參數，回應只會包含超出標記的記錄，直到 指定的值為止`maxResults`。  
類型：字串

## 錯誤
<a name="API_elastic_ListPendingMaintenanceActions_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** AccessDeniedException **   
當沒有足夠的許可來執行動作時，就會發生例外狀況。    
 ** message **   
錯誤訊息，說明拒絕存取的原因。
HTTP 狀態碼：403

 ** InternalServerException **   
發生內部伺服器錯誤。  
HTTP 狀態碼：500

 ** ThrottlingException **   
當請求因請求調節而遭拒時，將會擲回 ThrottlingException。    
 ** retryAfterSeconds **   
重試操作之前要等待的秒數。
HTTP 狀態碼：429

 ** ValidationException **   
定義驗證例外狀況的結構。    
 ** fieldList **   
發生驗證例外狀況的欄位清單。  
 ** message **   
描述驗證例外狀況的錯誤訊息。  
 ** reason **   
驗證例外發生的原因 (`unknownOperation`、`fieldValidationFailed`、 `cannotParse`或 之一`other`)。
HTTP 狀態碼：400

## 另請參閱
<a name="API_elastic_ListPendingMaintenanceActions_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) 

# ListTagsForResource
<a name="API_elastic_ListTagsForResource"></a>

列出彈性叢集資源上的所有標籤

## 請求語法
<a name="API_elastic_ListTagsForResource_RequestSyntax"></a>

```
GET /tags/resourceArn HTTP/1.1
```

## URI 請求參數
<a name="API_elastic_ListTagsForResource_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [resourceArn](#API_elastic_ListTagsForResource_RequestSyntax) **   <a name="documentdb-elastic_ListTagsForResource-request-uri-resourceArn"></a>
彈性叢集資源的 ARN 識別符。  
長度限制：長度下限為 1。長度上限為 1011。  
必要：是

## 請求主體
<a name="API_elastic_ListTagsForResource_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_elastic_ListTagsForResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## 回應元素
<a name="API_elastic_ListTagsForResource_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [tags](#API_elastic_ListTagsForResource_ResponseSyntax) **   <a name="documentdb-elastic_ListTagsForResource-response-tags"></a>
指定彈性叢集資源的標籤清單。  
類型：字串到字串映射  
索引鍵長度限制：長度下限為 1。長度上限為 128。  
金鑰模式：`(?!aws:)[a-zA-Z+-=._:/]+`  
值長度限制：長度下限為 0。長度上限為 256。

## 錯誤
<a name="API_elastic_ListTagsForResource_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** InternalServerException **   
發生內部伺服器錯誤。  
HTTP 狀態碼：500

 ** ResourceNotFoundException **   
找不到指定的資源。    
 ** message **   
描述失敗的錯誤訊息。  
 ** resourceId **   
找不到的資源 ID。  
 ** resourceType **   
找不到的資源類型。
HTTP 狀態碼：404

 ** ThrottlingException **   
當請求因請求調節而遭拒時，將會擲回 ThrottlingException。    
 ** retryAfterSeconds **   
重試操作之前要等待的秒數。
HTTP 狀態碼：429

 ** ValidationException **   
定義驗證例外狀況的結構。    
 ** fieldList **   
發生驗證例外狀況的欄位清單。  
 ** message **   
描述驗證例外狀況的錯誤訊息。  
 ** reason **   
驗證例外發生的原因 (`unknownOperation`、`fieldValidationFailed`、 `cannotParse`或 之一`other`)。
HTTP 狀態碼：400

## 另請參閱
<a name="API_elastic_ListTagsForResource_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListTagsForResource) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListTagsForResource) 

# RestoreClusterFromSnapshot
<a name="API_elastic_RestoreClusterFromSnapshot"></a>

從快照還原彈性叢集。

## 請求語法
<a name="API_elastic_RestoreClusterFromSnapshot_RequestSyntax"></a>

```
POST /cluster-snapshot/snapshotArn/restore HTTP/1.1
Content-type: application/json

{
   "clusterName": "string",
   "kmsKeyId": "string",
   "shardCapacity": number,
   "shardInstanceCount": number,
   "subnetIds": [ "string" ],
   "tags": { 
      "string" : "string" 
   },
   "vpcSecurityGroupIds": [ "string" ]
}
```

## URI 請求參數
<a name="API_elastic_RestoreClusterFromSnapshot_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [snapshotArn](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-uri-snapshotArn"></a>
彈性叢集快照的 ARN 識別符。  
必要：是

## 請求主體
<a name="API_elastic_RestoreClusterFromSnapshot_RequestBody"></a>

請求接受採用 JSON 格式的下列資料。

 ** [clusterName](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-clusterName"></a>
彈性叢集的名稱。  
類型：字串  
必要：是

 ** [kmsKeyId](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-kmsKeyId"></a>
用來加密新 Amazon DocumentDB 彈性叢集的 KMS 金鑰識別符。  
KMS 金鑰識別符是 KMS 加密金鑰的 Amazon Resource Name (ARN)。如果您使用擁有此 KMS 加密金鑰的相同 Amazon 帳戶建立叢集，您可以使用 KMS 金鑰別名，而非 ARN 做為 KMS 加密金鑰。  
如果此處未指定加密金鑰，Amazon DocumentDB 會使用 KMS 為您的帳戶建立的預設加密金鑰。您的帳戶在每個 Amazon 區域都有不同的預設加密金鑰。  
類型：字串  
必要：否

 ** [shardCapacity](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-shardCapacity"></a>
新還原彈性叢集中每個碎片的容量。  
類型：整數  
必要：否

 ** [shardInstanceCount](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-shardInstanceCount"></a>
套用至彈性叢集中所有碎片的複本執行個體數目。`shardInstanceCount` 值 1 表示有一個寫入器執行個體，而任何其他執行個體都是可用於讀取和改善可用性的複本。  
類型：整數  
必要：否

 ** [subnetIds](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-subnetIds"></a>
彈性叢集的 Amazon EC2 IDs。  
類型：字串陣列  
必要：否

 ** [tags](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-tags"></a>
要指派給已還原彈性叢集的標籤名稱清單，格式為索引鍵為標籤名稱且值為索引鍵值的索引鍵值對陣列。  
類型：字串到字串映射  
索引鍵長度限制：長度下限為 1。長度上限為 128。  
金鑰模式：`(?!aws:)[a-zA-Z+-=._:/]+`  
值長度限制：長度下限為 0。長度上限為 256。  
必要：否

 ** [vpcSecurityGroupIds](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-vpcSecurityGroupIds"></a>
要與彈性叢集建立關聯的 EC2 VPC 安全群組清單。  
類型：字串陣列  
必要：否

## 回應語法
<a name="API_elastic_RestoreClusterFromSnapshot_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cluster": { 
      "adminUserName": "string",
      "authType": "string",
      "backupRetentionPeriod": number,
      "clusterArn": "string",
      "clusterEndpoint": "string",
      "clusterName": "string",
      "createTime": "string",
      "kmsKeyId": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "shardCapacity": number,
      "shardCount": number,
      "shardInstanceCount": number,
      "shards": [ 
         { 
            "createTime": "string",
            "shardId": "string",
            "status": "string"
         }
      ],
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## 回應元素
<a name="API_elastic_RestoreClusterFromSnapshot_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [cluster](#API_elastic_RestoreClusterFromSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-response-cluster"></a>
傳回已還原彈性叢集的相關資訊。  
類型：[Cluster](API_elastic_Cluster.md) 物件

## 錯誤
<a name="API_elastic_RestoreClusterFromSnapshot_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** AccessDeniedException **   
當沒有足夠的許可來執行動作時，就會發生例外狀況。    
 ** message **   
錯誤訊息，說明拒絕存取的原因。
HTTP 狀態碼：403

 ** ConflictException **   
發生存取衝突。    
 ** resourceId **   
發生存取衝突的資源 ID。  
 ** resourceType **   
發生存取衝突的資源類型。
HTTP 狀態碼：409

 ** InternalServerException **   
發生內部伺服器錯誤。  
HTTP 狀態碼：500

 ** ResourceNotFoundException **   
找不到指定的資源。    
 ** message **   
描述失敗的錯誤訊息。  
 ** resourceId **   
找不到的資源 ID。  
 ** resourceType **   
找不到的資源類型。
HTTP 狀態碼：404

 ** ServiceQuotaExceededException **   
已超過 動作的服務配額。  
HTTP 狀態碼：402

 ** ThrottlingException **   
當請求因請求調節而遭拒時，將會擲回 ThrottlingException。    
 ** retryAfterSeconds **   
重試操作之前要等待的秒數。
HTTP 狀態碼：429

 ** ValidationException **   
定義驗證例外狀況的結構。    
 ** fieldList **   
發生驗證例外狀況的欄位清單。  
 ** message **   
描述驗證例外狀況的錯誤訊息。  
 ** reason **   
驗證例外發生的原因 (`unknownOperation`、`fieldValidationFailed`、 `cannotParse`或 之一`other`)。
HTTP 狀態碼：400

## 另請參閱
<a name="API_elastic_RestoreClusterFromSnapshot_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 

# StartCluster
<a name="API_elastic_StartCluster"></a>

重新啟動 指定的已停止彈性叢集`clusterARN`。

## 請求語法
<a name="API_elastic_StartCluster_RequestSyntax"></a>

```
POST /cluster/clusterArn/start HTTP/1.1
```

## URI 請求參數
<a name="API_elastic_StartCluster_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [clusterArn](#API_elastic_StartCluster_RequestSyntax) **   <a name="documentdb-elastic_StartCluster-request-uri-clusterArn"></a>
彈性叢集的 ARN 識別符。  
必要：是

## 請求主體
<a name="API_elastic_StartCluster_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_elastic_StartCluster_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cluster": { 
      "adminUserName": "string",
      "authType": "string",
      "backupRetentionPeriod": number,
      "clusterArn": "string",
      "clusterEndpoint": "string",
      "clusterName": "string",
      "createTime": "string",
      "kmsKeyId": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "shardCapacity": number,
      "shardCount": number,
      "shardInstanceCount": number,
      "shards": [ 
         { 
            "createTime": "string",
            "shardId": "string",
            "status": "string"
         }
      ],
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## 回應元素
<a name="API_elastic_StartCluster_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [cluster](#API_elastic_StartCluster_ResponseSyntax) **   <a name="documentdb-elastic_StartCluster-response-cluster"></a>
傳回特定彈性叢集的相關資訊。  
類型：[Cluster](API_elastic_Cluster.md) 物件

## 錯誤
<a name="API_elastic_StartCluster_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** AccessDeniedException **   
當沒有足夠的許可來執行動作時，就會發生例外狀況。    
 ** message **   
錯誤訊息，說明拒絕存取的原因。
HTTP 狀態碼：403

 ** InternalServerException **   
發生內部伺服器錯誤。  
HTTP 狀態碼：500

 ** ResourceNotFoundException **   
找不到指定的資源。    
 ** message **   
描述失敗的錯誤訊息。  
 ** resourceId **   
找不到的資源 ID。  
 ** resourceType **   
找不到的資源類型。
HTTP 狀態碼：404

 ** ThrottlingException **   
當請求因請求調節而遭拒時，將會擲回 ThrottlingException。    
 ** retryAfterSeconds **   
重試操作之前要等待的秒數。
HTTP 狀態碼：429

 ** ValidationException **   
定義驗證例外狀況的結構。    
 ** fieldList **   
發生驗證例外狀況的欄位清單。  
 ** message **   
描述驗證例外狀況的錯誤訊息。  
 ** reason **   
驗證例外發生的原因 (`unknownOperation`、`fieldValidationFailed`、 `cannotParse`或 之一`other`)。
HTTP 狀態碼：400

## 另請參閱
<a name="API_elastic_StartCluster_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/StartCluster) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/StartCluster) 

# StopCluster
<a name="API_elastic_StopCluster"></a>

停止 指定的執行中彈性叢集`clusterArn`。彈性叢集必須處於*可用*狀態。

## 請求語法
<a name="API_elastic_StopCluster_RequestSyntax"></a>

```
POST /cluster/clusterArn/stop HTTP/1.1
```

## URI 請求參數
<a name="API_elastic_StopCluster_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [clusterArn](#API_elastic_StopCluster_RequestSyntax) **   <a name="documentdb-elastic_StopCluster-request-uri-clusterArn"></a>
彈性叢集的 ARN 識別符。  
必要：是

## 請求主體
<a name="API_elastic_StopCluster_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_elastic_StopCluster_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cluster": { 
      "adminUserName": "string",
      "authType": "string",
      "backupRetentionPeriod": number,
      "clusterArn": "string",
      "clusterEndpoint": "string",
      "clusterName": "string",
      "createTime": "string",
      "kmsKeyId": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "shardCapacity": number,
      "shardCount": number,
      "shardInstanceCount": number,
      "shards": [ 
         { 
            "createTime": "string",
            "shardId": "string",
            "status": "string"
         }
      ],
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## 回應元素
<a name="API_elastic_StopCluster_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [cluster](#API_elastic_StopCluster_ResponseSyntax) **   <a name="documentdb-elastic_StopCluster-response-cluster"></a>
傳回特定彈性叢集的相關資訊。  
類型：[Cluster](API_elastic_Cluster.md) 物件

## 錯誤
<a name="API_elastic_StopCluster_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** AccessDeniedException **   
當沒有足夠的許可來執行動作時，就會發生例外狀況。    
 ** message **   
錯誤訊息，說明拒絕存取的原因。
HTTP 狀態碼：403

 ** InternalServerException **   
發生內部伺服器錯誤。  
HTTP 狀態碼：500

 ** ResourceNotFoundException **   
找不到指定的資源。    
 ** message **   
描述失敗的錯誤訊息。  
 ** resourceId **   
找不到的資源 ID。  
 ** resourceType **   
找不到的資源類型。
HTTP 狀態碼：404

 ** ThrottlingException **   
當請求因請求調節而遭拒時，將會擲回 ThrottlingException。    
 ** retryAfterSeconds **   
重試操作之前要等待的秒數。
HTTP 狀態碼：429

 ** ValidationException **   
定義驗證例外狀況的結構。    
 ** fieldList **   
發生驗證例外狀況的欄位清單。  
 ** message **   
描述驗證例外狀況的錯誤訊息。  
 ** reason **   
驗證例外發生的原因 (`unknownOperation`、`fieldValidationFailed`、 `cannotParse`或 之一`other`)。
HTTP 狀態碼：400

## 另請參閱
<a name="API_elastic_StopCluster_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/StopCluster) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/StopCluster) 

# TagResource
<a name="API_elastic_TagResource"></a>

將中繼資料標籤新增至彈性叢集資源

## 請求語法
<a name="API_elastic_TagResource_RequestSyntax"></a>

```
POST /tags/resourceArn HTTP/1.1
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## URI 請求參數
<a name="API_elastic_TagResource_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [resourceArn](#API_elastic_TagResource_RequestSyntax) **   <a name="documentdb-elastic_TagResource-request-uri-resourceArn"></a>
彈性叢集資源的 ARN 識別符。  
長度限制：長度下限為 1。長度上限為 1011。  
必要：是

## 請求主體
<a name="API_elastic_TagResource_RequestBody"></a>

請求接受採用 JSON 格式的下列資料。

 ** [tags](#API_elastic_TagResource_RequestSyntax) **   <a name="documentdb-elastic_TagResource-request-tags"></a>
指派給彈性叢集資源的標籤。  
類型：字串到字串映射  
索引鍵長度限制：長度下限為 1。長度上限為 128。  
金鑰模式：`(?!aws:)[a-zA-Z+-=._:/]+`  
值長度限制：長度下限為 0。長度上限為 256。  
必要：是

## 回應語法
<a name="API_elastic_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## 回應元素
<a name="API_elastic_TagResource_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_elastic_TagResource_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** InternalServerException **   
發生內部伺服器錯誤。  
HTTP 狀態碼：500

 ** ResourceNotFoundException **   
找不到指定的資源。    
 ** message **   
描述失敗的錯誤訊息。  
 ** resourceId **   
找不到的資源 ID。  
 ** resourceType **   
找不到的資源類型。
HTTP 狀態碼：404

 ** ThrottlingException **   
當請求因請求調節而遭拒時，將會擲回 ThrottlingException。    
 ** retryAfterSeconds **   
重試操作之前要等待的秒數。
HTTP 狀態碼：429

 ** ValidationException **   
定義驗證例外狀況的結構。    
 ** fieldList **   
發生驗證例外狀況的欄位清單。  
 ** message **   
描述驗證例外狀況的錯誤訊息。  
 ** reason **   
驗證例外發生的原因 (`unknownOperation`、`fieldValidationFailed`、 `cannotParse`或 之一`other`)。
HTTP 狀態碼：400

## 另請參閱
<a name="API_elastic_TagResource_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/TagResource) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/TagResource) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/TagResource) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/TagResource) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/TagResource) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/TagResource) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/TagResource) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/TagResource) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/TagResource) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/TagResource) 

# UntagResource
<a name="API_elastic_UntagResource"></a>

從彈性叢集資源移除中繼資料標籤

## 請求語法
<a name="API_elastic_UntagResource_RequestSyntax"></a>

```
DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1
```

## URI 請求參數
<a name="API_elastic_UntagResource_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [resourceArn](#API_elastic_UntagResource_RequestSyntax) **   <a name="documentdb-elastic_UntagResource-request-uri-resourceArn"></a>
彈性叢集資源的 ARN 識別符。  
長度限制：長度下限為 1。長度上限為 1011。  
必要：是

 ** [tagKeys](#API_elastic_UntagResource_RequestSyntax) **   <a name="documentdb-elastic_UntagResource-request-uri-tagKeys"></a>
要從彈性叢集資源中移除的標籤索引鍵。  
陣列成員：項目數下限為 0。項目數上限為 50。  
長度限制：長度下限為 1。長度上限為 128。  
模式：`(?!aws:)[a-zA-Z+-=._:/]+`  
必要：是

## 請求主體
<a name="API_elastic_UntagResource_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_elastic_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## 回應元素
<a name="API_elastic_UntagResource_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_elastic_UntagResource_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** InternalServerException **   
發生內部伺服器錯誤。  
HTTP 狀態碼：500

 ** ResourceNotFoundException **   
找不到指定的資源。    
 ** message **   
描述失敗的錯誤訊息。  
 ** resourceId **   
找不到的資源 ID。  
 ** resourceType **   
找不到的資源類型。
HTTP 狀態碼：404

 ** ThrottlingException **   
當請求因請求調節而遭拒時，將會擲回 ThrottlingException。    
 ** retryAfterSeconds **   
重試操作之前要等待的秒數。
HTTP 狀態碼：429

 ** ValidationException **   
定義驗證例外狀況的結構。    
 ** fieldList **   
發生驗證例外狀況的欄位清單。  
 ** message **   
描述驗證例外狀況的錯誤訊息。  
 ** reason **   
驗證例外發生的原因 (`unknownOperation`、`fieldValidationFailed`、 `cannotParse`或 之一`other`)。
HTTP 狀態碼：400

## 另請參閱
<a name="API_elastic_UntagResource_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/UntagResource) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/UntagResource) 

# UpdateCluster
<a name="API_elastic_UpdateCluster"></a>

修改彈性叢集。這包括更新 admin-username/password、升級 API 版本，以及設定備份時段和維護時段

## 請求語法
<a name="API_elastic_UpdateCluster_RequestSyntax"></a>

```
PUT /cluster/clusterArn HTTP/1.1
Content-type: application/json

{
   "adminUserPassword": "string",
   "authType": "string",
   "backupRetentionPeriod": number,
   "clientToken": "string",
   "preferredBackupWindow": "string",
   "preferredMaintenanceWindow": "string",
   "shardCapacity": number,
   "shardCount": number,
   "shardInstanceCount": number,
   "subnetIds": [ "string" ],
   "vpcSecurityGroupIds": [ "string" ]
}
```

## URI 請求參數
<a name="API_elastic_UpdateCluster_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [clusterArn](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-uri-clusterArn"></a>
彈性叢集的 ARN 識別符。  
必要：是

## 請求主體
<a name="API_elastic_UpdateCluster_RequestBody"></a>

請求接受採用 JSON 格式的下列資料。

 ** [adminUserPassword](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-adminUserPassword"></a>
與彈性叢集管理員相關聯的密碼。此密碼可包含任何可印出的 ASCII 字元，但斜線 (/)、雙引號 (") 或 "at" 符號 (@) 則除外。  
 *限制條件*：必須包含 8 到 100 個字元。  
類型：字串  
必要：否

 ** [authType](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-authType"></a>
用來決定在何處擷取用於存取彈性叢集之密碼的身分驗證類型。有效類型為 `PLAIN_TEXT`或 `SECRET_ARN`。  
類型：字串  
有效值:`PLAIN_TEXT | SECRET_ARN`   
必要：否

 ** [backupRetentionPeriod](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-backupRetentionPeriod"></a>
保留自動快照的天數。  
類型：整數  
必要：否

 ** [clientToken](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-clientToken"></a>
彈性叢集的用戶端字符。  
類型：字串  
必要：否

 ** [preferredBackupWindow](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-preferredBackupWindow"></a>
如果啟用自動備份，則建立自動備份的每日時間範圍，由 決定`backupRetentionPeriod`。  
類型：字串  
必要：否

 ** [preferredMaintenanceWindow](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-preferredMaintenanceWindow"></a>
每週可能進行系統維護的時段，以國際標準時間 (UTC) 表示。  
 *格式*：`ddd:hh24:mi-ddd:hh24:mi`  
 *預設*：從每個 8 小時的時段中隨機選取的 30 分鐘時段 AWS 區域，發生在一週中的隨機一天。  
 *有效天數*：週一、週二、週三、週四、週五、週六、週日  
 *限制條件*：必須至少是 30 分鐘的時段。  
類型：字串  
必要：否

 ** [shardCapacity](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-shardCapacity"></a>
指派給每個彈性叢集碎片vCPUs 數目。上限為 64。允許的值為 2、4、8、16、32、64。  
類型：整數  
必要：否

 ** [shardCount](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-shardCount"></a>
指派給彈性叢集的碎片數量。上限為 32。  
類型：整數  
必要：否

 ** [shardInstanceCount](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-shardInstanceCount"></a>
套用至彈性叢集中所有碎片的複本執行個體數目。`shardInstanceCount` 值 1 表示有一個寫入器執行個體，而任何其他執行個體都是可用於讀取和改善可用性的複本。  
類型：整數  
必要：否

 ** [subnetIds](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-subnetIds"></a>
彈性叢集的 Amazon EC2 IDs。  
類型：字串陣列  
必要：否

 ** [vpcSecurityGroupIds](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-vpcSecurityGroupIds"></a>
要與彈性叢集建立關聯的 EC2 VPC 安全群組清單。  
類型：字串陣列  
必要：否

## 回應語法
<a name="API_elastic_UpdateCluster_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cluster": { 
      "adminUserName": "string",
      "authType": "string",
      "backupRetentionPeriod": number,
      "clusterArn": "string",
      "clusterEndpoint": "string",
      "clusterName": "string",
      "createTime": "string",
      "kmsKeyId": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "shardCapacity": number,
      "shardCount": number,
      "shardInstanceCount": number,
      "shards": [ 
         { 
            "createTime": "string",
            "shardId": "string",
            "status": "string"
         }
      ],
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## 回應元素
<a name="API_elastic_UpdateCluster_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [cluster](#API_elastic_UpdateCluster_ResponseSyntax) **   <a name="documentdb-elastic_UpdateCluster-response-cluster"></a>
傳回更新彈性叢集的相關資訊。  
類型：[Cluster](API_elastic_Cluster.md) 物件

## 錯誤
<a name="API_elastic_UpdateCluster_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** AccessDeniedException **   
當沒有足夠的許可來執行動作時，就會發生例外狀況。    
 ** message **   
錯誤訊息，說明拒絕存取的原因。
HTTP 狀態碼：403

 ** ConflictException **   
發生存取衝突。    
 ** resourceId **   
發生存取衝突的資源 ID。  
 ** resourceType **   
發生存取衝突的資源類型。
HTTP 狀態碼：409

 ** InternalServerException **   
發生內部伺服器錯誤。  
HTTP 狀態碼：500

 ** ResourceNotFoundException **   
找不到指定的資源。    
 ** message **   
描述失敗的錯誤訊息。  
 ** resourceId **   
找不到的資源 ID。  
 ** resourceType **   
找不到的資源類型。
HTTP 狀態碼：404

 ** ThrottlingException **   
當請求因請求調節而遭拒時，將會擲回 ThrottlingException。    
 ** retryAfterSeconds **   
重試操作之前要等待的秒數。
HTTP 狀態碼：429

 ** ValidationException **   
定義驗證例外狀況的結構。    
 ** fieldList **   
發生驗證例外狀況的欄位清單。  
 ** message **   
描述驗證例外狀況的錯誤訊息。  
 ** reason **   
驗證例外發生的原因 (`unknownOperation`、`fieldValidationFailed`、 `cannotParse`或 之一`other`)。
HTTP 狀態碼：400

## 另請參閱
<a name="API_elastic_UpdateCluster_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/UpdateCluster)