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.

Opérations internes de l'API

Si vous surveillez les opérations d'API, vous pouvez voir des appels aux opérations internes suivantes uniquement :

Fonctionnement interne de l'API : GetDashboardUrl

Cette opération apparaît dans les journaux système lorsqu'elle est invoquée par la console AMS. Il n'a aucun autre cas d'utilisation. Il n'est pas disponible pour votre usage direct.

Renvoie l'URL du tableau de bord intégré pour le rapport correspondant. Cette opération accepte un dashboardName retour parListReports.

Syntaxe de demande

HTTP/1.1 200
Content-type: application/json
{
    "dashboardName": "string"
}

Éléments de la demande

dashboardName: nom du QuickSight tableau de bord pour lequel l'URL est demandée. Le nom du tableau de bord est renvoyé dans la ListReports version 2.

Type : String

Syntaxe de réponse

HTTP/1.1 200
Content-type: application/json
{
  "url": "string"
}

Élé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.

url: renvoie l' QuickSight URL de la demandedashboardName.

Type : String

Erreurs

Pour plus d'informations sur les erreurs communes à toutes les actions, consultez la section Erreurs courantes.

BadRequestException:

La demande soumise n'est pas valide. Par exemple, si la saisie est incomplète ou incorrecte. Consultez le message d'erreur qui l'accompagne pour plus de détails.

Code d’état HTTP : 400

NotFoundException:

La ressource demandée est introuvable. Assurez-vous que l'URI de la demande est correct.

Code d’état HTTP : 404

TooManyRequestsException:

La demande a atteint sa limite de limitation. Réessayez après la période spécifiée.

Code d’état HTTP : 429

UnauthorizedException:

La demande est refusée car l'appelant ne dispose pas des autorisations suffisantes.

Code d'état HTTP : 401

Fonctionnement interne de l'API : ListReports V2

Cette API apparaît dans les journaux système lorsqu'elle est invoquée par la console AMS. Il n'a aucun autre cas d'utilisation. Il n'est pas disponible pour votre usage direct.

Renvoie la liste des rapports opérationnels disponibles pour un compte donné.

Syntaxe de demande

La demande n'a pas de corps de demande.

Syntaxe de réponse

HTTP/1.1 200
Content-type: application/json
{
  "reportsList": [
    {
        "dashboard": "string",
        "lastUpdatedTime": "string",
    }
  ],
  "reportsType": "string"
}

Élé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.

reportsList: liste des rapports opérationnels disponibles.

Type : Tableau d'objets du tableau de bord

reportsType: indique si un rapport est agrégé sur plusieurs comptes ou non.

Type : String

Erreurs

Pour plus d'informations sur les erreurs communes à toutes les actions, consultez la section Erreurs courantes.

BadRequestException:

La demande soumise n'est pas valide. Par exemple, la saisie est incomplète ou incorrecte. Consultez le message d'erreur qui l'accompagne pour plus de détails.

Code d’état HTTP : 400

NotFoundException:

La ressource demandée est introuvable. Assurez-vous que l'URI de la demande est correct.

Code d’état HTTP : 404

TooManyRequestsException:

La demande a atteint sa limite de limitation. Réessayez après la période spécifiée.

Code d’état HTTP : 429

UnauthorizedException:

La demande est refusée car l'appelant ne dispose pas des autorisations suffisantes.

Code d'état HTTP : 401