Chamar a API por meio de solicitações de consulta HTTP - AWS Organizations

Chamar a API por meio de solicitações de consulta HTTP

Esta seção contém informações gerais sobre o uso da API de consulta do AWS Organizations. Para obter detalhes sobre as operações e os erros da API, consulte Referência da API do AWS Organizations.

nota

Em vez de fazer chamadas diretas para a API de consulta do AWS Organizations, você pode usar um dos SDKs da AWS. Os SDKs da AWS consistem em bibliotecas e no código de exemplo para várias linguagens de programação e plataformas (Java, Ruby, .NET, iOS, Android e muito mais). Os SDKs constituem uma forma conveniente de criar acesso programático para o AWS Organizations e a AWS. Por exemplo, os SDKs processam tarefas como assinatura criptográfica de solicitações, gerenciamento de erros e novas tentativas automáticas de solicitações. Para obter informações sobre os AWS SDKs, incluindo como fazer download e instalá-los, consulte Ferramentas da Amazon Web Services.

A API de consulta do AWS Organizations permite chamar ações de serviço. As solicitações da API de consulta são solicitações HTTPS que devem conter um parâmetro Action para indicar a ação a ser realizada. O AWS Organizations oferece suporte a solicitações GET e POST para todas as operações. Ou seja, a API não requer 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. Embora esse limite dependa do navegador, um limite típico é 2048 bytes. Portanto, para as solicitações da API de consulta que exigem tamanhos maiores, você deve usar uma solicitação POST.

A resposta é um documento XML. Para obter mais detalhes sobre a resposta, consulte as páginas de ação individuais na Referência da API do AWS Organizations.

Endpoints

O AWS Organizations tem um endpoint individual de API global que está hospedado na região Leste dos EUA (Norte da Virgínia).

Para obter mais informações sobre endpoints e regiões da AWS para todos os serviços, consulte Regiões e endpoints, na Referência geral da AWS.

HTTPS obrigatório

Como a API de consulta retorna informações confidenciais, como credenciais de segurança, você deve usar HTTPS para criptografar todas as solicitações de API.

Assinar solicitações de API do AWS Organizations

As solicitações devem ser assinadas usando um ID da chave de acesso e uma chave de acesso secreta. É altamente recomendável não usar as credenciais da conta raiz da AWS para trabalhos diários com o AWS Organizations. Você pode usar as credenciais de um usuário do IAM ou credenciais temporárias, como as que são utilizadas com uma função do IAM.

Para assinar suas solicitações de API, você deve usar a AWS Signature versão 4. Para obter informações sobre como usar o Signature versão 4, consulte Processo de assinatura do Signature versão 4 na Referência geral da AWS.

AWS OrganizationsO não dá suporte a versões anteriores, como Signature versão 2.

Para obter mais informações, consulte: