

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

# ListRegions
<a name="API_ListRegions"></a>

Lista todas as regiões de uma determinada conta e seus respectivos status de ativação. Opcionalmente, essa lista pode ser filtrada pelo parâmetro `region-opt-status-contains`. 

## Sintaxe da Solicitação
<a name="API_ListRegions_RequestSyntax"></a>

```
POST /listRegions HTTP/1.1
Content-type: application/json

{
   "AccountId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "RegionOptStatusContains": [ "string" ]
}
```

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

A solicitação não usa nenhum parâmetro de URI.

## Corpo da Solicitação
<a name="API_ListRegions_RequestBody"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [AccountId](#API_ListRegions_RequestSyntax) **   <a name="accounts-ListRegions-request-AccountId"></a>
Especifica o número de identificação da conta de 12 dígitos Conta da AWS que você deseja acessar ou modificar com essa operação. Se você não especificar esse parâmetro, o padrão será a conta da Amazon Web Services da identidade usada para chamar a operação. Para usar esse parâmetro, o chamador deve ser uma identidade na [conta de gerenciamento da organização](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account) ou em uma conta do administrador delegado. O ID da conta especificada deve ser uma conta-membro na mesma organização. A organização deve ter [todos os recursos habilitados](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html) e deve ter [acesso confiável](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html) habilitado para o serviço de gerenciamento de contas e, opcionalmente, uma conta do [administrador delegado](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#delegated-admin) atribuída.  
A conta de gerenciamento não pode especificar seu próprio `AccountId`. Ela deve chamar a operação em um contexto autônomo sem incluir o parâmetro `AccountId`.
Para chamar essa operação em uma conta que não é membro de uma organização, não especifique esse parâmetro. Em vez disso, chame a operação usando uma identidade pertencente à conta cujos contatos você deseja recuperar ou modificar.  
Tipo: sequência  
Padrão: `\d{12}`   
Obrigatório: não

 ** [MaxResults](#API_ListRegions_RequestSyntax) **   <a name="accounts-ListRegions-request-MaxResults"></a>
O número total de itens para retornar na saída do comando. Se o número total de itens disponíveis for maior que o valor especificado, um `NextToken` será fornecido na saída do comando. Para retomar a paginação, forneça o valor `NextToken` no argumento `starting-token` de um comando subsequente. Não use o elemento de `NextToken` resposta diretamente fora da AWS CLI. Para exemplos de uso, consulte [Paginação](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) no Guia do *usuário da interface de linha de AWS comando*.   
Tipo: inteiro  
Faixa válida: valor mínimo de 1. Valor máximo de 50.  
Obrigatório: não

 ** [NextToken](#API_ListRegions_RequestSyntax) **   <a name="accounts-ListRegions-request-NextToken"></a>
Um token para especificar onde iniciar a paginação. Esse é o `NextToken` de uma resposta truncada anteriormente. Para exemplos de uso, consulte [Paginação](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) no Guia do *usuário da interface de linha de AWS comando*.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 0. Tamanho máximo de 1.000.  
Obrigatório: não

 ** [RegionOptStatusContains](#API_ListRegions_RequestSyntax) **   <a name="accounts-ListRegions-request-RegionOptStatusContains"></a>
Uma lista de status de região (Sendo habilitada, Habilitada, Sendo desabilitada, Desabilitada, Habilitada\$1por\$1Padrão) a serem usados para filtrar a lista de regiões de uma determinada conta. Por exemplo, passar um valor ENABLING só retornará uma lista de regiões com o status de região ENABLING.  
Tipo: matriz de strings  
Valores válidos: `ENABLED | ENABLING | DISABLING | DISABLED | ENABLED_BY_DEFAULT`   
Obrigatório: não

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

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

{
   "NextToken": "string",
   "Regions": [ 
      { 
         "RegionName": "string",
         "RegionOptStatus": "string"
      }
   ]
}
```

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

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](#API_ListRegions_ResponseSyntax) **   <a name="accounts-ListRegions-response-NextToken"></a>
Se houver mais dados a serem retornados, eles serão preenchidos. Deve ser passado para o parâmetro de solicitação `next-token` da `list-regions`.  
Tipo: string

 ** [Regions](#API_ListRegions_ResponseSyntax) **   <a name="accounts-ListRegions-response-Regions"></a>
Essa é uma lista de regiões para uma determinada conta ou, se o parâmetro filtrado foi usado, uma lista de regiões que correspondem aos critérios de filtragem definidos no parâmetro `filter`.  
Tipo: matriz de objetos [Region](API_Region.md)

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

Para informações sobre os erros comuns retornados pelas ações, consulte [Tipos de erro comuns](CommonErrors.md).

 ** AccessDeniedException **   
Ocorreu uma falha na operação porque a identidade de chamada não tem as permissões mínimas necessárias.    
 ** errorType **   
O valor preenchido no cabeçalho da resposta `x-amzn-ErrorType` pelo API Gateway.
Código de status HTTP: 403

 ** InternalServerException **   
A operação falhou devido a um erro interno do AWS. Tente executar a operação novamente mais tarde.    
 ** errorType **   
O valor preenchido no cabeçalho da resposta `x-amzn-ErrorType` pelo API Gateway.
Código de status HTTP: 500

 ** TooManyRequestsException **   
Ocorreu uma falha na operação porque ela foi chamada com muita frequência e excedeu um limite de controle de utilização.    
 ** errorType **   
O valor preenchido no cabeçalho da resposta `x-amzn-ErrorType` pelo API Gateway.
Código de status HTTP: 429

 ** ValidationException **   
Ocorreu uma falha na operação porque um dos parâmetros de entrada era inválido.    
 ** fieldList **   
O campo em que a entrada inválida foi detectada.  
 ** message **   
A mensagem que informa sobre o que era inválido na solicitação.  
 ** reason **   
O motivo da falha na validação.
Código de Status HTTP: 400

## Consulte também
<a name="API_ListRegions_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/account-2021-02-01/ListRegions) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/account-2021-02-01/ListRegions) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/account-2021-02-01/ListRegions) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/account-2021-02-01/ListRegions) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/account-2021-02-01/ListRegions) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/account-2021-02-01/ListRegions) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/account-2021-02-01/ListRegions) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/account-2021-02-01/ListRegions) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/account-2021-02-01/ListRegions) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/account-2021-02-01/ListRegions) 