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á.
SearchGroups
Usar aSearchGroupsoperação para pesquisar grupos em uma Amazon especificada QuickSight namespace usando os filtros fornecidos.
Sintaxe da solicitação
POST /accounts/AwsAccountId/namespaces/Namespace/groups-search?max-results=MaxResults&next-token=NextToken HTTP/1.1
Content-type: application/json
{
"Filters": [
{
"Name": "string",
"Operator": "string",
"Value": "string"
}
]
}Parâmetros da solicitação de URI
A solicitação usa os parâmetros de URI a seguir.
- AwsAccountId
-
O ID doAWSconta em que o grupo está. Atualmente, você usa o ID para oAWSconta da que contém 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 que deseja pesquisar.
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
A solicitação aceita os dados a seguir no formato JSON.
- Filters
-
A estrutura dos filtros de pesquisa que você deseja aplicar à sua pesquisa.
Type: Matriz deGroupSearchFilterobjetos
Membros da matriz: Número fixo de 1 item.
Obrigatório: Sim
Sintaxe da resposta
HTTP/1.1 Status
Content-type: application/json
{
"GroupList": [
{
"Arn": "string",
"Description": "string",
"GroupName": "string",
"PrincipalId": "string"
}
],
"NextToken": "string",
"RequestId": "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.
- GroupList
-
Uma lista de grupos em um namespace especificado que correspondem aos filtros definidos no
SearchGroupssolicitação.Type: Matriz deGroupobjetos
- 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
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:
