本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。 # CreateDashboard 從範本建立儀表板若要先建立範本，請參閱 ` [CreateTemplate](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html) ` API 作業。儀表板是亞馬遜中的一個實體 QuickSight 標識亞馬遜 QuickSight 報告，透過分析建立。您可以分享亞馬遜 QuickSight 儀表板。有了適當的權限，您就可以從儀表板建立排程的電子郵件報告。如果您擁有正確的權限，可以從不同範本中建立儀表板AWS帳戶。 ## 請求語法 ``` POST /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" ] } ] }, "Permissions": [ { "Actions": [ "string" ], "Principal": "string" } ], "SourceEntity": { "SourceTemplate": { "Arn": "string", "DataSetReferences": [ { "DataSetArn": "string", "DataSetPlaceholder": "string" } ] } }, "Tags": [ { "Key": "string", "Value": "string" } ], "ThemeArn": "string", "VersionDescription": "string" } ``` ## URI 請求參數請求會使用下列 URI 參數。 ** [AwsAccountId](#API_CreateDashboard_RequestSyntax) ** 的 IDAWS您要在其中建立儀表板的帳戶。長度限制：固定長度為 12。模式：`^[0-9]{12}$` 必要：是 ** [DashboardId](#API_CreateDashboard_RequestSyntax) ** 儀表板的 ID，也已加入至 IAM 政策。長度限制：長度下限為 1。長度上限為 2048。模式：`[\w\-]+` 必要：是 ## 請求主體請求接受採用 JSON 格式的下列資料。 ** [Name](#API_CreateDashboard_RequestSyntax) ** 儀表板的顯示名稱。類型：字串長度限制：長度下限為 1。長度上限為 2048。必要：是 ** [SourceEntity](#API_CreateDashboard_RequestSyntax) ** 建立儀表板時用作來源的實體。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_CreateDashboard_RequestSyntax) ** 建立管控面板時用於發佈管控面板的選項： + `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_CreateDashboard_RequestSyntax) ** 用於建立管控面板的參數，您要使用它來取代預設設定。儀表板可以有任何類型的參數，而某些參數可能接受多個值。類型：[Parameters](API_Parameters.md) 物件必要：否 ** [Permissions](#API_CreateDashboard_RequestSyntax) ** 包含儀表板權限的結構。您可以使用此結構來授與許可，方法是為每個主體 ARN 提供 IAM 動作資訊清單。若不指定任何權限，請省略權限清單。類型：的陣列[ResourcePermission](API_ResourcePermission.md)對象陣列成員：項目數下限為 1。項目數上限為 64。必要：否 ** [Tags](#API_CreateDashboard_RequestSyntax) ** 包含資源標籤或指派給儀表板的標籤的鍵值對映。類型：的陣列[Tag](API_Tag.md)對象陣列成員：項目數下限為 1。項目數上限為 200。必要：否 ** [ThemeArn](#API_CreateDashboard_RequestSyntax) ** 此儀表板所使用主題的 Amazon Resource Name (ARN)。如果您為此欄位新增值，則會覆寫來源實體中所使用的值。ARN 必須存在於相同AWS您在其中創建儀表板的帳戶。類型：字串必要：否 ** [VersionDescription](#API_CreateDashboard_RequestSyntax) ** 目前建立儀表板第一個版本的描述。類型：字串長度限制：長度下限為 1。長度上限為 512。必要：否 ## 回應語法 ``` HTTP/1.1 Status Content-type: application/json { "Arn": "string", "CreationStatus": "string", "DashboardId": "string", "RequestId": "string", "VersionArn": "string" } ``` ## 回應元素如果動作成功，則服務傳回下列 HTTP 回應。 ** [Status](#API_CreateDashboard_ResponseSyntax) ** 請求的 HTTP 狀態。服務會傳回下列 JSON 格式的資料。 ** [Arn](#API_CreateDashboard_ResponseSyntax) ** 儀表板的 ARN。類型：字串 ** [CreationStatus](#API_CreateDashboard_ResponseSyntax) ** 儀表板建立請求的狀態。類型：字串有效值：` CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED` ** [DashboardId](#API_CreateDashboard_ResponseSyntax) ** 儀表板的 ID。類型：字串長度限制：長度下限為 1。長度上限為 2048。模式：`[\w\-]+` ** [RequestId](#API_CreateDashboard_ResponseSyntax) ** 所以此AWS此操作的請求 ID。類型：字串 ** [VersionArn](#API_CreateDashboard_ResponseSyntax) ** 儀表板的 ARN，包括所建立之第一個版本的版本號碼。類型：字串 ## 錯誤如需所有動作常見的錯誤相關資訊，請參閱[常見錯誤](CommonErrors.md)。 ** ConflictException ** 更新或刪除資源可能會導致不一致的狀態。 HTTP 狀態碼：409 ** InternalFailureException ** 發生內部故障。 HTTP 狀態碼：500 ** InvalidParameterValueException ** 一或多個參數的值無效。 HTTP 狀態碼：400 ** ResourceExistsException ** 指定的資源已存在。 HTTP 狀態碼：409 ** ResourceNotFoundException ** 無法找到一個或多個資源。 HTTP 狀態碼：404 ** ThrottlingException ** 存取已調節。 HTTP 狀態碼：429 ** UnsupportedUserEditionException ** 此錯誤表示您正在呼叫 Amazon 上的操作 QuickSight訂閱版本不包括對該操作的支持。Amazon Amazon QuickSight 目前包含 Standard Edition (企業版)。不是每個版本都會提供所有操作和功能。 HTTP 狀態碼：403 ## 另請參閱如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明： + [AWS 命令列界面](https://docs.aws.amazon.com/goto/aws-cli/quicksight-2018-04-01/CreateDashboard) + [適用於 .NET 的 AWS 開發套件](https://docs.aws.amazon.com/goto/DotNetSDKV3/quicksight-2018-04-01/CreateDashboard) + [適用於 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/quicksight-2018-04-01/CreateDashboard) + [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/quicksight-2018-04-01/CreateDashboard) + [適用於 Java 的 AWS 開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/quicksight-2018-04-01/CreateDashboard) + [AWS適用於的套件 JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/quicksight-2018-04-01/CreateDashboard) + [適用於 PHP V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/quicksight-2018-04-01/CreateDashboard) + [適用於 Python 的 AWS SDK](https://docs.aws.amazon.com/goto/boto3/quicksight-2018-04-01/CreateDashboard) + [適用於 Ruby 的 AWS 開發套件第 3 版](https://docs.aws.amazon.com/goto/SdkForRubyV3/quicksight-2018-04-01/CreateDashboard)