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á.
Como fazer solicitações de API
As solicitações de consulta para as Permissões Verificadas da Amazon são solicitações HTTP ou HTTPS que usam o POST método.
Endpoints de permissões verificadas
Um endpoint é uma URL que serve como ponto de entrada para um serviço web. Você pode selecionar um Região da AWS endpoint apropriado ao fazer suas solicitações para reduzir a latência. Para obter informações sobre os endpoints usados pelas Permissões verificadas, consulte Permissões verificadas da Amazon no Referência geral da Amazon Web Services.
Parâmetros de solicitação
O Amazon Verified Permissions usa um JSON-based protocolo. Você passa os parâmetros da solicitação como JSON no corpo da sua solicitação HTTP. As listas são representadas como matrizes JSON. Para obter mais informações, consulte Parâmetros comuns na referência da API de permissões verificadas da Amazon.
Identificadores de solicitação
Em cada resposta, AWS retorna um ID de solicitação por meio do cabeçalho de resposta x-amzn-RequestId HTTP. Essa string é um identificador exclusivo que é AWS atribuído para fornecer informações de rastreamento. Embora o ID da solicitação esteja incluído em todas as respostas, ele não está listado nas páginas individuais de documentação da API para melhorar a legibilidade e reduzir a redundância.
Autenticação da API de
Você envia solicitações de consulta por HTTPS. Você deve incluir uma assinatura em cada solicitação de consulta. Para obter mais informações sobre como criar e incluir uma assinatura, consulte Assinatura de solicitações de AWS API no Referência geral da Amazon Web Services.
Bibliotecas disponíveis
AWS fornece bibliotecas, exemplos de código, tutoriais e outros recursos para desenvolvedores de software que preferem criar aplicativos usando APIs específicas da linguagem em vez das ferramentas de linha de comando e da API de consulta. Essas bibliotecas fornecem funções básicas (não incluídas nas APIs), como autenticação de solicitações, novas tentativas de solicitação e tratamento de erros, para facilitar o início. As bibliotecas e os recursos de permissões verificadas estão disponíveis para os seguintes idiomas e plataformas:
Para obter mais informações sobre bibliotecas e exemplos de código em todas as linguagens, consulte Código de amostra e bibliotecas.
Fazendo solicitações de API usando o método POST
Se você não usa um dos AWS SDKs, pode fazer solicitações de Permissões Verificadas por HTTPS usando o método de POST solicitação. O POST método exige que você especifique a operação no cabeçalho da solicitação e forneça os dados da operação no formato JSON no corpo da solicitação.
| Nome do cabeçalho | Valor de cabeçalho |
|---|---|
Host |
O endpoint de permissões verificadas da Amazon. Por exemplo: |
X-Amz-Date |
Você deve fornecer o timestamp no cabeçalho HTTP Date ou no cabeçalho AWS x-amz-date. Algumas bibliotecas de cliente HTTP não permitem que você defina o cabeçalho de data. Quando um cabeçalho x-amz-date está presente, o sistema ignora qualquer cabeçalho de data durante a autenticação da solicitação. O cabeçalho x-amz-date deve ser especificado no formato básico ISO 8601. Por exemplo: |
Authorization |
O conjunto de parâmetros de autorização AWS usado para garantir a validade e a autenticidade da solicitação. Para obter mais informações sobre a construção desse cabeçalho, consulte Processo de assinatura do Signature versão 4 no Referência geral da Amazon Web Services. |
X-Amz-Target |
Especifica a operação de Permissões Verificadas que você deseja realizar.
Por exemplo, para chamar a
|
Content-Type |
Especifica o formato de entrada. Use o valor a seguir.
|
Accept |
Especifica o formato da resposta. Use o valor a seguir.
|
Content-Length |
Tamanho da carga em bytes. |
Content-Encoding |
Especifica o formato de codificação da entrada e da saída. Use o valor a seguir.
|
Veja a seguir um exemplo de cabeçalho de uma solicitação HTTP para retornar uma lista de todas as políticas no repositório de políticas especificado no Conta da AWS qual as Principal referências são User nomeadasalice. Neste exemplo, a Authorization linha é dividida aqui para facilitar a leitura. Não inclua isso em sua solicitação real.
POST / HTTP/1.1 Host: verifiedpermissions.us-east-1.amazonaws.com X-Amz-Date: 20230101T200059Z Accept-Encoding: identity Content-Type: application/x-amz-json-1.0 X-Amz-Target: VerifiedPermissions.ListPolicies User-Agent: <UserAgentString> Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=<Headers>, Signature=<Signature> Content-Length: <PayloadSizeBytes> { "PolicyStoreId": "PSExAmPLE222222222", "Filter": { "Principal": { "Id": { "EntityType": "User", "EntityId": "alice" } } } }
