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

UpdateDashboard

Met à jour un tableau de bord dansAWS.

Note

La mise à jour d'un tableau de bord crée une nouvelle version du tableau de bord mais ne publie pas immédiatement la nouvelle version. Vous pouvez mettre à jour la version publiée d'un tableau de bord en utilisant la UpdateDashboardPublishedVersion Opération d'API.

Syntaxe de la demande

PUT /accounts/AwsAccountId/dashboards/DashboardId HTTP/1.1
Content-type: application/json

{
   "DashboardPublishOptions": { 
      "AdHocFilteringOption": { 
         "AvailabilityStatus": "string"
      },
      "ExportToCSVOption": { 
         "AvailabilityStatus": "string"
      },
      "SheetControlsOption": { 
         "VisibilityState": "string"
      }
   },
   "Name": "string",
   "Parameters": { 
      "DateTimeParameters": [ 
         { 
            "Name": "string",
            "Values": [ number ]
         }
      ],
      "DecimalParameters": [ 
         { 
            "Name": "string",
            "Values": [ number ]
         }
      ],
      "IntegerParameters": [ 
         { 
            "Name": "string",
            "Values": [ number ]
         }
      ],
      "StringParameters": [ 
         { 
            "Name": "string",
            "Values": [ "string" ]
         }
      ]
   },
   "SourceEntity": { 
      "SourceTemplate": { 
         "Arn": "string",
         "DataSetReferences": [ 
            { 
               "DataSetArn": "string",
               "DataSetPlaceholder": "string"
            }
         ]
      }
   },
   "ThemeArn": "string",
   "VersionDescription": "string"
}

Paramètres de demande URI

La demande utilise les paramètres URI suivants.

AwsAccountId

ID duAWSqui contient le tableau de bord que vous mettez à jour.

Contraintes : Longueur fixe de 12.

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

Obligatoire : Oui

DashboardId

ID pour le tableau de bord.

Contraintes : 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.

Name

Nom d'affichage du tableau de bord.

Type : Chaîne

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

Obligatoire : Oui

SourceEntity

Entité que vous utilisez comme source lorsque vous mettez à jour le tableau de bord. DansSourceEntity, vous spécifiez le type d'objet que vous utilisez comme source. Vous ne pouvez mettre à jour un tableau de bord qu'à partir d'un modèle. Vous pouvez donc utiliser unSourceTemplateEntité. Si vous avez besoin de mettre à jour un tableau de bord à partir d'une analyse, convertissez d'abord l'analyse en modèle à l'aide du CreateTemplate Opération d'API. PourSourceTemplate, spécifiez l'ARN (Amazon Resource Name) du modèle 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 seinSourceTemplatepour 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 DashboardSourceEntity

Obligatoire : Oui

DashboardPublishOptions

Options de publication du tableau de bord lors de sa création :

  • AvailabilityStatuspourAdHocFilteringOption- Ce statut peut être l'un ou l'autreENABLEDouDISABLED. Lorsque cela est défini surDISABLED, Amazon QuickSight désactive le volet de filtre de gauche sur le tableau de bord publié, qui peut être utilisé pour le filtrage ad hoc (ponctuel). Cette option estENABLEDpar défaut.

  • AvailabilityStatuspourExportToCSVOption- Ce statut peut être l'un ou l'autreENABLEDouDISABLED. L'option visuelle permettant d'exporter des données au format .CSV n'est pas activée lorsque cette option est définie surDISABLED. Cette option estENABLEDpar défaut.

  • VisibilityStatepourSheetControlsOption- Cet état de visibilité peut être soitCOLLAPSEDouEXPANDED. Cette option estCOLLAPSEDpar défaut.

Type : objet DashboardPublishOptions

Obligatoire : Non

Parameters

Structure contenant les paramètres du tableau de bord. Il s'agit de remplacements de paramètres pour un tableau de bord. Un tableau de bord peut comporter n'importe quel type de paramètres, et certains paramètres peuvent accepter plusieurs valeurs.

Type : objet Parameters

Obligatoire : Non

ThemeArn

Amazon Resource Name (ARN) du thème utilisé pour ce tableau de bord. Si vous ajoutez une valeur pour ce champ, elle remplace la valeur initialement associée à l'entité. L'ARN du thème doit exister dans le même.AWScompte sur lequel vous créez le tableau de bord.

Type : Chaîne

Obligatoire : Non

VersionDescription

Une description pour la première version du tableau de bord en cours de création.

Type : Chaîne

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

Obligatoire : Non

Syntaxe de la réponse

HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "CreationStatus": "string",
   "DashboardId": "string",
   "RequestId": "string",
   "Status": number,
   "VersionArn": "string"
}

Eléments de réponse

Si l'action aboutit, le service renvoie une réponse HTTP 200.

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

Arn

ARN (Amazon Resource Name) de la ressource.

Type : Chaîne

CreationStatus

Le statut d'une demande.

Type : Chaîne

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

DashboardId

ID pour le tableau de bord.

Type : Chaîne

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

Modèle : [\w\-]+

RequestId

LeAWSID de demande pour cette opération.

Type : Chaîne

Status

Le statut HTTP de la requête.

Type : Entier

VersionArn

L'ARN du tableau de bord, y compris le numéro de 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

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 Amazon QuickSight possède actuellement 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 :