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.
DescribeDashboard
Fournit un résumé pour un tableau de bord.
Syntaxe de la demande
GET /accounts/AwsAccountId/dashboards/DashboardId?alias-name=AliasName&version-number=VersionNumber HTTP/1.1
Paramètres de demande URI
La demande utilise les paramètres URI suivants.
- AliasName
-
Le nom de l'alias.
Contraintes de longueur : Longueur minimale de 1. Longueur maximale de 2048.
Modèle :
[\w\-]+|(\$LATEST)|(\$PUBLISHED) - AwsAccountId
-
ID duAWSqui contient le tableau de bord que vous décrivez.
Contraintes de longueur : Longueur fixe de 12.
Modèle :
^[0-9]{12}$Obligatoire : Oui
- DashboardId
-
ID pour le tableau de bord.
Contraintes de longueur : Longueur minimale de 1. Longueur maximale de 2048.
Modèle :
[\w\-]+Obligatoire : Oui
- VersionNumber
-
Le numéro de version du tableau de bord. Si un numéro de version n'est pas transmis, la dernière version publiée du tableau de bord est décrite.
Plage valide : Valeur minimale est 1.
Corps de la requête
La demande n'a pas de corps de requête.
Syntaxe de la réponse
HTTP/1.1 Status
Content-type: application/json
{
"Dashboard": {
"Arn": "string",
"CreatedTime": number,
"DashboardId": "string",
"LastPublishedTime": number,
"LastUpdatedTime": number,
"Name": "string",
"Version": {
"Arn": "string",
"CreatedTime": number,
"DataSetArns": [ "string" ],
"Description": "string",
"Errors": [
{
"Message": "string",
"Type": "string"
}
],
"Sheets": [
{
"Name": "string",
"SheetId": "string"
}
],
"SourceEntityArn": "string",
"Status": "string",
"ThemeArn": "string",
"VersionNumber": number
}
},
"RequestId": "string"
}Eléments de réponse
Si l'action aboutit, le service renvoie la réponse HTTP suivante.
- Status
-
Le statut HTTP de cette requête.
Les données suivantes sont renvoyées au format JSON par le service.
Erreurs
Pour plus d'informations sur les erreurs communes à toutes les actions, consultezErreurs courantes.
- AccessDeniedException
-
Vous n'avez pas accès à cet article. 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.
Code d'état HTTP : 401
- InternalFailureException
-
Une défaillance interne s'est produite.
Code d'état HTTP : 500
- InvalidParameterValueException
-
La valeur d'un ou de plusieurs paramètres n'est pas valide.
Code d'état HTTP : 400
- ResourceNotFoundException
-
Une ou plusieurs ressources n'ont pas pu être trouvées.
Code d'état HTTP : 404
- ThrottlingException
-
L'accès est limité.
Code d'état HTTP : 429
- UnsupportedUserEditionException
-
Cette erreur indique que vous appelez une opération portant sur un compte Amazon QuickSightabonnement dont l'édition n'inclut pas la prise en charge de cette opération. Amazon Amazon QuickSight Les éditions actuellement disponibles pour l'édition. Toutes les opérations et fonctionnalités ne sont pas disponibles dans chaque édition.
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 :
