UpdateTemplate - Amazon QuickSight

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

UpdateTemplate

从现有的 Amazon 更新模板 QuickSight 分析或其他模板。

请求语法

PUT /accounts/AwsAccountId/templates/TemplateId HTTP/1.1 Content-type: application/json { "Name": "string", "SourceEntity": { "SourceAnalysis": { "Arn": "string", "DataSetReferences": [ { "DataSetArn": "string", "DataSetPlaceholder": "string" } ] }, "SourceTemplate": { "Arn": "string" } }, "VersionDescription": "string" }

URI 请求参数

请求使用以下 URI 参数。

AwsAccountId

的 IDAWS包含您要更新的模板的帐户。

长度限制:12 的固定长度。

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

必需:是

TemplateId

模板的 ID。

长度限制:最小长度为 1。长度上限为 2048。

模式:[\w\-]+

必需:是

请求正文

请求接受采用 JSON 格式的以下数据。

SourceEntity

更新模板时用作源的实体。在 SourceEntity 中,指定用作源的对象类型:SourceTemplate 用于模板或 SourceAnalysis 用于分析。两者都需要 Amazon 资源名称(ARN)。对于 SourceTemplate,指定源模板的 ARN。对于 SourceAnalysis,指定源分析的 ARN。这些区域有:SourceTemplateARN 可以包含任何AWS账户和任何亚马逊 QuickSight-支持AWS 区域;。

使用 SourceTemplateSourceAnalysis 中的 DataSetReferences 实体列出原文中所列占位符的替换数据集。每个数据集中的架构必须与其占位符匹配。

类型:TemplateSourceEntity 对象

必需:是

Name

模板名称。

类型: 字符串

长度限制:最小长度为 1。长度上限为 2048。

必需:否

VersionDescription

正在更新的当前模板版本的描述。每次你打电话UpdateTemplate,则创建模板的新版本。模板的每个版本都在 VersionDescription 字段中维护版本的描述。

类型: 字符串

长度限制:最小长度为 1。长度上限为 512。

必需:否

响应语法

HTTP/1.1 Status Content-type: application/json { "Arn": "string", "CreationStatus": "string", "RequestId": "string", "TemplateId": "string", "VersionArn": "string" }

响应元素

如果此操作成功,则该服务将会发送回 HTTP 响应。

Status

请求的 HTTP 状态。

服务以 JSON 格式返回的以下数据。

Arn

模板的 Amazon 资源名称 (ARN)

类型: 字符串

CreationStatus

模板的创建状态。

类型: 字符串

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

RequestId

这些区域有:AWS用于此操作的请求 ID。

类型: 字符串

TemplateId

模板的 ID。

类型: 字符串

长度限制:最小长度为 1。长度上限为 2048。

模式:[\w\-]+

VersionArn

模板的 ARN,包括第一个版本的版本信息。

类型: 字符串

错误

有关所有操作常见错误的信息,请参阅常见错误.

ConflictException

更新或删除资源可能会导致状态不一致。

HTTP 状态代码:409

InternalFailureException

出现内部故障。

HTTP 状态代码:500

InvalidParameterValueException

一个或多个参数的值无效。

HTTP 状态代码:400

LimitExceededException

超出限制。

HTTP 状态代码:409

ResourceExistsException

已存在指定的资源。

HTTP 状态代码:409

ResourceNotFoundException

无法找到一个或多个资源。

HTTP 状态代码:404

ThrottlingException

访问受限。

HTTP 状态代码:429

UnsupportedUserEditionException

此错误指示您正在 Amazon 上调用某个操作 QuickSight该版本不支持该操作的订阅。亚马逊Amazon QuickSight 当前具有标准版和企业版。每个版本中并未提供所有操作和功能。

HTTP 状态代码:403

另请参阅

有关在特定语言的 AWS 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: