Glossário

Os serviços têm uma ou mais versões de API, e a versão que você está usando determina quais operações e parâmetros são válidos. As versões da API são formatadas como uma data. Por exemplo, a versão mais recente da API do Amazon S3 é 2006-03-01. Especifique uma versão ao configurar um objeto do cliente.

Os objetos de clientes são usados para executar operações para um serviço. Cada serviço compatível com o SDK tem um objeto de cliente correspondente. Os objetos de clientes têm métodos que correspondem um para um com as operações do serviço. Consulte o guia de uso básico para obter detalhes sobre como criar e usar objetos de cliente.

Os objetos de comandos encapsulam a execução de uma operação. Ao seguir os padrões de uso básico do SDK, você não lidará diretamente com objetos de comando. Os objetos de comando podem ser acessados usando o método getCommand() de um cliente para usar recursos avançados do SDK, como solicitações simultâneas e processamento em lotes. Consulte o guia Objetos de comando no AWS SDK for PHP Versão 3 para obter mais detalhes.

Um manipulador é uma função que executa a transformação real de um comando e de uma solicitação em um resultado. Um manipulador normalmente envia solicitações HTTP. Os manipuladores podem ser compostos com middleware para aumentar seu comportamento. Um manipulador é uma função que aceita uma Aws\CommandInterface e uma Psr\Http\Message\RequestInterface e retorna uma promessa que é cumprida com uma Aws\ResultInterface ou rejeitada com uma razão de Aws\Exception\AwsException.

JMESPath é uma linguagem de consulta de dados do tipo JSON. O AWS SDK for PHP usa expressões do JMESPath para consultar estruturas de dados do PHP. As expressões de JMESPath podem ser usadas diretamente nos objetos Aws\Result e Aws\ResultPaginator por meio do método search($expression).

Middleware é um tipo especial de função de alto nível que aumenta o comportamento de transferência de um comando e delegação para um manipulador "próximo". As funções de middleware aceitam uma Aws\CommandInterface e uma Psr\Http\Message\RequestInterface e retornam uma promessa que é cumprida com uma Aws\ResultInterface ou rejeitada com um motivo de Aws\Exception\AwsException.

Refere-se a uma única operação em uma API do serviço (por exemplo, CreateTable para o DynamoDB, RunInstances para o Amazon EC2). No SDK, as operações são executadas chamando um método com o mesmo nome no objeto do cliente do serviço correspondente. A execução de uma operação envolve a preparação e o envio de uma solicitação HTTP ao serviço e a análise da resposta. Esse processo de execução de uma operação é abstraído pelo SDK por meio de objetos de comando.

Algumas operações de serviços da AWS são paginadas e respondem com resultados truncados. Por exemplo, a operação do ListObjects do Amazon S3 retorna só até 1000 objetos por vez. Operações como estas exigem fazer solicitações subsequentes com parâmetros de token (ou marcador) para recuperar todo o conjunto de resultados. Paginadores são um recurso do SDK que atuam como uma abstração sobre esse processo para facilitar o uso de APIs paginadas aos desenvolvedores. Eles são acessados por meio do método getPaginator() do cliente. Consulte o guia Paginadores no AWS SDK for PHP Versão 3 para obter mais detalhes.

Uma promessa representa o resultado eventual de uma operação assíncrona. A principal maneira de interagir com uma promessa é por meio de seu método, que registra retornos de chamada para receber o valor eventual de uma promessa ou o motivo pelo qual a promessa não pode ser cumprida.

Os serviços são suportados em uma ou mais regiões geográficas. Os serviços podem ter diferentes endpoints/URLs em cada região, que existem para reduzir a latência de dados nos aplicativos. Forneça uma região ao configurar um objeto do cliente para que o SDK possa determinar qual endpoint usar com o serviço.

O termo "SDK" pode se referir à biblioteca do AWS SDK for PHP como um todo, mas também se refere à classe Aws\Sdk (documentação), que atua como uma fábrica para os objetos de cliente para cada serviço. A classe Sdk também permite que você forneça um conjunto de valores globais da configuração que são aplicados a todos os objetos de cliente que ela cria.

A forma geral de fazer referência a qualquer um dos serviços da AWS (por exemplo, Amazon S3, Amazon DynamoDB, AWS OpsWorks, etc.). Cada serviço tem um objeto de cliente correspondente no SDK que oferece suporte a uma ou mais versões da API. Cada serviço também tem uma ou mais operações que compõem sua API. Os serviços são suportados em uma ou mais regiões.

Ao executar operações, o SDK usa suas credenciais para criar uma assinatura digital de sua solicitação. Em seguida, o serviço verifica a assinatura antes de processar a solicitação. O processo de assinatura é encapsulado pelo SDK e ocorre automaticamente usando as credenciais que você configura para o cliente.

Os waiters são um recurso do SDK que facilitam o trabalho com operações que alteram o estado de um recurso e que são eventualmente consistentes ou assíncronos por natureza. Por exemplo, a operação do Amazon DynamoDBCreateTable devolve uma resposta imediatamente, mas a tabela pode não estar pronta para acesso por vários segundos. A execução de um waiter permite que você aguarde até que um recurso entre em um estado específico suspendendo e sondando o status do recurso. Os waiters são acessados por meio do método waitUntil() do cliente. Consulte o guia Waiters no AWS SDK for PHP Versão 3 para obter mais detalhes.