本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
# Neptune 參數 API
**動作:**
+ [CopyDBParameterGroup (動作)](#CopyDBParameterGroup)
+ [CopyDBClusterParameterGroup (動作)](#CopyDBClusterParameterGroup)
+ [CreateDBParameterGroup (動作)](#CreateDBParameterGroup)
+ [CreateDBClusterParameterGroup (動作)](#CreateDBClusterParameterGroup)
+ [DeleteDBParameterGroup (動作)](#DeleteDBParameterGroup)
+ [DeleteDBClusterParameterGroup (動作)](#DeleteDBClusterParameterGroup)
+ [ModifyDBParameterGroup (動作)](#ModifyDBParameterGroup)
+ [ModifyDBClusterParameterGroup (動作)](#ModifyDBClusterParameterGroup)
+ [ResetDBParameterGroup (動作)](#ResetDBParameterGroup)
+ [ResetDBClusterParameterGroup (動作)](#ResetDBClusterParameterGroup)
+ [DescribeDBParameters (動作)](#DescribeDBParameters)
+ [DescribeDBParameterGroups (動作)](#DescribeDBParameterGroups)
+ [DescribeDBClusterParameters (動作)](#DescribeDBClusterParameters)
+ [DescribeDBClusterParameterGroups (動作)](#DescribeDBClusterParameterGroups)
+ [DescribeEngineDefaultParameters (動作)](#DescribeEngineDefaultParameters)
+ [DescribeEngineDefaultClusterParameters (動作)](#DescribeEngineDefaultClusterParameters)
**結構：**
+ [Parameter (結構)](#Parameter)
+ [DBParameterGroup (結構)](#DBParameterGroup)
+ [DBClusterParameterGroup (結構)](#DBClusterParameterGroup)
+ [DBParameterGroupStatus (結構)](#DBParameterGroupStatus)
## CopyDBParameterGroup (動作)
此 API 的 AWS CLI 名稱為：`copy-db-parameter-group`。
複製指定的資料庫參數群組。
**請求**
+ **SourceDBParameterGroupIdentifier** (在 CLI 中：`--source-db-parameter-group-identifier`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
來源資料庫參數群組的識別符或 ARN。如需建立 ARN 的資訊，請參閱[建構 Amazon Resource Name (ARN)](https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing)。
約束:
+ 必須指定有效的資料庫參數群組。
+ 必須指定有效的資料庫參數群組識別符 (例如 `my-db-param-group`)，或有效的 ARN。
+ **Tags** (在 CLI 中：`--tags`) – [Tag](api-other-apis.md#Tag) 物件的陣列。
要指派給所複製資料庫參數群組的標籤。
+ **TargetDBParameterGroupDescription** (在 CLI 中：`--target-db-parameter-group-description`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
所複製資料庫參數群組的描述。
+ **TargetDBParameterGroupIdentifier** (在 CLI 中：`--target-db-parameter-group-identifier`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
所複製資料庫參數群組的識別符。
約束:
+ 不得為無效、空白或留空。
+ 必須包含 1 到 255 個字母、數字或連字號。
+ 第一個字元必須是字母。
+ 不能以連字號結尾或連續包含兩個連字號。
範例：`my-db-parameter-group`
**回應**
包含 Amazon Neptune 資料庫參數群組的詳細資訊。
此資料類型在 [DescribeDBParameterGroups (動作)](#DescribeDBParameterGroups) 動作中會用來作為回應元素。
+ **DBParameterGroupArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫參數群組的 Amazon Resource Name (ARN)。
+ **DBParameterGroupFamily** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供此資料庫參數群組相容的資料庫參數群組系列名稱。
+ **DBParameterGroupName** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供資料庫參數群組的名稱。
+ **Description** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供此資料庫參數群組的客戶指定描述。
**錯誤**
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
+ [DBParameterGroupAlreadyExistsFault](api-faults.md#DBParameterGroupAlreadyExistsFault)
+ [DBParameterGroupQuotaExceededFault](api-faults.md#DBParameterGroupQuotaExceededFault)
## CopyDBClusterParameterGroup (動作)
此 API 的 AWS CLI 名稱為：`copy-db-cluster-parameter-group`。
複製指定的資料庫叢集參數群組。
**請求**
+ **SourceDBClusterParameterGroupIdentifier** (在 CLI 中：`--source-db-cluster-parameter-group-identifier`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
來源資料庫叢集參數群組的識別符或 Amazon Resource Name (ARN)。如需建立 ARN 的資訊，請參閱[建構 Amazon Resource Name (ARN)](https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing)。
約束:
+ 必須指定有效的資料庫叢集參數群組。
+ 若來源資料庫叢集參數群組位於和複本相同的 Amazon 區域，請指定有效的資料庫參數群組識別符 (例如 `my-db-cluster-param-group`)，或有效的 ARN。
+ 若來源資料庫參數群組位於和複本不同的 Amazon 區域，請指定有效的資料庫叢集參數群組 ARN (例如 `arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1`)。
+ **Tags** (在 CLI 中：`--tags`) – [Tag](api-other-apis.md#Tag) 物件的陣列。
要指派給所複製資料庫叢集參數群組的標籤。
+ **TargetDBClusterParameterGroupDescription** (在 CLI 中：`--target-db-cluster-parameter-group-description`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
所複製資料庫叢集參數群組的描述。
+ **TargetDBClusterParameterGroupIdentifier** (在 CLI 中：`--target-db-cluster-parameter-group-identifier`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
所複製資料庫叢集參數群組的識別符。
約束:
+ 不可為 null、空白或留空
+ 必須包含 1 到 255 個字母、數字或連字號
+ 第一個字元必須是字母
+ 不能以連字號結尾或連續包含兩個連字號
範例：`my-cluster-param-group1`
**回應**
包含 Amazon Neptune 資料庫叢集參數群組的詳細資訊。
此資料類型在 [DescribeDBClusterParameterGroups (動作)](#DescribeDBClusterParameterGroups) 動作中會用來作為回應元素。
+ **DBClusterParameterGroupArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集參數群組的 Amazon Resource Name (ARN)。
+ **DBClusterParameterGroupName** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供資料庫叢集參數群組的名稱。
+ **DBParameterGroupFamily** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供此資料庫叢集參數群組相容的資料庫參數群組系列名稱。
+ **Description** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供該客戶指定之此資料庫叢集參數群組的描述。
**錯誤**
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
+ [DBParameterGroupQuotaExceededFault](api-faults.md#DBParameterGroupQuotaExceededFault)
+ [DBParameterGroupAlreadyExistsFault](api-faults.md#DBParameterGroupAlreadyExistsFault)
## CreateDBParameterGroup (動作)
此 API 的 AWS CLI 名稱為：`create-db-parameter-group`。
建立新的資料庫參數群組。
最初會為資料庫執行個體所使用的資料庫引擎，使用預設參數建立資料庫參數群組。若要為任何參數提供自訂值，您必須在使用 *ModifyDBParameterGroup* 建立它後修改群組。在您建立資料庫參數群組後，您需要使用 *ModifyDBInstance* 將它與您的資料庫執行個體建立關聯。當您將新的資料庫參數群組與執行中的資料庫執行個體建立關聯時，您需要在不使用容錯移轉的情況下重新開機資料庫執行個體，才能讓新的資料庫參數群組和相關聯的設定產生效果。
**重要**
建立資料庫參數群組之後，您至少應等待 5 分鐘，再使用該資料庫參數群組當作預設參數群組，建立第一個資料庫執行個體。這可讓 Amazon Neptune 在將參數群組用來做為新資料庫執行個體的預設前，完成建立動作。這對建立資料庫執行個體預設資料庫時的關鍵參數尤其重要，像是 `character_set_database` 參數所定義之預設資料庫的字元集。您可以使用 Amazon Neptune 主控台的「參數群組」**選項或 *DescribeDBParameters* 命令來驗證您的資料庫參數群組已建立或修改完成。
**請求**
+ **DBParameterGroupFamily** (在 CLI 中：`--db-parameter-group-family`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫參數群組系列名稱。資料庫參數群組可和一個，並且只能和一個資料庫參數群組系列建立關聯，並且只能套用到執行與該資料庫參數群組系列相容資料庫引擎和引擎版本的資料庫執行個體。
+ **DBParameterGroupName** (在 CLI 中：`--db-parameter-group-name`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫參數群組的名稱。
約束:
+ 必須為 1 到 255 個字母、數字或連字號。
+ 第一個字元必須是字母
+ 不能以連字號結尾或連續包含兩個連字號
**注意**
此值會以小寫字母字串的形式儲存。
+ **Description** (在 CLI 中：`--description`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫參數群組的描述。
+ **Tags** (在 CLI 中：`--tags`) – [Tag](api-other-apis.md#Tag) 物件的陣列。
要指派給新資料庫參數群組的標籤。
**回應**
包含 Amazon Neptune 資料庫參數群組的詳細資訊。
此資料類型在 [DescribeDBParameterGroups (動作)](#DescribeDBParameterGroups) 動作中會用來作為回應元素。
+ **DBParameterGroupArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫參數群組的 Amazon Resource Name (ARN)。
+ **DBParameterGroupFamily** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供此資料庫參數群組相容的資料庫參數群組系列名稱。
+ **DBParameterGroupName** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供資料庫參數群組的名稱。
+ **Description** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供此資料庫參數群組的客戶指定描述。
**錯誤**
+ [DBParameterGroupQuotaExceededFault](api-faults.md#DBParameterGroupQuotaExceededFault)
+ [DBParameterGroupAlreadyExistsFault](api-faults.md#DBParameterGroupAlreadyExistsFault)
## CreateDBClusterParameterGroup (動作)
此 API 的 AWS CLI 名稱為：`create-db-cluster-parameter-group`。
建立新的資料庫叢集參數群組。
資料庫叢集參數群組中的參數會套用到資料庫叢集中的所有執行個體。
最初會為資料庫叢集中執行個體所使用的資料庫引擎，使用預設參數建立資料庫叢集參數群組。若要為任何參數提供自訂值，您必須在使用 [ModifyDBClusterParameterGroup (動作)](#ModifyDBClusterParameterGroup) 建立它後修改群組。在您建立資料庫叢集參數群組後，您需要使用 [ModifyDBCluster (動作)](api-clusters.md#ModifyDBCluster) 將它與您的資料庫叢集建立關聯。當您將新的資料庫叢集參數群組與執行中的資料庫叢集建立關聯時，您需要在不使用容錯移轉的情況下重新開機資料庫叢集中的資料庫執行個體，才能讓新的資料庫叢集參數群組和相關聯的設定產生效果。
**重要**
建立資料庫叢集參數群組後，您應等待至少 5 分鐘，然後再建立第一個使用該資料庫叢集參數群組做為預設參數群組的資料庫叢集。這可讓 Amazon Neptune 在將資料庫叢集參數群組用來做為新資料庫叢集的預設前，完成建立動作。這對建立資料庫叢集預設資料庫時的關鍵參數尤其重要，像是 `character_set_database` 參數所定義的預設資料庫字元集。您可以使用 [Amazon Neptune 主控台](https://console.aws.amazon.com/rds/)的「參數群組」**選項或 [DescribeDBClusterParameters (動作)](#DescribeDBClusterParameters) 命令，來驗證是否已建立或修改您的資料庫叢集參數群組。
**請求**
+ **DBClusterParameterGroupName** (在 CLI 中：`--db-cluster-parameter-group-name`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集參數群組的名稱。
約束:
+ 必須符合現有 DBClusterParameterGroup 的名稱。
**注意**
此值會以小寫字母字串的形式儲存。
+ **DBParameterGroupFamily** (在 CLI 中：`--db-parameter-group-family`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集參數群組的系列名稱。資料庫叢集參數群組可和一個，並且只能和一個資料庫叢集參數群組系列建立關聯，並且只能套用到執行與該資料庫叢集參數群組系列相容資料庫引擎和引擎版本的資料庫叢集。
+ **Description** (在 CLI 中：`--description`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集參數群組的描述。
+ **Tags** (在 CLI 中：`--tags`) – [Tag](api-other-apis.md#Tag) 物件的陣列。
要指派給新資料庫叢集參數群組的標籤。
**回應**
包含 Amazon Neptune 資料庫叢集參數群組的詳細資訊。
此資料類型在 [DescribeDBClusterParameterGroups (動作)](#DescribeDBClusterParameterGroups) 動作中會用來作為回應元素。
+ **DBClusterParameterGroupArn** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集參數群組的 Amazon Resource Name (ARN)。
+ **DBClusterParameterGroupName** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供資料庫叢集參數群組的名稱。
+ **DBParameterGroupFamily** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供此資料庫叢集參數群組相容的資料庫參數群組系列名稱。
+ **Description** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供該客戶指定之此資料庫叢集參數群組的描述。
**錯誤**
+ [DBParameterGroupQuotaExceededFault](api-faults.md#DBParameterGroupQuotaExceededFault)
+ [DBParameterGroupAlreadyExistsFault](api-faults.md#DBParameterGroupAlreadyExistsFault)
## DeleteDBParameterGroup (動作)
此 API 的 AWS CLI 名稱為：`delete-db-parameter-group`。
刪除指定的 DBParameterGroup。要刪除的 DBParameterGroup 不可和任何資料庫執行個體建立關聯。
**請求**
+ **DBParameterGroupName** (在 CLI 中：`--db-parameter-group-name`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫參數群組的名稱。
約束:
+ 必須是現有資料庫參數群組的名稱
+ 您無法刪除預設資料庫參數群組
+ 不可和任何資料庫執行個體建立關聯
**回應**
+ *無回應參數。*
**錯誤**
+ [InvalidDBParameterGroupStateFault](api-faults.md#InvalidDBParameterGroupStateFault)
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
## DeleteDBClusterParameterGroup (動作)
此 API 的 AWS CLI 名稱為：`delete-db-cluster-parameter-group`。
刪除指定的資料庫叢集參數群組。要刪除的資料庫叢集參數群組不可和任何資料庫叢集建立關聯。
**請求**
+ **DBClusterParameterGroupName** (在 CLI 中：`--db-cluster-parameter-group-name`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集參數群組的名稱。
約束:
+ 必須是現有資料庫叢集參數群組的名稱。
+ 您無法刪除預設資料庫叢集參數群組。
+ 不可和任何資料庫叢集建立關聯
**回應**
+ *無回應參數。*
**錯誤**
+ [InvalidDBParameterGroupStateFault](api-faults.md#InvalidDBParameterGroupStateFault)
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
## ModifyDBParameterGroup (動作)
此 API 的 AWS CLI 名稱為：`modify-db-parameter-group`。
修改資料庫參數群組的參數。若要修改超過一個參數，請提交下列項目的清單：`ParameterName`、`ParameterValue` 和 `ApplyMethod`。單一請求中最多可修改 20 個參數。
**注意**
動態參數的變更會立即套用。對靜態參數進行的變更，需要在不使用容錯移轉至與參數群組關聯資料庫執行個體的情況下重新開機，才能生效。
**重要**
修改資料庫參數群組之後，您應該等待至少5分鐘，然後再建立第一個使用該資料庫參數群組做為預設參數群組的資料庫執行個體。這可讓 Amazon Neptune 在將參數群組用來做為新資料庫執行個體的預設前，完成修改動作。這對建立資料庫執行個體預設資料庫時的關鍵參數尤其重要，像是 `character_set_database` 參數所定義之預設資料庫的字元集。您可以使用 Amazon Neptune 主控台的「參數群組」**選項或 *DescribeDBParameters* 命令來驗證您的資料庫參數群組已建立或修改完成。
**請求**
+ **DBParameterGroupName** (在 CLI 中：`--db-parameter-group-name`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫參數群組的名稱。
約束:
+ 若有提供，則必須符合現有 DBParameterGroup 的名稱。
+ **Parameters** (在 CLI 中：`--parameters`) – *必要：*[參數](#Parameter) 物件的陣列。
參數名稱、值，以及參數更新套用方法的陣列。必須至少提供一個參數名稱、值及套用方法；後續引數都是選用的。單一請求中最多可修改 20 個參數。
有效值 (針對套用方法)：`immediate | pending-reboot`
**注意**
您只能在搭配動態參數時使用 immediate 值。您可以針對動態和靜態參數使用 pending-reboot 值，並且變更會在您不使用容錯移轉重新開機資料庫執行個體時套用。
**回應**
+ **DBParameterGroupName** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供資料庫參數群組的名稱。
**錯誤**
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
+ [InvalidDBParameterGroupStateFault](api-faults.md#InvalidDBParameterGroupStateFault)
## ModifyDBClusterParameterGroup (動作)
此 API 的 AWS CLI 名稱為：`modify-db-cluster-parameter-group`。
修改資料庫叢集參數群組的參數。若要修改超過一個參數，請提交下列項目的清單：`ParameterName`、`ParameterValue` 和 `ApplyMethod`。單一請求中最多可修改 20 個參數。
**注意**
動態參數的變更會立即套用。對靜態參數進行的變更，需要在不使用容錯移轉至與參數群組關聯資料庫叢集的情況下重新開機，才能生效。
**重要**
建立資料庫叢集參數群組後，您應等待至少 5 分鐘，然後再建立第一個使用該資料庫叢集參數群組做為預設參數群組的資料庫叢集。這可讓 Amazon Neptune 在將參數群組用來做為新資料庫叢集的預設前，完成建立動作。這對建立資料庫叢集預設資料庫時的關鍵參數尤其重要，像是 `character_set_database` 參數所定義的預設資料庫字元集。您可以使用 Amazon Neptune 主控台的「參數群組」**選項或 [DescribeDBClusterParameters (動作)](#DescribeDBClusterParameters) 命令來驗證您的資料庫叢集參數群組已建立或修改完成。
**請求**
+ **DBClusterParameterGroupName** (在 CLI 中：`--db-cluster-parameter-group-name`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
欲修改資料庫叢集參數群組的名稱。
+ **Parameters** (在 CLI 中：`--parameters`) – *必要：*[參數](#Parameter) 物件的陣列。
欲修改資料庫叢集參數群組中參數的清單。
**回應**
+ **DBClusterParameterGroupName** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集參數群組的名稱。
約束:
+ 必須為 1 到 255 個字母或數字。
+ 第一個字元必須是字母
+ 不能以連字號結尾或連續包含兩個連字號
**注意**
此值會以小寫字母字串的形式儲存。
**錯誤**
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
+ [InvalidDBParameterGroupStateFault](api-faults.md#InvalidDBParameterGroupStateFault)
## ResetDBParameterGroup (動作)
此 API 的 AWS CLI 名稱為：`reset-db-parameter-group`。
將資料庫參數群組的參數修改為引擎/系統的預設值。若要重設特定參數，請提供下列項目的清單：`ParameterName` 和 `ApplyMethod`。若要重設整個資料庫參數群組，請指定 `DBParameterGroup` 名稱和 `ResetAllParameters` 參數。重設整個群組時，動態參數會立即更新，靜態參數則會設為 `pending-reboot`，並在下一次資料庫執行個體重新啟動或 `RebootDBInstance` 請求時生效。
**請求**
+ **DBParameterGroupName** (在 CLI 中：`--db-parameter-group-name`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫參數群組的名稱。
約束:
+ 必須符合現有 DBParameterGroup 的名稱。
+ **Parameters** (在 CLI 中：`--parameters`) – [參數](#Parameter) 物件的陣列。
若要重設整個資料庫參數群組，請指定 `DBParameterGroup` 名稱和 `ResetAllParameters` 參數。若要重設特定參數，請提供下列項目的清單：`ParameterName` 和 `ApplyMethod`。單一請求中最多可修改 20 個參數。
有效值 (針對套用方法)：`pending-reboot`
+ **ResetAllParameters** (在 CLI 中:`--reset-all-parameters`) – 布林值，類型為：`boolean` (布林值 (true 或 false))。
指定是 (`true`) 否 (`false`) 要將資料庫參數群組中的所有參數重設為預設值。
預設：`true`
**回應**
+ **DBParameterGroupName** – 字串，類型為：`string` (UTF-8 編碼的字串)。
提供資料庫參數群組的名稱。
**錯誤**
+ [InvalidDBParameterGroupStateFault](api-faults.md#InvalidDBParameterGroupStateFault)
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
## ResetDBClusterParameterGroup (動作)
此 API 的 AWS CLI 名稱為：`reset-db-cluster-parameter-group`。
將資料庫叢集參數群組的參數修改為預設值。若要重設特定參數，請提交下列項目的清單：`ParameterName` 和 `ApplyMethod`。若要重設整個資料庫叢集參數群組，請指定 `DBClusterParameterGroupName` 名稱和 `ResetAllParameters` 參數。
重設整個群組時，動態參數會立即更新，靜態參數則會設為 `pending-reboot`，並在下一次資料庫執行個體重新啟動或 [RebootDBInstance (動作)](api-instances.md#RebootDBInstance) 請求時生效。您必須為您欲套用更新後靜態參數資料庫叢集中的每個資料庫執行個體呼叫 [RebootDBInstance (動作)](api-instances.md#RebootDBInstance)。
**請求**
+ **DBClusterParameterGroupName** (在 CLI 中：`--db-cluster-parameter-group-name`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
要重設的資料庫叢集參數群組名稱。
+ **Parameters** (在 CLI 中：`--parameters`) – [參數](#Parameter) 物件的陣列。
資料庫叢集參數群組中的參數名稱清單，會將此清單上的參數重設為其預設值。若將 `ResetAllParameters` 參數設為 `true`，您便無法使用此參數。
+ **ResetAllParameters** (在 CLI 中:`--reset-all-parameters`) – 布林值，類型為：`boolean` (布林值 (true 或 false))。
會在將資料庫叢集參數群組中所有參數重設為其預設值時設為 `true` 的值，否則為 `false`。若有為 `Parameters` 參數指定參數名稱清單，您便無法使用此參數。
**回應**
+ **DBClusterParameterGroupName** – 字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集參數群組的名稱。
約束:
+ 必須為 1 到 255 個字母或數字。
+ 第一個字元必須是字母
+ 不能以連字號結尾或連續包含兩個連字號
**注意**
此值會以小寫字母字串的形式儲存。
**錯誤**
+ [InvalidDBParameterGroupStateFault](api-faults.md#InvalidDBParameterGroupStateFault)
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
## DescribeDBParameters (動作)
此 API 的 AWS CLI 名稱為：`describe-db-parameters`。
傳回特定資料庫參數群組的詳細參數清單。
**請求**
+ **DBParameterGroupName** (在 CLI 中：`--db-parameter-group-name`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
要傳回其詳細資訊的特定資料庫參數群組名稱。
約束:
+ 若有提供，則必須符合現有 DBParameterGroup 的名稱。
+ **Filters** (在 CLI 中：`--filters`) – [篩選條件](api-datatypes.md#Filter) 物件的陣列。
目前不支援此參數。
+ **Marker** (在 CLI 中：`--marker`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
前一個 `DescribeDBParameters` 請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。
+ **MaxRecords** (在 CLI 中：`--max-records`) – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
要在回應中包含的記錄數量上限。若存在的記錄比 `MaxRecords` 值指定的更多，則稱為「標記」的分頁字符會包含在回應中，讓您可以擷取剩餘的結果。
預設：100
限制條件：最小 20，最大 100。
+ **Source** (在 CLI 中：`--source`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
要傳回的參數類型。
預設：傳回所有參數類型。
有效值:`user | system | engine-default`
**回應**
+ **Marker** – 字串，類型為：`string` (UTF-8 編碼的字串)。
前一個請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。
+ **Parameters** – 一個 [參數](#Parameter) 物件陣列。
[Parameter (結構)](#Parameter) 值的清單。
**錯誤**
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
## DescribeDBParameterGroups (動作)
此 API 的 AWS CLI 名稱為：`describe-db-parameter-groups`。
傳回 `DBParameterGroup` 描述的清單。若有指定 `DBParameterGroupName`，則清單只會包含指定資料庫參數群組的描述。
**請求**
+ **DBParameterGroupName** (在 CLI 中：`--db-parameter-group-name`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
要傳回其詳細資訊的特定資料庫參數群組名稱。
約束:
+ 若有提供，則必須符合現有 DBClusterParameterGroup 的名稱。
+ **Filters** (在 CLI 中：`--filters`) – [篩選條件](api-datatypes.md#Filter) 物件的陣列。
目前不支援此參數。
+ **Marker** (在 CLI 中：`--marker`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
前一個 `DescribeDBParameterGroups` 請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。
+ **MaxRecords** (在 CLI 中：`--max-records`) – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
要在回應中包含的記錄數量上限。若存在的記錄比 `MaxRecords` 值指定的更多，則稱為「標記」的分頁字符會包含在回應中，讓您可以擷取剩餘的結果。
預設：100
限制條件：最小 20，最大 100。
**回應**
+ **DBParameterGroups** – 一個 [DBParameterGroup](#DBParameterGroup) 物件陣列。
[DBParameterGroup (結構)](#DBParameterGroup) 執行個體的清單。
+ **Marker** – 字串，類型為：`string` (UTF-8 編碼的字串)。
前一個請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。
**錯誤**
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
## DescribeDBClusterParameters (動作)
此 API 的 AWS CLI 名稱為：`describe-db-cluster-parameters`。
傳回特定資料庫叢集參數群組的詳細參數清單。
**請求**
+ **DBClusterParameterGroupName** (在 CLI 中：`--db-cluster-parameter-group-name`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
要傳回其參數詳細資訊的特定資料庫叢集參數群組名稱。
約束:
+ 若有提供，則必須符合現有 DBClusterParameterGroup 的名稱。
+ **Filters** (在 CLI 中：`--filters`) – [篩選條件](api-datatypes.md#Filter) 物件的陣列。
目前不支援此參數。
+ **Marker** (在 CLI 中：`--marker`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
前一個 `DescribeDBClusterParameters` 請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。
+ **MaxRecords** (在 CLI 中：`--max-records`) – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
要在回應中包含的記錄數量上限。若存在的記錄比 `MaxRecords` 值指定的更多，則稱為「標記」的分頁字符會包含在回應中，讓您可以擷取剩餘的結果。
預設：100
限制條件：最小 20，最大 100。
+ **Source** (在 CLI 中：`--source`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
指出只傳回特定來源參數的值。參數來源可以是 `engine`、`service` 或 `customer`。
**回應**
+ **Marker** – 字串，類型為：`string` (UTF-8 編碼的字串)。
前一個 DescribeDBClusterParameters 請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。
+ **Parameters** – 一個 [參數](#Parameter) 物件陣列。
提供資料庫叢集參數群組的參數清單。
**錯誤**
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
## DescribeDBClusterParameterGroups (動作)
此 API 的 AWS CLI 名稱為：`describe-db-cluster-parameter-groups`。
傳回 `DBClusterParameterGroup` 描述的清單。若有指定 `DBClusterParameterGroupName` 參數，則清單只會包含指定資料庫叢集參數群組的描述。
**請求**
+ **DBClusterParameterGroupName** (在 CLI 中：`--db-cluster-parameter-group-name`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
要傳回其詳細資訊的特定資料庫叢集參數群組名稱。
約束:
+ 若有提供，則必須符合現有 DBClusterParameterGroup 的名稱。
+ **Filters** (在 CLI 中：`--filters`) – [篩選條件](api-datatypes.md#Filter) 物件的陣列。
目前不支援此參數。
+ **Marker** (在 CLI 中：`--marker`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
前一個 `DescribeDBClusterParameterGroups` 請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。
+ **MaxRecords** (在 CLI 中：`--max-records`) – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
要在回應中包含的記錄數量上限。若存在的記錄比 `MaxRecords` 值指定的更多，則稱為「標記」的分頁字符會包含在回應中，讓您可以擷取剩餘的結果。
預設：100
限制條件：最小 20，最大 100。
**回應**
+ **DBClusterParameterGroups** – 一個 [DBClusterParameterGroup](#DBClusterParameterGroup) 物件陣列。
資料庫叢集參數群組的清單。
+ **Marker** – 字串，類型為：`string` (UTF-8 編碼的字串)。
前一個 `DescribeDBClusterParameterGroups` 請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。
**錯誤**
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
## DescribeEngineDefaultParameters (動作)
此 API 的 AWS CLI 名稱為：`describe-engine-default-parameters`。
傳回指定資料庫引擎的預設引擎和系統參數資訊。
**請求**
+ **DBParameterGroupFamily** (在 CLI 中：`--db-parameter-group-family`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫參數群組系列的名稱。
+ **Filters** (在 CLI 中：`--filters`) – [篩選條件](api-datatypes.md#Filter) 物件的陣列。
目前不支援。
+ **Marker** (在 CLI 中：`--marker`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
前一個 `DescribeEngineDefaultParameters` 請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。
+ **MaxRecords** (在 CLI 中：`--max-records`) – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
要在回應中包含的記錄數量上限。若存在的記錄比 `MaxRecords` 值指定的更多，則稱為「標記」的分頁字符會包含在回應中，讓您可以擷取剩餘的結果。
預設：100
限制條件：最小 20，最大 100。
**回應**
包含成功呼叫 [DescribeEngineDefaultParameters (動作)](#DescribeEngineDefaultParameters) 動作的結果。
+ **DBParameterGroupFamily** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定要套用引擎預設參數的資料庫參數群組系列名稱。
+ **Marker** – 字串，類型為：`string` (UTF-8 編碼的字串)。
前一個 EngineDefaults 請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。
+ **Parameters** – 一個 [參數](#Parameter) 物件陣列。
包含引擎預設參數的清單。
## DescribeEngineDefaultClusterParameters (動作)
此 API 的 AWS CLI 名稱為：`describe-engine-default-cluster-parameters`。
傳回叢集資料庫引擎的預設引擎和系統參數資訊。
**請求**
+ **DBParameterGroupFamily** (在 CLI 中：`--db-parameter-group-family`) – *必要：*字串，類型為：`string` (UTF-8 編碼的字串)。
要傳回其引擎參數資訊的資料庫叢集參數群組系列名稱。
+ **Filters** (在 CLI 中：`--filters`) – [篩選條件](api-datatypes.md#Filter) 物件的陣列。
目前不支援此參數。
+ **Marker** (在 CLI 中：`--marker`) – 字串，類型為：`string` (UTF-8 編碼的字串)。
前一個 `DescribeEngineDefaultClusterParameters` 請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。
+ **MaxRecords** (在 CLI 中：`--max-records`) – IntegerOptional，類型為：`integer` (帶正負號的 32 位元整數)。
要在回應中包含的記錄數量上限。若存在的記錄比 `MaxRecords` 值指定的更多，則稱為「標記」的分頁字符會包含在回應中，讓您可以擷取剩餘的結果。
預設：100
限制條件：最小 20，最大 100。
**回應**
包含成功呼叫 [DescribeEngineDefaultParameters (動作)](#DescribeEngineDefaultParameters) 動作的結果。
+ **DBParameterGroupFamily** – 字串，類型為：`string` (UTF-8 編碼的字串)。
指定要套用引擎預設參數的資料庫參數群組系列名稱。
+ **Marker** – 字串，類型為：`string` (UTF-8 編碼的字串)。
前一個 EngineDefaults 請求提供的選用分頁字符。若指定此參數，則回應只會包含超過標記的記錄，直到 `MaxRecords` 指定的值為止。
+ **Parameters** – 一個 [參數](#Parameter) 物件陣列。
包含引擎預設參數的清單。
## *結構：*
## Parameter (結構)
指定參數。
**欄位**
+ **AllowedValues** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指定參數值的有效範圍。
+ **ApplyMethod** - 這是 ApplyMethod，類型為：`string` (UTF-8 編碼字串)。
指出何時套用參數更新。
+ **ApplyType** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指定引擎限定的參數類型。
+ **DataType** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指定參數的有效資料類型。
+ **Description** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
提供參數的描述。
+ **IsModifiable** - 這是布林值，類型為：`boolean` (布林值 (true 或 false))。
指出是 (`true`) 否 (`false`) 可以修改參數。有些參數具有安全或操作上的隱含式，防止他們遭到變更。
+ **MinimumEngineVersion** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
可套用參數的最早引擎版本。
+ **ParameterName** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指定參數的名稱。
+ **ParameterValue** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指定參數的值。
+ **Source** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
指出參數值的來源。
## DBParameterGroup (結構)
包含 Amazon Neptune 資料庫參數群組的詳細資訊。
此資料類型在 [DescribeDBParameterGroups (動作)](#DescribeDBParameterGroups) 動作中會用來作為回應元素。
**欄位**
+ **DBParameterGroupArn** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫參數群組的 Amazon Resource Name (ARN)。
+ **DBParameterGroupFamily** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
提供此資料庫參數群組相容的資料庫參數群組系列名稱。
+ **DBParameterGroupName** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
提供資料庫參數群組的名稱。
+ **Description** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
提供此資料庫參數群組的客戶指定描述。
`DBParameterGroup` 會用來做為以下項目的回應元素：
+ [CopyDBParameterGroup](#CopyDBParameterGroup)
+ [CreateDBParameterGroup](#CreateDBParameterGroup)
## DBClusterParameterGroup (結構)
包含 Amazon Neptune 資料庫叢集參數群組的詳細資訊。
此資料類型在 [DescribeDBClusterParameterGroups (動作)](#DescribeDBClusterParameterGroups) 動作中會用來作為回應元素。
**欄位**
+ **DBClusterParameterGroupArn** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫叢集參數群組的 Amazon Resource Name (ARN)。
+ **DBClusterParameterGroupName** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
提供資料庫叢集參數群組的名稱。
+ **DBParameterGroupFamily** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
提供此資料庫叢集參數群組相容的資料庫參數群組系列名稱。
+ **Description** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
提供該客戶指定之此資料庫叢集參數群組的描述。
`DBClusterParameterGroup` 會用來做為以下項目的回應元素：
+ [CopyDBClusterParameterGroup](#CopyDBClusterParameterGroup)
+ [CreateDBClusterParameterGroup](#CreateDBClusterParameterGroup)
## DBParameterGroupStatus (結構)
資料庫參數群組的狀態。
此資料類型在下列動作中會用來做為回應元素：
+ [CreateDBInstance (動作)](api-instances.md#CreateDBInstance)
+ [DeleteDBInstance (動作)](api-instances.md#DeleteDBInstance)
+ [ModifyDBInstance (動作)](api-instances.md#ModifyDBInstance)
+ [RebootDBInstance (動作)](api-instances.md#RebootDBInstance)
**欄位**
+ **DBParameterGroupName** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
資料庫參數群組的名稱。
+ **ParameterApplyStatus** - 這是字串，類型為：`string` (UTF-8 編碼的字串)。
參數更新的狀態。