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

# DescribeTemplate
<a name="API_DescribeTemplate"></a>

描述範本的中繼資料。

## 請求語法
<a name="API_DescribeTemplate_RequestSyntax"></a>

```
GET /accounts/AwsAccountId/templates/TemplateId?alias-name=AliasName&version-number=VersionNumber HTTP/1.1
```

## URI 請求參數
<a name="API_DescribeTemplate_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [AliasName](#API_DescribeTemplate_RequestSyntax) **   <a name="QS-DescribeTemplate-request-AliasName"></a>
您要描述範本的別名。如果您命名特定別名，則會描述別名將指向的版本。您可以通過提供關鍵字來指定範本的最新版本`$LATEST`中的`AliasName`參數。關鍵字`$PUBLISHED`不適用於範本。  
長度限制：長度下限為 1。長度上限為 2048。  
模式：`[\w\-]+|(\$LATEST)|(\$PUBLISHED)`

 ** [AwsAccountId](#API_DescribeTemplate_RequestSyntax) **   <a name="QS-DescribeTemplate-request-AwsAccountId"></a>
的 IDAWS包含您所描述範本的帳戶。  
長度限制：固定長度為 12。  
模式：`^[0-9]{12}$`  
必要：是

 ** [TemplateId](#API_DescribeTemplate_RequestSyntax) **   <a name="QS-DescribeTemplate-request-TemplateId"></a>
範本的 ID。  
長度限制：長度下限為 1。長度上限為 2048。  
模式：`[\w\-]+`  
必要：是

 ** [VersionNumber](#API_DescribeTemplate_RequestSyntax) **   <a name="QS-DescribeTemplate-request-VersionNumber"></a>
(選用) 要描述的版本號碼。如果`VersionNumber`未提供參數值，描述範本的最新版本。  
有效範圍：最小值為 1。

## 請求主體
<a name="API_DescribeTemplate_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_DescribeTemplate_ResponseSyntax"></a>

```
HTTP/1.1 Status
Content-type: application/json

{
   "RequestId": "string",
   "Template": { 
      "Arn": "string",
      "CreatedTime": number,
      "LastUpdatedTime": number,
      "Name": "string",
      "TemplateId": "string",
      "Version": { 
         "CreatedTime": number,
         "DataSetConfigurations": [ 
            { 
               "ColumnGroupSchemaList": [ 
                  { 
                     "ColumnGroupColumnSchemaList": [ 
                        { 
                           "Name": "string"
                        }
                     ],
                     "Name": "string"
                  }
               ],
               "DataSetSchema": { 
                  "ColumnSchemaList": [ 
                     { 
                        "DataType": "string",
                        "GeographicRole": "string",
                        "Name": "string"
                     }
                  ]
               },
               "Placeholder": "string"
            }
         ],
         "Description": "string",
         "Errors": [ 
            { 
               "Message": "string",
               "Type": "string"
            }
         ],
         "Sheets": [ 
            { 
               "Name": "string",
               "SheetId": "string"
            }
         ],
         "SourceEntityArn": "string",
         "Status": "string",
         "ThemeArn": "string",
         "VersionNumber": number
      }
   }
}
```

## 回應元素
<a name="API_DescribeTemplate_ResponseElements"></a>

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

 ** [Status](#API_DescribeTemplate_ResponseSyntax) **   <a name="QS-DescribeTemplate-response-Status"></a>
請求的 HTTP 狀態。

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

 ** [RequestId](#API_DescribeTemplate_ResponseSyntax) **   <a name="QS-DescribeTemplate-response-RequestId"></a>
所以此AWS此操作的請求 ID。  
類型：字串

 ** [Template](#API_DescribeTemplate_ResponseSyntax) **   <a name="QS-DescribeTemplate-response-Template"></a>
您要描述之物件的範本結構。  
類型：[Template](API_Template.md) 物件

## 錯誤
<a name="API_DescribeTemplate_Errors"></a>

如需所有動作常見的錯誤相關資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** AccessDeniedException **   
您無法存取此物品。提供的登入資料無法驗證。您可能無法取得授權以執行請求。確保您的帳戶已獲授權使用亞馬遜 QuickSight 服務，您的政策有正確許可權，以及您正在使用正確的存取金鑰。  
HTTP 狀態碼：401

 ** ConflictException **   
更新或刪除資源可能會導致不一致的狀態。  
HTTP 狀態碼：409

 ** InternalFailureException **   
發生內部故障。  
HTTP 狀態碼：500

 ** InvalidParameterValueException **   
一或多個參數具有無效的值。  
HTTP 狀態碼：400

 ** ResourceExistsException **   
指定的資源已存在。  
HTTP 狀態碼：409

 ** ResourceNotFoundException **   
無法找到一個或多個資源。  
HTTP 狀態碼：404

 ** ThrottlingException **   
存取已調節。  
HTTP 狀態碼：429

 ** UnsupportedUserEditionException **   
此錯誤表示您正在呼叫 Amazon 上的操作 QuickSight訂閱版本不包括對該操作的支持。amazon QuickSight 目前包含 Standard 標準版和 Enterprise Edition (標準版 不是每個版本都會提供所有操作和功能。  
HTTP 狀態碼：403

## 另請參閱
<a name="API_DescribeTemplate_SeeAlso"></a>

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [AWS 命令列界面](https://docs.aws.amazon.com/goto/aws-cli/quicksight-2018-04-01/DescribeTemplate) 
+  [適用於 .NET 的 AWS 開發套件](https://docs.aws.amazon.com/goto/DotNetSDKV3/quicksight-2018-04-01/DescribeTemplate) 
+  [適用於 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/quicksight-2018-04-01/DescribeTemplate) 
+  [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/quicksight-2018-04-01/DescribeTemplate) 
+  [適用於 Java 的 AWS 開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/quicksight-2018-04-01/DescribeTemplate) 
+  [AWS適用於的套件 JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/quicksight-2018-04-01/DescribeTemplate) 
+  [適用於 PHP V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/quicksight-2018-04-01/DescribeTemplate) 
+  [適用於 Python 的 AWS SDK](https://docs.aws.amazon.com/goto/boto3/quicksight-2018-04-01/DescribeTemplate) 
+  [適用於 Ruby 的 AWS 開發套件第 3 版](https://docs.aws.amazon.com/goto/SdkForRubyV3/quicksight-2018-04-01/DescribeTemplate)