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

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

CreateTemplate

從現有的 Amazon 建立範本 QuickSight 分析或模板。您可以使用產生的範本來建立儀表板。

一個範本是亞馬遜的一個實體 QuickSight 它封裝了建立分析所需的中繼資料，您可以用來建立儀表板。範本透過使用預留位置來取代與分析關聯的資料集來新增抽象層。您可以使用範本建立儀表板，方法是使用與建立來源分析和範本相同結構描述的資料集取代資料集預留位置。

請求語法

POST /accounts/AwsAccountId/templates/TemplateId HTTP/1.1
Content-type: application/json

{
   "Name": "string",
   "Permissions": [ 
      { 
         "Actions": [ "string" ],
         "Principal": "string"
      }
   ],
   "SourceEntity": { 
      "SourceAnalysis": { 
         "Arn": "string",
         "DataSetReferences": [ 
            { 
               "DataSetArn": "string",
               "DataSetPlaceholder": "string"
            }
         ]
      },
      "SourceTemplate": { 
         "Arn": "string"
      }
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "VersionDescription": "string"
}

URI 請求參數

請求會使用下列 URI 參數。

AwsAccountId

的 IDAWS群組所在的帳戶。您使用的 IDAWS帳戶，其包含您的 Amazon QuickSight 帳戶。

長度限：固定長度：

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

必要：是

TemplateId

您希望建立範本的 ID。這個模板是每獨一無二的AWS 區域；在每AWS帳戶。

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

模式：[\w\-]+

必要：是

請求主體

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

SourceEntity

當您建立範本時，您用來作為來源的實體。InSourceEntity中，您可以指定要用作來源的物件類型：SourceTemplate對於模板或SourceAnalysis以進行分析。這兩個都需要 Amazon Resource Name (ARN)。適用於SourceTemplate，請指定來源範本的 ARN。適用於SourceAnalysis，請指定來源分析的 ARN。所以此SourceTemplateARN 可以包含任何AWS帳戶和任何亞馬遜 QuickSight-支援AWS 區域。

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

類型：TemplateSourceEntity 物件

必要：是

Name

範本的顯示名稱。

類型：字串

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

必要：否

Permissions

要在範本上設定的資源權限清單。

類型：的陣列ResourcePermission對象

陣列成員：項目數下限為 1。項目數上限為 64。

必要：否

Tags

包含資源標籤或指定給資源的標籤的鍵值配對的對映。

類型：的陣列Tag對象

陣列成員：項目數下限為 1。項目數上限為 200

必要：否

VersionDescription

目前所建立範本版本的描述。此 API 操作建立範本的第一個版本。每次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

範本的 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，包括第一個版本的版本資訊。

類型：字串

錯誤

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

AccessDeniedException

您無法存取。提供的登入資料無法驗證。您可能無法取得授權以執行請求。確保您的帳戶被授權使用亞馬遜 QuickSight 服務，您的政策有正確許可，以及您使用正確的存取金鑰。

HTTP 狀態碼：401

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 目前包含 Standard Edition (企業版)。不是每個版本都會提供所有操作和功能。

HTTP 狀態碼：403

另請參閱

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