ListRegions - AWS Gerenciamento de contas
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á.

ListRegions

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

Sintaxe da Solicitação

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 solicitação não usa nenhum parâmetro de URI.

Corpo da Solicitação

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

AccountId

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 é 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 ou uma conta de administrador delegado. O ID da conta especificado deve ser uma conta membro na mesma organização. A organização deve ter todos os recursos habilitados e a organização deve ter acesso confiável habilitado para o serviço de gerenciamento de contas e, opcionalmente, uma conta de administrador delegado atribuída.

nota

A conta de gerenciamento não pode especificar sua própria contaAccountId. Ele deve chamar a operação em um contexto autônomo sem incluir o AccountId parâmetro.

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: string

Padrão: ^\d{12}$

Obrigatório: Não

MaxResults

O número total de itens a serem retornados na saída do comando. Se o número total de itens disponíveis for maior que o valor especificado, a 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 no Guia do usuário da interface de linha de AWS comando.

Tipo: número inteiro

Faixa válida: valor mínimo de 1. Valor máximo de 50.

Obrigatório: Não

NextToken

Um token usado para especificar por onde começar a paginar. Isso é NextToken de uma resposta previamente truncada. Para exemplos de uso, consulte Paginação 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

Uma lista de status de região (Ativado, Ativado, Desativado, Desativado, Ativado_por_padrão) a serem usados para filtrar a lista de regiões de uma determinada conta. Por exemplo, passar um valor de 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

HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Regions": [ 
      { 
         "RegionName": "string",
         "RegionOptStatus": "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

Se houver mais dados a serem retornados, eles serão preenchidos. Ele deve ser passado para o parâmetro de next-token solicitação delist-regions.

Tipo: string

Regions

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 filtro definidos no filter parâmetro.

Tipo: matriz de objetos Region

Erros

Para obter informações sobre os erros comuns retornados pelas ações, consulte Erros comuns.

AccessDeniedException

A operação falhou porque a identidade de chamada não tem as permissões mínimas necessárias.

Código de Status HTTP: 403

InternalServerException

A operação falhou devido a um erro interno do AWS. Tente sua operação novamente mais tarde.

Código de Status HTTP: 500

TooManyRequestsException

A operação falhou porque foi chamada com muita frequência e excedeu o limite do acelerador.

Código de Status HTTP: 429

ValidationException

A operação falhou porque um dos parâmetros de entrada era inválido.

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: