UpdateDashboard - Amazon QuickSight
請求語法URI 請求參數請求主體回應語法回應元素錯誤另請參閱

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

UpdateDashboard

更新儀表板AWS帳戶。

注意

更新儀表板會建立新的儀表板版本，但不會立即發佈新版本。您可以使用以下方式更新儀表板的發佈版本。 UpdateDashboardPublishedVersion API 操作。

請求語法

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 請求參數

請求會使用下列 URI 參數。

AwsAccountId

的 IDAWS包含您正在更新的儀表板的帳戶。

長度限制：12 的固定長度。

模式：^[0-9]{12}$

必要：是

DashboardId

儀表板的 ID。

長度限制：長度下限為 1。長度上限為 2048。

模式：[\w\-]+

必要：是

請求主體

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

Name

儀表板的顯示名稱。

類型：字串

長度限制：長度下限為 1。長度上限為 2048。

必要：是

SourceEntity

更新儀表板時用作來源的實體。InSourceEntity中，您可以指定要用作來源的物件類型。您只能從範本更新儀表板，因此您可以使用SourceTemplate實體。如果您需要從分析更新儀表板，請先使用 CreateTemplate API 操作。適用於SourceTemplate，指定來源範本的 Amazon Resource Name (ARN)。所以此SourceTemplateARN 可以包含任何AWS帳戶和任何亞馬遜 QuickSight-支援。AWS 區域。

使用DataSetReferences實體內SourceTemplate以列出原始資料集中列出的預留位置的取代資料集。每個資料集中的結構定義都必須與其預留位置相符。

類型：DashboardSourceEntity 物件

必要：是

DashboardPublishOptions

建立管控面板時用於發佈管控面板的選項：

  • AvailabilityStatus為了AdHocFilteringOption-此狀態可以是任一項ENABLED或者DISABLED。當此值設為DISABLED，Amazon QuickSight 停用已發佈儀表板上的左側篩選器窗格，此窗格可用於臨機操作 (一次性) 篩選。此選項為ENABLED預設情況下。

  • AvailabilityStatus為了ExportToCSVOption-此狀態可以是任一項ENABLED或者DISABLED。將此選項設定為時，不會啟用將資料匯出為 .CSV 格式的視覺化選項DISABLED。此選項為ENABLED預設情況下。

  • VisibilityState為了SheetControlsOption-此可見性狀態可以是COLLAPSED或者EXPANDED。此選項為COLLAPSED預設情況下。

類型：DashboardPublishOptions 物件

必要：否

Parameters

包含圖標板參數的結構。這些是圖標板的參數取代。儀表板可以有任何類型的參數，而某些參數可能接受多個值。

類型：Parameters 物件

必要：否

ThemeArn

此儀表板使用的主題的 Amazon Resource Name (ARN)。如果您在此欄位加入值，則會覆寫與實體相關聯的值。主題 ARN 必須存在於相同的AWS您在其中創建儀表板的帳戶。

類型：字串

必要：否

VersionDescription

要建立之儀表板第一個版本的描述。

類型：字串

長度限制：長度下限為 1。長度上限為 512。

必要：否

回應語法

HTTP/1.1 200
Content-type: application/json

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

回應元素

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

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

Arn

資源的 Amazon Resource Name (ARN)。

類型：字串

CreationStatus

請求的建立狀態。

類型：字串

有效值： CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED

DashboardId

儀表板的 ID。

類型：字串

長度限制：長度下限為 1。長度上限為 2048。

模式：[\w\-]+

RequestId

所以此AWS此操作的請求 ID。

類型：字串

Status

請求的 HTTP 狀態。

類型：整數

VersionArn

儀表板的 ARN，包括版本號碼。

類型：字串

錯誤

如需所有動作常見的錯誤相關資訊，請參閱常見錯誤。

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

另請參閱

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：