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á. # Conceitos básicos do AWS SDK para PHP versão 3 Este capítulo é dedicado a tornar você ativo e em execução com o AWS SDK para PHP versão 3. **Topics** + [Pré-requisitos](getting-started_requirements.md) + [Instalar](getting-started_installation.md) + [Autenticando com AWS](credentials.md) + [Criar uma aplicação simples](hello.md) + [Use AWS Cloud9 com o SDK](cloud9.md) # Requisitos e recomendações para a AWS SDK para PHP versão 3 Para obter melhores resultados AWS SDK para PHP, certifique-se de que seu ambiente ofereça suporte aos seguintes requisitos e recomendações. ## Requisitos Para usar o AWS SDK para PHP, você deve estar usando a versão 8.1 ou posterior do PHP com a [extensão SimpleXML PHP ativada](https://www.php.net/manual/en/book.simplexml.php). Se precisar assinar uma Amazon privada CloudFront URLs, você também precisará da extensão PHP [OpenSSL](http://php.net/manual/en/book.openssl.php). ## Recomendações Além dos requisitos mínimos, também recomendamos instalar, desinstalar e usar o seguinte. **** | | | | --- |--- | | Instalar o [cURL](http://php.net/manual/en/book.curl.php) 7.16.2 ou posterior | Use uma versão recente do cURL compilada com OpenSSL/NSS e zlib. Se o cURL não estiver instalado no sistema e você não configurar um http\$1handler personalizado para o cliente, o SDK usará o stream wrapper do PHP. | | Usar o [OPCache](http://php.net/manual/en/book.opcache.php) | Use a OPcache extensão para melhorar o desempenho do PHP armazenando o bytecode de script pré-compilado na memória compartilhada. Isso remove a necessidade do PHP carregar e analisar scripts em cada solicitação. Por padrão, essa extensão normalmente está habilitada. Ao executar o Amazon Linux, você precisa instalar o pacote php56-opcache ou php55-opcache yum para usar a extensão. OPCache | | Desinstale o [Xdebug](http://xdebug.org/) em ambientes de produção | O Xdebug pode ajudar a identificar gargalos de desempenho. No entanto, se o desempenho for crítico para o aplicativo, não instale a extensão do Xdebug no ambiente de produção. O carregamento da extensão reduz consideravelmente o desempenho do SDK. | | Usar um carregador automático de classmap do [Composer](http://getcomposer.org) | O carregadores automáticos carregam classes conforme forem exigidas por um script do PHP. O Composer gera um carregador automático que pode carregar automaticamente os scripts do PHP de seu aplicativo e todos os outros scripts exigidos pelo aplicativo, inclusive o AWS SDK para PHP. Para ambientes de produção, recomendamos usar um carregador automático de classmap para melhorar o desempenho do carregador automático. Você pode gerar um carregador automático de classmap passando a opção `-o` ou `==optimize-autoloader` para o comando de instalação do Composer. | ## Teste de compatibilidade Execute o arquivo [https://github.com/aws/aws-sdk-php/blob/master/compatibility-test.php](https://github.com/aws/aws-sdk-php/blob/master/compatibility-test.php) localizado na base do código SDK para verificar se o sistema pode executar o SDK. Além de cumprir os requisitos mínimos de sistema do SDK, o teste de compatibilidade verifica se há configurações opcionais e faz recomendações que podem ajudar a melhorar o desempenho. As saídas do teste de compatibilidade resultam na linha de comando ou em um navegador da web. Ao analisar os resultados do teste em um navegador, as verificações bem-sucedidas são exibidas em verde, os avisos em roxo e as falhas em vermelho. Ao executar na linha de comando, o resultado de uma verificação é exibido em uma linha separada. Ao relatar um problema com o SDK, compartilhar a saída do teste de compatibilidade ajuda a identificar a causa subjacente. # Instalando a AWS SDK para PHP versão 3 Você pode instalar a AWS SDK para PHP versão 3: + Como uma dependência por meio do Composer + Como um phar pré-empacotado do SDK + Como um arquivo ZIP do SDK Antes de instalar a AWS SDK para PHP versão 3, certifique-se de que seu ambiente esteja usando a versão 8.1 ou posterior do PHP. Saiba mais sobre os [requisitos e as recomendações de ambiente](getting-started_requirements.md). **nota** A instalação do SDK por meio dos métodos .phar e .zip exige que a [extensão PHP Multibyte String](https://www.php.net/manual/en/book.mbstring.php) seja instalada e ativada separadamente. ## Instale AWS SDK para PHP como uma dependência via Composer O Composer é a maneira recomendada de instalar o AWS SDK para PHP. O Composer é uma ferramenta para PHP que gerencia e instala as dependências de seu projeto. Para obter mais informações sobre como instalar o Composer, configurar o carregamento automático e seguir outras práticas recomendadas para definir dependências, consulte [getcomposer.org](http://getcomposer.org). ### Instalar o Composer Se o Composer ainda não estiver no seu projeto, baixe-o e instale-o na [página de download do Composer](http://getcomposer.org/download). + Para **Windows**, siga as instruções do Windows Installer. + Para **Linux**, siga as instruções de instalação da linha de comando. ### Adicionar AWS SDK para PHP como uma dependência via Composer Se o [Composer já estiver instalado globalmente](https://getcomposer.org/doc/00-intro.md#globally) em seu sistema, execute o seguinte no diretório base do seu projeto para instalar AWS SDK para PHP como uma dependência: ``` $ composer require aws/aws-sdk-php ``` Caso contrário, digite este comando do Composer para instalar a versão mais recente do AWS SDK para PHP como uma dependência. ``` $ php -d memory_limit=-1 composer.phar require aws/aws-sdk-php ``` ### Adicionar carregador automático aos scripts PHP Instalar o Composer cria várias pastas e arquivos no ambiente. O arquivo primário que será usado é `autoload.php`, que se encontra na pasta `vendor` no ambiente. Para utilizar o AWS SDK para PHP em seus scripts, inclua o carregador automático em seus scripts, da seguinte maneira. ``` ``` ## Instalação usando o Phar empacotado Cada versão do AWS SDK para PHP inclui um phar (arquivo PHP) pré-empacotado que contém todas as classes e dependências necessárias para executar o SDK. Além disso, o phar registra automaticamente um carregador automático de classes para o AWS SDK para PHP e todas as suas dependências. Você pode [fazer download do phar empacotado](https://docs.aws.amazon.com/aws-sdk-php/v3/download/aws.phar) e incluí-lo em seus scripts. ``` ``` **nota** O uso do PHP com o patch Suhosin não é recomendado, mas é comum em distribuições do Ubuntu e do Debian. Nesse caso, pode ser necessário habilitar o uso de phars no suhosin.ini. Se você não fizer isso, a inclusão de um arquivo phar em seu código provocará uma falha silenciosa. Para modificar o suhosin.ini, adicione a linha a seguir. ``` suhosin.executor.include.whitelist = phar ``` ## Instalação usando o arquivo ZIP AWS SDK para PHP Isso inclui um arquivo ZIP contendo todas as classes e dependências necessárias para executar o SDK. Além disso, o arquivo ZIP inclui uma classe de carregador automático para o AWS SDK para PHP e suas dependências. Para instalar o SDK, [faça download do arquivo .zip](https://docs.aws.amazon.com/aws-sdk-php/v3/download/aws.zip) e extraia-o em seu projeto em um local de sua escolha. Em seguida, inclua o carregador automático em seus scripts, conforme mostrado a seguir. ``` ``` # Autenticando com o AWS uso da AWS SDK para PHP versão 3 Você deve estabelecer como seu código é autenticado AWS ao desenvolver com Serviços da AWS. Você pode configurar o acesso programático aos AWS recursos de maneiras diferentes, dependendo do ambiente e do AWS acesso disponível para você. Para escolher seu método de autenticação e configurá-lo para o SDK, consulte [Autenticação e acesso](https://docs.aws.amazon.com/sdkref/latest/guide/access.html) no *Guia de referência de ferramentas AWS SDKs e ferramentas*. ## Configurar a autenticação com o Centro de Identidade do IAM para desenvolvimento local Recomendamos que novos usuários que estejam se desenvolvendo localmente e que não recebam um método de autenticação do empregador se configurem Centro de Identidade do AWS IAM. Esse método inclui a instalação do AWS CLI para facilitar a configuração e entrar regularmente no portal de AWS acesso. Se você escolher esse método, seu ambiente deverá conter os seguintes elementos depois de concluir o procedimento de [autenticação do IAM Identity Center](https://docs.aws.amazon.com/sdkref/latest/guide/access-sso.html) no *Guia de referência de ferramentas AWS SDKs e ferramentas*: + O AWS CLI, que você usa para iniciar uma sessão do portal de AWS acesso antes de executar seu aplicativo. + Um [arquivo `config` da AWS compartilhado](https://docs.aws.amazon.com/sdkref/latest/guide/file-format.html) que tem um perfil `[default]` com um conjunto de valores de configuração que podem ser referenciados pelo SDK. Para encontrar a localização desse arquivo, consulte [Localização dos arquivos compartilhados no](https://docs.aws.amazon.com/sdkref/latest/guide/file-location.html) *Guia de referência de ferramentas AWS SDKs e ferramentas*. + O arquivo `config` compartilhado contém a definição de [https://docs.aws.amazon.com/sdkref/latest/guide/feature-region.html](https://docs.aws.amazon.com/sdkref/latest/guide/feature-region.html). Isso define o padrão Região da AWS que o SDK usa para solicitações. Essa região é usada para solicitações de serviço do SDK que não são configuradas explicitamente com uma propriedade `region`. + O SDK usa a [configuração do provedor do token de SSO](https://docs.aws.amazon.com/sdkref/latest/guide/feature-sso-credentials.html#feature-sso-credentials-profile) do perfil para adquirir credenciais antes de enviar solicitações para a AWS. O `sso_role_name` valor, que é uma função do IAM conectada a um conjunto de permissões do IAM Identity Center, permite acesso ao Serviços da AWS usado em seu aplicativo. O arquivo `config` de amostra a seguir mostra um perfil padrão configurado com o provedor de token de SSO. A configuração `sso_session` do perfil se refere à [seção do `sso-session`](https://docs.aws.amazon.com/sdkref/latest/guide/file-format.html#section-session). A `sso-session` seção contém configurações para iniciar uma sessão do portal de AWS acesso. ``` [default] sso_session = my-sso sso_account_id = 111122223333 sso_role_name = SampleRole region = us-east-1 output = json [sso-session my-sso] sso_region = us-east-1 sso_start_url = https://provided-domain.awsapps.com/start sso_registration_scopes = sso:account:access ``` AWS SDK para PHP Não é necessário adicionar pacotes adicionais (como `SSO` e`SSOOIDC`) ao seu aplicativo para usar a autenticação do IAM Identity Center. ## Iniciar uma sessão do portal de AWS acesso Antes de executar um aplicativo que acessa Serviços da AWS, você precisa de uma sessão ativa do portal de AWS acesso para que o SDK use a autenticação do IAM Identity Center para resolver as credenciais. Dependendo da duração da sessão configurada, o seu acesso acabará expirando e o SDK encontrará um erro de autenticação. Para entrar no portal de AWS acesso, execute o seguinte comando no AWS CLI. ``` aws sso login ``` Se você seguiu as orientações e tem um perfil padrão configurado, não precisará chamar o comando com uma opção de `--profile`. Se a configuração do provedor de token de SSO estiver usando um perfil nomeado, o comando será `aws sso login --profile named-profile`. Para testar opcionalmente se você já tem uma sessão ativa, execute o AWS CLI comando a seguir. ``` aws sts get-caller-identity ``` Se a sua sessão estiver ativa, a resposta a este comando relata a conta do IAM Identity Center e o conjunto de permissões configurados no arquivo `config` compartilhado. **nota** Se você já tiver uma sessão ativa do portal de AWS acesso e executá-la`aws sso login`, não será necessário fornecer credenciais. O processo de login pode solicitar que você permita o AWS CLI acesso aos seus dados. Como o AWS CLI é criado com base no SDK para Python, as mensagens de permissão podem conter variações do `botocore` nome. ## Saiba mais sobre autenticação + Para obter mais detalhes sobre o uso do IAM Identity Center para autenticação, consulte [Compreender a autenticação do IAM Identity Center](https://docs.aws.amazon.com/sdkref/latest/guide/understanding-sso.html) no *Guia de referência de ferramentas AWS SDKs e ferramentas* + Para saber mais sobre as práticas recomendadas, consulte [Práticas recomendadas de segurança no IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html) no *Guia do usuário do IAM*. + Para criar AWS credenciais de curto prazo, consulte [Credenciais de segurança temporárias](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html) no Guia do *usuário do IAM*. + Para saber mais sobre outros provedores de credenciais que AWS SDK para PHP podem usar, consulte Provedores de [credenciais padronizados no Guia de](https://docs.aws.amazon.com/sdkref/latest/guide/standardized-credentials.html) Referência de *Ferramentas AWS SDKs e Ferramentas*. # Criar uma aplicação simples usando o AWS SDK para PHP versão 3 Diga olá ao Amazon S3 usando o AWS SDK para PHP. O exemplo a seguir mostra uma lista dos seus buckets do Amazon S3. ## Pré-requisitos + [Download e instalação do SDK](getting-started_installation.md) + Antes de usar o AWS SDK para PHP, você deve configurar a autenticação na AWS. Para obter informações sobre a configuração de autenticação, consulte [Autenticando com o AWS uso da AWS SDK para PHP versão 3](credentials.md). ## Incluir o SDK em seu código Independentemente da técnica usada para instalar o SDK, é possível incluir o SDK em seu código com apenas uma única instrução `require`. Consulte a tabela a seguir para obter o código PHP mais adequado para sua técnica de instalação. Substitua todas as instâncias de `/path/to/` pelo caminho real em seu sistema. **** | Técnica de instalação | Instrução Require | | --- | --- | | Uso do Composer | `require '/path/to/vendor/autoload.php';` | | Uso do phar | `require '/path/to/aws.phar';` | | Uso da ZIP | `require '/path/to/aws-autoloader.php';` | Neste tópico, assumimos o método de instalação do Composer. Se estiver usando outro método de instalação, você poderá voltar a esta seção para localizar o código `require` correto a ser usado. ## Escrever o código Verifique se você é capaz de se autenticar. Copie e cole o código a seguir em um novo arquivo de origem. Salve e nomeie o arquivo como `hello-s3.php`. ``` 'default', 'region' => 'us-west-2', 'version' => '2006-03-01' ]); //Listing all S3 Bucket $buckets = $s3Client->listBuckets(); foreach ($buckets['Buckets'] as $bucket) { echo $bucket['Name'] . "\n"; } ``` ## Executar o programa Abra um prompt de comando para executar seu programa PHP. A sintaxe de comando típica para executar um programa PHP é: ``` php [source filename] [arguments...] ``` Esse código de exemplo não usa argumentos. Para executar esse código, digite o seguinte no prompt de comando: ``` $ php hello-s3.php ``` ## Próximas etapas Para testar muitas outras operações do Amazon S3, confira o [Repositório de exemplos de código da AWS](https://github.com/awsdocs/aws-doc-sdk-examples/blob/main/php/example_code/s3) no GitHub. # Use AWS Cloud9 com a AWS SDK para PHP versão 3 **nota** AWS Cloud9 não está mais disponível para novos clientes. Os clientes existentes do AWS Cloud9 podem continuar usando o serviço normalmente. [Saiba mais](https://aws.amazon.com/blogs/devops/how-to-migrate-from-aws-cloud9-to-aws-ide-toolkits-or-aws-cloudshell/). AWS Cloud9 é um ambiente de desenvolvimento integrado (IDE) baseado na Web que contém uma coleção de ferramentas que você usa para codificar, criar, executar, testar, depurar e lançar software na nuvem. Você pode usar AWS Cloud9 com o AWS SDK para PHP para escrever e executar seu código PHP usando um navegador. AWS Cloud9 inclui ferramentas como editor de código e terminal. Como o AWS Cloud9 IDE é baseado em nuvem, você pode trabalhar em seus projetos no escritório, em casa ou em qualquer lugar usando uma máquina conectada à Internet. Para obter informações gerais sobre AWS Cloud9, consulte o [Guia AWS Cloud9 do usuário](https://docs.aws.amazon.com/cloud9/latest/user-guide/welcome.html). Siga estas instruções para configurar AWS Cloud9 com o AWS SDK para PHP: + [Etapa 1: configure seu Conta da AWS para usar AWS Cloud9](#cloud9-php-account) + [Etapa 2: configurar seu ambiente AWS Cloud9 de desenvolvimento](#cloud9-php-environment) + [Etapa 3: configurar o AWS SDK para PHP](#cloud9-php-sdk) + [Etapa 4: baixar o código de exemplo](#cloud9-php-examples) + [Etapa 5: executar o código de exemplo](#cloud9-php-run) ## Etapa 1: configure seu Conta da AWS para usar AWS Cloud9 Para usar AWS Cloud9, entre no AWS Cloud9 console a partir do Console de gerenciamento da AWS. **nota** Se você estiver usando Centro de Identidade do AWS IAM para se autenticar, talvez seja necessário adicionar a permissão necessária de `iam:ListInstanceProfilesForRole` à política anexada ao usuário no console do IAM. Para configurar uma entidade do IAM em sua AWS conta para acessar AWS Cloud9 e fazer login no AWS Cloud9 console, consulte [Configuração da equipe AWS Cloud9](https://docs.aws.amazon.com/cloud9/latest/user-guide/setup.html) no *Guia do AWS Cloud9 usuário*. ## Etapa 2: configurar seu ambiente AWS Cloud9 de desenvolvimento Depois de entrar no AWS Cloud9 console, use o console para criar um ambiente de AWS Cloud9 desenvolvimento. Depois de criar o ambiente, AWS Cloud9 abre o IDE para esse ambiente. Para obter detalhes, consulte [Criação de um ambiente no AWS Cloud9](https://docs.aws.amazon.com/cloud9/latest/user-guide/create-environment.html) no *Guia do usuário do AWS Cloud9 *. **nota** Ao criar o ambiente no console pela primeira vez, recomendamos selecionar a opção **Create a new instance for environment (EC2) (Criar um nova instância para o ambiente (EC2))**. Essa opção diz AWS Cloud9 para criar um ambiente, iniciar uma instância do Amazon EC2 e, em seguida, conectar a nova instância ao novo ambiente. Essa é a maneira mais rápida de começar a usar AWS Cloud9. Se o terminal ainda não estiver aberto no IDE, abra-o. Na barra de menus no IDE, escolha **Window, New Terminal (Janela, novo terminal)**. Você pode usar a janela do terminal para instalar ferramentas e criar aplicações. ## Etapa 3: configurar o AWS SDK para PHP Depois de AWS Cloud9 abrir o IDE para seu ambiente de desenvolvimento, use a janela do terminal para configurar o AWS SDK para PHP em seu ambiente. O Composer é a maneira recomendada de instalar o AWS SDK para PHP. O Composer é uma ferramenta para PHP que gerencia e instala as dependências de seu projeto. Para obter mais informações sobre como instalar o Composer, configurar o carregamento automático e seguir outras práticas recomendadas para definir dependências, consulte [getcomposer.org](http://getcomposer.org). ### Instalar o Composer Se o Composer ainda não estiver no seu projeto, baixe-o e instale-o na [página de download do Composer](http://getcomposer.org/download). + Para **Windows**, siga as instruções do Windows Installer. + Para **Linux**, siga as instruções de instalação da linha de comando. ### Adicionar AWS SDK para PHP como uma dependência via Composer Se o [Composer já estiver instalado globalmente](https://getcomposer.org/doc/00-intro.md#globally) em seu sistema, execute o seguinte no diretório base do seu projeto para instalar AWS SDK para PHP como uma dependência: ``` $ composer require aws/aws-sdk-php ``` Caso contrário, digite este comando do Composer para instalar a versão mais recente do AWS SDK para PHP como uma dependência. ``` $ php -d memory_limit=-1 composer.phar require aws/aws-sdk-php ``` ### Adicionar carregador automático aos scripts PHP Instalar o Composer cria várias pastas e arquivos no ambiente. O arquivo primário que será usado é `autoload.php`, que se encontra na pasta `vendor` no ambiente. Para utilizar o AWS SDK para PHP em seus scripts, inclua o carregador automático em seus scripts, da seguinte maneira. ``` ``` ## Etapa 4: baixar o código de exemplo Use a janela do terminal para baixar o código de exemplo AWS SDK para PHP para o ambiente de AWS Cloud9 desenvolvimento. Para baixar uma cópia de todos os exemplos de código usados na documentação oficial do AWS SDK no diretório raiz do seu ambiente, execute o seguinte comando: ``` $ git clone https://github.com/awsdocs/aws-doc-sdk-examples.git ``` Os exemplos de código para o AWS SDK para PHP estão localizados no `ENVIRONMENT_NAME/aws-doc-sdk-examples/php` diretório, onde `ENVIRONMENT_NAME` está o nome do seu ambiente de desenvolvimento. Para continuar usando um exemplo do Amazon S3, recomendamos começar com um exemplo de código `ENVIRONMENT_NAME/aws-doc-sdk-examples/php/example_code/s3/ListBuckets.php`. Esse exemplo listará seus buckets do Amazon S3. Use a janela do terminal para navegar até o diretório `s3` e listar os arquivos. ``` $ cd aws-doc-sdk-examples/php/example_code/s3 $ ls ``` Para abrir o arquivo AWS Cloud9, você pode clicar `ListBuckets.php` diretamente na janela do terminal. Para obter mais suporte na compreensão de exemplos de código, consulte [Exemplos de código do AWS SDK para PHP](examples_index.md). ## Etapa 5: executar o código de exemplo Para executar código em seu ambiente de AWS Cloud9 desenvolvimento, escolha o botão **Executar** na barra de menu superior. AWS Cloud9 detecta automaticamente a extensão do `.php` arquivo e usa o executor **PHP (servidor web embutido)** para executar o código. No entanto, para esse exemplo, nós realmente queremos a opção **PHP (`cli`)**. Para obter mais informações sobre a execução de códigos no AWS Cloud9, consulte [Run Your Code](https://docs.aws.amazon.com/cloud9/latest/user-guide/build-run-debug.html#build-run-debug-run) no *Guia do usuário do AWS Cloud9 *. Na captura de tela a seguir, observe essas áreas básicas: + 1: Executar. O botão **Executar** está localizado na barra de menu superior. Isso abre uma nova guia para seus resultados. **nota** Você também pode criar manualmente novas configurações de execução. Na barra de menus, selecione **Executar**, **Configurações de execução**, **Nova configuração de execução**. + 2: Comando. AWS Cloud9 preenche a caixa de texto **Comando** com o caminho e o nome do arquivo executado. Se seu código espera que os parâmetros da linha de comando sejam passados, eles podem ser adicionados à linha de comando da mesma forma que você faria ao executar o código em uma janela do terminal. + 3: Corredor. AWS Cloud9 detecta que sua extensão de arquivo é `.php` e seleciona o executor **PHP (servidor web embutido)** para executar seu código. Em vez disso, selecione **PHP (`cli`)** para executar este exemplo. ![\[Escolher Executar na barra de menu superior do AWS Cloud9 IDE abre uma nova guia com a caixa Comando preenchida e o executor PHP já selecionado.\]](http://docs.aws.amazon.com/pt_br/sdk-for-php/v3/developer-guide/images/cloud9_runconfig.png) Qualquer saída gerada pelo código em execução é exibida na guia.