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 do cliente têm métodos que correspondem one-to-one às operações de serviço. Consulte o Criação de um cliente de serviço básico para começar a usar clientes.

Os objetos de comandos encapsulam a execução de uma operação. Ao executar uma operação de serviço conforme descrito na seção de solicitação, 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 para 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 para dados semelhantes a JSON. O AWS SDK para PHP usa JMESPath expressões para consultar estruturas de dados PHP. JMESPath expressões podem ser usadas diretamente em Aws\ResultPaginator objetos Aws\Result e por meio do search($expression) método.

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 dentro da API de um serviço (por exemplo, CreateTable para DynamoDB, RunInstances para 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 AWS de serviço 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 essas exigem a realização de solicitações subsequentes com parâmetros de token (ou marcador) para recuperar todo o conjunto de resultados. Os paginadores são um recurso do SDK que atua como uma abstração desse processo para facilitar o uso do paginado pelos desenvolvedores. APIs Eles são acessados por meio do método getPaginator() do cliente. Consulte o guia Paginadores na AWS SDK para 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 ser diferentes endpoints/URLs em cada região, o que existe para reduzir a latência de dados em seus 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 à AWS SDK para PHP biblioteca como um todo, mas também se refere à Aws\Sdk classe (docs), que atua como uma fábrica para os objetos do 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.

Uma forma geral de se referir a qualquer um dos AWS serviços (por exemplo, Amazon S3, Amazon DynamoDB etc.) AWS OpsWorks. 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 CreateTable do Amazon DynamoDB retorna 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 Garçons na AWS SDK para PHP versão 3 para obter mais detalhes.