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á.
Referência da API
As operações de API no namespace Gerenciamento de Contas (account) permitem que você modifique a Conta da AWS.
Cada Conta da AWS oferece suporte a metadados com informações sobre a conta, incluindo informações sobre até três contatos alternativos associados à conta. Eles são adicionais ao endereço de e-mail associado ao usuário-raiz da conta. Você pode especificar somente um de cada um dos tipos de contato a seguir associados a uma conta.
-
Contato de faturamento
-
Contato de operações
-
Contato de segurança
Por padrão, as operações de API discutidas neste guia se aplicam diretamente à conta que chama a operação. A identidade da conta que está chamando a operação normalmente é um perfil do IAM ou um usuário do IAM e deve ter permissão aplicada por uma política do IAM para chamar a operação da API. Como alternativa, você pode chamar essas operações de API em uma identidade de uma conta de gerenciamento do AWS Organizations e especificar o número de ID da conta para qualquer Conta da AWS que seja membro da organização.
Versão da API
Esta versão da Referência da API de Contas documenta a versão 2021-02-01 da API de Gerenciamento de Contas.
nota
Como alternativa ao uso da API diretamente, você pode usar um dos SDKs da AWS, que consistem em bibliotecas e códigos de exemplo para várias linguagens e plataformas de programação (Java, Ruby, .NET, iOS, Android e muito mais). Os SDKs são uma forma conveniente de criar acesso programático ao AWS Organizations. Por exemplo, os SDKs processam assinatura criptográfica de solicitações, gerenciamento de erros e novas tentativas automáticas de solicitações. Para obter mais informações sobre os SDKs da AWS, incluindo como fazer download deles e instalá-los, consulte Ferramentas da Amazon Web Services
Recomendamos que você use os SDKs da AWS para fazer chamadas programáticas de API para o serviço de Gerenciamento de Contas. No entanto, você também pode usar a API de consulta do Gerenciamento de Contas para fazer chamadas diretas para o serviço Web de Gerenciamento de Contas. Para saber mais sobre a API de consulta do Gerenciamento de Contas, consulte Chamar a API por meio de solicitações de consulta HTTP no Account Management User Guide. O Organizations oferece suporte a solicitações GET e POST para todas as ações. Ou seja, a API não exige que você use GET para algumas ações e POST para outras. No entanto, as solicitações GET estão sujeitas à limitação do tamanho de um URL. Portanto, para operações que exigem tamanhos maiores, use uma solicitação POST.
Assinatura de solicitações
Ao enviar solicitações de HTTP para a AWS, você deve assinar as solicitações para que a AWS possa identificar quem as enviou. Assine as solicitações com a chave de acesso da AWS, que consiste em um ID da chave de acesso e uma chave de acesso secreta. É altamente recomendável não criar uma chave de acesso para o usuário-raiz. Qualquer pessoa que tenha a chave de acesso do usuário-raiz da conta tem acesso irrestrito a todos os recursos da conta. Em vez disso, crie uma chave de acesso para um usuário do IAM que tenha privilégios administrativos. Opcionalmente, você pode usar o AWS Security Token Service para gerar credenciais de segurança temporárias e usá-las para assinar solicitações.
Para assinar solicitações, recomendamos o uso do Signature Version 4. Se você tiver uma aplicação existente que usa o Signature Version 2, não precisará atualizá-la para usar o Signature Version 4. No entanto, algumas operações agora exigem o Signature Version 4. A documentação das operações que exigem a versão 4 indica esse requisito. Para obter mais informações, consulte Assinar solicitações de API da AWS no Guia do usuário do IAM.
Quando você usa a AWS Command Line Interface (AWS CLI) ou um dos SDKs da AWS para fazer solicitações para a AWS, essas ferramentas assinam automaticamente as solicitações para você com a chave de acesso que você especifica ao configurar as ferramentas.
Suporte e feedback para o Gerenciamento de Contas
Os seus comentários são bem-vindos. Envie seu feedback para feedback-awsaccounts@amazon.com
Como os exemplos são apresentados
O JSON retornado pelo Gerenciamento de Contas como resposta às suas solicitações é retornado como uma única string longa sem quebras de linha ou espaços em branco de formatação. Tanto as quebras de linha quanto os espaços em branco são mostrados nos exemplos deste guia para melhorar a leitura. Quando exemplos de parâmetros de entrada também resultam em sequências longas que se estendem para além da tela, inserimos quebras de linha para melhorar a leitura. Você deve sempre enviar a entrada como uma única string de texto JSON.
Registro de solicitações de API
O Gerenciamento de Contas oferece suporte ao CloudTrail, que é um serviço que registra chamadas de API da AWS para a Conta da AWS, e entrega arquivos de log a um bucket do Amazon S3. Usando as informações coletadas pelo CloudTrail, você pode determinar quais solicitações foram feitas com êxito para o Gerenciamento de Contas, quem fez a solicitação, quando ela foi feita etc. Para saber mais sobre o Gerenciamento de Contas e seu suporte ao CloudTrail, consulte Registro em log de chamadas da API do Gerenciamento de Contas da AWS usando o AWS CloudTrail. Para saber mais sobre o CloudTrail, inclusive como ativá-lo e encontrar seus arquivos de log, consulte o Guia do usuário do AWS CloudTrail.
