ListRegions
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
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 do ID de 12 dígitos da 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 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 e deve ter acesso confiável habilitado para o serviço de gerenciamento de contas e, opcionalmente, uma conta do administrador delegado atribuída.
nota
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âmetroAccountId
.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 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 valorNextToken
no argumentostarting-token
de um comando subsequente. Não use o elemento de respostaNextToken
diretamente fora da AWS CLI. Para obter exemplos de uso, consulte Paginação no Guia do usuário da AWS Command Line Interface.Tipo: número inteiro
Faixa válida: valor mínimo de 1. Valor máximo de 50.
Obrigatório: Não
- NextToken
-
Um token para especificar onde iniciar a paginação. Esse é o
NextToken
de uma resposta truncada anteriormente. Para obter exemplos de uso, consulte Paginação no Guia do usuário da AWS Command Line Interface.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 (Sendo habilitada, Habilitada, Sendo desabilitada, Desabilitada, Habilitada_por_Padrã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
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. Deve ser passado para o parâmetro de solicitação
next-token
dalist-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 filtragem definidos no parâmetro
filter
.Tipo: matriz de objetos Region
Erros
Para obter informações sobre os erros comuns retornados pelas ações, consulte Erros comuns.
- AccessDeniedException
-
Ocorreu uma falha na operação porque a identidade de chamada não tem as permissões mínimas necessárias.
Código de Status HTTP: 403
- InternalServerException
-
Ocorreu uma falha na operação devido a um erro interno da AWS. Tente executar a operação novamente mais tarde.
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.
Código de Status HTTP: 429
- ValidationException
-
Ocorreu uma falha na operação 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 SDKs específicos de linguagem AWS, consulte: