DescribeAnalysis - Amazon QuickSight
Syntaxe de la demandeParamètres de demande URICorps de la requêteSyntaxe 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.

DescribeAnalysis

Fournit un résumé des métadonnées pour une analyse.

Syntaxe de la demande

GET /accounts/AwsAccountId/analyses/AnalysisId HTTP/1.1

Paramètres de demande URI

La demande utilise les paramètres URI suivants.

AnalysisId

ID de l'analyse que vous décrivez. L'ID fait partie de l'URL de l'analyse.

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

Modèle : [\w\-]+

Obligatoire : Oui

AwsAccountId

ID duAWScompte qui contient l'analyse. Vous devez utiliser leAWScompte dans lequel se trouve l'analyse.

Contraintes de longueur : Longueur fixe de 12.

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

Obligatoire : Oui

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

{
   "Analysis": { 
      "AnalysisId": "string",
      "Arn": "string",
      "CreatedTime": number,
      "DataSetArns": [ "string" ],
      "Errors": [ 
         { 
            "Message": "string",
            "Type": "string"
         }
      ],
      "LastUpdatedTime": number,
      "Name": "string",
      "Sheets": [ 
         { 
            "Name": "string",
            "SheetId": "string"
         }
      ],
      "Status": "string",
      "ThemeArn": "string"
   },
   "RequestId": "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.

Analysis

Structure de métadonnées qui contient des informations récapitulatives pour l'analyse que vous décrivez.

Type : objet Analysis

RequestId

LeAWSID de demande pour cette opération.

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 : 401

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

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

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 :