ListUsers - Amazon QuickSight

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

ListUsers

返回所有亚马逊的列表 QuickSight 属于该账户的用户。

请求语法

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

URI 请求参数

请求使用以下 URI 参数。

AwsAccountId

的 IDAWS用户所在的帐户。目前,您将 ID 用于AWS包含您的亚马逊的账户 QuickSight account.

长度约束:长度固定为 12。

模式:^[0-9]{12}$

必需:是

MaxResults

此请求返回的最大结果数。

有效范围:最小值为 1。最大值为 100。

Namespace

命名空间。目前,您应该将其设置为default.

长度约束:最大长度为 64。

模式:^[a-zA-Z0-9._-]*$

必需:是

NextToken

分页标记,您可在后续的 DescribeDight 请求中使用。

请求正文

该请求没有请求体。

响应语法

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" } ] }

响应元素

如果此操作成功,则该服务将会发送回 HTTP 响应。

Status

请求的 HTTP 状态。

服务以 JSON 格式返回的以下数据。

NextToken

分页标记,您可在后续的 DescribeDight 请求中使用。

类型: 字符串

RequestId

这些区域有:AWS用于此操作的请求 ID。

类型: 字符串

UserList

用户的列表。

类型: 数组User对象

错误

有关所有操作共有的错误的信息,请参阅常见错误.

AccessDeniedException

您无权访问此项目。无法验证提供的凭证。您可能无权执行请求。确保您的账户已获得使用亚马逊的授权 QuickSight 服务,您的策略具有正确的权限,并且您使用的是正确的访问密钥。

HTP 状态代码:401

InternalFailureException

出现内部故障。

HTP 状态代码:500

InvalidNextTokenException

NextToken 值无效。

HTP 状态代码:400

InvalidParameterValueException

一个或多个参数的值无效。

HTP 状态代码:400

PreconditionNotMetException

未满足一个或多个先决条件。

HTP 状态代码:400

ResourceNotFoundException

无法找到一个或多个资源。

HTP 状态代码:404

ResourceUnavailableException

此资源当前不可用。

HTP 状态代码:503

ThrottlingException

访问受限。

HTP 状态代码:429

另请参阅

有关在特定语言的 AWS 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: