

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

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

Décrit les métadonnées d'un modèle.

## Syntaxe de la demande
<a name="API_DescribeTemplate_RequestSyntax"></a>

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

## Paramètres de demande URI
<a name="API_DescribeTemplate_RequestParameters"></a>

La demande utilise les paramètres URI suivants.

 ** [AliasName](#API_DescribeTemplate_RequestSyntax) **   <a name="QS-DescribeTemplate-request-AliasName"></a>
Alias du modèle que vous voulez décrire. Si vous nommez un alias spécifique, vous décrivez la version vers laquelle pointe l'alias. Vous pouvez spécifier la dernière version du modèle en fournissant le mot-clé`$LATEST`dans le`AliasName`  Paramètre . Mot-clé`$PUBLISHED`ne s'applique pas aux modèles.  
Contraintes de longueur : Longueur minimale de 1. Longueur maximale de 2048.  
Modèle : `[\w\-]+|(\$LATEST)|(\$PUBLISHED)` 

 ** [AwsAccountId](#API_DescribeTemplate_RequestSyntax) **   <a name="QS-DescribeTemplate-request-AwsAccountId"></a>
ID duAWSqui contient le modèle que vous décrivez.  
Contraintes de longueur : Longueur fixe de 12.  
Modèle : `^[0-9]{12}$`   
Obligatoire : Oui

 ** [TemplateId](#API_DescribeTemplate_RequestSyntax) **   <a name="QS-DescribeTemplate-request-TemplateId"></a>
ID du modèle.  
Contraintes de longueur : Longueur minimale de 1. Longueur maximale de 2048.  
Modèle : `[\w\-]+`   
Obligatoire : Oui

 ** [VersionNumber](#API_DescribeTemplate_RequestSyntax) **   <a name="QS-DescribeTemplate-request-VersionNumber"></a>
(Facultatif) Nombre de version à décrire. Si un`VersionNumber`La valeur du paramètre n'est pas fournie, la dernière version du modèle est décrite.  
Plage valide : Valeur minimale est 1.

## Corps de la requête
<a name="API_DescribeTemplate_RequestBody"></a>

La demande n'a pas de corps de requête.

## Syntaxe de la réponse
<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
      }
   }
}
```

## Eléments de réponse
<a name="API_DescribeTemplate_ResponseElements"></a>

Si l'action aboutit, le service renvoie la réponse HTTP suivante.

 ** [Status](#API_DescribeTemplate_ResponseSyntax) **   <a name="QS-DescribeTemplate-response-Status"></a>
Le statut HTTP de la requête.

Les données suivantes sont renvoyées au format JSON par le service.

 ** [RequestId](#API_DescribeTemplate_ResponseSyntax) **   <a name="QS-DescribeTemplate-response-RequestId"></a>
LeAWSID de demande pour cette opération.  
Type : Chaîne

 ** [Template](#API_DescribeTemplate_ResponseSyntax) **   <a name="QS-DescribeTemplate-response-Template"></a>
Structure du modèle de l'objet que vous voulez décrire.  
Type : objet [Template](API_Template.md)

## Erreurs
<a name="API_DescribeTemplate_Errors"></a>

Pour plus d'informations sur les erreurs communes à toutes les actions, consultez[Erreurs courantes](CommonErrors.md).

 ** AccessDeniedException **   
Vous n'avez pas accès à cet élément. Les informations d'identification fournies n'ont pas pu être validées. Il est possible que vous ne soyez pas autorisé à effectuer la demande. Assurez-vous que votre compte est autorisé à utiliser Amazon QuickSight , que vos stratégies ont les autorisations appropriées et que vous utilisez les bonnes clés d'accès.  
HTTP Status Code : 401

 ** ConflictException **   
La mise à jour ou la suppression d'une ressource peut entraîner un état incohérent.  
HTTP Status Code : 409

 ** InternalFailureException **   
Une défaillance interne s'est produite.  
HTTP Status Code : 500

 ** InvalidParameterValueException **   
Un ou plusieurs paramètres ont une valeur non valide.  
HTTP Status Code : 400

 ** ResourceExistsException **   
La ressource spécifiée existe déjà.   
HTTP Status Code : 409

 ** ResourceNotFoundException **   
Une ou plusieurs ressources ne peuvent pas être trouvées.  
HTTP Status Code : 404

 ** ThrottlingException **   
L'accès est limité.  
HTTP Status Code : 429

 ** UnsupportedUserEditionException **   
Cette erreur indique que vous appelez une opération sur Amazon QuickSightabonnement dont l'édition n'inclut pas la prise en charge de cette opération. Amazon Amazon Amazon Amazon QuickSight Les éditions actuellement disponibles pour Amazon Edition. Toutes les opérations et fonctionnalités ne sont pas disponibles dans chaque édition.  
HTTP Status Code : 403

## Voir aussi
<a name="API_DescribeTemplate_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des kits SDK AWS spécifiques au langage, consultez les ressources suivantes :
+  [Interface de ligne de commande AWS](https://docs.aws.amazon.com/goto/aws-cli/quicksight-2018-04-01/DescribeTemplate) 
+  [AWS SDK pour .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/quicksight-2018-04-01/DescribeTemplate) 
+  [Kit AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/quicksight-2018-04-01/DescribeTemplate) 
+  [Kit AWS SDK pour 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) 
+  [AWSKits SDK pour JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/quicksight-2018-04-01/DescribeTemplate) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/quicksight-2018-04-01/DescribeTemplate) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/quicksight-2018-04-01/DescribeTemplate) 
+  [Kit SDK AWS pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/quicksight-2018-04-01/DescribeTemplate) 