

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

# UpdateDashboard
<a name="API_UpdateDashboard"></a>

更新儀表板AWS帳戶。

**注意**  
更新儀表板會建立新的儀表板版本，但不會立即發佈新版本。您可以使用以下方式更新儀表板的發佈版本。` [UpdateDashboardPublishedVersion](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateDashboardPublishedVersion.html) `API 操作。

## 請求語法
<a name="API_UpdateDashboard_RequestSyntax"></a>

```
PUT /accounts/AwsAccountId/dashboards/DashboardId HTTP/1.1
Content-type: application/json

{
   "DashboardPublishOptions": { 
      "AdHocFilteringOption": { 
         "AvailabilityStatus": "string"
      },
      "ExportToCSVOption": { 
         "AvailabilityStatus": "string"
      },
      "SheetControlsOption": { 
         "VisibilityState": "string"
      }
   },
   "Name": "string",
   "Parameters": { 
      "DateTimeParameters": [ 
         { 
            "Name": "string",
            "Values": [ number ]
         }
      ],
      "DecimalParameters": [ 
         { 
            "Name": "string",
            "Values": [ number ]
         }
      ],
      "IntegerParameters": [ 
         { 
            "Name": "string",
            "Values": [ number ]
         }
      ],
      "StringParameters": [ 
         { 
            "Name": "string",
            "Values": [ "string" ]
         }
      ]
   },
   "SourceEntity": { 
      "SourceTemplate": { 
         "Arn": "string",
         "DataSetReferences": [ 
            { 
               "DataSetArn": "string",
               "DataSetPlaceholder": "string"
            }
         ]
      }
   },
   "ThemeArn": "string",
   "VersionDescription": "string"
}
```

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

請求會使用下列 URI 參數。

 ** [AwsAccountId](#API_UpdateDashboard_RequestSyntax) **   <a name="QS-UpdateDashboard-request-AwsAccountId"></a>
的 IDAWS包含您正在更新的儀表板的帳戶。  
長度限制：12 的固定長度。  
模式：`^[0-9]{12}$`  
必要：是

 ** [DashboardId](#API_UpdateDashboard_RequestSyntax) **   <a name="QS-UpdateDashboard-request-DashboardId"></a>
儀表板的 ID。  
長度限制：長度下限為 1。長度上限為 2048。  
模式：`[\w\-]+`  
必要：是

## 請求主體
<a name="API_UpdateDashboard_RequestBody"></a>

請求接受採用 JSON 格式的下列資料。

 ** [Name](#API_UpdateDashboard_RequestSyntax) **   <a name="QS-UpdateDashboard-request-Name"></a>
儀表板的顯示名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 2048。  
必要：是

 ** [SourceEntity](#API_UpdateDashboard_RequestSyntax) **   <a name="QS-UpdateDashboard-request-SourceEntity"></a>
更新儀表板時用作來源的實體。In`SourceEntity`中，您可以指定要用作來源的物件類型。您只能從範本更新儀表板，因此您可以使用`SourceTemplate`實體。如果您需要從分析更新儀表板，請先使用` [CreateTemplate](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html) `API 操作。適用於`SourceTemplate`，指定來源範本的 Amazon Resource Name (ARN)。所以此`SourceTemplate`ARN 可以包含任何AWS帳戶和任何亞馬遜 QuickSight-支援。AWS 區域。  
使用`DataSetReferences`實體內`SourceTemplate`以列出原始資料集中列出的預留位置的取代資料集。每個資料集中的結構定義都必須與其預留位置相符。  
類型：[DashboardSourceEntity](API_DashboardSourceEntity.md) 物件  
必要：是

 ** [DashboardPublishOptions](#API_UpdateDashboard_RequestSyntax) **   <a name="QS-UpdateDashboard-request-DashboardPublishOptions"></a>
建立管控面板時用於發佈管控面板的選項：  
+  `AvailabilityStatus`為了`AdHocFilteringOption`-此狀態可以是任一項`ENABLED`或者`DISABLED`。當此值設為`DISABLED`，Amazon QuickSight 停用已發佈儀表板上的左側篩選器窗格，此窗格可用於臨機操作 (一次性) 篩選。此選項為`ENABLED`預設情況下。
+  `AvailabilityStatus`為了`ExportToCSVOption`-此狀態可以是任一項`ENABLED`或者`DISABLED`。將此選項設定為時，不會啟用將資料匯出為 .CSV 格式的視覺化選項`DISABLED`。此選項為`ENABLED`預設情況下。
+  `VisibilityState`為了`SheetControlsOption`-此可見性狀態可以是`COLLAPSED`或者`EXPANDED`。此選項為`COLLAPSED`預設情況下。
類型：[DashboardPublishOptions](API_DashboardPublishOptions.md) 物件  
必要：否

 ** [Parameters](#API_UpdateDashboard_RequestSyntax) **   <a name="QS-UpdateDashboard-request-Parameters"></a>
包含圖標板參數的結構。這些是圖標板的參數取代。儀表板可以有任何類型的參數，而某些參數可能接受多個值。  
類型：[Parameters](API_Parameters.md) 物件  
必要：否

 ** [ThemeArn](#API_UpdateDashboard_RequestSyntax) **   <a name="QS-UpdateDashboard-request-ThemeArn"></a>
此儀表板使用的主題的 Amazon Resource Name (ARN)。如果您在此欄位加入值，則會覆寫與實體相關聯的值。主題 ARN 必須存在於相同的AWS您在其中創建儀表板的帳戶。  
類型：字串  
必要：否

 ** [VersionDescription](#API_UpdateDashboard_RequestSyntax) **   <a name="QS-UpdateDashboard-request-VersionDescription"></a>
要建立之儀表板第一個版本的描述。  
類型：字串  
長度限制：長度下限為 1。長度上限為 512。  
必要：否

## 回應語法
<a name="API_UpdateDashboard_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "CreationStatus": "string",
   "DashboardId": "string",
   "RequestId": "string",
   "Status": number,
   "VersionArn": "string"
}
```

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

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [Arn](#API_UpdateDashboard_ResponseSyntax) **   <a name="QS-UpdateDashboard-response-Arn"></a>
資源的 Amazon Resource Name (ARN)。  
類型：字串

 ** [CreationStatus](#API_UpdateDashboard_ResponseSyntax) **   <a name="QS-UpdateDashboard-response-CreationStatus"></a>
請求的建立狀態。  
類型：字串  
有效值：` CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED`

 ** [DashboardId](#API_UpdateDashboard_ResponseSyntax) **   <a name="QS-UpdateDashboard-response-DashboardId"></a>
儀表板的 ID。  
類型：字串  
長度限制：長度下限為 1。長度上限為 2048。  
模式：`[\w\-]+`

 ** [RequestId](#API_UpdateDashboard_ResponseSyntax) **   <a name="QS-UpdateDashboard-response-RequestId"></a>
所以此AWS此操作的請求 ID。  
類型：字串

 ** [Status](#API_UpdateDashboard_ResponseSyntax) **   <a name="QS-UpdateDashboard-response-Status"></a>
請求的 HTTP 狀態。  
類型：整數

 ** [VersionArn](#API_UpdateDashboard_ResponseSyntax) **   <a name="QS-UpdateDashboard-response-VersionArn"></a>
儀表板的 ARN，包括版本號碼。  
類型：字串

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

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

 ** ConflictException **   
更新或刪除資源可能會導致不一致的狀態。  
HTTP 狀態碼：409

 ** InternalFailureException **   
發生內部故障。  
HTTP 狀態碼：500

 ** InvalidParameterValueException **   
一或多個參數的值無效。  
HTTP 狀態碼：400

 ** LimitExceededException **   
已超過上限。  
HTTP 狀態碼：409

 ** ResourceNotFoundException **   
無法找到一個或多個資源。  
HTTP 狀態碼：404

 ** ThrottlingException **   
存取已調節。  
HTTP 狀態碼：429

 ** UnsupportedUserEditionException **   
此錯誤表示您正在呼叫 Amazon 上的操作 QuickSight訂閱版本不包括對該操作的支持。amazon amazon QuickSight 目前包含 Standard Edition (企業版)。不是每個版本都會提供所有操作和功能。  
HTTP 狀態碼：403

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

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [AWS 命令列界面](https://docs.aws.amazon.com/goto/aws-cli/quicksight-2018-04-01/UpdateDashboard) 
+  [適用於 .NET 的 AWS 開發套件](https://docs.aws.amazon.com/goto/DotNetSDKV3/quicksight-2018-04-01/UpdateDashboard) 
+  [適用於 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/quicksight-2018-04-01/UpdateDashboard) 
+  [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/quicksight-2018-04-01/UpdateDashboard) 
+  [適用於 Java 的 AWS 開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/quicksight-2018-04-01/UpdateDashboard) 
+  [AWS適合的開發套 JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/quicksight-2018-04-01/UpdateDashboard) 
+  [適用於 PHP V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/quicksight-2018-04-01/UpdateDashboard) 
+  [適用於 Python 的 AWS SDK](https://docs.aws.amazon.com/goto/boto3/quicksight-2018-04-01/UpdateDashboard) 
+  [適用於 Ruby 的 AWS 開發套件第 3 版](https://docs.aws.amazon.com/goto/SdkForRubyV3/quicksight-2018-04-01/UpdateDashboard) 