

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

# ListGroups
<a name="API_ListGroups"></a>

Lista todos os grupos de usuários na Amazon QuickSight. 

## Sintaxe da solicitação
<a name="API_ListGroups_RequestSyntax"></a>

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

## Parâmetros da solicitação de URI
<a name="API_ListGroups_RequestParameters"></a>

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

 ** [AwsAccountId](#API_ListGroups_RequestSyntax) **   <a name="QS-ListGroups-request-AwsAccountId"></a>
O ID do doAWSconta em que o grupo está. Atualmente, você usa o ID para oAWSconta da sua Amazon QuickSight conta.  
Restrições de comprimento: Comprimento fixo de 12.  
Padrão: `^[0-9]{12}$`   
Obrigatório: Sim

 ** [MaxResults](#API_ListGroups_RequestSyntax) **   <a name="QS-ListGroups-request-MaxResults"></a>
O número máximo de resultados a serem retornados.  
Intervalo válido: Valor mínimo de 1. Valor máximo de 100.

 ** [Namespace](#API_ListGroups_RequestSyntax) **   <a name="QS-ListGroups-request-Namespace"></a>
O namespace do qual você deseja uma lista de grupos.  
Restrições de comprimento: Tamanho máximo de 64.  
Padrão: `^[a-zA-Z0-9._-]*$`   
Obrigatório: Sim

 ** [NextToken](#API_ListGroups_RequestSyntax) **   <a name="QS-ListGroups-request-NextToken"></a>
Um token de paginação que pode ser usado em uma solicitação subsequente.

## Corpo da solicitação
<a name="API_ListGroups_RequestBody"></a>

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

## Sintaxe da resposta
<a name="API_ListGroups_ResponseSyntax"></a>

```
HTTP/1.1 Status
Content-type: application/json

{
   "GroupList": [ 
      { 
         "Arn": "string",
         "Description": "string",
         "GroupName": "string",
         "PrincipalId": "string"
      }
   ],
   "NextToken": "string",
   "RequestId": "string"
}
```

## Elementos de resposta
<a name="API_ListGroups_ResponseElements"></a>

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

 ** [Status](#API_ListGroups_ResponseSyntax) **   <a name="QS-ListGroups-response-Status"></a>
O status HTTP da solicitação.

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

 ** [GroupList](#API_ListGroups_ResponseSyntax) **   <a name="QS-ListGroups-response-GroupList"></a>
A lista dos grupos.  
Type: Intervalo de[Group](API_Group.md)objetos

 ** [NextToken](#API_ListGroups_ResponseSyntax) **   <a name="QS-ListGroups-response-NextToken"></a>
Um token de paginação que pode ser usado em uma solicitação subsequente.  
Type: String

 ** [RequestId](#API_ListGroups_ResponseSyntax) **   <a name="QS-ListGroups-response-RequestId"></a>
OAWSID do para essa operação.  
Type: String

## Erros
<a name="API_ListGroups_Errors"></a>

Para obter informações sobre os erros que são comuns a todas as ações, consulte[Erros comuns](CommonErrors.md).

 ** 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
<a name="API_ListGroups_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos de linguagem, consulte o seguinte:
+  [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/quicksight-2018-04-01/ListGroups) 
+  [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/quicksight-2018-04-01/ListGroups) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/quicksight-2018-04-01/ListGroups) 
+  [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/quicksight-2018-04-01/ListGroups) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/quicksight-2018-04-01/ListGroups) 
+  [AWSSDK para o JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/quicksight-2018-04-01/ListGroups) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/quicksight-2018-04-01/ListGroups) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/quicksight-2018-04-01/ListGroups) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/quicksight-2018-04-01/ListGroups) 