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

SearchDashboards

Recherche les tableaux de bord qui appartiennent à un utilisateur.

Note

Cette opération est cohérente à terme. Les résultats sont fournis au mieux et peuvent ne pas refléter les mises à jour et modifications très récentes.

Syntaxe de la demande

POST /accounts/AwsAccountId/search/dashboards HTTP/1.1
Content-type: application/json

{
   "Filters": [ 
      { 
         "Name": "string",
         "Operator": "string",
         "Value": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}

Paramètres de demande URI

La demande utilise les paramètres URI suivants.

AwsAccountId

ID duAWSqui contient l'utilisateur dont vous recherchez les tableaux de bord.

Contraintes de longueur : Longueur fixe de 12.

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

Obligatoire : Oui

Corps de la demande

Cette demande accepte les données suivantes au format JSON.

Filters

Les filtres à appliquer à la recherche. Actuellement, vous pouvez uniquement rechercher par nom d'utilisateur, par exemple,"Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]

Type : Tableaux deDashboardSearchFilterobjets

Membres du tableau : Nombre fixe de 1 élément.

Obligatoire : Oui

MaxResults

Nombre maximal de résultats à renvoyer par demande.

Type : Entier

Plage valide : Valeur minimale est 1. Valeur maximale fixée à 100.

Obligatoire : Non

NextToken

Jeton pour l'ensemble de résultats suivant, ou valeur null s'il n'y a plus de résultats.

Type : Chaîne

Obligatoire : Non

Syntaxe de la réponse

HTTP/1.1 Status
Content-type: application/json

{
   "DashboardSummaryList": [ 
      { 
         "Arn": "string",
         "CreatedTime": number,
         "DashboardId": "string",
         "LastPublishedTime": number,
         "LastUpdatedTime": number,
         "Name": "string",
         "PublishedVersionNumber": number
      }
   ],
   "NextToken": "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.

DashboardSummaryList

La liste des tableaux de bord appartenant à l'utilisateur spécifié dansFiltersdans votre demande.

Type : Tableaux deDashboardSummaryobjets

Membres du tableau : Nombre maximal de 100 éléments.

NextToken

Jeton pour l'ensemble de résultats suivant, ou valeur null s'il n'y a plus de résultats.

Type : Chaîne

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.

InternalFailureException

Une défaillance interne s'est produite.

HTTP HTTP HTTP d'état HTTP : 500

InvalidNextTokenException

La valeur NextToken n'est pas valide.

HTTP HTTP HTTP d'état HTTP : 400

InvalidParameterValueException

Un ou plusieurs paramètres ont une valeur non valide.

HTTP HTTP HTTP d'état HTTP : 400

ResourceNotFoundException

Une ou plusieurs ressources n'ont pas pu être trouvées.

HTTP HTTP HTTP d'état HTTP : 404

ThrottlingException

L'accès est limité.

HTTP HTTP HTTP d'état HTTP : 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 HTTP HTTP 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 :