UpdateTemplate - 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.

UpdateTemplate

Met à jour un modèle provenant d'Amazon existant QuickSight une analyse ou un autre modèle.

Syntaxe de la demande

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

{
   "Name": "string",
   "SourceEntity": { 
      "SourceAnalysis": { 
         "Arn": "string",
         "DataSetReferences": [ 
            { 
               "DataSetArn": "string",
               "DataSetPlaceholder": "string"
            }
         ]
      },
      "SourceTemplate": { 
         "Arn": "string"
      }
   },
   "VersionDescription": "string"
}

Paramètres de demande URI

La demande utilise les paramètres URI suivants.

AwsAccountId

ID duAWSqui contient le modèle que vous mettez à jour.

Contraintes de longueur : Longueur fixe de 12.

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

Obligatoire : Oui

TemplateId

ID du modèle.

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

Entité que vous utilisez comme source lorsque vous mettez à jour le modèle. DansSourceEntity, vous spécifiez le type d'objet que vous utilisez comme source :SourceTemplatepour un modèle ouSourceAnalysispour une analyse. Les deux nécessitent un Amazon Resource Name (ARN). PourSourceTemplate, spécifiez l'ARN du modèle source. PourSourceAnalysis, spécifiez l'ARN de l'analyse source. LeSourceTemplateL'ARN peut contenir n'importe quelAWScompte et n'importe quel compte Amazon QuickSightpris 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

Le nom du modèle.

Type : Chaîne

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

Obligatoire : Non

VersionDescription

Description de la version du modèle actuellement mise à jour. Chaque fois que tu appellesUpdateTemplate, vous créez une nouvelle version du modèle. 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

ARN (Amazon Resource Name) du modèle.

Type : Chaîne

CreationStatus

État 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.

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

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

HTTP Status Code : 400

LimitExceededException

Une limite est dépassée.

HTTP Status Code : 409

ResourceExistsException

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

HTTP Status Code : 409

ResourceNotFoundException

Une ou plusieurs ressources n'ont pas pu ê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 portant sur Amazon QuickSightabonnement dont l'édition n'inclut pas la prise en charge de cette opération. Amazon QuickSight dispose actuellement de Standard Edition et Enterprise Edition. Toutes les opérations et fonctionnalités ne sont pas disponibles dans chaque édition.

HTTP Status Code : 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 :