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á.
GetGovCloudAccountInformation
Recupera informações sobre a GovCloud conta vinculada à conta padrão especificada (se ela existir), incluindo o ID e o estado da GovCloud conta. Para usar essa API, um usuário do IAM ou perfil deve ter a permissão account:GetGovCloudAccountInformation do IAM.
Sintaxe da Solicitação
POST /getGovCloudAccountInformation HTTP/1.1
Content-type: application/json
{
"StandardAccountId": "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.
- StandardAccountId
-
Especifica o número de identificação da conta de 12 dígitos da AWS conta que você deseja acessar ou modificar com essa operação.
Se você não especificar esse parâmetro, o padrão será a AWS conta 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 de administrador delegado, e o ID da conta especificada deve ser de uma conta-membro na mesma organização. A organização deve ter todos os atributos 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 seja membro de uma organização, não especifique esse parâmetro e 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
Sintaxe da Resposta
HTTP/1.1 200
Content-type: application/json
{
"AccountState": "string",
"GovCloudAccountId": "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.
- AccountState
-
O estado da GovCloud conta vinculada.
Tipo: String
Valores Válidos:
PENDING_ACTIVATION | ACTIVE | SUSPENDED | CLOSED - GovCloudAccountId
-
O número de identificação da conta de 12 dígitos da conta GovCloud vinculada.
Tipo: sequência
Padrão:
\d{12}
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.
- errorType
-
O valor preenchido no cabeçalho da resposta
x-amzn-ErrorTypepelo 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-ErrorTypepelo API Gateway.
Código de status HTTP: 500
- ResourceNotFoundException
-
Ocorreu uma falha na operação porque ela especificou um recurso que não pode ser encontrado.
- errorType
-
O valor preenchido no cabeçalho da resposta
x-amzn-ErrorTypepelo API Gateway.
Código de status HTTP: 404
- ResourceUnavailableException
-
A operação falhou porque especificou um recurso que não está disponível no momento.
- errorType
-
O valor preenchido no cabeçalho da resposta
x-amzn-ErrorTypepelo API Gateway.
Código de status HTTP: 424
- 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-ErrorTypepelo 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
Exemplos
Exemplo 1
O exemplo a seguir recupera as informações da GovCloud conta vinculada para a conta cujas credenciais são usadas para chamar a operação.
Exemplo de solicitação
POST / HTTP/1.1
X-Amz-Target: AWSAccountV20210201.GetGovCloudAccountInformation
{}Resposta da amostra
HTTP/1.1 200 OK
Content-Type: application/json
{
"GovCloudAccountId": "123456789012",
"AccountState": "ACTIVE"
}Exemplo 2
O exemplo a seguir recupera as informações da GovCloud conta vinculada para a conta membro especificada em uma organização. Você deve usar as credenciais da conta de gerenciamento da organização ou da conta de administrador delegado do serviço de Gerenciamento de Contas.
Exemplo de solicitação
POST / HTTP/1.1
X-Amz-Target: AWSAccountV20210201.GetGovCloudAccountInformation
{
"StandardAccountId": "111111111111"
}Resposta da amostra
HTTP/1.1 200 OK
Content-Type: application/json
{
"GovCloudAccountId": "123456789012",
"AccountState": "ACTIVE"
}Exemplo 3
O exemplo a seguir tenta recuperar as informações da GovCloud conta vinculada para uma conta padrão que não está vinculada a uma GovCloud conta.
Exemplo de solicitação
POST / HTTP/1.1
X-Amz-Target: AWSAccountV20210201.GetGovCloudAccountInformation
{
"StandardAccountId": "222222222222"
}Resposta da amostra
HTTP/1.1 404
Content-Type: application/json
{
"message":"GovCloud Account ID not found for Standard Account - 222222222222."
}Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
