ListUsers - Amazon QuickSight
Sintaxe da solicitaçãoParâmetros da solicitação de URICorpo da solicitaçãoSintaxe da respostaElementos de respostaErrosConsulte também

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

ListUsers

Retorna uma lista de toda a Amazônia QuickSight usuários pertencentes a essa conta.

Sintaxe da solicitação

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

Parâmetros da solicitação de URI

A solicitação usa os parâmetros de URI a seguir.

AwsAccountId

O ID doAWSconta na qual o usuário está. Atualmente, você usa o ID para oAWSconta da que contém a sua conta da Amazon QuickSight conta.

Restrições de tamanho: Comprimento fixo de 12.

Padrão: ^[0-9]{12}$

Obrigatório: Sim

MaxResults

O número máximo de resultados a serem retornados dessa solicitação.

Intervalo válido: Valor mínimo de 1. Valor máximo de 100.

Namespace

O namespace. No momento, é necessário definir isso comodefault.

Restrições de tamanho: Tamanho máximo de 64.

Padrão: ^[a-zA-Z0-9._-]*$

Obrigatório: Sim

NextToken

Um token de paginação que pode ser usado em uma solicitação subsequente.

Corpo da solicitação

Essa solicitação não tem o corpo da solicitação.

Sintaxe da resposta

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

Elementos de resposta

Se a ação for bem-sucedida, o serviço retornará a resposta HTTP a seguir.

Status

O status HTTP da solicitação.

Os seguintes dados são retornados no formato JSON pelo serviço.

NextToken

Um token de paginação que pode ser usado em uma solicitação subsequente.

Type: String

RequestId

OAWSID da solicitação para essa operação.

Type: String

UserList

A lista de usuários do.

Type: String ofUserobjetos

Erros

Para obter informações sobre os erros que são comuns a todas as ações, consulteErros comuns.

AccessDeniedException

Você não tem acesso a esse item. Não foi possível validar as credenciais fornecidas. Talvez você não tenha permissão para executar a solicitação. Verifique se sua conta está autorizada a usar a Amazon QuickSight , se as suas políticas têm as permissões corretas e se você está usando as chaves de acesso corretas.

Código de status HTTP: 401

InternalFailureException

Ocorreu um erro interno.

Código de status HTTP: 500

InvalidNextTokenException

O valor NextToken é inválido.

Código de status HTTP: 400

InvalidParameterValueException

Um ou mais parâmetros têm um valor que não é válido.

Código de status HTTP: 400

PreconditionNotMetException

Uma ou mais pré-condições não foram atendidas.

Código de status HTTP: 400

ResourceNotFoundException

Não foi possível encontrar um ou mais recursos.

Código de status HTTP: 404

ResourceUnavailableException

Este recurso está indisponível no momento.

Código de status HTTP: 503

ThrottlingException

O acesso é limitado.

Código de status HTTP: 429

Consulte também

Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos de linguagem, consulte o seguinte: