本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。 # UpdateDashboard 更新控制面板AWSaccount. **注意** 更新仪表板会创建新的仪表板版本，但不会立即发布新版本。您可以通过以下方式更新控制面板的已发布版本` [UpdateDashboardPublishedVersion](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateDashboardPublishedVersion.html) `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](#API_UpdateDashboard_RequestSyntax) ** 的 IDAWS包含您要更新的仪表板的帐户。长度限制：固定长度为 12。模式：`^[0-9]{12}$` 必需：是 ** [DashboardId](#API_UpdateDashboard_RequestSyntax) ** 控制面板 ID。长度限制：最小长度为 1。长度上限为 2048。模式：`[\w\-]+` 必需：是 ## 请求正文请求接受采用 JSON 格式的以下数据。 ** [Name](#API_UpdateDashboard_RequestSyntax) ** 控制面板的显示名称。类型: 字符串长度限制：最小长度为 1。长度上限为 2048。必需：是 ** [SourceEntity](#API_UpdateDashboard_RequestSyntax) ** 更新仪表板时用作源的实体。In`SourceEntity`，则指定要用作源的对象的类型。您只能从模板更新仪表板，因此您可以使用`SourceTemplate`实体。如果需要从分析更新仪表板，请先使用` [CreateTemplate](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html) `API 操作。对于 `SourceTemplate`，指定源模板的 Amazon 资源名称（ARN）。这些区域有：`SourceTemplate`ARN 可以包含任何AWS账户和任何亚马逊 QuickSight-支持AWS 区域. 使用 `SourceTemplate` 中的 `DataSetReferences` 实体列出原文中所列占位符的替换数据集。每个数据集中的架构必须与其占位符匹配。类型：[DashboardSourceEntity](API_DashboardSourceEntity.md) 对象必需：是 ** [DashboardPublishOptions](#API_UpdateDashboard_RequestSyntax) ** 创建时发布控制面板的选项： + `AvailabilityStatus` 的 `AdHocFilteringOption` - 此状态可以是 `ENABLED` 或 `DISABLED`。当设置为`DISABLED`，Amaon on QuickSight 禁用已发布仪表板上的左侧筛选器窗格，该窗格可用于临时（一次性）筛选。默认情况下，此选项为 `ENABLED`。 + `AvailabilityStatus` 的 `ExportToCSVOption` - 此状态可以是 `ENABLED` 或 `DISABLED`。此项设置为 `DISABLED` 时，将数据导出为 .CSV 格式的可视选项未启用。默认情况下，此选项为 `ENABLED`。 + `VisibilityState` 的 `SheetControlsOption` - 此可见性状态可以是 `COLLAPSED` 或 `EXPANDED`。默认情况下，此选项为 `COLLAPSED`。类型：[DashboardPublishOptions](API_DashboardPublishOptions.md) 对象必需：否 ** [Parameters](#API_UpdateDashboard_RequestSyntax) ** 包含仪表板参数的结构。这些是仪表板的参数覆盖。控制面板可以具有任何类型的参数，并且某些参数可接受多个值。类型：[Parameters](API_Parameters.md) 对象必需：否 ** [ThemeArn](#API_UpdateDashboard_RequestSyntax) ** 用于此控制面板的主题的 Amazon 资源名称（ARN）。如果您为此字段添加值，它会覆盖最初与实体关联的值。主题 ARN 必须存在于创建控制面板的同一 AWS 账户中。类型: 字符串必需：否 ** [VersionDescription](#API_UpdateDashboard_RequestSyntax) ** 所创建控制面板的第一个版本的描述。类型: 字符串长度限制：最小长度为 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](#API_UpdateDashboard_ResponseSyntax) ** 资源的 Amazon 资源名称（ARN）。类型: 字符串 ** [CreationStatus](#API_UpdateDashboard_ResponseSyntax) ** 请求的创建状态。类型: 字符串有效值:` CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED` ** [DashboardId](#API_UpdateDashboard_ResponseSyntax) ** 控制面板 ID。类型: 字符串长度限制：最小长度为 1。长度上限为 2048。模式：`[\w\-]+` ** [RequestId](#API_UpdateDashboard_ResponseSyntax) ** 这些区域有：AWS对于是必需的。类型: 字符串 ** [Status](#API_UpdateDashboard_ResponseSyntax) ** 请求的 HTTP 状态。类型: 整数 ** [VersionArn](#API_UpdateDashboard_ResponseSyntax) ** 控制面板 ARN，包括版本代码。类型: 字符串 ## 错误有关所有操作常见错误的信息，请参阅[常见错误](CommonErrors.md). ** ConflictException ** 更新或删除资源可能会导致状态不一致。 HTTP 状态代码：409 ** InternalFailureException ** 出现内部故障。 HTTP 状态代码：500 ** InvalidParameterValueException ** 一个或多个参数的值无效。 HTTP 状态代码：400 ** LimitExceededException ** 超出限制。 HTTP 状态代码：409 ** ResourceNotFoundException ** 无法找到一个或多个资源。 HTTP 状态代码：404 ** ThrottlingException ** 访问受限。 HTTP 状态代码：429 ** UnsupportedUserEditionException ** 此错误指示您正在 Amazon 上调用某个操作 QuickSight该版本不支持该操作的订阅。Amazon on QuickSight 当前具有标准版和企业版。每个版本中并未提供所有操作和功能。 HTTP 状态代码：403 ## 另请参阅有关在特定语言的 AWS 软件开发工具包中使用此 API 的更多信息，请参阅以下内容： + [AWS 命令行界面](https://docs.aws.amazon.com/goto/aws-cli/quicksight-2018-04-01/UpdateDashboard) + [适用于 .NET 的 AWS SDK](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 SDK](https://docs.aws.amazon.com/goto/SdkForGoV1/quicksight-2018-04-01/UpdateDashboard) + [适用于 Java V2 的 AWS SDK](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 V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/quicksight-2018-04-01/UpdateDashboard)