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á.
DescribeUsers
Retorna uma lista de usuários.
Sintaxe da Solicitação
{
"Filters": [
{
"Name": "string
",
"Values": [ "string
" ]
}
],
"MaxResults": number
,
"NextToken": "string
",
"UserName": "string
"
}
Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte Parâmetros comuns.
A solicitação aceita os dados a seguir no formato JSON.
- Filters
-
Filtre para determinar a lista de usuários a serem retornados.
Tipo: matriz de objetos Filter
Obrigatório: não
- MaxResults
-
O número máximo de registros a serem incluídos na resposta. Se existirem mais registros do que o MaxResults valor especificado, um token será incluído na resposta para que os resultados restantes possam ser recuperados.
Tipo: inteiro
Obrigatório: não
- NextToken
-
Um argumento opcional a ser passado caso o número total de registros exceda o valor de MaxResults. Se o NextToken for retornado, haverá mais resultados disponíveis. O valor de nextToken é um token de paginação exclusivo para cada página. Faça a chamada novamente usando o token retornado para recuperar a próxima página. Mantenha todos os outros argumentos inalterados.
Tipo: sequência
Obrigatório: não
- UserName
-
O nome do usuário
Tipo: sequência
Restrições de tamanho: tamanho mínimo 1.
Padrão:
[a-zA-Z][a-zA-Z0-9\-]*
Obrigatório: Não
Sintaxe da Resposta
{
"NextToken": "string",
"Users": [
{
"AccessString": "string",
"ACLNames": [ "string" ],
"ARN": "string",
"Authentication": {
"PasswordCount": number,
"Type": "string"
},
"MinimumEngineVersion": "string",
"Name": "string",
"Status": "string"
}
]
}
Elementos de Resposta
Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.
Os dados a seguir são retornados no formato JSON pelo serviço.
- NextToken
-
Um argumento opcional a ser passado caso o número total de registros exceda o valor de MaxResults. Se o NextToken for retornado, haverá mais resultados disponíveis. O valor de nextToken é um token de paginação exclusivo para cada página. Faça a chamada novamente usando o token retornado para recuperar a próxima página. Mantenha todos os outros argumentos inalterados.
Tipo: sequência
- Users
-
Uma lista de usuários.
Tipo: matriz de objetos User
Erros
Para obter informações sobre os erros comuns que são comuns em todas ações, consulte Erros comuns.
- InvalidParameterCombinationException
-
Código de Status HTTP: 400
- UserNotFoundFault
-
Código de Status HTTP: 400
Consulte também
Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos da linguagem, consulte o seguinte: