翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# 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 です｡ 最大長は 2,048 です。  
パターン: `[\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 です｡ 最大長は 2,048 です。  
パターン: `[\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。  
Type: 文字列

 ** [Template](#API_DescribeTemplate_ResponseSyntax) **   <a name="QS-DescribeTemplate-response-Template"></a>
記述するオブジェクトのテンプレート構造。  
型: [Template](API_Template.md) オブジェクト

## エラー
<a name="API_DescribeTemplate_Errors"></a>

すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。

 ** AccessDeniedException **   
このアイテムへのアクセス権限がありません。提供された認証情報を検証できませんでした。リクエストを実行する権限がない可能性があります。あなたのアカウントがAmazonの使用を許可されていることを確認してください QuickSight 正しいアクセス許可があること、正しいアクセスキーを使っていることを確認してください。  
HTTP ステータスコード: 401

 ** ConflictException **   
リソースを更新または削除すると、一貫性のない状態が発生する可能性があります。  
HTTP ステータスコード: 409

 ** InternalFailureException **   
内部エラーが発生しました。  
HTTP ステータスコード: 500

 ** InvalidParameterValueException **   
1 つ以上のパラメータに無効な値があります。  
HTTP ステータスコード: 400

 ** ResourceExistsException **   
指定されたリソースは既に存在します。  
HTTP ステータスコード: 409

 ** ResourceNotFoundException **   
1 つ以上のリソースが見つかりません。  
HTTP ステータスコード: 404

 ** ThrottlingException **   
アクセスが調整済みです。  
HTTP ステータスコード: 429

 ** UnsupportedUserEditionException **   
このエラーは Amazon でオペレーションを呼び出していることを示します。 QuickSightエディションにその操作のサポートが含まれていないサブスクリプション。アマゾンアマゾン QuickSight Standard Enterprise Edition があります。すべてのオペレーションと機能がすべてのエディションで利用できるわけではありません。​  
HTTP ステータスコード: 403

## 以下の資料も参照してください。
<a name="API_DescribeTemplate_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/quicksight-2018-04-01/DescribeTemplate) 
+  [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/quicksight-2018-04-01/DescribeTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/quicksight-2018-04-01/DescribeTemplate) 
+  [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/quicksight-2018-04-01/DescribeTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/quicksight-2018-04-01/DescribeTemplate) 
+  [AWS向け SDK JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/quicksight-2018-04-01/DescribeTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/quicksight-2018-04-01/DescribeTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/quicksight-2018-04-01/DescribeTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/quicksight-2018-04-01/DescribeTemplate)