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

ListUsers

Renvoie une liste de tous les Amazon QuickSight les utilisateurs appartenant à ce compte.

Syntaxe de la demande

GET /accounts/AwsAccountId/namespaces/Namespace/users?max-results=MaxResults&next-token=NextToken HTTP/1.1

Paramètres de demande URI

La demande utilise les paramètres URI suivants.

AwsAccountId

Code d'identification pourAWScompte dans lequel se trouve l'utilisateur. Actuellement, vous utilisez l'ID pourAWScompte qui contient votre Amazon QuickSight .

Contraintes de longueur : Longueur fixe de 12.

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

Obligatoire : Oui

MaxResults

Nombre maximal de résultats à renvoyer pour cette demande.

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

Namespace

Espace de noms. Actuellement, vous devez définir cette valeur surdefault.

Contraintes de longueur : Longueur maximale de 64.

Modèle : ^[a-zA-Z0-9._-]*$

Obligatoire : Oui

NextToken

Jeton de pagination qui peut être utilisée dans une demande ultérieure.

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

{
   "NextToken": "string",
   "RequestId": "string",
   "UserList": [ 
      { 
         "Active": boolean,
         "Arn": "string",
         "CustomPermissionsName": "string",
         "Email": "string",
         "ExternalLoginFederationProviderType": "string",
         "ExternalLoginFederationProviderUrl": "string",
         "ExternalLoginId": "string",
         "IdentityType": "string",
         "PrincipalId": "string",
         "Role": "string",
         "UserName": "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.

NextToken

Jeton de pagination qui peut être utilisée dans une demande ultérieure.

Type : Chaîne

RequestId

LeAWSID de demande pour cette opération.

Type : Chaîne

UserList

Liste des utilisateurs.

Type : Tableau deUserobjets

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.

HTTP Status Code : 401

InternalFailureException

Une défaillance interne s'est produite.

HTTP Status Code : 500

InvalidNextTokenException

La valeur NextToken n'est pas valide.

HTTP Status Code : 400

InvalidParameterValueException

La valeur d'un ou de plusieurs paramètres n'est pas valide.

HTTP Status Code : 400

PreconditionNotMetException

Une ou plusieurs conditions préalables ne sont pas remplies.

HTTP Status Code : 400

ResourceNotFoundException

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

HTTP Status Code : 404

ResourceUnavailableException

Cette ressource n'est pas disponible actuellement.

HTTP Status Code : 503

ThrottlingException

L'accès est limité.

HTTP Status Code : 429

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 :