CreateTemplate - Amazon QuickSight
Syntaxe de la demandeParamètres de demande URICorps de la demandeSyntaxe de la réponseEléments de réponseErreursVoir aussi

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.

CreateTemplate

Crée un modèle à partir d'un Amazon existant QuickSight une analyse ou un modèle. Vous pouvez utiliser le modèle résultant pour créer un tableau de bord.

UNmodèleest une entité d'Amazon QuickSight qui encapsule les métadonnées requises pour créer une analyse et que vous pouvez utiliser pour créer un tableau de bord. Un modèle ajoute une couche d'abstraction en utilisant des espaces réservés pour remplacer l'ensemble de données associé à l'analyse. Vous pouvez utiliser des modèles pour créer des tableaux de bord en remplaçant des espaces réservés d'ensemble de données par des ensembles de données qui suivent la même structure que celle utilisée pour créer l'analyse source et le modèle.

Syntaxe de la demande

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"
}

Paramètres de demande URI

La demande utilise les paramètres URI suivants.

AwsAccountId

ID duAWScompte dans lequel se trouve le groupe. Vous utilisez cet ID pourAWScompte qui contient votre Amazon QuickSight .

Contraintes de longueur : Longueur fixe de 12.

Modèle : ^[0-9]{12}$

Obligatoire : Oui

TemplateId

ID du modèle que vous souhaitez créer. Ce modèle est unique parRégion AWS; dans chaqueAWS.

Contraintes de longueur : Longueur minimale de 1. Longueur maximale de 2048.

Modèle : [\w\-]+

Obligatoire : Oui

Corps de la demande

Cette demande accepte les données suivantes au format JSON.

SourceEntity

L'entité que vous utilisez comme source lorsque vous créez le modèle. DansSourceEntity, vous spécifiez le type d'objet que vous utilisez comme source :SourceTemplatepour un modèle ouSourceAnalysispour une analyse. Ces deux éléments ont besoin d'un Amazon Resource Name (ARN). PourSourceTemplate, spécifiez l'ARN du modèle source. PourSourceAnalysis, spécifiez l'ARN de l'analyse de la source. LeSourceTemplateL'ARN peut contenir n'importe quelAWScompte et n'importe quel compte Amazon QuickSight-pris en chargeRégion AWS.

Utilisation de l'DataSetReferencesentité au seinSourceTemplateouSourceAnalysispour répertorier les jeux de données de remplacement pour les espaces réservés répertoriés dans l'original. Le schéma de chaque jeu de données doit correspondre à son espace réservé.

Type : objet TemplateSourceEntity

Obligatoire : Oui

Name

Nom d'affichage du modèle.

Type : Chaîne

Contraintes de longueur : Longueur minimale de 1. Longueur maximale de 2048.

Obligatoire : Non

Permissions

Une liste des autorisations de ressources à définir sur le modèle.

Type : Array deResourcePermissionobjets

Membres du tableau : Nombre minimal de 1 élément. Nombre maximum de 64 éléments.

Obligatoire : Non

Tags

Contient une carte des paires clé-valeur pour la ou les balises de ressource attribuées à la ressource.

Type : Array deTagobjets

Membres du tableau : Nombre minimal de 1 élément. Nombre maximum de 200 éléments.

Obligatoire : Non

VersionDescription

Description de la version actuelle du modèle en cours de création. Cette opération d'API crée la première version du modèle. À chaque foisUpdateTemplateest appelée, une nouvelle version est créée. Chaque version du modèle conserve une description de la version dans leVersionDescription.

Type : Chaîne

Contraintes de longueur : Longueur minimale de 1. Longueur maximale de 512.

Obligatoire : Non

Syntaxe de la réponse

HTTP/1.1 Status
Content-type: application/json

{
   "Arn": "string",
   "CreationStatus": "string",
   "RequestId": "string",
   "TemplateId": "string",
   "VersionArn": "string"
}

Eléments de réponse

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

Status

Le statut HTTP de la requête.

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

Arn

L'ARN du modèle.

Type : Chaîne

CreationStatus

Le statut de création du modèle.

Type : Chaîne

Valeurs valides : CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED

RequestId

LeAWSID de demande pour cette opération.

Type : Chaîne

TemplateId

ID du modèle.

Type : Chaîne

Contraintes de longueur : Longueur minimale de 1. Longueur maximale de 2048.

Modèle : [\w\-]+

VersionArn

L'ARN du modèle, y compris les informations de version de la première version.

Type : Chaîne

Erreurs

Pour plus d'informations sur les erreurs communes à toutes les actions, consultezErreurs courantes.

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 d'état HTTP 401

ConflictException

La mise à jour ou la suppression d'une ressource peut entraîner un état incohérent.

HTTP Status Code d'état HTTP 409

InternalFailureException

Une défaillance interne s'est produite.

HTTP Status Code d'état HTTP 500

InvalidParameterValueException

La valeur d'un ou de plusieurs paramètres n'est pas valide.

HTTP Status Code d'état HTTP 400

LimitExceededException

Une limite est dépassée.

HTTP Status Code d'état HTTP 409

ResourceExistsException

La ressource spécifiée existe déjà.

HTTP Status Code d'état HTTP 409

ResourceNotFoundException

Une ou plusieurs ressources n'ont pas pu être trouvées.

HTTP Status Code d'état HTTP 404

ThrottlingException

L'accès est limité.

HTTP Status Code d'état HTTP 429

UnsupportedUserEditionException

Cette erreur indique que vous appelez une opération portant sur Amazon QuickSightabonnement dont l'édition n'inclut pas la prise en charge de cette opération. Amazon Amazon QuickSight a actuellement les éditions Standard et Enterprise Edition. Toutes les opérations et fonctionnalités ne sont pas disponibles dans chaque édition.

HTTP Status Code d'état HTTP 403

Voir aussi

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 :